blob: 573f769cc159125c6e2637619b00b7d43eaa41f9 [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
951 TARGET_LIB=libpsa$TARGET
952
953 cp $CONFIG_H $CONFIG_H.bak
954
955 if [ "$TARGET" == "client" ]; then
956 scripts/config.py full
957 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
958 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
959 # Dynamic secure element support is a deprecated feature and it is not
960 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
961 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
962 # Disable potentially problematic features
963 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
964 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
965 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
966 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
967 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
968 else
969 scripts/config.py crypto_full
970 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
971 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
972 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
Valerio Settidde95792024-05-10 05:22:33 +0200973 # Disable NV_SEED as the MBEDTLS_PLATFORM_STD_NV_SEED_FILE is not in
974 # right path for mbedtls_platform_std_nv_seed_read(). Just rely on
975 # mbedtls_platform_entropy_poll() as entropy source().
976 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
977 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Valerio Settid1b6ef12024-05-07 16:00:21 +0200978 fi
979
980 make -C tests CC="$ASAN_CC" CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB
981
982 rm $CONFIG_H
983 mv $CONFIG_H.bak $CONFIG_H
984}
985
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100986################################################################
987#### Configuration helpers
988################################################################
989
Valerio Settib2fd6732023-08-15 17:10:47 +0200990# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200991# The function optionally accepts 1 parameter: a space-separated list of the
992# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200993helper_disable_builtin_curves() {
994 allowed_list="${1:-}"
995 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
996
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200997 for curve in $allowed_list; do
998 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200999 done
1000}
1001
1002# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1003# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1004# in the following helpers.
1005helper_get_psa_curve_list () {
1006 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001007 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1008 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001009 done
1010
1011 echo "$loc_list"
1012}
1013
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001014# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1015# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1016# in the following helpers.
1017helper_get_psa_dh_group_list () {
1018 loc_list=""
1019 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1020 loc_list="$loc_list $item"
1021 done
1022
1023 echo "$loc_list"
1024}
1025
Valerio Settib2fd6732023-08-15 17:10:47 +02001026# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001027# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001028# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001029helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001030 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001031 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001032 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 +02001033 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1034 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001035 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1036 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001037 fi
1038 done
1039
1040 echo "$loc_list"
1041}
1042
Gilles Peskine192c72f2017-12-21 15:59:21 +01001043################################################################
1044#### Basic checks
1045################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001046
1047#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001048# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001049#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001050# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001051# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001052# 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 +02001053# time, so start with a GCC build).
1054# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001055#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001056# Indicative running times are given for reference.
1057
Gilles Peskine8f073122018-11-27 15:58:47 +01001058component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001059 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001060 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001061}
Janos Follathb72c6782016-07-19 14:54:17 +01001062
Gilles Peskine67debb62021-05-18 16:09:50 +02001063component_check_generated_files () {
1064 msg "Check: check-generated-files, files generated with make" # 2s
1065 make generated_files
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 present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001069 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001070 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001071 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001072
1073 msg "Check: check-generated-files -u, files absent" # 2s
1074 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001075 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001076 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001077 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001078
1079 # This component ends with the generated files present in the source tree.
1080 # This is necessary for subsequent components!
1081}
1082
Gilles Peskine8f073122018-11-27 15:58:47 +01001083component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001084 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001085 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001086}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001087
Gilles Peskine8f073122018-11-27 15:58:47 +01001088component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001089 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001090 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001091}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001092
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001093component_check_changelog () {
1094 msg "Check: changelog entries" # < 1s
1095 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001096 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001097 if [ -e ChangeLog.new ]; then
1098 # Show the diff for information. It isn't an error if the diff is
1099 # non-empty.
1100 diff -u ChangeLog ChangeLog.new || true
1101 rm ChangeLog.new
1102 fi
1103}
1104
Gilles Peskine8f073122018-11-27 15:58:47 +01001105component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001106 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001107 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001108}
Darryl Greena07039c2018-03-13 16:48:16 +00001109
Gilles Peskine895868b2019-09-19 21:30:05 +02001110component_check_test_cases () {
1111 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001112 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001113 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001114 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001115 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001116 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001117 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001118 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001119}
1120
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001121component_check_test_dependencies () {
1122 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001123 # The purpose of this component is to catch unjustified dependencies on
1124 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1125 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1126 # MBEDTLS_PSA_xxx).
1127 #
1128 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1129 # this component is meant to catch. However a few of them are justified,
1130 # mostly by the absence of a PSA equivalent, so this component includes a
1131 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001132
1133 found="check-test-deps-found-$$"
1134 expected="check-test-deps-expected-$$"
1135
1136 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001137 grep 'depends_on' \
1138 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001139 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001140 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001141 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001142
Yanray Wang18040ed2023-11-23 21:29:56 +08001143 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001144 rm -f $expected
1145 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1146 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001147 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1148 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001149 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1150 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001151 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1152 # the test code and that's probably the most convenient way of achieving
1153 # the test's goal.
1154 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1155 # No PSA equivalent - we should probably have one in the future.
1156 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1157 # No PSA equivalent - needed by some init tests
1158 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001159 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001160 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001161
1162 # Compare reality with expectation.
1163 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001164 #
1165 # The output should be empty. When it's not:
1166 # - Each '+' line is a macro that was found but not expected. You want to
1167 # find where that macro occurs, and either replace it with PSA macros, or
1168 # add it to the exceptions list above with a justification.
1169 # - Each '-' line is a macro that was expected but not found; it means the
1170 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001171 diff -U0 $expected $found
1172
1173 rm $found $expected
1174}
1175
Gilles Peskine8f073122018-11-27 15:58:47 +01001176component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001177 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001178 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001179}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001180
Gilles Peskine192c72f2017-12-21 15:59:21 +01001181
Gilles Peskine636c26a2020-03-04 20:46:15 +01001182
Gilles Peskine192c72f2017-12-21 15:59:21 +01001183################################################################
1184#### Build and test many configurations and targets
1185################################################################
1186
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001187component_test_default_out_of_box () {
1188 msg "build: make, default config (out-of-box)" # ~1min
1189 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001190 # Disable fancy stuff
1191 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001192
1193 msg "test: main suites make, default config (out-of-box)" # ~10s
1194 make test
1195
1196 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001197 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001198
1199 msg "program demos: make, default config (out-of-box)" # ~10s
1200 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001201}
1202
Gilles Peskine8f073122018-11-27 15:58:47 +01001203component_test_default_cmake_gcc_asan () {
1204 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001205 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1206 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001207
Gilles Peskine8f073122018-11-27 15:58:47 +01001208 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1209 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001210
Gilles Peskine82b27272019-06-14 18:27:03 +02001211 msg "program demos (ASan build)" # ~10s
1212 tests/scripts/run_demos.py
1213
Gilles Peskine97bea012020-04-23 23:37:45 +02001214 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001215 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001216
Gilles Peskine6848d172023-11-02 19:58:03 +01001217 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001218 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001219
Gilles Peskine8f073122018-11-27 15:58:47 +01001220 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001221 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001222
Gilles Peskine8f073122018-11-27 15:58:47 +01001223 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001224 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001225
1226 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001227 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001228}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001229
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001230component_test_default_cmake_gcc_asan_new_bignum () {
1231 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001232 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001233 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001234 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001235
1236 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1237 make test
1238
1239 msg "test: selftest (ASan build)" # ~ 10s
1240 programs/test/selftest
1241
1242 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1243 tests/ssl-opt.sh
1244
1245 msg "test: compat.sh (ASan build)" # ~ 6 min
1246 tests/compat.sh
1247
1248 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1249 tests/context-info.sh
1250}
1251
Hanno Becker01635512019-02-26 14:27:09 +00001252component_test_full_cmake_gcc_asan () {
1253 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001254 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001255 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1256 make
1257
1258 msg "test: main suites (inc. selftests) (full config, ASan build)"
1259 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001260
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001261 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001262 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001263
Gilles Peskine636c26a2020-03-04 20:46:15 +01001264 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001265 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001266
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001267 # Note: the next two invocations cover all compat.sh test cases.
1268 # We should use the same here and in basic-build-test.sh.
1269 msg "test: compat.sh: default version (full config, ASan build)"
1270 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001271
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001272 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1273 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001274
1275 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001276 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001277}
1278
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001279
1280component_test_full_cmake_gcc_asan_new_bignum () {
1281 msg "build: full config, cmake, gcc, ASan"
1282 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001283 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001284 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001285 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001286
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001287 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001288 make test
1289
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001290 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001291 programs/test/selftest
1292
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001293 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001294 tests/ssl-opt.sh
1295
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001296 # Note: the next two invocations cover all compat.sh test cases.
1297 # We should use the same here and in basic-build-test.sh.
1298 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1299 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001300
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001301 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1302 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001303
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001304 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001305 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001306}
1307
Ronald Cronc3623db2020-10-29 10:51:32 +01001308component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001309 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001310 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001311 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1312 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1313 make
1314
1315 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1316 make test
1317}
1318
David Horstmann4a48bec2024-03-13 15:42:31 +00001319component_test_psa_assume_exclusive_buffers () {
1320 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001321 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001322 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001323 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1324 make
1325
David Horstmann4a48bec2024-03-13 15:42:31 +00001326 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001327 make test
1328}
1329
Gilles Peskinea3548672021-06-17 11:37:52 +02001330# check_renamed_symbols HEADER LIB
1331# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1332# name is LIB.
1333check_renamed_symbols () {
1334 ! nm "$2" | sed 's/.* //' |
1335 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1336}
1337
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001338component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001339 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001340 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001341 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1342 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1343 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1344 # We can only compile, not link, since our test and sample programs
1345 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1346 # is active.
1347 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001348
1349 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1350 # version is not present.
1351 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001352 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001353}
1354
Valerio Setti63097752024-03-12 13:18:13 +01001355# Get a list of library-wise undefined symbols and ensure that they only
1356# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1357# This function is a common helper used by both:
1358# - component_test_default_psa_crypto_client_without_crypto_provider
1359# - component_build_full_psa_crypto_client_without_crypto_provider.
1360common_check_mbedtls_missing_symbols() {
1361 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1362 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1363 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1364 not grep mbedtls_ linking_errors.txt
1365
1366 rm sym_def.txt sym_undef.txt linking_errors.txt
1367}
1368
1369component_test_default_psa_crypto_client_without_crypto_provider () {
1370 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1371
Ronald Cron336678b2021-01-28 17:54:24 +01001372 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1373 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001374 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001375 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001376 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001377 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001378
Ronald Cron336678b2021-01-28 17:54:24 +01001379 make
1380
Valerio Setti63097752024-03-12 13:18:13 +01001381 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1382 common_check_mbedtls_missing_symbols
1383
1384 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001385 make test
1386}
1387
Valerio Setti63097752024-03-12 13:18:13 +01001388component_build_full_psa_crypto_client_without_crypto_provider () {
1389 msg "build: full config - PSA_CRYPTO_C"
1390
1391 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1392 scripts/config.py full
1393
1394 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1395 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1396 # Dynamic secure element support is a deprecated feature and it is not
1397 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1398 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1399
1400 # Since there is no crypto provider in this build it is not possible to
1401 # build all the test executables and progrems due to missing PSA functions
1402 # at link time. Therefore we will just build libraries and we'll check
1403 # that symbols of interest are there.
1404 make lib
1405
1406 msg "check missing symbols: full config - PSA_CRYPTO_C"
1407
1408 common_check_mbedtls_missing_symbols
1409
1410 # Ensure that desired functions are included into the build (extend the
1411 # following list as required).
1412 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1413 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1414 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1415}
1416
Ryan Everettdaa322a2024-04-18 16:48:55 +01001417component_test_no_rsa_key_pair_generation() {
1418 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001419 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001420 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001421 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001422 make
1423
Ryan Everettdaa322a2024-04-18 16:48:55 +01001424 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001425 make test
1426}
1427
Gilles Peskine782f4112018-11-27 16:11:09 +01001428component_test_ref_configs () {
1429 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001430 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1431 # want to re-generate generated files that depend on it, quite correctly.
1432 # However this doesn't work as the generation script expects a specific
1433 # format for mbedtls_config.h, which the other files don't follow. Also,
1434 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001435 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001436 # whether they're on or off. So, disable cmake's (over-sensitive here)
1437 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001438 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001439 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001440 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001441}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001442
Gilles Peskine8f073122018-11-27 15:58:47 +01001443component_test_no_renegotiation () {
1444 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001445 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001446 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001447 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001448
Gilles Peskine8f073122018-11-27 15:58:47 +01001449 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1450 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001451
Gilles Peskine8f073122018-11-27 15:58:47 +01001452 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001453 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001454}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001455
Gilles Peskine636c26a2020-03-04 20:46:15 +01001456component_test_no_pem_no_fs () {
1457 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1458 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1459 scripts/config.py unset MBEDTLS_FS_IO
1460 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1461 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001462 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001463 make
1464
1465 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1466 make test
1467
1468 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001469 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001470}
1471
Gilles Peskine8f073122018-11-27 15:58:47 +01001472component_test_rsa_no_crt () {
1473 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001474 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001475 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001476 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001477
Gilles Peskine8f073122018-11-27 15:58:47 +01001478 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1479 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001480
Gilles Peskine8f073122018-11-27 15:58:47 +01001481 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001482 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001483
Gilles Peskine8f073122018-11-27 15:58:47 +01001484 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001485 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001486
1487 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001488 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001489}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001490
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001491component_test_no_ctr_drbg_classic () {
1492 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001493 scripts/config.py full
1494 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001495 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001496 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001497
Dave Rodgman17127e92023-12-14 16:42:48 +00001498 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001499 make
1500
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001501 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001502 make test
1503
Gilles Peskineba749042021-01-13 20:02:03 +01001504 # In this configuration, the TLS test programs use HMAC_DRBG.
1505 # The SSL tests are slow, so run a small subset, just enough to get
1506 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001507 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001508 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001509
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001510 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001511 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001512}
1513
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001514component_test_no_ctr_drbg_use_psa () {
1515 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001516 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001517 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1518 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001519
Dave Rodgman17127e92023-12-14 16:42:48 +00001520 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001521 make
1522
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001523 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1524 make test
1525
1526 # In this configuration, the TLS test programs use HMAC_DRBG.
1527 # The SSL tests are slow, so run a small subset, just enough to get
1528 # confidence that the SSL code copes with HMAC_DRBG.
1529 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001530 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001531
1532 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001533 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001534}
1535
1536component_test_no_hmac_drbg_classic () {
1537 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1538 scripts/config.py full
1539 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1540 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1541 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001542 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001543
Dave Rodgman17127e92023-12-14 16:42:48 +00001544 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001545 make
1546
1547 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001548 make test
1549
Gilles Peskinea2224342020-11-19 22:14:34 +01001550 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1551 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1552 # instead.
1553 # Test SSL with non-deterministic ECDSA. Only test features that
1554 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001555 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001556 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001557
1558 # To save time, only test one protocol version, since this part of
1559 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001560 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001561 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001562}
1563
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001564component_test_no_hmac_drbg_use_psa () {
1565 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1566 scripts/config.py full
1567 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1568 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1569 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1570
Dave Rodgman17127e92023-12-14 16:42:48 +00001571 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001572 make
1573
1574 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1575 make test
1576
1577 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1578 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1579 # instead.
1580 # Test SSL with non-deterministic ECDSA. Only test features that
1581 # might be affected by how ECDSA signature is performed.
1582 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001583 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001584
1585 # To save time, only test one protocol version, since this part of
1586 # the protocol is identical in (D)TLS up to 1.2.
1587 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001588 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001589}
1590
1591component_test_psa_external_rng_no_drbg_classic () {
1592 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1593 scripts/config.py full
1594 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001595 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001596 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001597 scripts/config.py unset MBEDTLS_ENTROPY_C
1598 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1599 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001600 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1601 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1602 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001603 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1604 # the SSL test programs don't have an RNG and can't work. Explicitly
1605 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001606 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001607
1608 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1609 make test
1610
Gilles Peskine8eb29432021-02-03 20:07:11 +01001611 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001612 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001613}
1614
1615component_test_psa_external_rng_no_drbg_use_psa () {
1616 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001617 scripts/config.py full
1618 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001619 scripts/config.py unset MBEDTLS_ENTROPY_C
1620 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1621 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001622 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1623 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1624 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001625 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001626
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001627 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001628 make test
1629
Gilles Peskine8eb29432021-02-03 20:07:11 +01001630 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001631 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001632}
1633
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001634component_test_psa_external_rng_use_psa_crypto () {
1635 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1636 scripts/config.py full
1637 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1638 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1639 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001640 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001641
1642 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1643 make test
1644
1645 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1646 tests/ssl-opt.sh -f 'Default\|opaque'
1647}
1648
Gilles Peskine801c4332023-04-28 21:04:28 +02001649component_test_psa_inject_entropy () {
1650 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1651 scripts/config.py full
1652 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1653 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1654 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1655 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1656 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1657 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001658 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 +02001659
1660 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1661 make test
1662}
1663
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001664component_test_sw_inet_pton () {
1665 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1666
1667 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1668 scripts/config.py set MBEDTLS_TEST_HOOKS
1669 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1670
1671 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1672 make test
1673}
1674
Valerio Settia41654d2024-02-08 10:33:11 +01001675component_full_no_pkparse_pkwrite() {
1676 msg "build: full without pkparse and pkwrite"
1677
1678 scripts/config.py crypto_full
1679 scripts/config.py unset MBEDTLS_PK_PARSE_C
1680 scripts/config.py unset MBEDTLS_PK_WRITE_C
1681
Valerio Settia41654d2024-02-08 10:33:11 +01001682 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1683
1684 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1685 not grep mbedtls_pk_parse_key library/pkparse.o
1686 not grep mbedtls_pk_write_key_der library/pkwrite.o
1687
1688 msg "test: full without pkparse and pkwrite"
1689 make test
1690}
1691
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001692component_test_crypto_full_md_light_only () {
1693 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001694 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001695 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001696 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001697 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001698 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001699 scripts/config.py unset MBEDTLS_HKDF_C
1700 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001701 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001702 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001703 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001704 # Disable things that would auto-enable MD_C
1705 scripts/config.py unset MBEDTLS_PKCS5_C
1706
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001707 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1708 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001709 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001710
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001711 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001712 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001713 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001714
1715 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001716 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001717}
1718
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001719component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001720 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001721 scripts/config.py full
1722 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001723 # Don't pull in cipher via PSA mechanisms
1724 # (currently ignored anyway because we completely disable PSA)
1725 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001726 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001727 scripts/config.py unset MBEDTLS_CMAC_C
1728 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001729 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001730 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001731 scripts/config.py unset MBEDTLS_SSL_TLS_C
1732 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001733 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001734 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1735 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001736 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001737 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001738 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001739
Valerio Settidf17a102023-10-23 14:14:19 +02001740 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001741 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001742}
1743
Valerio Setti7e710e82023-08-25 09:14:15 +02001744# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001745# - component_test_full_no_cipher_with_psa_crypto
1746# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001747# It accepts 2 input parameters:
1748# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1749# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001750common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001751 USE_CRYPTO_CONFIG="$1"
1752 COMPONENT_DESCRIPTION="$2"
1753
1754 msg "build: $COMPONENT_DESCRIPTION"
1755
1756 scripts/config.py full
1757 scripts/config.py unset MBEDTLS_CIPHER_C
1758
1759 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001760 # The built-in implementation of the following algs/key-types depends
1761 # on CIPHER_C so we disable them.
1762 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1763 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001764 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001765 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1766 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1767 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1768 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1769 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1770 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1771 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1772 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001773 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001774 else
1775 # Don't pull in cipher via PSA mechanisms
1776 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001777 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1778 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1779 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001780 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001781 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001782 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001783 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001784
Gilles Peskine21570cf2023-12-22 11:49:50 +01001785 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001786
Valerio Setti7e710e82023-08-25 09:14:15 +02001787 # Ensure that CIPHER_C was not re-enabled
1788 not grep mbedtls_cipher_init library/cipher.o
1789
1790 msg "test: $COMPONENT_DESCRIPTION"
1791 make test
1792}
1793
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001794component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001795 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001796}
1797
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001798component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001799 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001800}
1801
Valerio Settibdfecb62023-11-07 15:37:20 +01001802component_test_full_no_ccm() {
1803 msg "build: full no PSA_WANT_ALG_CCM"
1804
1805 # Full config enables:
1806 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1807 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1808 scripts/config.py full
1809
1810 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1811 # enabled, but not used from TLS since USE_PSA is set.
1812 # This is helpful to ensure that TLS tests below have proper dependencies.
1813 #
1814 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1815 # PSA_WANT_ALG_CCM to be re-enabled.
1816 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1817
Gilles Peskine21570cf2023-12-22 11:49:50 +01001818 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001819
1820 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001821 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001822}
1823
1824component_test_full_no_ccm_star_no_tag() {
1825 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1826
1827 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1828 scripts/config.py full
1829
1830 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1831 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1832 # This basically disables all unauthenticated ciphers on the PSA side, while
1833 # keeping AEADs enabled.
1834 #
1835 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1836 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1837 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1838 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1839 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1840 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1841 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1842 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1843 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1844 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1845
Gilles Peskine21570cf2023-12-22 11:49:50 +01001846 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001847
1848 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001849 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001850
1851 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001852 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001853}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001854
Valerio Settie1655b82023-01-03 15:35:25 +01001855component_test_full_no_bignum () {
1856 msg "build: full minus bignum"
1857 scripts/config.py full
1858 scripts/config.py unset MBEDTLS_BIGNUM_C
1859 # Direct dependencies of bignum
1860 scripts/config.py unset MBEDTLS_ECP_C
1861 scripts/config.py unset MBEDTLS_RSA_C
1862 scripts/config.py unset MBEDTLS_DHM_C
1863 # Direct dependencies of ECP
1864 scripts/config.py unset MBEDTLS_ECDH_C
1865 scripts/config.py unset MBEDTLS_ECDSA_C
1866 scripts/config.py unset MBEDTLS_ECJPAKE_C
1867 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001868 # Disable what auto-enables ECP_LIGHT
1869 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1870 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001871 # Indirect dependencies of ECP
1872 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1873 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1874 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1875 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1876 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1877 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1878 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1879 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1880 # Direct dependencies of DHM
1881 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1882 # Direct dependencies of RSA
1883 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1884 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1885 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1886 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1887 # PK and its dependencies
1888 scripts/config.py unset MBEDTLS_PK_C
1889 scripts/config.py unset MBEDTLS_PK_PARSE_C
1890 scripts/config.py unset MBEDTLS_PK_WRITE_C
1891 scripts/config.py unset MBEDTLS_X509_USE_C
1892 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1893 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1894 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1895 scripts/config.py unset MBEDTLS_X509_CREATE_C
1896 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1897 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1898 scripts/config.py unset MBEDTLS_PKCS7_C
1899 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1900 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1901 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1902
Gilles Peskine21570cf2023-12-22 11:49:50 +01001903 make
Valerio Settie1655b82023-01-03 15:35:25 +01001904
1905 msg "test: full minus bignum"
1906 make test
1907}
1908
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001909component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001910 msg "build: default with only stream cipher"
1911
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001912 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001913 scripts/config.py unset MBEDTLS_GCM_C
1914 scripts/config.py unset MBEDTLS_CCM_C
1915 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001916 #Disable TLS 1.3 (as no AEAD)
1917 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001918 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001919 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001920 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001921 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001922 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1923 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001924 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001925 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001926 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001927
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001928 make
1929
1930 msg "test: default with only stream cipher"
1931 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001932
1933 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001934}
1935
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001936component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001937 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001938
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001939 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001940 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001941 scripts/config.py unset MBEDTLS_GCM_C
1942 scripts/config.py unset MBEDTLS_CCM_C
1943 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001944 #Disable TLS 1.3 (as no AEAD)
1945 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001946 # Disable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
Przemek Stekiel9550c052022-09-28 09:51:55 +02001947 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001948 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001949 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001950 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1951 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001952 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001953 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001954 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001955
Przemek Stekiel9550c052022-09-28 09:51:55 +02001956 make
1957
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001958 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001959 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001960
1961 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001962}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001963
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001964component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001965 msg "build: default with only CBC-legacy cipher"
1966
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001967 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001968 scripts/config.py unset MBEDTLS_GCM_C
1969 scripts/config.py unset MBEDTLS_CCM_C
1970 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001971 #Disable TLS 1.3 (as no AEAD)
1972 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001973 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1974 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1975 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001976 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001977 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001978 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001979 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001980 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001981 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001982
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001983 make
1984
1985 msg "test: default with only CBC-legacy cipher"
1986 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001987
1988 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1989 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001990}
1991
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001992component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001993 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001994
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001995 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001996 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001997 scripts/config.py unset MBEDTLS_GCM_C
1998 scripts/config.py unset MBEDTLS_CCM_C
1999 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002000 #Disable TLS 1.3 (as no AEAD)
2001 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002002 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2003 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2004 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002005 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002006 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002007 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002008 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002009 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002010 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002011
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002012 make
2013
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002014 msg "test: default with only CBC-legacy cipher use psa"
2015 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002016
2017 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
2018 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002019}
2020
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002021component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002022 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
2023
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002024 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002025 scripts/config.py unset MBEDTLS_GCM_C
2026 scripts/config.py unset MBEDTLS_CCM_C
2027 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002028 #Disable TLS 1.3 (as no AEAD)
2029 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002030 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2031 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2032 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2033 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2034 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002035 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002036 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002037 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002038 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002039
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002040 make
2041
2042 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
2043 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002044
2045 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
2046 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002047}
2048
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002049component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
2050 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002051
2052 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002053 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002054 scripts/config.py unset MBEDTLS_GCM_C
2055 scripts/config.py unset MBEDTLS_CCM_C
2056 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002057 #Disable TLS 1.3 (as no AEAD)
2058 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002059 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2060 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2061 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2062 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2063 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002064 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002065 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002066 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002067 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002068
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002069 make
2070
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002071 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002072 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002073
2074 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2075 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002076}
2077
Valerio Setti9f0ec532022-11-08 13:03:24 +01002078# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2079# that we could use for interop testing. However, we now have sort of two
2080# implementations ourselves: one using PSA, the other not. At least test that
2081# these two interoperate with each other.
2082component_test_tls1_2_ecjpake_compatibility() {
2083 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2084 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002085 # Explicitly make lib first to avoid a race condition:
2086 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2087 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002088 make -C programs ssl/ssl_server2 ssl/ssl_client2
2089 cp programs/ssl/ssl_server2 s2_no_use_psa
2090 cp programs/ssl/ssl_client2 c2_no_use_psa
2091
2092 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2093 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2094 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002095 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002096 make -C programs ssl/ssl_server2 ssl/ssl_client2
2097 make -C programs test/udp_proxy test/query_compile_time_config
2098
Valerio Setti70e02902022-12-02 16:21:56 +01002099 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2100 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2101 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2102 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2103 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2104 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2105 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2106 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 +01002107
2108 rm s2_no_use_psa c2_no_use_psa
2109}
2110
Gilles Peskine636c26a2020-03-04 20:46:15 +01002111component_test_everest () {
2112 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2113 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2114 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2115 make
2116
2117 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2118 make test
2119
Gilles Peskine6848d172023-11-02 19:58:03 +01002120 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002121 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002122
Gilles Peskine636c26a2020-03-04 20:46:15 +01002123 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2124 tests/ssl-opt.sh -f ECDH
2125
2126 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2127 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002128 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002129}
2130
Gilles Peskined3beca92020-07-03 00:15:37 +02002131component_test_everest_curve25519_only () {
2132 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002133 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2134 scripts/config.py unset MBEDTLS_ECDSA_C
2135 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2136 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002137 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002138 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002139 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002140 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2141
Dave Rodgman17127e92023-12-14 16:42:48 +00002142 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002143
2144 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2145 make test
2146}
2147
Gilles Peskine8f073122018-11-27 15:58:47 +01002148component_test_small_ssl_out_content_len () {
2149 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002150 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2151 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002152 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002153 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002154
Gilles Peskine8f073122018-11-27 15:58:47 +01002155 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002156 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002157}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002158
Gilles Peskine8f073122018-11-27 15:58:47 +01002159component_test_small_ssl_in_content_len () {
2160 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002161 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2162 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002163 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002164 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002165
Gilles Peskine8f073122018-11-27 15:58:47 +01002166 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002167 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002168}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002169
Gilles Peskine8f073122018-11-27 15:58:47 +01002170component_test_small_ssl_dtls_max_buffering () {
2171 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002172 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002173 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002174 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002175
Gilles Peskine8f073122018-11-27 15:58:47 +01002176 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002177 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 +01002178}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002179
Gilles Peskine8f073122018-11-27 15:58:47 +01002180component_test_small_mbedtls_ssl_dtls_max_buffering () {
2181 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002182 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002183 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002184 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002185
Gilles Peskine8f073122018-11-27 15:58:47 +01002186 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002187 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002188}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002189
Gilles Peskine75cc7712019-09-06 19:47:17 +02002190component_test_psa_collect_statuses () {
2191 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002192 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002193 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002194 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002195 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002196 rm -f tests/statuses.log
2197}
2198
Gilles Peskine8f073122018-11-27 15:58:47 +01002199component_test_full_cmake_clang () {
2200 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002201 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002202 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 +01002203 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002204
k-stachowiak0291cb72019-06-26 15:52:12 +02002205 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002206 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002207
Gilles Peskineda6017c2022-10-30 21:02:40 +01002208 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2209 programs/test/cpp_dummy_build
2210
Gilles Peskine6848d172023-11-02 19:58:03 +01002211 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002212 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002213
Gilles Peskine82b27272019-06-14 18:27:03 +02002214 msg "program demos (full config, clang)" # ~10s
2215 tests/scripts/run_demos.py
2216
k-stachowiak0291cb72019-06-26 15:52:12 +02002217 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002218 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002219
Gilles Peskine8f073122018-11-27 15:58:47 +01002220 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002221 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002222}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002223
Gilles Peskine0c671602022-11-29 16:01:41 +01002224skip_suites_without_constant_flow () {
2225 # Skip the test suites that don't have any constant-flow annotations.
2226 # This will need to be adjusted if we ever start declaring things as
2227 # secret from macros or functions inside tests/include or tests/src.
2228 SKIP_TEST_SUITES=$(
2229 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2230 sed 's/test_suite_//; s/\.function$//' |
2231 tr '\n' ,)
2232 export SKIP_TEST_SUITES
2233}
2234
Dave Rodgman246210e2023-07-31 18:07:44 +01002235skip_all_except_given_suite () {
2236 # Skip all but the given test suite
2237 SKIP_TEST_SUITES=$(
2238 ls -1 tests/suites/test_suite_*.function |
2239 grep -v $1.function |
2240 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2241 tr '\n' ,)
2242 export SKIP_TEST_SUITES
2243}
2244
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002245component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002246 # This tests both (1) accesses to undefined memory, and (2) branches or
2247 # memory access depending on secret values. To distinguish between those:
2248 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2249 # - or alternatively, change the build type to MemSanDbg, which enables
2250 # origin tracking and nicer stack traces (which are useful for debugging
2251 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002252 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2253 scripts/config.py full
2254 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2255 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2256 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2257 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2258 make
2259
2260 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2261 make test
2262}
2263
2264component_test_memsan_constant_flow_psa () {
2265 # This tests both (1) accesses to undefined memory, and (2) branches or
2266 # memory access depending on secret values. To distinguish between those:
2267 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2268 # - or alternatively, change the build type to MemSanDbg, which enables
2269 # origin tracking and nicer stack traces (which are useful for debugging
2270 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002271 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002272 scripts/config.py full
2273 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2274 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2275 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2276 make
2277
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002278 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002279 make test
2280}
2281
Bence Szépkúti0354d042023-12-06 16:14:37 +01002282component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002283 # This tests both (1) everything that valgrind's memcheck usually checks
2284 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2285 # etc.) and (2) branches or memory access depending on secret values,
2286 # which will be reported as uninitialized memory. To distinguish between
2287 # secret and actually uninitialized:
2288 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2289 # - or alternatively, build with debug info and manually run the offending
2290 # test suite with valgrind --track-origins=yes, then check if the origin
2291 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002292 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2293 scripts/config.py full
2294 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2295 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002296 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002297 cmake -D CMAKE_BUILD_TYPE:String=Release .
2298 make
2299
2300 # this only shows a summary of the results (how many of each type)
2301 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002302 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002303 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002304
2305 # Test asm path in constant time module - by default, it will test the plain C
2306 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2307 msg "test: valgrind asm constant_time"
2308 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2309 skip_all_except_given_suite test_suite_constant_time
2310 cmake -D CMAKE_BUILD_TYPE:String=Release .
2311 make clean
2312 make
2313 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002314}
2315
Bence Szépkúti0354d042023-12-06 16:14:37 +01002316component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002317 # This tests both (1) everything that valgrind's memcheck usually checks
2318 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2319 # etc.) and (2) branches or memory access depending on secret values,
2320 # which will be reported as uninitialized memory. To distinguish between
2321 # secret and actually uninitialized:
2322 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2323 # - or alternatively, build with debug info and manually run the offending
2324 # test suite with valgrind --track-origins=yes, then check if the origin
2325 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002326 msg "build: cmake release GCC, full config with constant flow testing"
2327 scripts/config.py full
2328 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002329 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002330 cmake -D CMAKE_BUILD_TYPE:String=Release .
2331 make
2332
2333 # this only shows a summary of the results (how many of each type)
2334 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002335 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002336 make memcheck
2337}
2338
Janos Follath9338cac2023-10-04 18:55:39 +01002339component_test_tsan () {
2340 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002341 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002342 scripts/config.py set MBEDTLS_THREADING_C
2343 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002344 # Self-tests do not currently use multiple threads.
2345 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002346
Ryan6caf84f2024-03-05 13:57:00 +00002347 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2348 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2349
Janos Follath9338cac2023-10-04 18:55:39 +01002350 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2351 make
2352
2353 msg "test: main suites (TSan)"
2354 make test
2355}
2356
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002357component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002358 # Test that removing the deprecated features from the default
2359 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002360 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2361 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002362 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002363
2364 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2365 make test
2366}
2367
2368component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002369 msg "build: make, full_no_deprecated config" # ~ 30s
2370 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002371 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002372
Gilles Peskine30de2e82020-04-20 21:39:22 +02002373 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002374 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002375
2376 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2377 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002378}
2379
Gilles Peskine8386ea22020-04-30 09:07:29 +02002380component_test_full_no_deprecated_deprecated_warning () {
2381 # Test that there is nothing deprecated in "full_no_deprecated".
2382 # A deprecated feature would trigger a warning (made fatal) from
2383 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002384 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2385 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002386 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2387 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002388 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002389
Gilles Peskine30de2e82020-04-20 21:39:22 +02002390 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002391 make test
2392}
2393
Gilles Peskine8386ea22020-04-30 09:07:29 +02002394component_test_full_deprecated_warning () {
2395 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2396 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002397 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002398 scripts/config.py full
2399 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002400 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002401 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2402 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002403 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002404
Gilles Peskine8386ea22020-04-30 09:07:29 +02002405 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2406 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2407 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002408 # Expect warnings from '#warning' directives in check_config.h and
2409 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002410 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 +01002411
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002412 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2413 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002414
2415 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2416 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002417}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002418
Gilles Peskineec541fe2020-01-31 14:24:14 +01002419# Check that the specified libraries exist and are empty.
2420are_empty_libraries () {
2421 nm "$@" >/dev/null 2>/dev/null
2422 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2423}
2424
2425component_build_crypto_default () {
2426 msg "build: make, crypto only"
2427 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002428 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002429 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002430}
2431
2432component_build_crypto_full () {
2433 msg "build: make, crypto only, full config"
2434 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002435 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002436 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002437}
2438
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002439component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002440 msg "build: make, config for PSA crypto service"
2441 scripts/config.py crypto
2442 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2443 # Disable things that are not needed for just cryptography, to
2444 # reach a configuration that would be typical for a PSA cryptography
2445 # service providing all implemented PSA algorithms.
2446 # System stuff
2447 scripts/config.py unset MBEDTLS_ERROR_C
2448 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002449 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002450 # Crypto stuff with no PSA interface
2451 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002452 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002453 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002454 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002455 scripts/config.py unset MBEDTLS_NIST_KW_C
2456 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2457 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2458 scripts/config.py unset MBEDTLS_PKCS12_C
2459 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002460 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2461 # in PSA code to work with RSA keys. We don't require users to set those:
2462 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002463 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002464 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002465 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002466 make CFLAGS='-O1 -Werror' all test
2467 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2468}
2469
Gilles Peskineec541fe2020-01-31 14:24:14 +01002470component_build_crypto_baremetal () {
2471 msg "build: make, crypto only, baremetal config"
2472 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002473 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002474 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002475}
Daniel Axtens446af202020-09-02 21:30:13 +10002476support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002477 support_build_baremetal "$@"
2478}
2479
2480component_build_baremetal () {
2481 msg "build: make, baremetal config"
2482 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002483 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002484}
2485support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002486 # Older Glibc versions include time.h from other headers such as stdlib.h,
2487 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2488 # problem, Ubuntu 18.04 is ok.
2489 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2490}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002491
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002492# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002493component_test_depends_py_cipher_id () {
2494 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002495 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002496}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002497
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002498component_test_depends_py_cipher_chaining () {
2499 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002500 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002501}
2502
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002503component_test_depends_py_cipher_padding () {
2504 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002505 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002506}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002507
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002508component_test_depends_py_curves () {
2509 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002510 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002511}
2512
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002513component_test_depends_py_hashes () {
2514 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002515 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002516}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002517
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002518component_test_depends_py_kex () {
2519 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002520 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002521}
2522
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002523component_test_depends_py_pkalgs () {
2524 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002525 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002526}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002527
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002528# PSA equivalents of the depends.py tests
2529component_test_depends_py_cipher_id_psa () {
2530 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002531 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002532}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002533
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002534component_test_depends_py_cipher_chaining_psa () {
2535 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002536 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002537}
2538
2539component_test_depends_py_cipher_padding_psa () {
2540 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002541 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002542}
2543
2544component_test_depends_py_curves_psa () {
2545 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002546 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002547}
2548
2549component_test_depends_py_hashes_psa () {
2550 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002551 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002552}
2553
2554component_test_depends_py_kex_psa () {
2555 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002556 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002557}
2558
2559component_test_depends_py_pkalgs_psa () {
2560 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002561 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002562}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002563
Valerio Setti6bed64e2024-01-17 15:21:44 +01002564component_test_psa_crypto_config_ffdh_2048_only () {
2565 msg "build: full config - only DH 2048"
2566
2567 scripts/config.py full
2568
2569 # Disable all DH groups other than 2048.
2570 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2571 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2572 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2573 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2574
2575 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2576
2577 msg "test: full config - only DH 2048"
2578 make test
2579
2580 msg "ssl-opt: full config - only DH 2048"
2581 tests/ssl-opt.sh -f "ffdh"
2582}
2583
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002584component_build_no_pk_rsa_alt_support () {
2585 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2586
2587 scripts/config.py full
2588 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2589 scripts/config.py set MBEDTLS_RSA_C
2590 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2591
2592 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002593 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002594}
2595
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002596component_build_module_alt () {
2597 msg "build: MBEDTLS_XXX_ALT" # ~30s
2598 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002599
2600 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002601 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2602 scripts/config.py unset MBEDTLS_AESNI_C
2603 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002604 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002605 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2606 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002607 # You can only have one threading implementation: alt or pthread, not both.
2608 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002609 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2610 # directly and assumes the implementation works with partial groups.
2611 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002612 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2613 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2614 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002615 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2616 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2617 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002618
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002619 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2620 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2621 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002622 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002623
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002624 # We can only compile, not link, since we don't have any implementations
2625 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002626 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002627}
2628
2629component_build_dhm_alt () {
2630 msg "build: MBEDTLS_DHM_ALT" # ~30s
2631 scripts/config.py full
2632 scripts/config.py set MBEDTLS_DHM_ALT
2633 # debug.c currently references mbedtls_dhm_context fields directly.
2634 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002635 # We can only compile, not link, since we don't have any implementations
2636 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002637 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002638}
2639
Gilles Peskine64996c32024-01-23 20:25:47 +01002640component_test_no_psa_crypto_full_cmake_asan() {
2641 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2642 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002643 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002644 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002645 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002646 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002647 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002648 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002649 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002650 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002651 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002652 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002653 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002654 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002655
Gilles Peskine64996c32024-01-23 20:25:47 +01002656 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002657 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002658
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002659 # Note: ssl-opt.sh has some test cases that depend on
2660 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2661 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002662 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002663 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002664
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002665 # Note: the next two invocations cover all compat.sh test cases.
2666 # We should use the same here and in basic-build-test.sh.
2667 msg "test: compat.sh: default version (full minus PSA crypto)"
2668 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002669
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002670 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002671 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002672}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002673
Ronald Cron403c15c2021-09-13 09:38:05 +02002674component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002675 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002676
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002677 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002678 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002679 $(helper_get_psa_key_type_list "ECC") \
2680 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002681
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002682 # Configure
2683 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002684
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002685 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002686 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002687
2688 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002689 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002690
2691 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002692 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2693 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2694
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002695 # Build
2696 # -----
2697
2698 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002699 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2700 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002701
2702 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2703
Valerio Setti3fe105b2023-10-30 11:08:12 +01002704 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002705
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002706 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002707 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002708
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002709 # Run the tests
2710 # -------------
2711
Ronald Cron403c15c2021-09-13 09:38:05 +02002712 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2713 make test
2714}
2715
Valerio Setti44b178c2023-03-22 14:02:57 +01002716component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002717 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002718
2719 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002720 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002721 $(helper_get_psa_key_type_list "ECC") \
2722 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002723
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002724 # Configure
2725 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002726
Ronald Cron46ac0652024-03-18 12:39:04 +01002727 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002728 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002729
Valerio Setti44b178c2023-03-22 14:02:57 +01002730 # Disable the module that's accelerated
2731 scripts/config.py unset MBEDTLS_ECDH_C
2732
2733 # Disable things that depend on it
2734 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2735 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2736 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2737 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2738 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2739
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002740 # Build
2741 # -----
2742
2743 helper_libtestdriver1_make_drivers "$loc_accel_list"
2744
Valerio Setti3fe105b2023-10-30 11:08:12 +01002745 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002746
Valerio Setti44b178c2023-03-22 14:02:57 +01002747 # Make sure this was not re-enabled by accident (additive config)
2748 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002749
2750 # Run the tests
2751 # -------------
2752
Valerio Setti44b178c2023-03-22 14:02:57 +01002753 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002754 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002755}
2756
Przemek Stekieldccb2022023-05-11 10:48:50 +02002757component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002758 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002759
2760 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002761 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002762 $(helper_get_psa_key_type_list "DH") \
2763 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002764
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002765 # Configure
2766 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002767
Przemek Stekiel565353e2023-07-05 11:07:07 +02002768 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002769 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002770
2771 # Disable the module that's accelerated
2772 scripts/config.py unset MBEDTLS_DHM_C
2773
2774 # Disable things that depend on it
2775 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2776 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2777
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002778 # Build
2779 # -----
2780
2781 helper_libtestdriver1_make_drivers "$loc_accel_list"
2782
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002783 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002784
2785 # Make sure this was not re-enabled by accident (additive config)
2786 not grep mbedtls_dhm_ library/dhm.o
2787
2788 # Run the tests
2789 # -------------
2790
Gilles Peskine14302ed2023-07-19 19:30:04 +02002791 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002792 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002793
Gilles Peskine14302ed2023-07-19 19:30:04 +02002794 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002795 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002796}
2797
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002798component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002799 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002800
2801 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002802 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002803
2804 # Disable things that are not supported
2805 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2806 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002807 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002808
Gilles Peskine14302ed2023-07-19 19:30:04 +02002809 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002810 make test
2811
Gilles Peskine14302ed2023-07-19 19:30:04 +02002812 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002813 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002814}
2815
Valerio Setti44b178c2023-03-22 14:02:57 +01002816component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002817 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002818
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002819 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002820 $(helper_get_psa_key_type_list "ECC") \
2821 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002822
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002823 # Configure
2824 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002825
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002826 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002827
2828 # Make built-in fallback not available
2829 scripts/config.py unset MBEDTLS_ECJPAKE_C
2830 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2831
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002832 # Build
2833 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002834
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002835 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002836
Valerio Setti3fe105b2023-10-30 11:08:12 +01002837 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002838
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002839 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002840 not grep mbedtls_ecjpake_init library/ecjpake.o
2841
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002842 # Run the tests
2843 # -------------
2844
Gilles Peskine14302ed2023-07-19 19:30:04 +02002845 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002846 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002847}
2848
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002849component_test_psa_crypto_config_accel_ecc_some_key_types () {
2850 msg "build: full with accelerated EC algs and some key types"
2851
2852 # Algorithms and key types to accelerate
2853 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2854 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2855 ALG_ECDH \
2856 ALG_JPAKE \
2857 KEY_TYPE_ECC_PUBLIC_KEY \
2858 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2859 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002860 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2861 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002862
2863 # Configure
2864 # ---------
2865
2866 # start with config full for maximum coverage (also enables USE_PSA)
2867 helper_libtestdriver1_adjust_config "full"
2868
2869 # Disable modules that are accelerated - some will be re-enabled
2870 scripts/config.py unset MBEDTLS_ECDSA_C
2871 scripts/config.py unset MBEDTLS_ECDH_C
2872 scripts/config.py unset MBEDTLS_ECJPAKE_C
2873 scripts/config.py unset MBEDTLS_ECP_C
2874
2875 # Disable all curves - those that aren't accelerated should be re-enabled
2876 helper_disable_builtin_curves
2877
2878 # Restartable feature is not yet supported by PSA. Once it will in
2879 # the future, the following line could be removed (see issues
2880 # 6061, 6332 and following ones)
2881 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2882
2883 # this is not supported by the driver API yet
2884 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2885
2886 # Build
2887 # -----
2888
2889 # These hashes are needed for some ECDSA signature tests.
2890 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2891 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2892 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2893
Valerio Setti3fe105b2023-10-30 11:08:12 +01002894 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002895
2896 # ECP should be re-enabled but not the others
2897 not grep mbedtls_ecdh_ library/ecdh.o
2898 not grep mbedtls_ecdsa library/ecdsa.o
2899 not grep mbedtls_ecjpake library/ecjpake.o
2900 grep mbedtls_ecp library/ecp.o
2901
2902 # Run the tests
2903 # -------------
2904
2905 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002906 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002907}
2908
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002909# Run tests with only (non-)Weierstrass accelerated
2910# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002911# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2912# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002913common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002914 weierstrass=$1
2915 if [ $weierstrass -eq 1 ]; then
2916 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002917 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002918 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002919 fi
2920
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002921 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002922
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002923 # Note: Curves are handled in a special way by the libtestdriver machinery,
2924 # so we only want to include them in the accel list when building the main
2925 # libraries, hence the use of a separate variable.
2926 # Note: the following loop is a modified version of
2927 # helper_get_psa_curve_list that only keeps Weierstrass families.
2928 loc_weierstrass_list=""
2929 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002930 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2931 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002932 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002933 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002934 ;;
2935 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002936 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002937 ;;
2938 esac
2939 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002940 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002941 loc_curve_list=$loc_weierstrass_list
2942 else
2943 loc_curve_list=$loc_non_weierstrass_list
2944 fi
2945
Valerio Setti3fe105b2023-10-30 11:08:12 +01002946 # Algorithms and key types to accelerate
2947 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2948 ALG_ECDH \
2949 ALG_JPAKE \
2950 $(helper_get_psa_key_type_list "ECC") \
2951 $loc_curve_list"
2952
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002953 # Configure
2954 # ---------
2955
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002956 # Start with config crypto_full and remove PK_C:
2957 # that's what's supported now, see docs/driver-only-builds.md.
2958 helper_libtestdriver1_adjust_config "crypto_full"
2959 scripts/config.py unset MBEDTLS_PK_C
2960 scripts/config.py unset MBEDTLS_PK_PARSE_C
2961 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002962
2963 # Disable modules that are accelerated - some will be re-enabled
2964 scripts/config.py unset MBEDTLS_ECDSA_C
2965 scripts/config.py unset MBEDTLS_ECDH_C
2966 scripts/config.py unset MBEDTLS_ECJPAKE_C
2967 scripts/config.py unset MBEDTLS_ECP_C
2968
2969 # Disable all curves - those that aren't accelerated should be re-enabled
2970 helper_disable_builtin_curves
2971
2972 # Restartable feature is not yet supported by PSA. Once it will in
2973 # the future, the following line could be removed (see issues
2974 # 6061, 6332 and following ones)
2975 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2976
2977 # this is not supported by the driver API yet
2978 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2979
2980 # Build
2981 # -----
2982
2983 # These hashes are needed for some ECDSA signature tests.
2984 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2985 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2986 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2987
Valerio Settiac7a8092023-10-31 12:23:44 +01002988 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002989
2990 # We expect ECDH to be re-enabled for the missing curves
2991 grep mbedtls_ecdh_ library/ecdh.o
2992 # We expect ECP to be re-enabled, however the parts specific to the
2993 # families of curves that are accelerated should be ommited.
2994 # - functions with mxz in the name are specific to Montgomery curves
2995 # - ecp_muladd is specific to Weierstrass curves
2996 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002997 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002998 not grep mbedtls_ecp_muladd library/ecp.o
2999 grep mxz library/ecp.o
3000 else
3001 grep mbedtls_ecp_muladd library/ecp.o
3002 not grep mxz library/ecp.o
3003 fi
3004 # We expect ECDSA and ECJPAKE to be re-enabled only when
3005 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003006 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003007 not grep mbedtls_ecdsa library/ecdsa.o
3008 not grep mbedtls_ecjpake library/ecjpake.o
3009 else
3010 grep mbedtls_ecdsa library/ecdsa.o
3011 grep mbedtls_ecjpake library/ecjpake.o
3012 fi
3013
3014 # Run the tests
3015 # -------------
3016
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02003017 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
3018 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003019}
3020
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02003021component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003022 common_test_psa_crypto_config_accel_ecc_some_curves 1
3023}
3024
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02003025component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003026 common_test_psa_crypto_config_accel_ecc_some_curves 0
3027}
3028
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01003029# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
3030# ECDH, ECDSA) with and without drivers.
3031# The input parameter is a boolean value which indicates:
3032# - 0 keep built-in EC algs,
3033# - 1 exclude built-in EC algs (driver only).
3034#
3035# This is used by the two following components to ensure they always use the
3036# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003037# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
3038# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01003039# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003040config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003041 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01003042 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003043 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003044 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01003045 # Disable modules that are accelerated
3046 scripts/config.py unset MBEDTLS_ECDSA_C
3047 scripts/config.py unset MBEDTLS_ECDH_C
3048 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02003049 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01003050 fi
3051
3052 # Restartable feature is not yet supported by PSA. Once it will in
3053 # the future, the following line could be removed (see issues
3054 # 6061, 6332 and following ones)
3055 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003056}
3057
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003058# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3059component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003060 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003061
3062 # Algorithms and key types to accelerate
3063 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3064 ALG_ECDH \
3065 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003066 $(helper_get_psa_key_type_list "ECC") \
3067 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003068
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003069 # Configure
3070 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003071
3072 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003073 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003074
Valerio Setti0a342c92023-09-01 09:12:31 +02003075 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003076 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3077 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003078
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003079 # Build
3080 # -----
3081
3082 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003083 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3084 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003085 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3086
Valerio Setti3fe105b2023-10-30 11:08:12 +01003087 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003088
3089 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3090 not grep mbedtls_ecdsa_ library/ecdsa.o
3091 not grep mbedtls_ecdh_ library/ecdh.o
3092 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003093 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003094
3095 # Run the tests
3096 # -------------
3097
Gilles Peskine14302ed2023-07-19 19:30:04 +02003098 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003099 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003100
Gilles Peskine14302ed2023-07-19 19:30:04 +02003101 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003102 tests/ssl-opt.sh
3103}
3104
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003105# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3106component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003107 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003108
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003109 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003110
Gilles Peskine21570cf2023-12-22 11:49:50 +01003111 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003112
Gilles Peskine14302ed2023-07-19 19:30:04 +02003113 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003114 make test
3115
Gilles Peskine14302ed2023-07-19 19:30:04 +02003116 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003117 tests/ssl-opt.sh
3118}
3119
Valerio Settie618cb02023-04-12 14:59:16 +02003120# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003121# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3122# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003123# to ensure that both tests use the same underlying configuration when testing
3124# driver's coverage with analyze_outcomes.py.
3125#
3126# This functions accepts 1 boolean parameter as follows:
3127# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3128# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3129# - 0: include built-in implementation of EC algorithms.
3130#
3131# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3132# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003133config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003134 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003135 # start with full config for maximum coverage (also enables USE_PSA)
3136 helper_libtestdriver1_adjust_config "full"
3137
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003138 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003139 # Disable modules that are accelerated
3140 scripts/config.py unset MBEDTLS_ECDSA_C
3141 scripts/config.py unset MBEDTLS_ECDH_C
3142 scripts/config.py unset MBEDTLS_ECJPAKE_C
3143 # Disable ECP module (entirely)
3144 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003145 fi
3146
Valerio Settiaecd32c2023-06-14 10:42:31 +02003147 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3148 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003149 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003150 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003151
Valerio Settie618cb02023-04-12 14:59:16 +02003152 # Restartable feature is not yet supported by PSA. Once it will in
3153 # the future, the following line could be removed (see issues
3154 # 6061, 6332 and following ones)
3155 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003156}
3157
3158# Build and test a configuration where driver accelerates all EC algs while
3159# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3160# side.
3161#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003162# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3163component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003164 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003165
3166 # Algorithms and key types to accelerate
3167 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3168 ALG_ECDH \
3169 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003170 $(helper_get_psa_key_type_list "ECC") \
3171 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003172
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003173 # Configure
3174 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003175
Valerio Settie618cb02023-04-12 14:59:16 +02003176 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003177 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003178 # Disable all the builtin curves. All the required algs are accelerated.
3179 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003180
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003181 # Build
3182 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003183
3184 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003185 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3186 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3187 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003188
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003189 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003190
Valerio Setti3fe105b2023-10-30 11:08:12 +01003191 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003192
3193 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3194 not grep mbedtls_ecdsa_ library/ecdsa.o
3195 not grep mbedtls_ecdh_ library/ecdh.o
3196 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003197 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003198 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003199
3200 # Run the tests
3201 # -------------
3202
Gilles Peskine14302ed2023-07-19 19:30:04 +02003203 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003204 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003205
Gilles Peskine14302ed2023-07-19 19:30:04 +02003206 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003207 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003208}
3209
3210# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003211# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003212# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003213component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003214 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003215
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003216 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003217
Gilles Peskine21570cf2023-12-22 11:49:50 +01003218 make
Valerio Settie618cb02023-04-12 14:59:16 +02003219
Gilles Peskine14302ed2023-07-19 19:30:04 +02003220 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003221 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003222
Gilles Peskine14302ed2023-07-19 19:30:04 +02003223 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003224 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003225}
3226
Valerio Setti4e2f2442023-08-15 10:10:26 +02003227# This is a common configuration helper used directly from:
3228# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3229# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3230# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003231# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003232# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003233# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003234# - this is the reference component of the above
3235# - it still disables RSA and FFDH, but it uses builtin EC algs
3236# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3237# - accelerate all EC and FFDH algs, disable only RSA
3238# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3239# - this is the reference component of the above
3240# - it still disables RSA, but it uses builtin EC and FFDH algs
3241#
3242# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003243# $1: a boolean value which states if we are testing an accelerated scenario
3244# or not.
3245# $2: a string value which states which components are tested. Allowed values
3246# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003247config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003248 driver_only="$1"
3249 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003250 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003251 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003252
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003253 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003254 # Disable modules that are accelerated
3255 scripts/config.py unset MBEDTLS_ECDSA_C
3256 scripts/config.py unset MBEDTLS_ECDH_C
3257 scripts/config.py unset MBEDTLS_ECJPAKE_C
3258 # Disable ECP module (entirely)
3259 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003260 # Also disable bignum
3261 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003262 fi
3263
3264 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3265 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3266 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3267 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3268
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003269 # RSA support is intentionally disabled on this test because RSA_C depends
3270 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003271 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3272 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 +02003273 scripts/config.py unset MBEDTLS_RSA_C
3274 scripts/config.py unset MBEDTLS_PKCS1_V15
3275 scripts/config.py unset MBEDTLS_PKCS1_V21
3276 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3277 # Also disable key exchanges that depend on RSA
3278 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3279 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3280 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3281 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3282 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3283
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003284 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003285 # When testing ECC only, we disable FFDH support, both from builtin and
3286 # PSA sides, and also disable the key exchanges that depend on DHM.
3287 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3288 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 +01003289 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003290 scripts/config.py unset MBEDTLS_DHM_C
3291 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3292 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3293 else
3294 # When testing ECC and DH instead, we disable DHM and depending key
3295 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003296 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003297 scripts/config.py unset MBEDTLS_DHM_C
3298 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3299 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3300 fi
3301 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003302
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003303 # Restartable feature is not yet supported by PSA. Once it will in
3304 # the future, the following line could be removed (see issues
3305 # 6061, 6332 and following ones)
3306 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3307}
3308
Valerio Setti4e2f2442023-08-15 10:10:26 +02003309# Common helper used by:
3310# - component_test_psa_crypto_config_accel_ecc_no_bignum
3311# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003312#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003313# The goal is to build and test accelerating either:
3314# - ECC only or
3315# - both ECC and FFDH
3316#
3317# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003318# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3319# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003320common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003321 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003322
Valerio Setti5dfaca42023-09-05 08:48:51 +02003323 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003324 if [ "$test_target" = "ECC_DH" ]; then
3325 accel_text="ECC/FFDH"
3326 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003327 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003328 accel_text="ECC"
3329 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003330 fi
3331
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003332 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003333
3334 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003335 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3336 ALG_ECDH \
3337 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003338 $(helper_get_psa_key_type_list "ECC") \
3339 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003340 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003341 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003342 loc_accel_list="$loc_accel_list \
3343 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003344 $(helper_get_psa_key_type_list "DH") \
3345 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003346 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003347
3348 # Configure
3349 # ---------
3350
3351 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003352 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003353 # Disable all the builtin curves. All the required algs are accelerated.
3354 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003355
3356 # Build
3357 # -----
3358
3359 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003360 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3361 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3362 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003363
3364 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3365
Valerio Setti3fe105b2023-10-30 11:08:12 +01003366 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003367
3368 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3369 not grep mbedtls_ecdsa_ library/ecdsa.o
3370 not grep mbedtls_ecdh_ library/ecdh.o
3371 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003372 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003373 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003374 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003375 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003376 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003377
3378 # Run the tests
3379 # -------------
3380
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003381 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003382
Gilles Peskine21570cf2023-12-22 11:49:50 +01003383 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003384
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003385 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003386 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003387}
3388
Valerio Setti4e2f2442023-08-15 10:10:26 +02003389# Common helper used by:
3390# - component_test_psa_crypto_config_reference_ecc_no_bignum
3391# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3392#
3393# The goal is to build and test a reference scenario (i.e. with builtin
3394# components) compared to the ones used in
3395# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3396#
3397# It is meant to be used in conjunction with
3398# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3399# coverage analysis in "analyze_outcomes.py" script.
3400common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003401 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003402
Valerio Setti5dfaca42023-09-05 08:48:51 +02003403 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003404 if [ "$test_target" = "ECC_DH" ]; then
3405 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003406 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003407 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003408 fi
3409
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003410 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003411
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003412 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003413
Gilles Peskine21570cf2023-12-22 11:49:50 +01003414 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003415
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003416 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003417 make test
3418
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003419 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003420 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003421}
3422
Valerio Setti4e2f2442023-08-15 10:10:26 +02003423component_test_psa_crypto_config_accel_ecc_no_bignum () {
3424 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3425}
3426
3427component_test_psa_crypto_config_reference_ecc_no_bignum () {
3428 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3429}
3430
3431component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3432 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3433}
3434
3435component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3436 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3437}
3438
Valerio Settiac6d35f2023-08-04 12:49:11 +02003439# Helper for setting common configurations between:
3440# - component_test_tfm_config_p256m_driver_accel_ec()
3441# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003442common_tfm_config () {
3443 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003444 cp configs/config-tfm.h "$CONFIG_H"
3445 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3446 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003447
Yanray Wang73bb2312023-09-25 11:21:15 +08003448 # Other config adjustment to make the tests pass.
3449 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003450 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003451 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3452 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003453
Yanray Wang73bb2312023-09-25 11:21:15 +08003454 # Config adjustment for better test coverage in our environment.
3455 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003456 #
3457 # Enable filesystem I/O for the benefit of PK parse/write tests.
3458 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3459}
3460
Valerio Settiac6d35f2023-08-04 12:49:11 +02003461# Keep this in sync with component_test_tfm_config() as they are both meant
3462# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003463component_test_tfm_config_p256m_driver_accel_ec () {
3464 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3465
3466 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003467
Dave Rodgman897bb772023-11-15 16:34:20 +00003468 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003469 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003470
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003471 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3472 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003473 not grep mbedtls_ecdh_ library/ecdh.o
3474 not grep mbedtls_ecjpake_ library/ecjpake.o
3475 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3476 not grep mbedtls_ecp_ library/ecp.o
3477 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003478 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003479 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003480 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003481 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003482
Valerio Setti5e18b902023-12-04 12:07:30 +01003483 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3484 # files, so we want to ensure that it has not be re-enabled accidentally.
3485 not grep mbedtls_cipher library/cipher.o
3486
Valerio Settib7e95442023-03-21 11:52:33 +01003487 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003488 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003489 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003490}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003491
Valerio Settiac6d35f2023-08-04 12:49:11 +02003492# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3493# they are both meant to be used in analyze_outcomes.py for driver's coverage
3494# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003495component_test_tfm_config() {
3496 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003497
Dave Rodgman897bb772023-11-15 16:34:20 +00003498 # Disable P256M driver, which is on by default, so that analyze_outcomes
3499 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3500 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3501
Valerio Setti52ba0e32023-08-04 12:43:03 +02003502 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003503 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003504
Dave Rodgman897bb772023-11-15 16:34:20 +00003505 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003506 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003507
Valerio Setti5e18b902023-12-04 12:07:30 +01003508 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3509 # files, so we want to ensure that it has not be re-enabled accidentally.
3510 not grep mbedtls_cipher library/cipher.o
3511
Valerio Setti52ba0e32023-08-04 12:43:03 +02003512 msg "test: TF-M config"
3513 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003514}
3515
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003516# Common helper for component_full_without_ecdhe_ecdsa() and
3517# component_full_without_ecdhe_ecdsa_and_tls13() which:
3518# - starts from the "full" configuration minus the list of symbols passed in
3519# as 1st parameter
3520# - build
3521# - test only TLS (i.e. test_suite_tls and ssl-opt)
3522build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003523 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003524
3525 msg "build: full minus something, test TLS"
3526
3527 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003528 for sym in $symbols_to_disable; do
3529 echo "Disabling $sym"
3530 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003531 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003532
Gilles Peskine21570cf2023-12-22 11:49:50 +01003533 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003534
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003535 msg "test: full minus something, test TLS"
3536 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003537
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003538 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003539 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003540}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003541
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003542component_full_without_ecdhe_ecdsa () {
3543 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003544}
3545
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003546component_full_without_ecdhe_ecdsa_and_tls13 () {
3547 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3548 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003549}
3550
Valerio Setti249b18a2023-06-20 12:08:30 +02003551# This is an helper used by:
3552# - component_test_psa_ecc_key_pair_no_derive
3553# - component_test_psa_ecc_key_pair_no_generate
3554# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3555# enabled, but one. Input arguments are as follows:
3556# - $1 is the key type under test, i.e. ECC/RSA/DH
3557# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003558build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003559 key_type=$1
3560 unset_option=$2
3561 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003562
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003563 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003564 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003565 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3566 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3567
3568 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3569 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003570 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003571
Gilles Peskine21570cf2023-12-22 11:49:50 +01003572 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003573
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003574 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003575 make test
3576}
3577
3578component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003579 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003580}
3581
3582component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003583 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003584}
3585
Pengyu Lve705f572023-12-06 16:38:15 +08003586config_psa_crypto_accel_rsa () {
3587 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003588
Pengyu Lve705f572023-12-06 16:38:15 +08003589 # Start from crypto_full config (no X.509, no TLS)
3590 helper_libtestdriver1_adjust_config "crypto_full"
3591
3592 if [ "$driver_only" -eq 1 ]; then
3593 # Remove RSA support and its dependencies
3594 scripts/config.py unset MBEDTLS_RSA_C
3595 scripts/config.py unset MBEDTLS_PKCS1_V15
3596 scripts/config.py unset MBEDTLS_PKCS1_V21
3597
3598 # We need PEM parsing in the test library as well to support the import
3599 # of PEM encoded RSA keys.
3600 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3601 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3602 fi
3603}
3604
3605component_test_psa_crypto_config_accel_rsa_crypto () {
3606 msg "build: crypto_full with accelerated RSA"
3607
3608 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3609 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3610 KEY_TYPE_RSA_PUBLIC_KEY \
3611 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3612 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3613 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3614 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003615
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003616 # Configure
3617 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003618
Pengyu Lve705f572023-12-06 16:38:15 +08003619 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003620
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003621 # Build
3622 # -----
3623
Pengyu Lve705f572023-12-06 16:38:15 +08003624 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003625 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 +08003626 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003627 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003628
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003629 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003630
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003631 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003632 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003633
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003634 # Run the tests
3635 # -------------
3636
Pengyu Lve705f572023-12-06 16:38:15 +08003637 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003638 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003639}
3640
3641component_test_psa_crypto_config_reference_rsa_crypto () {
3642 msg "build: crypto_full with non-accelerated RSA"
3643
3644 # Configure
3645 # ---------
3646 config_psa_crypto_accel_rsa 0
3647
3648 # Build
3649 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003650 make
Pengyu Lve705f572023-12-06 16:38:15 +08003651
3652 # Run the tests
3653 # -------------
3654 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003655 make test
3656}
3657
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003658# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003659# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003660component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003661 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003662
Valerio Setti4590bc22023-06-13 15:39:23 +02003663 # Create a temporary output file unless there is already one set
3664 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3665 REMOVE_OUTCOME_ON_EXIT="no"
3666 else
3667 REMOVE_OUTCOME_ON_EXIT="yes"
3668 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3669 export MBEDTLS_TEST_OUTCOME_FILE
3670 fi
3671
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003672 # Start from crypto configuration
3673 scripts/config.py crypto
3674
3675 # Remove RSA support and its dependencies
3676 scripts/config.py unset MBEDTLS_PKCS1_V15
3677 scripts/config.py unset MBEDTLS_PKCS1_V21
3678 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3679 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3680 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3681 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3682 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3683 scripts/config.py unset MBEDTLS_RSA_C
3684 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3685
3686 # Enable PSA support
3687 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3688
Valerio Setti01cc88a2023-06-15 11:53:08 +02003689 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003690 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003691 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3692 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3693 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003694
3695 make
3696
Valerio Setti01cc88a2023-06-15 11:53:08 +02003697 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003698 make test
3699
3700 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3701 # performing RSA signature.
3702 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3703 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3704
3705 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3706 rm $MBEDTLS_TEST_OUTCOME_FILE
3707 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003708}
3709
Ronald Cronb2312452021-05-08 14:32:59 +02003710component_test_psa_crypto_config_accel_hash () {
3711 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3712
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003713 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3714 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3715 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003716
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003717 # Configure
3718 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003719
Ronald Cron46ac0652024-03-18 12:39:04 +01003720 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003721 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003722
3723 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003724 scripts/config.py unset MBEDTLS_MD5_C
3725 scripts/config.py unset MBEDTLS_RIPEMD160_C
3726 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003727 scripts/config.py unset MBEDTLS_SHA224_C
3728 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003729 scripts/config.py unset MBEDTLS_SHA384_C
3730 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003731 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003732
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003733 # Build
3734 # -----
3735
3736 helper_libtestdriver1_make_drivers "$loc_accel_list"
3737
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003738 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003739
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003740 # There's a risk of something getting re-enabled via config_psa.h;
3741 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3742 not grep mbedtls_md5 library/md5.o
3743 not grep mbedtls_sha1 library/sha1.o
3744 not grep mbedtls_sha256 library/sha256.o
3745 not grep mbedtls_sha512 library/sha512.o
3746 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003747
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003748 # Run the tests
3749 # -------------
3750
Ronald Cronb2312452021-05-08 14:32:59 +02003751 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3752 make test
3753}
3754
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003755# Auxiliary function to build config for hashes with and without drivers
3756config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003757 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003758 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003759 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003760 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003761 # disable the built-in implementation of hashes
3762 scripts/config.py unset MBEDTLS_MD5_C
3763 scripts/config.py unset MBEDTLS_RIPEMD160_C
3764 scripts/config.py unset MBEDTLS_SHA1_C
3765 scripts/config.py unset MBEDTLS_SHA224_C
3766 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003767 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003768 scripts/config.py unset MBEDTLS_SHA384_C
3769 scripts/config.py unset MBEDTLS_SHA512_C
3770 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003771 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003772 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003773}
3774
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003775# Note that component_test_psa_crypto_config_reference_hash_use_psa
3776# is related to this component and both components need to be kept in sync.
3777# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003778component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003779 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003780
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003781 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3782 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3783 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003784
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003785 # Configure
3786 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003787
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003788 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003789
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003790 # Build
3791 # -----
3792
3793 helper_libtestdriver1_make_drivers "$loc_accel_list"
3794
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003795 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003796
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003797 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003798 # 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 +02003799 not grep mbedtls_md5 library/md5.o
3800 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003801 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003802 not grep mbedtls_sha512 library/sha512.o
3803 not grep mbedtls_ripemd160 library/ripemd160.o
3804
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003805 # Run the tests
3806 # -------------
3807
Gilles Peskine14302ed2023-07-19 19:30:04 +02003808 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003809 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003810
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003811 # This is mostly useful so that we can later compare outcome files with
3812 # the reference config in analyze_outcomes.py, to check that the
3813 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003814 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003815 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003816
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003817 # This is to make sure all ciphersuites are exercised, but we don't need
3818 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003819 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003820 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003821}
3822
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003823# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3824# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3825# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3826# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003827component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003828 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003829
3830 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003831
Gilles Peskine21570cf2023-12-22 11:49:50 +01003832 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003833
Gilles Peskine14302ed2023-07-19 19:30:04 +02003834 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003835 make test
3836
Gilles Peskine14302ed2023-07-19 19:30:04 +02003837 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003838 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003839}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003840
Valerio Setti8eb310c2024-01-22 16:22:57 +01003841# Auxiliary function to build config for hashes with and without drivers
3842config_psa_crypto_hmac_use_psa () {
3843 driver_only="$1"
3844 # start with config full for maximum coverage (also enables USE_PSA)
3845 helper_libtestdriver1_adjust_config "full"
3846
Valerio Setticd89b0b2024-01-24 14:24:55 +01003847 if [ "$driver_only" -eq 1 ]; then
3848 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3849 # is still enabled though (for ENTROPY_C among others).
3850 scripts/config.py unset MBEDTLS_MD_C
3851 # Disable also the builtin hashes since they are supported by the driver
3852 # and MD module is able to perform PSA dispathing.
3853 scripts/config.py unset-all MBEDTLS_SHA
3854 scripts/config.py unset MBEDTLS_MD5_C
3855 scripts/config.py unset MBEDTLS_RIPEMD160_C
3856 fi
3857
Valerio Setti8eb310c2024-01-22 16:22:57 +01003858 # Direct dependencies of MD_C. We disable them also in the reference
3859 # component to work with the same set of features.
3860 scripts/config.py unset MBEDTLS_PKCS7_C
3861 scripts/config.py unset MBEDTLS_PKCS5_C
3862 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3863 scripts/config.py unset MBEDTLS_HKDF_C
3864 # Dependencies of HMAC_DRBG
3865 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3866 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3867}
3868
3869component_test_psa_crypto_config_accel_hmac() {
3870 msg "test: full with accelerated hmac"
3871
3872 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3873 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3874 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3875 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3876
3877 # Configure
3878 # ---------
3879
3880 config_psa_crypto_hmac_use_psa 1
3881
Valerio Setti8eb310c2024-01-22 16:22:57 +01003882 # Build
3883 # -----
3884
3885 helper_libtestdriver1_make_drivers "$loc_accel_list"
3886
3887 helper_libtestdriver1_make_main "$loc_accel_list"
3888
3889 # Ensure that built-in support for HMAC is disabled.
3890 not grep mbedtls_md_hmac library/md.o
3891
3892 # Run the tests
3893 # -------------
3894
3895 msg "test: full with accelerated hmac"
3896 make test
3897}
3898
3899component_test_psa_crypto_config_reference_hmac() {
3900 msg "test: full without accelerated hmac"
3901
3902 config_psa_crypto_hmac_use_psa 0
3903
3904 make
3905
3906 msg "test: full without accelerated hmac"
3907 make test
3908}
3909
Valerio Setti9da01a72023-12-18 17:38:18 +01003910component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003911 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003912
Valerio Setti9da01a72023-12-18 17:38:18 +01003913 # Albeit this components aims at accelerating DES which should only support
3914 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3915 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003916 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3917 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3918 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003919
Valerio Setti9da01a72023-12-18 17:38:18 +01003920 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3921 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3922 # of this component. This limitation will be addressed by #8598.
3923
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003924 # Configure
3925 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003926
Valerio Setti9a427302023-10-17 11:40:42 +02003927 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003928 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003929
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003930 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003931 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3932 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3933 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3934 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3935 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3936 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3937 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003938 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003939
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003940 # Build
3941 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003942
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003943 helper_libtestdriver1_make_drivers "$loc_accel_list"
3944
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003945 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003946
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003947 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003948 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003949
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003950 # Run the tests
3951 # -------------
3952
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003953 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003954 make test
3955}
3956
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003957component_test_psa_crypto_config_accel_aead () {
3958 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3959
Valerio Setti3f02bb72023-10-02 15:57:33 +02003960 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3961 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003962
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003963 # Configure
3964 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003965
Valerio Setti3f02bb72023-10-02 15:57:33 +02003966 # Start from full config
3967 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003968
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003969 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003970 scripts/config.py unset MBEDTLS_GCM_C
3971 scripts/config.py unset MBEDTLS_CCM_C
3972 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003973
Valerio Settia50b89e2023-11-08 15:58:47 +01003974 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3975 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003976
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003977 # Build
3978 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003979
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003980 helper_libtestdriver1_make_drivers "$loc_accel_list"
3981
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003982 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003983
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003984 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003985 not grep mbedtls_ccm library/ccm.o
3986 not grep mbedtls_gcm library/gcm.o
3987 not grep mbedtls_chachapoly library/chachapoly.o
3988
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003989 # Run the tests
3990 # -------------
3991
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003992 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3993 make test
3994}
3995
Valerio Settib680fc42023-10-13 09:29:37 +02003996# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003997# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3998# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3999common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08004000 # Start from the full config
4001 helper_libtestdriver1_adjust_config "full"
4002
Valerio Settib680fc42023-10-13 09:29:37 +02004003 scripts/config.py unset MBEDTLS_NIST_KW_C
4004}
4005
Valerio Settib6b301f2023-10-04 12:05:05 +02004006# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004007# - component_test_psa_crypto_config_accel_cipher_aead_cmac
4008# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004009# are meant to be used together in analyze_outcomes.py script in order to test
4010# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004011component_test_psa_crypto_config_accel_cipher_aead_cmac () {
4012 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004013
Valerio Settiad8b7f02023-10-25 12:39:50 +02004014 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 +01004015 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02004016 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02004017 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
4018
4019 # Configure
4020 # ---------
4021
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004022 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004023
4024 # Disable the things that are being accelerated
4025 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4026 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
4027 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
4028 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
4029 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
4030 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4031 scripts/config.py unset MBEDTLS_GCM_C
4032 scripts/config.py unset MBEDTLS_CCM_C
4033 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02004034 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02004035 scripts/config.py unset MBEDTLS_DES_C
4036 scripts/config.py unset MBEDTLS_AES_C
4037 scripts/config.py unset MBEDTLS_ARIA_C
4038 scripts/config.py unset MBEDTLS_CHACHA20_C
4039 scripts/config.py unset MBEDTLS_CAMELLIA_C
4040
Valerio Settiec9b2582023-11-08 16:50:54 +01004041 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
4042 # does not depend on it.
4043 scripts/config.py unset MBEDTLS_CIPHER_C
4044
Valerio Settib6b301f2023-10-04 12:05:05 +02004045 # Build
4046 # -----
4047
4048 helper_libtestdriver1_make_drivers "$loc_accel_list"
4049
4050 helper_libtestdriver1_make_main "$loc_accel_list"
4051
4052 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01004053 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02004054 not grep mbedtls_des library/des.o
4055 not grep mbedtls_aes library/aes.o
4056 not grep mbedtls_aria library/aria.o
4057 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004058 not grep mbedtls_ccm library/ccm.o
4059 not grep mbedtls_gcm library/gcm.o
4060 not grep mbedtls_chachapoly library/chachapoly.o
4061 not grep mbedtls_cmac library/cmac.o
4062
4063 # Run the tests
4064 # -------------
4065
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004066 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004067 make test
Valerio Settif9414552023-11-09 10:43:20 +01004068
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004069 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004070 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004071
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004072 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004073 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004074}
4075
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004076component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4077 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4078 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004079
Gilles Peskine21570cf2023-12-22 11:49:50 +01004080 make
Valerio Settif9414552023-11-09 10:43:20 +01004081
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004082 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004083 make test
Valerio Settif9414552023-11-09 10:43:20 +01004084
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004085 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004086 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004087
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004088 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004089 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004090}
4091
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004092common_block_cipher_dispatch() {
4093 TEST_WITH_DRIVER="$1"
4094
4095 # Start from the full config
4096 helper_libtestdriver1_adjust_config "full"
4097
4098 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4099 # Disable key types that are accelerated (there is no legacy equivalent
4100 # symbol for ECB)
4101 scripts/config.py unset MBEDTLS_AES_C
4102 scripts/config.py unset MBEDTLS_ARIA_C
4103 scripts/config.py unset MBEDTLS_CAMELLIA_C
4104 fi
4105
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004106 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004107 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004108 # Keep this also in the reference component in order to skip the same tests
4109 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004110 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4111 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4112 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4113 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4114 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4115 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4116 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004117
4118 # Disable direct dependency on AES_C
4119 scripts/config.py unset MBEDTLS_NIST_KW_C
4120
4121 # Prevent the cipher module from using deprecated PSA path. The reason is
4122 # that otherwise there will be tests relying on "aes_info" (defined in
4123 # "cipher_wrap.c") whose functions are not available when AES_C is
4124 # not defined. ARIA and Camellia are not a problem in this case because
4125 # the PSA path is not tested for these key types.
4126 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4127}
4128
Valerio Settif8e6cba2023-12-12 11:53:39 +01004129component_test_full_block_cipher_psa_dispatch () {
4130 msg "build: full + PSA dispatch in block_cipher"
4131
4132 loc_accel_list="ALG_ECB_NO_PADDING \
4133 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4134
4135 # Configure
4136 # ---------
4137
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004138 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004139
Valerio Settif8e6cba2023-12-12 11:53:39 +01004140 # Build
4141 # -----
4142
4143 helper_libtestdriver1_make_drivers "$loc_accel_list"
4144
4145 helper_libtestdriver1_make_main "$loc_accel_list"
4146
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004147 # Make sure disabled components were not re-enabled by accident (additive
4148 # config)
4149 not grep mbedtls_aes_ library/aes.o
4150 not grep mbedtls_aria_ library/aria.o
4151 not grep mbedtls_camellia_ library/camellia.o
4152
Valerio Settif8e6cba2023-12-12 11:53:39 +01004153 # Run the tests
4154 # -------------
4155
4156 msg "test: full + PSA dispatch in block_cipher"
4157 make test
4158}
4159
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004160# This is the reference component of component_test_full_block_cipher_psa_dispatch
4161component_test_full_block_cipher_legacy_dispatch () {
4162 msg "build: full + legacy dispatch in block_cipher"
4163
4164 common_block_cipher_dispatch 0
4165
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004166 make
4167
4168 msg "test: full + legacy dispatch in block_cipher"
4169 make test
4170}
4171
Gilles Peskine36dea152023-07-20 22:19:45 +02004172component_test_aead_chachapoly_disabled() {
4173 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004174 scripts/config.py full
4175 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004176 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004177 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004178
Gilles Peskine36dea152023-07-20 22:19:45 +02004179 msg "test: full minus CHACHAPOLY"
4180 make test
4181}
4182
4183component_test_aead_only_ccm() {
4184 msg "build: full minus CHACHAPOLY and GCM"
4185 scripts/config.py full
4186 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4187 scripts/config.py unset MBEDTLS_GCM_C
4188 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4189 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004190 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004191
4192 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004193 make test
4194}
4195
Ronald Crone501d0e2023-07-10 08:31:19 +02004196component_test_ccm_aes_sha256() {
4197 msg "build: CCM + AES + SHA256 configuration"
4198
Ronald Cron7612d8c2023-07-20 10:03:54 +02004199 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004200 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004201
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004202 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004203
4204 msg "test: CCM + AES + SHA256 configuration"
4205 make test
4206}
4207
Dave Rodgman904c5892023-06-28 17:36:02 +01004208support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004209 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004210}
4211
Dave Rodgman904c5892023-06-28 17:36:02 +01004212component_build_tfm_armcc() {
4213 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004214 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004215
Dave Rodgman88651c42023-06-29 12:35:51 +01004216 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004217 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 +01004218}
4219
4220component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004221 # Check that the TF-M configuration can build cleanly with various
4222 # warning flags enabled. We don't build or run tests, since the
4223 # TF-M configuration needs a TF-M platform. A tweaked version of
4224 # the configuration that works on mainstream platforms is in
4225 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004226 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004227
Dave Rodgman88651c42023-06-29 12:35:51 +01004228 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004229 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 +01004230
Dave Rodgman904c5892023-06-28 17:36:02 +01004231 msg "build: TF-M config, gcc native build"
4232 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004233 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 +01004234}
4235
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004236# Test that the given .o file builds with all (valid) combinations of the given options.
4237#
4238# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4239#
4240# The validator function is the name of a function to validate the combination of options.
4241# It may be "" if all combinations are valid.
4242# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004243# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004244build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004245 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004246 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004247 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004248 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004249 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004250
Dave Rodgman42436102023-10-03 15:47:05 +01004251 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004252 for opt in "${options[@]}"; do
4253 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004254 done
4255
4256 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004257 cd $(dirname ${file})
4258 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004259
Dave Rodgman920343a2023-10-01 18:41:09 +01004260 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004261 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 +01004262
Dave Rodgman42436102023-10-03 15:47:05 +01004263 # Extract the command generated by the Makefile to build the target file.
4264 # This ensures that we have any include paths, macro definitions, etc
4265 # that may be applied by make.
4266 # 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 +01004267 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004268
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004269 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004270 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004271
Dave Rodgman28e38d82023-10-04 11:50:30 +01004272 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004273 source_file=${file%.o}.c
4274
4275 targets=0
4276 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004277
Dave Rodgman28e38d82023-10-04 11:50:30 +01004278 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004279 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004280 # each bit of $i is used to determine if options[i] will be set or not
4281 target="t"
4282 clang_args=""
4283 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004284 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004285 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004286 clang_args="${clang_args} ${opt}"
4287 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004288 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004289 done
4290
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004291 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004292 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004293 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004294 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004295
Dave Rodgman28e38d82023-10-04 11:50:30 +01004296 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004297 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004298 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004299 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004300
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004301 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004302
Dave Rodgman920343a2023-10-01 18:41:09 +01004303 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004304 make -s -f ${makefile} build_test_config_combos
4305 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004306
4307 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004308 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004309}
4310
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004311validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004312 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4313 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004314 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004315 fi
4316 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4317 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004318 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004319 fi
4320 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004321 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004322}
4323
4324component_build_aes_variations() {
4325 # 18s - around 90ms per clang invocation on M1 Pro
4326 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004327 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004328 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004329
Yanray Wangbc29aef2023-11-06 11:08:17 +08004330 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004331 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004332
Dave Rodgman42436102023-10-03 15:47:05 +01004333 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004334 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4335 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4336 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4337 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004338
4339 cd "$MBEDTLS_ROOT_DIR"
4340 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4341
Yanray Wang42be1ba2023-11-23 14:28:47 +08004342 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004343 # manually set or unset those configurations to check
4344 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004345 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4346 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4347 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4348 scripts/config.py unset MBEDTLS_DES_C
4349 scripts/config.py unset MBEDTLS_NIST_KW_C
4350 build_test_config_combos library/aes.o validate_aes_config_variations \
4351 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4352 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4353 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4354 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004355}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004356
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004357component_test_no_platform () {
4358 # Full configuration build, without platform support, file IO and net sockets.
4359 # This should catch missing mbedtls_printf definitions, and by disabling file
4360 # IO, it should catch missing '#include <stdio.h>'
4361 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004362 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004363 scripts/config.py unset MBEDTLS_PLATFORM_C
4364 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004365 scripts/config.py unset MBEDTLS_FS_IO
4366 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004367 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004368 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004369 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004370 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004371 # to re-enable platform integration features otherwise disabled in C99 builds
4372 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004373 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004374}
Gilles Peskine7c652162017-12-11 00:01:40 +01004375
4376component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004377 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004378 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4379 scripts/config.py full
4380 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004381 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4382 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4383 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4384 make
4385}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004386
Gilles Peskine8f073122018-11-27 15:58:47 +01004387component_build_no_ssl_srv () {
4388 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004389 scripts/config.py full
4390 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004391 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004392}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004393
Gilles Peskine8f073122018-11-27 15:58:47 +01004394component_build_no_ssl_cli () {
4395 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004396 scripts/config.py full
4397 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004398 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004399}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004400
Gilles Peskine8f073122018-11-27 15:58:47 +01004401component_build_no_sockets () {
4402 # Note, C99 compliance can also be tested with the sockets support disabled,
4403 # as that requires a POSIX platform (which isn't the same as C99).
4404 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004405 scripts/config.py full
4406 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4407 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4408 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4409}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004410
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004411component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004412 msg "build: default config with memory buffer allocator and backtrace enabled"
4413 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4414 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4415 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004416 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004417 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004418 make
4419
4420 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4421 make test
4422}
4423
4424component_test_memory_buffer_allocator () {
4425 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004426 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4427 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004428 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004429 make
4430
4431 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4432 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004433
4434 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4435 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004436 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004437}
4438
Gilles Peskine8f073122018-11-27 15:58:47 +01004439component_test_no_max_fragment_length () {
4440 # Run max fragment length tests with MFL disabled
4441 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004442 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004443 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004444 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004445
Gilles Peskine8f073122018-11-27 15:58:47 +01004446 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004447 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004448}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004449
Hanno Becker545ced42019-02-19 11:10:48 +00004450component_test_asan_remove_peer_certificate () {
4451 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004452 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004453 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004454 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004455 make
4456
4457 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4458 make test
4459
4460 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004461 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004462
4463 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004464 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004465
4466 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004467 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004468}
4469
Gilles Peskine8f073122018-11-27 15:58:47 +01004470component_test_no_max_fragment_length_small_ssl_out_content_len () {
4471 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004472 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4473 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4474 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004475 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004476 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004477
Gilles Peskine8f073122018-11-27 15:58:47 +01004478 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004479 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004480
4481 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004482 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004483}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004484
Darryl Greenaad82f92019-12-02 10:53:11 +00004485component_test_variable_ssl_in_out_buffer_len () {
4486 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4487 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004488 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004489 make
4490
4491 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4492 make test
4493
4494 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004495 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004496
4497 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004498 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004499}
4500
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004501component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004502 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004503 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004504
Dave Rodgman17127e92023-12-14 16:42:48 +00004505 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004506 make
4507
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004508 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004509 make test
4510
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004511 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004512 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004513
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004514 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004515 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004516}
4517
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004518component_test_ssl_alloc_buffer_and_mfl () {
4519 msg "build: default config with memory buffer allocator and MFL extension"
4520 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4521 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4522 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4523 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4524 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004525 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004526 make
4527
4528 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4529 make test
4530
4531 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 +02004532 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004533}
4534
Gilles Peskine636c26a2020-03-04 20:46:15 +01004535component_test_when_no_ciphersuites_have_mac () {
4536 msg "build: when no ciphersuites have MAC"
4537 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004538 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004539 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004540 make
4541
4542 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4543 make test
4544
4545 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004546 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004547}
4548
Raoul Strackxa4e86142020-06-15 17:03:13 +02004549component_test_no_date_time () {
4550 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4551 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004552 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004553 make
4554
4555 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4556 make test
4557}
4558
Gilles Peskine8f073122018-11-27 15:58:47 +01004559component_test_platform_calloc_macro () {
4560 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004561 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4562 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4563 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004564 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004565 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004566
Gilles Peskine8f073122018-11-27 15:58:47 +01004567 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4568 make test
4569}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004570
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004571component_test_malloc_0_null () {
4572 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004573 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004574 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 +02004575
4576 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4577 make test
4578
4579 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4580 # Just the calloc selftest. "make test" ran the others as part of the
4581 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004582 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004583
4584 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4585 # Run a subset of the tests. The choice is a balance between coverage
4586 # and time (including time indirectly wasted due to flaky tests).
4587 # The current choice is to skip tests whose description includes
4588 # "proxy", which is an approximation of skipping tests that use the
4589 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004590 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004591}
4592
Dave Rodgman6a08b682023-06-19 11:51:33 +01004593support_test_aesni() {
4594 # Check that gcc targets x86_64 (we can build AESNI), and check for
4595 # AESNI support on the host (we can run AESNI).
4596 #
4597 # The name of this function is possibly slightly misleading, but needs to align
4598 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004599 #
4600 # In principle 32-bit x86 can support AESNI, but our implementation does not
4601 # support 32-bit x86, so we check for x86-64.
4602 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004603 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4604 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004605 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004606}
4607
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004608component_test_aesni () { # ~ 60s
4609 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4610 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4611 #
4612 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4613 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4614 # exercise the plain C impl).
4615
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004616 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004617 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004618 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004619 scripts/config.py set MBEDTLS_HAVE_ASM
4620
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004621 # test the intrinsics implementation
4622 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004623 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004624 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004625 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004626 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004627
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004628 # test the asm implementation
4629 msg "AES tests, test assembly"
4630 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004631 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004632 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004633 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004634
4635 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004636 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004637 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004638 msg "AES tests, plain C"
4639 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004640 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004641 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004642 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004643 not grep -q "AES note: using AESNI" ./programs/test/selftest
4644 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004645
4646 # test the intrinsics implementation
4647 scripts/config.py set MBEDTLS_AESNI_C
4648 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4649 msg "AES tests, test AESNI only"
4650 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004651 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004652 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4653 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004654 grep -q "AES note: using AESNI" ./programs/test/selftest
4655 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004656}
4657
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004658component_test_sha3_variations() {
4659 msg "sha3 loop unroll variations"
4660
4661 # define minimal config sufficient to test SHA3
4662 cat > include/mbedtls/mbedtls_config.h << END
4663 #define MBEDTLS_SELF_TEST
4664 #define MBEDTLS_SHA3_C
4665END
4666
4667 msg "all loops unrolled"
4668 make clean
4669 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"
4670 ./tests/test_suite_shax
4671
4672 msg "all loops rolled up"
4673 make clean
4674 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"
4675 ./tests/test_suite_shax
4676}
4677
Jerry Yub6d39c22023-08-16 15:11:48 +08004678support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004679 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004680}
4681
4682component_test_aesni_m32 () { # ~ 60s
4683 # This tests are duplicated from component_test_aesni for i386 target
4684 #
4685 # AESNI intrinsic code supports i386 and assembly code does not support it.
4686
4687 msg "build: default config with different AES implementations"
4688 scripts/config.py set MBEDTLS_AESNI_C
4689 scripts/config.py set MBEDTLS_PADLOCK_C
4690 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4691 scripts/config.py set MBEDTLS_HAVE_ASM
4692
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004693 # test the intrinsics implementation with gcc
4694 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004695 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004696 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004697 # check that we built intrinsics - this should be used by default when supported by the compiler
4698 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4699 grep -q "AES note: using AESNI" ./programs/test/selftest
4700 grep -q "AES note: built-in implementation." ./programs/test/selftest
4701 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4702 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4703
4704 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004705 scripts/config.py unset MBEDTLS_PADLOCK_C
4706 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4707 msg "AES tests, test AESNI only"
4708 make clean
4709 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4710 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4711 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4712 grep -q "AES note: using AESNI" ./programs/test/selftest
4713 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4714 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4715 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4716}
4717
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004718support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004719 # clang >= 4 is required to build with target attributes
4720 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004721}
4722
4723component_test_aesni_m32_clang() {
4724
4725 scripts/config.py set MBEDTLS_AESNI_C
4726 scripts/config.py set MBEDTLS_PADLOCK_C
4727 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4728 scripts/config.py set MBEDTLS_HAVE_ASM
4729
4730 # test the intrinsics implementation with clang
4731 msg "AES tests, test intrinsics (clang)"
4732 make clean
4733 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4734 # check that we built intrinsics - this should be used by default when supported by the compiler
4735 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4736 grep -q "AES note: using AESNI" ./programs/test/selftest
4737 grep -q "AES note: built-in implementation." ./programs/test/selftest
4738 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4739 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4740}
4741
Jerry Yu193cbc02023-08-03 17:06:29 +08004742# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4743component_build_aes_aesce_armcc () {
4744 msg "Build: AESCE test on arm64 platform without plain C."
4745 scripts/config.py baremetal
4746
4747 # armc[56] don't support SHA-512 intrinsics
4748 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4749
4750 # Stop armclang warning about feature detection for A64_CRYPTO.
4751 # With this enabled, the library does build correctly under armclang,
4752 # but in baremetal builds (as tested here), feature detection is
4753 # unavailable, and the user is notified via a #warning. So enabling
4754 # this feature would prevent us from building with -Werror on
4755 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004756 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004757 scripts/config.py set MBEDTLS_HAVE_ASM
4758
4759 msg "AESCE, build with default configuration."
4760 scripts/config.py set MBEDTLS_AESCE_C
4761 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4762 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4763
4764 msg "AESCE, build AESCE only"
4765 scripts/config.py set MBEDTLS_AESCE_C
4766 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4767 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4768}
4769
Dave Rodgman0c584032023-10-08 12:26:54 +01004770support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004771 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004772 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004773}
4774
4775component_build_aes_armce () {
4776 # Test variations of AES with Armv8 crypto extensions
4777 scripts/config.py set MBEDTLS_AESCE_C
4778 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4779
4780 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004781 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004782
4783 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4784 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4785
4786 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4787 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4788
Dave Rodgman5e419372023-10-23 15:30:20 +01004789 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004790
Dave Rodgman5e419372023-10-23 15:30:20 +01004791 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4792 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004793
Dave Rodgman5e419372023-10-23 15:30:20 +01004794 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4795 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004796
Dave Rodgman5e419372023-10-23 15:30:20 +01004797 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4798 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004799
4800 # test for presence of AES instructions
4801 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4802 msg "clang, test A32 crypto instructions built"
4803 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4804 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4805 msg "clang, test T32 crypto instructions built"
4806 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4807 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4808 msg "clang, test aarch64 crypto instructions built"
4809 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4810 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4811
4812 # test for absence of AES instructions
4813 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4814 scripts/config.py unset MBEDTLS_AESCE_C
4815 msg "clang, test A32 crypto instructions not built"
4816 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4817 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4818 msg "clang, test T32 crypto instructions not built"
4819 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4820 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4821 msg "clang, test aarch64 crypto instructions not built"
4822 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4823 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004824}
4825
Dave Rodgman9ed18532023-10-05 00:06:47 +01004826support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004827 # clang >= 4 is required to build with SHA extensions
4828 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004829}
4830
Dave Rodgmand9e80832023-10-04 17:17:46 +01004831component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004832 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004833
4834
4835 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004836 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004837 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4838 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4839 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4840 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4841 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004842
Dave Rodgmand9e80832023-10-04 17:17:46 +01004843
Dave Rodgman94a634d2023-10-10 12:59:29 +01004844 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004845 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004846 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4847 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4848 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004849
Dave Rodgman5b89c552023-10-10 14:59:02 +01004850 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004851 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4852 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4853 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004854
Dave Rodgmancd654002023-10-05 09:40:07 +01004855
Dave Rodgman94a634d2023-10-10 12:59:29 +01004856 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004857 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004858 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4859 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4860 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4861 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4862 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004863
Dave Rodgmancd654002023-10-05 09:40:07 +01004864
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004865 # examine the disassembly for presence of SHA instructions
4866 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4867 scripts/config.py set ${opt}
4868 msg "${opt} clang, test A32 crypto instructions built"
4869 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4870 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4871
4872 msg "${opt} clang, test T32 crypto instructions built"
4873 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4874 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4875
4876 msg "${opt} clang, test aarch64 crypto instructions built"
4877 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4878 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4879 scripts/config.py unset ${opt}
4880 done
4881
4882
4883 # examine the disassembly for absence of SHA instructions
4884 msg "clang, test A32 crypto instructions not built"
4885 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4886 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4887
4888 msg "clang, test T32 crypto instructions not built"
4889 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4890 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4891
4892 msg "clang, test aarch64 crypto instructions not built"
4893 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4894 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004895}
4896
Jerry Yuc935aa62023-08-03 17:08:27 +08004897# For timebeing, no VIA Padlock platform available.
4898component_build_aes_via_padlock () {
4899
4900 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004901 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004902 scripts/config.py set MBEDTLS_PADLOCK_C
4903 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00004904 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004905 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004906
4907}
4908
4909support_build_aes_via_padlock_only () {
4910 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4911 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4912 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4913}
4914
Jerry Yu193cbc02023-08-03 17:06:29 +08004915support_build_aes_aesce_armcc () {
4916 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004917}
4918
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004919component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004920 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004921 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004922 scripts/config.py unset MBEDTLS_PADLOCK_C
4923
Dave Rodgmand8d64512023-12-19 12:20:21 +00004924 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004925
4926 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4927 make test
4928}
4929
4930component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4931 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4932 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004933 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4934 scripts/config.py unset MBEDTLS_PADLOCK_C
4935
Hanno Becker83ebf782017-07-07 12:29:15 +01004936 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004937
4938 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004939 make test
4940}
Gilles Peskine8f073122018-11-27 15:58:47 +01004941
Hanno Becker83ebf782017-07-07 12:29:15 +01004942component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004943 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4944 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4945 scripts/config.py unset MBEDTLS_PADLOCK_C
4946 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004947 scripts/config.py unset MBEDTLS_AESCE_C
4948
Dave Rodgmand8d64512023-12-19 12:20:21 +00004949 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004950
4951 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004952 make test
4953
4954 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4955 programs/test/selftest
4956}
4957
Matthias Schulz0767fda2024-02-07 10:46:28 +01004958component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004959 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4960 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004961 scripts/config.py unset MBEDTLS_PADLOCK_C
4962 scripts/config.py unset MBEDTLS_AESNI_C
4963 scripts/config.py unset MBEDTLS_AESCE_C
4964
4965 make CFLAGS='-O2 -Werror -Wall -Wextra'
4966
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004967 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004968 make test
4969}
4970
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004971component_test_aes_fewer_tables () {
4972 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004973 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004974 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004975
Gilles Peskine7c652162017-12-11 00:01:40 +01004976 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004977 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004978}
4979
4980component_test_aes_rom_tables () {
4981 msg "build: default config with AES_ROM_TABLES enabled"
4982 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004983 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004984
4985 msg "test: AES_ROM_TABLES"
4986 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004987}
4988
Gilles Peskine14c3c062018-01-29 21:25:12 +01004989component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004990 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4991 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4992 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004993 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004994
Gilles Peskine8f073122018-11-27 15:58:47 +01004995 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4996 make test
4997}
4998
Yanray Wang49cd4b52023-11-10 11:58:37 +08004999# helper for common_block_cipher_no_decrypt() which:
5000# - enable/disable the list of config options passed from -s/-u respectively.
5001# - build
5002# - test for tests_suite_xxx
5003# - selftest
5004#
5005# Usage: helper_block_cipher_no_decrypt_build_test
5006# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5007# Options: -s set_opts the list of config options to enable
5008# -u unset_opts the list of config options to disable
5009# -c cflags the list of options passed to CFLAGS
5010# -l ldflags the list of options passed to LDFLAGS
5011helper_block_cipher_no_decrypt_build_test () {
5012 while [ $# -gt 0 ]; do
5013 case "$1" in
5014 -s)
5015 shift; local set_opts="$1";;
5016 -u)
5017 shift; local unset_opts="$1";;
5018 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005019 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005020 -l)
5021 shift; local ldflags="$1";;
5022 esac
5023 shift
5024 done
5025 set_opts="${set_opts:-}"
5026 unset_opts="${unset_opts:-}"
5027 cflags="${cflags:-}"
5028 ldflags="${ldflags:-}"
5029
Yanray Wangb2d6e522023-11-13 16:57:47 +08005030 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5031 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005032
5033 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5034 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005035 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005036
5037 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5038 not grep mbedtls_aes_setkey_dec library/aes.o
5039 not grep mbedtls_aria_setkey_dec library/aria.o
5040 not grep mbedtls_camellia_setkey_dec library/camellia.o
5041 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5042 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005043 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5044 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005045
5046 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5047 make test
5048
5049 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5050 programs/test/selftest
5051}
5052
5053# This is a common configuration function used in:
5054# - component_test_block_cipher_no_decrypt_aesni_legacy()
5055# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5056# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5057# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5058# on x86.
5059common_block_cipher_no_decrypt () {
5060 # test AESNI intrinsics
5061 helper_block_cipher_no_decrypt_build_test \
5062 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005063 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005064
5065 # test AESNI assembly
5066 helper_block_cipher_no_decrypt_build_test \
5067 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005068 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005069
5070 # test AES C implementation
5071 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005072 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005073
5074 # test AESNI intrinsics for i386 target
5075 helper_block_cipher_no_decrypt_build_test \
5076 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005077 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005078 -l "-m32"
5079}
5080
Yanray Wang3ae11992023-11-13 17:32:09 +08005081# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5082# usage: 0: no PSA crypto configuration
5083# 1: use PSA crypto configuration
5084config_block_cipher_no_decrypt () {
5085 use_psa=$1
5086
Yanray Wang66111392023-10-31 18:54:54 +08005087 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005088 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5089 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005090 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005091 scripts/config.py unset MBEDTLS_NIST_KW_C
5092
Yanray Wang3ae11992023-11-13 17:32:09 +08005093 if [ "$use_psa" -eq 1 ]; then
5094 # Enable support for cryptographic mechanisms through the PSA API.
5095 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5096 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5097 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5098 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5099 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5100 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5101 fi
5102}
5103
5104component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005105 # This consistently causes an llvm crash on clang 3.8, so use gcc
5106 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005107 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005108 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005109}
5110
Yanray Wangf1496402023-11-01 18:55:13 +08005111component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005112 # This consistently causes an llvm crash on clang 3.8, so use gcc
5113 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005114 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005115 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005116}
5117
Yanray Wang66111392023-10-31 18:54:54 +08005118support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005119 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005120}
5121
Yanray Wang66111392023-10-31 18:54:54 +08005122component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005123 scripts/config.py baremetal
5124
5125 # armc[56] don't support SHA-512 intrinsics
5126 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5127
5128 # Stop armclang warning about feature detection for A64_CRYPTO.
5129 # With this enabled, the library does build correctly under armclang,
5130 # but in baremetal builds (as tested here), feature detection is
5131 # unavailable, and the user is notified via a #warning. So enabling
5132 # this feature would prevent us from building with -Werror on
5133 # armclang. Tracked in #7198.
5134 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5135 scripts/config.py set MBEDTLS_HAVE_ASM
5136
Yanray Wang3ae11992023-11-13 17:32:09 +08005137 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005138
5139 # test AESCE baremetal build
5140 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005141 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005142 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005143
Yanray Wangef1b04d2023-09-08 11:09:26 +08005144 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5145 not grep mbedtls_aes_setkey_dec library/aes.o
5146 not grep mbedtls_aria_setkey_dec library/aria.o
5147 not grep mbedtls_camellia_setkey_dec library/camellia.o
5148 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5149 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005150 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005151 not grep mbedtls_aesce_inverse_key library/aesce.o
5152 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005153}
5154
Gilles Peskine592f5912019-10-07 18:49:32 +02005155component_test_ctr_drbg_aes_256_sha_256 () {
5156 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5157 scripts/config.py full
5158 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5159 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005160 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005161 make
5162
5163 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5164 make test
5165}
5166
5167component_test_ctr_drbg_aes_128_sha_512 () {
5168 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005169 scripts/config.py full
5170 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5171 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005172 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005173 make
5174
5175 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5176 make test
5177}
5178
5179component_test_ctr_drbg_aes_128_sha_256 () {
5180 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005181 scripts/config.py full
5182 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5183 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5184 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005185 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005186 make
5187
5188 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5189 make test
5190}
5191
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005192component_test_se_default () {
5193 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005194 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005195 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005196
5197 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5198 make test
5199}
5200
Steven Cooremand57203d2020-07-16 20:28:59 +02005201component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005202 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005203 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005204 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005205 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5206 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005207 loc_cflags="${loc_cflags} -I../tests/include -O2"
5208
Gilles Peskine21570cf2023-12-22 11:49:50 +01005209 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005210
Gilles Peskine1997f302023-07-26 18:45:20 +02005211 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005212 make test
5213}
5214
Gilles Peskine8f073122018-11-27 15:58:47 +01005215component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005216 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005217 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005218 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005219 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005220}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005221
Gilles Peskinecf740502019-07-03 20:43:05 +02005222component_test_cmake_shared () {
5223 msg "build/test: cmake shared" # ~ 2min
5224 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5225 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005226 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005227 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005228 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005229}
5230
Gilles Peskineec10bf12019-09-20 19:56:06 +02005231test_build_opt () {
5232 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005233 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005234 for opt in "$@"; do
5235 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005236 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005237 # We're confident enough in compilers to not run _all_ the tests,
5238 # but at least run the unit tests. In particular, runs with
5239 # optimizations use inline assembly whereas runs with -O0
5240 # skip inline assembly.
5241 make test # ~30s
5242 make clean
5243 done
5244}
5245
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005246# For FreeBSD we invoke the function by name so this condition is added
5247# to disable the existing test_clang_opt function for linux.
5248if [[ $(uname) != "Linux" ]]; then
5249 component_test_clang_opt () {
5250 scripts/config.py full
5251 test_build_opt 'full config' clang -O0 -Os -O2
5252 }
5253fi
5254
5255component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005256 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005257 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005258}
5259support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005260 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005261}
5262
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005263component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005264 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005265 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005266}
5267support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005268 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005269}
5270
5271component_test_gcc_latest_opt () {
5272 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005273 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005274}
5275support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005276 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005277}
5278
5279component_test_gcc_earliest_opt () {
5280 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005281 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005282}
5283support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005284 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005285}
5286
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005287component_build_mbedtls_config_file () {
5288 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005289 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005290 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005291 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005292 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005293 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5294 make clean
5295
5296 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5297 # In the user config, disable one feature (for simplicity, pick a feature
5298 # that nothing else depends on).
5299 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005300 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005301 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5302
5303 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005304}
5305
Gilles Peskine7d904e72022-04-07 21:59:14 +02005306component_build_psa_config_file () {
5307 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5308 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5309 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5310 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5311 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005312 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005313 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5314 make clean
5315
5316 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
5317 # In the user config, disable one feature, which will reflect on the
5318 # mbedtls configuration so we can query it with query_compile_time_config.
5319 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
5320 scripts/config.py unset MBEDTLS_CMAC_C
5321 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5322 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5323
5324 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005325}
5326
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005327component_build_psa_alt_headers () {
5328 msg "build: make with PSA alt headers" # ~20s
5329
5330 # Generate alternative versions of the substitutable headers with the
5331 # same content except different include guards.
5332 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5333
5334 # Build the library and some programs.
5335 # Don't build the fuzzers to avoid having to go through hoops to set
5336 # a correct include path for programs/fuzz/Makefile.
5337 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
5338 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\"'"
5339
5340 # Check that we're getting the alternative include guards and not the
5341 # original include guards.
5342 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5343 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5344 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5345 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5346}
5347
Dave Rodgman852de3c2023-12-14 14:46:45 +00005348component_test_m32_no_asm () {
5349 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005350 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005351 #
5352 # Note that we require gcc, because clang Asan builds fail to link for
5353 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005354 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005355 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005356 scripts/config.py unset MBEDTLS_HAVE_ASM
5357 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005358 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005359 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005360
Dave Rodgman852de3c2023-12-14 14:46:45 +00005361 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005362 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005363}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005364support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005365 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005366 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005367 *) false;;
5368 esac
5369}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005370
Gilles Peskineff0aee02021-10-05 09:36:03 +02005371component_test_m32_o2 () {
5372 # Build with optimization, to use the i386 specific inline assembly
5373 # and go faster for tests.
5374 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005375 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005376 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005377 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005378
Gilles Peskineff0aee02021-10-05 09:36:03 +02005379 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005380 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005381
Gilles Peskineff0aee02021-10-05 09:36:03 +02005382 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005383 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005384}
Gilles Peskinecf522222021-10-07 19:25:29 +02005385support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005386 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005387}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005388
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005389component_test_m32_everest () {
5390 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005391 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005392 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005393 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005394
5395 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5396 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005397
5398 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005399 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005400
5401 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5402 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005403 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005404}
5405support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005406 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005407}
5408
Gilles Peskine8f073122018-11-27 15:58:47 +01005409component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005410 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005411 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005412 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005413
5414 msg "test: 64-bit ILP32, make, gcc"
5415 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005416}
Gilles Peskine878cf602019-01-06 20:50:38 +00005417support_test_mx32 () {
5418 case $(uname -m) in
5419 amd64|x86_64) true;;
5420 *) false;;
5421 esac
5422}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005423
Peter Kolbus60c6da22018-12-27 06:59:04 -06005424component_test_min_mpi_window_size () {
5425 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005426 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005427 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005428 make
5429
5430 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5431 make test
5432}
5433
Gilles Peskine8f073122018-11-27 15:58:47 +01005434component_test_have_int32 () {
5435 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005436 scripts/config.py unset MBEDTLS_HAVE_ASM
5437 scripts/config.py unset MBEDTLS_AESNI_C
5438 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005439 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005440 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005441
Gilles Peskine8f073122018-11-27 15:58:47 +01005442 msg "test: gcc, force 32-bit bignum limbs"
5443 make test
5444}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005445
Gilles Peskine8f073122018-11-27 15:58:47 +01005446component_test_have_int64 () {
5447 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005448 scripts/config.py unset MBEDTLS_HAVE_ASM
5449 scripts/config.py unset MBEDTLS_AESNI_C
5450 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005451 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005452 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005453
Gilles Peskine8f073122018-11-27 15:58:47 +01005454 msg "test: gcc, force 64-bit bignum limbs"
5455 make test
5456}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005457
Gabor Mezeie256cc12023-07-26 17:28:48 +02005458component_test_have_int32_cmake_new_bignum () {
5459 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5460 scripts/config.py unset MBEDTLS_HAVE_ASM
5461 scripts/config.py unset MBEDTLS_AESNI_C
5462 scripts/config.py unset MBEDTLS_PADLOCK_C
5463 scripts/config.py unset MBEDTLS_AESCE_C
5464 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005465 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005466 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005467
5468 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5469 make test
5470}
5471
Gilles Peskine8f073122018-11-27 15:58:47 +01005472component_test_no_udbl_division () {
5473 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005474 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005475 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005476 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005477
Gilles Peskine8f073122018-11-27 15:58:47 +01005478 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5479 make test
5480}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005481
Gilles Peskine8f073122018-11-27 15:58:47 +01005482component_test_no_64bit_multiplication () {
5483 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005484 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005485 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005486 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005487
Gilles Peskine8f073122018-11-27 15:58:47 +01005488 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5489 make test
5490}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005491
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005492component_test_no_strings () {
5493 msg "build: no strings" # ~10s
5494 scripts/config.py full
5495 # Disable options that activate a large amount of string constants.
5496 scripts/config.py unset MBEDTLS_DEBUG_C
5497 scripts/config.py unset MBEDTLS_ERROR_C
5498 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5499 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005500 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005501
5502 msg "test: no strings" # ~ 10s
5503 make test
5504}
5505
Hanno Beckerc5722d12020-10-09 11:10:42 +01005506component_test_no_x509_info () {
5507 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5508 scripts/config.pl full
5509 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5510 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005511 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005512
5513 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5514 make test
5515
5516 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005517 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005518}
5519
Gilles Peskine8f073122018-11-27 15:58:47 +01005520component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005521 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005522 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005523 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 +02005524
Gilles Peskinee36fe812021-09-01 20:00:33 +02005525 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005526 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005527}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005528
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005529component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005530 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005531 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005532 # Build for a target platform that's close to what Debian uses
5533 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005534 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005535 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005536 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005537 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'
5538
Gilles Peskinee36fe812021-09-01 20:00:33 +02005539 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005540 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005541}
5542support_build_arm_linux_gnueabi_gcc_arm5vte () {
5543 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5544}
5545
5546component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005547 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005548 scripts/config.py baremetal
5549 # This is an imperfect substitute for
5550 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005551 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005552 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 +02005553
Gilles Peskinee36fe812021-09-01 20:00:33 +02005554 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005555 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005556}
5557
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005558component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005559 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5560 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005561 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 +02005562
Gilles Peskinee36fe812021-09-01 20:00:33 +02005563 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005564 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005565 for lib in library/*.a; do
5566 echo "$lib:"
5567 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5568 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005569}
5570
Gilles Peskine8f073122018-11-27 15:58:47 +01005571component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005572 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005573 scripts/config.py baremetal
5574 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005575 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 +01005576 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005577 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005578}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005579
Gilles Peskine8f073122018-11-27 15:58:47 +01005580component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005581 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005582 scripts/config.py baremetal
5583 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005584 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 +01005585 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005586 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005587}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005588
Dave Rodgman8c315f22023-06-02 10:26:24 -04005589component_build_arm_clang_thumb () {
5590 # ~ 30s
5591
5592 scripts/config.py baremetal
5593
5594 msg "build: clang thumb 2, make"
5595 make clean
5596 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5597
5598 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5599 msg "build: clang thumb 1 -O0, make"
5600 make clean
5601 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5602
5603 msg "build: clang thumb 1 -Os, make"
5604 make clean
5605 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5606}
5607
Gilles Peskine8f073122018-11-27 15:58:47 +01005608component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005609 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005610 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005611 # armc[56] don't support SHA-512 intrinsics
5612 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005613
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005614 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5615 scripts/config.py unset MBEDTLS_AESCE_C
5616
Dave Rodgman0fddf822023-03-02 15:32:12 +00005617 # Stop armclang warning about feature detection for A64_CRYPTO.
5618 # With this enabled, the library does build correctly under armclang,
5619 # but in baremetal builds (as tested here), feature detection is
5620 # unavailable, and the user is notified via a #warning. So enabling
5621 # this feature would prevent us from building with -Werror on
5622 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005623 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005624
Hanno Beckerf0762e92022-07-15 12:08:19 +01005625 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005626
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005627 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005628
5629 msg "size: ARM Compiler 5"
5630 "$ARMC5_FROMELF" -z library/*.o
5631
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005632 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005633
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005634 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005635 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005636
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005637 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005638 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5639
5640 # ARM Compiler 6 - Target ARMv7-M+DSP
5641 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005642
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005643 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005644 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005645
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005646 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005647 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005648
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005649 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5650 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5651
Dave Rodgman99318e62023-05-24 12:27:42 +01005652 # ARM Compiler 6 - Target Cortex-M0
5653 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005654
5655 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5656 #
5657 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5658 # that we have in our CI
5659 scripts/config.py set MBEDTLS_AESCE_C
5660 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005661}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005662
Pengyu Lvdf070032023-02-24 16:03:31 +08005663support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005664 armc5_cc="$ARMC5_BIN_DIR/armcc"
5665 armc6_cc="$ARMC6_BIN_DIR/armclang"
5666 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005667}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005668
Ronald Crond2cb7f42024-03-18 12:49:18 +01005669component_test_tls12_only () {
5670 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5671 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5672 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5673 make
5674
5675 msg "test: main suites (inc. selftests) (ASan build)"
5676 make test
5677
5678 msg "test: ssl-opt.sh (ASan build)"
5679 tests/ssl-opt.sh
5680
5681 msg "test: compat.sh (ASan build)"
5682 tests/compat.sh
5683}
5684
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005685component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005686 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005687 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005688 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005689 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5690
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005691 msg "test: TLS 1.3 only, all key exchange modes enabled"
5692 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005693
Ronald Cronc3f43b62022-10-17 17:35:32 +02005694 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5695 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005696}
5697
Ronald Cronc3f43b62022-10-17 17:35:32 +02005698component_test_tls13_only_psk () {
5699 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5700 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5701 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5702 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005703 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005704 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5705 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5706 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5707 scripts/config.py unset MBEDTLS_ECDSA_C
5708 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005709 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005710 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005711 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5712
Ronald Cronc3f43b62022-10-17 17:35:32 +02005713 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5714 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005715
Ronald Cronc3f43b62022-10-17 17:35:32 +02005716 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5717 tests/ssl-opt.sh
5718}
5719
5720component_test_tls13_only_ephemeral () {
5721 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5722 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5723 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005724 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005725 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5726
5727 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5728 cd tests; ./test_suite_ssl; cd ..
5729
5730 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5731 tests/ssl-opt.sh
5732}
5733
Przemek Stekiela01c2422023-06-13 10:46:48 +02005734component_test_tls13_only_ephemeral_ffdh () {
5735 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5736 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5737 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5738 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005739 scripts/config.py unset MBEDTLS_ECDH_C
5740
Przemek Stekiela01c2422023-06-13 10:46:48 +02005741 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5742
5743 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5744 cd tests; ./test_suite_ssl; cd ..
5745
5746 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5747 tests/ssl-opt.sh
5748}
5749
Ronald Cronc3f43b62022-10-17 17:35:32 +02005750component_test_tls13_only_psk_ephemeral () {
5751 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5752 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5753 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5754 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5755 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5756 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5757 scripts/config.py unset MBEDTLS_ECDSA_C
5758 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005759 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005760 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005761 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5762
5763 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5764 cd tests; ./test_suite_ssl; cd ..
5765
5766 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5767 tests/ssl-opt.sh
5768}
5769
Przemek Stekiela01c2422023-06-13 10:46:48 +02005770component_test_tls13_only_psk_ephemeral_ffdh () {
5771 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5772 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5773 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5774 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5775 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5776 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5777 scripts/config.py unset MBEDTLS_ECDSA_C
5778 scripts/config.py unset MBEDTLS_PKCS1_V21
5779 scripts/config.py unset MBEDTLS_PKCS7_C
5780 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005781 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005782 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5783
5784 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5785 cd tests; ./test_suite_ssl; cd ..
5786
5787 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5788 tests/ssl-opt.sh
5789}
5790
Ronald Cronc3f43b62022-10-17 17:35:32 +02005791component_test_tls13_only_psk_all () {
5792 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5793 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5794 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5795 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5796 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5797 scripts/config.py unset MBEDTLS_ECDSA_C
5798 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005799 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005800 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005801 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5802
5803 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5804 cd tests; ./test_suite_ssl; cd ..
5805
5806 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5807 tests/ssl-opt.sh
5808}
5809
5810component_test_tls13_only_ephemeral_all () {
5811 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5812 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005813 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005814 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5815
5816 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5817 cd tests; ./test_suite_ssl; cd ..
5818
5819 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5820 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005821}
5822
Ronald Cron46ac0652024-03-18 12:39:04 +01005823component_test_tls13_no_padding () {
5824 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005825 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005826 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005827 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005828 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005829 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005830 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005831 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005832 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005833}
5834
Ronald Cron6f135e12021-12-08 16:57:54 +01005835component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005836 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005837 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005838 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005839 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005840 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005841 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005842 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005843 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005844 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005845}
5846
Ronald Crondd96c0a2024-04-02 12:34:24 +02005847component_test_full_minus_session_tickets() {
5848 msg "build: full config without session tickets"
5849 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005850 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005851 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005852 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5853 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005854 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005855 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005856 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005857 tests/ssl-opt.sh
5858}
5859
Gilles Peskine8f073122018-11-27 15:58:47 +01005860component_build_mingw () {
5861 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005862 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 +00005863
Gilles Peskine8f073122018-11-27 15:58:47 +01005864 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005865 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 +01005866 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005867
Gilles Peskine8f073122018-11-27 15:58:47 +01005868 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005869 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
5870 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 +01005871 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005872
Pengyu Lv158eead2023-10-19 11:27:05 +08005873 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005874 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005875 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 +01005876 make WINDOWS_BUILD=1 clean
5877}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005878support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005879 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5880 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005881 *) true;;
5882 esac
5883}
Simon Butcher91aef332016-11-17 09:20:50 +00005884
Gilles Peskine8f073122018-11-27 15:58:47 +01005885component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005886 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005887 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005888 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5889 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005890
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005891 msg "test: main suites (MSan)" # ~ 10s
5892 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005893
Gilles Peskine6848d172023-11-02 19:58:03 +01005894 msg "test: metatests (MSan)"
5895 tests/scripts/run-metatests.sh any msan
5896
Gilles Peskine82b27272019-06-14 18:27:03 +02005897 msg "program demos (MSan)" # ~20s
5898 tests/scripts/run_demos.py
5899
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005900 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005901 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005902
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005903 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005904
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005905 if [ "$MEMORY" -gt 0 ]; then
5906 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005907 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005908 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005909}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005910
Bence Szépkúti0354d042023-12-06 16:14:37 +01005911component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005912 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005913 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005914 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5915 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005916
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005917 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005918 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005919
Gilles Peskine636c26a2020-03-04 20:46:15 +01005920 # Optional parts (slow; currently broken on OS X because programs don't
5921 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005922 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005923 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005924 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005925 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005926 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005927
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005928 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005929 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005930 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005931 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005932
5933 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005934 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005935 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005936 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005937}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005938
Bence Szépkúti0354d042023-12-06 16:14:37 +01005939component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005940 msg "build: Release, full (clang)"
5941 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5942 scripts/config.py full
5943 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5944 make
5945
5946 msg "test: main suites, Valgrind (full config)"
5947 make memcheck
5948}
5949
Paul Elliott62dc3922021-11-25 17:29:40 +00005950support_test_cmake_out_of_source () {
5951 distrib_id=""
5952 distrib_ver=""
5953 distrib_ver_minor=""
5954 distrib_ver_major=""
5955
5956 # Attempt to parse lsb-release to find out distribution and version. If not
5957 # found this should fail safe (test is supported).
5958 if [[ -f /etc/lsb-release ]]; then
5959
5960 while read -r lsb_line; do
5961 case "$lsb_line" in
5962 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5963 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5964 esac
5965 done < /etc/lsb-release
5966
5967 distrib_ver_major="${distrib_ver%%.*}"
5968 distrib_ver="${distrib_ver#*.}"
5969 distrib_ver_minor="${distrib_ver%%.*}"
5970 fi
5971
5972 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5973 # processor (as the CI does) can create a race condition whereby the build
5974 # fails to see a generated file, despite that file actually having been
5975 # generated. This problem appears to go away with 18.04 or newer, so make
5976 # the out of source tests unsupported on Ubuntu 16.04.
5977 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5978}
5979
Gilles Peskine8f073122018-11-27 15:58:47 +01005980component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005981 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005982 # generates
5983 make neat
5984
Gilles Peskine8f073122018-11-27 15:58:47 +01005985 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005986 MBEDTLS_ROOT_DIR="$PWD"
5987 mkdir "$OUT_OF_SOURCE_DIR"
5988 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005989 # Note: Explicitly generate files as these are turned off in releases
5990 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005991 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005992
Gilles Peskine8f073122018-11-27 15:58:47 +01005993 msg "test: cmake 'out-of-source' build"
5994 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005995 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005996 # Also ensure that there are no error messages such as
5997 # "No such file or directory", which would indicate that some required
5998 # file is missing (ssl-opt.sh tolerates the absence of some files so
5999 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006000 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006001 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006002 cat ssl-opt.err >&2
6003 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006004 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006005 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006006 cd "$MBEDTLS_ROOT_DIR"
6007 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006008}
Andres AGdc192212016-08-31 17:33:13 +01006009
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006010component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006011 # Remove existing generated files so that we use the ones CMake
6012 # generates
6013 make neat
6014
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006015 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006016 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006017 # Note: Explicitly generate files as these are turned off in releases
6018 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006019 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006020 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006021}
Gilles Peskinea3000992022-02-04 00:21:12 +01006022support_test_cmake_as_subdirectory () {
6023 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006024}
6025
Chris Kayd259e342021-03-25 16:03:25 +00006026component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006027 # Remove existing generated files so that we use the ones CMake
6028 # generates
6029 make neat
6030
Chris Kayd259e342021-03-25 16:03:25 +00006031 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006032 cd programs/test/cmake_package
6033 cmake .
6034 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006035 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006036}
Gilles Peskinea3000992022-02-04 00:21:12 +01006037support_test_cmake_as_package () {
6038 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006039}
6040
6041component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006042 # Remove existing generated files so that we use the ones CMake
6043 # generates
6044 make neat
6045
Chris Kayd259e342021-03-25 16:03:25 +00006046 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006047 cd programs/test/cmake_package_install
6048 cmake .
6049 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006050 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006051}
Gilles Peskinea3000992022-02-04 00:21:12 +01006052support_test_cmake_as_package_install () {
6053 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006054}
6055
David Horstmann20550e32023-01-12 14:17:01 +00006056component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006057 # Make a copy of config file to use for the in-tree test
6058 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006059
6060 MBEDTLS_ROOT_DIR="$PWD"
6061 mkdir "$OUT_OF_SOURCE_DIR"
6062 cd "$OUT_OF_SOURCE_DIR"
6063
David Horstmann969c1452023-01-31 10:34:44 +00006064 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006065 cmake "$MBEDTLS_ROOT_DIR"
6066 make
6067
6068 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6069 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006070 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006071 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6072 make
6073
6074 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6075 # In the user config, disable one feature (for simplicity, pick a feature
6076 # that nothing else depends on).
6077 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6078
6079 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6080 make
6081 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6082
6083 rm -f user_config.h full_config.h
6084
6085 cd "$MBEDTLS_ROOT_DIR"
6086 rm -rf "$OUT_OF_SOURCE_DIR"
6087
6088 # Now repeat the test for an in-tree build:
6089
David Horstmann969c1452023-01-31 10:34:44 +00006090 # Restore config for the in-tree test
6091 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006092
David Horstmann969c1452023-01-31 10:34:44 +00006093 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006094 cmake .
6095 make
6096
6097 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6098 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006099 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006100 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6101 make
6102
6103 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6104 # In the user config, disable one feature (for simplicity, pick a feature
6105 # that nothing else depends on).
6106 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6107
6108 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6109 make
6110 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6111
6112 rm -f user_config.h full_config.h
6113}
6114support_build_cmake_custom_config_file () {
6115 support_test_cmake_out_of_source
6116}
6117
6118
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006119component_build_zeroize_checks () {
6120 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6121
6122 scripts/config.py full
6123
6124 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006125 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 +01006126}
6127
6128
Gilles Peskine8f073122018-11-27 15:58:47 +01006129component_test_zeroize () {
6130 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6131 # different combinations of compilers and optimization flags by using an
6132 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6133 # system in all cases that the script fails, so we must manually search the
6134 # output to check whether the pass string is present and no failure strings
6135 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006136
Gilles Peskine4976e822019-01-06 19:52:22 +00006137 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6138 # about a spurious message if Gdb tries and fails, so suppress that.
6139 gdb_disable_aslr=
6140 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6141 gdb_disable_aslr='set disable-randomization off'
6142 fi
6143
Gilles Peskine8f073122018-11-27 15:58:47 +01006144 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006145 for compiler in clang gcc; do
6146 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6147 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006148 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6149 grep "The buffer was correctly zeroized" test_zeroize.log
6150 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006151 rm -f test_zeroize.log
6152 make clean
6153 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006154 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006155}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006156
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006157component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006158 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006159 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006160 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006161
6162 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006163 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006164}
6165
6166support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006167 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006168 ver="$(cmake --version)"
6169 ver="${ver#cmake version }"
6170 ver_major="${ver%%.*}"
6171
6172 ver="${ver#*.}"
6173 ver_minor="${ver%%.*}"
6174
6175 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006176}
6177
Gilles Peskinec848d222022-12-09 12:23:35 +01006178component_check_code_style () {
6179 msg "Check C code style"
6180 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006181}
6182
Gilles Peskinec848d222022-12-09 12:23:35 +01006183support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006184 case $(uncrustify --version) in
6185 *0.75.1*) true;;
6186 *) false;;
6187 esac
6188}
6189
Gilles Peskine8f073122018-11-27 15:58:47 +01006190component_check_python_files () {
6191 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006192 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006193}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006194
Joe Subbianid614c0b2021-07-29 11:18:29 +01006195component_check_test_helpers () {
6196 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006197 # unittest writes out mundane stuff like number or tests run on stderr.
6198 # Our convention is to reserve stderr for actual errors, and write
6199 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006200 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006201
Joe Subbiania25ffab2021-08-06 09:41:27 +01006202 msg "unit test: translate_ciphers.py"
6203 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006204}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006205
Valerio Settid9e42512024-05-06 15:59:51 +02006206component_test_psasim() {
Valerio Settid1b6ef12024-05-07 16:00:21 +02006207 msg "build library for client"
6208
6209 helper_crypto_client_build client
6210
6211 msg "build library for server"
6212
6213 scripts/config.py crypto
6214
6215 helper_crypto_client_build server
6216
Valerio Settid9e42512024-05-06 15:59:51 +02006217 msg "build psasim"
Valerio Setti4362aae2024-05-09 09:15:39 +02006218 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Settid9e42512024-05-06 15:59:51 +02006219
6220 msg "test psasim"
Valerio Setti655b9792024-05-09 12:20:40 +02006221 tests/psa-client-server/psasim/test/run_test.sh
Valerio Settid9e42512024-05-06 15:59:51 +02006222
6223 msg "clean psasim"
6224 make -C tests/psa-client-server/psasim clean
6225}
Jerry Yud767cc42023-03-31 15:03:55 +08006226
Gilles Peskine192c72f2017-12-21 15:59:21 +01006227################################################################
6228#### Termination
6229################################################################
6230
Gilles Peskine8f073122018-11-27 15:58:47 +01006231post_report () {
6232 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006233 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006234
Gilles Peskine8f073122018-11-27 15:58:47 +01006235 final_report
6236}
6237
6238
6239
6240################################################################
6241#### Run all the things
6242################################################################
6243
Gilles Peskine5d996822020-03-28 21:09:21 +01006244# Function invoked by --error-test to test error reporting.
6245pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006246 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006247 if [ $KEEP_GOING -ne 0 ]; then
6248 echo "Expect three failing commands."
6249 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006250 # If the component doesn't run in a subshell, changing error_test_i to an
6251 # invalid integer will cause an error in the loop that runs this function.
6252 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006253 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006254 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006255 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006256 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006257 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006258 make unknown_target
6259 false "this should not be executed"
6260}
6261
Gilles Peskinee48351a2018-11-27 16:06:30 +01006262# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006263run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006264 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006265 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006266
6267 # Unconditionally create a seedfile that's sufficiently long.
6268 # Do this before each component, because a previous component may
6269 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006270 local dd_cmd
6271 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6272 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006273 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006274 esac
6275 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006276
Gilles Peskineec135542021-08-02 23:14:03 +02006277 # Run the component in a subshell, with error trapping and output
6278 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006279 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006280 # We want to keep running if the subshell fails, so 'set -e' must
6281 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006282 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006283 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006284 (
6285 if [ $QUIET -eq 1 ]; then
6286 # msg() will be silenced, so just print the component name here.
6287 echo "${current_component#component_}"
6288 exec >/dev/null
6289 fi
6290 if [ $KEEP_GOING -eq 1 ]; then
6291 # Keep "set -e" off, and run an ERR trap instead to record failures.
6292 set -E
6293 trap err_trap ERR
6294 fi
6295 # The next line is what runs the component
6296 "$@"
6297 if [ $KEEP_GOING -eq 1 ]; then
6298 trap - ERR
6299 exit $last_failure_status
6300 fi
6301 )
6302 component_status=$?
6303 if [ $KEEP_GOING -eq 1 ]; then
6304 set -e
6305 if [ $component_status -ne 0 ]; then
6306 failure_count=$((failure_count + 1))
6307 fi
6308 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006309
6310 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006311 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006312 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006313}
6314
6315# Preliminary setup
6316pre_check_environment
6317pre_initialize_variables
6318pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006319
Dave Rodgman21900632024-02-26 11:41:19 +00006320setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006321pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006322pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006323pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006324
Gilles Peskine878cf602019-01-06 20:50:38 +00006325build_status=0
6326if [ $KEEP_GOING -eq 1 ]; then
6327 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006328fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006329pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006330pre_print_configuration
6331pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006332cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006333if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006334 pre_generate_files
6335fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006336
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006337# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006338for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006339 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006340done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006341unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006342for component in $RUN_COMPONENTS; do
6343 run_component "component_$component"
6344done
Gilles Peskine8f073122018-11-27 15:58:47 +01006345
6346# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006347post_report