blob: 0bd6d18dee87b3f288b9ebab34263b8ddaf165aa [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'
David Horstmann76a77382023-08-17 17:32:26 +0100136 else
137 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100138 fi
John Durkopbd069d32020-10-31 22:14:03 -0700139 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100140 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200141
142 # Files that are clobbered by some jobs will be backed up. Use a different
143 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
144 # independently decide when to remove the backup file.
145 backup_suffix='.all.bak'
146 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100147 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100148 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100149 # Files clobbered by in-tree cmake
150 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
151 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200152
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200153 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100154 MEMORY=0
155 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200156 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100157 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100158
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200159 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200160 #
161 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
162 # both values are kept in sync. If you change the value here because it
163 # breaks some tests, you'll definitely want to change it in
164 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200165 RELEASE_SEED=1
166
Yanray Wang18040ed2023-11-23 21:29:56 +0800167 # Specify character collation for regular expressions and sorting with C locale
168 export LC_COLLATE=C
169
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200170 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200171 : ${MBEDTLS_TEST_PLATFORM="$(uname -s | tr -c \\n0-9A-Za-z _)-$(uname -m | tr -c \\n0-9A-Za-z _)"}
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200172 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200173 export MBEDTLS_TEST_PLATFORM
174
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000175 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100176 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100177 : ${OPENSSL_NEXT:="$OPENSSL"}
178 : ${GNUTLS_CLI:="gnutls-cli"}
179 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100180 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
181 : ${ARMC5_BIN_DIR:=/usr/bin}
182 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200183 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200184 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100185 : ${CLANG_LATEST:="clang-latest"}
186 : ${CLANG_EARLIEST:="clang-earliest"}
187 : ${GCC_LATEST:="gcc-latest"}
188 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100189 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000190 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200191 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100192 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000193 # if CC is not set, use clang by default (if present) to improve build times
194 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000195 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000196 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000197
Ronald Cronc5e81d22024-04-02 14:39:53 +0200198 if [ -n "${OPENSSL_3+set}" ]; then
199 export OPENSSL_NEXT="$OPENSSL_3"
200 fi
201
Gilles Peskine396853a2021-09-20 18:57:55 +0200202 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000203 export CTEST_OUTPUT_ON_FAILURE=1
204
Gilles Peskine8fd59422019-10-21 17:11:33 +0200205 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100206 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200207 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000208 # Normally, tests should use this compiler for ASAN testing
209 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200210
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400211 # Platform tests have an allocation that returns null
212 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400213 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400214
Gilles Peskine878cf602019-01-06 20:50:38 +0000215 # Gather the list of available components. These are the functions
216 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100217 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000218
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000219 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100220 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100221}
Andres AG38495a32016-07-12 16:54:33 +0100222
Dave Rodgman21900632024-02-26 11:41:19 +0000223setup_quiet_wrappers()
224{
225 # Pick up "quiet" wrappers for make and cmake, which don't output very much
226 # unless there is an error. This reduces logging overhead in the CI.
227 #
228 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000229 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
230 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000231 fi
232}
233
Gilles Peskinea28db922019-01-10 00:05:18 +0100234# Test whether the component $1 is included in the command line patterns.
235is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100236{
Gilles Peskine03af6782021-08-06 11:35:17 +0200237 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
238 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100239 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000240 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100241 set +f
242 case ${1#component_} in $pattern) return 0;; esac
243 done
244 set +f
245 return 1
246}
Andres AG7770ea82016-10-10 15:46:20 +0100247
Simon Butcher41eeccf2016-09-07 00:07:09 +0100248usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100249{
Gilles Peskine709346a2017-12-10 23:43:39 +0100250 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100251Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100252Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100253By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100254COMPONENT can be the name of a component or a shell wildcard pattern.
255
256Examples:
257 $0 "check_*"
258 Run all sanity checks.
259 $0 --no-armcc --except test_memsan
260 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100261
262Special options:
263 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000264 --list-all-components List all available test components and exit.
265 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100266
267General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200268 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100269 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100270 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100271 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200272 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200273 --arm-none-eabi-gcc-prefix=<string>
274 Prefix for a cross-compiler for arm-none-eabi
275 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200276 --arm-linux-gnueabi-gcc-prefix=<string>
277 Prefix for a cross-compiler for arm-linux-gnueabi
278 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100279 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200280 --restore First clean up the build tree, restoring backed up
281 files. Do not run any components unless they are
282 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100283 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200284 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100285 --except Exclude the COMPONENTs listed on the command line,
286 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200287 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100288 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100289 --no-force Refuse to overwrite modified files (default).
290 --no-keep-going Stop at the first error (default).
291 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800292 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100293 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200294 --outcome-file=<path> File where test outcomes are written (not done if
295 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100296 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200297 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100298 -s|--seed Integer seed value to use for this test run.
299
300Tool path options:
301 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
302 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100303 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
304 --clang-latest=<Clang_latest_path> Latest version of clang available
305 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
306 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100307 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
308 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100309 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100310 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100311EOF
SimonB2e23c822016-04-16 21:54:39 +0100312}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100313
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200314# Cleanup before/after running a component.
315# Remove built files as well as the cmake cache/config.
316# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100317cleanup()
318{
David Horstmann76a77382023-08-17 17:32:26 +0100319 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100320 command make clean
321 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200322
Gilles Peskine31b07e22018-03-21 12:15:06 +0100323 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000324 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100325 -iname CMakeFiles -exec rm -rf {} \+ -o \
326 \( -iname cmake_install.cmake -o \
327 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200328 -iname CMakeCache.txt -o \
329 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100330 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200331 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200332
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100333 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
334 rm -rf programs/test/cmake_subproject/build
335 rm -f programs/test/cmake_subproject/Makefile
336 rm -f programs/test/cmake_subproject/cmake_subproject
337
Chris Kayd259e342021-03-25 16:03:25 +0000338 # Remove any artifacts from the component_test_cmake_as_package test.
339 rm -rf programs/test/cmake_package/build
340 rm -f programs/test/cmake_package/Makefile
341 rm -f programs/test/cmake_package/cmake_package
342
343 # Remove any artifacts from the component_test_cmake_as_installed_package test.
344 rm -rf programs/test/cmake_package_install/build
345 rm -f programs/test/cmake_package_install/Makefile
346 rm -f programs/test/cmake_package_install/cmake_package_install
347
Gilles Peskinef83eb822020-03-30 20:11:39 +0200348 # Restore files that may have been clobbered by the job
349 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200350 if [[ -e "$x$backup_suffix" ]]; then
351 cp -p "$x$backup_suffix" "$x"
352 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200353 done
354}
John Durkopbd069d32020-10-31 22:14:03 -0700355
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200356# Final cleanup when this script exits (except when exiting on a failure
357# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200358final_cleanup () {
359 cleanup
360
361 for x in $files_to_back_up; do
362 rm -f "$x$backup_suffix"
363 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100364}
365
Gilles Peskine7c652162017-12-11 00:01:40 +0100366# Executed on exit. May be redefined depending on command line options.
367final_report () {
368 :
369}
370
371fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200372 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100373 final_report $1
374 trap - $1
375 kill -$1 $$
376}
377
378trap 'fatal_signal HUP' HUP
379trap 'fatal_signal INT' INT
380trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200381
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200382# Number of processors on this machine. Used as the default setting
383# for parallel make.
384all_sh_nproc ()
385{
386 {
387 nproc || # Linux
388 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
389 sysctl -n hw.ncpu || # FreeBSD
390 echo 1
391 } 2>/dev/null
392}
393
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100394msg()
395{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100396 if [ -n "${current_component:-}" ]; then
397 current_section="${current_component#component_}: $1"
398 else
399 current_section="$1"
400 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200401
402 if [ $QUIET -eq 1 ]; then
403 return
404 fi
405
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100406 echo ""
407 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100408 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000409 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100410 echo "******************************************************************"
411}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100412
Gilles Peskine8f073122018-11-27 15:58:47 +0100413armc6_build_test()
414{
415 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100416
Gilles Peskine18487f62020-04-30 23:11:54 +0200417 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800418 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100419 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000420 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200421
422 msg "size: ARM Compiler 6 ($FLAGS)"
423 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100424}
Andres AGa5cd9732016-10-17 15:23:10 +0100425
Andres AGd9eba4b2016-08-26 14:42:14 +0100426err_msg()
427{
428 echo "$1" >&2
429}
430
431check_tools()
432{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200433 for tool in "$@"; do
434 if ! `type "$tool" >/dev/null 2>&1`; then
435 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100436 exit 1
437 fi
438 done
439}
440
Gilles Peskine8f073122018-11-27 15:58:47 +0100441pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000442 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100443 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100444 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100445 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200446 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000447 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100448
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000449 # Note that legacy options are ignored instead of being omitted from this
450 # list of options, so invocations that worked with previous version of
451 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100452 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100453 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200454 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200455 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200456 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000457 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100458 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
459 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100460 --clang-earliest) shift; CLANG_EARLIEST="$1";;
461 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100462 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000463 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100464 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100465 --gcc-earliest) shift; GCC_EARLIEST="$1";;
466 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100467 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200468 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
469 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100470 --gnutls-serv) shift; GNUTLS_SERV="$1";;
471 --help|-h) usage; exit;;
472 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000473 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100474 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100475 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200476 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000477 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --no-force) FORCE=0;;
479 --no-keep-going) KEEP_GOING=0;;
480 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200481 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100482 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200484 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100485 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200486 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100487 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200488 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200489 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100490 --seed|-s) shift; SEED="$1";;
491 -*)
492 echo >&2 "Unknown option: $1"
493 echo >&2 "Run $0 --help for usage."
494 exit 120
495 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000496 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100497 esac
498 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100499 done
SimonB2e23c822016-04-16 21:54:39 +0100500
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100501 # Exclude components that are not supported on this platform.
502 SUPPORTED_COMPONENTS=
503 for component in $ALL_COMPONENTS; do
504 case $(type "support_$component" 2>&1) in
505 *' function'*)
506 if ! support_$component; then continue; fi;;
507 esac
508 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
509 done
510
511 if [ $list_components -eq 1 ]; then
512 printf '%s\n' $SUPPORTED_COMPONENTS
513 exit
514 fi
515
Gilles Peskinea28db922019-01-10 00:05:18 +0100516 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200517 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000518 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100519 fi
520
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000521 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
522 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100523 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000524 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100525 fi
SimonB2e23c822016-04-16 21:54:39 +0100526
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200527 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100528 if [ $all_except -eq 0 ]; then
529 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200530 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
531 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200532 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100533 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200534 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200535 # If the requested name includes a wildcard character, don't
536 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100537 case $component in
538 *[*?\[]*) continue;;
539 esac
540 case " $SUPPORTED_COMPONENTS " in
541 *" $component "*) :;;
542 *)
543 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
544 unsupported=$((unsupported + 1));;
545 esac
546 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200547 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100548 if [ $unsupported -ne 0 ]; then
549 exit 2
550 fi
551 fi
552
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000553 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100554 RUN_COMPONENTS=
555 for component in $SUPPORTED_COMPONENTS; do
556 if is_component_included "$component"; [ $? -eq $all_except ]; then
557 RUN_COMPONENTS="$RUN_COMPONENTS $component"
558 fi
559 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000560
561 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000562 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100563}
SimonB2e23c822016-04-16 21:54:39 +0100564
Gilles Peskine8f073122018-11-27 15:58:47 +0100565pre_check_git () {
566 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100567 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100568 git checkout-index -f -q $CONFIG_H
569 cleanup
570 else
SimonB2e23c822016-04-16 21:54:39 +0100571
Gilles Peskine8f073122018-11-27 15:58:47 +0100572 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
573 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
574 echo "You can either delete this directory manually, or force the test by rerunning"
575 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
576 exit 1
577 fi
578
Ronald Cron7a93ac52023-07-20 09:49:12 +0200579 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100580 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100581 echo "You can either delete or preserve your work, or force the test by rerunning the"
582 echo "script as: $0 --force"
583 exit 1
584 fi
SimonB2e23c822016-04-16 21:54:39 +0100585 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500586}
587
Gilles Peskine568f53a2021-07-12 18:16:01 +0200588pre_restore_files () {
589 # If the makefiles have been generated by a framework such as cmake,
590 # restore them from git. If the makefiles look like modifications from
591 # the ones checked into git, take care not to modify them. Whatever
592 # this function leaves behind is what the script will restore before
593 # each component.
594 case "$(head -n1 Makefile)" in
595 *[Gg]enerated*)
596 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
597 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
598 ;;
599 esac
600}
601
Gilles Peskinef83eb822020-03-30 20:11:39 +0200602pre_back_up () {
603 for x in $files_to_back_up; do
604 cp -p "$x" "$x$backup_suffix"
605 done
606}
607
Gilles Peskine8f073122018-11-27 15:58:47 +0100608pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100609 failure_count=0 # Number of failed components
610 last_failure_status=0 # Last failure status in this component
611
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100612 # See err_trap
613 previous_failure_status=0
614 previous_failed_command=
615 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100616 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100617
Gilles Peskine7c652162017-12-11 00:01:40 +0100618 start_red=
619 end_color=
620 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100621 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100622 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
623 start_red=$(printf '\033[31m')
624 end_color=$(printf '\033[0m')
625 ;;
626 esac
627 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100628
629 # Keep a summary of failures in a file. We'll print it out at the end.
630 failure_summary_file=$PWD/all-sh-failures-$$.log
631 : >"$failure_summary_file"
632
633 # Whether it makes sense to keep a component going after the specified
634 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200635 # This function normally receives the failing simple command
636 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
637 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100638 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200639 # False positives result in running things that can't be expected to
640 # work. False negatives result in things not running after something else
641 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100642 can_keep_going_after_failure () {
643 case "$1" in
644 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200645 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100646 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200647 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
648 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
649 *make*check*) true;;
650 "grep "*) true;;
651 "[ "*) true;;
652 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100653 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100654 esac
655 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100656
657 # This function runs if there is any error in a component.
658 # It must either exit with a nonzero status, or set
659 # last_failure_status to a nonzero value.
660 err_trap () {
661 # Save $? (status of the failing command). This must be the very
662 # first thing, before $? is overridden.
663 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100664 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100665
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100666 if [[ $last_failure_status -eq $previous_failure_status &&
667 "$failed_command" == "$previous_failed_command" &&
668 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
669 then
670 # The same command failed twice in a row, but this time one level
671 # less deep in the function call stack. This happens when the last
672 # command of a function returns a nonzero status, and the function
673 # returns that same status. Ignore the second failure.
674 previous_failure_funcall_depth=${#FUNCNAME[@]}
675 return
676 fi
677 previous_failure_status=$last_failure_status
678 previous_failed_command=$failed_command
679 previous_failure_funcall_depth=${#FUNCNAME[@]}
680
Gilles Peskinece266c42020-03-28 18:50:43 +0100681 text="$current_section: $failed_command -> $last_failure_status"
682 echo "${start_red}^^^^$text^^^^${end_color}" >&2
683 echo "$text" >>"$failure_summary_file"
684
685 # If the command is fatal (configure or build command), stop this
686 # component. Otherwise (test command) keep the component running
687 # (run more tests from the same build).
688 if ! can_keep_going_after_failure "$failed_command"; then
689 exit $last_failure_status
690 fi
691 }
692
Gilles Peskine7c652162017-12-11 00:01:40 +0100693 final_report () {
694 if [ $failure_count -gt 0 ]; then
695 echo
696 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100697 echo "${start_red}FAILED: $failure_count components${end_color}"
698 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100699 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
700 elif [ -z "${1-}" ]; then
701 echo "SUCCESS :)"
702 fi
703 if [ -n "${1-}" ]; then
704 echo "Killed by SIG$1."
705 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100706 rm -f "$failure_summary_file"
707 if [ $failure_count -gt 0 ]; then
708 exit 1
709 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100710 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100711}
712
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200713# record_status() and if_build_succeeded() are kept temporarily for backward
714# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100715record_status () {
716 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100717}
Gilles Peskine7c652162017-12-11 00:01:40 +0100718if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100719 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100720}
721
Gilles Peskinea681c592020-03-28 21:27:40 +0100722# '! true' does not trigger the ERR trap. Arrange to trigger it, with
723# a reasonably informative error message (not just "$@").
724not () {
725 if "$@"; then
726 report_failed_command="! $*"
727 false
728 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200729 fi
730}
731
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200732pre_prepare_outcome_file () {
733 case "$MBEDTLS_TEST_OUTCOME_FILE" in
734 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
735 esac
736 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
737 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
738 fi
739}
740
Gilles Peskine8f073122018-11-27 15:58:47 +0100741pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200742 if [ $QUIET -eq 1 ]; then
743 return
744 fi
745
Gilles Peskine8f073122018-11-27 15:58:47 +0100746 msg "info: $0 configuration"
747 echo "MEMORY: $MEMORY"
748 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200749 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100750 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100751 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100752 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100753 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
754 echo "GNUTLS_CLI: $GNUTLS_CLI"
755 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100756 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
757 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
758}
Andres AG7770ea82016-10-10 15:46:20 +0100759
Andres AGd9eba4b2016-08-26 14:42:14 +0100760# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100761pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000762 # Build the list of variables to pass to output_env.sh.
763 set env
SimonB2e23c822016-04-16 21:54:39 +0100764
Gilles Peskine87964262019-01-06 22:40:00 +0000765 case " $RUN_COMPONENTS " in
766 # Require OpenSSL and GnuTLS if running any tests (as opposed to
767 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
768 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100769 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000770 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
771 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100772 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000773 export GNUTLS_CLI="$GNUTLS_CLI"
774 export GNUTLS_SERV="$GNUTLS_SERV"
775 # Avoid passing --seed flag in every call to ssl-opt.sh
776 if [ -n "${SEED-}" ]; then
777 export SEED
778 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200779 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000780 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200781 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
782 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000783 ;;
784 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200785
Gilles Peskine87964262019-01-06 22:40:00 +0000786 case " $RUN_COMPONENTS " in
787 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
788 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100789
Gilles Peskine87964262019-01-06 22:40:00 +0000790 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200791 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000792 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100793
Gilles Peskine87964262019-01-06 22:40:00 +0000794 case " $RUN_COMPONENTS " in
795 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
796 esac
797
798 case " $RUN_COMPONENTS " in
799 *" test_zeroize "*) check_tools "gdb";;
800 esac
801
802 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000803 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000804 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
805 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200806 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000807 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
808 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200809 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
810 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
811 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000812 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000813
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200814 # past this point, no call to check_tool, only printing output
815 if [ $QUIET -eq 1 ]; then
816 return
817 fi
818
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000819 msg "info: output_env.sh"
820 case $RUN_COMPONENTS in
821 *_armcc*)
822 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
823 *) set "$@" RUN_ARMCC=0;;
824 esac
825 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100826}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100827
Gilles Peskine1570b592021-04-22 01:10:12 +0200828pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200829 # since make doesn't have proper dependencies, remove any possibly outdate
830 # file that might be around before generating fresh ones
831 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200832 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200833 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200834 else
835 make generated_files
836 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200837}
838
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000839clang_version() {
840 if command -v clang > /dev/null ; then
841 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
842 else
843 echo 0 # report version 0 for "no clang"
844 fi
845}
846
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200847################################################################
848#### Helpers for components using libtestdriver1
849################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100850
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200851# How to use libtestdriver1
852# -------------------------
853#
854# 1. Define the list algorithms and key types to accelerate,
855# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
856# Examples:
857# - loc_accel_list="ALG_JPAKE"
858# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200859# 2. Make configurations changes for the driver and/or main libraries.
860# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
861# can be either "default" to start with the default config, or a name
862# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200863# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200864# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
865# These changes affect both the driver and the main libraries.
866# (Note: they need to have the same set of PSA_WANT symbols, as that
867# determines the ABI between them.)
868# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
869# main libraries. Typically, you want to disable the module(s) that are
870# being accelerated. You may need to also disable modules that depend
871# on them or options that are not supported with drivers.
872# 2d. On top of psa/crypto_config.h, the driver library uses its own config
873# file: tests/include/test/drivers/config_test_driver.h. You usually
874# don't need to edit it: using loc_extra_list (see below) is preferred.
875# However, when there's no PSA symbol for what you want to enable,
876# calling scripts/config.py on this file remains the only option.
877# 3. Build the driver library, then the main libraries, test, and programs.
878# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
879# need to enable more algorithms here, typically hash algorithms when
880# accelerating some signature algorithms (ECDSA, RSAv2). This is done
881# by passing a 2nd argument listing the extra algorithms.
882# Example:
883# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
884# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800885# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200886# additional arguments will be passed to make: this can be useful if
887# you don't want to build everything when iterating during development.
888# Example:
889# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
890# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200891
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200892# Adjust the configuration - for both libtestdriver1 and main library,
893# as they should have the same PSA_WANT macros.
894helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200895 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200896 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200897 if [ "$base_config" != "default" ]; then
898 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200899 fi
900
901 # Enable PSA-based config (necessary to use drivers)
902 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
903
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200904 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
905 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
906 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000907
908 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
909 # otherwise we will end up running multithreaded tests without mutexes to protect them.
910 if scripts/config.py get MBEDTLS_THREADING_C; then
911 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
912 fi
913
914 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
915 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
916 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200917}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100918
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100919# Build the drivers library libtestdriver1.a (with ASan).
920#
921# Parameters:
922# 1. a space-separated list of things to accelerate;
923# 2. optional: a space-separate list of things to also support.
924# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
925helper_libtestdriver1_make_drivers() {
926 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
927 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
928}
929
930# Build the main libraries, programs and tests,
931# linking to the drivers library (with ASan).
932#
933# Parameters:
934# 1. a space-separated list of things to accelerate;
935# *. remaining arguments if any are passed directly to make
936# (examples: lib, -C tests test_suite_xxx, etc.)
937# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
938helper_libtestdriver1_make_main() {
939 loc_accel_list=$1
940 shift
941
942 # we need flags both with and without the LIBTESTDRIVER1_ prefix
943 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
944 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
945 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" "$@"
946}
947
Valerio Settid1b6ef12024-05-07 16:00:21 +0200948# $1: target which can be "client" or "server"
949helper_crypto_client_build() {
950 TARGET=$1
Valerio Settic98f8ab2024-05-10 15:53:40 +0200951 shift
Valerio Settid1b6ef12024-05-07 16:00:21 +0200952 TARGET_LIB=libpsa$TARGET
953
Valerio Settid1b6ef12024-05-07 16:00:21 +0200954 if [ "$TARGET" == "client" ]; then
955 scripts/config.py full
956 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
957 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
958 # Dynamic secure element support is a deprecated feature and it is not
959 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
960 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
961 # Disable potentially problematic features
962 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
963 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
964 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
965 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
966 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
967 else
968 scripts/config.py crypto_full
969 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
970 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200971 fi
972
Valerio Settif57afd52024-05-14 10:39:20 +0200973 make -C tests/psa-client-server/psasim/ CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
Valerio Settid1b6ef12024-05-07 16:00:21 +0200974
Valerio Settif57afd52024-05-14 10:39:20 +0200975 # cleanup() will restore some backed-up files which include $CONFIG_H and
976 # $CRYPTO_CONFIG_H. Built libraries were already copied to psasim at this
977 # point.
978 cleanup
Valerio Settid1b6ef12024-05-07 16:00:21 +0200979}
980
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100981################################################################
982#### Configuration helpers
983################################################################
984
Valerio Settib2fd6732023-08-15 17:10:47 +0200985# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200986# The function optionally accepts 1 parameter: a space-separated list of the
987# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200988helper_disable_builtin_curves() {
989 allowed_list="${1:-}"
990 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
991
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200992 for curve in $allowed_list; do
993 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200994 done
995}
996
997# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
998# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
999# in the following helpers.
1000helper_get_psa_curve_list () {
1001 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001002 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1003 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001004 done
1005
1006 echo "$loc_list"
1007}
1008
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001009# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1010# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1011# in the following helpers.
1012helper_get_psa_dh_group_list () {
1013 loc_list=""
1014 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1015 loc_list="$loc_list $item"
1016 done
1017
1018 echo "$loc_list"
1019}
1020
Valerio Settib2fd6732023-08-15 17:10:47 +02001021# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001022# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001023# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001024helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001025 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001026 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001027 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 +02001028 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1029 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001030 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1031 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001032 fi
1033 done
1034
1035 echo "$loc_list"
1036}
1037
Gilles Peskine192c72f2017-12-21 15:59:21 +01001038################################################################
1039#### Basic checks
1040################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001041
1042#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001043# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001044#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001045# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001046# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001047# 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 +02001048# time, so start with a GCC build).
1049# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001050#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001051# Indicative running times are given for reference.
1052
Gilles Peskine8f073122018-11-27 15:58:47 +01001053component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001054 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001055 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001056}
Janos Follathb72c6782016-07-19 14:54:17 +01001057
Gilles Peskine67debb62021-05-18 16:09:50 +02001058component_check_generated_files () {
1059 msg "Check: check-generated-files, files generated with make" # 2s
1060 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001061 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001062
1063 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001064 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001065 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001066 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001067
1068 msg "Check: check-generated-files -u, files absent" # 2s
1069 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001070 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001071 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001072 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001073
1074 # This component ends with the generated files present in the source tree.
1075 # This is necessary for subsequent components!
1076}
1077
Gilles Peskine8f073122018-11-27 15:58:47 +01001078component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001079 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001080 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001081}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001082
Gilles Peskine8f073122018-11-27 15:58:47 +01001083component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001084 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001085 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001086}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001087
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001088component_check_changelog () {
1089 msg "Check: changelog entries" # < 1s
1090 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001091 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001092 if [ -e ChangeLog.new ]; then
1093 # Show the diff for information. It isn't an error if the diff is
1094 # non-empty.
1095 diff -u ChangeLog ChangeLog.new || true
1096 rm ChangeLog.new
1097 fi
1098}
1099
Gilles Peskine8f073122018-11-27 15:58:47 +01001100component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001101 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001102 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001103}
Darryl Greena07039c2018-03-13 16:48:16 +00001104
Gilles Peskine895868b2019-09-19 21:30:05 +02001105component_check_test_cases () {
1106 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001107 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001108 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001109 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001110 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001111 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001112 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001113 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001114}
1115
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001116component_check_test_dependencies () {
1117 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001118 # The purpose of this component is to catch unjustified dependencies on
1119 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1120 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1121 # MBEDTLS_PSA_xxx).
1122 #
1123 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1124 # this component is meant to catch. However a few of them are justified,
1125 # mostly by the absence of a PSA equivalent, so this component includes a
1126 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001127
1128 found="check-test-deps-found-$$"
1129 expected="check-test-deps-expected-$$"
1130
1131 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001132 grep 'depends_on' \
1133 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001134 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001135 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001136 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001137
Yanray Wang18040ed2023-11-23 21:29:56 +08001138 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001139 rm -f $expected
1140 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1141 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001142 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1143 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001144 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1145 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001146 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1147 # the test code and that's probably the most convenient way of achieving
1148 # the test's goal.
1149 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1150 # No PSA equivalent - we should probably have one in the future.
1151 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1152 # No PSA equivalent - needed by some init tests
1153 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001154 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001155 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001156
1157 # Compare reality with expectation.
1158 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001159 #
1160 # The output should be empty. When it's not:
1161 # - Each '+' line is a macro that was found but not expected. You want to
1162 # find where that macro occurs, and either replace it with PSA macros, or
1163 # add it to the exceptions list above with a justification.
1164 # - Each '-' line is a macro that was expected but not found; it means the
1165 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001166 diff -U0 $expected $found
1167
1168 rm $found $expected
1169}
1170
Gilles Peskine8f073122018-11-27 15:58:47 +01001171component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001172 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001173 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001174}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001175
Gilles Peskine192c72f2017-12-21 15:59:21 +01001176
Gilles Peskine636c26a2020-03-04 20:46:15 +01001177
Gilles Peskine192c72f2017-12-21 15:59:21 +01001178################################################################
1179#### Build and test many configurations and targets
1180################################################################
1181
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001182component_test_default_out_of_box () {
1183 msg "build: make, default config (out-of-box)" # ~1min
1184 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001185 # Disable fancy stuff
1186 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001187
1188 msg "test: main suites make, default config (out-of-box)" # ~10s
1189 make test
1190
1191 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001192 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001193
1194 msg "program demos: make, default config (out-of-box)" # ~10s
1195 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001196}
1197
Gilles Peskine8f073122018-11-27 15:58:47 +01001198component_test_default_cmake_gcc_asan () {
1199 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001200 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1201 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001202
Gilles Peskine8f073122018-11-27 15:58:47 +01001203 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1204 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001205
Gilles Peskine82b27272019-06-14 18:27:03 +02001206 msg "program demos (ASan build)" # ~10s
1207 tests/scripts/run_demos.py
1208
Gilles Peskine97bea012020-04-23 23:37:45 +02001209 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001210 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001211
Gilles Peskine6848d172023-11-02 19:58:03 +01001212 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001213 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001214
Gilles Peskine8f073122018-11-27 15:58:47 +01001215 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001216 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001217
Gilles Peskine8f073122018-11-27 15:58:47 +01001218 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001219 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001220
1221 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001222 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001223}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001224
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001225component_test_default_cmake_gcc_asan_new_bignum () {
1226 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001227 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001228 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001229 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001230
1231 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1232 make test
1233
1234 msg "test: selftest (ASan build)" # ~ 10s
1235 programs/test/selftest
1236
1237 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1238 tests/ssl-opt.sh
1239
1240 msg "test: compat.sh (ASan build)" # ~ 6 min
1241 tests/compat.sh
1242
1243 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1244 tests/context-info.sh
1245}
1246
Hanno Becker01635512019-02-26 14:27:09 +00001247component_test_full_cmake_gcc_asan () {
1248 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001249 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001250 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1251 make
1252
1253 msg "test: main suites (inc. selftests) (full config, ASan build)"
1254 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001255
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001256 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001257 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001258
Gilles Peskine636c26a2020-03-04 20:46:15 +01001259 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001260 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001261
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001262 # Note: the next two invocations cover all compat.sh test cases.
1263 # We should use the same here and in basic-build-test.sh.
1264 msg "test: compat.sh: default version (full config, ASan build)"
1265 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001266
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001267 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1268 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001269
1270 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001271 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001272}
1273
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001274
1275component_test_full_cmake_gcc_asan_new_bignum () {
1276 msg "build: full config, cmake, gcc, ASan"
1277 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001278 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001279 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001280 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001281
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001282 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001283 make test
1284
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001285 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001286 programs/test/selftest
1287
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001288 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001289 tests/ssl-opt.sh
1290
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001291 # Note: the next two invocations cover all compat.sh test cases.
1292 # We should use the same here and in basic-build-test.sh.
1293 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1294 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001295
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001296 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1297 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001298
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001299 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001300 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001301}
1302
Ronald Cronc3623db2020-10-29 10:51:32 +01001303component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001304 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001305 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001306 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1307 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1308 make
1309
1310 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1311 make test
1312}
1313
David Horstmann4a48bec2024-03-13 15:42:31 +00001314component_test_psa_assume_exclusive_buffers () {
1315 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001316 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001317 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001318 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1319 make
1320
David Horstmann4a48bec2024-03-13 15:42:31 +00001321 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001322 make test
1323}
1324
Gilles Peskinea3548672021-06-17 11:37:52 +02001325# check_renamed_symbols HEADER LIB
1326# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1327# name is LIB.
1328check_renamed_symbols () {
1329 ! nm "$2" | sed 's/.* //' |
1330 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1331}
1332
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001333component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001334 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001335 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001336 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1337 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1338 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1339 # We can only compile, not link, since our test and sample programs
1340 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1341 # is active.
1342 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001343
1344 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1345 # version is not present.
1346 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001347 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001348}
1349
Valerio Setti63097752024-03-12 13:18:13 +01001350# Get a list of library-wise undefined symbols and ensure that they only
1351# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1352# This function is a common helper used by both:
1353# - component_test_default_psa_crypto_client_without_crypto_provider
1354# - component_build_full_psa_crypto_client_without_crypto_provider.
1355common_check_mbedtls_missing_symbols() {
1356 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1357 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1358 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1359 not grep mbedtls_ linking_errors.txt
1360
1361 rm sym_def.txt sym_undef.txt linking_errors.txt
1362}
1363
1364component_test_default_psa_crypto_client_without_crypto_provider () {
1365 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1366
Ronald Cron336678b2021-01-28 17:54:24 +01001367 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1368 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001369 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001370 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001371 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001372 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001373
Ronald Cron336678b2021-01-28 17:54:24 +01001374 make
1375
Valerio Setti63097752024-03-12 13:18:13 +01001376 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1377 common_check_mbedtls_missing_symbols
1378
1379 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001380 make test
1381}
1382
Valerio Setti63097752024-03-12 13:18:13 +01001383component_build_full_psa_crypto_client_without_crypto_provider () {
1384 msg "build: full config - PSA_CRYPTO_C"
1385
1386 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1387 scripts/config.py full
1388
1389 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1390 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1391 # Dynamic secure element support is a deprecated feature and it is not
1392 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1393 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1394
1395 # Since there is no crypto provider in this build it is not possible to
1396 # build all the test executables and progrems due to missing PSA functions
1397 # at link time. Therefore we will just build libraries and we'll check
1398 # that symbols of interest are there.
1399 make lib
1400
1401 msg "check missing symbols: full config - PSA_CRYPTO_C"
1402
1403 common_check_mbedtls_missing_symbols
1404
1405 # Ensure that desired functions are included into the build (extend the
1406 # following list as required).
1407 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1408 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1409 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1410}
1411
Ryan Everettdaa322a2024-04-18 16:48:55 +01001412component_test_no_rsa_key_pair_generation() {
1413 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001414 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001415 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001416 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001417 make
1418
Ryan Everettdaa322a2024-04-18 16:48:55 +01001419 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001420 make test
1421}
1422
Gilles Peskine782f4112018-11-27 16:11:09 +01001423component_test_ref_configs () {
1424 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001425 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1426 # want to re-generate generated files that depend on it, quite correctly.
1427 # However this doesn't work as the generation script expects a specific
1428 # format for mbedtls_config.h, which the other files don't follow. Also,
1429 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001430 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001431 # whether they're on or off. So, disable cmake's (over-sensitive here)
1432 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001433 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001434 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001435 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001436}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001437
Gilles Peskine8f073122018-11-27 15:58:47 +01001438component_test_no_renegotiation () {
1439 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001440 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001441 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001442 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001443
Gilles Peskine8f073122018-11-27 15:58:47 +01001444 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1445 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001446
Gilles Peskine8f073122018-11-27 15:58:47 +01001447 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001448 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001449}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001450
Gilles Peskine636c26a2020-03-04 20:46:15 +01001451component_test_no_pem_no_fs () {
1452 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1453 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1454 scripts/config.py unset MBEDTLS_FS_IO
1455 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1456 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001457 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001458 make
1459
1460 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1461 make test
1462
1463 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001464 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001465}
1466
Gilles Peskine8f073122018-11-27 15:58:47 +01001467component_test_rsa_no_crt () {
1468 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001469 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001470 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001471 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001472
Gilles Peskine8f073122018-11-27 15:58:47 +01001473 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1474 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001475
Gilles Peskine8f073122018-11-27 15:58:47 +01001476 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001477 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001478
Gilles Peskine8f073122018-11-27 15:58:47 +01001479 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001480 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001481
1482 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001483 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001484}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001485
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001486component_test_no_ctr_drbg_classic () {
1487 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001488 scripts/config.py full
1489 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001490 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001491 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001492
Dave Rodgman17127e92023-12-14 16:42:48 +00001493 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001494 make
1495
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001496 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001497 make test
1498
Gilles Peskineba749042021-01-13 20:02:03 +01001499 # In this configuration, the TLS test programs use HMAC_DRBG.
1500 # The SSL tests are slow, so run a small subset, just enough to get
1501 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001502 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001503 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001504
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001505 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001506 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001507}
1508
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001509component_test_no_ctr_drbg_use_psa () {
1510 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001511 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001512 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1513 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001514
Dave Rodgman17127e92023-12-14 16:42:48 +00001515 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001516 make
1517
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001518 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1519 make test
1520
1521 # In this configuration, the TLS test programs use HMAC_DRBG.
1522 # The SSL tests are slow, so run a small subset, just enough to get
1523 # confidence that the SSL code copes with HMAC_DRBG.
1524 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001525 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001526
1527 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001528 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001529}
1530
1531component_test_no_hmac_drbg_classic () {
1532 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1533 scripts/config.py full
1534 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1535 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1536 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001537 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001538
Dave Rodgman17127e92023-12-14 16:42:48 +00001539 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001540 make
1541
1542 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001543 make test
1544
Gilles Peskinea2224342020-11-19 22:14:34 +01001545 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1546 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1547 # instead.
1548 # Test SSL with non-deterministic ECDSA. Only test features that
1549 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001550 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001551 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001552
1553 # To save time, only test one protocol version, since this part of
1554 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001555 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001556 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001557}
1558
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001559component_test_no_hmac_drbg_use_psa () {
1560 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1561 scripts/config.py full
1562 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1563 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1564 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1565
Dave Rodgman17127e92023-12-14 16:42:48 +00001566 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001567 make
1568
1569 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1570 make test
1571
1572 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1573 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1574 # instead.
1575 # Test SSL with non-deterministic ECDSA. Only test features that
1576 # might be affected by how ECDSA signature is performed.
1577 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001578 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001579
1580 # To save time, only test one protocol version, since this part of
1581 # the protocol is identical in (D)TLS up to 1.2.
1582 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001583 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001584}
1585
1586component_test_psa_external_rng_no_drbg_classic () {
1587 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1588 scripts/config.py full
1589 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001590 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001591 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001592 scripts/config.py unset MBEDTLS_ENTROPY_C
1593 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1594 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001595 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1596 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1597 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001598 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1599 # the SSL test programs don't have an RNG and can't work. Explicitly
1600 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001601 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001602
1603 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1604 make test
1605
Gilles Peskine8eb29432021-02-03 20:07:11 +01001606 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001607 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001608}
1609
1610component_test_psa_external_rng_no_drbg_use_psa () {
1611 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001612 scripts/config.py full
1613 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001614 scripts/config.py unset MBEDTLS_ENTROPY_C
1615 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1616 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001617 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1618 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1619 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001620 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001621
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001622 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001623 make test
1624
Gilles Peskine8eb29432021-02-03 20:07:11 +01001625 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001626 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001627}
1628
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001629component_test_psa_external_rng_use_psa_crypto () {
1630 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1631 scripts/config.py full
1632 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1633 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1634 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001635 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001636
1637 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1638 make test
1639
1640 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1641 tests/ssl-opt.sh -f 'Default\|opaque'
1642}
1643
Gilles Peskine801c4332023-04-28 21:04:28 +02001644component_test_psa_inject_entropy () {
1645 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1646 scripts/config.py full
1647 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1648 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1649 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1650 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1651 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1652 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001653 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 +02001654
1655 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1656 make test
1657}
1658
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001659component_test_sw_inet_pton () {
1660 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1661
1662 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1663 scripts/config.py set MBEDTLS_TEST_HOOKS
1664 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1665
1666 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1667 make test
1668}
1669
Valerio Settia41654d2024-02-08 10:33:11 +01001670component_full_no_pkparse_pkwrite() {
1671 msg "build: full without pkparse and pkwrite"
1672
1673 scripts/config.py crypto_full
1674 scripts/config.py unset MBEDTLS_PK_PARSE_C
1675 scripts/config.py unset MBEDTLS_PK_WRITE_C
1676
Valerio Settia41654d2024-02-08 10:33:11 +01001677 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1678
1679 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1680 not grep mbedtls_pk_parse_key library/pkparse.o
1681 not grep mbedtls_pk_write_key_der library/pkwrite.o
1682
1683 msg "test: full without pkparse and pkwrite"
1684 make test
1685}
1686
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001687component_test_crypto_full_md_light_only () {
1688 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001689 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001690 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001691 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001692 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001693 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001694 scripts/config.py unset MBEDTLS_HKDF_C
1695 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001696 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001697 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001698 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001699 # Disable things that would auto-enable MD_C
1700 scripts/config.py unset MBEDTLS_PKCS5_C
1701
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001702 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1703 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001704 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001705
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001706 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001707 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001708 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001709
1710 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001711 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001712}
1713
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001714component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001715 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001716 scripts/config.py full
1717 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001718 # Don't pull in cipher via PSA mechanisms
1719 # (currently ignored anyway because we completely disable PSA)
1720 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001721 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001722 scripts/config.py unset MBEDTLS_CMAC_C
1723 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001724 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001725 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001726 scripts/config.py unset MBEDTLS_SSL_TLS_C
1727 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001728 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001729 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1730 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001731 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001732 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001733 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001734
Valerio Settidf17a102023-10-23 14:14:19 +02001735 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001736 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001737}
1738
Valerio Setti7e710e82023-08-25 09:14:15 +02001739# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001740# - component_test_full_no_cipher_with_psa_crypto
1741# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001742# It accepts 2 input parameters:
1743# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1744# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001745common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001746 USE_CRYPTO_CONFIG="$1"
1747 COMPONENT_DESCRIPTION="$2"
1748
1749 msg "build: $COMPONENT_DESCRIPTION"
1750
1751 scripts/config.py full
1752 scripts/config.py unset MBEDTLS_CIPHER_C
1753
1754 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001755 # The built-in implementation of the following algs/key-types depends
1756 # on CIPHER_C so we disable them.
1757 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1758 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001759 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001760 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1761 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1762 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1763 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1764 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1765 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1766 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
Ronald Crona33a8242024-05-15 18:31:17 +02001767 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti7e710e82023-08-25 09:14:15 +02001768 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001769 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001770 else
1771 # Don't pull in cipher via PSA mechanisms
1772 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001773 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1774 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1775 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001776 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001777 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001778 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001779 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001780
Gilles Peskine21570cf2023-12-22 11:49:50 +01001781 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001782
Valerio Setti7e710e82023-08-25 09:14:15 +02001783 # Ensure that CIPHER_C was not re-enabled
1784 not grep mbedtls_cipher_init library/cipher.o
1785
1786 msg "test: $COMPONENT_DESCRIPTION"
1787 make test
1788}
1789
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001790component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001791 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001792}
1793
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001794component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001795 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001796}
1797
Valerio Settibdfecb62023-11-07 15:37:20 +01001798component_test_full_no_ccm() {
1799 msg "build: full no PSA_WANT_ALG_CCM"
1800
1801 # Full config enables:
1802 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1803 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1804 scripts/config.py full
1805
1806 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1807 # enabled, but not used from TLS since USE_PSA is set.
1808 # This is helpful to ensure that TLS tests below have proper dependencies.
1809 #
1810 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1811 # PSA_WANT_ALG_CCM to be re-enabled.
1812 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1813
Gilles Peskine21570cf2023-12-22 11:49:50 +01001814 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001815
1816 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001817 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001818}
1819
1820component_test_full_no_ccm_star_no_tag() {
1821 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1822
1823 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1824 scripts/config.py full
1825
1826 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1827 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1828 # This basically disables all unauthenticated ciphers on the PSA side, while
1829 # keeping AEADs enabled.
1830 #
1831 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1832 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1833 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1834 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1835 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1836 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1837 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1838 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1839 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1840 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1841
Gilles Peskine21570cf2023-12-22 11:49:50 +01001842 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001843
1844 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001845 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001846
1847 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001848 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001849}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001850
Valerio Settie1655b82023-01-03 15:35:25 +01001851component_test_full_no_bignum () {
1852 msg "build: full minus bignum"
1853 scripts/config.py full
1854 scripts/config.py unset MBEDTLS_BIGNUM_C
1855 # Direct dependencies of bignum
1856 scripts/config.py unset MBEDTLS_ECP_C
1857 scripts/config.py unset MBEDTLS_RSA_C
1858 scripts/config.py unset MBEDTLS_DHM_C
1859 # Direct dependencies of ECP
1860 scripts/config.py unset MBEDTLS_ECDH_C
1861 scripts/config.py unset MBEDTLS_ECDSA_C
1862 scripts/config.py unset MBEDTLS_ECJPAKE_C
1863 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001864 # Disable what auto-enables ECP_LIGHT
1865 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1866 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001867 # Indirect dependencies of ECP
1868 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1869 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1870 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1871 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1872 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1873 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1874 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1875 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1876 # Direct dependencies of DHM
1877 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1878 # Direct dependencies of RSA
1879 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1880 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1881 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1882 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1883 # PK and its dependencies
1884 scripts/config.py unset MBEDTLS_PK_C
1885 scripts/config.py unset MBEDTLS_PK_PARSE_C
1886 scripts/config.py unset MBEDTLS_PK_WRITE_C
1887 scripts/config.py unset MBEDTLS_X509_USE_C
1888 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1889 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1890 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1891 scripts/config.py unset MBEDTLS_X509_CREATE_C
1892 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1893 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1894 scripts/config.py unset MBEDTLS_PKCS7_C
1895 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1896 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1897 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1898
Gilles Peskine21570cf2023-12-22 11:49:50 +01001899 make
Valerio Settie1655b82023-01-03 15:35:25 +01001900
1901 msg "test: full minus bignum"
1902 make test
1903}
1904
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001905component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001906 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001907
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001908 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001909 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001910 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001911 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001912 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001913 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1914 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001915 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001916 scripts/config.py unset MBEDTLS_GCM_C
1917 scripts/config.py unset MBEDTLS_CCM_C
1918 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001919 #Disable TLS 1.3 (as no AEAD)
1920 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Thomas Daubneyb8cbbe72024-04-26 16:32:48 +01001921 # Disable CBC. Note: When implemented, PSA_WANT_ALG_CBC_MAC will also need to be unset here to fully disable CBC
1922 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1923 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001924 # 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 +01001925 # Note: The unset below is to be removed for 4.0
Przemek Stekiel9550c052022-09-28 09:51:55 +02001926 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001927 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001928 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001929 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1930 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001931 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001932 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001933 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001934
Przemek Stekiel9550c052022-09-28 09:51:55 +02001935 make
1936
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001937 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001938 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001939
1940 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001941}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001942
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001943component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001944 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001945
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001946 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubney62586212024-04-26 17:01:16 +01001947 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001948 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubney62586212024-04-26 17:01:16 +01001949 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001950 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubney62586212024-04-26 17:01:16 +01001951 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1952 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001953 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001954 scripts/config.py unset MBEDTLS_GCM_C
1955 scripts/config.py unset MBEDTLS_CCM_C
1956 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001957 #Disable TLS 1.3 (as no AEAD)
1958 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001959 # 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 +01001960 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001961 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001962 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001963 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001964 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001965 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001966 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001967 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001968
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001969 make
1970
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001971 msg "test: default with only CBC-legacy cipher use psa"
1972 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001973
1974 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1975 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001976}
1977
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001978component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001979 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001980
1981 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001982 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001983 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001984 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM
Thomas Daubneya8004f22024-05-17 14:46:07 +01001985 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Thomas Daubneyff33abd2024-04-26 17:08:34 +01001986 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_GCM
1987 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CHACHA20_POLY1305
Thomas Daubney1ca1f3d2024-05-02 09:48:29 +01001988 # Note: The three unsets below are to be removed for Mbed TLS 4.0
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001989 scripts/config.py unset MBEDTLS_GCM_C
1990 scripts/config.py unset MBEDTLS_CCM_C
1991 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001992 #Disable TLS 1.3 (as no AEAD)
1993 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001994 # 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 +01001995 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_CBC_NO_PADDING
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001996 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1997 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1998 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001999 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002000 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002001 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002002 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002003
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002004 make
2005
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002006 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002007 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002008
2009 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2010 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002011}
2012
Valerio Setti9f0ec532022-11-08 13:03:24 +01002013# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2014# that we could use for interop testing. However, we now have sort of two
2015# implementations ourselves: one using PSA, the other not. At least test that
2016# these two interoperate with each other.
2017component_test_tls1_2_ecjpake_compatibility() {
2018 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2019 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002020 # Explicitly make lib first to avoid a race condition:
2021 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2022 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002023 make -C programs ssl/ssl_server2 ssl/ssl_client2
2024 cp programs/ssl/ssl_server2 s2_no_use_psa
2025 cp programs/ssl/ssl_client2 c2_no_use_psa
2026
2027 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2028 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2029 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002030 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002031 make -C programs ssl/ssl_server2 ssl/ssl_client2
2032 make -C programs test/udp_proxy test/query_compile_time_config
2033
Valerio Setti70e02902022-12-02 16:21:56 +01002034 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2035 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2036 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2037 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2038 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2039 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2040 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2041 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 +01002042
2043 rm s2_no_use_psa c2_no_use_psa
2044}
2045
Gilles Peskine636c26a2020-03-04 20:46:15 +01002046component_test_everest () {
2047 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2048 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2049 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2050 make
2051
2052 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2053 make test
2054
Gilles Peskine6848d172023-11-02 19:58:03 +01002055 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002056 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002057
Gilles Peskine636c26a2020-03-04 20:46:15 +01002058 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2059 tests/ssl-opt.sh -f ECDH
2060
2061 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2062 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002063 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002064}
2065
Gilles Peskined3beca92020-07-03 00:15:37 +02002066component_test_everest_curve25519_only () {
2067 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002068 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2069 scripts/config.py unset MBEDTLS_ECDSA_C
2070 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2071 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002072 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002073 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002074 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002075 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2076
Dave Rodgman17127e92023-12-14 16:42:48 +00002077 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002078
2079 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2080 make test
2081}
2082
Gilles Peskine8f073122018-11-27 15:58:47 +01002083component_test_small_ssl_out_content_len () {
2084 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002085 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2086 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002087 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002088 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002089
Gilles Peskine8f073122018-11-27 15:58:47 +01002090 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002091 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002092}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002093
Gilles Peskine8f073122018-11-27 15:58:47 +01002094component_test_small_ssl_in_content_len () {
2095 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002096 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2097 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002098 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002099 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002100
Gilles Peskine8f073122018-11-27 15:58:47 +01002101 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002102 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002103}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002104
Gilles Peskine8f073122018-11-27 15:58:47 +01002105component_test_small_ssl_dtls_max_buffering () {
2106 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002107 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002108 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002109 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002110
Gilles Peskine8f073122018-11-27 15:58:47 +01002111 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002112 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 +01002113}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002114
Gilles Peskine8f073122018-11-27 15:58:47 +01002115component_test_small_mbedtls_ssl_dtls_max_buffering () {
2116 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002117 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002118 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002119 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002120
Gilles Peskine8f073122018-11-27 15:58:47 +01002121 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002122 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002123}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002124
Gilles Peskine75cc7712019-09-06 19:47:17 +02002125component_test_psa_collect_statuses () {
2126 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002127 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002128 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002129 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002130 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002131 rm -f tests/statuses.log
2132}
2133
Gilles Peskine8f073122018-11-27 15:58:47 +01002134component_test_full_cmake_clang () {
2135 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002136 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002137 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 +01002138 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002139
k-stachowiak0291cb72019-06-26 15:52:12 +02002140 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002141 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002142
Gilles Peskineda6017c2022-10-30 21:02:40 +01002143 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2144 programs/test/cpp_dummy_build
2145
Gilles Peskine6848d172023-11-02 19:58:03 +01002146 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002147 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002148
Gilles Peskine82b27272019-06-14 18:27:03 +02002149 msg "program demos (full config, clang)" # ~10s
2150 tests/scripts/run_demos.py
2151
k-stachowiak0291cb72019-06-26 15:52:12 +02002152 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002153 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002154
Gilles Peskine8f073122018-11-27 15:58:47 +01002155 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002156 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002157}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002158
Gilles Peskine0c671602022-11-29 16:01:41 +01002159skip_suites_without_constant_flow () {
2160 # Skip the test suites that don't have any constant-flow annotations.
2161 # This will need to be adjusted if we ever start declaring things as
2162 # secret from macros or functions inside tests/include or tests/src.
2163 SKIP_TEST_SUITES=$(
2164 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2165 sed 's/test_suite_//; s/\.function$//' |
2166 tr '\n' ,)
2167 export SKIP_TEST_SUITES
2168}
2169
Dave Rodgman246210e2023-07-31 18:07:44 +01002170skip_all_except_given_suite () {
2171 # Skip all but the given test suite
2172 SKIP_TEST_SUITES=$(
2173 ls -1 tests/suites/test_suite_*.function |
2174 grep -v $1.function |
2175 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2176 tr '\n' ,)
2177 export SKIP_TEST_SUITES
2178}
2179
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002180component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002181 # This tests both (1) accesses to undefined memory, and (2) branches or
2182 # memory access depending on secret values. To distinguish between those:
2183 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2184 # - or alternatively, change the build type to MemSanDbg, which enables
2185 # origin tracking and nicer stack traces (which are useful for debugging
2186 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002187 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2188 scripts/config.py full
2189 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2190 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2191 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2192 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2193 make
2194
2195 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2196 make test
2197}
2198
2199component_test_memsan_constant_flow_psa () {
2200 # This tests both (1) accesses to undefined memory, and (2) branches or
2201 # memory access depending on secret values. To distinguish between those:
2202 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2203 # - or alternatively, change the build type to MemSanDbg, which enables
2204 # origin tracking and nicer stack traces (which are useful for debugging
2205 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002206 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002207 scripts/config.py full
2208 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2209 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2210 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2211 make
2212
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002213 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002214 make test
2215}
2216
Bence Szépkúti0354d042023-12-06 16:14:37 +01002217component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002218 # This tests both (1) everything that valgrind's memcheck usually checks
2219 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2220 # etc.) and (2) branches or memory access depending on secret values,
2221 # which will be reported as uninitialized memory. To distinguish between
2222 # secret and actually uninitialized:
2223 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2224 # - or alternatively, build with debug info and manually run the offending
2225 # test suite with valgrind --track-origins=yes, then check if the origin
2226 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002227 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2228 scripts/config.py full
2229 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2230 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002231 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002232 cmake -D CMAKE_BUILD_TYPE:String=Release .
2233 make
2234
2235 # this only shows a summary of the results (how many of each type)
2236 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002237 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002238 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002239
2240 # Test asm path in constant time module - by default, it will test the plain C
2241 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2242 msg "test: valgrind asm constant_time"
2243 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2244 skip_all_except_given_suite test_suite_constant_time
2245 cmake -D CMAKE_BUILD_TYPE:String=Release .
2246 make clean
2247 make
2248 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002249}
2250
Bence Szépkúti0354d042023-12-06 16:14:37 +01002251component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002252 # This tests both (1) everything that valgrind's memcheck usually checks
2253 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2254 # etc.) and (2) branches or memory access depending on secret values,
2255 # which will be reported as uninitialized memory. To distinguish between
2256 # secret and actually uninitialized:
2257 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2258 # - or alternatively, build with debug info and manually run the offending
2259 # test suite with valgrind --track-origins=yes, then check if the origin
2260 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002261 msg "build: cmake release GCC, full config with constant flow testing"
2262 scripts/config.py full
2263 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002264 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002265 cmake -D CMAKE_BUILD_TYPE:String=Release .
2266 make
2267
2268 # this only shows a summary of the results (how many of each type)
2269 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002270 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002271 make memcheck
2272}
2273
Janos Follath9338cac2023-10-04 18:55:39 +01002274component_test_tsan () {
2275 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002276 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002277 scripts/config.py set MBEDTLS_THREADING_C
2278 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002279 # Self-tests do not currently use multiple threads.
2280 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002281
Ryan6caf84f2024-03-05 13:57:00 +00002282 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2283 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2284
Janos Follath9338cac2023-10-04 18:55:39 +01002285 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2286 make
2287
2288 msg "test: main suites (TSan)"
2289 make test
2290}
2291
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002292component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002293 # Test that removing the deprecated features from the default
2294 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002295 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2296 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002297 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002298
2299 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2300 make test
2301}
2302
2303component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002304 msg "build: make, full_no_deprecated config" # ~ 30s
2305 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002306 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002307
Gilles Peskine30de2e82020-04-20 21:39:22 +02002308 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002309 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002310
2311 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2312 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002313}
2314
Gilles Peskine8386ea22020-04-30 09:07:29 +02002315component_test_full_no_deprecated_deprecated_warning () {
2316 # Test that there is nothing deprecated in "full_no_deprecated".
2317 # A deprecated feature would trigger a warning (made fatal) from
2318 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002319 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2320 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002321 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2322 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002323 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002324
Gilles Peskine30de2e82020-04-20 21:39:22 +02002325 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002326 make test
2327}
2328
Gilles Peskine8386ea22020-04-30 09:07:29 +02002329component_test_full_deprecated_warning () {
2330 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2331 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002332 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002333 scripts/config.py full
2334 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002335 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002336 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2337 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002338 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002339
Gilles Peskine8386ea22020-04-30 09:07:29 +02002340 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2341 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2342 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002343 # Expect warnings from '#warning' directives in check_config.h and
2344 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002345 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 +01002346
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002347 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2348 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002349
2350 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2351 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002352}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002353
Gilles Peskineec541fe2020-01-31 14:24:14 +01002354# Check that the specified libraries exist and are empty.
2355are_empty_libraries () {
2356 nm "$@" >/dev/null 2>/dev/null
2357 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2358}
2359
2360component_build_crypto_default () {
2361 msg "build: make, crypto only"
2362 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002363 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002364 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002365}
2366
2367component_build_crypto_full () {
2368 msg "build: make, crypto only, full config"
2369 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002370 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002371 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002372}
2373
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002374component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002375 msg "build: make, config for PSA crypto service"
2376 scripts/config.py crypto
2377 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2378 # Disable things that are not needed for just cryptography, to
2379 # reach a configuration that would be typical for a PSA cryptography
2380 # service providing all implemented PSA algorithms.
2381 # System stuff
2382 scripts/config.py unset MBEDTLS_ERROR_C
2383 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002384 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002385 # Crypto stuff with no PSA interface
2386 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002387 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002388 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002389 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002390 scripts/config.py unset MBEDTLS_NIST_KW_C
2391 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2392 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2393 scripts/config.py unset MBEDTLS_PKCS12_C
2394 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002395 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2396 # in PSA code to work with RSA keys. We don't require users to set those:
2397 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002398 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002399 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002400 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002401 make CFLAGS='-O1 -Werror' all test
2402 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2403}
2404
Gilles Peskineec541fe2020-01-31 14:24:14 +01002405component_build_crypto_baremetal () {
2406 msg "build: make, crypto only, baremetal config"
2407 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002408 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002409 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002410}
Daniel Axtens446af202020-09-02 21:30:13 +10002411support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002412 support_build_baremetal "$@"
2413}
2414
2415component_build_baremetal () {
2416 msg "build: make, baremetal config"
2417 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002418 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002419}
2420support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002421 # Older Glibc versions include time.h from other headers such as stdlib.h,
2422 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2423 # problem, Ubuntu 18.04 is ok.
2424 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2425}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002426
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002427# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002428component_test_depends_py_cipher_id () {
2429 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002430 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002431}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002432
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002433component_test_depends_py_cipher_chaining () {
2434 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002435 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002436}
2437
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002438component_test_depends_py_cipher_padding () {
2439 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002440 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002441}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002442
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002443component_test_depends_py_curves () {
2444 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002445 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002446}
2447
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002448component_test_depends_py_hashes () {
2449 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002450 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002451}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002452
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002453component_test_depends_py_kex () {
2454 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002455 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002456}
2457
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002458component_test_depends_py_pkalgs () {
2459 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002460 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002461}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002462
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002463# PSA equivalents of the depends.py tests
2464component_test_depends_py_cipher_id_psa () {
2465 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002466 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002467}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002468
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002469component_test_depends_py_cipher_chaining_psa () {
2470 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002471 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002472}
2473
2474component_test_depends_py_cipher_padding_psa () {
2475 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002476 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002477}
2478
2479component_test_depends_py_curves_psa () {
2480 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002481 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002482}
2483
2484component_test_depends_py_hashes_psa () {
2485 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002486 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002487}
2488
2489component_test_depends_py_kex_psa () {
2490 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002491 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002492}
2493
2494component_test_depends_py_pkalgs_psa () {
2495 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002496 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002497}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002498
Valerio Setti6bed64e2024-01-17 15:21:44 +01002499component_test_psa_crypto_config_ffdh_2048_only () {
2500 msg "build: full config - only DH 2048"
2501
2502 scripts/config.py full
2503
2504 # Disable all DH groups other than 2048.
2505 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2506 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2507 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2508 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2509
2510 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2511
2512 msg "test: full config - only DH 2048"
2513 make test
2514
2515 msg "ssl-opt: full config - only DH 2048"
2516 tests/ssl-opt.sh -f "ffdh"
2517}
2518
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002519component_build_no_pk_rsa_alt_support () {
2520 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2521
2522 scripts/config.py full
2523 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2524 scripts/config.py set MBEDTLS_RSA_C
2525 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2526
2527 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002528 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002529}
2530
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002531component_build_module_alt () {
2532 msg "build: MBEDTLS_XXX_ALT" # ~30s
2533 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002534
2535 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002536 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2537 scripts/config.py unset MBEDTLS_AESNI_C
2538 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002539 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002540 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2541 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002542 # You can only have one threading implementation: alt or pthread, not both.
2543 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002544 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2545 # directly and assumes the implementation works with partial groups.
2546 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002547 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2548 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2549 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002550 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2551 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2552 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002553
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002554 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2555 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2556 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002557 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002558
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002559 # We can only compile, not link, since we don't have any implementations
2560 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002561 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002562}
2563
2564component_build_dhm_alt () {
2565 msg "build: MBEDTLS_DHM_ALT" # ~30s
2566 scripts/config.py full
2567 scripts/config.py set MBEDTLS_DHM_ALT
2568 # debug.c currently references mbedtls_dhm_context fields directly.
2569 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002570 # We can only compile, not link, since we don't have any implementations
2571 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002572 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002573}
2574
Gilles Peskine64996c32024-01-23 20:25:47 +01002575component_test_no_psa_crypto_full_cmake_asan() {
2576 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2577 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002578 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002579 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002580 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002581 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002582 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002583 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002584 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002585 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002586 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002587 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002588 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002589 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002590
Gilles Peskine64996c32024-01-23 20:25:47 +01002591 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002592 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002593
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002594 # Note: ssl-opt.sh has some test cases that depend on
2595 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2596 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002597 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002598 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002599
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002600 # Note: the next two invocations cover all compat.sh test cases.
2601 # We should use the same here and in basic-build-test.sh.
2602 msg "test: compat.sh: default version (full minus PSA crypto)"
2603 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002604
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002605 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002606 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002607}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002608
Ronald Cron403c15c2021-09-13 09:38:05 +02002609component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002610 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002611
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002612 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002613 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002614 $(helper_get_psa_key_type_list "ECC") \
2615 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002616
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002617 # Configure
2618 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002619
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002620 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002621 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002622
2623 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002624 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002625
2626 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002627 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2628 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2629
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002630 # Build
2631 # -----
2632
2633 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002634 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2635 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002636
2637 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2638
Valerio Setti3fe105b2023-10-30 11:08:12 +01002639 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002640
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002641 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002642 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002643
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002644 # Run the tests
2645 # -------------
2646
Ronald Cron403c15c2021-09-13 09:38:05 +02002647 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2648 make test
2649}
2650
Valerio Setti44b178c2023-03-22 14:02:57 +01002651component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002652 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002653
2654 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002655 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002656 $(helper_get_psa_key_type_list "ECC") \
2657 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002658
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002659 # Configure
2660 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002661
Ronald Cron46ac0652024-03-18 12:39:04 +01002662 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002663 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002664
Valerio Setti44b178c2023-03-22 14:02:57 +01002665 # Disable the module that's accelerated
2666 scripts/config.py unset MBEDTLS_ECDH_C
2667
2668 # Disable things that depend on it
2669 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2670 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2671 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2672 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2673 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2674
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002675 # Build
2676 # -----
2677
2678 helper_libtestdriver1_make_drivers "$loc_accel_list"
2679
Valerio Setti3fe105b2023-10-30 11:08:12 +01002680 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002681
Valerio Setti44b178c2023-03-22 14:02:57 +01002682 # Make sure this was not re-enabled by accident (additive config)
2683 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002684
2685 # Run the tests
2686 # -------------
2687
Valerio Setti44b178c2023-03-22 14:02:57 +01002688 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002689 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002690}
2691
Przemek Stekieldccb2022023-05-11 10:48:50 +02002692component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002693 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002694
2695 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002696 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002697 $(helper_get_psa_key_type_list "DH") \
2698 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002699
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002700 # Configure
2701 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002702
Przemek Stekiel565353e2023-07-05 11:07:07 +02002703 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002704 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002705
2706 # Disable the module that's accelerated
2707 scripts/config.py unset MBEDTLS_DHM_C
2708
2709 # Disable things that depend on it
2710 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2711 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2712
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002713 # Build
2714 # -----
2715
2716 helper_libtestdriver1_make_drivers "$loc_accel_list"
2717
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002718 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002719
2720 # Make sure this was not re-enabled by accident (additive config)
2721 not grep mbedtls_dhm_ library/dhm.o
2722
2723 # Run the tests
2724 # -------------
2725
Gilles Peskine14302ed2023-07-19 19:30:04 +02002726 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002727 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002728
Gilles Peskine14302ed2023-07-19 19:30:04 +02002729 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002730 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002731}
2732
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002733component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002734 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002735
2736 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002737 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002738
2739 # Disable things that are not supported
2740 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2741 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002742 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002743
Gilles Peskine14302ed2023-07-19 19:30:04 +02002744 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002745 make test
2746
Gilles Peskine14302ed2023-07-19 19:30:04 +02002747 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002748 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002749}
2750
Valerio Setti44b178c2023-03-22 14:02:57 +01002751component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002752 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002753
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002754 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002755 $(helper_get_psa_key_type_list "ECC") \
2756 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002757
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002758 # Configure
2759 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002760
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002761 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002762
2763 # Make built-in fallback not available
2764 scripts/config.py unset MBEDTLS_ECJPAKE_C
2765 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2766
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002767 # Build
2768 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002769
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002770 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002771
Valerio Setti3fe105b2023-10-30 11:08:12 +01002772 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002773
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002774 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002775 not grep mbedtls_ecjpake_init library/ecjpake.o
2776
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002777 # Run the tests
2778 # -------------
2779
Gilles Peskine14302ed2023-07-19 19:30:04 +02002780 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002781 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002782}
2783
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002784component_test_psa_crypto_config_accel_ecc_some_key_types () {
2785 msg "build: full with accelerated EC algs and some key types"
2786
2787 # Algorithms and key types to accelerate
2788 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2789 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2790 ALG_ECDH \
2791 ALG_JPAKE \
2792 KEY_TYPE_ECC_PUBLIC_KEY \
2793 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2794 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002795 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2796 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002797
2798 # Configure
2799 # ---------
2800
2801 # start with config full for maximum coverage (also enables USE_PSA)
2802 helper_libtestdriver1_adjust_config "full"
2803
2804 # Disable modules that are accelerated - some will be re-enabled
2805 scripts/config.py unset MBEDTLS_ECDSA_C
2806 scripts/config.py unset MBEDTLS_ECDH_C
2807 scripts/config.py unset MBEDTLS_ECJPAKE_C
2808 scripts/config.py unset MBEDTLS_ECP_C
2809
2810 # Disable all curves - those that aren't accelerated should be re-enabled
2811 helper_disable_builtin_curves
2812
2813 # Restartable feature is not yet supported by PSA. Once it will in
2814 # the future, the following line could be removed (see issues
2815 # 6061, 6332 and following ones)
2816 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2817
2818 # this is not supported by the driver API yet
2819 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2820
2821 # Build
2822 # -----
2823
2824 # These hashes are needed for some ECDSA signature tests.
2825 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2826 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2827 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2828
Valerio Setti3fe105b2023-10-30 11:08:12 +01002829 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002830
2831 # ECP should be re-enabled but not the others
2832 not grep mbedtls_ecdh_ library/ecdh.o
2833 not grep mbedtls_ecdsa library/ecdsa.o
2834 not grep mbedtls_ecjpake library/ecjpake.o
2835 grep mbedtls_ecp library/ecp.o
2836
2837 # Run the tests
2838 # -------------
2839
2840 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002841 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002842}
2843
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002844# Run tests with only (non-)Weierstrass accelerated
2845# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002846# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2847# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002848common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002849 weierstrass=$1
2850 if [ $weierstrass -eq 1 ]; then
2851 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002852 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002853 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002854 fi
2855
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002856 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002857
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002858 # Note: Curves are handled in a special way by the libtestdriver machinery,
2859 # so we only want to include them in the accel list when building the main
2860 # libraries, hence the use of a separate variable.
2861 # Note: the following loop is a modified version of
2862 # helper_get_psa_curve_list that only keeps Weierstrass families.
2863 loc_weierstrass_list=""
2864 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002865 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2866 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002867 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002868 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002869 ;;
2870 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002871 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002872 ;;
2873 esac
2874 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002875 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002876 loc_curve_list=$loc_weierstrass_list
2877 else
2878 loc_curve_list=$loc_non_weierstrass_list
2879 fi
2880
Valerio Setti3fe105b2023-10-30 11:08:12 +01002881 # Algorithms and key types to accelerate
2882 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2883 ALG_ECDH \
2884 ALG_JPAKE \
2885 $(helper_get_psa_key_type_list "ECC") \
2886 $loc_curve_list"
2887
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002888 # Configure
2889 # ---------
2890
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002891 # Start with config crypto_full and remove PK_C:
2892 # that's what's supported now, see docs/driver-only-builds.md.
2893 helper_libtestdriver1_adjust_config "crypto_full"
2894 scripts/config.py unset MBEDTLS_PK_C
2895 scripts/config.py unset MBEDTLS_PK_PARSE_C
2896 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002897
2898 # Disable modules that are accelerated - some will be re-enabled
2899 scripts/config.py unset MBEDTLS_ECDSA_C
2900 scripts/config.py unset MBEDTLS_ECDH_C
2901 scripts/config.py unset MBEDTLS_ECJPAKE_C
2902 scripts/config.py unset MBEDTLS_ECP_C
2903
2904 # Disable all curves - those that aren't accelerated should be re-enabled
2905 helper_disable_builtin_curves
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
2911
2912 # this is not supported by the driver API yet
2913 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2914
2915 # Build
2916 # -----
2917
2918 # These hashes are needed for some ECDSA signature tests.
2919 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2920 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2921 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2922
Valerio Settiac7a8092023-10-31 12:23:44 +01002923 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002924
2925 # We expect ECDH to be re-enabled for the missing curves
2926 grep mbedtls_ecdh_ library/ecdh.o
2927 # We expect ECP to be re-enabled, however the parts specific to the
2928 # families of curves that are accelerated should be ommited.
2929 # - functions with mxz in the name are specific to Montgomery curves
2930 # - ecp_muladd is specific to Weierstrass curves
2931 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002932 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002933 not grep mbedtls_ecp_muladd library/ecp.o
2934 grep mxz library/ecp.o
2935 else
2936 grep mbedtls_ecp_muladd library/ecp.o
2937 not grep mxz library/ecp.o
2938 fi
2939 # We expect ECDSA and ECJPAKE to be re-enabled only when
2940 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002941 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002942 not grep mbedtls_ecdsa library/ecdsa.o
2943 not grep mbedtls_ecjpake library/ecjpake.o
2944 else
2945 grep mbedtls_ecdsa library/ecdsa.o
2946 grep mbedtls_ecjpake library/ecjpake.o
2947 fi
2948
2949 # Run the tests
2950 # -------------
2951
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002952 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2953 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002954}
2955
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002956component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002957 common_test_psa_crypto_config_accel_ecc_some_curves 1
2958}
2959
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002960component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002961 common_test_psa_crypto_config_accel_ecc_some_curves 0
2962}
2963
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002964# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2965# ECDH, ECDSA) with and without drivers.
2966# The input parameter is a boolean value which indicates:
2967# - 0 keep built-in EC algs,
2968# - 1 exclude built-in EC algs (driver only).
2969#
2970# This is used by the two following components to ensure they always use the
2971# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002972# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2973# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002974# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002975config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002976 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002977 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002978 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002979 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002980 # Disable modules that are accelerated
2981 scripts/config.py unset MBEDTLS_ECDSA_C
2982 scripts/config.py unset MBEDTLS_ECDH_C
2983 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002984 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002985 fi
2986
2987 # Restartable feature is not yet supported by PSA. Once it will in
2988 # the future, the following line could be removed (see issues
2989 # 6061, 6332 and following ones)
2990 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002991}
2992
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002993# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2994component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002995 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002996
2997 # Algorithms and key types to accelerate
2998 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2999 ALG_ECDH \
3000 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003001 $(helper_get_psa_key_type_list "ECC") \
3002 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003003
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003004 # Configure
3005 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003006
3007 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003008 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003009
Valerio Setti0a342c92023-09-01 09:12:31 +02003010 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003011 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3012 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003013
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003014 # Build
3015 # -----
3016
3017 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003018 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3019 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003020 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3021
Valerio Setti3fe105b2023-10-30 11:08:12 +01003022 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003023
3024 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3025 not grep mbedtls_ecdsa_ library/ecdsa.o
3026 not grep mbedtls_ecdh_ library/ecdh.o
3027 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003028 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003029
3030 # Run the tests
3031 # -------------
3032
Gilles Peskine14302ed2023-07-19 19:30:04 +02003033 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003034 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003035
Gilles Peskine14302ed2023-07-19 19:30:04 +02003036 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003037 tests/ssl-opt.sh
3038}
3039
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003040# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3041component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003042 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003043
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003044 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003045
Gilles Peskine21570cf2023-12-22 11:49:50 +01003046 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003047
Gilles Peskine14302ed2023-07-19 19:30:04 +02003048 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003049 make test
3050
Gilles Peskine14302ed2023-07-19 19:30:04 +02003051 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003052 tests/ssl-opt.sh
3053}
3054
Valerio Settie618cb02023-04-12 14:59:16 +02003055# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003056# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3057# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003058# to ensure that both tests use the same underlying configuration when testing
3059# driver's coverage with analyze_outcomes.py.
3060#
3061# This functions accepts 1 boolean parameter as follows:
3062# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3063# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3064# - 0: include built-in implementation of EC algorithms.
3065#
3066# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3067# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003068config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003069 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003070 # start with full config for maximum coverage (also enables USE_PSA)
3071 helper_libtestdriver1_adjust_config "full"
3072
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003073 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003074 # Disable modules that are accelerated
3075 scripts/config.py unset MBEDTLS_ECDSA_C
3076 scripts/config.py unset MBEDTLS_ECDH_C
3077 scripts/config.py unset MBEDTLS_ECJPAKE_C
3078 # Disable ECP module (entirely)
3079 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003080 fi
3081
Valerio Settiaecd32c2023-06-14 10:42:31 +02003082 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3083 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003084 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003085 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003086
Valerio Settie618cb02023-04-12 14:59:16 +02003087 # Restartable feature is not yet supported by PSA. Once it will in
3088 # the future, the following line could be removed (see issues
3089 # 6061, 6332 and following ones)
3090 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003091}
3092
3093# Build and test a configuration where driver accelerates all EC algs while
3094# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3095# side.
3096#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003097# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3098component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003099 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003100
3101 # Algorithms and key types to accelerate
3102 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3103 ALG_ECDH \
3104 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003105 $(helper_get_psa_key_type_list "ECC") \
3106 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003107
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003108 # Configure
3109 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003110
Valerio Settie618cb02023-04-12 14:59:16 +02003111 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003112 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003113 # Disable all the builtin curves. All the required algs are accelerated.
3114 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003115
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003116 # Build
3117 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003118
3119 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003120 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3121 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3122 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003123
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003124 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003125
Valerio Setti3fe105b2023-10-30 11:08:12 +01003126 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003127
3128 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3129 not grep mbedtls_ecdsa_ library/ecdsa.o
3130 not grep mbedtls_ecdh_ library/ecdh.o
3131 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003132 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003133 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003134
3135 # Run the tests
3136 # -------------
3137
Gilles Peskine14302ed2023-07-19 19:30:04 +02003138 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003139 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003140
Gilles Peskine14302ed2023-07-19 19:30:04 +02003141 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003142 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003143}
3144
3145# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003146# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003147# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003148component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003149 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003150
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003151 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003152
Gilles Peskine21570cf2023-12-22 11:49:50 +01003153 make
Valerio Settie618cb02023-04-12 14:59:16 +02003154
Gilles Peskine14302ed2023-07-19 19:30:04 +02003155 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003156 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003157
Gilles Peskine14302ed2023-07-19 19:30:04 +02003158 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003159 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003160}
3161
Valerio Setti4e2f2442023-08-15 10:10:26 +02003162# This is a common configuration helper used directly from:
3163# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3164# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3165# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003166# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003167# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003168# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003169# - this is the reference component of the above
3170# - it still disables RSA and FFDH, but it uses builtin EC algs
3171# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3172# - accelerate all EC and FFDH algs, disable only RSA
3173# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3174# - this is the reference component of the above
3175# - it still disables RSA, but it uses builtin EC and FFDH algs
3176#
3177# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003178# $1: a boolean value which states if we are testing an accelerated scenario
3179# or not.
3180# $2: a string value which states which components are tested. Allowed values
3181# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003182config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003183 driver_only="$1"
3184 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003185 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003186 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003187
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003188 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003189 # Disable modules that are accelerated
3190 scripts/config.py unset MBEDTLS_ECDSA_C
3191 scripts/config.py unset MBEDTLS_ECDH_C
3192 scripts/config.py unset MBEDTLS_ECJPAKE_C
3193 # Disable ECP module (entirely)
3194 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003195 # Also disable bignum
3196 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003197 fi
3198
3199 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3200 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3201 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3202 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3203
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003204 # RSA support is intentionally disabled on this test because RSA_C depends
3205 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003206 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3207 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 +02003208 scripts/config.py unset MBEDTLS_RSA_C
3209 scripts/config.py unset MBEDTLS_PKCS1_V15
3210 scripts/config.py unset MBEDTLS_PKCS1_V21
3211 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3212 # Also disable key exchanges that depend on RSA
3213 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3214 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3215 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3216 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3217 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3218
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003219 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003220 # When testing ECC only, we disable FFDH support, both from builtin and
3221 # PSA sides, and also disable the key exchanges that depend on DHM.
3222 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3223 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 +01003224 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003225 scripts/config.py unset MBEDTLS_DHM_C
3226 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3227 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3228 else
3229 # When testing ECC and DH instead, we disable DHM and depending key
3230 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003231 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003232 scripts/config.py unset MBEDTLS_DHM_C
3233 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3234 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3235 fi
3236 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003237
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003238 # Restartable feature is not yet supported by PSA. Once it will in
3239 # the future, the following line could be removed (see issues
3240 # 6061, 6332 and following ones)
3241 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3242}
3243
Valerio Setti4e2f2442023-08-15 10:10:26 +02003244# Common helper used by:
3245# - component_test_psa_crypto_config_accel_ecc_no_bignum
3246# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003247#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003248# The goal is to build and test accelerating either:
3249# - ECC only or
3250# - both ECC and FFDH
3251#
3252# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003253# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3254# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003255common_test_psa_crypto_config_accel_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"
3261 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003262 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003263 accel_text="ECC"
3264 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003265 fi
3266
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003267 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003268
3269 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003270 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3271 ALG_ECDH \
3272 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003273 $(helper_get_psa_key_type_list "ECC") \
3274 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003275 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003276 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003277 loc_accel_list="$loc_accel_list \
3278 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003279 $(helper_get_psa_key_type_list "DH") \
3280 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003281 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003282
3283 # Configure
3284 # ---------
3285
3286 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003287 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003288 # Disable all the builtin curves. All the required algs are accelerated.
3289 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003290
3291 # Build
3292 # -----
3293
3294 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003295 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3296 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3297 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003298
3299 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3300
Valerio Setti3fe105b2023-10-30 11:08:12 +01003301 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003302
3303 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3304 not grep mbedtls_ecdsa_ library/ecdsa.o
3305 not grep mbedtls_ecdh_ library/ecdh.o
3306 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003307 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003308 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003309 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003310 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003311 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003312
3313 # Run the tests
3314 # -------------
3315
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003316 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003317
Gilles Peskine21570cf2023-12-22 11:49:50 +01003318 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003319
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003320 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003321 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003322}
3323
Valerio Setti4e2f2442023-08-15 10:10:26 +02003324# Common helper used by:
3325# - component_test_psa_crypto_config_reference_ecc_no_bignum
3326# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3327#
3328# The goal is to build and test a reference scenario (i.e. with builtin
3329# components) compared to the ones used in
3330# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3331#
3332# It is meant to be used in conjunction with
3333# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3334# coverage analysis in "analyze_outcomes.py" script.
3335common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003336 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003337
Valerio Setti5dfaca42023-09-05 08:48:51 +02003338 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003339 if [ "$test_target" = "ECC_DH" ]; then
3340 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003341 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003342 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003343 fi
3344
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003345 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003346
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003347 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003348
Gilles Peskine21570cf2023-12-22 11:49:50 +01003349 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003350
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003351 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003352 make test
3353
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003354 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003355 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003356}
3357
Valerio Setti4e2f2442023-08-15 10:10:26 +02003358component_test_psa_crypto_config_accel_ecc_no_bignum () {
3359 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3360}
3361
3362component_test_psa_crypto_config_reference_ecc_no_bignum () {
3363 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3364}
3365
3366component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3367 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3368}
3369
3370component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3371 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3372}
3373
Valerio Settiac6d35f2023-08-04 12:49:11 +02003374# Helper for setting common configurations between:
3375# - component_test_tfm_config_p256m_driver_accel_ec()
3376# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003377common_tfm_config () {
3378 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003379 cp configs/config-tfm.h "$CONFIG_H"
3380 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3381 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003382
Yanray Wang73bb2312023-09-25 11:21:15 +08003383 # Other config adjustment to make the tests pass.
3384 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003385 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003386 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3387 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003388
Yanray Wang73bb2312023-09-25 11:21:15 +08003389 # Config adjustment for better test coverage in our environment.
3390 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003391 #
3392 # Enable filesystem I/O for the benefit of PK parse/write tests.
3393 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3394}
3395
Valerio Settiac6d35f2023-08-04 12:49:11 +02003396# Keep this in sync with component_test_tfm_config() as they are both meant
3397# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003398component_test_tfm_config_p256m_driver_accel_ec () {
3399 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3400
3401 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003402
Dave Rodgman897bb772023-11-15 16:34:20 +00003403 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003404 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003405
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003406 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3407 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003408 not grep mbedtls_ecdh_ library/ecdh.o
3409 not grep mbedtls_ecjpake_ library/ecjpake.o
3410 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3411 not grep mbedtls_ecp_ library/ecp.o
3412 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003413 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003414 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003415 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003416 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003417
Valerio Setti5e18b902023-12-04 12:07:30 +01003418 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3419 # files, so we want to ensure that it has not be re-enabled accidentally.
3420 not grep mbedtls_cipher library/cipher.o
3421
Valerio Settib7e95442023-03-21 11:52:33 +01003422 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003423 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003424 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003425}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003426
Valerio Settiac6d35f2023-08-04 12:49:11 +02003427# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3428# they are both meant to be used in analyze_outcomes.py for driver's coverage
3429# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003430component_test_tfm_config() {
3431 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003432
Dave Rodgman897bb772023-11-15 16:34:20 +00003433 # Disable P256M driver, which is on by default, so that analyze_outcomes
3434 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3435 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3436
Valerio Setti52ba0e32023-08-04 12:43:03 +02003437 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003438 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003439
Dave Rodgman897bb772023-11-15 16:34:20 +00003440 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003441 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003442
Valerio Setti5e18b902023-12-04 12:07:30 +01003443 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3444 # files, so we want to ensure that it has not be re-enabled accidentally.
3445 not grep mbedtls_cipher library/cipher.o
3446
Valerio Setti52ba0e32023-08-04 12:43:03 +02003447 msg "test: TF-M config"
3448 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003449}
3450
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003451# Common helper for component_full_without_ecdhe_ecdsa() and
3452# component_full_without_ecdhe_ecdsa_and_tls13() which:
3453# - starts from the "full" configuration minus the list of symbols passed in
3454# as 1st parameter
3455# - build
3456# - test only TLS (i.e. test_suite_tls and ssl-opt)
3457build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003458 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003459
3460 msg "build: full minus something, test TLS"
3461
3462 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003463 for sym in $symbols_to_disable; do
3464 echo "Disabling $sym"
3465 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003466 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003467
Gilles Peskine21570cf2023-12-22 11:49:50 +01003468 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003469
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003470 msg "test: full minus something, test TLS"
3471 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003472
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003473 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003474 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003475}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003476
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003477component_full_without_ecdhe_ecdsa () {
3478 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003479}
3480
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003481component_full_without_ecdhe_ecdsa_and_tls13 () {
3482 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3483 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003484}
3485
Valerio Setti249b18a2023-06-20 12:08:30 +02003486# This is an helper used by:
3487# - component_test_psa_ecc_key_pair_no_derive
3488# - component_test_psa_ecc_key_pair_no_generate
3489# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3490# enabled, but one. Input arguments are as follows:
3491# - $1 is the key type under test, i.e. ECC/RSA/DH
3492# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003493build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003494 key_type=$1
3495 unset_option=$2
3496 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003497
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003498 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003499 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003500 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3501 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3502
3503 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3504 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003505 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003506
Gilles Peskine21570cf2023-12-22 11:49:50 +01003507 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003508
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003509 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003510 make test
3511}
3512
3513component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003514 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003515}
3516
3517component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003518 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003519}
3520
Pengyu Lve705f572023-12-06 16:38:15 +08003521config_psa_crypto_accel_rsa () {
3522 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003523
Pengyu Lve705f572023-12-06 16:38:15 +08003524 # Start from crypto_full config (no X.509, no TLS)
3525 helper_libtestdriver1_adjust_config "crypto_full"
3526
3527 if [ "$driver_only" -eq 1 ]; then
3528 # Remove RSA support and its dependencies
3529 scripts/config.py unset MBEDTLS_RSA_C
3530 scripts/config.py unset MBEDTLS_PKCS1_V15
3531 scripts/config.py unset MBEDTLS_PKCS1_V21
3532
3533 # We need PEM parsing in the test library as well to support the import
3534 # of PEM encoded RSA keys.
3535 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3536 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3537 fi
3538}
3539
3540component_test_psa_crypto_config_accel_rsa_crypto () {
3541 msg "build: crypto_full with accelerated RSA"
3542
3543 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3544 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3545 KEY_TYPE_RSA_PUBLIC_KEY \
3546 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3547 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3548 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3549 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003550
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003551 # Configure
3552 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003553
Pengyu Lve705f572023-12-06 16:38:15 +08003554 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003555
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003556 # Build
3557 # -----
3558
Pengyu Lve705f572023-12-06 16:38:15 +08003559 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003560 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 +08003561 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003562 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003563
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003564 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003565
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003566 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003567 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003568
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003569 # Run the tests
3570 # -------------
3571
Pengyu Lve705f572023-12-06 16:38:15 +08003572 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003573 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003574}
3575
3576component_test_psa_crypto_config_reference_rsa_crypto () {
3577 msg "build: crypto_full with non-accelerated RSA"
3578
3579 # Configure
3580 # ---------
3581 config_psa_crypto_accel_rsa 0
3582
3583 # Build
3584 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003585 make
Pengyu Lve705f572023-12-06 16:38:15 +08003586
3587 # Run the tests
3588 # -------------
3589 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003590 make test
3591}
3592
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003593# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003594# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003595component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003596 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003597
Valerio Setti4590bc22023-06-13 15:39:23 +02003598 # Create a temporary output file unless there is already one set
3599 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3600 REMOVE_OUTCOME_ON_EXIT="no"
3601 else
3602 REMOVE_OUTCOME_ON_EXIT="yes"
3603 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3604 export MBEDTLS_TEST_OUTCOME_FILE
3605 fi
3606
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003607 # Start from crypto configuration
3608 scripts/config.py crypto
3609
3610 # Remove RSA support and its dependencies
3611 scripts/config.py unset MBEDTLS_PKCS1_V15
3612 scripts/config.py unset MBEDTLS_PKCS1_V21
3613 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3614 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3615 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3616 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3617 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3618 scripts/config.py unset MBEDTLS_RSA_C
3619 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3620
3621 # Enable PSA support
3622 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3623
Valerio Setti01cc88a2023-06-15 11:53:08 +02003624 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003625 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003626 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3627 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3628 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003629
3630 make
3631
Valerio Setti01cc88a2023-06-15 11:53:08 +02003632 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003633 make test
3634
3635 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3636 # performing RSA signature.
3637 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3638 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3639
3640 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3641 rm $MBEDTLS_TEST_OUTCOME_FILE
3642 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003643}
3644
Ronald Cronb2312452021-05-08 14:32:59 +02003645component_test_psa_crypto_config_accel_hash () {
3646 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3647
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003648 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3649 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3650 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003651
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003652 # Configure
3653 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003654
Ronald Cron46ac0652024-03-18 12:39:04 +01003655 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003656 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003657
3658 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003659 scripts/config.py unset MBEDTLS_MD5_C
3660 scripts/config.py unset MBEDTLS_RIPEMD160_C
3661 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003662 scripts/config.py unset MBEDTLS_SHA224_C
3663 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003664 scripts/config.py unset MBEDTLS_SHA384_C
3665 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003666 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003667
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003668 # Build
3669 # -----
3670
3671 helper_libtestdriver1_make_drivers "$loc_accel_list"
3672
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003673 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003674
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003675 # There's a risk of something getting re-enabled via config_psa.h;
3676 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3677 not grep mbedtls_md5 library/md5.o
3678 not grep mbedtls_sha1 library/sha1.o
3679 not grep mbedtls_sha256 library/sha256.o
3680 not grep mbedtls_sha512 library/sha512.o
3681 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003682
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003683 # Run the tests
3684 # -------------
3685
Ronald Cronb2312452021-05-08 14:32:59 +02003686 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3687 make test
3688}
3689
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003690# Auxiliary function to build config for hashes with and without drivers
3691config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003692 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003693 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003694 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003695 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003696 # disable the built-in implementation of hashes
3697 scripts/config.py unset MBEDTLS_MD5_C
3698 scripts/config.py unset MBEDTLS_RIPEMD160_C
3699 scripts/config.py unset MBEDTLS_SHA1_C
3700 scripts/config.py unset MBEDTLS_SHA224_C
3701 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003702 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003703 scripts/config.py unset MBEDTLS_SHA384_C
3704 scripts/config.py unset MBEDTLS_SHA512_C
3705 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003706 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003707 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003708}
3709
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003710# Note that component_test_psa_crypto_config_reference_hash_use_psa
3711# is related to this component and both components need to be kept in sync.
3712# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003713component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003714 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003715
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003716 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3717 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3718 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003719
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003720 # Configure
3721 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003722
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003723 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003724
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003725 # Build
3726 # -----
3727
3728 helper_libtestdriver1_make_drivers "$loc_accel_list"
3729
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003730 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003731
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003732 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003733 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003734 not grep mbedtls_md5 library/md5.o
3735 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003736 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003737 not grep mbedtls_sha512 library/sha512.o
3738 not grep mbedtls_ripemd160 library/ripemd160.o
3739
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003740 # Run the tests
3741 # -------------
3742
Gilles Peskine14302ed2023-07-19 19:30:04 +02003743 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003744 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003745
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003746 # This is mostly useful so that we can later compare outcome files with
3747 # the reference config in analyze_outcomes.py, to check that the
3748 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003749 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003750 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003751
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003752 # This is to make sure all ciphersuites are exercised, but we don't need
3753 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003754 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003755 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003756}
3757
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003758# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3759# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3760# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3761# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003762component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003763 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003764
3765 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003766
Gilles Peskine21570cf2023-12-22 11:49:50 +01003767 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003768
Gilles Peskine14302ed2023-07-19 19:30:04 +02003769 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003770 make test
3771
Gilles Peskine14302ed2023-07-19 19:30:04 +02003772 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003773 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003774}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003775
Valerio Setti8eb310c2024-01-22 16:22:57 +01003776# Auxiliary function to build config for hashes with and without drivers
3777config_psa_crypto_hmac_use_psa () {
3778 driver_only="$1"
3779 # start with config full for maximum coverage (also enables USE_PSA)
3780 helper_libtestdriver1_adjust_config "full"
3781
Valerio Setticd89b0b2024-01-24 14:24:55 +01003782 if [ "$driver_only" -eq 1 ]; then
3783 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3784 # is still enabled though (for ENTROPY_C among others).
3785 scripts/config.py unset MBEDTLS_MD_C
3786 # Disable also the builtin hashes since they are supported by the driver
3787 # and MD module is able to perform PSA dispathing.
3788 scripts/config.py unset-all MBEDTLS_SHA
3789 scripts/config.py unset MBEDTLS_MD5_C
3790 scripts/config.py unset MBEDTLS_RIPEMD160_C
3791 fi
3792
Valerio Setti8eb310c2024-01-22 16:22:57 +01003793 # Direct dependencies of MD_C. We disable them also in the reference
3794 # component to work with the same set of features.
3795 scripts/config.py unset MBEDTLS_PKCS7_C
3796 scripts/config.py unset MBEDTLS_PKCS5_C
3797 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3798 scripts/config.py unset MBEDTLS_HKDF_C
3799 # Dependencies of HMAC_DRBG
3800 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3801 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3802}
3803
3804component_test_psa_crypto_config_accel_hmac() {
3805 msg "test: full with accelerated hmac"
3806
3807 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3808 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3809 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3810 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3811
3812 # Configure
3813 # ---------
3814
3815 config_psa_crypto_hmac_use_psa 1
3816
Valerio Setti8eb310c2024-01-22 16:22:57 +01003817 # Build
3818 # -----
3819
3820 helper_libtestdriver1_make_drivers "$loc_accel_list"
3821
3822 helper_libtestdriver1_make_main "$loc_accel_list"
3823
3824 # Ensure that built-in support for HMAC is disabled.
3825 not grep mbedtls_md_hmac library/md.o
3826
3827 # Run the tests
3828 # -------------
3829
3830 msg "test: full with accelerated hmac"
3831 make test
3832}
3833
3834component_test_psa_crypto_config_reference_hmac() {
3835 msg "test: full without accelerated hmac"
3836
3837 config_psa_crypto_hmac_use_psa 0
3838
3839 make
3840
3841 msg "test: full without accelerated hmac"
3842 make test
3843}
3844
Valerio Setti9da01a72023-12-18 17:38:18 +01003845component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003846 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003847
Valerio Setti9da01a72023-12-18 17:38:18 +01003848 # Albeit this components aims at accelerating DES which should only support
3849 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3850 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003851 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3852 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3853 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003854
Valerio Setti9da01a72023-12-18 17:38:18 +01003855 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3856 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3857 # of this component. This limitation will be addressed by #8598.
3858
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003859 # Configure
3860 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003861
Valerio Setti9a427302023-10-17 11:40:42 +02003862 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003863 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003864
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003865 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003866 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3867 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3868 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3869 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3870 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3871 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3872 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003873 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003874
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003875 # Build
3876 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003877
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003878 helper_libtestdriver1_make_drivers "$loc_accel_list"
3879
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003880 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003881
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003882 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003883 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003884
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003885 # Run the tests
3886 # -------------
3887
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003888 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003889 make test
3890}
3891
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003892component_test_psa_crypto_config_accel_aead () {
3893 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3894
Valerio Setti3f02bb72023-10-02 15:57:33 +02003895 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3896 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003897
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003898 # Configure
3899 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003900
Valerio Setti3f02bb72023-10-02 15:57:33 +02003901 # Start from full config
3902 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003903
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003904 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003905 scripts/config.py unset MBEDTLS_GCM_C
3906 scripts/config.py unset MBEDTLS_CCM_C
3907 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003908
Valerio Settia50b89e2023-11-08 15:58:47 +01003909 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3910 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003911
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003912 # Build
3913 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003914
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003915 helper_libtestdriver1_make_drivers "$loc_accel_list"
3916
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003917 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003918
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003919 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003920 not grep mbedtls_ccm library/ccm.o
3921 not grep mbedtls_gcm library/gcm.o
3922 not grep mbedtls_chachapoly library/chachapoly.o
3923
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003924 # Run the tests
3925 # -------------
3926
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003927 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3928 make test
3929}
3930
Valerio Settib680fc42023-10-13 09:29:37 +02003931# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003932# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3933# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3934common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003935 # Start from the full config
3936 helper_libtestdriver1_adjust_config "full"
3937
Valerio Settib680fc42023-10-13 09:29:37 +02003938 scripts/config.py unset MBEDTLS_NIST_KW_C
3939}
3940
Valerio Settib6b301f2023-10-04 12:05:05 +02003941# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003942# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3943# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003944# are meant to be used together in analyze_outcomes.py script in order to test
3945# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003946component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3947 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003948
Valerio Settiad8b7f02023-10-25 12:39:50 +02003949 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 +01003950 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003951 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003952 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3953
3954 # Configure
3955 # ---------
3956
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003957 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003958
3959 # Disable the things that are being accelerated
3960 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3961 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3962 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3963 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3964 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3965 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3966 scripts/config.py unset MBEDTLS_GCM_C
3967 scripts/config.py unset MBEDTLS_CCM_C
3968 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003969 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003970 scripts/config.py unset MBEDTLS_DES_C
3971 scripts/config.py unset MBEDTLS_AES_C
3972 scripts/config.py unset MBEDTLS_ARIA_C
3973 scripts/config.py unset MBEDTLS_CHACHA20_C
3974 scripts/config.py unset MBEDTLS_CAMELLIA_C
3975
Valerio Settiec9b2582023-11-08 16:50:54 +01003976 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3977 # does not depend on it.
3978 scripts/config.py unset MBEDTLS_CIPHER_C
3979
Valerio Settib6b301f2023-10-04 12:05:05 +02003980 # Build
3981 # -----
3982
3983 helper_libtestdriver1_make_drivers "$loc_accel_list"
3984
3985 helper_libtestdriver1_make_main "$loc_accel_list"
3986
3987 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01003988 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02003989 not grep mbedtls_des library/des.o
3990 not grep mbedtls_aes library/aes.o
3991 not grep mbedtls_aria library/aria.o
3992 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003993 not grep mbedtls_ccm library/ccm.o
3994 not grep mbedtls_gcm library/gcm.o
3995 not grep mbedtls_chachapoly library/chachapoly.o
3996 not grep mbedtls_cmac library/cmac.o
3997
3998 # Run the tests
3999 # -------------
4000
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004001 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004002 make test
Valerio Settif9414552023-11-09 10:43:20 +01004003
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004004 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004005 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004006
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004007 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004008 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004009}
4010
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004011component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4012 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4013 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004014
Gilles Peskine21570cf2023-12-22 11:49:50 +01004015 make
Valerio Settif9414552023-11-09 10:43:20 +01004016
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004017 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004018 make test
Valerio Settif9414552023-11-09 10:43:20 +01004019
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004020 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004021 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004022
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004023 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004024 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004025}
4026
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004027common_block_cipher_dispatch() {
4028 TEST_WITH_DRIVER="$1"
4029
4030 # Start from the full config
4031 helper_libtestdriver1_adjust_config "full"
4032
4033 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4034 # Disable key types that are accelerated (there is no legacy equivalent
4035 # symbol for ECB)
4036 scripts/config.py unset MBEDTLS_AES_C
4037 scripts/config.py unset MBEDTLS_ARIA_C
4038 scripts/config.py unset MBEDTLS_CAMELLIA_C
4039 fi
4040
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004041 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004042 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004043 # Keep this also in the reference component in order to skip the same tests
4044 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004045 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4046 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4047 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4048 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4049 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4050 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4051 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02004052 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004053
4054 # Disable direct dependency on AES_C
4055 scripts/config.py unset MBEDTLS_NIST_KW_C
4056
4057 # Prevent the cipher module from using deprecated PSA path. The reason is
4058 # that otherwise there will be tests relying on "aes_info" (defined in
4059 # "cipher_wrap.c") whose functions are not available when AES_C is
4060 # not defined. ARIA and Camellia are not a problem in this case because
4061 # the PSA path is not tested for these key types.
4062 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4063}
4064
Valerio Settif8e6cba2023-12-12 11:53:39 +01004065component_test_full_block_cipher_psa_dispatch () {
4066 msg "build: full + PSA dispatch in block_cipher"
4067
4068 loc_accel_list="ALG_ECB_NO_PADDING \
4069 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4070
4071 # Configure
4072 # ---------
4073
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004074 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004075
Valerio Settif8e6cba2023-12-12 11:53:39 +01004076 # Build
4077 # -----
4078
4079 helper_libtestdriver1_make_drivers "$loc_accel_list"
4080
4081 helper_libtestdriver1_make_main "$loc_accel_list"
4082
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004083 # Make sure disabled components were not re-enabled by accident (additive
4084 # config)
4085 not grep mbedtls_aes_ library/aes.o
4086 not grep mbedtls_aria_ library/aria.o
4087 not grep mbedtls_camellia_ library/camellia.o
4088
Valerio Settif8e6cba2023-12-12 11:53:39 +01004089 # Run the tests
4090 # -------------
4091
4092 msg "test: full + PSA dispatch in block_cipher"
4093 make test
4094}
4095
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004096# This is the reference component of component_test_full_block_cipher_psa_dispatch
4097component_test_full_block_cipher_legacy_dispatch () {
4098 msg "build: full + legacy dispatch in block_cipher"
4099
4100 common_block_cipher_dispatch 0
4101
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004102 make
4103
4104 msg "test: full + legacy dispatch in block_cipher"
4105 make test
4106}
4107
Gilles Peskine36dea152023-07-20 22:19:45 +02004108component_test_aead_chachapoly_disabled() {
4109 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004110 scripts/config.py full
4111 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004112 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004113 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004114
Gilles Peskine36dea152023-07-20 22:19:45 +02004115 msg "test: full minus CHACHAPOLY"
4116 make test
4117}
4118
4119component_test_aead_only_ccm() {
4120 msg "build: full minus CHACHAPOLY and GCM"
4121 scripts/config.py full
4122 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4123 scripts/config.py unset MBEDTLS_GCM_C
4124 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4125 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004126 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004127
4128 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004129 make test
4130}
4131
Ronald Crone501d0e2023-07-10 08:31:19 +02004132component_test_ccm_aes_sha256() {
4133 msg "build: CCM + AES + SHA256 configuration"
4134
Ronald Cron7612d8c2023-07-20 10:03:54 +02004135 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004136 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004137
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004138 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004139
4140 msg "test: CCM + AES + SHA256 configuration"
4141 make test
4142}
4143
Dave Rodgman904c5892023-06-28 17:36:02 +01004144support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004145 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004146}
4147
Dave Rodgman904c5892023-06-28 17:36:02 +01004148component_build_tfm_armcc() {
4149 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004150 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004151
Dave Rodgman88651c42023-06-29 12:35:51 +01004152 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004153 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 +01004154}
4155
4156component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004157 # Check that the TF-M configuration can build cleanly with various
4158 # warning flags enabled. We don't build or run tests, since the
4159 # TF-M configuration needs a TF-M platform. A tweaked version of
4160 # the configuration that works on mainstream platforms is in
4161 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004162 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004163
Dave Rodgman88651c42023-06-29 12:35:51 +01004164 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004165 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 +01004166
Dave Rodgman904c5892023-06-28 17:36:02 +01004167 msg "build: TF-M config, gcc native build"
4168 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004169 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 +01004170}
4171
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004172# Test that the given .o file builds with all (valid) combinations of the given options.
4173#
4174# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4175#
4176# The validator function is the name of a function to validate the combination of options.
4177# It may be "" if all combinations are valid.
4178# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004179# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004180build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004181 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004182 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004183 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004184 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004185 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004186
Dave Rodgman42436102023-10-03 15:47:05 +01004187 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004188 for opt in "${options[@]}"; do
4189 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004190 done
4191
4192 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004193 cd $(dirname ${file})
4194 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004195
Dave Rodgman920343a2023-10-01 18:41:09 +01004196 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004197 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 +01004198
Dave Rodgman42436102023-10-03 15:47:05 +01004199 # Extract the command generated by the Makefile to build the target file.
4200 # This ensures that we have any include paths, macro definitions, etc
4201 # that may be applied by make.
4202 # 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 +01004203 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004204
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004205 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004206 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004207
Dave Rodgman28e38d82023-10-04 11:50:30 +01004208 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004209 source_file=${file%.o}.c
4210
4211 targets=0
4212 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004213
Dave Rodgman28e38d82023-10-04 11:50:30 +01004214 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004215 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004216 # each bit of $i is used to determine if options[i] will be set or not
4217 target="t"
4218 clang_args=""
4219 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004220 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004221 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004222 clang_args="${clang_args} ${opt}"
4223 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004224 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004225 done
4226
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004227 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004228 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004229 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004230 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004231
Dave Rodgman28e38d82023-10-04 11:50:30 +01004232 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004233 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004234 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004235 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004236
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004237 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004238
Dave Rodgman920343a2023-10-01 18:41:09 +01004239 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004240 make -s -f ${makefile} build_test_config_combos
4241 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004242
4243 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004244 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004245}
4246
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004247validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004248 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4249 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004250 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004251 fi
4252 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4253 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004254 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004255 fi
4256 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004257 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004258}
4259
4260component_build_aes_variations() {
4261 # 18s - around 90ms per clang invocation on M1 Pro
4262 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004263 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004264 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004265
Yanray Wangbc29aef2023-11-06 11:08:17 +08004266 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004267 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004268
Dave Rodgman42436102023-10-03 15:47:05 +01004269 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004270 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4271 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4272 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4273 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004274
4275 cd "$MBEDTLS_ROOT_DIR"
4276 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4277
Yanray Wang42be1ba2023-11-23 14:28:47 +08004278 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004279 # manually set or unset those configurations to check
4280 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004281 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4282 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4283 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4284 scripts/config.py unset MBEDTLS_DES_C
4285 scripts/config.py unset MBEDTLS_NIST_KW_C
4286 build_test_config_combos library/aes.o validate_aes_config_variations \
4287 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4288 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4289 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4290 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004291}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004292
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004293component_test_no_platform () {
4294 # Full configuration build, without platform support, file IO and net sockets.
4295 # This should catch missing mbedtls_printf definitions, and by disabling file
4296 # IO, it should catch missing '#include <stdio.h>'
4297 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004298 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004299 scripts/config.py unset MBEDTLS_PLATFORM_C
4300 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004301 scripts/config.py unset MBEDTLS_FS_IO
4302 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004303 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004304 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004305 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004306 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004307 # to re-enable platform integration features otherwise disabled in C99 builds
4308 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004309 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004310}
Gilles Peskine7c652162017-12-11 00:01:40 +01004311
4312component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004313 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004314 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4315 scripts/config.py full
4316 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004317 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4318 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4319 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4320 make
4321}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004322
Gilles Peskine8f073122018-11-27 15:58:47 +01004323component_build_no_ssl_srv () {
4324 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004325 scripts/config.py full
4326 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004327 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004328}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004329
Gilles Peskine8f073122018-11-27 15:58:47 +01004330component_build_no_ssl_cli () {
4331 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004332 scripts/config.py full
4333 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004334 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004335}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004336
Gilles Peskine8f073122018-11-27 15:58:47 +01004337component_build_no_sockets () {
4338 # Note, C99 compliance can also be tested with the sockets support disabled,
4339 # as that requires a POSIX platform (which isn't the same as C99).
4340 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004341 scripts/config.py full
4342 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4343 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4344 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4345}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004346
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004347component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004348 msg "build: default config with memory buffer allocator and backtrace enabled"
4349 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4350 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4351 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004352 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004353 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004354 make
4355
4356 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4357 make test
4358}
4359
4360component_test_memory_buffer_allocator () {
4361 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004362 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4363 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004364 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004365 make
4366
4367 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4368 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004369
4370 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4371 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004372 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004373}
4374
Gilles Peskine8f073122018-11-27 15:58:47 +01004375component_test_no_max_fragment_length () {
4376 # Run max fragment length tests with MFL disabled
4377 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004378 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004379 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004380 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004381
Gilles Peskine8f073122018-11-27 15:58:47 +01004382 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004383 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004384}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004385
Hanno Becker545ced42019-02-19 11:10:48 +00004386component_test_asan_remove_peer_certificate () {
4387 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004388 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004389 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004390 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004391 make
4392
4393 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4394 make test
4395
4396 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004397 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004398
4399 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004400 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004401
4402 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004403 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004404}
4405
Gilles Peskine8f073122018-11-27 15:58:47 +01004406component_test_no_max_fragment_length_small_ssl_out_content_len () {
4407 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004408 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4409 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4410 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004411 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004412 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004413
Gilles Peskine8f073122018-11-27 15:58:47 +01004414 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004415 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004416
4417 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004418 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004419}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004420
Darryl Greenaad82f92019-12-02 10:53:11 +00004421component_test_variable_ssl_in_out_buffer_len () {
4422 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4423 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004424 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004425 make
4426
4427 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4428 make test
4429
4430 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004431 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004432
4433 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004434 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004435}
4436
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004437component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004438 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004439 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004440
Dave Rodgman17127e92023-12-14 16:42:48 +00004441 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004442 make
4443
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004444 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004445 make test
4446
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004447 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004448 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004449
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004450 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004451 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004452}
4453
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004454component_test_ssl_alloc_buffer_and_mfl () {
4455 msg "build: default config with memory buffer allocator and MFL extension"
4456 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4457 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4458 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4459 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4460 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004461 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004462 make
4463
4464 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4465 make test
4466
4467 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 +02004468 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004469}
4470
Gilles Peskine636c26a2020-03-04 20:46:15 +01004471component_test_when_no_ciphersuites_have_mac () {
4472 msg "build: when no ciphersuites have MAC"
4473 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004474 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004475 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004476 make
4477
4478 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4479 make test
4480
4481 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004482 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004483}
4484
Raoul Strackxa4e86142020-06-15 17:03:13 +02004485component_test_no_date_time () {
4486 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4487 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004488 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004489 make
4490
4491 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4492 make test
4493}
4494
Gilles Peskine8f073122018-11-27 15:58:47 +01004495component_test_platform_calloc_macro () {
4496 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004497 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4498 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4499 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004500 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004501 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004502
Gilles Peskine8f073122018-11-27 15:58:47 +01004503 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4504 make test
4505}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004506
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004507component_test_malloc_0_null () {
4508 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004509 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004510 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 +02004511
4512 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4513 make test
4514
4515 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4516 # Just the calloc selftest. "make test" ran the others as part of the
4517 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004518 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004519
4520 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4521 # Run a subset of the tests. The choice is a balance between coverage
4522 # and time (including time indirectly wasted due to flaky tests).
4523 # The current choice is to skip tests whose description includes
4524 # "proxy", which is an approximation of skipping tests that use the
4525 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004526 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004527}
4528
Dave Rodgman6a08b682023-06-19 11:51:33 +01004529support_test_aesni() {
4530 # Check that gcc targets x86_64 (we can build AESNI), and check for
4531 # AESNI support on the host (we can run AESNI).
4532 #
4533 # The name of this function is possibly slightly misleading, but needs to align
4534 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004535 #
4536 # In principle 32-bit x86 can support AESNI, but our implementation does not
4537 # support 32-bit x86, so we check for x86-64.
4538 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004539 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4540 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004541 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004542}
4543
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004544component_test_aesni () { # ~ 60s
4545 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4546 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4547 #
4548 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4549 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4550 # exercise the plain C impl).
4551
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004552 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004553 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004554 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004555 scripts/config.py set MBEDTLS_HAVE_ASM
4556
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004557 # test the intrinsics implementation
4558 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004559 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004560 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004561 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004562 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004563
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004564 # test the asm implementation
4565 msg "AES tests, test assembly"
4566 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004567 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004568 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004569 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004570
4571 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004572 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004573 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004574 msg "AES tests, plain C"
4575 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004576 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004577 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004578 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004579 not grep -q "AES note: using AESNI" ./programs/test/selftest
4580 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004581
4582 # test the intrinsics implementation
4583 scripts/config.py set MBEDTLS_AESNI_C
4584 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4585 msg "AES tests, test AESNI only"
4586 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004587 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004588 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4589 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004590 grep -q "AES note: using AESNI" ./programs/test/selftest
4591 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004592}
4593
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004594component_test_sha3_variations() {
4595 msg "sha3 loop unroll variations"
4596
4597 # define minimal config sufficient to test SHA3
4598 cat > include/mbedtls/mbedtls_config.h << END
4599 #define MBEDTLS_SELF_TEST
4600 #define MBEDTLS_SHA3_C
4601END
4602
4603 msg "all loops unrolled"
4604 make clean
4605 make -C tests test_suite_shax CFLAGS="-DMBEDTLS_SHA3_THETA_UNROLL=1 -DMBEDTLS_SHA3_PI_UNROLL=1 -DMBEDTLS_SHA3_CHI_UNROLL=1 -DMBEDTLS_SHA3_RHO_UNROLL=1"
4606 ./tests/test_suite_shax
4607
4608 msg "all loops rolled up"
4609 make clean
4610 make -C tests test_suite_shax CFLAGS="-DMBEDTLS_SHA3_THETA_UNROLL=0 -DMBEDTLS_SHA3_PI_UNROLL=0 -DMBEDTLS_SHA3_CHI_UNROLL=0 -DMBEDTLS_SHA3_RHO_UNROLL=0"
4611 ./tests/test_suite_shax
4612}
4613
Jerry Yub6d39c22023-08-16 15:11:48 +08004614support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004615 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004616}
4617
4618component_test_aesni_m32 () { # ~ 60s
4619 # This tests are duplicated from component_test_aesni for i386 target
4620 #
4621 # AESNI intrinsic code supports i386 and assembly code does not support it.
4622
4623 msg "build: default config with different AES implementations"
4624 scripts/config.py set MBEDTLS_AESNI_C
4625 scripts/config.py set MBEDTLS_PADLOCK_C
4626 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4627 scripts/config.py set MBEDTLS_HAVE_ASM
4628
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004629 # test the intrinsics implementation with gcc
4630 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004631 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004632 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004633 # check that we built intrinsics - this should be used by default when supported by the compiler
4634 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4635 grep -q "AES note: using AESNI" ./programs/test/selftest
4636 grep -q "AES note: built-in implementation." ./programs/test/selftest
4637 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4638 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4639
4640 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004641 scripts/config.py unset MBEDTLS_PADLOCK_C
4642 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4643 msg "AES tests, test AESNI only"
4644 make clean
4645 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4646 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4647 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4648 grep -q "AES note: using AESNI" ./programs/test/selftest
4649 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4650 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4651 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4652}
4653
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004654support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004655 # clang >= 4 is required to build with target attributes
4656 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004657}
4658
4659component_test_aesni_m32_clang() {
4660
4661 scripts/config.py set MBEDTLS_AESNI_C
4662 scripts/config.py set MBEDTLS_PADLOCK_C
4663 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4664 scripts/config.py set MBEDTLS_HAVE_ASM
4665
4666 # test the intrinsics implementation with clang
4667 msg "AES tests, test intrinsics (clang)"
4668 make clean
4669 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4670 # check that we built intrinsics - this should be used by default when supported by the compiler
4671 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4672 grep -q "AES note: using AESNI" ./programs/test/selftest
4673 grep -q "AES note: built-in implementation." ./programs/test/selftest
4674 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4675 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4676}
4677
Jerry Yu193cbc02023-08-03 17:06:29 +08004678# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4679component_build_aes_aesce_armcc () {
4680 msg "Build: AESCE test on arm64 platform without plain C."
4681 scripts/config.py baremetal
4682
4683 # armc[56] don't support SHA-512 intrinsics
4684 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4685
4686 # Stop armclang warning about feature detection for A64_CRYPTO.
4687 # With this enabled, the library does build correctly under armclang,
4688 # but in baremetal builds (as tested here), feature detection is
4689 # unavailable, and the user is notified via a #warning. So enabling
4690 # this feature would prevent us from building with -Werror on
4691 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004692 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004693 scripts/config.py set MBEDTLS_HAVE_ASM
4694
4695 msg "AESCE, build with default configuration."
4696 scripts/config.py set MBEDTLS_AESCE_C
4697 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4698 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4699
4700 msg "AESCE, build AESCE only"
4701 scripts/config.py set MBEDTLS_AESCE_C
4702 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4703 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4704}
4705
Dave Rodgman0c584032023-10-08 12:26:54 +01004706support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004707 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004708 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004709}
4710
4711component_build_aes_armce () {
4712 # Test variations of AES with Armv8 crypto extensions
4713 scripts/config.py set MBEDTLS_AESCE_C
4714 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4715
4716 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004717 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004718
4719 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4720 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4721
4722 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4723 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4724
Dave Rodgman5e419372023-10-23 15:30:20 +01004725 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004726
Dave Rodgman5e419372023-10-23 15:30:20 +01004727 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4728 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004729
Dave Rodgman5e419372023-10-23 15:30:20 +01004730 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4731 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004732
Dave Rodgman5e419372023-10-23 15:30:20 +01004733 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4734 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004735
4736 # test for presence of AES instructions
4737 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4738 msg "clang, test A32 crypto instructions built"
4739 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4740 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4741 msg "clang, test T32 crypto instructions built"
4742 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4743 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4744 msg "clang, test aarch64 crypto instructions built"
4745 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4746 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4747
4748 # test for absence of AES instructions
4749 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4750 scripts/config.py unset MBEDTLS_AESCE_C
4751 msg "clang, test A32 crypto instructions not built"
4752 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4753 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4754 msg "clang, test T32 crypto instructions not built"
4755 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4756 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4757 msg "clang, test aarch64 crypto instructions not built"
4758 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4759 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004760}
4761
Dave Rodgman9ed18532023-10-05 00:06:47 +01004762support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004763 # clang >= 4 is required to build with SHA extensions
4764 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004765}
4766
Dave Rodgmand9e80832023-10-04 17:17:46 +01004767component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004768 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004769
4770
4771 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004772 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004773 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4774 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4775 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4776 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4777 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004778
Dave Rodgmand9e80832023-10-04 17:17:46 +01004779
Dave Rodgman94a634d2023-10-10 12:59:29 +01004780 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004781 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004782 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4783 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4784 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004785
Dave Rodgman5b89c552023-10-10 14:59:02 +01004786 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004787 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4788 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4789 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004790
Dave Rodgmancd654002023-10-05 09:40:07 +01004791
Dave Rodgman94a634d2023-10-10 12:59:29 +01004792 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004793 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004794 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4795 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4796 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4797 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4798 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004799
Dave Rodgmancd654002023-10-05 09:40:07 +01004800
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004801 # examine the disassembly for presence of SHA instructions
4802 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4803 scripts/config.py set ${opt}
4804 msg "${opt} clang, test A32 crypto instructions built"
4805 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4806 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4807
4808 msg "${opt} clang, test T32 crypto instructions built"
4809 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4810 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4811
4812 msg "${opt} clang, test aarch64 crypto instructions built"
4813 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4814 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4815 scripts/config.py unset ${opt}
4816 done
4817
4818
4819 # examine the disassembly for absence of SHA instructions
4820 msg "clang, test A32 crypto instructions not built"
4821 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4822 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4823
4824 msg "clang, test T32 crypto instructions not built"
4825 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4826 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4827
4828 msg "clang, test aarch64 crypto instructions not built"
4829 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4830 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004831}
4832
Jerry Yuc935aa62023-08-03 17:08:27 +08004833# For timebeing, no VIA Padlock platform available.
4834component_build_aes_via_padlock () {
4835
4836 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004837 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004838 scripts/config.py set MBEDTLS_PADLOCK_C
4839 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00004840 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004841 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004842
4843}
4844
4845support_build_aes_via_padlock_only () {
4846 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4847 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4848 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4849}
4850
Jerry Yu193cbc02023-08-03 17:06:29 +08004851support_build_aes_aesce_armcc () {
4852 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004853}
4854
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004855component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004856 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004857 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004858 scripts/config.py unset MBEDTLS_PADLOCK_C
4859
Dave Rodgmand8d64512023-12-19 12:20:21 +00004860 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004861
4862 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4863 make test
4864}
4865
4866component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4867 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4868 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004869 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4870 scripts/config.py unset MBEDTLS_PADLOCK_C
4871
Hanno Becker83ebf782017-07-07 12:29:15 +01004872 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004873
4874 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004875 make test
4876}
Gilles Peskine8f073122018-11-27 15:58:47 +01004877
Hanno Becker83ebf782017-07-07 12:29:15 +01004878component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004879 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4880 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4881 scripts/config.py unset MBEDTLS_PADLOCK_C
4882 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004883 scripts/config.py unset MBEDTLS_AESCE_C
4884
Dave Rodgmand8d64512023-12-19 12:20:21 +00004885 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004886
4887 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004888 make test
4889
4890 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4891 programs/test/selftest
4892}
4893
Matthias Schulz0767fda2024-02-07 10:46:28 +01004894component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004895 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4896 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004897 scripts/config.py unset MBEDTLS_PADLOCK_C
4898 scripts/config.py unset MBEDTLS_AESNI_C
4899 scripts/config.py unset MBEDTLS_AESCE_C
4900
4901 make CFLAGS='-O2 -Werror -Wall -Wextra'
4902
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004903 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004904 make test
4905}
4906
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004907component_test_aes_fewer_tables () {
4908 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004909 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004910 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004911
Gilles Peskine7c652162017-12-11 00:01:40 +01004912 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004913 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004914}
4915
4916component_test_aes_rom_tables () {
4917 msg "build: default config with AES_ROM_TABLES enabled"
4918 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004919 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004920
4921 msg "test: AES_ROM_TABLES"
4922 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004923}
4924
Gilles Peskine14c3c062018-01-29 21:25:12 +01004925component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004926 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4927 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4928 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004929 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004930
Gilles Peskine8f073122018-11-27 15:58:47 +01004931 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4932 make test
4933}
4934
Yanray Wang49cd4b52023-11-10 11:58:37 +08004935# helper for common_block_cipher_no_decrypt() which:
4936# - enable/disable the list of config options passed from -s/-u respectively.
4937# - build
4938# - test for tests_suite_xxx
4939# - selftest
4940#
4941# Usage: helper_block_cipher_no_decrypt_build_test
4942# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4943# Options: -s set_opts the list of config options to enable
4944# -u unset_opts the list of config options to disable
4945# -c cflags the list of options passed to CFLAGS
4946# -l ldflags the list of options passed to LDFLAGS
4947helper_block_cipher_no_decrypt_build_test () {
4948 while [ $# -gt 0 ]; do
4949 case "$1" in
4950 -s)
4951 shift; local set_opts="$1";;
4952 -u)
4953 shift; local unset_opts="$1";;
4954 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004955 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004956 -l)
4957 shift; local ldflags="$1";;
4958 esac
4959 shift
4960 done
4961 set_opts="${set_opts:-}"
4962 unset_opts="${unset_opts:-}"
4963 cflags="${cflags:-}"
4964 ldflags="${ldflags:-}"
4965
Yanray Wangb2d6e522023-11-13 16:57:47 +08004966 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4967 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004968
4969 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4970 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00004971 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004972
4973 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
4974 not grep mbedtls_aes_setkey_dec library/aes.o
4975 not grep mbedtls_aria_setkey_dec library/aria.o
4976 not grep mbedtls_camellia_setkey_dec library/camellia.o
4977 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
4978 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004979 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
4980 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004981
4982 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4983 make test
4984
4985 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4986 programs/test/selftest
4987}
4988
4989# This is a common configuration function used in:
4990# - component_test_block_cipher_no_decrypt_aesni_legacy()
4991# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4992# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4993# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4994# on x86.
4995common_block_cipher_no_decrypt () {
4996 # test AESNI intrinsics
4997 helper_block_cipher_no_decrypt_build_test \
4998 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004999 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005000
5001 # test AESNI assembly
5002 helper_block_cipher_no_decrypt_build_test \
5003 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005004 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005005
5006 # test AES C implementation
5007 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005008 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005009
5010 # test AESNI intrinsics for i386 target
5011 helper_block_cipher_no_decrypt_build_test \
5012 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005013 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005014 -l "-m32"
5015}
5016
Yanray Wang3ae11992023-11-13 17:32:09 +08005017# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5018# usage: 0: no PSA crypto configuration
5019# 1: use PSA crypto configuration
5020config_block_cipher_no_decrypt () {
5021 use_psa=$1
5022
Yanray Wang66111392023-10-31 18:54:54 +08005023 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005024 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5025 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005026 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005027 scripts/config.py unset MBEDTLS_NIST_KW_C
5028
Yanray Wang3ae11992023-11-13 17:32:09 +08005029 if [ "$use_psa" -eq 1 ]; then
5030 # Enable support for cryptographic mechanisms through the PSA API.
5031 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5032 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5033 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5034 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5035 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5036 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5037 fi
5038}
5039
5040component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005041 # This consistently causes an llvm crash on clang 3.8, so use gcc
5042 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005043 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005044 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005045}
5046
Yanray Wangf1496402023-11-01 18:55:13 +08005047component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005048 # This consistently causes an llvm crash on clang 3.8, so use gcc
5049 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005050 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005051 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005052}
5053
Yanray Wang66111392023-10-31 18:54:54 +08005054support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005055 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005056}
5057
Yanray Wang66111392023-10-31 18:54:54 +08005058component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005059 scripts/config.py baremetal
5060
5061 # armc[56] don't support SHA-512 intrinsics
5062 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5063
5064 # Stop armclang warning about feature detection for A64_CRYPTO.
5065 # With this enabled, the library does build correctly under armclang,
5066 # but in baremetal builds (as tested here), feature detection is
5067 # unavailable, and the user is notified via a #warning. So enabling
5068 # this feature would prevent us from building with -Werror on
5069 # armclang. Tracked in #7198.
5070 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5071 scripts/config.py set MBEDTLS_HAVE_ASM
5072
Yanray Wang3ae11992023-11-13 17:32:09 +08005073 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005074
5075 # test AESCE baremetal build
5076 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005077 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005078 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005079
Yanray Wangef1b04d2023-09-08 11:09:26 +08005080 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5081 not grep mbedtls_aes_setkey_dec library/aes.o
5082 not grep mbedtls_aria_setkey_dec library/aria.o
5083 not grep mbedtls_camellia_setkey_dec library/camellia.o
5084 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5085 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005086 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005087 not grep mbedtls_aesce_inverse_key library/aesce.o
5088 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005089}
5090
Gilles Peskine592f5912019-10-07 18:49:32 +02005091component_test_ctr_drbg_aes_256_sha_256 () {
5092 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5093 scripts/config.py full
5094 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5095 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005096 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005097 make
5098
5099 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5100 make test
5101}
5102
5103component_test_ctr_drbg_aes_128_sha_512 () {
5104 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005105 scripts/config.py full
5106 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5107 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005108 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005109 make
5110
5111 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5112 make test
5113}
5114
5115component_test_ctr_drbg_aes_128_sha_256 () {
5116 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005117 scripts/config.py full
5118 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5119 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5120 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005121 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005122 make
5123
5124 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5125 make test
5126}
5127
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005128component_test_se_default () {
5129 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005130 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005131 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005132
5133 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5134 make test
5135}
5136
Steven Cooremand57203d2020-07-16 20:28:59 +02005137component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005138 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005139 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005140 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005141 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5142 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005143 loc_cflags="${loc_cflags} -I../tests/include -O2"
5144
Gilles Peskine21570cf2023-12-22 11:49:50 +01005145 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005146
Gilles Peskine1997f302023-07-26 18:45:20 +02005147 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005148 make test
5149}
5150
Gilles Peskine8f073122018-11-27 15:58:47 +01005151component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005152 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005153 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005154 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005155 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005156}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005157
Gilles Peskinecf740502019-07-03 20:43:05 +02005158component_test_cmake_shared () {
5159 msg "build/test: cmake shared" # ~ 2min
5160 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5161 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005162 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005163 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005164 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005165}
5166
Gilles Peskineec10bf12019-09-20 19:56:06 +02005167test_build_opt () {
5168 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005169 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005170 for opt in "$@"; do
5171 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005172 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005173 # We're confident enough in compilers to not run _all_ the tests,
5174 # but at least run the unit tests. In particular, runs with
5175 # optimizations use inline assembly whereas runs with -O0
5176 # skip inline assembly.
5177 make test # ~30s
5178 make clean
5179 done
5180}
5181
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005182# For FreeBSD we invoke the function by name so this condition is added
5183# to disable the existing test_clang_opt function for linux.
5184if [[ $(uname) != "Linux" ]]; then
5185 component_test_clang_opt () {
5186 scripts/config.py full
5187 test_build_opt 'full config' clang -O0 -Os -O2
5188 }
5189fi
5190
5191component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005192 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005193 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005194}
5195support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005196 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005197}
5198
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005199component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005200 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005201 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005202}
5203support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005204 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005205}
5206
5207component_test_gcc_latest_opt () {
5208 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005209 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005210}
5211support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005212 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005213}
5214
5215component_test_gcc_earliest_opt () {
5216 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005217 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005218}
5219support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005220 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005221}
5222
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005223component_build_mbedtls_config_file () {
5224 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005225 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005226 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005227 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005228 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005229 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5230 make clean
5231
5232 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5233 # In the user config, disable one feature (for simplicity, pick a feature
5234 # that nothing else depends on).
5235 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005236 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005237 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5238
5239 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005240}
5241
Gilles Peskine7d904e72022-04-07 21:59:14 +02005242component_build_psa_config_file () {
5243 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5244 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5245 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5246 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5247 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005248 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005249 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5250 make clean
5251
5252 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005253 # In the user config, disable one feature and its dependencies, which will
5254 # reflect on the mbedtls configuration so we can query it with
5255 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005256 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005257 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005258 scripts/config.py unset MBEDTLS_CMAC_C
5259 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5260 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5261
5262 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005263}
5264
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005265component_build_psa_alt_headers () {
5266 msg "build: make with PSA alt headers" # ~20s
5267
5268 # Generate alternative versions of the substitutable headers with the
5269 # same content except different include guards.
5270 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5271
5272 # Build the library and some programs.
5273 # Don't build the fuzzers to avoid having to go through hoops to set
5274 # a correct include path for programs/fuzz/Makefile.
5275 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
5276 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\"'"
5277
5278 # Check that we're getting the alternative include guards and not the
5279 # original include guards.
5280 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5281 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5282 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5283 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5284}
5285
Dave Rodgman852de3c2023-12-14 14:46:45 +00005286component_test_m32_no_asm () {
5287 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005288 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005289 #
5290 # Note that we require gcc, because clang Asan builds fail to link for
5291 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005292 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005293 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005294 scripts/config.py unset MBEDTLS_HAVE_ASM
5295 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005296 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005297 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005298
Dave Rodgman852de3c2023-12-14 14:46:45 +00005299 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005300 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005301}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005302support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005303 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005304 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005305 *) false;;
5306 esac
5307}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005308
Gilles Peskineff0aee02021-10-05 09:36:03 +02005309component_test_m32_o2 () {
5310 # Build with optimization, to use the i386 specific inline assembly
5311 # and go faster for tests.
5312 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005313 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005314 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005315 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005316
Gilles Peskineff0aee02021-10-05 09:36:03 +02005317 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005318 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005319
Gilles Peskineff0aee02021-10-05 09:36:03 +02005320 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005321 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005322}
Gilles Peskinecf522222021-10-07 19:25:29 +02005323support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005324 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005325}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005326
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005327component_test_m32_everest () {
5328 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005329 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005330 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005331 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005332
5333 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5334 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005335
5336 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005337 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005338
5339 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5340 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005341 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005342}
5343support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005344 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005345}
5346
Gilles Peskine8f073122018-11-27 15:58:47 +01005347component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005348 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005349 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005350 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005351
5352 msg "test: 64-bit ILP32, make, gcc"
5353 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005354}
Gilles Peskine878cf602019-01-06 20:50:38 +00005355support_test_mx32 () {
5356 case $(uname -m) in
5357 amd64|x86_64) true;;
5358 *) false;;
5359 esac
5360}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005361
Peter Kolbus60c6da22018-12-27 06:59:04 -06005362component_test_min_mpi_window_size () {
5363 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005364 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005365 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005366 make
5367
5368 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5369 make test
5370}
5371
Gilles Peskine8f073122018-11-27 15:58:47 +01005372component_test_have_int32 () {
5373 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005374 scripts/config.py unset MBEDTLS_HAVE_ASM
5375 scripts/config.py unset MBEDTLS_AESNI_C
5376 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005377 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005378 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005379
Gilles Peskine8f073122018-11-27 15:58:47 +01005380 msg "test: gcc, force 32-bit bignum limbs"
5381 make test
5382}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005383
Gilles Peskine8f073122018-11-27 15:58:47 +01005384component_test_have_int64 () {
5385 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005386 scripts/config.py unset MBEDTLS_HAVE_ASM
5387 scripts/config.py unset MBEDTLS_AESNI_C
5388 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005389 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005390 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005391
Gilles Peskine8f073122018-11-27 15:58:47 +01005392 msg "test: gcc, force 64-bit bignum limbs"
5393 make test
5394}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005395
Gabor Mezeie256cc12023-07-26 17:28:48 +02005396component_test_have_int32_cmake_new_bignum () {
5397 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5398 scripts/config.py unset MBEDTLS_HAVE_ASM
5399 scripts/config.py unset MBEDTLS_AESNI_C
5400 scripts/config.py unset MBEDTLS_PADLOCK_C
5401 scripts/config.py unset MBEDTLS_AESCE_C
5402 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005403 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005404 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005405
5406 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5407 make test
5408}
5409
Gilles Peskine8f073122018-11-27 15:58:47 +01005410component_test_no_udbl_division () {
5411 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005412 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005413 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005414 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005415
Gilles Peskine8f073122018-11-27 15:58:47 +01005416 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5417 make test
5418}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005419
Gilles Peskine8f073122018-11-27 15:58:47 +01005420component_test_no_64bit_multiplication () {
5421 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005422 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005423 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005424 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005425
Gilles Peskine8f073122018-11-27 15:58:47 +01005426 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5427 make test
5428}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005429
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005430component_test_no_strings () {
5431 msg "build: no strings" # ~10s
5432 scripts/config.py full
5433 # Disable options that activate a large amount of string constants.
5434 scripts/config.py unset MBEDTLS_DEBUG_C
5435 scripts/config.py unset MBEDTLS_ERROR_C
5436 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5437 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005438 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005439
5440 msg "test: no strings" # ~ 10s
5441 make test
5442}
5443
Hanno Beckerc5722d12020-10-09 11:10:42 +01005444component_test_no_x509_info () {
5445 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5446 scripts/config.pl full
5447 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5448 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005449 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005450
5451 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5452 make test
5453
5454 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005455 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005456}
5457
Gilles Peskine8f073122018-11-27 15:58:47 +01005458component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005459 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005460 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005461 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 +02005462
Gilles Peskinee36fe812021-09-01 20:00:33 +02005463 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005464 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005465}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005466
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005467component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005468 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005469 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005470 # Build for a target platform that's close to what Debian uses
5471 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005472 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005473 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005474 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005475 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'
5476
Gilles Peskinee36fe812021-09-01 20:00:33 +02005477 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005478 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005479}
5480support_build_arm_linux_gnueabi_gcc_arm5vte () {
5481 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5482}
5483
5484component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005485 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005486 scripts/config.py baremetal
5487 # This is an imperfect substitute for
5488 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005489 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005490 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 +02005491
Gilles Peskinee36fe812021-09-01 20:00:33 +02005492 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005493 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005494}
5495
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005496component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005497 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5498 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005499 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 +02005500
Gilles Peskinee36fe812021-09-01 20:00:33 +02005501 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005502 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005503 for lib in library/*.a; do
5504 echo "$lib:"
5505 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5506 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005507}
5508
Gilles Peskine8f073122018-11-27 15:58:47 +01005509component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005510 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005511 scripts/config.py baremetal
5512 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005513 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 +01005514 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005515 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005516}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005517
Gilles Peskine8f073122018-11-27 15:58:47 +01005518component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005519 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005520 scripts/config.py baremetal
5521 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005522 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 +01005523 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005524 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005525}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005526
Dave Rodgman8c315f22023-06-02 10:26:24 -04005527component_build_arm_clang_thumb () {
5528 # ~ 30s
5529
5530 scripts/config.py baremetal
5531
5532 msg "build: clang thumb 2, make"
5533 make clean
5534 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5535
5536 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5537 msg "build: clang thumb 1 -O0, make"
5538 make clean
5539 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5540
5541 msg "build: clang thumb 1 -Os, make"
5542 make clean
5543 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5544}
5545
Gilles Peskine8f073122018-11-27 15:58:47 +01005546component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005547 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005548 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005549 # armc[56] don't support SHA-512 intrinsics
5550 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005551
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005552 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5553 scripts/config.py unset MBEDTLS_AESCE_C
5554
Dave Rodgman0fddf822023-03-02 15:32:12 +00005555 # Stop armclang warning about feature detection for A64_CRYPTO.
5556 # With this enabled, the library does build correctly under armclang,
5557 # but in baremetal builds (as tested here), feature detection is
5558 # unavailable, and the user is notified via a #warning. So enabling
5559 # this feature would prevent us from building with -Werror on
5560 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005561 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005562
Hanno Beckerf0762e92022-07-15 12:08:19 +01005563 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005564
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005565 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005566
5567 msg "size: ARM Compiler 5"
5568 "$ARMC5_FROMELF" -z library/*.o
5569
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005570 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005571
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005572 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005573 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005574
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005575 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005576 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5577
5578 # ARM Compiler 6 - Target ARMv7-M+DSP
5579 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005580
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005581 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005582 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005583
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005584 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005585 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005586
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005587 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5588 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5589
Dave Rodgman99318e62023-05-24 12:27:42 +01005590 # ARM Compiler 6 - Target Cortex-M0
5591 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005592
5593 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5594 #
5595 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5596 # that we have in our CI
5597 scripts/config.py set MBEDTLS_AESCE_C
5598 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005599}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005600
Pengyu Lvdf070032023-02-24 16:03:31 +08005601support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005602 armc5_cc="$ARMC5_BIN_DIR/armcc"
5603 armc6_cc="$ARMC6_BIN_DIR/armclang"
5604 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005605}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005606
Ronald Crond2cb7f42024-03-18 12:49:18 +01005607component_test_tls12_only () {
5608 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5609 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5610 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5611 make
5612
5613 msg "test: main suites (inc. selftests) (ASan build)"
5614 make test
5615
5616 msg "test: ssl-opt.sh (ASan build)"
5617 tests/ssl-opt.sh
5618
5619 msg "test: compat.sh (ASan build)"
5620 tests/compat.sh
5621}
5622
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005623component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005624 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005625 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005626 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005627 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5628
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005629 msg "test: TLS 1.3 only, all key exchange modes enabled"
5630 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005631
Ronald Cronc3f43b62022-10-17 17:35:32 +02005632 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5633 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005634}
5635
Ronald Cronc3f43b62022-10-17 17:35:32 +02005636component_test_tls13_only_psk () {
5637 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5638 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5639 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5640 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005641 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005642 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5643 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5644 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5645 scripts/config.py unset MBEDTLS_ECDSA_C
5646 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005647 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005648 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005649 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5650
Ronald Cronc3f43b62022-10-17 17:35:32 +02005651 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5652 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005653
Ronald Cronc3f43b62022-10-17 17:35:32 +02005654 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5655 tests/ssl-opt.sh
5656}
5657
5658component_test_tls13_only_ephemeral () {
5659 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5660 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5661 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005662 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005663 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5664
5665 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5666 cd tests; ./test_suite_ssl; cd ..
5667
5668 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5669 tests/ssl-opt.sh
5670}
5671
Przemek Stekiela01c2422023-06-13 10:46:48 +02005672component_test_tls13_only_ephemeral_ffdh () {
5673 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5674 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5675 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5676 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005677 scripts/config.py unset MBEDTLS_ECDH_C
5678
Przemek Stekiela01c2422023-06-13 10:46:48 +02005679 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5680
5681 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5682 cd tests; ./test_suite_ssl; cd ..
5683
5684 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5685 tests/ssl-opt.sh
5686}
5687
Ronald Cronc3f43b62022-10-17 17:35:32 +02005688component_test_tls13_only_psk_ephemeral () {
5689 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5690 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5691 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5692 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5693 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5694 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5695 scripts/config.py unset MBEDTLS_ECDSA_C
5696 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005697 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005698 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005699 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5700
5701 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5702 cd tests; ./test_suite_ssl; cd ..
5703
5704 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5705 tests/ssl-opt.sh
5706}
5707
Przemek Stekiela01c2422023-06-13 10:46:48 +02005708component_test_tls13_only_psk_ephemeral_ffdh () {
5709 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5710 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5711 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5712 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5713 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5714 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5715 scripts/config.py unset MBEDTLS_ECDSA_C
5716 scripts/config.py unset MBEDTLS_PKCS1_V21
5717 scripts/config.py unset MBEDTLS_PKCS7_C
5718 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005719 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005720 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5721
5722 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5723 cd tests; ./test_suite_ssl; cd ..
5724
5725 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5726 tests/ssl-opt.sh
5727}
5728
Ronald Cronc3f43b62022-10-17 17:35:32 +02005729component_test_tls13_only_psk_all () {
5730 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5731 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5732 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5733 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5734 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5735 scripts/config.py unset MBEDTLS_ECDSA_C
5736 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005737 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005738 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005739 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5740
5741 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5742 cd tests; ./test_suite_ssl; cd ..
5743
5744 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5745 tests/ssl-opt.sh
5746}
5747
5748component_test_tls13_only_ephemeral_all () {
5749 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5750 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005751 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005752 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5753
5754 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5755 cd tests; ./test_suite_ssl; cd ..
5756
5757 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5758 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005759}
5760
Ronald Cron46ac0652024-03-18 12:39:04 +01005761component_test_tls13_no_padding () {
5762 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005763 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005764 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005765 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005766 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005767 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005768 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005769 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005770 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005771}
5772
Ronald Cron6f135e12021-12-08 16:57:54 +01005773component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005774 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005775 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005776 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005777 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005778 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005779 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005780 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005781 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005782 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005783}
5784
Ronald Crondd96c0a2024-04-02 12:34:24 +02005785component_test_full_minus_session_tickets() {
5786 msg "build: full config without session tickets"
5787 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005788 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005789 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005790 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5791 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005792 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005793 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005794 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005795 tests/ssl-opt.sh
5796}
5797
Gilles Peskine8f073122018-11-27 15:58:47 +01005798component_build_mingw () {
5799 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005800 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 +00005801
Gilles Peskine8f073122018-11-27 15:58:47 +01005802 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005803 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 +01005804 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005805
Gilles Peskine8f073122018-11-27 15:58:47 +01005806 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005807 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
5808 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 +01005809 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005810
Pengyu Lv158eead2023-10-19 11:27:05 +08005811 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005812 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005813 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 +01005814 make WINDOWS_BUILD=1 clean
5815}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005816support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005817 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5818 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005819 *) true;;
5820 esac
5821}
Simon Butcher91aef332016-11-17 09:20:50 +00005822
Gilles Peskine8f073122018-11-27 15:58:47 +01005823component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005824 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005825 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005826 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5827 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005828
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005829 msg "test: main suites (MSan)" # ~ 10s
5830 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005831
Gilles Peskine6848d172023-11-02 19:58:03 +01005832 msg "test: metatests (MSan)"
5833 tests/scripts/run-metatests.sh any msan
5834
Gilles Peskine82b27272019-06-14 18:27:03 +02005835 msg "program demos (MSan)" # ~20s
5836 tests/scripts/run_demos.py
5837
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005838 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005839 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005840
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005841 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005842
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005843 if [ "$MEMORY" -gt 0 ]; then
5844 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005845 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005846 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005847}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005848
Bence Szépkúti0354d042023-12-06 16:14:37 +01005849component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005850 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005851 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005852 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5853 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005854
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005855 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005856 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005857
Gilles Peskine636c26a2020-03-04 20:46:15 +01005858 # Optional parts (slow; currently broken on OS X because programs don't
5859 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005860 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005861 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005862 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005863 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005864 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005865
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005866 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005867 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005868 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005869 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005870
5871 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005872 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005873 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005874 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005875}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005876
Bence Szépkúti0354d042023-12-06 16:14:37 +01005877component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005878 msg "build: Release, full (clang)"
5879 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5880 scripts/config.py full
5881 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5882 make
5883
5884 msg "test: main suites, Valgrind (full config)"
5885 make memcheck
5886}
5887
Paul Elliott62dc3922021-11-25 17:29:40 +00005888support_test_cmake_out_of_source () {
5889 distrib_id=""
5890 distrib_ver=""
5891 distrib_ver_minor=""
5892 distrib_ver_major=""
5893
5894 # Attempt to parse lsb-release to find out distribution and version. If not
5895 # found this should fail safe (test is supported).
5896 if [[ -f /etc/lsb-release ]]; then
5897
5898 while read -r lsb_line; do
5899 case "$lsb_line" in
5900 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5901 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5902 esac
5903 done < /etc/lsb-release
5904
5905 distrib_ver_major="${distrib_ver%%.*}"
5906 distrib_ver="${distrib_ver#*.}"
5907 distrib_ver_minor="${distrib_ver%%.*}"
5908 fi
5909
5910 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5911 # processor (as the CI does) can create a race condition whereby the build
5912 # fails to see a generated file, despite that file actually having been
5913 # generated. This problem appears to go away with 18.04 or newer, so make
5914 # the out of source tests unsupported on Ubuntu 16.04.
5915 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5916}
5917
Gilles Peskine8f073122018-11-27 15:58:47 +01005918component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005919 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005920 # generates
5921 make neat
5922
Gilles Peskine8f073122018-11-27 15:58:47 +01005923 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005924 MBEDTLS_ROOT_DIR="$PWD"
5925 mkdir "$OUT_OF_SOURCE_DIR"
5926 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005927 # Note: Explicitly generate files as these are turned off in releases
5928 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005929 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005930
Gilles Peskine8f073122018-11-27 15:58:47 +01005931 msg "test: cmake 'out-of-source' build"
5932 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005933 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005934 # Also ensure that there are no error messages such as
5935 # "No such file or directory", which would indicate that some required
5936 # file is missing (ssl-opt.sh tolerates the absence of some files so
5937 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005938 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005939 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005940 cat ssl-opt.err >&2
5941 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005942 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005943 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005944 cd "$MBEDTLS_ROOT_DIR"
5945 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005946}
Andres AGdc192212016-08-31 17:33:13 +01005947
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005948component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005949 # Remove existing generated files so that we use the ones CMake
5950 # generates
5951 make neat
5952
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005953 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005954 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005955 # Note: Explicitly generate files as these are turned off in releases
5956 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005957 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005958 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005959}
Gilles Peskinea3000992022-02-04 00:21:12 +01005960support_test_cmake_as_subdirectory () {
5961 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005962}
5963
Chris Kayd259e342021-03-25 16:03:25 +00005964component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005965 # Remove existing generated files so that we use the ones CMake
5966 # generates
5967 make neat
5968
Chris Kayd259e342021-03-25 16:03:25 +00005969 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005970 cd programs/test/cmake_package
5971 cmake .
5972 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005973 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005974}
Gilles Peskinea3000992022-02-04 00:21:12 +01005975support_test_cmake_as_package () {
5976 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005977}
5978
5979component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005980 # Remove existing generated files so that we use the ones CMake
5981 # generates
5982 make neat
5983
Chris Kayd259e342021-03-25 16:03:25 +00005984 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005985 cd programs/test/cmake_package_install
5986 cmake .
5987 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005988 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005989}
Gilles Peskinea3000992022-02-04 00:21:12 +01005990support_test_cmake_as_package_install () {
5991 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005992}
5993
David Horstmann20550e32023-01-12 14:17:01 +00005994component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005995 # Make a copy of config file to use for the in-tree test
5996 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005997
5998 MBEDTLS_ROOT_DIR="$PWD"
5999 mkdir "$OUT_OF_SOURCE_DIR"
6000 cd "$OUT_OF_SOURCE_DIR"
6001
David Horstmann969c1452023-01-31 10:34:44 +00006002 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006003 cmake "$MBEDTLS_ROOT_DIR"
6004 make
6005
6006 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6007 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006008 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006009 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6010 make
6011
6012 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6013 # In the user config, disable one feature (for simplicity, pick a feature
6014 # that nothing else depends on).
6015 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6016
6017 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6018 make
6019 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6020
6021 rm -f user_config.h full_config.h
6022
6023 cd "$MBEDTLS_ROOT_DIR"
6024 rm -rf "$OUT_OF_SOURCE_DIR"
6025
6026 # Now repeat the test for an in-tree build:
6027
David Horstmann969c1452023-01-31 10:34:44 +00006028 # Restore config for the in-tree test
6029 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006030
David Horstmann969c1452023-01-31 10:34:44 +00006031 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006032 cmake .
6033 make
6034
6035 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6036 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006037 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006038 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6039 make
6040
6041 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6042 # In the user config, disable one feature (for simplicity, pick a feature
6043 # that nothing else depends on).
6044 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6045
6046 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6047 make
6048 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6049
6050 rm -f user_config.h full_config.h
6051}
6052support_build_cmake_custom_config_file () {
6053 support_test_cmake_out_of_source
6054}
6055
David Horstmann041ed422024-05-10 14:37:48 +01006056component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01006057 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01006058 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
6059 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
6060 make
6061}
6062support_build_cmake_programs_no_testing () {
6063 support_test_cmake_out_of_source
6064}
David Horstmann20550e32023-01-12 14:17:01 +00006065
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006066component_build_zeroize_checks () {
6067 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6068
6069 scripts/config.py full
6070
6071 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006072 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 +01006073}
6074
6075
Gilles Peskine8f073122018-11-27 15:58:47 +01006076component_test_zeroize () {
6077 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6078 # different combinations of compilers and optimization flags by using an
6079 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6080 # system in all cases that the script fails, so we must manually search the
6081 # output to check whether the pass string is present and no failure strings
6082 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006083
Gilles Peskine4976e822019-01-06 19:52:22 +00006084 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6085 # about a spurious message if Gdb tries and fails, so suppress that.
6086 gdb_disable_aslr=
6087 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6088 gdb_disable_aslr='set disable-randomization off'
6089 fi
6090
Gilles Peskine8f073122018-11-27 15:58:47 +01006091 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006092 for compiler in clang gcc; do
6093 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6094 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006095 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6096 grep "The buffer was correctly zeroized" test_zeroize.log
6097 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006098 rm -f test_zeroize.log
6099 make clean
6100 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006101 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006102}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006103
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006104component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006105 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006106 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006107 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006108
6109 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006110 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006111}
6112
6113support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006114 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006115 ver="$(cmake --version)"
6116 ver="${ver#cmake version }"
6117 ver_major="${ver%%.*}"
6118
6119 ver="${ver#*.}"
6120 ver_minor="${ver%%.*}"
6121
6122 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006123}
6124
Gilles Peskinec848d222022-12-09 12:23:35 +01006125component_check_code_style () {
6126 msg "Check C code style"
6127 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006128}
6129
Gilles Peskinec848d222022-12-09 12:23:35 +01006130support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006131 case $(uncrustify --version) in
6132 *0.75.1*) true;;
6133 *) false;;
6134 esac
6135}
6136
Gilles Peskine8f073122018-11-27 15:58:47 +01006137component_check_python_files () {
6138 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006139 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006140}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006141
Joe Subbianid614c0b2021-07-29 11:18:29 +01006142component_check_test_helpers () {
6143 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006144 # unittest writes out mundane stuff like number or tests run on stderr.
6145 # Our convention is to reserve stderr for actual errors, and write
6146 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006147 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006148
Joe Subbiania25ffab2021-08-06 09:41:27 +01006149 msg "unit test: translate_ciphers.py"
6150 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006151}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006152
Valerio Settid9e42512024-05-06 15:59:51 +02006153component_test_psasim() {
Valerio Settid1b6ef12024-05-07 16:00:21 +02006154 msg "build library for client"
6155
6156 helper_crypto_client_build client
6157
6158 msg "build library for server"
6159
6160 scripts/config.py crypto
6161
6162 helper_crypto_client_build server
6163
Valerio Settid9e42512024-05-06 15:59:51 +02006164 msg "build psasim"
Valerio Setti4362aae2024-05-09 09:15:39 +02006165 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Settid9e42512024-05-06 15:59:51 +02006166
6167 msg "test psasim"
Valerio Setti655b9792024-05-09 12:20:40 +02006168 tests/psa-client-server/psasim/test/run_test.sh
Valerio Settid9e42512024-05-06 15:59:51 +02006169
Tom Cosgrove3ebb8802024-05-29 10:29:39 +01006170 msg "build psasim to test psa_hash_compute"
6171 # Delete the executable to ensure we build using the right MAIN
6172 rm tests/psa-client-server/psasim/test/psa_client
6173 # API under test: psa_hash_compute()
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006174 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="src/aut_psa_hash_compute.c"
Tom Cosgrove3ebb8802024-05-29 10:29:39 +01006175
6176 msg "test psasim running psa_hash_compute"
6177 tests/psa-client-server/psasim/test/run_test.sh
6178
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006179 # Next APIs under test: psa_hash_*(). Just use the PSA hash example.
6180 aut_psa_hash="../../../programs/psa/psa_hash.c"
6181 if [ -f "tests/psa-client-server/psasim/$aut_psa_hash" ]; then
6182
6183 msg "build psasim to test all psa_hash_* APIs"
6184 # Delete the executable to ensure we build using the right MAIN
6185 rm tests/psa-client-server/psasim/test/psa_client
6186 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="$aut_psa_hash"
6187
6188 msg "test psasim running psa_hash sample"
6189 tests/psa-client-server/psasim/test/run_test.sh
6190 else
6191 echo $aut_psa_hash NOT FOUND, so not running that test
6192 fi
6193
Valerio Settid9e42512024-05-06 15:59:51 +02006194 msg "clean psasim"
6195 make -C tests/psa-client-server/psasim clean
6196}
Jerry Yud767cc42023-03-31 15:03:55 +08006197
Gilles Peskine192c72f2017-12-21 15:59:21 +01006198################################################################
6199#### Termination
6200################################################################
6201
Gilles Peskine8f073122018-11-27 15:58:47 +01006202post_report () {
6203 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006204 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006205
Gilles Peskine8f073122018-11-27 15:58:47 +01006206 final_report
6207}
6208
6209
6210
6211################################################################
6212#### Run all the things
6213################################################################
6214
Gilles Peskine5d996822020-03-28 21:09:21 +01006215# Function invoked by --error-test to test error reporting.
6216pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006217 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006218 if [ $KEEP_GOING -ne 0 ]; then
6219 echo "Expect three failing commands."
6220 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006221 # If the component doesn't run in a subshell, changing error_test_i to an
6222 # invalid integer will cause an error in the loop that runs this function.
6223 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006224 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006225 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006226 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006227 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006228 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006229 make unknown_target
6230 false "this should not be executed"
6231}
6232
Gilles Peskinee48351a2018-11-27 16:06:30 +01006233# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006234run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006235 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006236 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006237
6238 # Unconditionally create a seedfile that's sufficiently long.
6239 # Do this before each component, because a previous component may
6240 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006241 local dd_cmd
6242 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6243 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006244 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006245 esac
6246 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006247
Gilles Peskineec135542021-08-02 23:14:03 +02006248 # Run the component in a subshell, with error trapping and output
6249 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006250 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006251 # We want to keep running if the subshell fails, so 'set -e' must
6252 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006253 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006254 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006255 (
6256 if [ $QUIET -eq 1 ]; then
6257 # msg() will be silenced, so just print the component name here.
6258 echo "${current_component#component_}"
6259 exec >/dev/null
6260 fi
6261 if [ $KEEP_GOING -eq 1 ]; then
6262 # Keep "set -e" off, and run an ERR trap instead to record failures.
6263 set -E
6264 trap err_trap ERR
6265 fi
6266 # The next line is what runs the component
6267 "$@"
6268 if [ $KEEP_GOING -eq 1 ]; then
6269 trap - ERR
6270 exit $last_failure_status
6271 fi
6272 )
6273 component_status=$?
6274 if [ $KEEP_GOING -eq 1 ]; then
6275 set -e
6276 if [ $component_status -ne 0 ]; then
6277 failure_count=$((failure_count + 1))
6278 fi
6279 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006280
6281 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006282 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006283 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006284}
6285
6286# Preliminary setup
6287pre_check_environment
6288pre_initialize_variables
6289pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006290
Dave Rodgman21900632024-02-26 11:41:19 +00006291setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006292pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006293pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006294pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006295
Gilles Peskine878cf602019-01-06 20:50:38 +00006296build_status=0
6297if [ $KEEP_GOING -eq 1 ]; then
6298 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006299fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006300pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006301pre_print_configuration
6302pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006303cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006304if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006305 pre_generate_files
6306fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006307
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006308# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006309for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006310 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006311done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006312unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006313for component in $RUN_COMPONENTS; do
6314 run_component "component_$component"
6315done
Gilles Peskine8f073122018-11-27 15:58:47 +01006316
6317# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006318post_report