blob: 74921dce29a82ebcd9c9144ae42c35768e10ef94 [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
Valerio Settib2fd6732023-08-15 17:10:47 +0200919# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200920# The function optionally accepts 1 parameter: a space-separated list of the
921# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200922helper_disable_builtin_curves() {
923 allowed_list="${1:-}"
924 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
925
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200926 for curve in $allowed_list; do
927 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200928 done
929}
930
931# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
932# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
933# in the following helpers.
934helper_get_psa_curve_list () {
935 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200936 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
937 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200938 done
939
940 echo "$loc_list"
941}
942
Valerio Setti78aa0bc2024-01-17 15:53:46 +0100943# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
944# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
945# in the following helpers.
946helper_get_psa_dh_group_list () {
947 loc_list=""
948 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
949 loc_list="$loc_list $item"
950 done
951
952 echo "$loc_list"
953}
954
Valerio Settib2fd6732023-08-15 17:10:47 +0200955# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +0200956# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +0200957# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +0200958helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200959 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +0200960 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200961 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 +0200962 # Skip DERIVE for elliptic keys since there is no driver dispatch for
963 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200964 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
965 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200966 fi
967 done
968
969 echo "$loc_list"
970}
971
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200972# Build the drivers library libtestdriver1.a (with ASan).
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200973#
974# Parameters:
975# 1. a space-separated list of things to accelerate;
976# 2. optional: a space-separate list of things to also support.
977# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
978helper_libtestdriver1_make_drivers() {
979 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
Gilles Peskine21570cf2023-12-22 11:49:50 +0100980 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200981}
982
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200983# Build the main libraries, programs and tests,
984# linking to the drivers library (with ASan).
985#
986# Parameters:
987# 1. a space-separated list of things to accelerate;
988# *. remaining arguments if any are passed directly to make
989# (examples: lib, -C tests test_suite_xxx, etc.)
990# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
991helper_libtestdriver1_make_main() {
992 loc_accel_list=$1
993 shift
994
995 # we need flags both with and without the LIBTESTDRIVER1_ prefix
996 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
997 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
Gilles Peskine21570cf2023-12-22 11:49:50 +0100998 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" "$@"
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200999}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001000
1001################################################################
1002#### Basic checks
1003################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001004
1005#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001006# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001007#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001008# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001009# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001010# 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 +02001011# time, so start with a GCC build).
1012# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001013#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001014# Indicative running times are given for reference.
1015
Gilles Peskine8f073122018-11-27 15:58:47 +01001016component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001017 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001018 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001019}
Janos Follathb72c6782016-07-19 14:54:17 +01001020
Gilles Peskine67debb62021-05-18 16:09:50 +02001021component_check_generated_files () {
1022 msg "Check: check-generated-files, files generated with make" # 2s
1023 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001024 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001025
1026 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001027 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001028 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001029 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001030
1031 msg "Check: check-generated-files -u, files absent" # 2s
1032 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001033 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001034 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001035 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001036
1037 # This component ends with the generated files present in the source tree.
1038 # This is necessary for subsequent components!
1039}
1040
Gilles Peskine8f073122018-11-27 15:58:47 +01001041component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001042 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001043 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001044}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001045
Gilles Peskine8f073122018-11-27 15:58:47 +01001046component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001047 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001048 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001049}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001050
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001051component_check_changelog () {
1052 msg "Check: changelog entries" # < 1s
1053 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001054 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001055 if [ -e ChangeLog.new ]; then
1056 # Show the diff for information. It isn't an error if the diff is
1057 # non-empty.
1058 diff -u ChangeLog ChangeLog.new || true
1059 rm ChangeLog.new
1060 fi
1061}
1062
Gilles Peskine8f073122018-11-27 15:58:47 +01001063component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001064 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001065 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001066}
Darryl Greena07039c2018-03-13 16:48:16 +00001067
Gilles Peskine895868b2019-09-19 21:30:05 +02001068component_check_test_cases () {
1069 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001070 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001071 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001072 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001073 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001074 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001075 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001076 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001077}
1078
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001079component_check_test_dependencies () {
1080 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001081 # The purpose of this component is to catch unjustified dependencies on
1082 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1083 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1084 # MBEDTLS_PSA_xxx).
1085 #
1086 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1087 # this component is meant to catch. However a few of them are justified,
1088 # mostly by the absence of a PSA equivalent, so this component includes a
1089 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001090
1091 found="check-test-deps-found-$$"
1092 expected="check-test-deps-expected-$$"
1093
1094 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001095 grep 'depends_on' \
1096 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001097 grep -Eo '!?MBEDTLS_[^: ]*' |
1098 grep -v MBEDTLS_PSA_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001099 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001100
Yanray Wang18040ed2023-11-23 21:29:56 +08001101 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001102 rm -f $expected
1103 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1104 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001105 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1106 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001107 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1108 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001109 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1110 # the test code and that's probably the most convenient way of achieving
1111 # the test's goal.
1112 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1113 # No PSA equivalent - we should probably have one in the future.
1114 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1115 # No PSA equivalent - needed by some init tests
1116 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001117 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001118 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001119
1120 # Compare reality with expectation.
1121 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001122 #
1123 # The output should be empty. When it's not:
1124 # - Each '+' line is a macro that was found but not expected. You want to
1125 # find where that macro occurs, and either replace it with PSA macros, or
1126 # add it to the exceptions list above with a justification.
1127 # - Each '-' line is a macro that was expected but not found; it means the
1128 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001129 diff -U0 $expected $found
1130
1131 rm $found $expected
1132}
1133
Gilles Peskine8f073122018-11-27 15:58:47 +01001134component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001135 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001136 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001137}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001138
Gilles Peskine192c72f2017-12-21 15:59:21 +01001139
Gilles Peskine636c26a2020-03-04 20:46:15 +01001140
Gilles Peskine192c72f2017-12-21 15:59:21 +01001141################################################################
1142#### Build and test many configurations and targets
1143################################################################
1144
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001145component_test_default_out_of_box () {
1146 msg "build: make, default config (out-of-box)" # ~1min
1147 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001148 # Disable fancy stuff
1149 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001150
1151 msg "test: main suites make, default config (out-of-box)" # ~10s
1152 make test
1153
1154 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001155 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001156
1157 msg "program demos: make, default config (out-of-box)" # ~10s
1158 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001159}
1160
Gilles Peskine8f073122018-11-27 15:58:47 +01001161component_test_default_cmake_gcc_asan () {
1162 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001163 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1164 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001165
Gilles Peskine8f073122018-11-27 15:58:47 +01001166 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1167 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001168
Gilles Peskine82b27272019-06-14 18:27:03 +02001169 msg "program demos (ASan build)" # ~10s
1170 tests/scripts/run_demos.py
1171
Gilles Peskine97bea012020-04-23 23:37:45 +02001172 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001173 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001174
Gilles Peskine6848d172023-11-02 19:58:03 +01001175 msg "test: metatests (GCC, ASan build)"
1176 tests/scripts/run-metatests.sh any asan
1177
Gilles Peskine8f073122018-11-27 15:58:47 +01001178 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001179 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001180
Gilles Peskine8f073122018-11-27 15:58:47 +01001181 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001182 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001183
1184 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001185 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001186}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001187
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001188component_test_default_cmake_gcc_asan_new_bignum () {
1189 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001190 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001191 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001192 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001193
1194 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1195 make test
1196
1197 msg "test: selftest (ASan build)" # ~ 10s
1198 programs/test/selftest
1199
1200 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1201 tests/ssl-opt.sh
1202
1203 msg "test: compat.sh (ASan build)" # ~ 6 min
1204 tests/compat.sh
1205
1206 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1207 tests/context-info.sh
1208}
1209
Hanno Becker01635512019-02-26 14:27:09 +00001210component_test_full_cmake_gcc_asan () {
1211 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001212 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001213 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1214 make
1215
1216 msg "test: main suites (inc. selftests) (full config, ASan build)"
1217 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001218
Gilles Peskine97bea012020-04-23 23:37:45 +02001219 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001220 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001221
Gilles Peskine636c26a2020-03-04 20:46:15 +01001222 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001223 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001224
1225 msg "test: compat.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001226 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001227
1228 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001229 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001230}
1231
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001232
1233component_test_full_cmake_gcc_asan_new_bignum () {
1234 msg "build: full config, cmake, gcc, ASan"
1235 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001236 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001237 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001238 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001239
1240 msg "test: main suites (inc. selftests) (full config, ASan build)"
1241 make test
1242
1243 msg "test: selftest (ASan build)" # ~ 10s
1244 programs/test/selftest
1245
1246 msg "test: ssl-opt.sh (full config, ASan build)"
1247 tests/ssl-opt.sh
1248
1249 msg "test: compat.sh (full config, ASan build)"
1250 tests/compat.sh
1251
1252 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
1253 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001254}
1255
Ronald Cronc3623db2020-10-29 10:51:32 +01001256component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001257 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001258 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001259 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1260 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1261 make
1262
1263 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1264 make test
1265}
1266
Gilles Peskinea3548672021-06-17 11:37:52 +02001267# check_renamed_symbols HEADER LIB
1268# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1269# name is LIB.
1270check_renamed_symbols () {
1271 ! nm "$2" | sed 's/.* //' |
1272 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1273}
1274
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001275component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001276 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001277 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001278 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1279 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1280 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1281 # We can only compile, not link, since our test and sample programs
1282 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1283 # is active.
1284 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001285
1286 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1287 # version is not present.
1288 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001289 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001290}
1291
Valerio Setti63097752024-03-12 13:18:13 +01001292# Get a list of library-wise undefined symbols and ensure that they only
1293# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1294# This function is a common helper used by both:
1295# - component_test_default_psa_crypto_client_without_crypto_provider
1296# - component_build_full_psa_crypto_client_without_crypto_provider.
1297common_check_mbedtls_missing_symbols() {
1298 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1299 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1300 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1301 not grep mbedtls_ linking_errors.txt
1302
1303 rm sym_def.txt sym_undef.txt linking_errors.txt
1304}
1305
1306component_test_default_psa_crypto_client_without_crypto_provider () {
1307 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1308
Ronald Cron336678b2021-01-28 17:54:24 +01001309 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1310 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001311 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001312 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001313 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001314 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001315
Ronald Cron336678b2021-01-28 17:54:24 +01001316 make
1317
Valerio Setti63097752024-03-12 13:18:13 +01001318 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1319 common_check_mbedtls_missing_symbols
1320
1321 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001322 make test
1323}
1324
Valerio Setti63097752024-03-12 13:18:13 +01001325component_build_full_psa_crypto_client_without_crypto_provider () {
1326 msg "build: full config - PSA_CRYPTO_C"
1327
1328 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1329 scripts/config.py full
1330
1331 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1332 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1333 # Dynamic secure element support is a deprecated feature and it is not
1334 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1335 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1336
1337 # Since there is no crypto provider in this build it is not possible to
1338 # build all the test executables and progrems due to missing PSA functions
1339 # at link time. Therefore we will just build libraries and we'll check
1340 # that symbols of interest are there.
1341 make lib
1342
1343 msg "check missing symbols: full config - PSA_CRYPTO_C"
1344
1345 common_check_mbedtls_missing_symbols
1346
1347 # Ensure that desired functions are included into the build (extend the
1348 # following list as required).
1349 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1350 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1351 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1352}
1353
Jaeden Amero424fa932021-05-14 08:34:32 +01001354component_test_psa_crypto_rsa_no_genprime() {
1355 msg "build: default config minus MBEDTLS_GENPRIME"
1356 scripts/config.py unset MBEDTLS_GENPRIME
1357 make
1358
1359 msg "test: default config minus MBEDTLS_GENPRIME"
1360 make test
1361}
1362
Gilles Peskine782f4112018-11-27 16:11:09 +01001363component_test_ref_configs () {
1364 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001365 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1366 # want to re-generate generated files that depend on it, quite correctly.
1367 # However this doesn't work as the generation script expects a specific
1368 # format for mbedtls_config.h, which the other files don't follow. Also,
1369 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001370 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001371 # whether they're on or off. So, disable cmake's (over-sensitive here)
1372 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001373 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001374 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001375 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001376}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001377
Gilles Peskine8f073122018-11-27 15:58:47 +01001378component_test_no_renegotiation () {
1379 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001380 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001381 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001382 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001383
Gilles Peskine8f073122018-11-27 15:58:47 +01001384 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1385 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001386
Gilles Peskine8f073122018-11-27 15:58:47 +01001387 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001388 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001389}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001390
Gilles Peskine636c26a2020-03-04 20:46:15 +01001391component_test_no_pem_no_fs () {
1392 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1393 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1394 scripts/config.py unset MBEDTLS_FS_IO
1395 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1396 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001397 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001398 make
1399
1400 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1401 make test
1402
1403 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001404 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001405}
1406
Gilles Peskine8f073122018-11-27 15:58:47 +01001407component_test_rsa_no_crt () {
1408 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001409 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001410 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001411 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001412
Gilles Peskine8f073122018-11-27 15:58:47 +01001413 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1414 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001415
Gilles Peskine8f073122018-11-27 15:58:47 +01001416 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001417 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001418
Gilles Peskine8f073122018-11-27 15:58:47 +01001419 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001420 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001421
1422 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001423 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001424}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001425
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001426component_test_no_ctr_drbg_classic () {
1427 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001428 scripts/config.py full
1429 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001430 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001431 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001432
Dave Rodgman17127e92023-12-14 16:42:48 +00001433 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001434 make
1435
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001436 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001437 make test
1438
Gilles Peskineba749042021-01-13 20:02:03 +01001439 # In this configuration, the TLS test programs use HMAC_DRBG.
1440 # The SSL tests are slow, so run a small subset, just enough to get
1441 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001442 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001443 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001444
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001445 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001446 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001447}
1448
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001449component_test_no_ctr_drbg_use_psa () {
1450 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001451 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001452 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1453 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001454
Dave Rodgman17127e92023-12-14 16:42:48 +00001455 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001456 make
1457
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001458 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1459 make test
1460
1461 # In this configuration, the TLS test programs use HMAC_DRBG.
1462 # The SSL tests are slow, so run a small subset, just enough to get
1463 # confidence that the SSL code copes with HMAC_DRBG.
1464 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001465 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001466
1467 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001468 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001469}
1470
1471component_test_no_hmac_drbg_classic () {
1472 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1473 scripts/config.py full
1474 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1475 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1476 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001477 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001478
Dave Rodgman17127e92023-12-14 16:42:48 +00001479 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001480 make
1481
1482 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001483 make test
1484
Gilles Peskinea2224342020-11-19 22:14:34 +01001485 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1486 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1487 # instead.
1488 # Test SSL with non-deterministic ECDSA. Only test features that
1489 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001490 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001491 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001492
1493 # To save time, only test one protocol version, since this part of
1494 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001495 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001496 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001497}
1498
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001499component_test_no_hmac_drbg_use_psa () {
1500 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1501 scripts/config.py full
1502 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1503 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1504 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1505
Dave Rodgman17127e92023-12-14 16:42:48 +00001506 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001507 make
1508
1509 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1510 make test
1511
1512 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1513 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1514 # instead.
1515 # Test SSL with non-deterministic ECDSA. Only test features that
1516 # might be affected by how ECDSA signature is performed.
1517 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001518 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001519
1520 # To save time, only test one protocol version, since this part of
1521 # the protocol is identical in (D)TLS up to 1.2.
1522 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001523 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001524}
1525
1526component_test_psa_external_rng_no_drbg_classic () {
1527 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1528 scripts/config.py full
1529 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001530 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001531 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001532 scripts/config.py unset MBEDTLS_ENTROPY_C
1533 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1534 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001535 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1536 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1537 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001538 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1539 # the SSL test programs don't have an RNG and can't work. Explicitly
1540 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001541 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001542
1543 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1544 make test
1545
Gilles Peskine8eb29432021-02-03 20:07:11 +01001546 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001547 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001548}
1549
1550component_test_psa_external_rng_no_drbg_use_psa () {
1551 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001552 scripts/config.py full
1553 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001554 scripts/config.py unset MBEDTLS_ENTROPY_C
1555 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1556 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001557 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1558 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1559 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001560 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001561
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001562 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001563 make test
1564
Gilles Peskine8eb29432021-02-03 20:07:11 +01001565 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001566 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001567}
1568
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001569component_test_psa_external_rng_use_psa_crypto () {
1570 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1571 scripts/config.py full
1572 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1573 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1574 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001575 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001576
1577 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1578 make test
1579
1580 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1581 tests/ssl-opt.sh -f 'Default\|opaque'
1582}
1583
Gilles Peskine801c4332023-04-28 21:04:28 +02001584component_test_psa_inject_entropy () {
1585 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1586 scripts/config.py full
1587 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1588 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1589 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1590 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1591 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1592 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001593 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 +02001594
1595 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1596 make test
1597}
1598
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001599component_test_sw_inet_pton () {
1600 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1601
1602 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1603 scripts/config.py set MBEDTLS_TEST_HOOKS
1604 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1605
1606 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1607 make test
1608}
1609
Valerio Settia41654d2024-02-08 10:33:11 +01001610component_full_no_pkparse_pkwrite() {
1611 msg "build: full without pkparse and pkwrite"
1612
1613 scripts/config.py crypto_full
1614 scripts/config.py unset MBEDTLS_PK_PARSE_C
1615 scripts/config.py unset MBEDTLS_PK_WRITE_C
1616
Valerio Settia41654d2024-02-08 10:33:11 +01001617 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1618
1619 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1620 not grep mbedtls_pk_parse_key library/pkparse.o
1621 not grep mbedtls_pk_write_key_der library/pkwrite.o
1622
1623 msg "test: full without pkparse and pkwrite"
1624 make test
1625}
1626
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001627component_test_crypto_full_md_light_only () {
1628 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001629 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001630 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001631 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001632 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001633 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001634 scripts/config.py unset MBEDTLS_HKDF_C
1635 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001636 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001637 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001638 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001639 # Disable things that would auto-enable MD_C
1640 scripts/config.py unset MBEDTLS_PKCS5_C
1641
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001642 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1643 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001644 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001645
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001646 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001647 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001648 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001649
1650 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001651 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001652}
1653
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001654component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001655 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001656 scripts/config.py full
1657 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001658 # Don't pull in cipher via PSA mechanisms
1659 # (currently ignored anyway because we completely disable PSA)
1660 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001661 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001662 scripts/config.py unset MBEDTLS_CMAC_C
1663 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001664 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001665 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001666 scripts/config.py unset MBEDTLS_SSL_TLS_C
1667 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001668 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001669 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1670 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001671 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001672 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001673 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001674
Valerio Settidf17a102023-10-23 14:14:19 +02001675 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001676 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001677}
1678
Valerio Setti7e710e82023-08-25 09:14:15 +02001679# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001680# - component_test_full_no_cipher_with_psa_crypto
1681# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001682# It accepts 2 input parameters:
1683# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1684# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001685common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001686 USE_CRYPTO_CONFIG="$1"
1687 COMPONENT_DESCRIPTION="$2"
1688
1689 msg "build: $COMPONENT_DESCRIPTION"
1690
1691 scripts/config.py full
1692 scripts/config.py unset MBEDTLS_CIPHER_C
1693
1694 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001695 # The built-in implementation of the following algs/key-types depends
1696 # on CIPHER_C so we disable them.
1697 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1698 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001699 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001700 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1701 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1702 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1703 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1704 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1705 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1706 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1707 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001708 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001709 else
1710 # Don't pull in cipher via PSA mechanisms
1711 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001712 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1713 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1714 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001715 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001716 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001717 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001718 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001719
Gilles Peskine21570cf2023-12-22 11:49:50 +01001720 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001721
Valerio Setti7e710e82023-08-25 09:14:15 +02001722 # Ensure that CIPHER_C was not re-enabled
1723 not grep mbedtls_cipher_init library/cipher.o
1724
1725 msg "test: $COMPONENT_DESCRIPTION"
1726 make test
1727}
1728
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001729component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001730 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001731}
1732
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001733component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001734 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001735}
1736
Valerio Settibdfecb62023-11-07 15:37:20 +01001737component_test_full_no_ccm() {
1738 msg "build: full no PSA_WANT_ALG_CCM"
1739
1740 # Full config enables:
1741 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1742 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1743 scripts/config.py full
1744
1745 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1746 # enabled, but not used from TLS since USE_PSA is set.
1747 # This is helpful to ensure that TLS tests below have proper dependencies.
1748 #
1749 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1750 # PSA_WANT_ALG_CCM to be re-enabled.
1751 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1752
Gilles Peskine21570cf2023-12-22 11:49:50 +01001753 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001754
1755 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001756 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001757}
1758
1759component_test_full_no_ccm_star_no_tag() {
1760 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1761
1762 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1763 scripts/config.py full
1764
1765 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1766 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1767 # This basically disables all unauthenticated ciphers on the PSA side, while
1768 # keeping AEADs enabled.
1769 #
1770 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1771 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1772 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1773 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1774 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1775 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1776 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1777 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1778 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1779 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1780
Gilles Peskine21570cf2023-12-22 11:49:50 +01001781 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001782
1783 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001784 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001785
1786 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001787 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001788}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001789
Valerio Settie1655b82023-01-03 15:35:25 +01001790component_test_full_no_bignum () {
1791 msg "build: full minus bignum"
1792 scripts/config.py full
1793 scripts/config.py unset MBEDTLS_BIGNUM_C
1794 # Direct dependencies of bignum
1795 scripts/config.py unset MBEDTLS_ECP_C
1796 scripts/config.py unset MBEDTLS_RSA_C
1797 scripts/config.py unset MBEDTLS_DHM_C
1798 # Direct dependencies of ECP
1799 scripts/config.py unset MBEDTLS_ECDH_C
1800 scripts/config.py unset MBEDTLS_ECDSA_C
1801 scripts/config.py unset MBEDTLS_ECJPAKE_C
1802 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001803 # Disable what auto-enables ECP_LIGHT
1804 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1805 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001806 # Indirect dependencies of ECP
1807 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1808 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1809 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1810 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1811 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1812 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1813 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1814 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1815 # Direct dependencies of DHM
1816 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1817 # Direct dependencies of RSA
1818 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1819 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1820 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1821 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1822 # PK and its dependencies
1823 scripts/config.py unset MBEDTLS_PK_C
1824 scripts/config.py unset MBEDTLS_PK_PARSE_C
1825 scripts/config.py unset MBEDTLS_PK_WRITE_C
1826 scripts/config.py unset MBEDTLS_X509_USE_C
1827 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1828 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1829 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1830 scripts/config.py unset MBEDTLS_X509_CREATE_C
1831 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1832 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1833 scripts/config.py unset MBEDTLS_PKCS7_C
1834 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1835 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1836 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1837
Gilles Peskine21570cf2023-12-22 11:49:50 +01001838 make
Valerio Settie1655b82023-01-03 15:35:25 +01001839
1840 msg "test: full minus bignum"
1841 make test
1842}
1843
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001844component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001845 msg "build: default with only stream cipher"
1846
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001847 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001848 scripts/config.py unset MBEDTLS_GCM_C
1849 scripts/config.py unset MBEDTLS_CCM_C
1850 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001851 #Disable TLS 1.3 (as no AEAD)
1852 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001853 # 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 +02001854 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001855 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001856 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001857 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1858 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001859 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001860 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001861 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001862
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001863 make
1864
1865 msg "test: default with only stream cipher"
1866 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001867
1868 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001869}
1870
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001871component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001872 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001873
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001874 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001875 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001876 scripts/config.py unset MBEDTLS_GCM_C
1877 scripts/config.py unset MBEDTLS_CCM_C
1878 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001879 #Disable TLS 1.3 (as no AEAD)
1880 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001881 # 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 +02001882 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001883 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001884 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001885 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1886 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001887 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001888 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001889 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001890
Przemek Stekiel9550c052022-09-28 09:51:55 +02001891 make
1892
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001893 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001894 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001895
1896 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001897}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001898
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001899component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001900 msg "build: default with only CBC-legacy cipher"
1901
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001902 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001903 scripts/config.py unset MBEDTLS_GCM_C
1904 scripts/config.py unset MBEDTLS_CCM_C
1905 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001906 #Disable TLS 1.3 (as no AEAD)
1907 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001908 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1909 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1910 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001911 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001912 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001913 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001914 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001915 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001916 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001917
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001918 make
1919
1920 msg "test: default with only CBC-legacy cipher"
1921 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001922
1923 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1924 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001925}
1926
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001927component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001928 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001929
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001930 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001931 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001932 scripts/config.py unset MBEDTLS_GCM_C
1933 scripts/config.py unset MBEDTLS_CCM_C
1934 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001935 #Disable TLS 1.3 (as no AEAD)
1936 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001937 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1938 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1939 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001940 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001941 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001942 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001943 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001944 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001945 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001946
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001947 make
1948
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001949 msg "test: default with only CBC-legacy cipher use psa"
1950 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001951
1952 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1953 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001954}
1955
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001956component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001957 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1958
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001959 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001960 scripts/config.py unset MBEDTLS_GCM_C
1961 scripts/config.py unset MBEDTLS_CCM_C
1962 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001963 #Disable TLS 1.3 (as no AEAD)
1964 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001965 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1966 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1967 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1968 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1969 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001970 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001971 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001972 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001973 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001974
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001975 make
1976
1977 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
1978 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001979
1980 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
1981 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001982}
1983
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001984component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
1985 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001986
1987 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001988 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001989 scripts/config.py unset MBEDTLS_GCM_C
1990 scripts/config.py unset MBEDTLS_CCM_C
1991 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001992 #Disable TLS 1.3 (as no AEAD)
1993 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001994 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1995 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1996 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1997 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1998 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001999 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002000 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002001 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002002 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002003
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002004 make
2005
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002006 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002007 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002008
2009 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2010 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002011}
2012
Valerio Setti9f0ec532022-11-08 13:03:24 +01002013# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2014# that we could use for interop testing. However, we now have sort of two
2015# implementations ourselves: one using PSA, the other not. At least test that
2016# these two interoperate with each other.
2017component_test_tls1_2_ecjpake_compatibility() {
2018 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2019 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002020 # Explicitly make lib first to avoid a race condition:
2021 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2022 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002023 make -C programs ssl/ssl_server2 ssl/ssl_client2
2024 cp programs/ssl/ssl_server2 s2_no_use_psa
2025 cp programs/ssl/ssl_client2 c2_no_use_psa
2026
2027 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2028 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2029 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002030 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002031 make -C programs ssl/ssl_server2 ssl/ssl_client2
2032 make -C programs test/udp_proxy test/query_compile_time_config
2033
Valerio Setti70e02902022-12-02 16:21:56 +01002034 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2035 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2036 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2037 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2038 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2039 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2040 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2041 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password server only, working, TLS"
Valerio Setti9f0ec532022-11-08 13:03:24 +01002042
2043 rm s2_no_use_psa c2_no_use_psa
2044}
2045
Gilles Peskine636c26a2020-03-04 20:46:15 +01002046component_test_everest () {
2047 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2048 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2049 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2050 make
2051
2052 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2053 make test
2054
Gilles Peskine6848d172023-11-02 19:58:03 +01002055 msg "test: metatests (clang, ASan)"
2056 tests/scripts/run-metatests.sh any asan
2057
Gilles Peskine636c26a2020-03-04 20:46:15 +01002058 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2059 tests/ssl-opt.sh -f ECDH
2060
2061 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2062 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002063 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002064}
2065
Gilles Peskined3beca92020-07-03 00:15:37 +02002066component_test_everest_curve25519_only () {
2067 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002068 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2069 scripts/config.py unset MBEDTLS_ECDSA_C
2070 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2071 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002072 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002073 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002074 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002075 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2076
Dave Rodgman17127e92023-12-14 16:42:48 +00002077 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002078
2079 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2080 make test
2081}
2082
Gilles Peskine8f073122018-11-27 15:58:47 +01002083component_test_small_ssl_out_content_len () {
2084 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002085 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2086 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002087 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002088 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002089
Gilles Peskine8f073122018-11-27 15:58:47 +01002090 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002091 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002092}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002093
Gilles Peskine8f073122018-11-27 15:58:47 +01002094component_test_small_ssl_in_content_len () {
2095 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002096 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2097 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002098 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002099 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002100
Gilles Peskine8f073122018-11-27 15:58:47 +01002101 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002102 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002103}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002104
Gilles Peskine8f073122018-11-27 15:58:47 +01002105component_test_small_ssl_dtls_max_buffering () {
2106 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002107 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002108 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002109 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002110
Gilles Peskine8f073122018-11-27 15:58:47 +01002111 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002112 tests/ssl-opt.sh -f "DTLS reordering: Buffer out-of-order hs msg before reassembling next, free buffered msg"
Gilles Peskine8f073122018-11-27 15:58:47 +01002113}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002114
Gilles Peskine8f073122018-11-27 15:58:47 +01002115component_test_small_mbedtls_ssl_dtls_max_buffering () {
2116 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002117 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002118 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002119 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002120
Gilles Peskine8f073122018-11-27 15:58:47 +01002121 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002122 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002123}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002124
Gilles Peskine75cc7712019-09-06 19:47:17 +02002125component_test_psa_collect_statuses () {
2126 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002127 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002128 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002129 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002130 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002131 rm -f tests/statuses.log
2132}
2133
Gilles Peskine8f073122018-11-27 15:58:47 +01002134component_test_full_cmake_clang () {
2135 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002136 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002137 CC=clang CXX=clang cmake -D CMAKE_BUILD_TYPE:String=Release -D ENABLE_TESTING=On -D TEST_CPP=1 .
Gilles Peskine8f073122018-11-27 15:58:47 +01002138 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002139
k-stachowiak0291cb72019-06-26 15:52:12 +02002140 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002141 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002142
Gilles Peskineda6017c2022-10-30 21:02:40 +01002143 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2144 programs/test/cpp_dummy_build
2145
Gilles Peskine6848d172023-11-02 19:58:03 +01002146 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002147 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002148
Gilles Peskine82b27272019-06-14 18:27:03 +02002149 msg "program demos (full config, clang)" # ~10s
2150 tests/scripts/run_demos.py
2151
k-stachowiak0291cb72019-06-26 15:52:12 +02002152 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002153 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002154
Gilles Peskine8f073122018-11-27 15:58:47 +01002155 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002156 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002157
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002158 msg "test: compat.sh NULL (full config)" # ~ 2 min
Gilles Peskinee29203b2023-08-27 21:43:00 +02002159 tests/compat.sh -e '^$' -f 'NULL'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002160
Gilles Peskine8f073122018-11-27 15:58:47 +01002161 msg "test: compat.sh ARIA + ChachaPoly"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002162 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gilles Peskine8f073122018-11-27 15:58:47 +01002163}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002164
Gilles Peskine0c671602022-11-29 16:01:41 +01002165skip_suites_without_constant_flow () {
2166 # Skip the test suites that don't have any constant-flow annotations.
2167 # This will need to be adjusted if we ever start declaring things as
2168 # secret from macros or functions inside tests/include or tests/src.
2169 SKIP_TEST_SUITES=$(
2170 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2171 sed 's/test_suite_//; s/\.function$//' |
2172 tr '\n' ,)
2173 export SKIP_TEST_SUITES
2174}
2175
Dave Rodgman246210e2023-07-31 18:07:44 +01002176skip_all_except_given_suite () {
2177 # Skip all but the given test suite
2178 SKIP_TEST_SUITES=$(
2179 ls -1 tests/suites/test_suite_*.function |
2180 grep -v $1.function |
2181 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2182 tr '\n' ,)
2183 export SKIP_TEST_SUITES
2184}
2185
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002186component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002187 # This tests both (1) accesses to undefined memory, and (2) branches or
2188 # memory access depending on secret values. To distinguish between those:
2189 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2190 # - or alternatively, change the build type to MemSanDbg, which enables
2191 # origin tracking and nicer stack traces (which are useful for debugging
2192 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002193 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2194 scripts/config.py full
2195 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2196 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2197 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2198 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2199 make
2200
2201 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2202 make test
2203}
2204
2205component_test_memsan_constant_flow_psa () {
2206 # This tests both (1) accesses to undefined memory, and (2) branches or
2207 # memory access depending on secret values. To distinguish between those:
2208 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2209 # - or alternatively, change the build type to MemSanDbg, which enables
2210 # origin tracking and nicer stack traces (which are useful for debugging
2211 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002212 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002213 scripts/config.py full
2214 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2215 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2216 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2217 make
2218
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002219 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002220 make test
2221}
2222
Bence Szépkúti0354d042023-12-06 16:14:37 +01002223component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002224 # This tests both (1) everything that valgrind's memcheck usually checks
2225 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2226 # etc.) and (2) branches or memory access depending on secret values,
2227 # which will be reported as uninitialized memory. To distinguish between
2228 # secret and actually uninitialized:
2229 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2230 # - or alternatively, build with debug info and manually run the offending
2231 # test suite with valgrind --track-origins=yes, then check if the origin
2232 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002233 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2234 scripts/config.py full
2235 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2236 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002237 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002238 cmake -D CMAKE_BUILD_TYPE:String=Release .
2239 make
2240
2241 # this only shows a summary of the results (how many of each type)
2242 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002243 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002244 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002245
2246 # Test asm path in constant time module - by default, it will test the plain C
2247 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2248 msg "test: valgrind asm constant_time"
2249 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2250 skip_all_except_given_suite test_suite_constant_time
2251 cmake -D CMAKE_BUILD_TYPE:String=Release .
2252 make clean
2253 make
2254 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002255}
2256
Bence Szépkúti0354d042023-12-06 16:14:37 +01002257component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002258 # This tests both (1) everything that valgrind's memcheck usually checks
2259 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2260 # etc.) and (2) branches or memory access depending on secret values,
2261 # which will be reported as uninitialized memory. To distinguish between
2262 # secret and actually uninitialized:
2263 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2264 # - or alternatively, build with debug info and manually run the offending
2265 # test suite with valgrind --track-origins=yes, then check if the origin
2266 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002267 msg "build: cmake release GCC, full config with constant flow testing"
2268 scripts/config.py full
2269 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002270 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002271 cmake -D CMAKE_BUILD_TYPE:String=Release .
2272 make
2273
2274 # this only shows a summary of the results (how many of each type)
2275 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002276 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002277 make memcheck
2278}
2279
Janos Follath9338cac2023-10-04 18:55:39 +01002280component_test_tsan () {
2281 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002282 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002283 scripts/config.py set MBEDTLS_THREADING_C
2284 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002285 # Self-tests do not currently use multiple threads.
2286 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002287
Ryan6caf84f2024-03-05 13:57:00 +00002288 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2289 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2290
Janos Follath9338cac2023-10-04 18:55:39 +01002291 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2292 make
2293
2294 msg "test: main suites (TSan)"
2295 make test
2296}
2297
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002298component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002299 # Test that removing the deprecated features from the default
2300 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002301 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2302 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002303 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002304
2305 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2306 make test
2307}
2308
2309component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002310 msg "build: make, full_no_deprecated config" # ~ 30s
2311 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002312 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002313
Gilles Peskine30de2e82020-04-20 21:39:22 +02002314 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002315 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002316
2317 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2318 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002319}
2320
Gilles Peskine8386ea22020-04-30 09:07:29 +02002321component_test_full_no_deprecated_deprecated_warning () {
2322 # Test that there is nothing deprecated in "full_no_deprecated".
2323 # A deprecated feature would trigger a warning (made fatal) from
2324 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002325 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2326 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002327 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2328 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002329 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002330
Gilles Peskine30de2e82020-04-20 21:39:22 +02002331 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002332 make test
2333}
2334
Gilles Peskine8386ea22020-04-30 09:07:29 +02002335component_test_full_deprecated_warning () {
2336 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2337 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002338 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002339 scripts/config.py full
2340 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002341 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002342 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2343 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002344 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002345
Gilles Peskine8386ea22020-04-30 09:07:29 +02002346 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2347 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2348 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002349 # Expect warnings from '#warning' directives in check_config.h and
2350 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002351 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 +01002352
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002353 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2354 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002355
2356 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2357 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002358}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002359
Gilles Peskineec541fe2020-01-31 14:24:14 +01002360# Check that the specified libraries exist and are empty.
2361are_empty_libraries () {
2362 nm "$@" >/dev/null 2>/dev/null
2363 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2364}
2365
2366component_build_crypto_default () {
2367 msg "build: make, crypto only"
2368 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002369 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002370 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002371}
2372
2373component_build_crypto_full () {
2374 msg "build: make, crypto only, full config"
2375 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002376 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002377 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002378}
2379
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002380component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002381 msg "build: make, config for PSA crypto service"
2382 scripts/config.py crypto
2383 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2384 # Disable things that are not needed for just cryptography, to
2385 # reach a configuration that would be typical for a PSA cryptography
2386 # service providing all implemented PSA algorithms.
2387 # System stuff
2388 scripts/config.py unset MBEDTLS_ERROR_C
2389 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002390 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002391 # Crypto stuff with no PSA interface
2392 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002393 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002394 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002395 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002396 scripts/config.py unset MBEDTLS_NIST_KW_C
2397 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2398 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2399 scripts/config.py unset MBEDTLS_PKCS12_C
2400 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002401 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2402 # in PSA code to work with RSA keys. We don't require users to set those:
2403 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002404 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002405 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002406 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002407 make CFLAGS='-O1 -Werror' all test
2408 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2409}
2410
Gilles Peskineec541fe2020-01-31 14:24:14 +01002411component_build_crypto_baremetal () {
2412 msg "build: make, crypto only, baremetal config"
2413 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002414 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002415 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002416}
Daniel Axtens446af202020-09-02 21:30:13 +10002417support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002418 support_build_baremetal "$@"
2419}
2420
2421component_build_baremetal () {
2422 msg "build: make, baremetal config"
2423 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002424 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002425}
2426support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002427 # Older Glibc versions include time.h from other headers such as stdlib.h,
2428 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2429 # problem, Ubuntu 18.04 is ok.
2430 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2431}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002432
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002433# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002434component_test_depends_py_cipher_id () {
2435 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002436 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002437}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002438
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002439component_test_depends_py_cipher_chaining () {
2440 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002441 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002442}
2443
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002444component_test_depends_py_cipher_padding () {
2445 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002446 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002447}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002448
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002449component_test_depends_py_curves () {
2450 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002451 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002452}
2453
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002454component_test_depends_py_hashes () {
2455 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002456 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002457}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002458
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002459component_test_depends_py_kex () {
2460 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002461 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002462}
2463
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002464component_test_depends_py_pkalgs () {
2465 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002466 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002467}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002468
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002469# PSA equivalents of the depends.py tests
2470component_test_depends_py_cipher_id_psa () {
2471 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002472 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002473}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002474
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002475component_test_depends_py_cipher_chaining_psa () {
2476 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002477 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002478}
2479
2480component_test_depends_py_cipher_padding_psa () {
2481 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002482 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002483}
2484
2485component_test_depends_py_curves_psa () {
2486 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002487 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002488}
2489
2490component_test_depends_py_hashes_psa () {
2491 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002492 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002493}
2494
2495component_test_depends_py_kex_psa () {
2496 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002497 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002498}
2499
2500component_test_depends_py_pkalgs_psa () {
2501 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002502 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002503}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002504
Valerio Setti6bed64e2024-01-17 15:21:44 +01002505component_test_psa_crypto_config_ffdh_2048_only () {
2506 msg "build: full config - only DH 2048"
2507
2508 scripts/config.py full
2509
2510 # Disable all DH groups other than 2048.
2511 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2512 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2513 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2514 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2515
2516 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2517
2518 msg "test: full config - only DH 2048"
2519 make test
2520
2521 msg "ssl-opt: full config - only DH 2048"
2522 tests/ssl-opt.sh -f "ffdh"
2523}
2524
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002525component_build_no_pk_rsa_alt_support () {
2526 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2527
2528 scripts/config.py full
2529 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2530 scripts/config.py set MBEDTLS_RSA_C
2531 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2532
2533 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002534 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002535}
2536
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002537component_build_module_alt () {
2538 msg "build: MBEDTLS_XXX_ALT" # ~30s
2539 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002540
2541 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002542 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2543 scripts/config.py unset MBEDTLS_AESNI_C
2544 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002545 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002546 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2547 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002548 # You can only have one threading implementation: alt or pthread, not both.
2549 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002550 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2551 # directly and assumes the implementation works with partial groups.
2552 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002553 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2554 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2555 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002556 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2557 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2558 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002559
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002560 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2561 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2562 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002563 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002564
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002565 # We can only compile, not link, since we don't have any implementations
2566 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002567 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002568}
2569
2570component_build_dhm_alt () {
2571 msg "build: MBEDTLS_DHM_ALT" # ~30s
2572 scripts/config.py full
2573 scripts/config.py set MBEDTLS_DHM_ALT
2574 # debug.c currently references mbedtls_dhm_context fields directly.
2575 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002576 # We can only compile, not link, since we don't have any implementations
2577 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002578 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002579}
2580
Gilles Peskine64996c32024-01-23 20:25:47 +01002581component_test_no_psa_crypto_full_cmake_asan() {
2582 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2583 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002584 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002585 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002586 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002587 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002588 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002589 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002590 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002591 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002592 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002593 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002594 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002595 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002596
Gilles Peskine64996c32024-01-23 20:25:47 +01002597 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002598 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002599
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002600 # Note: ssl-opt.sh has some test cases that depend on
2601 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2602 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002603 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002604 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002605
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002606 msg "test: compat.sh default (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002607 tests/compat.sh
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002608
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002609 msg "test: compat.sh NULL (full minus PSA crypto)"
Gilles Peskinee29203b2023-08-27 21:43:00 +02002610 tests/compat.sh -f 'NULL'
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002611
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002612 msg "test: compat.sh ARIA + ChachaPoly (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002613 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002614}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002615
Ronald Cron403c15c2021-09-13 09:38:05 +02002616component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002617 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002618
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002619 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002620 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002621 $(helper_get_psa_key_type_list "ECC") \
2622 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002623
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002624 # Configure
2625 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002626
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002627 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002628 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002629
2630 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002631 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002632
2633 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002634 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2635 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2636
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002637 # Build
2638 # -----
2639
2640 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002641 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2642 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002643
2644 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2645
Valerio Setti3fe105b2023-10-30 11:08:12 +01002646 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002647
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002648 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002649 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002650
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002651 # Run the tests
2652 # -------------
2653
Ronald Cron403c15c2021-09-13 09:38:05 +02002654 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2655 make test
2656}
2657
Valerio Setti44b178c2023-03-22 14:02:57 +01002658component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002659 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002660
2661 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002662 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002663 $(helper_get_psa_key_type_list "ECC") \
2664 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002665
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002666 # Configure
2667 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002668
Ronald Cron46ac0652024-03-18 12:39:04 +01002669 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002670 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002671
Valerio Setti44b178c2023-03-22 14:02:57 +01002672 # Disable the module that's accelerated
2673 scripts/config.py unset MBEDTLS_ECDH_C
2674
2675 # Disable things that depend on it
2676 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2677 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2678 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2679 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2680 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2681
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002682 # Build
2683 # -----
2684
2685 helper_libtestdriver1_make_drivers "$loc_accel_list"
2686
Valerio Setti3fe105b2023-10-30 11:08:12 +01002687 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002688
Valerio Setti44b178c2023-03-22 14:02:57 +01002689 # Make sure this was not re-enabled by accident (additive config)
2690 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002691
2692 # Run the tests
2693 # -------------
2694
Valerio Setti44b178c2023-03-22 14:02:57 +01002695 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002696 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002697}
2698
Przemek Stekieldccb2022023-05-11 10:48:50 +02002699component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002700 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002701
2702 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002703 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002704 $(helper_get_psa_key_type_list "DH") \
2705 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002706
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002707 # Configure
2708 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002709
Przemek Stekiel565353e2023-07-05 11:07:07 +02002710 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002711 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002712
2713 # Disable the module that's accelerated
2714 scripts/config.py unset MBEDTLS_DHM_C
2715
2716 # Disable things that depend on it
2717 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2718 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2719
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002720 # Build
2721 # -----
2722
2723 helper_libtestdriver1_make_drivers "$loc_accel_list"
2724
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002725 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002726
2727 # Make sure this was not re-enabled by accident (additive config)
2728 not grep mbedtls_dhm_ library/dhm.o
2729
2730 # Run the tests
2731 # -------------
2732
Gilles Peskine14302ed2023-07-19 19:30:04 +02002733 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002734 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002735
Gilles Peskine14302ed2023-07-19 19:30:04 +02002736 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002737 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002738}
2739
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002740component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002741 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002742
2743 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002744 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002745
2746 # Disable things that are not supported
2747 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2748 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002749 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002750
Gilles Peskine14302ed2023-07-19 19:30:04 +02002751 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002752 make test
2753
Gilles Peskine14302ed2023-07-19 19:30:04 +02002754 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002755 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002756}
2757
Valerio Setti44b178c2023-03-22 14:02:57 +01002758component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002759 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002760
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002761 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002762 $(helper_get_psa_key_type_list "ECC") \
2763 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002764
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002765 # Configure
2766 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002767
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002768 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002769
2770 # Make built-in fallback not available
2771 scripts/config.py unset MBEDTLS_ECJPAKE_C
2772 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2773
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002774 # Build
2775 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002776
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002777 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002778
Valerio Setti3fe105b2023-10-30 11:08:12 +01002779 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002780
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002781 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002782 not grep mbedtls_ecjpake_init library/ecjpake.o
2783
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002784 # Run the tests
2785 # -------------
2786
Gilles Peskine14302ed2023-07-19 19:30:04 +02002787 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002788 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002789}
2790
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002791component_test_psa_crypto_config_accel_ecc_some_key_types () {
2792 msg "build: full with accelerated EC algs and some key types"
2793
2794 # Algorithms and key types to accelerate
2795 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2796 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2797 ALG_ECDH \
2798 ALG_JPAKE \
2799 KEY_TYPE_ECC_PUBLIC_KEY \
2800 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2801 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002802 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2803 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002804
2805 # Configure
2806 # ---------
2807
2808 # start with config full for maximum coverage (also enables USE_PSA)
2809 helper_libtestdriver1_adjust_config "full"
2810
2811 # Disable modules that are accelerated - some will be re-enabled
2812 scripts/config.py unset MBEDTLS_ECDSA_C
2813 scripts/config.py unset MBEDTLS_ECDH_C
2814 scripts/config.py unset MBEDTLS_ECJPAKE_C
2815 scripts/config.py unset MBEDTLS_ECP_C
2816
2817 # Disable all curves - those that aren't accelerated should be re-enabled
2818 helper_disable_builtin_curves
2819
2820 # Restartable feature is not yet supported by PSA. Once it will in
2821 # the future, the following line could be removed (see issues
2822 # 6061, 6332 and following ones)
2823 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2824
2825 # this is not supported by the driver API yet
2826 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2827
2828 # Build
2829 # -----
2830
2831 # These hashes are needed for some ECDSA signature tests.
2832 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2833 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2834 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2835
Valerio Setti3fe105b2023-10-30 11:08:12 +01002836 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002837
2838 # ECP should be re-enabled but not the others
2839 not grep mbedtls_ecdh_ library/ecdh.o
2840 not grep mbedtls_ecdsa library/ecdsa.o
2841 not grep mbedtls_ecjpake library/ecjpake.o
2842 grep mbedtls_ecp library/ecp.o
2843
2844 # Run the tests
2845 # -------------
2846
2847 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002848 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002849}
2850
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002851# Run tests with only (non-)Weierstrass accelerated
2852# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002853# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2854# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002855common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002856 weierstrass=$1
2857 if [ $weierstrass -eq 1 ]; then
2858 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002859 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002860 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002861 fi
2862
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002863 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002864
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002865 # Note: Curves are handled in a special way by the libtestdriver machinery,
2866 # so we only want to include them in the accel list when building the main
2867 # libraries, hence the use of a separate variable.
2868 # Note: the following loop is a modified version of
2869 # helper_get_psa_curve_list that only keeps Weierstrass families.
2870 loc_weierstrass_list=""
2871 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002872 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2873 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002874 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002875 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002876 ;;
2877 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002878 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002879 ;;
2880 esac
2881 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002882 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002883 loc_curve_list=$loc_weierstrass_list
2884 else
2885 loc_curve_list=$loc_non_weierstrass_list
2886 fi
2887
Valerio Setti3fe105b2023-10-30 11:08:12 +01002888 # Algorithms and key types to accelerate
2889 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2890 ALG_ECDH \
2891 ALG_JPAKE \
2892 $(helper_get_psa_key_type_list "ECC") \
2893 $loc_curve_list"
2894
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002895 # Configure
2896 # ---------
2897
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002898 # Start with config crypto_full and remove PK_C:
2899 # that's what's supported now, see docs/driver-only-builds.md.
2900 helper_libtestdriver1_adjust_config "crypto_full"
2901 scripts/config.py unset MBEDTLS_PK_C
2902 scripts/config.py unset MBEDTLS_PK_PARSE_C
2903 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002904
2905 # Disable modules that are accelerated - some will be re-enabled
2906 scripts/config.py unset MBEDTLS_ECDSA_C
2907 scripts/config.py unset MBEDTLS_ECDH_C
2908 scripts/config.py unset MBEDTLS_ECJPAKE_C
2909 scripts/config.py unset MBEDTLS_ECP_C
2910
2911 # Disable all curves - those that aren't accelerated should be re-enabled
2912 helper_disable_builtin_curves
2913
2914 # Restartable feature is not yet supported by PSA. Once it will in
2915 # the future, the following line could be removed (see issues
2916 # 6061, 6332 and following ones)
2917 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2918
2919 # this is not supported by the driver API yet
2920 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2921
2922 # Build
2923 # -----
2924
2925 # These hashes are needed for some ECDSA signature tests.
2926 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2927 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2928 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2929
Valerio Settiac7a8092023-10-31 12:23:44 +01002930 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002931
2932 # We expect ECDH to be re-enabled for the missing curves
2933 grep mbedtls_ecdh_ library/ecdh.o
2934 # We expect ECP to be re-enabled, however the parts specific to the
2935 # families of curves that are accelerated should be ommited.
2936 # - functions with mxz in the name are specific to Montgomery curves
2937 # - ecp_muladd is specific to Weierstrass curves
2938 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002939 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002940 not grep mbedtls_ecp_muladd library/ecp.o
2941 grep mxz library/ecp.o
2942 else
2943 grep mbedtls_ecp_muladd library/ecp.o
2944 not grep mxz library/ecp.o
2945 fi
2946 # We expect ECDSA and ECJPAKE to be re-enabled only when
2947 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002948 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002949 not grep mbedtls_ecdsa library/ecdsa.o
2950 not grep mbedtls_ecjpake library/ecjpake.o
2951 else
2952 grep mbedtls_ecdsa library/ecdsa.o
2953 grep mbedtls_ecjpake library/ecjpake.o
2954 fi
2955
2956 # Run the tests
2957 # -------------
2958
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002959 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2960 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002961}
2962
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002963component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002964 common_test_psa_crypto_config_accel_ecc_some_curves 1
2965}
2966
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002967component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002968 common_test_psa_crypto_config_accel_ecc_some_curves 0
2969}
2970
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002971# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2972# ECDH, ECDSA) with and without drivers.
2973# The input parameter is a boolean value which indicates:
2974# - 0 keep built-in EC algs,
2975# - 1 exclude built-in EC algs (driver only).
2976#
2977# This is used by the two following components to ensure they always use the
2978# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002979# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2980# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002981# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002982config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002983 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002984 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002985 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002986 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002987 # Disable modules that are accelerated
2988 scripts/config.py unset MBEDTLS_ECDSA_C
2989 scripts/config.py unset MBEDTLS_ECDH_C
2990 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002991 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002992 fi
2993
2994 # Restartable feature is not yet supported by PSA. Once it will in
2995 # the future, the following line could be removed (see issues
2996 # 6061, 6332 and following ones)
2997 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002998}
2999
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003000# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3001component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003002 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003003
3004 # Algorithms and key types to accelerate
3005 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3006 ALG_ECDH \
3007 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003008 $(helper_get_psa_key_type_list "ECC") \
3009 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003010
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003011 # Configure
3012 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003013
3014 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003015 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003016
Valerio Setti0a342c92023-09-01 09:12:31 +02003017 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003018 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3019 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003020
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003021 # Build
3022 # -----
3023
3024 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003025 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3026 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003027 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3028
Valerio Setti3fe105b2023-10-30 11:08:12 +01003029 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003030
3031 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3032 not grep mbedtls_ecdsa_ library/ecdsa.o
3033 not grep mbedtls_ecdh_ library/ecdh.o
3034 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003035 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003036
3037 # Run the tests
3038 # -------------
3039
Gilles Peskine14302ed2023-07-19 19:30:04 +02003040 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003041 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003042
Gilles Peskine14302ed2023-07-19 19:30:04 +02003043 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003044 tests/ssl-opt.sh
3045}
3046
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003047# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3048component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003049 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003050
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003051 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003052
Gilles Peskine21570cf2023-12-22 11:49:50 +01003053 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003054
Gilles Peskine14302ed2023-07-19 19:30:04 +02003055 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003056 make test
3057
Gilles Peskine14302ed2023-07-19 19:30:04 +02003058 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003059 tests/ssl-opt.sh
3060}
3061
Valerio Settie618cb02023-04-12 14:59:16 +02003062# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003063# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3064# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003065# to ensure that both tests use the same underlying configuration when testing
3066# driver's coverage with analyze_outcomes.py.
3067#
3068# This functions accepts 1 boolean parameter as follows:
3069# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3070# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3071# - 0: include built-in implementation of EC algorithms.
3072#
3073# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3074# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003075config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003076 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003077 # start with full config for maximum coverage (also enables USE_PSA)
3078 helper_libtestdriver1_adjust_config "full"
3079
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003080 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003081 # Disable modules that are accelerated
3082 scripts/config.py unset MBEDTLS_ECDSA_C
3083 scripts/config.py unset MBEDTLS_ECDH_C
3084 scripts/config.py unset MBEDTLS_ECJPAKE_C
3085 # Disable ECP module (entirely)
3086 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003087 fi
3088
Valerio Settiaecd32c2023-06-14 10:42:31 +02003089 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3090 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003091 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003092 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003093
Valerio Settie618cb02023-04-12 14:59:16 +02003094 # Restartable feature is not yet supported by PSA. Once it will in
3095 # the future, the following line could be removed (see issues
3096 # 6061, 6332 and following ones)
3097 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003098}
3099
3100# Build and test a configuration where driver accelerates all EC algs while
3101# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3102# side.
3103#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003104# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3105component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003106 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003107
3108 # Algorithms and key types to accelerate
3109 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3110 ALG_ECDH \
3111 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003112 $(helper_get_psa_key_type_list "ECC") \
3113 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003114
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003115 # Configure
3116 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003117
Valerio Settie618cb02023-04-12 14:59:16 +02003118 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003119 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003120 # Disable all the builtin curves. All the required algs are accelerated.
3121 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003122
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003123 # Build
3124 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003125
3126 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003127 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3128 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3129 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003130
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003131 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003132
Valerio Setti3fe105b2023-10-30 11:08:12 +01003133 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003134
3135 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3136 not grep mbedtls_ecdsa_ library/ecdsa.o
3137 not grep mbedtls_ecdh_ library/ecdh.o
3138 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003139 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003140 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003141
3142 # Run the tests
3143 # -------------
3144
Gilles Peskine14302ed2023-07-19 19:30:04 +02003145 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003146 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003147
Gilles Peskine14302ed2023-07-19 19:30:04 +02003148 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003149 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003150}
3151
3152# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003153# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003154# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003155component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003156 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003157
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003158 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003159
Gilles Peskine21570cf2023-12-22 11:49:50 +01003160 make
Valerio Settie618cb02023-04-12 14:59:16 +02003161
Gilles Peskine14302ed2023-07-19 19:30:04 +02003162 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003163 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003164
Gilles Peskine14302ed2023-07-19 19:30:04 +02003165 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003166 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003167}
3168
Valerio Setti4e2f2442023-08-15 10:10:26 +02003169# This is a common configuration helper used directly from:
3170# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3171# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3172# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003173# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003174# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003175# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003176# - this is the reference component of the above
3177# - it still disables RSA and FFDH, but it uses builtin EC algs
3178# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3179# - accelerate all EC and FFDH algs, disable only RSA
3180# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3181# - this is the reference component of the above
3182# - it still disables RSA, but it uses builtin EC and FFDH algs
3183#
3184# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003185# $1: a boolean value which states if we are testing an accelerated scenario
3186# or not.
3187# $2: a string value which states which components are tested. Allowed values
3188# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003189config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003190 driver_only="$1"
3191 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003192 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003193 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003194
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003195 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003196 # Disable modules that are accelerated
3197 scripts/config.py unset MBEDTLS_ECDSA_C
3198 scripts/config.py unset MBEDTLS_ECDH_C
3199 scripts/config.py unset MBEDTLS_ECJPAKE_C
3200 # Disable ECP module (entirely)
3201 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003202 # Also disable bignum
3203 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003204 fi
3205
3206 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3207 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3208 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3209 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3210
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003211 # RSA support is intentionally disabled on this test because RSA_C depends
3212 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003213 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3214 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 +02003215 scripts/config.py unset MBEDTLS_RSA_C
3216 scripts/config.py unset MBEDTLS_PKCS1_V15
3217 scripts/config.py unset MBEDTLS_PKCS1_V21
3218 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3219 # Also disable key exchanges that depend on RSA
3220 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3221 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3222 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3223 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3224 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3225
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003226 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003227 # When testing ECC only, we disable FFDH support, both from builtin and
3228 # PSA sides, and also disable the key exchanges that depend on DHM.
3229 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3230 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 +01003231 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003232 scripts/config.py unset MBEDTLS_DHM_C
3233 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3234 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3235 else
3236 # When testing ECC and DH instead, we disable DHM and depending key
3237 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003238 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003239 scripts/config.py unset MBEDTLS_DHM_C
3240 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3241 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3242 fi
3243 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003244
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003245 # Restartable feature is not yet supported by PSA. Once it will in
3246 # the future, the following line could be removed (see issues
3247 # 6061, 6332 and following ones)
3248 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3249}
3250
Valerio Setti4e2f2442023-08-15 10:10:26 +02003251# Common helper used by:
3252# - component_test_psa_crypto_config_accel_ecc_no_bignum
3253# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003254#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003255# The goal is to build and test accelerating either:
3256# - ECC only or
3257# - both ECC and FFDH
3258#
3259# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003260# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3261# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003262common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003263 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003264
Valerio Setti5dfaca42023-09-05 08:48:51 +02003265 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003266 if [ "$test_target" = "ECC_DH" ]; then
3267 accel_text="ECC/FFDH"
3268 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003269 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003270 accel_text="ECC"
3271 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003272 fi
3273
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003274 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003275
3276 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003277 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3278 ALG_ECDH \
3279 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003280 $(helper_get_psa_key_type_list "ECC") \
3281 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003282 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003283 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003284 loc_accel_list="$loc_accel_list \
3285 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003286 $(helper_get_psa_key_type_list "DH") \
3287 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003288 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003289
3290 # Configure
3291 # ---------
3292
3293 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003294 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003295 # Disable all the builtin curves. All the required algs are accelerated.
3296 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003297
3298 # Build
3299 # -----
3300
3301 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003302 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3303 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3304 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003305
3306 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3307
Valerio Setti3fe105b2023-10-30 11:08:12 +01003308 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003309
3310 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3311 not grep mbedtls_ecdsa_ library/ecdsa.o
3312 not grep mbedtls_ecdh_ library/ecdh.o
3313 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003314 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003315 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003316 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003317 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003318 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003319
3320 # Run the tests
3321 # -------------
3322
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003323 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003324
Gilles Peskine21570cf2023-12-22 11:49:50 +01003325 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003326
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003327 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003328 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003329}
3330
Valerio Setti4e2f2442023-08-15 10:10:26 +02003331# Common helper used by:
3332# - component_test_psa_crypto_config_reference_ecc_no_bignum
3333# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3334#
3335# The goal is to build and test a reference scenario (i.e. with builtin
3336# components) compared to the ones used in
3337# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3338#
3339# It is meant to be used in conjunction with
3340# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3341# coverage analysis in "analyze_outcomes.py" script.
3342common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003343 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003344
Valerio Setti5dfaca42023-09-05 08:48:51 +02003345 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003346 if [ "$test_target" = "ECC_DH" ]; then
3347 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003348 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003349 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003350 fi
3351
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003352 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003353
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003354 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003355
Gilles Peskine21570cf2023-12-22 11:49:50 +01003356 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003357
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003358 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003359 make test
3360
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003361 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003362 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003363}
3364
Valerio Setti4e2f2442023-08-15 10:10:26 +02003365component_test_psa_crypto_config_accel_ecc_no_bignum () {
3366 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3367}
3368
3369component_test_psa_crypto_config_reference_ecc_no_bignum () {
3370 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3371}
3372
3373component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3374 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3375}
3376
3377component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3378 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3379}
3380
Valerio Settiac6d35f2023-08-04 12:49:11 +02003381# Helper for setting common configurations between:
3382# - component_test_tfm_config_p256m_driver_accel_ec()
3383# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003384common_tfm_config () {
3385 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003386 cp configs/config-tfm.h "$CONFIG_H"
3387 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3388 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003389
Yanray Wang73bb2312023-09-25 11:21:15 +08003390 # Other config adjustment to make the tests pass.
3391 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003392 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003393 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3394 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003395
Yanray Wang73bb2312023-09-25 11:21:15 +08003396 # Config adjustment for better test coverage in our environment.
3397 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003398 #
3399 # Enable filesystem I/O for the benefit of PK parse/write tests.
3400 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3401}
3402
Valerio Settiac6d35f2023-08-04 12:49:11 +02003403# Keep this in sync with component_test_tfm_config() as they are both meant
3404# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003405component_test_tfm_config_p256m_driver_accel_ec () {
3406 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3407
3408 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003409
Dave Rodgman897bb772023-11-15 16:34:20 +00003410 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003411 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003412
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003413 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3414 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003415 not grep mbedtls_ecdh_ library/ecdh.o
3416 not grep mbedtls_ecjpake_ library/ecjpake.o
3417 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3418 not grep mbedtls_ecp_ library/ecp.o
3419 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003420 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003421 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003422 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003423 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003424
Valerio Setti5e18b902023-12-04 12:07:30 +01003425 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3426 # files, so we want to ensure that it has not be re-enabled accidentally.
3427 not grep mbedtls_cipher library/cipher.o
3428
Valerio Settib7e95442023-03-21 11:52:33 +01003429 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003430 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003431 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003432}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003433
Valerio Settiac6d35f2023-08-04 12:49:11 +02003434# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3435# they are both meant to be used in analyze_outcomes.py for driver's coverage
3436# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003437component_test_tfm_config() {
3438 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003439
Dave Rodgman897bb772023-11-15 16:34:20 +00003440 # Disable P256M driver, which is on by default, so that analyze_outcomes
3441 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3442 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3443
Valerio Setti52ba0e32023-08-04 12:43:03 +02003444 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003445 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003446
Dave Rodgman897bb772023-11-15 16:34:20 +00003447 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003448 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003449
Valerio Setti5e18b902023-12-04 12:07:30 +01003450 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3451 # files, so we want to ensure that it has not be re-enabled accidentally.
3452 not grep mbedtls_cipher library/cipher.o
3453
Valerio Setti52ba0e32023-08-04 12:43:03 +02003454 msg "test: TF-M config"
3455 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003456}
3457
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003458# Common helper for component_full_without_ecdhe_ecdsa() and
3459# component_full_without_ecdhe_ecdsa_and_tls13() which:
3460# - starts from the "full" configuration minus the list of symbols passed in
3461# as 1st parameter
3462# - build
3463# - test only TLS (i.e. test_suite_tls and ssl-opt)
3464build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003465 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003466
3467 msg "build: full minus something, test TLS"
3468
3469 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003470 for sym in $symbols_to_disable; do
3471 echo "Disabling $sym"
3472 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003473 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003474
Gilles Peskine21570cf2023-12-22 11:49:50 +01003475 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003476
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003477 msg "test: full minus something, test TLS"
3478 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003479
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003480 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003481 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003482}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003483
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003484component_full_without_ecdhe_ecdsa () {
3485 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003486}
3487
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003488component_full_without_ecdhe_ecdsa_and_tls13 () {
3489 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3490 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003491}
3492
Valerio Setti249b18a2023-06-20 12:08:30 +02003493# This is an helper used by:
3494# - component_test_psa_ecc_key_pair_no_derive
3495# - component_test_psa_ecc_key_pair_no_generate
3496# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3497# enabled, but one. Input arguments are as follows:
3498# - $1 is the key type under test, i.e. ECC/RSA/DH
3499# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003500build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003501 key_type=$1
3502 unset_option=$2
3503 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003504
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003505 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003506 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003507 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3508 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3509
3510 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3511 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003512 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003513
Gilles Peskine21570cf2023-12-22 11:49:50 +01003514 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003515
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003516 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003517 make test
3518}
3519
3520component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003521 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003522}
3523
3524component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003525 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003526}
3527
Pengyu Lve705f572023-12-06 16:38:15 +08003528config_psa_crypto_accel_rsa () {
3529 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003530
Pengyu Lve705f572023-12-06 16:38:15 +08003531 # Start from crypto_full config (no X.509, no TLS)
3532 helper_libtestdriver1_adjust_config "crypto_full"
3533
3534 if [ "$driver_only" -eq 1 ]; then
3535 # Remove RSA support and its dependencies
3536 scripts/config.py unset MBEDTLS_RSA_C
3537 scripts/config.py unset MBEDTLS_PKCS1_V15
3538 scripts/config.py unset MBEDTLS_PKCS1_V21
3539
3540 # We need PEM parsing in the test library as well to support the import
3541 # of PEM encoded RSA keys.
3542 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3543 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3544 fi
3545}
3546
3547component_test_psa_crypto_config_accel_rsa_crypto () {
3548 msg "build: crypto_full with accelerated RSA"
3549
3550 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3551 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3552 KEY_TYPE_RSA_PUBLIC_KEY \
3553 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3554 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3555 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3556 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003557
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003558 # Configure
3559 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003560
Pengyu Lve705f572023-12-06 16:38:15 +08003561 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003562
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003563 # Build
3564 # -----
3565
Pengyu Lve705f572023-12-06 16:38:15 +08003566 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003567 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 +08003568 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003569 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003570
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003571 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003572
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003573 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003574 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003575
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003576 # Run the tests
3577 # -------------
3578
Pengyu Lve705f572023-12-06 16:38:15 +08003579 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003580 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003581}
3582
3583component_test_psa_crypto_config_reference_rsa_crypto () {
3584 msg "build: crypto_full with non-accelerated RSA"
3585
3586 # Configure
3587 # ---------
3588 config_psa_crypto_accel_rsa 0
3589
3590 # Build
3591 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003592 make
Pengyu Lve705f572023-12-06 16:38:15 +08003593
3594 # Run the tests
3595 # -------------
3596 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003597 make test
3598}
3599
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003600# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003601# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003602component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003603 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003604
Valerio Setti4590bc22023-06-13 15:39:23 +02003605 # Create a temporary output file unless there is already one set
3606 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3607 REMOVE_OUTCOME_ON_EXIT="no"
3608 else
3609 REMOVE_OUTCOME_ON_EXIT="yes"
3610 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3611 export MBEDTLS_TEST_OUTCOME_FILE
3612 fi
3613
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003614 # Start from crypto configuration
3615 scripts/config.py crypto
3616
3617 # Remove RSA support and its dependencies
3618 scripts/config.py unset MBEDTLS_PKCS1_V15
3619 scripts/config.py unset MBEDTLS_PKCS1_V21
3620 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3621 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3622 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3623 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3624 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3625 scripts/config.py unset MBEDTLS_RSA_C
3626 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3627
3628 # Enable PSA support
3629 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3630
Valerio Setti01cc88a2023-06-15 11:53:08 +02003631 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003632 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003633 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3634 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3635 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003636
3637 make
3638
Valerio Setti01cc88a2023-06-15 11:53:08 +02003639 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003640 make test
3641
3642 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3643 # performing RSA signature.
3644 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3645 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3646
3647 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3648 rm $MBEDTLS_TEST_OUTCOME_FILE
3649 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003650}
3651
Ronald Cronb2312452021-05-08 14:32:59 +02003652component_test_psa_crypto_config_accel_hash () {
3653 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3654
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003655 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3656 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3657 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003658
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003659 # Configure
3660 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003661
Ronald Cron46ac0652024-03-18 12:39:04 +01003662 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003663 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003664
3665 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003666 scripts/config.py unset MBEDTLS_MD5_C
3667 scripts/config.py unset MBEDTLS_RIPEMD160_C
3668 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003669 scripts/config.py unset MBEDTLS_SHA224_C
3670 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003671 scripts/config.py unset MBEDTLS_SHA384_C
3672 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003673 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003674
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003675 # Build
3676 # -----
3677
3678 helper_libtestdriver1_make_drivers "$loc_accel_list"
3679
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003680 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003681
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003682 # There's a risk of something getting re-enabled via config_psa.h;
3683 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3684 not grep mbedtls_md5 library/md5.o
3685 not grep mbedtls_sha1 library/sha1.o
3686 not grep mbedtls_sha256 library/sha256.o
3687 not grep mbedtls_sha512 library/sha512.o
3688 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003689
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003690 # Run the tests
3691 # -------------
3692
Ronald Cronb2312452021-05-08 14:32:59 +02003693 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3694 make test
3695}
3696
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003697component_test_psa_crypto_config_accel_hash_keep_builtins () {
3698 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3699 # This component ensures that all the test cases for
3700 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3701
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003702 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3703 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3704 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003705
Ronald Cron46ac0652024-03-18 12:39:04 +01003706 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003707 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003708
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003709 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003710
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003711 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003712
3713 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3714 make test
3715}
3716
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003717# Auxiliary function to build config for hashes with and without drivers
3718config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003719 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003720 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003721 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003722 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003723 # disable the built-in implementation of hashes
3724 scripts/config.py unset MBEDTLS_MD5_C
3725 scripts/config.py unset MBEDTLS_RIPEMD160_C
3726 scripts/config.py unset MBEDTLS_SHA1_C
3727 scripts/config.py unset MBEDTLS_SHA224_C
3728 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003729 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003730 scripts/config.py unset MBEDTLS_SHA384_C
3731 scripts/config.py unset MBEDTLS_SHA512_C
3732 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003733 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003734 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003735}
3736
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003737# Note that component_test_psa_crypto_config_reference_hash_use_psa
3738# is related to this component and both components need to be kept in sync.
3739# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003740component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003741 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003742
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003743 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3744 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3745 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003746
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003747 # Configure
3748 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003749
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003750 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003751
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003752 # Build
3753 # -----
3754
3755 helper_libtestdriver1_make_drivers "$loc_accel_list"
3756
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003757 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003758
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003759 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003760 # 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 +02003761 not grep mbedtls_md5 library/md5.o
3762 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003763 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003764 not grep mbedtls_sha512 library/sha512.o
3765 not grep mbedtls_ripemd160 library/ripemd160.o
3766
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003767 # Run the tests
3768 # -------------
3769
Gilles Peskine14302ed2023-07-19 19:30:04 +02003770 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003771 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003772
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003773 # This is mostly useful so that we can later compare outcome files with
3774 # the reference config in analyze_outcomes.py, to check that the
3775 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003776 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003777 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003778
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003779 # This is to make sure all ciphersuites are exercised, but we don't need
3780 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003781 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003782 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003783}
3784
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003785# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3786# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3787# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3788# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003789component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003790 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003791
3792 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003793
Gilles Peskine21570cf2023-12-22 11:49:50 +01003794 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003795
Gilles Peskine14302ed2023-07-19 19:30:04 +02003796 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003797 make test
3798
Gilles Peskine14302ed2023-07-19 19:30:04 +02003799 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003800 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003801}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003802
Valerio Setti8eb310c2024-01-22 16:22:57 +01003803# Auxiliary function to build config for hashes with and without drivers
3804config_psa_crypto_hmac_use_psa () {
3805 driver_only="$1"
3806 # start with config full for maximum coverage (also enables USE_PSA)
3807 helper_libtestdriver1_adjust_config "full"
3808
Valerio Setticd89b0b2024-01-24 14:24:55 +01003809 if [ "$driver_only" -eq 1 ]; then
3810 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3811 # is still enabled though (for ENTROPY_C among others).
3812 scripts/config.py unset MBEDTLS_MD_C
3813 # Disable also the builtin hashes since they are supported by the driver
3814 # and MD module is able to perform PSA dispathing.
3815 scripts/config.py unset-all MBEDTLS_SHA
3816 scripts/config.py unset MBEDTLS_MD5_C
3817 scripts/config.py unset MBEDTLS_RIPEMD160_C
3818 fi
3819
Valerio Setti8eb310c2024-01-22 16:22:57 +01003820 # Direct dependencies of MD_C. We disable them also in the reference
3821 # component to work with the same set of features.
3822 scripts/config.py unset MBEDTLS_PKCS7_C
3823 scripts/config.py unset MBEDTLS_PKCS5_C
3824 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3825 scripts/config.py unset MBEDTLS_HKDF_C
3826 # Dependencies of HMAC_DRBG
3827 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3828 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3829}
3830
3831component_test_psa_crypto_config_accel_hmac() {
3832 msg "test: full with accelerated hmac"
3833
3834 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3835 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3836 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3837 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3838
3839 # Configure
3840 # ---------
3841
3842 config_psa_crypto_hmac_use_psa 1
3843
Valerio Setti8eb310c2024-01-22 16:22:57 +01003844 # Build
3845 # -----
3846
3847 helper_libtestdriver1_make_drivers "$loc_accel_list"
3848
3849 helper_libtestdriver1_make_main "$loc_accel_list"
3850
3851 # Ensure that built-in support for HMAC is disabled.
3852 not grep mbedtls_md_hmac library/md.o
3853
3854 # Run the tests
3855 # -------------
3856
3857 msg "test: full with accelerated hmac"
3858 make test
3859}
3860
3861component_test_psa_crypto_config_reference_hmac() {
3862 msg "test: full without accelerated hmac"
3863
3864 config_psa_crypto_hmac_use_psa 0
3865
3866 make
3867
3868 msg "test: full without accelerated hmac"
3869 make test
3870}
3871
Valerio Setti9da01a72023-12-18 17:38:18 +01003872component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003873 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003874
Valerio Setti9da01a72023-12-18 17:38:18 +01003875 # Albeit this components aims at accelerating DES which should only support
3876 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3877 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003878 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3879 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3880 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003881
Valerio Setti9da01a72023-12-18 17:38:18 +01003882 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3883 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3884 # of this component. This limitation will be addressed by #8598.
3885
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003886 # Configure
3887 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003888
Valerio Setti9a427302023-10-17 11:40:42 +02003889 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003890 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003891
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003892 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003893 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3894 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3895 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3896 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3897 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3898 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3899 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003900 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003901
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003902 # Build
3903 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003904
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003905 helper_libtestdriver1_make_drivers "$loc_accel_list"
3906
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003907 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003908
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003909 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003910 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003911
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003912 # Run the tests
3913 # -------------
3914
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003915 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003916 make test
3917}
3918
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003919component_test_psa_crypto_config_accel_aead () {
3920 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3921
Valerio Setti3f02bb72023-10-02 15:57:33 +02003922 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3923 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003924
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003925 # Configure
3926 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003927
Valerio Setti3f02bb72023-10-02 15:57:33 +02003928 # Start from full config
3929 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003930
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003931 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003932 scripts/config.py unset MBEDTLS_GCM_C
3933 scripts/config.py unset MBEDTLS_CCM_C
3934 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003935
Valerio Settia50b89e2023-11-08 15:58:47 +01003936 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3937 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003938
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003939 # Build
3940 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003941
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003942 helper_libtestdriver1_make_drivers "$loc_accel_list"
3943
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003944 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003945
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003946 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003947 not grep mbedtls_ccm library/ccm.o
3948 not grep mbedtls_gcm library/gcm.o
3949 not grep mbedtls_chachapoly library/chachapoly.o
3950
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003951 # Run the tests
3952 # -------------
3953
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003954 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3955 make test
3956}
3957
Valerio Settib680fc42023-10-13 09:29:37 +02003958# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003959# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3960# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3961common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003962 # Start from the full config
3963 helper_libtestdriver1_adjust_config "full"
3964
Valerio Settib680fc42023-10-13 09:29:37 +02003965 scripts/config.py unset MBEDTLS_NIST_KW_C
3966}
3967
Valerio Settib6b301f2023-10-04 12:05:05 +02003968# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003969# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3970# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003971# are meant to be used together in analyze_outcomes.py script in order to test
3972# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003973component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3974 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003975
Valerio Settiad8b7f02023-10-25 12:39:50 +02003976 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 +01003977 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003978 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003979 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3980
3981 # Configure
3982 # ---------
3983
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003984 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003985
3986 # Disable the things that are being accelerated
3987 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3988 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3989 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3990 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3991 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3992 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3993 scripts/config.py unset MBEDTLS_GCM_C
3994 scripts/config.py unset MBEDTLS_CCM_C
3995 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003996 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003997 scripts/config.py unset MBEDTLS_DES_C
3998 scripts/config.py unset MBEDTLS_AES_C
3999 scripts/config.py unset MBEDTLS_ARIA_C
4000 scripts/config.py unset MBEDTLS_CHACHA20_C
4001 scripts/config.py unset MBEDTLS_CAMELLIA_C
4002
Valerio Settiec9b2582023-11-08 16:50:54 +01004003 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
4004 # does not depend on it.
4005 scripts/config.py unset MBEDTLS_CIPHER_C
4006
Valerio Settib6b301f2023-10-04 12:05:05 +02004007 # Build
4008 # -----
4009
4010 helper_libtestdriver1_make_drivers "$loc_accel_list"
4011
4012 helper_libtestdriver1_make_main "$loc_accel_list"
4013
4014 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01004015 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02004016 not grep mbedtls_des library/des.o
4017 not grep mbedtls_aes library/aes.o
4018 not grep mbedtls_aria library/aria.o
4019 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004020 not grep mbedtls_ccm library/ccm.o
4021 not grep mbedtls_gcm library/gcm.o
4022 not grep mbedtls_chachapoly library/chachapoly.o
4023 not grep mbedtls_cmac library/cmac.o
4024
4025 # Run the tests
4026 # -------------
4027
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004028 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004029 make test
Valerio Settif9414552023-11-09 10:43:20 +01004030
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004031 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004032 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004033
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004034 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004035 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004036}
4037
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004038component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4039 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4040 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004041
Gilles Peskine21570cf2023-12-22 11:49:50 +01004042 make
Valerio Settif9414552023-11-09 10:43:20 +01004043
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004044 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004045 make test
Valerio Settif9414552023-11-09 10:43:20 +01004046
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004047 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004048 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004049
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004050 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004051 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004052}
4053
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004054common_block_cipher_dispatch() {
4055 TEST_WITH_DRIVER="$1"
4056
4057 # Start from the full config
4058 helper_libtestdriver1_adjust_config "full"
4059
4060 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4061 # Disable key types that are accelerated (there is no legacy equivalent
4062 # symbol for ECB)
4063 scripts/config.py unset MBEDTLS_AES_C
4064 scripts/config.py unset MBEDTLS_ARIA_C
4065 scripts/config.py unset MBEDTLS_CAMELLIA_C
4066 fi
4067
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004068 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004069 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004070 # Keep this also in the reference component in order to skip the same tests
4071 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004072 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4073 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4074 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4075 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4076 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4077 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4078 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004079
4080 # Disable direct dependency on AES_C
4081 scripts/config.py unset MBEDTLS_NIST_KW_C
4082
4083 # Prevent the cipher module from using deprecated PSA path. The reason is
4084 # that otherwise there will be tests relying on "aes_info" (defined in
4085 # "cipher_wrap.c") whose functions are not available when AES_C is
4086 # not defined. ARIA and Camellia are not a problem in this case because
4087 # the PSA path is not tested for these key types.
4088 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4089}
4090
Valerio Settif8e6cba2023-12-12 11:53:39 +01004091component_test_full_block_cipher_psa_dispatch () {
4092 msg "build: full + PSA dispatch in block_cipher"
4093
4094 loc_accel_list="ALG_ECB_NO_PADDING \
4095 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4096
4097 # Configure
4098 # ---------
4099
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004100 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004101
Valerio Settif8e6cba2023-12-12 11:53:39 +01004102 # Build
4103 # -----
4104
4105 helper_libtestdriver1_make_drivers "$loc_accel_list"
4106
4107 helper_libtestdriver1_make_main "$loc_accel_list"
4108
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004109 # Make sure disabled components were not re-enabled by accident (additive
4110 # config)
4111 not grep mbedtls_aes_ library/aes.o
4112 not grep mbedtls_aria_ library/aria.o
4113 not grep mbedtls_camellia_ library/camellia.o
4114
Valerio Settif8e6cba2023-12-12 11:53:39 +01004115 # Run the tests
4116 # -------------
4117
4118 msg "test: full + PSA dispatch in block_cipher"
4119 make test
4120}
4121
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004122# This is the reference component of component_test_full_block_cipher_psa_dispatch
4123component_test_full_block_cipher_legacy_dispatch () {
4124 msg "build: full + legacy dispatch in block_cipher"
4125
4126 common_block_cipher_dispatch 0
4127
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004128 make
4129
4130 msg "test: full + legacy dispatch in block_cipher"
4131 make test
4132}
4133
Gilles Peskine36dea152023-07-20 22:19:45 +02004134component_test_aead_chachapoly_disabled() {
4135 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004136 scripts/config.py full
4137 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004138 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004139 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004140
Gilles Peskine36dea152023-07-20 22:19:45 +02004141 msg "test: full minus CHACHAPOLY"
4142 make test
4143}
4144
4145component_test_aead_only_ccm() {
4146 msg "build: full minus CHACHAPOLY and GCM"
4147 scripts/config.py full
4148 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4149 scripts/config.py unset MBEDTLS_GCM_C
4150 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4151 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004152 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004153
4154 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004155 make test
4156}
4157
Ronald Crone501d0e2023-07-10 08:31:19 +02004158component_test_ccm_aes_sha256() {
4159 msg "build: CCM + AES + SHA256 configuration"
4160
Ronald Cron7612d8c2023-07-20 10:03:54 +02004161 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004162 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004163
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004164 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004165
4166 msg "test: CCM + AES + SHA256 configuration"
4167 make test
4168}
4169
John Durkopd0321952020-10-29 21:37:36 -07004170# This should be renamed to test and updated once the accelerator ECDH code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004171component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004172 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07004173 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004174 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004175 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004176 scripts/config.py unset MBEDTLS_ECDH_C
4177 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
4178 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
4179 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
4180 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
4181 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
4182 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004183 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_ECDH -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004184}
4185
4186# This should be renamed to test and updated once the accelerator HMAC code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004187component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004188 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkopd0321952020-10-29 21:37:36 -07004189 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004190 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004191 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004192 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004193 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HMAC -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004194}
4195
4196# This should be renamed to test and updated once the accelerator HKDF code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004197component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004198 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkopd0321952020-10-29 21:37:36 -07004199 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004200 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
4201 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01004202 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
4203 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004204 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004205 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HKDF -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004206}
4207
John Durkop1b7ee052020-11-27 08:51:22 -08004208# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
4209component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004210 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004211 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004212 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004213 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004214 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4215 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4216 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4217 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4218 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4219 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4220 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004221 scripts/config.py unset MBEDTLS_LMS_C
4222 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004223 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004224 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_MD5 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004225}
4226
4227# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
4228component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004229 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004230 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004231 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004232 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004233 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4234 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4235 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4236 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4237 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4238 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4239 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004240 scripts/config.py unset MBEDTLS_LMS_C
4241 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004242 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004243 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RIPEMD160 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004244}
4245
4246# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
4247component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004248 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004249 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004250 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004251 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004252 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4253 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4254 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4255 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4256 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4257 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4258 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004259 scripts/config.py unset MBEDTLS_LMS_C
4260 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004261 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004262 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_1 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004263}
4264
4265# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
4266component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004267 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004268 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004269 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004270 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004271 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4272 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4273 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4274 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4275 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4276 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08004277 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004278 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_224 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004279}
4280
4281# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
4282component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004283 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004284 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004285 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004286 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004287 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4288 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4289 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4290 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4291 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4292 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08004293 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004294 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_256 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004295}
4296
4297# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
4298component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004299 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004300 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004301 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004302 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004303 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4304 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4305 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4306 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4307 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4308 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004309 scripts/config.py unset MBEDTLS_LMS_C
4310 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004311 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004312 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_384 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004313}
4314
4315# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
4316component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004317 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004318 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004319 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004320 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004321 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4322 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4323 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4324 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4325 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4326 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4327 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004328 scripts/config.py unset MBEDTLS_LMS_C
4329 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004330 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004331 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_512 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004332}
4333
John Durkopd0321952020-10-29 21:37:36 -07004334# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004335component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004336 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_CRYPT + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopd0321952020-10-29 21:37:36 -07004337 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004338 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004339 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004340 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
4341 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4342 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4343 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07004344 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004345 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_CRYPT -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004346}
4347
4348# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004349component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004350 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_SIGN + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004351 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004352 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004353 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004354 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
4355 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4356 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4357 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004358 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004359 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_SIGN -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004360}
4361
4362# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004363component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004364 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_OAEP + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004365 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004366 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004367 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004368 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
4369 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4370 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4371 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004372 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004373 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_OAEP -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004374}
4375
4376# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004377component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004378 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PSS + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004379 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004380 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004381 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004382 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4383 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4384 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4385 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07004386 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004387 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PSS -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004388}
4389
4390# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004391component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004392 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_xxx + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004393 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004394 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004395 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004396 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4397 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
4398 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
4399 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
4400 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07004401 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004402 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_KEY_PAIR -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004403}
4404
4405# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004406component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004407 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004408 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004409 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004410 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004411 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4412 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07004413 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004414 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_PUBLIC_KEY -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004415}
4416
Dave Rodgmanc164c072023-06-28 09:43:23 +01004417
Dave Rodgman904c5892023-06-28 17:36:02 +01004418support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004419 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004420}
4421
Dave Rodgman904c5892023-06-28 17:36:02 +01004422component_build_tfm_armcc() {
4423 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004424 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004425
Dave Rodgman88651c42023-06-29 12:35:51 +01004426 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004427 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 +01004428}
4429
4430component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004431 # Check that the TF-M configuration can build cleanly with various
4432 # warning flags enabled. We don't build or run tests, since the
4433 # TF-M configuration needs a TF-M platform. A tweaked version of
4434 # the configuration that works on mainstream platforms is in
4435 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004436 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004437
Dave Rodgman88651c42023-06-29 12:35:51 +01004438 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004439 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 +01004440
Dave Rodgman904c5892023-06-28 17:36:02 +01004441 msg "build: TF-M config, gcc native build"
4442 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004443 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 +01004444}
4445
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004446# Test that the given .o file builds with all (valid) combinations of the given options.
4447#
4448# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4449#
4450# The validator function is the name of a function to validate the combination of options.
4451# It may be "" if all combinations are valid.
4452# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004453# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004454build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004455 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004456 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004457 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004458 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004459 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004460
Dave Rodgman42436102023-10-03 15:47:05 +01004461 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004462 for opt in "${options[@]}"; do
4463 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004464 done
4465
4466 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004467 cd $(dirname ${file})
4468 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004469
Dave Rodgman920343a2023-10-01 18:41:09 +01004470 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004471 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 +01004472
Dave Rodgman42436102023-10-03 15:47:05 +01004473 # Extract the command generated by the Makefile to build the target file.
4474 # This ensures that we have any include paths, macro definitions, etc
4475 # that may be applied by make.
4476 # 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 +01004477 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004478
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004479 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004480 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004481
Dave Rodgman28e38d82023-10-04 11:50:30 +01004482 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004483 source_file=${file%.o}.c
4484
4485 targets=0
4486 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004487
Dave Rodgman28e38d82023-10-04 11:50:30 +01004488 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004489 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004490 # each bit of $i is used to determine if options[i] will be set or not
4491 target="t"
4492 clang_args=""
4493 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004494 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004495 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004496 clang_args="${clang_args} ${opt}"
4497 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004498 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004499 done
4500
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004501 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004502 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004503 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004504 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004505
Dave Rodgman28e38d82023-10-04 11:50:30 +01004506 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004507 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004508 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004509 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004510
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004511 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004512
Dave Rodgman920343a2023-10-01 18:41:09 +01004513 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004514 make -s -f ${makefile} build_test_config_combos
4515 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004516
4517 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004518 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004519}
4520
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004521validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004522 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4523 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004524 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004525 fi
4526 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4527 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004528 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004529 fi
4530 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004531 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004532}
4533
4534component_build_aes_variations() {
4535 # 18s - around 90ms per clang invocation on M1 Pro
4536 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004537 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004538 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004539
Yanray Wangbc29aef2023-11-06 11:08:17 +08004540 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004541 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004542
Dave Rodgman42436102023-10-03 15:47:05 +01004543 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004544 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4545 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4546 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4547 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004548
4549 cd "$MBEDTLS_ROOT_DIR"
4550 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4551
Yanray Wang42be1ba2023-11-23 14:28:47 +08004552 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004553 # manually set or unset those configurations to check
4554 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004555 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4556 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4557 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4558 scripts/config.py unset MBEDTLS_DES_C
4559 scripts/config.py unset MBEDTLS_NIST_KW_C
4560 build_test_config_combos library/aes.o validate_aes_config_variations \
4561 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4562 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4563 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4564 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004565}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004566
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004567component_test_no_platform () {
4568 # Full configuration build, without platform support, file IO and net sockets.
4569 # This should catch missing mbedtls_printf definitions, and by disabling file
4570 # IO, it should catch missing '#include <stdio.h>'
4571 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004572 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004573 scripts/config.py unset MBEDTLS_PLATFORM_C
4574 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004575 scripts/config.py unset MBEDTLS_FS_IO
4576 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004577 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004578 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004579 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004580 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004581 # to re-enable platform integration features otherwise disabled in C99 builds
4582 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004583 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004584}
Gilles Peskine7c652162017-12-11 00:01:40 +01004585
4586component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004587 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004588 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4589 scripts/config.py full
4590 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004591 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4592 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4593 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4594 make
4595}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004596
Gilles Peskine8f073122018-11-27 15:58:47 +01004597component_build_no_ssl_srv () {
4598 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004599 scripts/config.py full
4600 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004601 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004602}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004603
Gilles Peskine8f073122018-11-27 15:58:47 +01004604component_build_no_ssl_cli () {
4605 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004606 scripts/config.py full
4607 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004608 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004609}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004610
Gilles Peskine8f073122018-11-27 15:58:47 +01004611component_build_no_sockets () {
4612 # Note, C99 compliance can also be tested with the sockets support disabled,
4613 # as that requires a POSIX platform (which isn't the same as C99).
4614 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004615 scripts/config.py full
4616 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4617 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4618 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4619}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004620
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004621component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004622 msg "build: default config with memory buffer allocator and backtrace enabled"
4623 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4624 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4625 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004626 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004627 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004628 make
4629
4630 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4631 make test
4632}
4633
4634component_test_memory_buffer_allocator () {
4635 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004636 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4637 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004638 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004639 make
4640
4641 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4642 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004643
4644 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4645 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004646 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004647}
4648
Gilles Peskine8f073122018-11-27 15:58:47 +01004649component_test_no_max_fragment_length () {
4650 # Run max fragment length tests with MFL disabled
4651 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004652 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004653 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004654 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004655
Gilles Peskine8f073122018-11-27 15:58:47 +01004656 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004657 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004658}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004659
Hanno Becker545ced42019-02-19 11:10:48 +00004660component_test_asan_remove_peer_certificate () {
4661 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004662 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004663 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004664 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004665 make
4666
4667 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4668 make test
4669
4670 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004671 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004672
4673 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004674 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004675
4676 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004677 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004678}
4679
Gilles Peskine8f073122018-11-27 15:58:47 +01004680component_test_no_max_fragment_length_small_ssl_out_content_len () {
4681 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004682 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4683 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4684 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004685 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004686 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004687
Gilles Peskine8f073122018-11-27 15:58:47 +01004688 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004689 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004690
4691 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004692 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004693}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004694
Darryl Greenaad82f92019-12-02 10:53:11 +00004695component_test_variable_ssl_in_out_buffer_len () {
4696 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4697 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004698 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004699 make
4700
4701 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4702 make test
4703
4704 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004705 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004706
4707 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004708 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004709}
4710
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004711component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004712 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004713 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004714
Dave Rodgman17127e92023-12-14 16:42:48 +00004715 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004716 make
4717
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004718 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004719 make test
4720
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004721 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004722 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004723
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004724 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004725 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004726}
4727
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004728component_test_ssl_alloc_buffer_and_mfl () {
4729 msg "build: default config with memory buffer allocator and MFL extension"
4730 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4731 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4732 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4733 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4734 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004735 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004736 make
4737
4738 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4739 make test
4740
4741 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 +02004742 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004743}
4744
Gilles Peskine636c26a2020-03-04 20:46:15 +01004745component_test_when_no_ciphersuites_have_mac () {
4746 msg "build: when no ciphersuites have MAC"
4747 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004748 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004749 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004750 make
4751
4752 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4753 make test
4754
4755 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004756 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004757}
4758
Raoul Strackxa4e86142020-06-15 17:03:13 +02004759component_test_no_date_time () {
4760 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4761 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004762 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004763 make
4764
4765 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4766 make test
4767}
4768
Gilles Peskine8f073122018-11-27 15:58:47 +01004769component_test_platform_calloc_macro () {
4770 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004771 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4772 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4773 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004774 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004775 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004776
Gilles Peskine8f073122018-11-27 15:58:47 +01004777 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4778 make test
4779}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004780
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004781component_test_malloc_0_null () {
4782 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004783 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004784 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 +02004785
4786 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4787 make test
4788
4789 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4790 # Just the calloc selftest. "make test" ran the others as part of the
4791 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004792 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004793
4794 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4795 # Run a subset of the tests. The choice is a balance between coverage
4796 # and time (including time indirectly wasted due to flaky tests).
4797 # The current choice is to skip tests whose description includes
4798 # "proxy", which is an approximation of skipping tests that use the
4799 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004800 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004801}
4802
Dave Rodgman6a08b682023-06-19 11:51:33 +01004803support_test_aesni() {
4804 # Check that gcc targets x86_64 (we can build AESNI), and check for
4805 # AESNI support on the host (we can run AESNI).
4806 #
4807 # The name of this function is possibly slightly misleading, but needs to align
4808 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004809 #
4810 # In principle 32-bit x86 can support AESNI, but our implementation does not
4811 # support 32-bit x86, so we check for x86-64.
4812 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004813 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4814 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004815 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004816}
4817
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004818component_test_aesni () { # ~ 60s
4819 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4820 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4821 #
4822 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4823 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4824 # exercise the plain C impl).
4825
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004826 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004827 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004828 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004829 scripts/config.py set MBEDTLS_HAVE_ASM
4830
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004831 # test the intrinsics implementation
4832 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004833 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004834 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004835 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004836 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004837
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004838 # test the asm implementation
4839 msg "AES tests, test assembly"
4840 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004841 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004842 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004843 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004844
4845 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004846 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004847 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004848 msg "AES tests, plain C"
4849 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004850 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004851 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004852 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004853 not grep -q "AES note: using AESNI" ./programs/test/selftest
4854 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004855
4856 # test the intrinsics implementation
4857 scripts/config.py set MBEDTLS_AESNI_C
4858 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4859 msg "AES tests, test AESNI only"
4860 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004861 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004862 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4863 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004864 grep -q "AES note: using AESNI" ./programs/test/selftest
4865 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004866}
4867
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004868component_test_sha3_variations() {
4869 msg "sha3 loop unroll variations"
4870
4871 # define minimal config sufficient to test SHA3
4872 cat > include/mbedtls/mbedtls_config.h << END
4873 #define MBEDTLS_SELF_TEST
4874 #define MBEDTLS_SHA3_C
4875END
4876
4877 msg "all loops unrolled"
4878 make clean
4879 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"
4880 ./tests/test_suite_shax
4881
4882 msg "all loops rolled up"
4883 make clean
4884 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"
4885 ./tests/test_suite_shax
4886}
4887
Jerry Yub6d39c22023-08-16 15:11:48 +08004888support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004889 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004890}
4891
4892component_test_aesni_m32 () { # ~ 60s
4893 # This tests are duplicated from component_test_aesni for i386 target
4894 #
4895 # AESNI intrinsic code supports i386 and assembly code does not support it.
4896
4897 msg "build: default config with different AES implementations"
4898 scripts/config.py set MBEDTLS_AESNI_C
4899 scripts/config.py set MBEDTLS_PADLOCK_C
4900 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4901 scripts/config.py set MBEDTLS_HAVE_ASM
4902
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004903 # test the intrinsics implementation with gcc
4904 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004905 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004906 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004907 # check that we built intrinsics - this should be used by default when supported by the compiler
4908 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4909 grep -q "AES note: using AESNI" ./programs/test/selftest
4910 grep -q "AES note: built-in implementation." ./programs/test/selftest
4911 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4912 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4913
4914 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004915 scripts/config.py unset MBEDTLS_PADLOCK_C
4916 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4917 msg "AES tests, test AESNI only"
4918 make clean
4919 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4920 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4921 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4922 grep -q "AES note: using AESNI" ./programs/test/selftest
4923 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4924 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4925 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4926}
4927
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004928support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004929 # clang >= 4 is required to build with target attributes
4930 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004931}
4932
4933component_test_aesni_m32_clang() {
4934
4935 scripts/config.py set MBEDTLS_AESNI_C
4936 scripts/config.py set MBEDTLS_PADLOCK_C
4937 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4938 scripts/config.py set MBEDTLS_HAVE_ASM
4939
4940 # test the intrinsics implementation with clang
4941 msg "AES tests, test intrinsics (clang)"
4942 make clean
4943 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4944 # check that we built intrinsics - this should be used by default when supported by the compiler
4945 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4946 grep -q "AES note: using AESNI" ./programs/test/selftest
4947 grep -q "AES note: built-in implementation." ./programs/test/selftest
4948 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4949 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4950}
4951
Jerry Yu193cbc02023-08-03 17:06:29 +08004952# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4953component_build_aes_aesce_armcc () {
4954 msg "Build: AESCE test on arm64 platform without plain C."
4955 scripts/config.py baremetal
4956
4957 # armc[56] don't support SHA-512 intrinsics
4958 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4959
4960 # Stop armclang warning about feature detection for A64_CRYPTO.
4961 # With this enabled, the library does build correctly under armclang,
4962 # but in baremetal builds (as tested here), feature detection is
4963 # unavailable, and the user is notified via a #warning. So enabling
4964 # this feature would prevent us from building with -Werror on
4965 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004966 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004967 scripts/config.py set MBEDTLS_HAVE_ASM
4968
4969 msg "AESCE, build with default configuration."
4970 scripts/config.py set MBEDTLS_AESCE_C
4971 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4972 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4973
4974 msg "AESCE, build AESCE only"
4975 scripts/config.py set MBEDTLS_AESCE_C
4976 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4977 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4978}
4979
Dave Rodgman0c584032023-10-08 12:26:54 +01004980support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004981 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004982 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004983}
4984
4985component_build_aes_armce () {
4986 # Test variations of AES with Armv8 crypto extensions
4987 scripts/config.py set MBEDTLS_AESCE_C
4988 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4989
4990 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004991 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004992
4993 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4994 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4995
4996 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4997 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4998
Dave Rodgman5e419372023-10-23 15:30:20 +01004999 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01005000
Dave Rodgman5e419372023-10-23 15:30:20 +01005001 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
5002 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01005003
Dave Rodgman5e419372023-10-23 15:30:20 +01005004 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
5005 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01005006
Dave Rodgman5e419372023-10-23 15:30:20 +01005007 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
5008 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01005009
5010 # test for presence of AES instructions
5011 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
5012 msg "clang, test A32 crypto instructions built"
5013 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5014 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5015 msg "clang, test T32 crypto instructions built"
5016 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5017 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5018 msg "clang, test aarch64 crypto instructions built"
5019 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5020 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
5021
5022 # test for absence of AES instructions
5023 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
5024 scripts/config.py unset MBEDTLS_AESCE_C
5025 msg "clang, test A32 crypto instructions not built"
5026 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5027 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5028 msg "clang, test T32 crypto instructions not built"
5029 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5030 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5031 msg "clang, test aarch64 crypto instructions not built"
5032 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5033 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01005034}
5035
Dave Rodgman9ed18532023-10-05 00:06:47 +01005036support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00005037 # clang >= 4 is required to build with SHA extensions
5038 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01005039}
5040
Dave Rodgmand9e80832023-10-04 17:17:46 +01005041component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01005042 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005043
5044
5045 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01005046 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005047 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
5048 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5049 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
5050 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
5051 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005052
Dave Rodgmand9e80832023-10-04 17:17:46 +01005053
Dave Rodgman94a634d2023-10-10 12:59:29 +01005054 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005055 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005056 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
5057 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5058 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005059
Dave Rodgman5b89c552023-10-10 14:59:02 +01005060 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005061 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
5062 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5063 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01005064
Dave Rodgmancd654002023-10-05 09:40:07 +01005065
Dave Rodgman94a634d2023-10-10 12:59:29 +01005066 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005067 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005068 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
5069 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
5070 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
5071 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5072 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01005073
Dave Rodgmancd654002023-10-05 09:40:07 +01005074
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005075 # examine the disassembly for presence of SHA instructions
5076 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
5077 scripts/config.py set ${opt}
5078 msg "${opt} clang, test A32 crypto instructions built"
5079 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5080 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5081
5082 msg "${opt} clang, test T32 crypto instructions built"
5083 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5084 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5085
5086 msg "${opt} clang, test aarch64 crypto instructions built"
5087 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5088 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
5089 scripts/config.py unset ${opt}
5090 done
5091
5092
5093 # examine the disassembly for absence of SHA instructions
5094 msg "clang, test A32 crypto instructions not built"
5095 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5096 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5097
5098 msg "clang, test T32 crypto instructions not built"
5099 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5100 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5101
5102 msg "clang, test aarch64 crypto instructions not built"
5103 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5104 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01005105}
5106
Jerry Yuc935aa62023-08-03 17:08:27 +08005107# For timebeing, no VIA Padlock platform available.
5108component_build_aes_via_padlock () {
5109
5110 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08005111 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08005112 scripts/config.py set MBEDTLS_PADLOCK_C
5113 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005114 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08005115 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08005116
5117}
5118
5119support_build_aes_via_padlock_only () {
5120 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
5121 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
5122 [ "`dpkg --print-foreign-architectures`" == "i386" ]
5123}
5124
Jerry Yu193cbc02023-08-03 17:06:29 +08005125support_build_aes_aesce_armcc () {
5126 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01005127}
5128
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005129component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005130 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01005131 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005132 scripts/config.py unset MBEDTLS_PADLOCK_C
5133
Dave Rodgmand8d64512023-12-19 12:20:21 +00005134 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01005135
5136 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
5137 make test
5138}
5139
5140component_test_no_ctr_drbg_aes_only_128_bit_keys () {
5141 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
5142 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005143 scripts/config.py unset MBEDTLS_CTR_DRBG_C
5144 scripts/config.py unset MBEDTLS_PADLOCK_C
5145
Hanno Becker83ebf782017-07-07 12:29:15 +01005146 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01005147
5148 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005149 make test
5150}
Gilles Peskine8f073122018-11-27 15:58:47 +01005151
Hanno Becker83ebf782017-07-07 12:29:15 +01005152component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005153 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5154 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
5155 scripts/config.py unset MBEDTLS_PADLOCK_C
5156 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02005157 scripts/config.py unset MBEDTLS_AESCE_C
5158
Dave Rodgmand8d64512023-12-19 12:20:21 +00005159 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005160
5161 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02005162 make test
5163
5164 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5165 programs/test/selftest
5166}
5167
Matthias Schulz0767fda2024-02-07 10:46:28 +01005168component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005169 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
5170 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01005171 scripts/config.py unset MBEDTLS_PADLOCK_C
5172 scripts/config.py unset MBEDTLS_AESNI_C
5173 scripts/config.py unset MBEDTLS_AESCE_C
5174
5175 make CFLAGS='-O2 -Werror -Wall -Wextra'
5176
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005177 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01005178 make test
5179}
5180
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02005181component_test_aes_fewer_tables () {
5182 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005183 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005184 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005185
Gilles Peskine7c652162017-12-11 00:01:40 +01005186 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005187 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005188}
5189
5190component_test_aes_rom_tables () {
5191 msg "build: default config with AES_ROM_TABLES enabled"
5192 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005193 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005194
5195 msg "test: AES_ROM_TABLES"
5196 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005197}
5198
Gilles Peskine14c3c062018-01-29 21:25:12 +01005199component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005200 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
5201 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
5202 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005203 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005204
Gilles Peskine8f073122018-11-27 15:58:47 +01005205 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
5206 make test
5207}
5208
Yanray Wang49cd4b52023-11-10 11:58:37 +08005209# helper for common_block_cipher_no_decrypt() which:
5210# - enable/disable the list of config options passed from -s/-u respectively.
5211# - build
5212# - test for tests_suite_xxx
5213# - selftest
5214#
5215# Usage: helper_block_cipher_no_decrypt_build_test
5216# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5217# Options: -s set_opts the list of config options to enable
5218# -u unset_opts the list of config options to disable
5219# -c cflags the list of options passed to CFLAGS
5220# -l ldflags the list of options passed to LDFLAGS
5221helper_block_cipher_no_decrypt_build_test () {
5222 while [ $# -gt 0 ]; do
5223 case "$1" in
5224 -s)
5225 shift; local set_opts="$1";;
5226 -u)
5227 shift; local unset_opts="$1";;
5228 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005229 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005230 -l)
5231 shift; local ldflags="$1";;
5232 esac
5233 shift
5234 done
5235 set_opts="${set_opts:-}"
5236 unset_opts="${unset_opts:-}"
5237 cflags="${cflags:-}"
5238 ldflags="${ldflags:-}"
5239
Yanray Wangb2d6e522023-11-13 16:57:47 +08005240 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5241 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005242
5243 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5244 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005245 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005246
5247 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5248 not grep mbedtls_aes_setkey_dec library/aes.o
5249 not grep mbedtls_aria_setkey_dec library/aria.o
5250 not grep mbedtls_camellia_setkey_dec library/camellia.o
5251 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5252 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005253 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5254 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005255
5256 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5257 make test
5258
5259 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5260 programs/test/selftest
5261}
5262
5263# This is a common configuration function used in:
5264# - component_test_block_cipher_no_decrypt_aesni_legacy()
5265# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5266# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5267# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5268# on x86.
5269common_block_cipher_no_decrypt () {
5270 # test AESNI intrinsics
5271 helper_block_cipher_no_decrypt_build_test \
5272 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005273 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005274
5275 # test AESNI assembly
5276 helper_block_cipher_no_decrypt_build_test \
5277 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005278 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005279
5280 # test AES C implementation
5281 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005282 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005283
5284 # test AESNI intrinsics for i386 target
5285 helper_block_cipher_no_decrypt_build_test \
5286 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005287 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005288 -l "-m32"
5289}
5290
Yanray Wang3ae11992023-11-13 17:32:09 +08005291# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5292# usage: 0: no PSA crypto configuration
5293# 1: use PSA crypto configuration
5294config_block_cipher_no_decrypt () {
5295 use_psa=$1
5296
Yanray Wang66111392023-10-31 18:54:54 +08005297 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005298 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5299 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005300 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005301 scripts/config.py unset MBEDTLS_NIST_KW_C
5302
Yanray Wang3ae11992023-11-13 17:32:09 +08005303 if [ "$use_psa" -eq 1 ]; then
5304 # Enable support for cryptographic mechanisms through the PSA API.
5305 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5306 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5307 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5308 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5309 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5310 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5311 fi
5312}
5313
5314component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005315 # This consistently causes an llvm crash on clang 3.8, so use gcc
5316 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005317 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005318 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005319}
5320
Yanray Wangf1496402023-11-01 18:55:13 +08005321component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005322 # This consistently causes an llvm crash on clang 3.8, so use gcc
5323 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005324 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005325 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005326}
5327
Yanray Wang66111392023-10-31 18:54:54 +08005328support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005329 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005330}
5331
Yanray Wang66111392023-10-31 18:54:54 +08005332component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005333 scripts/config.py baremetal
5334
5335 # armc[56] don't support SHA-512 intrinsics
5336 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5337
5338 # Stop armclang warning about feature detection for A64_CRYPTO.
5339 # With this enabled, the library does build correctly under armclang,
5340 # but in baremetal builds (as tested here), feature detection is
5341 # unavailable, and the user is notified via a #warning. So enabling
5342 # this feature would prevent us from building with -Werror on
5343 # armclang. Tracked in #7198.
5344 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5345 scripts/config.py set MBEDTLS_HAVE_ASM
5346
Yanray Wang3ae11992023-11-13 17:32:09 +08005347 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005348
5349 # test AESCE baremetal build
5350 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005351 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005352 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005353
Yanray Wangef1b04d2023-09-08 11:09:26 +08005354 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5355 not grep mbedtls_aes_setkey_dec library/aes.o
5356 not grep mbedtls_aria_setkey_dec library/aria.o
5357 not grep mbedtls_camellia_setkey_dec library/camellia.o
5358 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5359 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005360 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005361 not grep mbedtls_aesce_inverse_key library/aesce.o
5362 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005363}
5364
Gilles Peskine592f5912019-10-07 18:49:32 +02005365component_test_ctr_drbg_aes_256_sha_256 () {
5366 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5367 scripts/config.py full
5368 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5369 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005370 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005371 make
5372
5373 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5374 make test
5375}
5376
5377component_test_ctr_drbg_aes_128_sha_512 () {
5378 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005379 scripts/config.py full
5380 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5381 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005382 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005383 make
5384
5385 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5386 make test
5387}
5388
5389component_test_ctr_drbg_aes_128_sha_256 () {
5390 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005391 scripts/config.py full
5392 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5393 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5394 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005395 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005396 make
5397
5398 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5399 make test
5400}
5401
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005402component_test_se_default () {
5403 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005404 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005405 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005406
5407 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5408 make test
5409}
5410
Steven Cooremand57203d2020-07-16 20:28:59 +02005411component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005412 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005413 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005414 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005415 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5416 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005417 loc_cflags="${loc_cflags} -I../tests/include -O2"
5418
Gilles Peskine21570cf2023-12-22 11:49:50 +01005419 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005420
Gilles Peskine1997f302023-07-26 18:45:20 +02005421 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005422 make test
5423}
5424
Gilles Peskine8f073122018-11-27 15:58:47 +01005425component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005426 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005427 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005428 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005429 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005430}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005431
Gilles Peskinecf740502019-07-03 20:43:05 +02005432component_test_cmake_shared () {
5433 msg "build/test: cmake shared" # ~ 2min
5434 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5435 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005436 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005437 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005438 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005439}
5440
Gilles Peskineec10bf12019-09-20 19:56:06 +02005441test_build_opt () {
5442 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005443 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005444 for opt in "$@"; do
5445 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005446 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005447 # We're confident enough in compilers to not run _all_ the tests,
5448 # but at least run the unit tests. In particular, runs with
5449 # optimizations use inline assembly whereas runs with -O0
5450 # skip inline assembly.
5451 make test # ~30s
5452 make clean
5453 done
5454}
5455
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005456# For FreeBSD we invoke the function by name so this condition is added
5457# to disable the existing test_clang_opt function for linux.
5458if [[ $(uname) != "Linux" ]]; then
5459 component_test_clang_opt () {
5460 scripts/config.py full
5461 test_build_opt 'full config' clang -O0 -Os -O2
5462 }
5463fi
5464
5465component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005466 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005467 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005468}
5469support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005470 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005471}
5472
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005473component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005474 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005475 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005476}
5477support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005478 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005479}
5480
5481component_test_gcc_latest_opt () {
5482 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005483 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005484}
5485support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005486 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005487}
5488
5489component_test_gcc_earliest_opt () {
5490 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005491 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005492}
5493support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005494 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005495}
5496
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005497component_build_mbedtls_config_file () {
5498 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005499 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005500 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005501 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005502 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005503 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5504 make clean
5505
5506 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5507 # In the user config, disable one feature (for simplicity, pick a feature
5508 # that nothing else depends on).
5509 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005510 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005511 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5512
5513 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005514}
5515
Gilles Peskine7d904e72022-04-07 21:59:14 +02005516component_build_psa_config_file () {
5517 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5518 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5519 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5520 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5521 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005522 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005523 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5524 make clean
5525
5526 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
5527 # In the user config, disable one feature, which will reflect on the
5528 # mbedtls configuration so we can query it with query_compile_time_config.
5529 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
5530 scripts/config.py unset MBEDTLS_CMAC_C
5531 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5532 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5533
5534 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005535}
5536
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005537component_build_psa_alt_headers () {
5538 msg "build: make with PSA alt headers" # ~20s
5539
5540 # Generate alternative versions of the substitutable headers with the
5541 # same content except different include guards.
5542 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5543
5544 # Build the library and some programs.
5545 # Don't build the fuzzers to avoid having to go through hoops to set
5546 # a correct include path for programs/fuzz/Makefile.
5547 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
5548 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\"'"
5549
5550 # Check that we're getting the alternative include guards and not the
5551 # original include guards.
5552 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5553 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5554 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5555 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5556}
5557
Dave Rodgman852de3c2023-12-14 14:46:45 +00005558component_test_m32_no_asm () {
5559 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005560 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005561 #
5562 # Note that we require gcc, because clang Asan builds fail to link for
5563 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005564 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005565 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005566 scripts/config.py unset MBEDTLS_HAVE_ASM
5567 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005568 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005569 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005570
Dave Rodgman852de3c2023-12-14 14:46:45 +00005571 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005572 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005573}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005574support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005575 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005576 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005577 *) false;;
5578 esac
5579}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005580
Gilles Peskineff0aee02021-10-05 09:36:03 +02005581component_test_m32_o2 () {
5582 # Build with optimization, to use the i386 specific inline assembly
5583 # and go faster for tests.
5584 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005585 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005586 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005587 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005588
Gilles Peskineff0aee02021-10-05 09:36:03 +02005589 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005590 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005591
Gilles Peskineff0aee02021-10-05 09:36:03 +02005592 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005593 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005594}
Gilles Peskinecf522222021-10-07 19:25:29 +02005595support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005596 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005597}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005598
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005599component_test_m32_everest () {
5600 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005601 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005602 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005603 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005604
5605 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5606 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005607
5608 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005609 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005610
5611 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5612 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005613 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005614}
5615support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005616 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005617}
5618
Gilles Peskine8f073122018-11-27 15:58:47 +01005619component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005620 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005621 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005622 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005623
5624 msg "test: 64-bit ILP32, make, gcc"
5625 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005626}
Gilles Peskine878cf602019-01-06 20:50:38 +00005627support_test_mx32 () {
5628 case $(uname -m) in
5629 amd64|x86_64) true;;
5630 *) false;;
5631 esac
5632}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005633
Peter Kolbus60c6da22018-12-27 06:59:04 -06005634component_test_min_mpi_window_size () {
5635 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005636 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005637 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005638 make
5639
5640 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5641 make test
5642}
5643
Gilles Peskine8f073122018-11-27 15:58:47 +01005644component_test_have_int32 () {
5645 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005646 scripts/config.py unset MBEDTLS_HAVE_ASM
5647 scripts/config.py unset MBEDTLS_AESNI_C
5648 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005649 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005650 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005651
Gilles Peskine8f073122018-11-27 15:58:47 +01005652 msg "test: gcc, force 32-bit bignum limbs"
5653 make test
5654}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005655
Gilles Peskine8f073122018-11-27 15:58:47 +01005656component_test_have_int64 () {
5657 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005658 scripts/config.py unset MBEDTLS_HAVE_ASM
5659 scripts/config.py unset MBEDTLS_AESNI_C
5660 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005661 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005662 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005663
Gilles Peskine8f073122018-11-27 15:58:47 +01005664 msg "test: gcc, force 64-bit bignum limbs"
5665 make test
5666}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005667
Gabor Mezeie256cc12023-07-26 17:28:48 +02005668component_test_have_int32_cmake_new_bignum () {
5669 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5670 scripts/config.py unset MBEDTLS_HAVE_ASM
5671 scripts/config.py unset MBEDTLS_AESNI_C
5672 scripts/config.py unset MBEDTLS_PADLOCK_C
5673 scripts/config.py unset MBEDTLS_AESCE_C
5674 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005675 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005676 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005677
5678 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5679 make test
5680}
5681
Gilles Peskine8f073122018-11-27 15:58:47 +01005682component_test_no_udbl_division () {
5683 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005684 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005685 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005686 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005687
Gilles Peskine8f073122018-11-27 15:58:47 +01005688 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5689 make test
5690}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005691
Gilles Peskine8f073122018-11-27 15:58:47 +01005692component_test_no_64bit_multiplication () {
5693 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005694 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005695 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005696 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005697
Gilles Peskine8f073122018-11-27 15:58:47 +01005698 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5699 make test
5700}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005701
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005702component_test_no_strings () {
5703 msg "build: no strings" # ~10s
5704 scripts/config.py full
5705 # Disable options that activate a large amount of string constants.
5706 scripts/config.py unset MBEDTLS_DEBUG_C
5707 scripts/config.py unset MBEDTLS_ERROR_C
5708 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5709 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005710 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005711
5712 msg "test: no strings" # ~ 10s
5713 make test
5714}
5715
Hanno Beckerc5722d12020-10-09 11:10:42 +01005716component_test_no_x509_info () {
5717 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5718 scripts/config.pl full
5719 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5720 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005721 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005722
5723 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5724 make test
5725
5726 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005727 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005728}
5729
Gilles Peskine8f073122018-11-27 15:58:47 +01005730component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005731 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005732 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005733 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 +02005734
Gilles Peskinee36fe812021-09-01 20:00:33 +02005735 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005736 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005737}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005738
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005739component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005740 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005741 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005742 # Build for a target platform that's close to what Debian uses
5743 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005744 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005745 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005746 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005747 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'
5748
Gilles Peskinee36fe812021-09-01 20:00:33 +02005749 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005750 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005751}
5752support_build_arm_linux_gnueabi_gcc_arm5vte () {
5753 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5754}
5755
5756component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005757 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005758 scripts/config.py baremetal
5759 # This is an imperfect substitute for
5760 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005761 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005762 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 +02005763
Gilles Peskinee36fe812021-09-01 20:00:33 +02005764 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005765 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005766}
5767
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005768component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005769 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5770 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005771 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 +02005772
Gilles Peskinee36fe812021-09-01 20:00:33 +02005773 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005774 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005775 for lib in library/*.a; do
5776 echo "$lib:"
5777 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5778 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005779}
5780
Gilles Peskine8f073122018-11-27 15:58:47 +01005781component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005782 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005783 scripts/config.py baremetal
5784 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005785 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 +01005786 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005787 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005788}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005789
Gilles Peskine8f073122018-11-27 15:58:47 +01005790component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005791 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005792 scripts/config.py baremetal
5793 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005794 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 +01005795 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005796 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005797}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005798
Dave Rodgman8c315f22023-06-02 10:26:24 -04005799component_build_arm_clang_thumb () {
5800 # ~ 30s
5801
5802 scripts/config.py baremetal
5803
5804 msg "build: clang thumb 2, make"
5805 make clean
5806 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5807
5808 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5809 msg "build: clang thumb 1 -O0, make"
5810 make clean
5811 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5812
5813 msg "build: clang thumb 1 -Os, make"
5814 make clean
5815 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5816}
5817
Gilles Peskine8f073122018-11-27 15:58:47 +01005818component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005819 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005820 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005821 # armc[56] don't support SHA-512 intrinsics
5822 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005823
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005824 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5825 scripts/config.py unset MBEDTLS_AESCE_C
5826
Dave Rodgman0fddf822023-03-02 15:32:12 +00005827 # Stop armclang warning about feature detection for A64_CRYPTO.
5828 # With this enabled, the library does build correctly under armclang,
5829 # but in baremetal builds (as tested here), feature detection is
5830 # unavailable, and the user is notified via a #warning. So enabling
5831 # this feature would prevent us from building with -Werror on
5832 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005833 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005834
Hanno Beckerf0762e92022-07-15 12:08:19 +01005835 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005836
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005837 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005838
5839 msg "size: ARM Compiler 5"
5840 "$ARMC5_FROMELF" -z library/*.o
5841
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005842 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005843
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005844 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005845 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005846
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005847 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005848 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5849
5850 # ARM Compiler 6 - Target ARMv7-M+DSP
5851 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005852
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005853 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005854 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005855
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005856 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005857 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005858
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005859 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5860 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5861
Dave Rodgman99318e62023-05-24 12:27:42 +01005862 # ARM Compiler 6 - Target Cortex-M0
5863 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005864
5865 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5866 #
5867 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5868 # that we have in our CI
5869 scripts/config.py set MBEDTLS_AESCE_C
5870 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005871}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005872
Pengyu Lvdf070032023-02-24 16:03:31 +08005873support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005874 armc5_cc="$ARMC5_BIN_DIR/armcc"
5875 armc6_cc="$ARMC6_BIN_DIR/armclang"
5876 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005877}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005878
Ronald Crond2cb7f42024-03-18 12:49:18 +01005879component_test_tls12_only () {
5880 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5881 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5882 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5883 make
5884
5885 msg "test: main suites (inc. selftests) (ASan build)"
5886 make test
5887
5888 msg "test: ssl-opt.sh (ASan build)"
5889 tests/ssl-opt.sh
5890
5891 msg "test: compat.sh (ASan build)"
5892 tests/compat.sh
5893}
5894
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005895component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005896 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005897 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005898 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005899 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5900
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005901 msg "test: TLS 1.3 only, all key exchange modes enabled"
5902 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005903
Ronald Cronc3f43b62022-10-17 17:35:32 +02005904 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5905 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005906}
5907
Ronald Cronc3f43b62022-10-17 17:35:32 +02005908component_test_tls13_only_psk () {
5909 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5910 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5911 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5912 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005913 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005914 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5915 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5916 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5917 scripts/config.py unset MBEDTLS_ECDSA_C
5918 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005919 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005920 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005921 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5922
Ronald Cronc3f43b62022-10-17 17:35:32 +02005923 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5924 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005925
Ronald Cronc3f43b62022-10-17 17:35:32 +02005926 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5927 tests/ssl-opt.sh
5928}
5929
5930component_test_tls13_only_ephemeral () {
5931 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5932 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5933 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005934 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005935 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5936
5937 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5938 cd tests; ./test_suite_ssl; cd ..
5939
5940 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5941 tests/ssl-opt.sh
5942}
5943
Przemek Stekiela01c2422023-06-13 10:46:48 +02005944component_test_tls13_only_ephemeral_ffdh () {
5945 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5946 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5947 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5948 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005949 scripts/config.py unset MBEDTLS_ECDH_C
5950
Przemek Stekiela01c2422023-06-13 10:46:48 +02005951 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5952
5953 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5954 cd tests; ./test_suite_ssl; cd ..
5955
5956 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5957 tests/ssl-opt.sh
5958}
5959
Ronald Cronc3f43b62022-10-17 17:35:32 +02005960component_test_tls13_only_psk_ephemeral () {
5961 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5962 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5963 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5964 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5965 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5966 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5967 scripts/config.py unset MBEDTLS_ECDSA_C
5968 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005969 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005970 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005971 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5972
5973 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5974 cd tests; ./test_suite_ssl; cd ..
5975
5976 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5977 tests/ssl-opt.sh
5978}
5979
Przemek Stekiela01c2422023-06-13 10:46:48 +02005980component_test_tls13_only_psk_ephemeral_ffdh () {
5981 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5982 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5983 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5984 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5985 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5986 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5987 scripts/config.py unset MBEDTLS_ECDSA_C
5988 scripts/config.py unset MBEDTLS_PKCS1_V21
5989 scripts/config.py unset MBEDTLS_PKCS7_C
5990 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005991 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005992 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5993
5994 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5995 cd tests; ./test_suite_ssl; cd ..
5996
5997 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5998 tests/ssl-opt.sh
5999}
6000
Ronald Cronc3f43b62022-10-17 17:35:32 +02006001component_test_tls13_only_psk_all () {
6002 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
6003 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
6004 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
6005 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
6006 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
6007 scripts/config.py unset MBEDTLS_ECDSA_C
6008 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00006009 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01006010 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006011 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6012
6013 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6014 cd tests; ./test_suite_ssl; cd ..
6015
6016 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6017 tests/ssl-opt.sh
6018}
6019
6020component_test_tls13_only_ephemeral_all () {
6021 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
6022 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01006023 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006024 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6025
6026 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6027 cd tests; ./test_suite_ssl; cd ..
6028
6029 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6030 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02006031}
6032
Ronald Cron46ac0652024-03-18 12:39:04 +01006033component_test_tls13_no_padding () {
6034 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006035 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01006036 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006037 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006038 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006039 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006040 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01006041 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006042 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006043}
6044
Ronald Cron6f135e12021-12-08 16:57:54 +01006045component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01006046 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006047 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01006048 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006049 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01006050 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006051 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006052 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01006053 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006054 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006055}
6056
Gilles Peskine8f073122018-11-27 15:58:47 +01006057component_build_mingw () {
6058 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006059 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 +00006060
Gilles Peskine8f073122018-11-27 15:58:47 +01006061 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006062 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 +01006063 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02006064
Gilles Peskine8f073122018-11-27 15:58:47 +01006065 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006066 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
6067 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 +01006068 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006069
Pengyu Lv158eead2023-10-19 11:27:05 +08006070 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006071 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08006072 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 +01006073 make WINDOWS_BUILD=1 clean
6074}
Jaeden Amero117b8a42019-04-17 15:19:26 +01006075support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08006076 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
6077 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01006078 *) true;;
6079 esac
6080}
Simon Butcher91aef332016-11-17 09:20:50 +00006081
Gilles Peskine8f073122018-11-27 15:58:47 +01006082component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006083 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02006084 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006085 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
6086 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02006087
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006088 msg "test: main suites (MSan)" # ~ 10s
6089 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006090
Gilles Peskine6848d172023-11-02 19:58:03 +01006091 msg "test: metatests (MSan)"
6092 tests/scripts/run-metatests.sh any msan
6093
Gilles Peskine82b27272019-06-14 18:27:03 +02006094 msg "program demos (MSan)" # ~20s
6095 tests/scripts/run_demos.py
6096
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006097 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006098 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006099
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006100 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006101
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006102 if [ "$MEMORY" -gt 0 ]; then
6103 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006104 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006105 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006106}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006107
Bence Szépkúti0354d042023-12-06 16:14:37 +01006108component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006109 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006110 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006111 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6112 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006113
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006114 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006115 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006116
Gilles Peskine636c26a2020-03-04 20:46:15 +01006117 # Optional parts (slow; currently broken on OS X because programs don't
6118 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006119 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006120 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006121 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006122 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006123 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006124
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006125 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006126 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006127 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006128 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006129
6130 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006131 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006132 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006133 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006134}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006135
Bence Szépkúti0354d042023-12-06 16:14:37 +01006136component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006137 msg "build: Release, full (clang)"
6138 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
6139 scripts/config.py full
6140 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6141 make
6142
6143 msg "test: main suites, Valgrind (full config)"
6144 make memcheck
6145}
6146
Paul Elliott62dc3922021-11-25 17:29:40 +00006147support_test_cmake_out_of_source () {
6148 distrib_id=""
6149 distrib_ver=""
6150 distrib_ver_minor=""
6151 distrib_ver_major=""
6152
6153 # Attempt to parse lsb-release to find out distribution and version. If not
6154 # found this should fail safe (test is supported).
6155 if [[ -f /etc/lsb-release ]]; then
6156
6157 while read -r lsb_line; do
6158 case "$lsb_line" in
6159 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
6160 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
6161 esac
6162 done < /etc/lsb-release
6163
6164 distrib_ver_major="${distrib_ver%%.*}"
6165 distrib_ver="${distrib_ver#*.}"
6166 distrib_ver_minor="${distrib_ver%%.*}"
6167 fi
6168
6169 # Running the out of source CMake test on Ubuntu 16.04 using more than one
6170 # processor (as the CI does) can create a race condition whereby the build
6171 # fails to see a generated file, despite that file actually having been
6172 # generated. This problem appears to go away with 18.04 or newer, so make
6173 # the out of source tests unsupported on Ubuntu 16.04.
6174 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
6175}
6176
Gilles Peskine8f073122018-11-27 15:58:47 +01006177component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01006178 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01006179 # generates
6180 make neat
6181
Gilles Peskine8f073122018-11-27 15:58:47 +01006182 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01006183 MBEDTLS_ROOT_DIR="$PWD"
6184 mkdir "$OUT_OF_SOURCE_DIR"
6185 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01006186 # Note: Explicitly generate files as these are turned off in releases
6187 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006188 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006189
Gilles Peskine8f073122018-11-27 15:58:47 +01006190 msg "test: cmake 'out-of-source' build"
6191 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006192 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01006193 # Also ensure that there are no error messages such as
6194 # "No such file or directory", which would indicate that some required
6195 # file is missing (ssl-opt.sh tolerates the absence of some files so
6196 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006197 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006198 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006199 cat ssl-opt.err >&2
6200 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006201 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006202 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006203 cd "$MBEDTLS_ROOT_DIR"
6204 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006205}
Andres AGdc192212016-08-31 17:33:13 +01006206
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006207component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006208 # Remove existing generated files so that we use the ones CMake
6209 # generates
6210 make neat
6211
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006212 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006213 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006214 # Note: Explicitly generate files as these are turned off in releases
6215 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006216 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006217 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006218}
Gilles Peskinea3000992022-02-04 00:21:12 +01006219support_test_cmake_as_subdirectory () {
6220 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006221}
6222
Chris Kayd259e342021-03-25 16:03:25 +00006223component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006224 # Remove existing generated files so that we use the ones CMake
6225 # generates
6226 make neat
6227
Chris Kayd259e342021-03-25 16:03:25 +00006228 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006229 cd programs/test/cmake_package
6230 cmake .
6231 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006232 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006233}
Gilles Peskinea3000992022-02-04 00:21:12 +01006234support_test_cmake_as_package () {
6235 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006236}
6237
6238component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006239 # Remove existing generated files so that we use the ones CMake
6240 # generates
6241 make neat
6242
Chris Kayd259e342021-03-25 16:03:25 +00006243 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006244 cd programs/test/cmake_package_install
6245 cmake .
6246 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006247 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006248}
Gilles Peskinea3000992022-02-04 00:21:12 +01006249support_test_cmake_as_package_install () {
6250 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006251}
6252
David Horstmann20550e32023-01-12 14:17:01 +00006253component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006254 # Make a copy of config file to use for the in-tree test
6255 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006256
6257 MBEDTLS_ROOT_DIR="$PWD"
6258 mkdir "$OUT_OF_SOURCE_DIR"
6259 cd "$OUT_OF_SOURCE_DIR"
6260
David Horstmann969c1452023-01-31 10:34:44 +00006261 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006262 cmake "$MBEDTLS_ROOT_DIR"
6263 make
6264
6265 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6266 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006267 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006268 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6269 make
6270
6271 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6272 # In the user config, disable one feature (for simplicity, pick a feature
6273 # that nothing else depends on).
6274 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6275
6276 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6277 make
6278 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6279
6280 rm -f user_config.h full_config.h
6281
6282 cd "$MBEDTLS_ROOT_DIR"
6283 rm -rf "$OUT_OF_SOURCE_DIR"
6284
6285 # Now repeat the test for an in-tree build:
6286
David Horstmann969c1452023-01-31 10:34:44 +00006287 # Restore config for the in-tree test
6288 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006289
David Horstmann969c1452023-01-31 10:34:44 +00006290 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006291 cmake .
6292 make
6293
6294 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6295 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006296 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006297 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6298 make
6299
6300 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6301 # In the user config, disable one feature (for simplicity, pick a feature
6302 # that nothing else depends on).
6303 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6304
6305 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6306 make
6307 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6308
6309 rm -f user_config.h full_config.h
6310}
6311support_build_cmake_custom_config_file () {
6312 support_test_cmake_out_of_source
6313}
6314
6315
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006316component_build_zeroize_checks () {
6317 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6318
6319 scripts/config.py full
6320
6321 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006322 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 +01006323}
6324
6325
Gilles Peskine8f073122018-11-27 15:58:47 +01006326component_test_zeroize () {
6327 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6328 # different combinations of compilers and optimization flags by using an
6329 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6330 # system in all cases that the script fails, so we must manually search the
6331 # output to check whether the pass string is present and no failure strings
6332 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006333
Gilles Peskine4976e822019-01-06 19:52:22 +00006334 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6335 # about a spurious message if Gdb tries and fails, so suppress that.
6336 gdb_disable_aslr=
6337 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6338 gdb_disable_aslr='set disable-randomization off'
6339 fi
6340
Gilles Peskine8f073122018-11-27 15:58:47 +01006341 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006342 for compiler in clang gcc; do
6343 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6344 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006345 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6346 grep "The buffer was correctly zeroized" test_zeroize.log
6347 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006348 rm -f test_zeroize.log
6349 make clean
6350 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006351 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006352}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006353
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006354component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006355 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006356 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006357 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006358
6359 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006360 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006361}
6362
6363support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006364 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006365 ver="$(cmake --version)"
6366 ver="${ver#cmake version }"
6367 ver_major="${ver%%.*}"
6368
6369 ver="${ver#*.}"
6370 ver_minor="${ver%%.*}"
6371
6372 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006373}
6374
Gilles Peskinec848d222022-12-09 12:23:35 +01006375component_check_code_style () {
6376 msg "Check C code style"
6377 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006378}
6379
Gilles Peskinec848d222022-12-09 12:23:35 +01006380support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006381 case $(uncrustify --version) in
6382 *0.75.1*) true;;
6383 *) false;;
6384 esac
6385}
6386
Gilles Peskine8f073122018-11-27 15:58:47 +01006387component_check_python_files () {
6388 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006389 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006390}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006391
Joe Subbianid614c0b2021-07-29 11:18:29 +01006392component_check_test_helpers () {
6393 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006394 # unittest writes out mundane stuff like number or tests run on stderr.
6395 # Our convention is to reserve stderr for actual errors, and write
6396 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006397 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006398
Joe Subbiania25ffab2021-08-06 09:41:27 +01006399 msg "unit test: translate_ciphers.py"
6400 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006401}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006402
Jerry Yud767cc42023-03-31 15:03:55 +08006403
Gilles Peskine192c72f2017-12-21 15:59:21 +01006404################################################################
6405#### Termination
6406################################################################
6407
Gilles Peskine8f073122018-11-27 15:58:47 +01006408post_report () {
6409 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006410 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006411
Gilles Peskine8f073122018-11-27 15:58:47 +01006412 final_report
6413}
6414
6415
6416
6417################################################################
6418#### Run all the things
6419################################################################
6420
Gilles Peskine5d996822020-03-28 21:09:21 +01006421# Function invoked by --error-test to test error reporting.
6422pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006423 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006424 if [ $KEEP_GOING -ne 0 ]; then
6425 echo "Expect three failing commands."
6426 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006427 # If the component doesn't run in a subshell, changing error_test_i to an
6428 # invalid integer will cause an error in the loop that runs this function.
6429 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006430 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006431 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006432 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006433 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006434 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006435 make unknown_target
6436 false "this should not be executed"
6437}
6438
Gilles Peskinee48351a2018-11-27 16:06:30 +01006439# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006440run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006441 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006442 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006443
6444 # Unconditionally create a seedfile that's sufficiently long.
6445 # Do this before each component, because a previous component may
6446 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006447 local dd_cmd
6448 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6449 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006450 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006451 esac
6452 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006453
Gilles Peskineec135542021-08-02 23:14:03 +02006454 # Run the component in a subshell, with error trapping and output
6455 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006456 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006457 # We want to keep running if the subshell fails, so 'set -e' must
6458 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006459 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006460 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006461 (
6462 if [ $QUIET -eq 1 ]; then
6463 # msg() will be silenced, so just print the component name here.
6464 echo "${current_component#component_}"
6465 exec >/dev/null
6466 fi
6467 if [ $KEEP_GOING -eq 1 ]; then
6468 # Keep "set -e" off, and run an ERR trap instead to record failures.
6469 set -E
6470 trap err_trap ERR
6471 fi
6472 # The next line is what runs the component
6473 "$@"
6474 if [ $KEEP_GOING -eq 1 ]; then
6475 trap - ERR
6476 exit $last_failure_status
6477 fi
6478 )
6479 component_status=$?
6480 if [ $KEEP_GOING -eq 1 ]; then
6481 set -e
6482 if [ $component_status -ne 0 ]; then
6483 failure_count=$((failure_count + 1))
6484 fi
6485 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006486
6487 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006488 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006489 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006490}
6491
6492# Preliminary setup
6493pre_check_environment
6494pre_initialize_variables
6495pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006496
Dave Rodgman21900632024-02-26 11:41:19 +00006497setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006498pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006499pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006500pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006501
Gilles Peskine878cf602019-01-06 20:50:38 +00006502build_status=0
6503if [ $KEEP_GOING -eq 1 ]; then
6504 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006505fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006506pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006507pre_print_configuration
6508pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006509cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006510if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006511 pre_generate_files
6512fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006513
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006514# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006515for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006516 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006517done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006518unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006519for component in $RUN_COMPONENTS; do
6520 run_component "component_$component"
6521done
Gilles Peskine8f073122018-11-27 15:58:47 +01006522
6523# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006524post_report