blob: fbe9523caf31d517472b5eab820196899e218f6e [file] [log] [blame]
Gilles Peskine62cf2e82020-03-27 16:35:23 +01001#! /usr/bin/env bash
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine192c72f2017-12-21 15:59:21 +01007
8
9
10################################################################
11#### Documentation
12################################################################
13
Simon Butcher3ea7f522016-03-07 23:22:10 +000014# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010015# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000016#
SimonB2e23c822016-04-16 21:54:39 +010017# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010018#
Gilles Peskine192c72f2017-12-21 15:59:21 +010019# Notes for users
20# ---------------
21#
SimonB2e23c822016-04-16 21:54:39 +010022# Warning: the test is destructive. It includes various build modes and
23# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010024# configuration. The following files must be committed into git:
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020025# * include/mbedtls/mbedtls_config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010026# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
27# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010028# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040038# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010039# * arm-gcc and mingw-gcc
40# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine7be571a2023-08-27 21:39:21 +020041# * OpenSSL and GnuTLS command line tools, in suitable versions for the
42# interoperability tests. The following are the official versions at the
43# time of writing:
44# * GNUTLS_{CLI,SERV} = 3.4.10
45# * GNUTLS_NEXT_{CLI,SERV} = 3.7.2
46# * OPENSSL = 1.0.2g (without Debian/Ubuntu patches)
Ronald Cronc5e81d22024-04-02 14:39:53 +020047# * OPENSSL_NEXT = 3.1.2
Gilles Peskine192c72f2017-12-21 15:59:21 +010048# See the invocation of check_tools below for details.
49#
50# This script must be invoked from the toplevel directory of a git
51# working copy of Mbed TLS.
52#
Gilles Peskinece266c42020-03-28 18:50:43 +010053# The behavior on an error depends on whether --keep-going (alias -k)
54# is in effect.
55# * Without --keep-going: the script stops on the first error without
56# cleaning up. This lets you work in the configuration of the failing
57# component.
58# * With --keep-going: the script runs all requested components and
59# reports failures at the end. In particular the script always cleans
60# up on exit.
61#
Gilles Peskine192c72f2017-12-21 15:59:21 +010062# Note that the output is not saved. You may want to run
63# script -c tests/scripts/all.sh
64# or
65# tests/scripts/all.sh >all.log 2>&1
66#
67# Notes for maintainers
68# ---------------------
69#
Gilles Peskine8f073122018-11-27 15:58:47 +010070# The bulk of the code is organized into functions that follow one of the
71# following naming conventions:
72# * pre_XXX: things to do before running the tests, in order.
73# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010074# * component_check_XXX: quick tests that aren't worth parallelizing.
75# * component_build_XXX: build things but don't run them.
76# * component_test_XXX: build and test.
Bence Szépkúti89dd5c02023-12-15 17:05:15 +010077# * component_release_XXX: tests that the CI should skip during PR testing.
Gilles Peskine878cf602019-01-06 20:50:38 +000078# * support_XXX: if support_XXX exists and returns false then
79# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010080# * post_XXX: things to do after running the tests.
81# * other: miscellaneous support functions.
82#
Gilles Peskinec70637a2019-01-09 22:29:17 +010083# Each component must start by invoking `msg` with a short informative message.
84#
Gilles Peskinea681c592020-03-28 21:27:40 +010085# Warning: due to the way bash detects errors, the failure of a command
86# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
87#
Gilles Peskinece266c42020-03-28 18:50:43 +010088# Each component is executed in a separate shell process. The component
89# fails if any command in it returns a non-zero status.
90#
Gilles Peskinec70637a2019-01-09 22:29:17 +010091# The framework performs some cleanup tasks after each component. This
92# means that components can assume that the working directory is in a
93# cleaned-up state, and don't need to perform the cleanup themselves.
94# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010095# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010096# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010097# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
98# `tests/Makefile` and `programs/fuzz/Makefile` from git.
99# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100100#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100101# The tests are roughly in order from fastest to slowest. This doesn't
102# have to be exact, but in general you should add slower tests towards
103# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100104
105
106
107################################################################
108#### Initialization and command line parsing
109################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100110
Gilles Peskine36647802020-03-28 18:50:49 +0100111# Abort on errors (even on the left-hand side of a pipe).
112# Treat uninitialised variables as errors.
113set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100114
Gilles Peskine076f7252022-08-30 21:02:44 +0200115# Enable ksh/bash extended file matching patterns
116shopt -s extglob
117
David Horstmann76a77382023-08-17 17:32:26 +0100118in_mbedtls_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100119 test -d include -a -d library -a -d programs -a -d tests
120}
121
Ronald Cron070e8652023-10-09 10:25:45 +0200122in_tf_psa_crypto_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100123 test -d include -a -d core -a -d drivers -a -d programs -a -d tests
David Horstmann9a6c45b2023-07-14 12:30:00 +0100124}
125
Gilles Peskine8f073122018-11-27 15:58:47 +0100126pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200127 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
128 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100129 exit 1
130 fi
131}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100132
Gilles Peskine8f073122018-11-27 15:58:47 +0100133pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100134 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100135 CONFIG_H='include/mbedtls/mbedtls_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100136 else
137 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100138 fi
John Durkopbd069d32020-10-31 22:14:03 -0700139 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100140 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200141
142 # Files that are clobbered by some jobs will be backed up. Use a different
143 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
144 # independently decide when to remove the backup file.
145 backup_suffix='.all.bak'
146 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100147 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100148 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100149 # Files clobbered by in-tree cmake
150 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
151 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200152
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200153 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100154 MEMORY=0
155 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200156 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100157 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100158
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200159 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200160 #
161 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
162 # both values are kept in sync. If you change the value here because it
163 # breaks some tests, you'll definitely want to change it in
164 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200165 RELEASE_SEED=1
166
Yanray Wang18040ed2023-11-23 21:29:56 +0800167 # Specify character collation for regular expressions and sorting with C locale
168 export LC_COLLATE=C
169
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200170 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200171 : ${MBEDTLS_TEST_PLATFORM="$(uname -s | tr -c \\n0-9A-Za-z _)-$(uname -m | tr -c \\n0-9A-Za-z _)"}
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200172 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200173 export MBEDTLS_TEST_PLATFORM
174
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000175 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100176 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100177 : ${OPENSSL_NEXT:="$OPENSSL"}
178 : ${GNUTLS_CLI:="gnutls-cli"}
179 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100180 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
181 : ${ARMC5_BIN_DIR:=/usr/bin}
182 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200183 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200184 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100185 : ${CLANG_LATEST:="clang-latest"}
186 : ${CLANG_EARLIEST:="clang-earliest"}
187 : ${GCC_LATEST:="gcc-latest"}
188 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100189 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000190 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200191 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100192 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000193 # if CC is not set, use clang by default (if present) to improve build times
194 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000195 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000196 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000197
Ronald Cronc5e81d22024-04-02 14:39:53 +0200198 if [ -n "${OPENSSL_3+set}" ]; then
199 export OPENSSL_NEXT="$OPENSSL_3"
200 fi
201
Gilles Peskine396853a2021-09-20 18:57:55 +0200202 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000203 export CTEST_OUTPUT_ON_FAILURE=1
204
Gilles Peskine8fd59422019-10-21 17:11:33 +0200205 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100206 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200207 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000208 # Normally, tests should use this compiler for ASAN testing
209 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200210
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400211 # Platform tests have an allocation that returns null
212 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400213 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400214
Gilles Peskine878cf602019-01-06 20:50:38 +0000215 # Gather the list of available components. These are the functions
216 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100217 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000218
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000219 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100220 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100221}
Andres AG38495a32016-07-12 16:54:33 +0100222
Dave Rodgman21900632024-02-26 11:41:19 +0000223setup_quiet_wrappers()
224{
225 # Pick up "quiet" wrappers for make and cmake, which don't output very much
226 # unless there is an error. This reduces logging overhead in the CI.
227 #
228 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000229 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
230 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000231 fi
232}
233
Gilles Peskinea28db922019-01-10 00:05:18 +0100234# Test whether the component $1 is included in the command line patterns.
235is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100236{
Gilles Peskine03af6782021-08-06 11:35:17 +0200237 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
238 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100239 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000240 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100241 set +f
242 case ${1#component_} in $pattern) return 0;; esac
243 done
244 set +f
245 return 1
246}
Andres AG7770ea82016-10-10 15:46:20 +0100247
Simon Butcher41eeccf2016-09-07 00:07:09 +0100248usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100249{
Gilles Peskine709346a2017-12-10 23:43:39 +0100250 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100251Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100252Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100253By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100254COMPONENT can be the name of a component or a shell wildcard pattern.
255
256Examples:
257 $0 "check_*"
258 Run all sanity checks.
259 $0 --no-armcc --except test_memsan
260 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100261
262Special options:
263 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000264 --list-all-components List all available test components and exit.
265 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100266
267General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200268 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100269 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100270 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100271 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200272 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200273 --arm-none-eabi-gcc-prefix=<string>
274 Prefix for a cross-compiler for arm-none-eabi
275 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200276 --arm-linux-gnueabi-gcc-prefix=<string>
277 Prefix for a cross-compiler for arm-linux-gnueabi
278 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100279 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200280 --restore First clean up the build tree, restoring backed up
281 files. Do not run any components unless they are
282 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100283 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200284 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100285 --except Exclude the COMPONENTs listed on the command line,
286 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200287 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100288 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100289 --no-force Refuse to overwrite modified files (default).
290 --no-keep-going Stop at the first error (default).
291 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800292 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100293 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200294 --outcome-file=<path> File where test outcomes are written (not done if
295 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100296 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200297 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100298 -s|--seed Integer seed value to use for this test run.
299
300Tool path options:
301 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
302 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100303 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
304 --clang-latest=<Clang_latest_path> Latest version of clang available
305 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
306 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100307 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
308 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100309 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100310 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100311EOF
SimonB2e23c822016-04-16 21:54:39 +0100312}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100313
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200314# Cleanup before/after running a component.
315# Remove built files as well as the cmake cache/config.
316# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100317cleanup()
318{
David Horstmann76a77382023-08-17 17:32:26 +0100319 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100320 command make clean
321 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200322
Gilles Peskine31b07e22018-03-21 12:15:06 +0100323 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000324 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100325 -iname CMakeFiles -exec rm -rf {} \+ -o \
326 \( -iname cmake_install.cmake -o \
327 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200328 -iname CMakeCache.txt -o \
329 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100330 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200331 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200332
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100333 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
334 rm -rf programs/test/cmake_subproject/build
335 rm -f programs/test/cmake_subproject/Makefile
336 rm -f programs/test/cmake_subproject/cmake_subproject
337
Chris Kayd259e342021-03-25 16:03:25 +0000338 # Remove any artifacts from the component_test_cmake_as_package test.
339 rm -rf programs/test/cmake_package/build
340 rm -f programs/test/cmake_package/Makefile
341 rm -f programs/test/cmake_package/cmake_package
342
343 # Remove any artifacts from the component_test_cmake_as_installed_package test.
344 rm -rf programs/test/cmake_package_install/build
345 rm -f programs/test/cmake_package_install/Makefile
346 rm -f programs/test/cmake_package_install/cmake_package_install
347
Gilles Peskinef83eb822020-03-30 20:11:39 +0200348 # Restore files that may have been clobbered by the job
349 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200350 if [[ -e "$x$backup_suffix" ]]; then
351 cp -p "$x$backup_suffix" "$x"
352 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200353 done
354}
John Durkopbd069d32020-10-31 22:14:03 -0700355
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200356# Final cleanup when this script exits (except when exiting on a failure
357# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200358final_cleanup () {
359 cleanup
360
361 for x in $files_to_back_up; do
362 rm -f "$x$backup_suffix"
363 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100364}
365
Gilles Peskine7c652162017-12-11 00:01:40 +0100366# Executed on exit. May be redefined depending on command line options.
367final_report () {
368 :
369}
370
371fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200372 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100373 final_report $1
374 trap - $1
375 kill -$1 $$
376}
377
378trap 'fatal_signal HUP' HUP
379trap 'fatal_signal INT' INT
380trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200381
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200382# Number of processors on this machine. Used as the default setting
383# for parallel make.
384all_sh_nproc ()
385{
386 {
387 nproc || # Linux
388 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
389 sysctl -n hw.ncpu || # FreeBSD
390 echo 1
391 } 2>/dev/null
392}
393
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100394msg()
395{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100396 if [ -n "${current_component:-}" ]; then
397 current_section="${current_component#component_}: $1"
398 else
399 current_section="$1"
400 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200401
402 if [ $QUIET -eq 1 ]; then
403 return
404 fi
405
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100406 echo ""
407 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100408 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000409 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100410 echo "******************************************************************"
411}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100412
Gilles Peskine8f073122018-11-27 15:58:47 +0100413armc6_build_test()
414{
415 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100416
Gilles Peskine18487f62020-04-30 23:11:54 +0200417 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800418 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100419 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000420 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200421
422 msg "size: ARM Compiler 6 ($FLAGS)"
423 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100424}
Andres AGa5cd9732016-10-17 15:23:10 +0100425
Andres AGd9eba4b2016-08-26 14:42:14 +0100426err_msg()
427{
428 echo "$1" >&2
429}
430
431check_tools()
432{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200433 for tool in "$@"; do
434 if ! `type "$tool" >/dev/null 2>&1`; then
435 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100436 exit 1
437 fi
438 done
439}
440
Gilles Peskine8f073122018-11-27 15:58:47 +0100441pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000442 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100443 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100444 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100445 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200446 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000447 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100448
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000449 # Note that legacy options are ignored instead of being omitted from this
450 # list of options, so invocations that worked with previous version of
451 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100452 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100453 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200454 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200455 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200456 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000457 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100458 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
459 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100460 --clang-earliest) shift; CLANG_EARLIEST="$1";;
461 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100462 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000463 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100464 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100465 --gcc-earliest) shift; GCC_EARLIEST="$1";;
466 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100467 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200468 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
469 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100470 --gnutls-serv) shift; GNUTLS_SERV="$1";;
471 --help|-h) usage; exit;;
472 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000473 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100474 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100475 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200476 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000477 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --no-force) FORCE=0;;
479 --no-keep-going) KEEP_GOING=0;;
480 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200481 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100482 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200484 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100485 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200486 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100487 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200488 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200489 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100490 --seed|-s) shift; SEED="$1";;
491 -*)
492 echo >&2 "Unknown option: $1"
493 echo >&2 "Run $0 --help for usage."
494 exit 120
495 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000496 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100497 esac
498 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100499 done
SimonB2e23c822016-04-16 21:54:39 +0100500
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100501 # Exclude components that are not supported on this platform.
502 SUPPORTED_COMPONENTS=
503 for component in $ALL_COMPONENTS; do
504 case $(type "support_$component" 2>&1) in
505 *' function'*)
506 if ! support_$component; then continue; fi;;
507 esac
508 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
509 done
510
511 if [ $list_components -eq 1 ]; then
512 printf '%s\n' $SUPPORTED_COMPONENTS
513 exit
514 fi
515
Gilles Peskinea28db922019-01-10 00:05:18 +0100516 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200517 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000518 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100519 fi
520
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000521 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
522 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100523 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000524 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100525 fi
SimonB2e23c822016-04-16 21:54:39 +0100526
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200527 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100528 if [ $all_except -eq 0 ]; then
529 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200530 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
531 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200532 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100533 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200534 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200535 # If the requested name includes a wildcard character, don't
536 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100537 case $component in
538 *[*?\[]*) continue;;
539 esac
540 case " $SUPPORTED_COMPONENTS " in
541 *" $component "*) :;;
542 *)
543 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
544 unsupported=$((unsupported + 1));;
545 esac
546 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200547 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100548 if [ $unsupported -ne 0 ]; then
549 exit 2
550 fi
551 fi
552
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000553 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100554 RUN_COMPONENTS=
555 for component in $SUPPORTED_COMPONENTS; do
556 if is_component_included "$component"; [ $? -eq $all_except ]; then
557 RUN_COMPONENTS="$RUN_COMPONENTS $component"
558 fi
559 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000560
561 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000562 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100563}
SimonB2e23c822016-04-16 21:54:39 +0100564
Gilles Peskine8f073122018-11-27 15:58:47 +0100565pre_check_git () {
566 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100567 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100568 git checkout-index -f -q $CONFIG_H
569 cleanup
570 else
SimonB2e23c822016-04-16 21:54:39 +0100571
Gilles Peskine8f073122018-11-27 15:58:47 +0100572 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
573 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
574 echo "You can either delete this directory manually, or force the test by rerunning"
575 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
576 exit 1
577 fi
578
Ronald Cron7a93ac52023-07-20 09:49:12 +0200579 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100580 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100581 echo "You can either delete or preserve your work, or force the test by rerunning the"
582 echo "script as: $0 --force"
583 exit 1
584 fi
SimonB2e23c822016-04-16 21:54:39 +0100585 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500586}
587
Gilles Peskine568f53a2021-07-12 18:16:01 +0200588pre_restore_files () {
589 # If the makefiles have been generated by a framework such as cmake,
590 # restore them from git. If the makefiles look like modifications from
591 # the ones checked into git, take care not to modify them. Whatever
592 # this function leaves behind is what the script will restore before
593 # each component.
594 case "$(head -n1 Makefile)" in
595 *[Gg]enerated*)
596 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
597 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
598 ;;
599 esac
600}
601
Gilles Peskinef83eb822020-03-30 20:11:39 +0200602pre_back_up () {
603 for x in $files_to_back_up; do
604 cp -p "$x" "$x$backup_suffix"
605 done
606}
607
Gilles Peskine8f073122018-11-27 15:58:47 +0100608pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100609 failure_count=0 # Number of failed components
610 last_failure_status=0 # Last failure status in this component
611
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100612 # See err_trap
613 previous_failure_status=0
614 previous_failed_command=
615 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100616 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100617
Gilles Peskine7c652162017-12-11 00:01:40 +0100618 start_red=
619 end_color=
620 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100621 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100622 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
623 start_red=$(printf '\033[31m')
624 end_color=$(printf '\033[0m')
625 ;;
626 esac
627 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100628
629 # Keep a summary of failures in a file. We'll print it out at the end.
630 failure_summary_file=$PWD/all-sh-failures-$$.log
631 : >"$failure_summary_file"
632
633 # Whether it makes sense to keep a component going after the specified
634 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200635 # This function normally receives the failing simple command
636 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
637 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100638 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200639 # False positives result in running things that can't be expected to
640 # work. False negatives result in things not running after something else
641 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100642 can_keep_going_after_failure () {
643 case "$1" in
644 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200645 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100646 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200647 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
648 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
649 *make*check*) true;;
650 "grep "*) true;;
651 "[ "*) true;;
652 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100653 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100654 esac
655 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100656
657 # This function runs if there is any error in a component.
658 # It must either exit with a nonzero status, or set
659 # last_failure_status to a nonzero value.
660 err_trap () {
661 # Save $? (status of the failing command). This must be the very
662 # first thing, before $? is overridden.
663 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100664 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100665
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100666 if [[ $last_failure_status -eq $previous_failure_status &&
667 "$failed_command" == "$previous_failed_command" &&
668 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
669 then
670 # The same command failed twice in a row, but this time one level
671 # less deep in the function call stack. This happens when the last
672 # command of a function returns a nonzero status, and the function
673 # returns that same status. Ignore the second failure.
674 previous_failure_funcall_depth=${#FUNCNAME[@]}
675 return
676 fi
677 previous_failure_status=$last_failure_status
678 previous_failed_command=$failed_command
679 previous_failure_funcall_depth=${#FUNCNAME[@]}
680
Gilles Peskinece266c42020-03-28 18:50:43 +0100681 text="$current_section: $failed_command -> $last_failure_status"
682 echo "${start_red}^^^^$text^^^^${end_color}" >&2
683 echo "$text" >>"$failure_summary_file"
684
685 # If the command is fatal (configure or build command), stop this
686 # component. Otherwise (test command) keep the component running
687 # (run more tests from the same build).
688 if ! can_keep_going_after_failure "$failed_command"; then
689 exit $last_failure_status
690 fi
691 }
692
Gilles Peskine7c652162017-12-11 00:01:40 +0100693 final_report () {
694 if [ $failure_count -gt 0 ]; then
695 echo
696 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100697 echo "${start_red}FAILED: $failure_count components${end_color}"
698 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100699 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
700 elif [ -z "${1-}" ]; then
701 echo "SUCCESS :)"
702 fi
703 if [ -n "${1-}" ]; then
704 echo "Killed by SIG$1."
705 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100706 rm -f "$failure_summary_file"
707 if [ $failure_count -gt 0 ]; then
708 exit 1
709 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100710 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100711}
712
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200713# record_status() and if_build_succeeded() are kept temporarily for backward
714# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100715record_status () {
716 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100717}
Gilles Peskine7c652162017-12-11 00:01:40 +0100718if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100719 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100720}
721
Gilles Peskinea681c592020-03-28 21:27:40 +0100722# '! true' does not trigger the ERR trap. Arrange to trigger it, with
723# a reasonably informative error message (not just "$@").
724not () {
725 if "$@"; then
726 report_failed_command="! $*"
727 false
728 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200729 fi
730}
731
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200732pre_prepare_outcome_file () {
733 case "$MBEDTLS_TEST_OUTCOME_FILE" in
734 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
735 esac
736 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
737 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
738 fi
739}
740
Gilles Peskine8f073122018-11-27 15:58:47 +0100741pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200742 if [ $QUIET -eq 1 ]; then
743 return
744 fi
745
Gilles Peskine8f073122018-11-27 15:58:47 +0100746 msg "info: $0 configuration"
747 echo "MEMORY: $MEMORY"
748 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200749 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100750 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100751 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100752 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100753 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
754 echo "GNUTLS_CLI: $GNUTLS_CLI"
755 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100756 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
757 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
758}
Andres AG7770ea82016-10-10 15:46:20 +0100759
Andres AGd9eba4b2016-08-26 14:42:14 +0100760# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100761pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000762 # Build the list of variables to pass to output_env.sh.
763 set env
SimonB2e23c822016-04-16 21:54:39 +0100764
Gilles Peskine87964262019-01-06 22:40:00 +0000765 case " $RUN_COMPONENTS " in
766 # Require OpenSSL and GnuTLS if running any tests (as opposed to
767 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
768 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100769 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000770 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
771 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100772 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000773 export GNUTLS_CLI="$GNUTLS_CLI"
774 export GNUTLS_SERV="$GNUTLS_SERV"
775 # Avoid passing --seed flag in every call to ssl-opt.sh
776 if [ -n "${SEED-}" ]; then
777 export SEED
778 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200779 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000780 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200781 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
782 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000783 ;;
784 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200785
Gilles Peskine87964262019-01-06 22:40:00 +0000786 case " $RUN_COMPONENTS " in
787 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
788 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100789
Gilles Peskine87964262019-01-06 22:40:00 +0000790 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200791 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000792 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100793
Gilles Peskine87964262019-01-06 22:40:00 +0000794 case " $RUN_COMPONENTS " in
795 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
796 esac
797
798 case " $RUN_COMPONENTS " in
799 *" test_zeroize "*) check_tools "gdb";;
800 esac
801
802 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000803 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000804 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
805 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200806 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000807 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
808 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200809 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
810 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
811 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000812 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000813
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200814 # past this point, no call to check_tool, only printing output
815 if [ $QUIET -eq 1 ]; then
816 return
817 fi
818
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000819 msg "info: output_env.sh"
820 case $RUN_COMPONENTS in
821 *_armcc*)
822 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
823 *) set "$@" RUN_ARMCC=0;;
824 esac
825 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100826}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100827
Gilles Peskine1570b592021-04-22 01:10:12 +0200828pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200829 # since make doesn't have proper dependencies, remove any possibly outdate
830 # file that might be around before generating fresh ones
831 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200832 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200833 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200834 else
835 make generated_files
836 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200837}
838
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000839clang_version() {
840 if command -v clang > /dev/null ; then
841 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
842 else
843 echo 0 # report version 0 for "no clang"
844 fi
845}
846
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200847################################################################
848#### Helpers for components using libtestdriver1
849################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100850
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200851# How to use libtestdriver1
852# -------------------------
853#
854# 1. Define the list algorithms and key types to accelerate,
855# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
856# Examples:
857# - loc_accel_list="ALG_JPAKE"
858# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200859# 2. Make configurations changes for the driver and/or main libraries.
860# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
861# can be either "default" to start with the default config, or a name
862# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200863# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200864# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
865# These changes affect both the driver and the main libraries.
866# (Note: they need to have the same set of PSA_WANT symbols, as that
867# determines the ABI between them.)
868# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
869# main libraries. Typically, you want to disable the module(s) that are
870# being accelerated. You may need to also disable modules that depend
871# on them or options that are not supported with drivers.
872# 2d. On top of psa/crypto_config.h, the driver library uses its own config
873# file: tests/include/test/drivers/config_test_driver.h. You usually
874# don't need to edit it: using loc_extra_list (see below) is preferred.
875# However, when there's no PSA symbol for what you want to enable,
876# calling scripts/config.py on this file remains the only option.
877# 3. Build the driver library, then the main libraries, test, and programs.
878# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
879# need to enable more algorithms here, typically hash algorithms when
880# accelerating some signature algorithms (ECDSA, RSAv2). This is done
881# by passing a 2nd argument listing the extra algorithms.
882# Example:
883# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
884# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800885# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200886# additional arguments will be passed to make: this can be useful if
887# you don't want to build everything when iterating during development.
888# Example:
889# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
890# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200891
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200892# Adjust the configuration - for both libtestdriver1 and main library,
893# as they should have the same PSA_WANT macros.
894helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200895 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200896 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200897 if [ "$base_config" != "default" ]; then
898 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200899 fi
900
901 # Enable PSA-based config (necessary to use drivers)
902 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
903
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200904 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
905 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
906 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000907
908 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
909 # otherwise we will end up running multithreaded tests without mutexes to protect them.
910 if scripts/config.py get MBEDTLS_THREADING_C; then
911 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
912 fi
913
914 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
915 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
916 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200917}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100918
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100919# Build the drivers library libtestdriver1.a (with ASan).
920#
921# Parameters:
922# 1. a space-separated list of things to accelerate;
923# 2. optional: a space-separate list of things to also support.
924# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
925helper_libtestdriver1_make_drivers() {
926 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
927 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
928}
929
930# Build the main libraries, programs and tests,
931# linking to the drivers library (with ASan).
932#
933# Parameters:
934# 1. a space-separated list of things to accelerate;
935# *. remaining arguments if any are passed directly to make
936# (examples: lib, -C tests test_suite_xxx, etc.)
937# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
938helper_libtestdriver1_make_main() {
939 loc_accel_list=$1
940 shift
941
942 # we need flags both with and without the LIBTESTDRIVER1_ prefix
943 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
944 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
945 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include -I../tests -I../../tests -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_TEST_LIBTESTDRIVER1 $loc_accel_flags" LDFLAGS="-ltestdriver1 $ASAN_CFLAGS" "$@"
946}
947
Valerio Settid1b6ef12024-05-07 16:00:21 +0200948# $1: target which can be "client" or "server"
949helper_crypto_client_build() {
950 TARGET=$1
Valerio Settic98f8ab2024-05-10 15:53:40 +0200951 shift
Valerio Settid1b6ef12024-05-07 16:00:21 +0200952 TARGET_LIB=libpsa$TARGET
953
Valerio Settid1b6ef12024-05-07 16:00:21 +0200954 if [ "$TARGET" == "client" ]; then
955 scripts/config.py full
956 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
957 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
958 # Dynamic secure element support is a deprecated feature and it is not
959 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
960 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
961 # Disable potentially problematic features
962 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
963 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
964 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
965 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
966 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
967 else
968 scripts/config.py crypto_full
969 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
970 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Setticd89c1f2024-05-10 11:21:04 +0200971 # scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
Valerio Settidde95792024-05-10 05:22:33 +0200972 # Disable NV_SEED as the MBEDTLS_PLATFORM_STD_NV_SEED_FILE is not in
973 # right path for mbedtls_platform_std_nv_seed_read(). Just rely on
974 # mbedtls_platform_entropy_poll() as entropy source().
975 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
976 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Valerio Settid1b6ef12024-05-07 16:00:21 +0200977 fi
978
Valerio Settif57afd52024-05-14 10:39:20 +0200979 make -C tests/psa-client-server/psasim/ CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
Valerio Settid1b6ef12024-05-07 16:00:21 +0200980
Valerio Settif57afd52024-05-14 10:39:20 +0200981 # cleanup() will restore some backed-up files which include $CONFIG_H and
982 # $CRYPTO_CONFIG_H. Built libraries were already copied to psasim at this
983 # point.
984 cleanup
Valerio Settid1b6ef12024-05-07 16:00:21 +0200985}
986
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100987################################################################
988#### Configuration helpers
989################################################################
990
Valerio Settib2fd6732023-08-15 17:10:47 +0200991# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200992# The function optionally accepts 1 parameter: a space-separated list of the
993# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200994helper_disable_builtin_curves() {
995 allowed_list="${1:-}"
996 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
997
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200998 for curve in $allowed_list; do
999 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +02001000 done
1001}
1002
1003# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1004# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1005# in the following helpers.
1006helper_get_psa_curve_list () {
1007 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001008 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1009 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001010 done
1011
1012 echo "$loc_list"
1013}
1014
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001015# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1016# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1017# in the following helpers.
1018helper_get_psa_dh_group_list () {
1019 loc_list=""
1020 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1021 loc_list="$loc_list $item"
1022 done
1023
1024 echo "$loc_list"
1025}
1026
Valerio Settib2fd6732023-08-15 17:10:47 +02001027# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001028# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001029# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001030helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001031 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001032 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001033 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 +02001034 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1035 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001036 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1037 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001038 fi
1039 done
1040
1041 echo "$loc_list"
1042}
1043
Gilles Peskine192c72f2017-12-21 15:59:21 +01001044################################################################
1045#### Basic checks
1046################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001047
1048#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001049# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001050#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001051# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001052# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001053# 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 +02001054# time, so start with a GCC build).
1055# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001056#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001057# Indicative running times are given for reference.
1058
Gilles Peskine8f073122018-11-27 15:58:47 +01001059component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001060 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001061 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001062}
Janos Follathb72c6782016-07-19 14:54:17 +01001063
Gilles Peskine67debb62021-05-18 16:09:50 +02001064component_check_generated_files () {
1065 msg "Check: check-generated-files, files generated with make" # 2s
1066 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001067 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001068
1069 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001070 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001071 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001072 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001073
1074 msg "Check: check-generated-files -u, files absent" # 2s
1075 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001076 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001077 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001078 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001079
1080 # This component ends with the generated files present in the source tree.
1081 # This is necessary for subsequent components!
1082}
1083
Gilles Peskine8f073122018-11-27 15:58:47 +01001084component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001085 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001086 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001087}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001088
Gilles Peskine8f073122018-11-27 15:58:47 +01001089component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001090 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001091 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001092}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001093
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001094component_check_changelog () {
1095 msg "Check: changelog entries" # < 1s
1096 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001097 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001098 if [ -e ChangeLog.new ]; then
1099 # Show the diff for information. It isn't an error if the diff is
1100 # non-empty.
1101 diff -u ChangeLog ChangeLog.new || true
1102 rm ChangeLog.new
1103 fi
1104}
1105
Gilles Peskine8f073122018-11-27 15:58:47 +01001106component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001107 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001108 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001109}
Darryl Greena07039c2018-03-13 16:48:16 +00001110
Gilles Peskine895868b2019-09-19 21:30:05 +02001111component_check_test_cases () {
1112 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001113 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001114 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001115 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001116 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001117 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001118 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001119 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001120}
1121
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001122component_check_test_dependencies () {
1123 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001124 # The purpose of this component is to catch unjustified dependencies on
1125 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1126 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1127 # MBEDTLS_PSA_xxx).
1128 #
1129 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1130 # this component is meant to catch. However a few of them are justified,
1131 # mostly by the absence of a PSA equivalent, so this component includes a
1132 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001133
1134 found="check-test-deps-found-$$"
1135 expected="check-test-deps-expected-$$"
1136
1137 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001138 grep 'depends_on' \
1139 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001140 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001141 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001142 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001143
Yanray Wang18040ed2023-11-23 21:29:56 +08001144 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001145 rm -f $expected
1146 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1147 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001148 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1149 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001150 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1151 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001152 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1153 # the test code and that's probably the most convenient way of achieving
1154 # the test's goal.
1155 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1156 # No PSA equivalent - we should probably have one in the future.
1157 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1158 # No PSA equivalent - needed by some init tests
1159 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001160 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001161 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001162
1163 # Compare reality with expectation.
1164 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001165 #
1166 # The output should be empty. When it's not:
1167 # - Each '+' line is a macro that was found but not expected. You want to
1168 # find where that macro occurs, and either replace it with PSA macros, or
1169 # add it to the exceptions list above with a justification.
1170 # - Each '-' line is a macro that was expected but not found; it means the
1171 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001172 diff -U0 $expected $found
1173
1174 rm $found $expected
1175}
1176
Gilles Peskine8f073122018-11-27 15:58:47 +01001177component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001178 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001179 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001180}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001181
Gilles Peskine192c72f2017-12-21 15:59:21 +01001182
Gilles Peskine636c26a2020-03-04 20:46:15 +01001183
Gilles Peskine192c72f2017-12-21 15:59:21 +01001184################################################################
1185#### Build and test many configurations and targets
1186################################################################
1187
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001188component_test_default_out_of_box () {
1189 msg "build: make, default config (out-of-box)" # ~1min
1190 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001191 # Disable fancy stuff
1192 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001193
1194 msg "test: main suites make, default config (out-of-box)" # ~10s
1195 make test
1196
1197 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001198 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001199
1200 msg "program demos: make, default config (out-of-box)" # ~10s
1201 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001202}
1203
Gilles Peskine8f073122018-11-27 15:58:47 +01001204component_test_default_cmake_gcc_asan () {
1205 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001206 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1207 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001208
Gilles Peskine8f073122018-11-27 15:58:47 +01001209 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1210 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001211
Gilles Peskine82b27272019-06-14 18:27:03 +02001212 msg "program demos (ASan build)" # ~10s
1213 tests/scripts/run_demos.py
1214
Gilles Peskine97bea012020-04-23 23:37:45 +02001215 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001216 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001217
Gilles Peskine6848d172023-11-02 19:58:03 +01001218 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001219 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001220
Gilles Peskine8f073122018-11-27 15:58:47 +01001221 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001222 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001223
Gilles Peskine8f073122018-11-27 15:58:47 +01001224 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001225 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001226
1227 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001228 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001229}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001230
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001231component_test_default_cmake_gcc_asan_new_bignum () {
1232 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001233 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001234 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001235 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001236
1237 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1238 make test
1239
1240 msg "test: selftest (ASan build)" # ~ 10s
1241 programs/test/selftest
1242
1243 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1244 tests/ssl-opt.sh
1245
1246 msg "test: compat.sh (ASan build)" # ~ 6 min
1247 tests/compat.sh
1248
1249 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1250 tests/context-info.sh
1251}
1252
Hanno Becker01635512019-02-26 14:27:09 +00001253component_test_full_cmake_gcc_asan () {
1254 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001255 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001256 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1257 make
1258
1259 msg "test: main suites (inc. selftests) (full config, ASan build)"
1260 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001261
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001262 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001263 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001264
Gilles Peskine636c26a2020-03-04 20:46:15 +01001265 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001266 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001267
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001268 # Note: the next two invocations cover all compat.sh test cases.
1269 # We should use the same here and in basic-build-test.sh.
1270 msg "test: compat.sh: default version (full config, ASan build)"
1271 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001272
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001273 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1274 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001275
1276 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001277 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001278}
1279
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001280
1281component_test_full_cmake_gcc_asan_new_bignum () {
1282 msg "build: full config, cmake, gcc, ASan"
1283 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001284 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001285 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001286 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001287
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001288 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001289 make test
1290
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001291 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001292 programs/test/selftest
1293
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001294 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001295 tests/ssl-opt.sh
1296
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001297 # Note: the next two invocations cover all compat.sh test cases.
1298 # We should use the same here and in basic-build-test.sh.
1299 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1300 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001301
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001302 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1303 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001304
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001305 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001306 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001307}
1308
Ronald Cronc3623db2020-10-29 10:51:32 +01001309component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001310 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001311 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001312 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1313 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1314 make
1315
1316 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1317 make test
1318}
1319
David Horstmann4a48bec2024-03-13 15:42:31 +00001320component_test_psa_assume_exclusive_buffers () {
1321 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001322 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001323 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001324 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1325 make
1326
David Horstmann4a48bec2024-03-13 15:42:31 +00001327 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001328 make test
1329}
1330
Gilles Peskinea3548672021-06-17 11:37:52 +02001331# check_renamed_symbols HEADER LIB
1332# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1333# name is LIB.
1334check_renamed_symbols () {
1335 ! nm "$2" | sed 's/.* //' |
1336 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1337}
1338
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001339component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001340 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001341 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001342 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1343 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1344 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1345 # We can only compile, not link, since our test and sample programs
1346 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1347 # is active.
1348 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001349
1350 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1351 # version is not present.
1352 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001353 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001354}
1355
Valerio Setti63097752024-03-12 13:18:13 +01001356# Get a list of library-wise undefined symbols and ensure that they only
1357# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1358# This function is a common helper used by both:
1359# - component_test_default_psa_crypto_client_without_crypto_provider
1360# - component_build_full_psa_crypto_client_without_crypto_provider.
1361common_check_mbedtls_missing_symbols() {
1362 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1363 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1364 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1365 not grep mbedtls_ linking_errors.txt
1366
1367 rm sym_def.txt sym_undef.txt linking_errors.txt
1368}
1369
1370component_test_default_psa_crypto_client_without_crypto_provider () {
1371 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1372
Ronald Cron336678b2021-01-28 17:54:24 +01001373 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1374 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001375 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001376 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001377 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001378 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001379
Ronald Cron336678b2021-01-28 17:54:24 +01001380 make
1381
Valerio Setti63097752024-03-12 13:18:13 +01001382 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1383 common_check_mbedtls_missing_symbols
1384
1385 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001386 make test
1387}
1388
Valerio Setti63097752024-03-12 13:18:13 +01001389component_build_full_psa_crypto_client_without_crypto_provider () {
1390 msg "build: full config - PSA_CRYPTO_C"
1391
1392 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1393 scripts/config.py full
1394
1395 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1396 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1397 # Dynamic secure element support is a deprecated feature and it is not
1398 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1399 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1400
1401 # Since there is no crypto provider in this build it is not possible to
1402 # build all the test executables and progrems due to missing PSA functions
1403 # at link time. Therefore we will just build libraries and we'll check
1404 # that symbols of interest are there.
1405 make lib
1406
1407 msg "check missing symbols: full config - PSA_CRYPTO_C"
1408
1409 common_check_mbedtls_missing_symbols
1410
1411 # Ensure that desired functions are included into the build (extend the
1412 # following list as required).
1413 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1414 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1415 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1416}
1417
Ryan Everettdaa322a2024-04-18 16:48:55 +01001418component_test_no_rsa_key_pair_generation() {
1419 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001420 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001421 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001422 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001423 make
1424
Ryan Everettdaa322a2024-04-18 16:48:55 +01001425 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001426 make test
1427}
1428
Gilles Peskine782f4112018-11-27 16:11:09 +01001429component_test_ref_configs () {
1430 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001431 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1432 # want to re-generate generated files that depend on it, quite correctly.
1433 # However this doesn't work as the generation script expects a specific
1434 # format for mbedtls_config.h, which the other files don't follow. Also,
1435 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001436 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001437 # whether they're on or off. So, disable cmake's (over-sensitive here)
1438 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001439 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001440 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001441 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001442}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001443
Gilles Peskine8f073122018-11-27 15:58:47 +01001444component_test_no_renegotiation () {
1445 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001446 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001447 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001448 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001449
Gilles Peskine8f073122018-11-27 15:58:47 +01001450 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1451 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001452
Gilles Peskine8f073122018-11-27 15:58:47 +01001453 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001454 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001455}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001456
Gilles Peskine636c26a2020-03-04 20:46:15 +01001457component_test_no_pem_no_fs () {
1458 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1459 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1460 scripts/config.py unset MBEDTLS_FS_IO
1461 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1462 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001463 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001464 make
1465
1466 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1467 make test
1468
1469 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001470 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001471}
1472
Gilles Peskine8f073122018-11-27 15:58:47 +01001473component_test_rsa_no_crt () {
1474 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001475 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001476 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001477 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001478
Gilles Peskine8f073122018-11-27 15:58:47 +01001479 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1480 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001481
Gilles Peskine8f073122018-11-27 15:58:47 +01001482 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001483 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001484
Gilles Peskine8f073122018-11-27 15:58:47 +01001485 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001486 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001487
1488 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001489 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001490}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001491
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001492component_test_no_ctr_drbg_classic () {
1493 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001494 scripts/config.py full
1495 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001496 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001497 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001498
Dave Rodgman17127e92023-12-14 16:42:48 +00001499 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001500 make
1501
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001502 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001503 make test
1504
Gilles Peskineba749042021-01-13 20:02:03 +01001505 # In this configuration, the TLS test programs use HMAC_DRBG.
1506 # The SSL tests are slow, so run a small subset, just enough to get
1507 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001508 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001509 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001510
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001511 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001512 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001513}
1514
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001515component_test_no_ctr_drbg_use_psa () {
1516 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001517 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001518 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1519 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001520
Dave Rodgman17127e92023-12-14 16:42:48 +00001521 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001522 make
1523
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001524 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1525 make test
1526
1527 # In this configuration, the TLS test programs use HMAC_DRBG.
1528 # The SSL tests are slow, so run a small subset, just enough to get
1529 # confidence that the SSL code copes with HMAC_DRBG.
1530 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001531 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001532
1533 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001534 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001535}
1536
1537component_test_no_hmac_drbg_classic () {
1538 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1539 scripts/config.py full
1540 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1541 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1542 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001543 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001544
Dave Rodgman17127e92023-12-14 16:42:48 +00001545 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001546 make
1547
1548 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001549 make test
1550
Gilles Peskinea2224342020-11-19 22:14:34 +01001551 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1552 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1553 # instead.
1554 # Test SSL with non-deterministic ECDSA. Only test features that
1555 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001556 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001557 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001558
1559 # To save time, only test one protocol version, since this part of
1560 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001561 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001562 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001563}
1564
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001565component_test_no_hmac_drbg_use_psa () {
1566 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1567 scripts/config.py full
1568 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1569 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1570 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1571
Dave Rodgman17127e92023-12-14 16:42:48 +00001572 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001573 make
1574
1575 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1576 make test
1577
1578 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1579 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1580 # instead.
1581 # Test SSL with non-deterministic ECDSA. Only test features that
1582 # might be affected by how ECDSA signature is performed.
1583 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001584 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001585
1586 # To save time, only test one protocol version, since this part of
1587 # the protocol is identical in (D)TLS up to 1.2.
1588 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001589 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001590}
1591
1592component_test_psa_external_rng_no_drbg_classic () {
1593 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1594 scripts/config.py full
1595 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001596 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001597 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001598 scripts/config.py unset MBEDTLS_ENTROPY_C
1599 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1600 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001601 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1602 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1603 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001604 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1605 # the SSL test programs don't have an RNG and can't work. Explicitly
1606 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001607 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001608
1609 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1610 make test
1611
Gilles Peskine8eb29432021-02-03 20:07:11 +01001612 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001613 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001614}
1615
1616component_test_psa_external_rng_no_drbg_use_psa () {
1617 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001618 scripts/config.py full
1619 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001620 scripts/config.py unset MBEDTLS_ENTROPY_C
1621 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1622 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001623 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1624 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1625 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001626 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001627
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001628 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001629 make test
1630
Gilles Peskine8eb29432021-02-03 20:07:11 +01001631 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001632 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001633}
1634
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001635component_test_psa_external_rng_use_psa_crypto () {
1636 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1637 scripts/config.py full
1638 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1639 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1640 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001641 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001642
1643 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1644 make test
1645
1646 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1647 tests/ssl-opt.sh -f 'Default\|opaque'
1648}
1649
Gilles Peskine801c4332023-04-28 21:04:28 +02001650component_test_psa_inject_entropy () {
1651 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1652 scripts/config.py full
1653 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1654 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1655 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1656 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1657 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1658 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001659 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 +02001660
1661 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1662 make test
1663}
1664
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001665component_test_sw_inet_pton () {
1666 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1667
1668 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1669 scripts/config.py set MBEDTLS_TEST_HOOKS
1670 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1671
1672 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1673 make test
1674}
1675
Valerio Settia41654d2024-02-08 10:33:11 +01001676component_full_no_pkparse_pkwrite() {
1677 msg "build: full without pkparse and pkwrite"
1678
1679 scripts/config.py crypto_full
1680 scripts/config.py unset MBEDTLS_PK_PARSE_C
1681 scripts/config.py unset MBEDTLS_PK_WRITE_C
1682
Valerio Settia41654d2024-02-08 10:33:11 +01001683 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1684
1685 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1686 not grep mbedtls_pk_parse_key library/pkparse.o
1687 not grep mbedtls_pk_write_key_der library/pkwrite.o
1688
1689 msg "test: full without pkparse and pkwrite"
1690 make test
1691}
1692
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001693component_test_crypto_full_md_light_only () {
1694 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001695 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001696 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001697 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001698 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001699 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001700 scripts/config.py unset MBEDTLS_HKDF_C
1701 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001702 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001703 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001704 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001705 # Disable things that would auto-enable MD_C
1706 scripts/config.py unset MBEDTLS_PKCS5_C
1707
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001708 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1709 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001710 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001711
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001712 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001713 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001714 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001715
1716 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001717 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001718}
1719
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001720component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001721 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001722 scripts/config.py full
1723 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001724 # Don't pull in cipher via PSA mechanisms
1725 # (currently ignored anyway because we completely disable PSA)
1726 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001727 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001728 scripts/config.py unset MBEDTLS_CMAC_C
1729 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001730 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001731 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001732 scripts/config.py unset MBEDTLS_SSL_TLS_C
1733 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001734 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001735 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1736 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001737 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001738 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001739 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001740
Valerio Settidf17a102023-10-23 14:14:19 +02001741 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001742 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001743}
1744
Valerio Setti7e710e82023-08-25 09:14:15 +02001745# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001746# - component_test_full_no_cipher_with_psa_crypto
1747# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001748# It accepts 2 input parameters:
1749# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1750# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001751common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001752 USE_CRYPTO_CONFIG="$1"
1753 COMPONENT_DESCRIPTION="$2"
1754
1755 msg "build: $COMPONENT_DESCRIPTION"
1756
1757 scripts/config.py full
1758 scripts/config.py unset MBEDTLS_CIPHER_C
1759
1760 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001761 # The built-in implementation of the following algs/key-types depends
1762 # on CIPHER_C so we disable them.
1763 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1764 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001765 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001766 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1767 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1768 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1769 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1770 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1771 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1772 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1773 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001774 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001775 else
1776 # Don't pull in cipher via PSA mechanisms
1777 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001778 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1779 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1780 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001781 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001782 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001783 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001784 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001785
Gilles Peskine21570cf2023-12-22 11:49:50 +01001786 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001787
Valerio Setti7e710e82023-08-25 09:14:15 +02001788 # Ensure that CIPHER_C was not re-enabled
1789 not grep mbedtls_cipher_init library/cipher.o
1790
1791 msg "test: $COMPONENT_DESCRIPTION"
1792 make test
1793}
1794
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001795component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001796 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001797}
1798
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001799component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001800 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001801}
1802
Valerio Settibdfecb62023-11-07 15:37:20 +01001803component_test_full_no_ccm() {
1804 msg "build: full no PSA_WANT_ALG_CCM"
1805
1806 # Full config enables:
1807 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1808 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1809 scripts/config.py full
1810
1811 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1812 # enabled, but not used from TLS since USE_PSA is set.
1813 # This is helpful to ensure that TLS tests below have proper dependencies.
1814 #
1815 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1816 # PSA_WANT_ALG_CCM to be re-enabled.
1817 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1818
Gilles Peskine21570cf2023-12-22 11:49:50 +01001819 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001820
1821 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001822 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001823}
1824
1825component_test_full_no_ccm_star_no_tag() {
1826 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1827
1828 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1829 scripts/config.py full
1830
1831 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1832 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1833 # This basically disables all unauthenticated ciphers on the PSA side, while
1834 # keeping AEADs enabled.
1835 #
1836 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1837 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1838 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1839 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1840 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1841 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1842 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1843 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1844 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1845 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1846
Gilles Peskine21570cf2023-12-22 11:49:50 +01001847 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001848
1849 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001850 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001851
1852 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001853 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001854}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001855
Valerio Settie1655b82023-01-03 15:35:25 +01001856component_test_full_no_bignum () {
1857 msg "build: full minus bignum"
1858 scripts/config.py full
1859 scripts/config.py unset MBEDTLS_BIGNUM_C
1860 # Direct dependencies of bignum
1861 scripts/config.py unset MBEDTLS_ECP_C
1862 scripts/config.py unset MBEDTLS_RSA_C
1863 scripts/config.py unset MBEDTLS_DHM_C
1864 # Direct dependencies of ECP
1865 scripts/config.py unset MBEDTLS_ECDH_C
1866 scripts/config.py unset MBEDTLS_ECDSA_C
1867 scripts/config.py unset MBEDTLS_ECJPAKE_C
1868 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001869 # Disable what auto-enables ECP_LIGHT
1870 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1871 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001872 # Indirect dependencies of ECP
1873 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1874 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1875 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1876 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1877 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1878 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1879 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1880 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1881 # Direct dependencies of DHM
1882 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1883 # Direct dependencies of RSA
1884 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1885 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1886 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1887 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1888 # PK and its dependencies
1889 scripts/config.py unset MBEDTLS_PK_C
1890 scripts/config.py unset MBEDTLS_PK_PARSE_C
1891 scripts/config.py unset MBEDTLS_PK_WRITE_C
1892 scripts/config.py unset MBEDTLS_X509_USE_C
1893 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1894 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1895 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1896 scripts/config.py unset MBEDTLS_X509_CREATE_C
1897 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1898 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1899 scripts/config.py unset MBEDTLS_PKCS7_C
1900 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1901 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1902 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1903
Gilles Peskine21570cf2023-12-22 11:49:50 +01001904 make
Valerio Settie1655b82023-01-03 15:35:25 +01001905
1906 msg "test: full minus bignum"
1907 make test
1908}
1909
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001910component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001911 msg "build: default with only stream cipher"
1912
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001913 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001914 scripts/config.py unset MBEDTLS_GCM_C
1915 scripts/config.py unset MBEDTLS_CCM_C
1916 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001917 #Disable TLS 1.3 (as no AEAD)
1918 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001919 # 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 +02001920 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001921 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001922 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001923 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1924 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001925 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001926 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001927 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001928
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001929 make
1930
1931 msg "test: default with only stream cipher"
1932 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001933
1934 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001935}
1936
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001937component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001938 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001939
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001940 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001941 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001942 scripts/config.py unset MBEDTLS_GCM_C
1943 scripts/config.py unset MBEDTLS_CCM_C
1944 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001945 #Disable TLS 1.3 (as no AEAD)
1946 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001947 # 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 +02001948 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001949 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001950 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001951 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1952 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001953 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001954 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001955 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001956
Przemek Stekiel9550c052022-09-28 09:51:55 +02001957 make
1958
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001959 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001960 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001961
1962 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001963}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001964
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001965component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001966 msg "build: default with only CBC-legacy cipher"
1967
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001968 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001969 scripts/config.py unset MBEDTLS_GCM_C
1970 scripts/config.py unset MBEDTLS_CCM_C
1971 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001972 #Disable TLS 1.3 (as no AEAD)
1973 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001974 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1975 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1976 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001977 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001978 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001979 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001980 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001981 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001982 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001983
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001984 make
1985
1986 msg "test: default with only CBC-legacy cipher"
1987 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001988
1989 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1990 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001991}
1992
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001993component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001994 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001995
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001996 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001997 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001998 scripts/config.py unset MBEDTLS_GCM_C
1999 scripts/config.py unset MBEDTLS_CCM_C
2000 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002001 #Disable TLS 1.3 (as no AEAD)
2002 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002003 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2004 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2005 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002006 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002007 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002008 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002009 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002010 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002011 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002012
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002013 make
2014
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002015 msg "test: default with only CBC-legacy cipher use psa"
2016 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002017
2018 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
2019 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002020}
2021
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002022component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002023 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
2024
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002025 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002026 scripts/config.py unset MBEDTLS_GCM_C
2027 scripts/config.py unset MBEDTLS_CCM_C
2028 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002029 #Disable TLS 1.3 (as no AEAD)
2030 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002031 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2032 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2033 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2034 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2035 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002036 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002037 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002038 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002039 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002040
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002041 make
2042
2043 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
2044 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002045
2046 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
2047 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002048}
2049
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002050component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
2051 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002052
2053 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002054 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002055 scripts/config.py unset MBEDTLS_GCM_C
2056 scripts/config.py unset MBEDTLS_CCM_C
2057 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002058 #Disable TLS 1.3 (as no AEAD)
2059 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002060 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2061 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2062 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2063 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2064 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002065 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002066 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002067 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002068 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002069
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002070 make
2071
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002072 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002073 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002074
2075 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2076 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002077}
2078
Valerio Setti9f0ec532022-11-08 13:03:24 +01002079# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2080# that we could use for interop testing. However, we now have sort of two
2081# implementations ourselves: one using PSA, the other not. At least test that
2082# these two interoperate with each other.
2083component_test_tls1_2_ecjpake_compatibility() {
2084 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2085 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002086 # Explicitly make lib first to avoid a race condition:
2087 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2088 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002089 make -C programs ssl/ssl_server2 ssl/ssl_client2
2090 cp programs/ssl/ssl_server2 s2_no_use_psa
2091 cp programs/ssl/ssl_client2 c2_no_use_psa
2092
2093 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2094 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2095 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002096 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002097 make -C programs ssl/ssl_server2 ssl/ssl_client2
2098 make -C programs test/udp_proxy test/query_compile_time_config
2099
Valerio Setti70e02902022-12-02 16:21:56 +01002100 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2101 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2102 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2103 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2104 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2105 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2106 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2107 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 +01002108
2109 rm s2_no_use_psa c2_no_use_psa
2110}
2111
Gilles Peskine636c26a2020-03-04 20:46:15 +01002112component_test_everest () {
2113 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2114 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2115 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2116 make
2117
2118 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2119 make test
2120
Gilles Peskine6848d172023-11-02 19:58:03 +01002121 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002122 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002123
Gilles Peskine636c26a2020-03-04 20:46:15 +01002124 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2125 tests/ssl-opt.sh -f ECDH
2126
2127 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2128 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002129 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002130}
2131
Gilles Peskined3beca92020-07-03 00:15:37 +02002132component_test_everest_curve25519_only () {
2133 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002134 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2135 scripts/config.py unset MBEDTLS_ECDSA_C
2136 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2137 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002138 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002139 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002140 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002141 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2142
Dave Rodgman17127e92023-12-14 16:42:48 +00002143 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002144
2145 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2146 make test
2147}
2148
Gilles Peskine8f073122018-11-27 15:58:47 +01002149component_test_small_ssl_out_content_len () {
2150 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002151 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2152 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002153 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002154 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002155
Gilles Peskine8f073122018-11-27 15:58:47 +01002156 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002157 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002158}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002159
Gilles Peskine8f073122018-11-27 15:58:47 +01002160component_test_small_ssl_in_content_len () {
2161 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002162 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2163 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002164 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002165 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002166
Gilles Peskine8f073122018-11-27 15:58:47 +01002167 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002168 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002169}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002170
Gilles Peskine8f073122018-11-27 15:58:47 +01002171component_test_small_ssl_dtls_max_buffering () {
2172 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002173 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002174 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002175 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002176
Gilles Peskine8f073122018-11-27 15:58:47 +01002177 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002178 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 +01002179}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002180
Gilles Peskine8f073122018-11-27 15:58:47 +01002181component_test_small_mbedtls_ssl_dtls_max_buffering () {
2182 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002183 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002184 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002185 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002186
Gilles Peskine8f073122018-11-27 15:58:47 +01002187 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002188 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002189}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002190
Gilles Peskine75cc7712019-09-06 19:47:17 +02002191component_test_psa_collect_statuses () {
2192 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002193 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002194 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002195 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002196 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002197 rm -f tests/statuses.log
2198}
2199
Gilles Peskine8f073122018-11-27 15:58:47 +01002200component_test_full_cmake_clang () {
2201 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002202 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002203 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 +01002204 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002205
k-stachowiak0291cb72019-06-26 15:52:12 +02002206 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002207 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002208
Gilles Peskineda6017c2022-10-30 21:02:40 +01002209 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2210 programs/test/cpp_dummy_build
2211
Gilles Peskine6848d172023-11-02 19:58:03 +01002212 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002213 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002214
Gilles Peskine82b27272019-06-14 18:27:03 +02002215 msg "program demos (full config, clang)" # ~10s
2216 tests/scripts/run_demos.py
2217
k-stachowiak0291cb72019-06-26 15:52:12 +02002218 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002219 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002220
Gilles Peskine8f073122018-11-27 15:58:47 +01002221 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002222 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002223}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002224
Gilles Peskine0c671602022-11-29 16:01:41 +01002225skip_suites_without_constant_flow () {
2226 # Skip the test suites that don't have any constant-flow annotations.
2227 # This will need to be adjusted if we ever start declaring things as
2228 # secret from macros or functions inside tests/include or tests/src.
2229 SKIP_TEST_SUITES=$(
2230 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2231 sed 's/test_suite_//; s/\.function$//' |
2232 tr '\n' ,)
2233 export SKIP_TEST_SUITES
2234}
2235
Dave Rodgman246210e2023-07-31 18:07:44 +01002236skip_all_except_given_suite () {
2237 # Skip all but the given test suite
2238 SKIP_TEST_SUITES=$(
2239 ls -1 tests/suites/test_suite_*.function |
2240 grep -v $1.function |
2241 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2242 tr '\n' ,)
2243 export SKIP_TEST_SUITES
2244}
2245
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002246component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002247 # This tests both (1) accesses to undefined memory, and (2) branches or
2248 # memory access depending on secret values. To distinguish between those:
2249 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2250 # - or alternatively, change the build type to MemSanDbg, which enables
2251 # origin tracking and nicer stack traces (which are useful for debugging
2252 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002253 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2254 scripts/config.py full
2255 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2256 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2257 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2258 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2259 make
2260
2261 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2262 make test
2263}
2264
2265component_test_memsan_constant_flow_psa () {
2266 # This tests both (1) accesses to undefined memory, and (2) branches or
2267 # memory access depending on secret values. To distinguish between those:
2268 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2269 # - or alternatively, change the build type to MemSanDbg, which enables
2270 # origin tracking and nicer stack traces (which are useful for debugging
2271 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002272 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002273 scripts/config.py full
2274 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2275 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2276 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2277 make
2278
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002279 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002280 make test
2281}
2282
Bence Szépkúti0354d042023-12-06 16:14:37 +01002283component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002284 # This tests both (1) everything that valgrind's memcheck usually checks
2285 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2286 # etc.) and (2) branches or memory access depending on secret values,
2287 # which will be reported as uninitialized memory. To distinguish between
2288 # secret and actually uninitialized:
2289 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2290 # - or alternatively, build with debug info and manually run the offending
2291 # test suite with valgrind --track-origins=yes, then check if the origin
2292 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002293 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2294 scripts/config.py full
2295 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2296 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002297 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002298 cmake -D CMAKE_BUILD_TYPE:String=Release .
2299 make
2300
2301 # this only shows a summary of the results (how many of each type)
2302 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002303 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002304 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002305
2306 # Test asm path in constant time module - by default, it will test the plain C
2307 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2308 msg "test: valgrind asm constant_time"
2309 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2310 skip_all_except_given_suite test_suite_constant_time
2311 cmake -D CMAKE_BUILD_TYPE:String=Release .
2312 make clean
2313 make
2314 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002315}
2316
Bence Szépkúti0354d042023-12-06 16:14:37 +01002317component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002318 # This tests both (1) everything that valgrind's memcheck usually checks
2319 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2320 # etc.) and (2) branches or memory access depending on secret values,
2321 # which will be reported as uninitialized memory. To distinguish between
2322 # secret and actually uninitialized:
2323 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2324 # - or alternatively, build with debug info and manually run the offending
2325 # test suite with valgrind --track-origins=yes, then check if the origin
2326 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002327 msg "build: cmake release GCC, full config with constant flow testing"
2328 scripts/config.py full
2329 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002330 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002331 cmake -D CMAKE_BUILD_TYPE:String=Release .
2332 make
2333
2334 # this only shows a summary of the results (how many of each type)
2335 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002336 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002337 make memcheck
2338}
2339
Janos Follath9338cac2023-10-04 18:55:39 +01002340component_test_tsan () {
2341 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002342 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002343 scripts/config.py set MBEDTLS_THREADING_C
2344 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002345 # Self-tests do not currently use multiple threads.
2346 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002347
Ryan6caf84f2024-03-05 13:57:00 +00002348 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2349 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2350
Janos Follath9338cac2023-10-04 18:55:39 +01002351 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2352 make
2353
2354 msg "test: main suites (TSan)"
2355 make test
2356}
2357
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002358component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002359 # Test that removing the deprecated features from the default
2360 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002361 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2362 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002363 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002364
2365 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2366 make test
2367}
2368
2369component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002370 msg "build: make, full_no_deprecated config" # ~ 30s
2371 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002372 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002373
Gilles Peskine30de2e82020-04-20 21:39:22 +02002374 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002375 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002376
2377 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2378 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002379}
2380
Gilles Peskine8386ea22020-04-30 09:07:29 +02002381component_test_full_no_deprecated_deprecated_warning () {
2382 # Test that there is nothing deprecated in "full_no_deprecated".
2383 # A deprecated feature would trigger a warning (made fatal) from
2384 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002385 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2386 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002387 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2388 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002389 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002390
Gilles Peskine30de2e82020-04-20 21:39:22 +02002391 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002392 make test
2393}
2394
Gilles Peskine8386ea22020-04-30 09:07:29 +02002395component_test_full_deprecated_warning () {
2396 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2397 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002398 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002399 scripts/config.py full
2400 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002401 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002402 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2403 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002404 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002405
Gilles Peskine8386ea22020-04-30 09:07:29 +02002406 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2407 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2408 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002409 # Expect warnings from '#warning' directives in check_config.h and
2410 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002411 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 +01002412
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002413 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2414 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002415
2416 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2417 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002418}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002419
Gilles Peskineec541fe2020-01-31 14:24:14 +01002420# Check that the specified libraries exist and are empty.
2421are_empty_libraries () {
2422 nm "$@" >/dev/null 2>/dev/null
2423 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2424}
2425
2426component_build_crypto_default () {
2427 msg "build: make, crypto only"
2428 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002429 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002430 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002431}
2432
2433component_build_crypto_full () {
2434 msg "build: make, crypto only, full config"
2435 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002436 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002437 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002438}
2439
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002440component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002441 msg "build: make, config for PSA crypto service"
2442 scripts/config.py crypto
2443 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2444 # Disable things that are not needed for just cryptography, to
2445 # reach a configuration that would be typical for a PSA cryptography
2446 # service providing all implemented PSA algorithms.
2447 # System stuff
2448 scripts/config.py unset MBEDTLS_ERROR_C
2449 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002450 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002451 # Crypto stuff with no PSA interface
2452 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002453 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002454 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002455 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002456 scripts/config.py unset MBEDTLS_NIST_KW_C
2457 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2458 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2459 scripts/config.py unset MBEDTLS_PKCS12_C
2460 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002461 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2462 # in PSA code to work with RSA keys. We don't require users to set those:
2463 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002464 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002465 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002466 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002467 make CFLAGS='-O1 -Werror' all test
2468 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2469}
2470
Gilles Peskineec541fe2020-01-31 14:24:14 +01002471component_build_crypto_baremetal () {
2472 msg "build: make, crypto only, baremetal config"
2473 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002474 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002475 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002476}
Daniel Axtens446af202020-09-02 21:30:13 +10002477support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002478 support_build_baremetal "$@"
2479}
2480
2481component_build_baremetal () {
2482 msg "build: make, baremetal config"
2483 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002484 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002485}
2486support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002487 # Older Glibc versions include time.h from other headers such as stdlib.h,
2488 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2489 # problem, Ubuntu 18.04 is ok.
2490 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2491}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002492
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002493# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002494component_test_depends_py_cipher_id () {
2495 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002496 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002497}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002498
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002499component_test_depends_py_cipher_chaining () {
2500 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002501 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002502}
2503
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002504component_test_depends_py_cipher_padding () {
2505 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002506 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002507}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002508
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002509component_test_depends_py_curves () {
2510 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002511 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002512}
2513
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002514component_test_depends_py_hashes () {
2515 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002516 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002517}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002518
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002519component_test_depends_py_kex () {
2520 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002521 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002522}
2523
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002524component_test_depends_py_pkalgs () {
2525 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002526 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002527}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002528
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002529# PSA equivalents of the depends.py tests
2530component_test_depends_py_cipher_id_psa () {
2531 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002532 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002533}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002534
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002535component_test_depends_py_cipher_chaining_psa () {
2536 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002537 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002538}
2539
2540component_test_depends_py_cipher_padding_psa () {
2541 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002542 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002543}
2544
2545component_test_depends_py_curves_psa () {
2546 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002547 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002548}
2549
2550component_test_depends_py_hashes_psa () {
2551 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002552 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002553}
2554
2555component_test_depends_py_kex_psa () {
2556 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002557 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002558}
2559
2560component_test_depends_py_pkalgs_psa () {
2561 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002562 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002563}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002564
Valerio Setti6bed64e2024-01-17 15:21:44 +01002565component_test_psa_crypto_config_ffdh_2048_only () {
2566 msg "build: full config - only DH 2048"
2567
2568 scripts/config.py full
2569
2570 # Disable all DH groups other than 2048.
2571 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2572 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2573 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2574 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2575
2576 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2577
2578 msg "test: full config - only DH 2048"
2579 make test
2580
2581 msg "ssl-opt: full config - only DH 2048"
2582 tests/ssl-opt.sh -f "ffdh"
2583}
2584
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002585component_build_no_pk_rsa_alt_support () {
2586 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2587
2588 scripts/config.py full
2589 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2590 scripts/config.py set MBEDTLS_RSA_C
2591 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2592
2593 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002594 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002595}
2596
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002597component_build_module_alt () {
2598 msg "build: MBEDTLS_XXX_ALT" # ~30s
2599 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002600
2601 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002602 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2603 scripts/config.py unset MBEDTLS_AESNI_C
2604 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002605 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002606 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2607 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002608 # You can only have one threading implementation: alt or pthread, not both.
2609 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002610 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2611 # directly and assumes the implementation works with partial groups.
2612 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002613 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2614 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2615 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002616 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2617 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2618 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002619
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002620 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2621 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2622 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002623 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002624
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002625 # We can only compile, not link, since we don't have any implementations
2626 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002627 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002628}
2629
2630component_build_dhm_alt () {
2631 msg "build: MBEDTLS_DHM_ALT" # ~30s
2632 scripts/config.py full
2633 scripts/config.py set MBEDTLS_DHM_ALT
2634 # debug.c currently references mbedtls_dhm_context fields directly.
2635 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002636 # We can only compile, not link, since we don't have any implementations
2637 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002638 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002639}
2640
Gilles Peskine64996c32024-01-23 20:25:47 +01002641component_test_no_psa_crypto_full_cmake_asan() {
2642 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2643 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002644 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002645 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002646 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002647 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002648 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002649 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002650 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002651 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002652 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002653 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002654 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002655 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002656
Gilles Peskine64996c32024-01-23 20:25:47 +01002657 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002658 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002659
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002660 # Note: ssl-opt.sh has some test cases that depend on
2661 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2662 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002663 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002664 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002665
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002666 # Note: the next two invocations cover all compat.sh test cases.
2667 # We should use the same here and in basic-build-test.sh.
2668 msg "test: compat.sh: default version (full minus PSA crypto)"
2669 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002670
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002671 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002672 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002673}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002674
Ronald Cron403c15c2021-09-13 09:38:05 +02002675component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002676 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002677
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002678 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002679 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002680 $(helper_get_psa_key_type_list "ECC") \
2681 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002682
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002683 # Configure
2684 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002685
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002686 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002687 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002688
2689 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002690 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002691
2692 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002693 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2694 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2695
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002696 # Build
2697 # -----
2698
2699 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002700 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2701 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002702
2703 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2704
Valerio Setti3fe105b2023-10-30 11:08:12 +01002705 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002706
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002707 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002708 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002709
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002710 # Run the tests
2711 # -------------
2712
Ronald Cron403c15c2021-09-13 09:38:05 +02002713 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2714 make test
2715}
2716
Valerio Setti44b178c2023-03-22 14:02:57 +01002717component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002718 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002719
2720 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002721 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002722 $(helper_get_psa_key_type_list "ECC") \
2723 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002724
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002725 # Configure
2726 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002727
Ronald Cron46ac0652024-03-18 12:39:04 +01002728 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002729 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002730
Valerio Setti44b178c2023-03-22 14:02:57 +01002731 # Disable the module that's accelerated
2732 scripts/config.py unset MBEDTLS_ECDH_C
2733
2734 # Disable things that depend on it
2735 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2736 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2737 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2738 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2739 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2740
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002741 # Build
2742 # -----
2743
2744 helper_libtestdriver1_make_drivers "$loc_accel_list"
2745
Valerio Setti3fe105b2023-10-30 11:08:12 +01002746 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002747
Valerio Setti44b178c2023-03-22 14:02:57 +01002748 # Make sure this was not re-enabled by accident (additive config)
2749 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002750
2751 # Run the tests
2752 # -------------
2753
Valerio Setti44b178c2023-03-22 14:02:57 +01002754 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002755 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002756}
2757
Przemek Stekieldccb2022023-05-11 10:48:50 +02002758component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002759 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002760
2761 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002762 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002763 $(helper_get_psa_key_type_list "DH") \
2764 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002765
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002766 # Configure
2767 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002768
Przemek Stekiel565353e2023-07-05 11:07:07 +02002769 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002770 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002771
2772 # Disable the module that's accelerated
2773 scripts/config.py unset MBEDTLS_DHM_C
2774
2775 # Disable things that depend on it
2776 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2777 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2778
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002779 # Build
2780 # -----
2781
2782 helper_libtestdriver1_make_drivers "$loc_accel_list"
2783
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002784 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002785
2786 # Make sure this was not re-enabled by accident (additive config)
2787 not grep mbedtls_dhm_ library/dhm.o
2788
2789 # Run the tests
2790 # -------------
2791
Gilles Peskine14302ed2023-07-19 19:30:04 +02002792 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002793 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002794
Gilles Peskine14302ed2023-07-19 19:30:04 +02002795 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002796 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002797}
2798
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002799component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002800 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002801
2802 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002803 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002804
2805 # Disable things that are not supported
2806 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2807 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002808 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002809
Gilles Peskine14302ed2023-07-19 19:30:04 +02002810 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002811 make test
2812
Gilles Peskine14302ed2023-07-19 19:30:04 +02002813 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002814 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002815}
2816
Valerio Setti44b178c2023-03-22 14:02:57 +01002817component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002818 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002819
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002820 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002821 $(helper_get_psa_key_type_list "ECC") \
2822 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002823
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002824 # Configure
2825 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002826
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002827 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002828
2829 # Make built-in fallback not available
2830 scripts/config.py unset MBEDTLS_ECJPAKE_C
2831 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2832
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002833 # Build
2834 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002835
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002836 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002837
Valerio Setti3fe105b2023-10-30 11:08:12 +01002838 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002839
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002840 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002841 not grep mbedtls_ecjpake_init library/ecjpake.o
2842
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002843 # Run the tests
2844 # -------------
2845
Gilles Peskine14302ed2023-07-19 19:30:04 +02002846 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002847 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002848}
2849
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002850component_test_psa_crypto_config_accel_ecc_some_key_types () {
2851 msg "build: full with accelerated EC algs and some key types"
2852
2853 # Algorithms and key types to accelerate
2854 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2855 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2856 ALG_ECDH \
2857 ALG_JPAKE \
2858 KEY_TYPE_ECC_PUBLIC_KEY \
2859 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2860 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002861 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2862 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002863
2864 # Configure
2865 # ---------
2866
2867 # start with config full for maximum coverage (also enables USE_PSA)
2868 helper_libtestdriver1_adjust_config "full"
2869
2870 # Disable modules that are accelerated - some will be re-enabled
2871 scripts/config.py unset MBEDTLS_ECDSA_C
2872 scripts/config.py unset MBEDTLS_ECDH_C
2873 scripts/config.py unset MBEDTLS_ECJPAKE_C
2874 scripts/config.py unset MBEDTLS_ECP_C
2875
2876 # Disable all curves - those that aren't accelerated should be re-enabled
2877 helper_disable_builtin_curves
2878
2879 # Restartable feature is not yet supported by PSA. Once it will in
2880 # the future, the following line could be removed (see issues
2881 # 6061, 6332 and following ones)
2882 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2883
2884 # this is not supported by the driver API yet
2885 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2886
2887 # Build
2888 # -----
2889
2890 # These hashes are needed for some ECDSA signature tests.
2891 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2892 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2893 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2894
Valerio Setti3fe105b2023-10-30 11:08:12 +01002895 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002896
2897 # ECP should be re-enabled but not the others
2898 not grep mbedtls_ecdh_ library/ecdh.o
2899 not grep mbedtls_ecdsa library/ecdsa.o
2900 not grep mbedtls_ecjpake library/ecjpake.o
2901 grep mbedtls_ecp library/ecp.o
2902
2903 # Run the tests
2904 # -------------
2905
2906 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002907 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002908}
2909
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002910# Run tests with only (non-)Weierstrass accelerated
2911# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002912# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2913# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002914common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002915 weierstrass=$1
2916 if [ $weierstrass -eq 1 ]; then
2917 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002918 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002919 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002920 fi
2921
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002922 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002923
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002924 # Note: Curves are handled in a special way by the libtestdriver machinery,
2925 # so we only want to include them in the accel list when building the main
2926 # libraries, hence the use of a separate variable.
2927 # Note: the following loop is a modified version of
2928 # helper_get_psa_curve_list that only keeps Weierstrass families.
2929 loc_weierstrass_list=""
2930 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002931 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2932 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002933 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002934 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002935 ;;
2936 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002937 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002938 ;;
2939 esac
2940 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002941 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002942 loc_curve_list=$loc_weierstrass_list
2943 else
2944 loc_curve_list=$loc_non_weierstrass_list
2945 fi
2946
Valerio Setti3fe105b2023-10-30 11:08:12 +01002947 # Algorithms and key types to accelerate
2948 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2949 ALG_ECDH \
2950 ALG_JPAKE \
2951 $(helper_get_psa_key_type_list "ECC") \
2952 $loc_curve_list"
2953
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002954 # Configure
2955 # ---------
2956
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002957 # Start with config crypto_full and remove PK_C:
2958 # that's what's supported now, see docs/driver-only-builds.md.
2959 helper_libtestdriver1_adjust_config "crypto_full"
2960 scripts/config.py unset MBEDTLS_PK_C
2961 scripts/config.py unset MBEDTLS_PK_PARSE_C
2962 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002963
2964 # Disable modules that are accelerated - some will be re-enabled
2965 scripts/config.py unset MBEDTLS_ECDSA_C
2966 scripts/config.py unset MBEDTLS_ECDH_C
2967 scripts/config.py unset MBEDTLS_ECJPAKE_C
2968 scripts/config.py unset MBEDTLS_ECP_C
2969
2970 # Disable all curves - those that aren't accelerated should be re-enabled
2971 helper_disable_builtin_curves
2972
2973 # Restartable feature is not yet supported by PSA. Once it will in
2974 # the future, the following line could be removed (see issues
2975 # 6061, 6332 and following ones)
2976 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2977
2978 # this is not supported by the driver API yet
2979 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2980
2981 # Build
2982 # -----
2983
2984 # These hashes are needed for some ECDSA signature tests.
2985 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2986 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2987 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2988
Valerio Settiac7a8092023-10-31 12:23:44 +01002989 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002990
2991 # We expect ECDH to be re-enabled for the missing curves
2992 grep mbedtls_ecdh_ library/ecdh.o
2993 # We expect ECP to be re-enabled, however the parts specific to the
2994 # families of curves that are accelerated should be ommited.
2995 # - functions with mxz in the name are specific to Montgomery curves
2996 # - ecp_muladd is specific to Weierstrass curves
2997 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002998 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002999 not grep mbedtls_ecp_muladd library/ecp.o
3000 grep mxz library/ecp.o
3001 else
3002 grep mbedtls_ecp_muladd library/ecp.o
3003 not grep mxz library/ecp.o
3004 fi
3005 # We expect ECDSA and ECJPAKE to be re-enabled only when
3006 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003007 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003008 not grep mbedtls_ecdsa library/ecdsa.o
3009 not grep mbedtls_ecjpake library/ecjpake.o
3010 else
3011 grep mbedtls_ecdsa library/ecdsa.o
3012 grep mbedtls_ecjpake library/ecjpake.o
3013 fi
3014
3015 # Run the tests
3016 # -------------
3017
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02003018 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
3019 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003020}
3021
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02003022component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003023 common_test_psa_crypto_config_accel_ecc_some_curves 1
3024}
3025
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02003026component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003027 common_test_psa_crypto_config_accel_ecc_some_curves 0
3028}
3029
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01003030# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
3031# ECDH, ECDSA) with and without drivers.
3032# The input parameter is a boolean value which indicates:
3033# - 0 keep built-in EC algs,
3034# - 1 exclude built-in EC algs (driver only).
3035#
3036# This is used by the two following components to ensure they always use the
3037# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003038# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
3039# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01003040# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003041config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003042 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01003043 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003044 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003045 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01003046 # Disable modules that are accelerated
3047 scripts/config.py unset MBEDTLS_ECDSA_C
3048 scripts/config.py unset MBEDTLS_ECDH_C
3049 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02003050 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01003051 fi
3052
3053 # Restartable feature is not yet supported by PSA. Once it will in
3054 # the future, the following line could be removed (see issues
3055 # 6061, 6332 and following ones)
3056 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003057}
3058
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003059# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3060component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003061 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003062
3063 # Algorithms and key types to accelerate
3064 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3065 ALG_ECDH \
3066 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003067 $(helper_get_psa_key_type_list "ECC") \
3068 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003069
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003070 # Configure
3071 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003072
3073 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003074 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003075
Valerio Setti0a342c92023-09-01 09:12:31 +02003076 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003077 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3078 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003079
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003080 # Build
3081 # -----
3082
3083 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003084 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3085 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003086 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3087
Valerio Setti3fe105b2023-10-30 11:08:12 +01003088 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003089
3090 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3091 not grep mbedtls_ecdsa_ library/ecdsa.o
3092 not grep mbedtls_ecdh_ library/ecdh.o
3093 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003094 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003095
3096 # Run the tests
3097 # -------------
3098
Gilles Peskine14302ed2023-07-19 19:30:04 +02003099 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003100 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003101
Gilles Peskine14302ed2023-07-19 19:30:04 +02003102 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003103 tests/ssl-opt.sh
3104}
3105
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003106# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3107component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003108 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003109
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003110 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003111
Gilles Peskine21570cf2023-12-22 11:49:50 +01003112 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003113
Gilles Peskine14302ed2023-07-19 19:30:04 +02003114 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003115 make test
3116
Gilles Peskine14302ed2023-07-19 19:30:04 +02003117 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003118 tests/ssl-opt.sh
3119}
3120
Valerio Settie618cb02023-04-12 14:59:16 +02003121# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003122# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3123# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003124# to ensure that both tests use the same underlying configuration when testing
3125# driver's coverage with analyze_outcomes.py.
3126#
3127# This functions accepts 1 boolean parameter as follows:
3128# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3129# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3130# - 0: include built-in implementation of EC algorithms.
3131#
3132# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3133# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003134config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003135 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003136 # start with full config for maximum coverage (also enables USE_PSA)
3137 helper_libtestdriver1_adjust_config "full"
3138
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003139 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003140 # Disable modules that are accelerated
3141 scripts/config.py unset MBEDTLS_ECDSA_C
3142 scripts/config.py unset MBEDTLS_ECDH_C
3143 scripts/config.py unset MBEDTLS_ECJPAKE_C
3144 # Disable ECP module (entirely)
3145 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003146 fi
3147
Valerio Settiaecd32c2023-06-14 10:42:31 +02003148 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3149 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003150 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003151 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003152
Valerio Settie618cb02023-04-12 14:59:16 +02003153 # Restartable feature is not yet supported by PSA. Once it will in
3154 # the future, the following line could be removed (see issues
3155 # 6061, 6332 and following ones)
3156 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003157}
3158
3159# Build and test a configuration where driver accelerates all EC algs while
3160# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3161# side.
3162#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003163# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3164component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003165 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003166
3167 # Algorithms and key types to accelerate
3168 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3169 ALG_ECDH \
3170 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003171 $(helper_get_psa_key_type_list "ECC") \
3172 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003173
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003174 # Configure
3175 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003176
Valerio Settie618cb02023-04-12 14:59:16 +02003177 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003178 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003179 # Disable all the builtin curves. All the required algs are accelerated.
3180 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003181
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003182 # Build
3183 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003184
3185 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003186 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3187 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3188 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003189
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003190 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003191
Valerio Setti3fe105b2023-10-30 11:08:12 +01003192 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003193
3194 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3195 not grep mbedtls_ecdsa_ library/ecdsa.o
3196 not grep mbedtls_ecdh_ library/ecdh.o
3197 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003198 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003199 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003200
3201 # Run the tests
3202 # -------------
3203
Gilles Peskine14302ed2023-07-19 19:30:04 +02003204 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003205 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003206
Gilles Peskine14302ed2023-07-19 19:30:04 +02003207 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003208 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003209}
3210
3211# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003212# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003213# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003214component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003215 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003216
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003217 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003218
Gilles Peskine21570cf2023-12-22 11:49:50 +01003219 make
Valerio Settie618cb02023-04-12 14:59:16 +02003220
Gilles Peskine14302ed2023-07-19 19:30:04 +02003221 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003222 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003223
Gilles Peskine14302ed2023-07-19 19:30:04 +02003224 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003225 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003226}
3227
Valerio Setti4e2f2442023-08-15 10:10:26 +02003228# This is a common configuration helper used directly from:
3229# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3230# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3231# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003232# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003233# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003234# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003235# - this is the reference component of the above
3236# - it still disables RSA and FFDH, but it uses builtin EC algs
3237# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3238# - accelerate all EC and FFDH algs, disable only RSA
3239# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3240# - this is the reference component of the above
3241# - it still disables RSA, but it uses builtin EC and FFDH algs
3242#
3243# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003244# $1: a boolean value which states if we are testing an accelerated scenario
3245# or not.
3246# $2: a string value which states which components are tested. Allowed values
3247# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003248config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003249 driver_only="$1"
3250 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003251 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003252 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003253
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003254 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003255 # Disable modules that are accelerated
3256 scripts/config.py unset MBEDTLS_ECDSA_C
3257 scripts/config.py unset MBEDTLS_ECDH_C
3258 scripts/config.py unset MBEDTLS_ECJPAKE_C
3259 # Disable ECP module (entirely)
3260 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003261 # Also disable bignum
3262 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003263 fi
3264
3265 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3266 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3267 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3268 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3269
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003270 # RSA support is intentionally disabled on this test because RSA_C depends
3271 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003272 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3273 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 +02003274 scripts/config.py unset MBEDTLS_RSA_C
3275 scripts/config.py unset MBEDTLS_PKCS1_V15
3276 scripts/config.py unset MBEDTLS_PKCS1_V21
3277 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3278 # Also disable key exchanges that depend on RSA
3279 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3280 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3281 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3282 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3283 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3284
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003285 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003286 # When testing ECC only, we disable FFDH support, both from builtin and
3287 # PSA sides, and also disable the key exchanges that depend on DHM.
3288 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3289 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 +01003290 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003291 scripts/config.py unset MBEDTLS_DHM_C
3292 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3293 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3294 else
3295 # When testing ECC and DH instead, we disable DHM and depending key
3296 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003297 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003298 scripts/config.py unset MBEDTLS_DHM_C
3299 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3300 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3301 fi
3302 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003303
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003304 # Restartable feature is not yet supported by PSA. Once it will in
3305 # the future, the following line could be removed (see issues
3306 # 6061, 6332 and following ones)
3307 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3308}
3309
Valerio Setti4e2f2442023-08-15 10:10:26 +02003310# Common helper used by:
3311# - component_test_psa_crypto_config_accel_ecc_no_bignum
3312# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003313#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003314# The goal is to build and test accelerating either:
3315# - ECC only or
3316# - both ECC and FFDH
3317#
3318# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003319# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3320# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003321common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003322 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003323
Valerio Setti5dfaca42023-09-05 08:48:51 +02003324 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003325 if [ "$test_target" = "ECC_DH" ]; then
3326 accel_text="ECC/FFDH"
3327 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003328 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003329 accel_text="ECC"
3330 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003331 fi
3332
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003333 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003334
3335 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003336 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3337 ALG_ECDH \
3338 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003339 $(helper_get_psa_key_type_list "ECC") \
3340 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003341 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003342 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003343 loc_accel_list="$loc_accel_list \
3344 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003345 $(helper_get_psa_key_type_list "DH") \
3346 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003347 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003348
3349 # Configure
3350 # ---------
3351
3352 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003353 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003354 # Disable all the builtin curves. All the required algs are accelerated.
3355 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003356
3357 # Build
3358 # -----
3359
3360 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003361 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3362 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3363 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003364
3365 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3366
Valerio Setti3fe105b2023-10-30 11:08:12 +01003367 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003368
3369 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3370 not grep mbedtls_ecdsa_ library/ecdsa.o
3371 not grep mbedtls_ecdh_ library/ecdh.o
3372 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003373 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003374 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003375 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003376 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003377 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003378
3379 # Run the tests
3380 # -------------
3381
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003382 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003383
Gilles Peskine21570cf2023-12-22 11:49:50 +01003384 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003385
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003386 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003387 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003388}
3389
Valerio Setti4e2f2442023-08-15 10:10:26 +02003390# Common helper used by:
3391# - component_test_psa_crypto_config_reference_ecc_no_bignum
3392# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3393#
3394# The goal is to build and test a reference scenario (i.e. with builtin
3395# components) compared to the ones used in
3396# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3397#
3398# It is meant to be used in conjunction with
3399# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3400# coverage analysis in "analyze_outcomes.py" script.
3401common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003402 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003403
Valerio Setti5dfaca42023-09-05 08:48:51 +02003404 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003405 if [ "$test_target" = "ECC_DH" ]; then
3406 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003407 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003408 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003409 fi
3410
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003411 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003412
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003413 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003414
Gilles Peskine21570cf2023-12-22 11:49:50 +01003415 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003416
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003417 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003418 make test
3419
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003420 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003421 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003422}
3423
Valerio Setti4e2f2442023-08-15 10:10:26 +02003424component_test_psa_crypto_config_accel_ecc_no_bignum () {
3425 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3426}
3427
3428component_test_psa_crypto_config_reference_ecc_no_bignum () {
3429 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3430}
3431
3432component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3433 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3434}
3435
3436component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3437 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3438}
3439
Valerio Settiac6d35f2023-08-04 12:49:11 +02003440# Helper for setting common configurations between:
3441# - component_test_tfm_config_p256m_driver_accel_ec()
3442# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003443common_tfm_config () {
3444 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003445 cp configs/config-tfm.h "$CONFIG_H"
3446 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3447 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003448
Yanray Wang73bb2312023-09-25 11:21:15 +08003449 # Other config adjustment to make the tests pass.
3450 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003451 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003452 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3453 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003454
Yanray Wang73bb2312023-09-25 11:21:15 +08003455 # Config adjustment for better test coverage in our environment.
3456 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003457 #
3458 # Enable filesystem I/O for the benefit of PK parse/write tests.
3459 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3460}
3461
Valerio Settiac6d35f2023-08-04 12:49:11 +02003462# Keep this in sync with component_test_tfm_config() as they are both meant
3463# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003464component_test_tfm_config_p256m_driver_accel_ec () {
3465 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3466
3467 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003468
Dave Rodgman897bb772023-11-15 16:34:20 +00003469 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003470 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003471
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003472 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3473 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003474 not grep mbedtls_ecdh_ library/ecdh.o
3475 not grep mbedtls_ecjpake_ library/ecjpake.o
3476 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3477 not grep mbedtls_ecp_ library/ecp.o
3478 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003479 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003480 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003481 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003482 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003483
Valerio Setti5e18b902023-12-04 12:07:30 +01003484 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3485 # files, so we want to ensure that it has not be re-enabled accidentally.
3486 not grep mbedtls_cipher library/cipher.o
3487
Valerio Settib7e95442023-03-21 11:52:33 +01003488 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003489 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003490 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003491}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003492
Valerio Settiac6d35f2023-08-04 12:49:11 +02003493# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3494# they are both meant to be used in analyze_outcomes.py for driver's coverage
3495# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003496component_test_tfm_config() {
3497 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003498
Dave Rodgman897bb772023-11-15 16:34:20 +00003499 # Disable P256M driver, which is on by default, so that analyze_outcomes
3500 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3501 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3502
Valerio Setti52ba0e32023-08-04 12:43:03 +02003503 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003504 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003505
Dave Rodgman897bb772023-11-15 16:34:20 +00003506 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003507 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003508
Valerio Setti5e18b902023-12-04 12:07:30 +01003509 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3510 # files, so we want to ensure that it has not be re-enabled accidentally.
3511 not grep mbedtls_cipher library/cipher.o
3512
Valerio Setti52ba0e32023-08-04 12:43:03 +02003513 msg "test: TF-M config"
3514 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003515}
3516
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003517# Common helper for component_full_without_ecdhe_ecdsa() and
3518# component_full_without_ecdhe_ecdsa_and_tls13() which:
3519# - starts from the "full" configuration minus the list of symbols passed in
3520# as 1st parameter
3521# - build
3522# - test only TLS (i.e. test_suite_tls and ssl-opt)
3523build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003524 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003525
3526 msg "build: full minus something, test TLS"
3527
3528 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003529 for sym in $symbols_to_disable; do
3530 echo "Disabling $sym"
3531 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003532 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003533
Gilles Peskine21570cf2023-12-22 11:49:50 +01003534 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003535
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003536 msg "test: full minus something, test TLS"
3537 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003538
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003539 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003540 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003541}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003542
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003543component_full_without_ecdhe_ecdsa () {
3544 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003545}
3546
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003547component_full_without_ecdhe_ecdsa_and_tls13 () {
3548 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3549 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003550}
3551
Valerio Setti249b18a2023-06-20 12:08:30 +02003552# This is an helper used by:
3553# - component_test_psa_ecc_key_pair_no_derive
3554# - component_test_psa_ecc_key_pair_no_generate
3555# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3556# enabled, but one. Input arguments are as follows:
3557# - $1 is the key type under test, i.e. ECC/RSA/DH
3558# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003559build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003560 key_type=$1
3561 unset_option=$2
3562 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003563
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003564 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003565 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003566 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3567 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3568
3569 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3570 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003571 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003572
Gilles Peskine21570cf2023-12-22 11:49:50 +01003573 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003574
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003575 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003576 make test
3577}
3578
3579component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003580 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003581}
3582
3583component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003584 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003585}
3586
Pengyu Lve705f572023-12-06 16:38:15 +08003587config_psa_crypto_accel_rsa () {
3588 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003589
Pengyu Lve705f572023-12-06 16:38:15 +08003590 # Start from crypto_full config (no X.509, no TLS)
3591 helper_libtestdriver1_adjust_config "crypto_full"
3592
3593 if [ "$driver_only" -eq 1 ]; then
3594 # Remove RSA support and its dependencies
3595 scripts/config.py unset MBEDTLS_RSA_C
3596 scripts/config.py unset MBEDTLS_PKCS1_V15
3597 scripts/config.py unset MBEDTLS_PKCS1_V21
3598
3599 # We need PEM parsing in the test library as well to support the import
3600 # of PEM encoded RSA keys.
3601 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3602 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3603 fi
3604}
3605
3606component_test_psa_crypto_config_accel_rsa_crypto () {
3607 msg "build: crypto_full with accelerated RSA"
3608
3609 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3610 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3611 KEY_TYPE_RSA_PUBLIC_KEY \
3612 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3613 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3614 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3615 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003616
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003617 # Configure
3618 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003619
Pengyu Lve705f572023-12-06 16:38:15 +08003620 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003621
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003622 # Build
3623 # -----
3624
Pengyu Lve705f572023-12-06 16:38:15 +08003625 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003626 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 +08003627 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003628 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003629
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003630 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003631
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003632 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003633 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003634
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003635 # Run the tests
3636 # -------------
3637
Pengyu Lve705f572023-12-06 16:38:15 +08003638 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003639 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003640}
3641
3642component_test_psa_crypto_config_reference_rsa_crypto () {
3643 msg "build: crypto_full with non-accelerated RSA"
3644
3645 # Configure
3646 # ---------
3647 config_psa_crypto_accel_rsa 0
3648
3649 # Build
3650 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003651 make
Pengyu Lve705f572023-12-06 16:38:15 +08003652
3653 # Run the tests
3654 # -------------
3655 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003656 make test
3657}
3658
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003659# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003660# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003661component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003662 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003663
Valerio Setti4590bc22023-06-13 15:39:23 +02003664 # Create a temporary output file unless there is already one set
3665 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3666 REMOVE_OUTCOME_ON_EXIT="no"
3667 else
3668 REMOVE_OUTCOME_ON_EXIT="yes"
3669 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3670 export MBEDTLS_TEST_OUTCOME_FILE
3671 fi
3672
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003673 # Start from crypto configuration
3674 scripts/config.py crypto
3675
3676 # Remove RSA support and its dependencies
3677 scripts/config.py unset MBEDTLS_PKCS1_V15
3678 scripts/config.py unset MBEDTLS_PKCS1_V21
3679 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3680 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3681 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3682 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3683 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3684 scripts/config.py unset MBEDTLS_RSA_C
3685 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3686
3687 # Enable PSA support
3688 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3689
Valerio Setti01cc88a2023-06-15 11:53:08 +02003690 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003691 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003692 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3693 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3694 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003695
3696 make
3697
Valerio Setti01cc88a2023-06-15 11:53:08 +02003698 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003699 make test
3700
3701 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3702 # performing RSA signature.
3703 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3704 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3705
3706 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3707 rm $MBEDTLS_TEST_OUTCOME_FILE
3708 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003709}
3710
Ronald Cronb2312452021-05-08 14:32:59 +02003711component_test_psa_crypto_config_accel_hash () {
3712 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3713
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003714 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3715 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3716 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003717
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003718 # Configure
3719 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003720
Ronald Cron46ac0652024-03-18 12:39:04 +01003721 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003722 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003723
3724 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003725 scripts/config.py unset MBEDTLS_MD5_C
3726 scripts/config.py unset MBEDTLS_RIPEMD160_C
3727 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003728 scripts/config.py unset MBEDTLS_SHA224_C
3729 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003730 scripts/config.py unset MBEDTLS_SHA384_C
3731 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003732 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003733
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003734 # Build
3735 # -----
3736
3737 helper_libtestdriver1_make_drivers "$loc_accel_list"
3738
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003739 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003740
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003741 # There's a risk of something getting re-enabled via config_psa.h;
3742 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3743 not grep mbedtls_md5 library/md5.o
3744 not grep mbedtls_sha1 library/sha1.o
3745 not grep mbedtls_sha256 library/sha256.o
3746 not grep mbedtls_sha512 library/sha512.o
3747 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003748
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003749 # Run the tests
3750 # -------------
3751
Ronald Cronb2312452021-05-08 14:32:59 +02003752 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3753 make test
3754}
3755
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003756# Auxiliary function to build config for hashes with and without drivers
3757config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003758 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003759 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003760 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003761 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003762 # disable the built-in implementation of hashes
3763 scripts/config.py unset MBEDTLS_MD5_C
3764 scripts/config.py unset MBEDTLS_RIPEMD160_C
3765 scripts/config.py unset MBEDTLS_SHA1_C
3766 scripts/config.py unset MBEDTLS_SHA224_C
3767 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003768 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003769 scripts/config.py unset MBEDTLS_SHA384_C
3770 scripts/config.py unset MBEDTLS_SHA512_C
3771 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003772 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003773 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003774}
3775
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003776# Note that component_test_psa_crypto_config_reference_hash_use_psa
3777# is related to this component and both components need to be kept in sync.
3778# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003779component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003780 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003781
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003782 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3783 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3784 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003785
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003786 # Configure
3787 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003788
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003789 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003790
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003791 # Build
3792 # -----
3793
3794 helper_libtestdriver1_make_drivers "$loc_accel_list"
3795
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003796 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003797
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003798 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003799 # 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 +02003800 not grep mbedtls_md5 library/md5.o
3801 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003802 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003803 not grep mbedtls_sha512 library/sha512.o
3804 not grep mbedtls_ripemd160 library/ripemd160.o
3805
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003806 # Run the tests
3807 # -------------
3808
Gilles Peskine14302ed2023-07-19 19:30:04 +02003809 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003810 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003811
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003812 # This is mostly useful so that we can later compare outcome files with
3813 # the reference config in analyze_outcomes.py, to check that the
3814 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003815 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003816 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003817
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003818 # This is to make sure all ciphersuites are exercised, but we don't need
3819 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003820 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003821 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003822}
3823
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003824# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3825# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3826# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3827# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003828component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003829 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003830
3831 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003832
Gilles Peskine21570cf2023-12-22 11:49:50 +01003833 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003834
Gilles Peskine14302ed2023-07-19 19:30:04 +02003835 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003836 make test
3837
Gilles Peskine14302ed2023-07-19 19:30:04 +02003838 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003839 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003840}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003841
Valerio Setti8eb310c2024-01-22 16:22:57 +01003842# Auxiliary function to build config for hashes with and without drivers
3843config_psa_crypto_hmac_use_psa () {
3844 driver_only="$1"
3845 # start with config full for maximum coverage (also enables USE_PSA)
3846 helper_libtestdriver1_adjust_config "full"
3847
Valerio Setticd89b0b2024-01-24 14:24:55 +01003848 if [ "$driver_only" -eq 1 ]; then
3849 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3850 # is still enabled though (for ENTROPY_C among others).
3851 scripts/config.py unset MBEDTLS_MD_C
3852 # Disable also the builtin hashes since they are supported by the driver
3853 # and MD module is able to perform PSA dispathing.
3854 scripts/config.py unset-all MBEDTLS_SHA
3855 scripts/config.py unset MBEDTLS_MD5_C
3856 scripts/config.py unset MBEDTLS_RIPEMD160_C
3857 fi
3858
Valerio Setti8eb310c2024-01-22 16:22:57 +01003859 # Direct dependencies of MD_C. We disable them also in the reference
3860 # component to work with the same set of features.
3861 scripts/config.py unset MBEDTLS_PKCS7_C
3862 scripts/config.py unset MBEDTLS_PKCS5_C
3863 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3864 scripts/config.py unset MBEDTLS_HKDF_C
3865 # Dependencies of HMAC_DRBG
3866 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3867 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3868}
3869
3870component_test_psa_crypto_config_accel_hmac() {
3871 msg "test: full with accelerated hmac"
3872
3873 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3874 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3875 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3876 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3877
3878 # Configure
3879 # ---------
3880
3881 config_psa_crypto_hmac_use_psa 1
3882
Valerio Setti8eb310c2024-01-22 16:22:57 +01003883 # Build
3884 # -----
3885
3886 helper_libtestdriver1_make_drivers "$loc_accel_list"
3887
3888 helper_libtestdriver1_make_main "$loc_accel_list"
3889
3890 # Ensure that built-in support for HMAC is disabled.
3891 not grep mbedtls_md_hmac library/md.o
3892
3893 # Run the tests
3894 # -------------
3895
3896 msg "test: full with accelerated hmac"
3897 make test
3898}
3899
3900component_test_psa_crypto_config_reference_hmac() {
3901 msg "test: full without accelerated hmac"
3902
3903 config_psa_crypto_hmac_use_psa 0
3904
3905 make
3906
3907 msg "test: full without accelerated hmac"
3908 make test
3909}
3910
Valerio Setti9da01a72023-12-18 17:38:18 +01003911component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003912 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003913
Valerio Setti9da01a72023-12-18 17:38:18 +01003914 # Albeit this components aims at accelerating DES which should only support
3915 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3916 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003917 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3918 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3919 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003920
Valerio Setti9da01a72023-12-18 17:38:18 +01003921 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3922 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3923 # of this component. This limitation will be addressed by #8598.
3924
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003925 # Configure
3926 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003927
Valerio Setti9a427302023-10-17 11:40:42 +02003928 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003929 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003930
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003931 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003932 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3933 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3934 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3935 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3936 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3937 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3938 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003939 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003940
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003941 # Build
3942 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003943
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003944 helper_libtestdriver1_make_drivers "$loc_accel_list"
3945
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003946 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003947
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003948 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003949 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003950
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003951 # Run the tests
3952 # -------------
3953
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003954 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003955 make test
3956}
3957
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003958component_test_psa_crypto_config_accel_aead () {
3959 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3960
Valerio Setti3f02bb72023-10-02 15:57:33 +02003961 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3962 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003963
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003964 # Configure
3965 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003966
Valerio Setti3f02bb72023-10-02 15:57:33 +02003967 # Start from full config
3968 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003969
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003970 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003971 scripts/config.py unset MBEDTLS_GCM_C
3972 scripts/config.py unset MBEDTLS_CCM_C
3973 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003974
Valerio Settia50b89e2023-11-08 15:58:47 +01003975 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3976 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003977
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003978 # Build
3979 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003980
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003981 helper_libtestdriver1_make_drivers "$loc_accel_list"
3982
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003983 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003984
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003985 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003986 not grep mbedtls_ccm library/ccm.o
3987 not grep mbedtls_gcm library/gcm.o
3988 not grep mbedtls_chachapoly library/chachapoly.o
3989
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003990 # Run the tests
3991 # -------------
3992
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003993 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3994 make test
3995}
3996
Valerio Settib680fc42023-10-13 09:29:37 +02003997# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003998# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3999# - component_test_psa_crypto_config_reference_cipher_aead_cmac
4000common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08004001 # Start from the full config
4002 helper_libtestdriver1_adjust_config "full"
4003
Valerio Settib680fc42023-10-13 09:29:37 +02004004 scripts/config.py unset MBEDTLS_NIST_KW_C
4005}
4006
Valerio Settib6b301f2023-10-04 12:05:05 +02004007# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004008# - component_test_psa_crypto_config_accel_cipher_aead_cmac
4009# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004010# are meant to be used together in analyze_outcomes.py script in order to test
4011# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004012component_test_psa_crypto_config_accel_cipher_aead_cmac () {
4013 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004014
Valerio Settiad8b7f02023-10-25 12:39:50 +02004015 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 +01004016 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02004017 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02004018 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
4019
4020 # Configure
4021 # ---------
4022
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004023 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004024
4025 # Disable the things that are being accelerated
4026 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4027 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
4028 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
4029 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
4030 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
4031 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4032 scripts/config.py unset MBEDTLS_GCM_C
4033 scripts/config.py unset MBEDTLS_CCM_C
4034 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02004035 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02004036 scripts/config.py unset MBEDTLS_DES_C
4037 scripts/config.py unset MBEDTLS_AES_C
4038 scripts/config.py unset MBEDTLS_ARIA_C
4039 scripts/config.py unset MBEDTLS_CHACHA20_C
4040 scripts/config.py unset MBEDTLS_CAMELLIA_C
4041
Valerio Settiec9b2582023-11-08 16:50:54 +01004042 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
4043 # does not depend on it.
4044 scripts/config.py unset MBEDTLS_CIPHER_C
4045
Valerio Settib6b301f2023-10-04 12:05:05 +02004046 # Build
4047 # -----
4048
4049 helper_libtestdriver1_make_drivers "$loc_accel_list"
4050
4051 helper_libtestdriver1_make_main "$loc_accel_list"
4052
4053 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01004054 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02004055 not grep mbedtls_des library/des.o
4056 not grep mbedtls_aes library/aes.o
4057 not grep mbedtls_aria library/aria.o
4058 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004059 not grep mbedtls_ccm library/ccm.o
4060 not grep mbedtls_gcm library/gcm.o
4061 not grep mbedtls_chachapoly library/chachapoly.o
4062 not grep mbedtls_cmac library/cmac.o
4063
4064 # Run the tests
4065 # -------------
4066
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004067 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004068 make test
Valerio Settif9414552023-11-09 10:43:20 +01004069
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004070 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004071 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004072
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004073 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004074 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004075}
4076
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004077component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4078 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4079 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004080
Gilles Peskine21570cf2023-12-22 11:49:50 +01004081 make
Valerio Settif9414552023-11-09 10:43:20 +01004082
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004083 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004084 make test
Valerio Settif9414552023-11-09 10:43:20 +01004085
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004086 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004087 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004088
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004089 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004090 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004091}
4092
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004093common_block_cipher_dispatch() {
4094 TEST_WITH_DRIVER="$1"
4095
4096 # Start from the full config
4097 helper_libtestdriver1_adjust_config "full"
4098
4099 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4100 # Disable key types that are accelerated (there is no legacy equivalent
4101 # symbol for ECB)
4102 scripts/config.py unset MBEDTLS_AES_C
4103 scripts/config.py unset MBEDTLS_ARIA_C
4104 scripts/config.py unset MBEDTLS_CAMELLIA_C
4105 fi
4106
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004107 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004108 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004109 # Keep this also in the reference component in order to skip the same tests
4110 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004111 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4112 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4113 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4114 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4115 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4116 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4117 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004118
4119 # Disable direct dependency on AES_C
4120 scripts/config.py unset MBEDTLS_NIST_KW_C
4121
4122 # Prevent the cipher module from using deprecated PSA path. The reason is
4123 # that otherwise there will be tests relying on "aes_info" (defined in
4124 # "cipher_wrap.c") whose functions are not available when AES_C is
4125 # not defined. ARIA and Camellia are not a problem in this case because
4126 # the PSA path is not tested for these key types.
4127 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4128}
4129
Valerio Settif8e6cba2023-12-12 11:53:39 +01004130component_test_full_block_cipher_psa_dispatch () {
4131 msg "build: full + PSA dispatch in block_cipher"
4132
4133 loc_accel_list="ALG_ECB_NO_PADDING \
4134 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4135
4136 # Configure
4137 # ---------
4138
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004139 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004140
Valerio Settif8e6cba2023-12-12 11:53:39 +01004141 # Build
4142 # -----
4143
4144 helper_libtestdriver1_make_drivers "$loc_accel_list"
4145
4146 helper_libtestdriver1_make_main "$loc_accel_list"
4147
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004148 # Make sure disabled components were not re-enabled by accident (additive
4149 # config)
4150 not grep mbedtls_aes_ library/aes.o
4151 not grep mbedtls_aria_ library/aria.o
4152 not grep mbedtls_camellia_ library/camellia.o
4153
Valerio Settif8e6cba2023-12-12 11:53:39 +01004154 # Run the tests
4155 # -------------
4156
4157 msg "test: full + PSA dispatch in block_cipher"
4158 make test
4159}
4160
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004161# This is the reference component of component_test_full_block_cipher_psa_dispatch
4162component_test_full_block_cipher_legacy_dispatch () {
4163 msg "build: full + legacy dispatch in block_cipher"
4164
4165 common_block_cipher_dispatch 0
4166
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004167 make
4168
4169 msg "test: full + legacy dispatch in block_cipher"
4170 make test
4171}
4172
Gilles Peskine36dea152023-07-20 22:19:45 +02004173component_test_aead_chachapoly_disabled() {
4174 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004175 scripts/config.py full
4176 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004177 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004178 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004179
Gilles Peskine36dea152023-07-20 22:19:45 +02004180 msg "test: full minus CHACHAPOLY"
4181 make test
4182}
4183
4184component_test_aead_only_ccm() {
4185 msg "build: full minus CHACHAPOLY and GCM"
4186 scripts/config.py full
4187 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4188 scripts/config.py unset MBEDTLS_GCM_C
4189 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4190 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004191 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004192
4193 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004194 make test
4195}
4196
Ronald Crone501d0e2023-07-10 08:31:19 +02004197component_test_ccm_aes_sha256() {
4198 msg "build: CCM + AES + SHA256 configuration"
4199
Ronald Cron7612d8c2023-07-20 10:03:54 +02004200 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004201 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004202
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004203 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004204
4205 msg "test: CCM + AES + SHA256 configuration"
4206 make test
4207}
4208
Dave Rodgman904c5892023-06-28 17:36:02 +01004209support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004210 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004211}
4212
Dave Rodgman904c5892023-06-28 17:36:02 +01004213component_build_tfm_armcc() {
4214 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004215 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004216
Dave Rodgman88651c42023-06-29 12:35:51 +01004217 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004218 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 +01004219}
4220
4221component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004222 # Check that the TF-M configuration can build cleanly with various
4223 # warning flags enabled. We don't build or run tests, since the
4224 # TF-M configuration needs a TF-M platform. A tweaked version of
4225 # the configuration that works on mainstream platforms is in
4226 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004227 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004228
Dave Rodgman88651c42023-06-29 12:35:51 +01004229 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004230 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 +01004231
Dave Rodgman904c5892023-06-28 17:36:02 +01004232 msg "build: TF-M config, gcc native build"
4233 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004234 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 +01004235}
4236
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004237# Test that the given .o file builds with all (valid) combinations of the given options.
4238#
4239# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4240#
4241# The validator function is the name of a function to validate the combination of options.
4242# It may be "" if all combinations are valid.
4243# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004244# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004245build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004246 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004247 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004248 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004249 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004250 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004251
Dave Rodgman42436102023-10-03 15:47:05 +01004252 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004253 for opt in "${options[@]}"; do
4254 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004255 done
4256
4257 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004258 cd $(dirname ${file})
4259 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004260
Dave Rodgman920343a2023-10-01 18:41:09 +01004261 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004262 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 +01004263
Dave Rodgman42436102023-10-03 15:47:05 +01004264 # Extract the command generated by the Makefile to build the target file.
4265 # This ensures that we have any include paths, macro definitions, etc
4266 # that may be applied by make.
4267 # 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 +01004268 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004269
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004270 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004271 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004272
Dave Rodgman28e38d82023-10-04 11:50:30 +01004273 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004274 source_file=${file%.o}.c
4275
4276 targets=0
4277 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004278
Dave Rodgman28e38d82023-10-04 11:50:30 +01004279 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004280 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004281 # each bit of $i is used to determine if options[i] will be set or not
4282 target="t"
4283 clang_args=""
4284 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004285 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004286 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004287 clang_args="${clang_args} ${opt}"
4288 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004289 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004290 done
4291
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004292 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004293 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004294 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004295 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004296
Dave Rodgman28e38d82023-10-04 11:50:30 +01004297 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004298 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004299 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004300 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004301
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004302 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004303
Dave Rodgman920343a2023-10-01 18:41:09 +01004304 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004305 make -s -f ${makefile} build_test_config_combos
4306 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004307
4308 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004309 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004310}
4311
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004312validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004313 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4314 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004315 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004316 fi
4317 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4318 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004319 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004320 fi
4321 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004322 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004323}
4324
4325component_build_aes_variations() {
4326 # 18s - around 90ms per clang invocation on M1 Pro
4327 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004328 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004329 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004330
Yanray Wangbc29aef2023-11-06 11:08:17 +08004331 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004332 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004333
Dave Rodgman42436102023-10-03 15:47:05 +01004334 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004335 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4336 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4337 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4338 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004339
4340 cd "$MBEDTLS_ROOT_DIR"
4341 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4342
Yanray Wang42be1ba2023-11-23 14:28:47 +08004343 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004344 # manually set or unset those configurations to check
4345 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004346 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4347 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4348 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4349 scripts/config.py unset MBEDTLS_DES_C
4350 scripts/config.py unset MBEDTLS_NIST_KW_C
4351 build_test_config_combos library/aes.o validate_aes_config_variations \
4352 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4353 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4354 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4355 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004356}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004357
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004358component_test_no_platform () {
4359 # Full configuration build, without platform support, file IO and net sockets.
4360 # This should catch missing mbedtls_printf definitions, and by disabling file
4361 # IO, it should catch missing '#include <stdio.h>'
4362 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004363 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004364 scripts/config.py unset MBEDTLS_PLATFORM_C
4365 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004366 scripts/config.py unset MBEDTLS_FS_IO
4367 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004368 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004369 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004370 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004371 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004372 # to re-enable platform integration features otherwise disabled in C99 builds
4373 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004374 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004375}
Gilles Peskine7c652162017-12-11 00:01:40 +01004376
4377component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004378 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004379 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4380 scripts/config.py full
4381 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004382 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4383 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4384 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4385 make
4386}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004387
Gilles Peskine8f073122018-11-27 15:58:47 +01004388component_build_no_ssl_srv () {
4389 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004390 scripts/config.py full
4391 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004392 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004393}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004394
Gilles Peskine8f073122018-11-27 15:58:47 +01004395component_build_no_ssl_cli () {
4396 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004397 scripts/config.py full
4398 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004399 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004400}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004401
Gilles Peskine8f073122018-11-27 15:58:47 +01004402component_build_no_sockets () {
4403 # Note, C99 compliance can also be tested with the sockets support disabled,
4404 # as that requires a POSIX platform (which isn't the same as C99).
4405 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004406 scripts/config.py full
4407 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4408 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4409 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4410}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004411
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004412component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004413 msg "build: default config with memory buffer allocator and backtrace enabled"
4414 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4415 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4416 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004417 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004418 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004419 make
4420
4421 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4422 make test
4423}
4424
4425component_test_memory_buffer_allocator () {
4426 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004427 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4428 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004429 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004430 make
4431
4432 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4433 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004434
4435 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4436 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004437 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004438}
4439
Gilles Peskine8f073122018-11-27 15:58:47 +01004440component_test_no_max_fragment_length () {
4441 # Run max fragment length tests with MFL disabled
4442 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004443 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004444 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004445 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004446
Gilles Peskine8f073122018-11-27 15:58:47 +01004447 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004448 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004449}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004450
Hanno Becker545ced42019-02-19 11:10:48 +00004451component_test_asan_remove_peer_certificate () {
4452 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004453 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004454 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004455 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004456 make
4457
4458 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4459 make test
4460
4461 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004462 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004463
4464 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004465 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004466
4467 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004468 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004469}
4470
Gilles Peskine8f073122018-11-27 15:58:47 +01004471component_test_no_max_fragment_length_small_ssl_out_content_len () {
4472 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004473 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4474 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4475 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004476 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004477 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004478
Gilles Peskine8f073122018-11-27 15:58:47 +01004479 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004480 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004481
4482 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004483 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004484}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004485
Darryl Greenaad82f92019-12-02 10:53:11 +00004486component_test_variable_ssl_in_out_buffer_len () {
4487 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4488 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004489 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004490 make
4491
4492 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4493 make test
4494
4495 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004496 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004497
4498 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004499 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004500}
4501
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004502component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004503 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004504 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004505
Dave Rodgman17127e92023-12-14 16:42:48 +00004506 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004507 make
4508
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004509 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004510 make test
4511
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004512 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004513 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004514
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004515 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004516 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004517}
4518
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004519component_test_ssl_alloc_buffer_and_mfl () {
4520 msg "build: default config with memory buffer allocator and MFL extension"
4521 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4522 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4523 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4524 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4525 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004526 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004527 make
4528
4529 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4530 make test
4531
4532 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 +02004533 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004534}
4535
Gilles Peskine636c26a2020-03-04 20:46:15 +01004536component_test_when_no_ciphersuites_have_mac () {
4537 msg "build: when no ciphersuites have MAC"
4538 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004539 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004540 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004541 make
4542
4543 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4544 make test
4545
4546 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004547 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004548}
4549
Raoul Strackxa4e86142020-06-15 17:03:13 +02004550component_test_no_date_time () {
4551 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4552 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004553 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004554 make
4555
4556 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4557 make test
4558}
4559
Gilles Peskine8f073122018-11-27 15:58:47 +01004560component_test_platform_calloc_macro () {
4561 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004562 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4563 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4564 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004565 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004566 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004567
Gilles Peskine8f073122018-11-27 15:58:47 +01004568 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4569 make test
4570}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004571
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004572component_test_malloc_0_null () {
4573 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004574 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004575 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 +02004576
4577 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4578 make test
4579
4580 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4581 # Just the calloc selftest. "make test" ran the others as part of the
4582 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004583 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004584
4585 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4586 # Run a subset of the tests. The choice is a balance between coverage
4587 # and time (including time indirectly wasted due to flaky tests).
4588 # The current choice is to skip tests whose description includes
4589 # "proxy", which is an approximation of skipping tests that use the
4590 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004591 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004592}
4593
Dave Rodgman6a08b682023-06-19 11:51:33 +01004594support_test_aesni() {
4595 # Check that gcc targets x86_64 (we can build AESNI), and check for
4596 # AESNI support on the host (we can run AESNI).
4597 #
4598 # The name of this function is possibly slightly misleading, but needs to align
4599 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004600 #
4601 # In principle 32-bit x86 can support AESNI, but our implementation does not
4602 # support 32-bit x86, so we check for x86-64.
4603 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004604 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4605 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004606 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004607}
4608
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004609component_test_aesni () { # ~ 60s
4610 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4611 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4612 #
4613 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4614 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4615 # exercise the plain C impl).
4616
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004617 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004618 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004619 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004620 scripts/config.py set MBEDTLS_HAVE_ASM
4621
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004622 # test the intrinsics implementation
4623 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004624 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004625 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004626 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004627 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004628
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004629 # test the asm implementation
4630 msg "AES tests, test assembly"
4631 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004632 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004633 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004634 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004635
4636 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004637 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004638 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004639 msg "AES tests, plain C"
4640 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004641 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004642 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004643 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004644 not grep -q "AES note: using AESNI" ./programs/test/selftest
4645 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004646
4647 # test the intrinsics implementation
4648 scripts/config.py set MBEDTLS_AESNI_C
4649 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4650 msg "AES tests, test AESNI only"
4651 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004652 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004653 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4654 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004655 grep -q "AES note: using AESNI" ./programs/test/selftest
4656 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004657}
4658
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004659component_test_sha3_variations() {
4660 msg "sha3 loop unroll variations"
4661
4662 # define minimal config sufficient to test SHA3
4663 cat > include/mbedtls/mbedtls_config.h << END
4664 #define MBEDTLS_SELF_TEST
4665 #define MBEDTLS_SHA3_C
4666END
4667
4668 msg "all loops unrolled"
4669 make clean
4670 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"
4671 ./tests/test_suite_shax
4672
4673 msg "all loops rolled up"
4674 make clean
4675 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"
4676 ./tests/test_suite_shax
4677}
4678
Jerry Yub6d39c22023-08-16 15:11:48 +08004679support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004680 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004681}
4682
4683component_test_aesni_m32 () { # ~ 60s
4684 # This tests are duplicated from component_test_aesni for i386 target
4685 #
4686 # AESNI intrinsic code supports i386 and assembly code does not support it.
4687
4688 msg "build: default config with different AES implementations"
4689 scripts/config.py set MBEDTLS_AESNI_C
4690 scripts/config.py set MBEDTLS_PADLOCK_C
4691 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4692 scripts/config.py set MBEDTLS_HAVE_ASM
4693
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004694 # test the intrinsics implementation with gcc
4695 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004696 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004697 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004698 # check that we built intrinsics - this should be used by default when supported by the compiler
4699 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4700 grep -q "AES note: using AESNI" ./programs/test/selftest
4701 grep -q "AES note: built-in implementation." ./programs/test/selftest
4702 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4703 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4704
4705 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004706 scripts/config.py unset MBEDTLS_PADLOCK_C
4707 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4708 msg "AES tests, test AESNI only"
4709 make clean
4710 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4711 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4712 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4713 grep -q "AES note: using AESNI" ./programs/test/selftest
4714 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4715 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4716 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4717}
4718
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004719support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004720 # clang >= 4 is required to build with target attributes
4721 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004722}
4723
4724component_test_aesni_m32_clang() {
4725
4726 scripts/config.py set MBEDTLS_AESNI_C
4727 scripts/config.py set MBEDTLS_PADLOCK_C
4728 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4729 scripts/config.py set MBEDTLS_HAVE_ASM
4730
4731 # test the intrinsics implementation with clang
4732 msg "AES tests, test intrinsics (clang)"
4733 make clean
4734 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4735 # check that we built intrinsics - this should be used by default when supported by the compiler
4736 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4737 grep -q "AES note: using AESNI" ./programs/test/selftest
4738 grep -q "AES note: built-in implementation." ./programs/test/selftest
4739 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4740 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4741}
4742
Jerry Yu193cbc02023-08-03 17:06:29 +08004743# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4744component_build_aes_aesce_armcc () {
4745 msg "Build: AESCE test on arm64 platform without plain C."
4746 scripts/config.py baremetal
4747
4748 # armc[56] don't support SHA-512 intrinsics
4749 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4750
4751 # Stop armclang warning about feature detection for A64_CRYPTO.
4752 # With this enabled, the library does build correctly under armclang,
4753 # but in baremetal builds (as tested here), feature detection is
4754 # unavailable, and the user is notified via a #warning. So enabling
4755 # this feature would prevent us from building with -Werror on
4756 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004757 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004758 scripts/config.py set MBEDTLS_HAVE_ASM
4759
4760 msg "AESCE, build with default configuration."
4761 scripts/config.py set MBEDTLS_AESCE_C
4762 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4763 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4764
4765 msg "AESCE, build AESCE only"
4766 scripts/config.py set MBEDTLS_AESCE_C
4767 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4768 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4769}
4770
Dave Rodgman0c584032023-10-08 12:26:54 +01004771support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004772 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004773 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004774}
4775
4776component_build_aes_armce () {
4777 # Test variations of AES with Armv8 crypto extensions
4778 scripts/config.py set MBEDTLS_AESCE_C
4779 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4780
4781 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004782 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004783
4784 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4785 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4786
4787 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4788 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4789
Dave Rodgman5e419372023-10-23 15:30:20 +01004790 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004791
Dave Rodgman5e419372023-10-23 15:30:20 +01004792 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4793 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004794
Dave Rodgman5e419372023-10-23 15:30:20 +01004795 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4796 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004797
Dave Rodgman5e419372023-10-23 15:30:20 +01004798 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4799 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004800
4801 # test for presence of AES instructions
4802 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4803 msg "clang, test A32 crypto instructions built"
4804 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4805 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4806 msg "clang, test T32 crypto instructions built"
4807 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4808 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4809 msg "clang, test aarch64 crypto instructions built"
4810 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4811 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4812
4813 # test for absence of AES instructions
4814 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4815 scripts/config.py unset MBEDTLS_AESCE_C
4816 msg "clang, test A32 crypto instructions not built"
4817 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4818 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4819 msg "clang, test T32 crypto instructions not built"
4820 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4821 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4822 msg "clang, test aarch64 crypto instructions not built"
4823 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4824 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004825}
4826
Dave Rodgman9ed18532023-10-05 00:06:47 +01004827support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004828 # clang >= 4 is required to build with SHA extensions
4829 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004830}
4831
Dave Rodgmand9e80832023-10-04 17:17:46 +01004832component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004833 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004834
4835
4836 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004837 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004838 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4839 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4840 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4841 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4842 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004843
Dave Rodgmand9e80832023-10-04 17:17:46 +01004844
Dave Rodgman94a634d2023-10-10 12:59:29 +01004845 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004846 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004847 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4848 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4849 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004850
Dave Rodgman5b89c552023-10-10 14:59:02 +01004851 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004852 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4853 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4854 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004855
Dave Rodgmancd654002023-10-05 09:40:07 +01004856
Dave Rodgman94a634d2023-10-10 12:59:29 +01004857 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004858 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004859 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4860 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4861 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4862 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4863 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004864
Dave Rodgmancd654002023-10-05 09:40:07 +01004865
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004866 # examine the disassembly for presence of SHA instructions
4867 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4868 scripts/config.py set ${opt}
4869 msg "${opt} clang, test A32 crypto instructions built"
4870 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4871 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4872
4873 msg "${opt} clang, test T32 crypto instructions built"
4874 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4875 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4876
4877 msg "${opt} clang, test aarch64 crypto instructions built"
4878 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4879 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4880 scripts/config.py unset ${opt}
4881 done
4882
4883
4884 # examine the disassembly for absence of SHA instructions
4885 msg "clang, test A32 crypto instructions not built"
4886 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4887 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4888
4889 msg "clang, test T32 crypto instructions not built"
4890 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4891 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4892
4893 msg "clang, test aarch64 crypto instructions not built"
4894 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4895 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004896}
4897
Jerry Yuc935aa62023-08-03 17:08:27 +08004898# For timebeing, no VIA Padlock platform available.
4899component_build_aes_via_padlock () {
4900
4901 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004902 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004903 scripts/config.py set MBEDTLS_PADLOCK_C
4904 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00004905 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004906 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004907
4908}
4909
4910support_build_aes_via_padlock_only () {
4911 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4912 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4913 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4914}
4915
Jerry Yu193cbc02023-08-03 17:06:29 +08004916support_build_aes_aesce_armcc () {
4917 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004918}
4919
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004920component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004921 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004922 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004923 scripts/config.py unset MBEDTLS_PADLOCK_C
4924
Dave Rodgmand8d64512023-12-19 12:20:21 +00004925 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004926
4927 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4928 make test
4929}
4930
4931component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4932 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4933 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004934 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4935 scripts/config.py unset MBEDTLS_PADLOCK_C
4936
Hanno Becker83ebf782017-07-07 12:29:15 +01004937 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004938
4939 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004940 make test
4941}
Gilles Peskine8f073122018-11-27 15:58:47 +01004942
Hanno Becker83ebf782017-07-07 12:29:15 +01004943component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004944 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4945 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4946 scripts/config.py unset MBEDTLS_PADLOCK_C
4947 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004948 scripts/config.py unset MBEDTLS_AESCE_C
4949
Dave Rodgmand8d64512023-12-19 12:20:21 +00004950 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004951
4952 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004953 make test
4954
4955 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4956 programs/test/selftest
4957}
4958
Matthias Schulz0767fda2024-02-07 10:46:28 +01004959component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004960 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4961 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004962 scripts/config.py unset MBEDTLS_PADLOCK_C
4963 scripts/config.py unset MBEDTLS_AESNI_C
4964 scripts/config.py unset MBEDTLS_AESCE_C
4965
4966 make CFLAGS='-O2 -Werror -Wall -Wextra'
4967
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004968 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004969 make test
4970}
4971
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004972component_test_aes_fewer_tables () {
4973 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004974 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004975 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004976
Gilles Peskine7c652162017-12-11 00:01:40 +01004977 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004978 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004979}
4980
4981component_test_aes_rom_tables () {
4982 msg "build: default config with AES_ROM_TABLES enabled"
4983 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004984 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004985
4986 msg "test: AES_ROM_TABLES"
4987 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004988}
4989
Gilles Peskine14c3c062018-01-29 21:25:12 +01004990component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004991 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4992 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4993 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004994 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004995
Gilles Peskine8f073122018-11-27 15:58:47 +01004996 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4997 make test
4998}
4999
Yanray Wang49cd4b52023-11-10 11:58:37 +08005000# helper for common_block_cipher_no_decrypt() which:
5001# - enable/disable the list of config options passed from -s/-u respectively.
5002# - build
5003# - test for tests_suite_xxx
5004# - selftest
5005#
5006# Usage: helper_block_cipher_no_decrypt_build_test
5007# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5008# Options: -s set_opts the list of config options to enable
5009# -u unset_opts the list of config options to disable
5010# -c cflags the list of options passed to CFLAGS
5011# -l ldflags the list of options passed to LDFLAGS
5012helper_block_cipher_no_decrypt_build_test () {
5013 while [ $# -gt 0 ]; do
5014 case "$1" in
5015 -s)
5016 shift; local set_opts="$1";;
5017 -u)
5018 shift; local unset_opts="$1";;
5019 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005020 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005021 -l)
5022 shift; local ldflags="$1";;
5023 esac
5024 shift
5025 done
5026 set_opts="${set_opts:-}"
5027 unset_opts="${unset_opts:-}"
5028 cflags="${cflags:-}"
5029 ldflags="${ldflags:-}"
5030
Yanray Wangb2d6e522023-11-13 16:57:47 +08005031 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5032 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005033
5034 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5035 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005036 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005037
5038 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5039 not grep mbedtls_aes_setkey_dec library/aes.o
5040 not grep mbedtls_aria_setkey_dec library/aria.o
5041 not grep mbedtls_camellia_setkey_dec library/camellia.o
5042 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5043 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005044 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5045 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005046
5047 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5048 make test
5049
5050 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5051 programs/test/selftest
5052}
5053
5054# This is a common configuration function used in:
5055# - component_test_block_cipher_no_decrypt_aesni_legacy()
5056# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5057# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5058# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5059# on x86.
5060common_block_cipher_no_decrypt () {
5061 # test AESNI intrinsics
5062 helper_block_cipher_no_decrypt_build_test \
5063 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005064 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005065
5066 # test AESNI assembly
5067 helper_block_cipher_no_decrypt_build_test \
5068 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005069 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005070
5071 # test AES C implementation
5072 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005073 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005074
5075 # test AESNI intrinsics for i386 target
5076 helper_block_cipher_no_decrypt_build_test \
5077 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005078 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005079 -l "-m32"
5080}
5081
Yanray Wang3ae11992023-11-13 17:32:09 +08005082# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5083# usage: 0: no PSA crypto configuration
5084# 1: use PSA crypto configuration
5085config_block_cipher_no_decrypt () {
5086 use_psa=$1
5087
Yanray Wang66111392023-10-31 18:54:54 +08005088 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005089 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5090 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005091 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005092 scripts/config.py unset MBEDTLS_NIST_KW_C
5093
Yanray Wang3ae11992023-11-13 17:32:09 +08005094 if [ "$use_psa" -eq 1 ]; then
5095 # Enable support for cryptographic mechanisms through the PSA API.
5096 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5097 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5098 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5099 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5100 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5101 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5102 fi
5103}
5104
5105component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005106 # This consistently causes an llvm crash on clang 3.8, so use gcc
5107 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005108 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005109 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005110}
5111
Yanray Wangf1496402023-11-01 18:55:13 +08005112component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005113 # This consistently causes an llvm crash on clang 3.8, so use gcc
5114 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005115 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005116 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005117}
5118
Yanray Wang66111392023-10-31 18:54:54 +08005119support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005120 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005121}
5122
Yanray Wang66111392023-10-31 18:54:54 +08005123component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005124 scripts/config.py baremetal
5125
5126 # armc[56] don't support SHA-512 intrinsics
5127 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5128
5129 # Stop armclang warning about feature detection for A64_CRYPTO.
5130 # With this enabled, the library does build correctly under armclang,
5131 # but in baremetal builds (as tested here), feature detection is
5132 # unavailable, and the user is notified via a #warning. So enabling
5133 # this feature would prevent us from building with -Werror on
5134 # armclang. Tracked in #7198.
5135 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5136 scripts/config.py set MBEDTLS_HAVE_ASM
5137
Yanray Wang3ae11992023-11-13 17:32:09 +08005138 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005139
5140 # test AESCE baremetal build
5141 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005142 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005143 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005144
Yanray Wangef1b04d2023-09-08 11:09:26 +08005145 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5146 not grep mbedtls_aes_setkey_dec library/aes.o
5147 not grep mbedtls_aria_setkey_dec library/aria.o
5148 not grep mbedtls_camellia_setkey_dec library/camellia.o
5149 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5150 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005151 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005152 not grep mbedtls_aesce_inverse_key library/aesce.o
5153 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005154}
5155
Gilles Peskine592f5912019-10-07 18:49:32 +02005156component_test_ctr_drbg_aes_256_sha_256 () {
5157 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5158 scripts/config.py full
5159 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5160 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005161 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005162 make
5163
5164 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5165 make test
5166}
5167
5168component_test_ctr_drbg_aes_128_sha_512 () {
5169 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005170 scripts/config.py full
5171 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5172 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005173 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005174 make
5175
5176 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5177 make test
5178}
5179
5180component_test_ctr_drbg_aes_128_sha_256 () {
5181 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005182 scripts/config.py full
5183 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5184 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5185 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005186 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005187 make
5188
5189 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5190 make test
5191}
5192
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005193component_test_se_default () {
5194 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005195 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005196 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005197
5198 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5199 make test
5200}
5201
Steven Cooremand57203d2020-07-16 20:28:59 +02005202component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005203 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005204 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005205 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005206 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5207 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005208 loc_cflags="${loc_cflags} -I../tests/include -O2"
5209
Gilles Peskine21570cf2023-12-22 11:49:50 +01005210 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005211
Gilles Peskine1997f302023-07-26 18:45:20 +02005212 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005213 make test
5214}
5215
Gilles Peskine8f073122018-11-27 15:58:47 +01005216component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005217 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005218 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005219 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005220 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005221}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005222
Gilles Peskinecf740502019-07-03 20:43:05 +02005223component_test_cmake_shared () {
5224 msg "build/test: cmake shared" # ~ 2min
5225 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5226 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005227 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005228 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005229 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005230}
5231
Gilles Peskineec10bf12019-09-20 19:56:06 +02005232test_build_opt () {
5233 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005234 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005235 for opt in "$@"; do
5236 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005237 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005238 # We're confident enough in compilers to not run _all_ the tests,
5239 # but at least run the unit tests. In particular, runs with
5240 # optimizations use inline assembly whereas runs with -O0
5241 # skip inline assembly.
5242 make test # ~30s
5243 make clean
5244 done
5245}
5246
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005247# For FreeBSD we invoke the function by name so this condition is added
5248# to disable the existing test_clang_opt function for linux.
5249if [[ $(uname) != "Linux" ]]; then
5250 component_test_clang_opt () {
5251 scripts/config.py full
5252 test_build_opt 'full config' clang -O0 -Os -O2
5253 }
5254fi
5255
5256component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005257 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005258 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005259}
5260support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005261 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005262}
5263
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005264component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005265 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005266 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005267}
5268support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005269 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005270}
5271
5272component_test_gcc_latest_opt () {
5273 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005274 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005275}
5276support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005277 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005278}
5279
5280component_test_gcc_earliest_opt () {
5281 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005282 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005283}
5284support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005285 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005286}
5287
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005288component_build_mbedtls_config_file () {
5289 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005290 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005291 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005292 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005293 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005294 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5295 make clean
5296
5297 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5298 # In the user config, disable one feature (for simplicity, pick a feature
5299 # that nothing else depends on).
5300 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005301 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005302 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5303
5304 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005305}
5306
Gilles Peskine7d904e72022-04-07 21:59:14 +02005307component_build_psa_config_file () {
5308 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5309 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5310 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5311 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5312 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005313 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005314 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5315 make clean
5316
5317 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
5318 # In the user config, disable one feature, which will reflect on the
5319 # mbedtls configuration so we can query it with query_compile_time_config.
5320 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
5321 scripts/config.py unset MBEDTLS_CMAC_C
5322 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5323 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5324
5325 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005326}
5327
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005328component_build_psa_alt_headers () {
5329 msg "build: make with PSA alt headers" # ~20s
5330
5331 # Generate alternative versions of the substitutable headers with the
5332 # same content except different include guards.
5333 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5334
5335 # Build the library and some programs.
5336 # Don't build the fuzzers to avoid having to go through hoops to set
5337 # a correct include path for programs/fuzz/Makefile.
5338 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
5339 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\"'"
5340
5341 # Check that we're getting the alternative include guards and not the
5342 # original include guards.
5343 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5344 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5345 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5346 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5347}
5348
Dave Rodgman852de3c2023-12-14 14:46:45 +00005349component_test_m32_no_asm () {
5350 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005351 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005352 #
5353 # Note that we require gcc, because clang Asan builds fail to link for
5354 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005355 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005356 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005357 scripts/config.py unset MBEDTLS_HAVE_ASM
5358 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005359 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005360 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005361
Dave Rodgman852de3c2023-12-14 14:46:45 +00005362 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005363 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005364}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005365support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005366 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005367 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005368 *) false;;
5369 esac
5370}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005371
Gilles Peskineff0aee02021-10-05 09:36:03 +02005372component_test_m32_o2 () {
5373 # Build with optimization, to use the i386 specific inline assembly
5374 # and go faster for tests.
5375 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005376 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005377 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005378 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005379
Gilles Peskineff0aee02021-10-05 09:36:03 +02005380 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005381 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005382
Gilles Peskineff0aee02021-10-05 09:36:03 +02005383 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005384 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005385}
Gilles Peskinecf522222021-10-07 19:25:29 +02005386support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005387 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005388}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005389
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005390component_test_m32_everest () {
5391 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005392 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005393 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005394 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005395
5396 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5397 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005398
5399 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005400 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005401
5402 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5403 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005404 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005405}
5406support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005407 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005408}
5409
Gilles Peskine8f073122018-11-27 15:58:47 +01005410component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005411 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005412 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005413 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005414
5415 msg "test: 64-bit ILP32, make, gcc"
5416 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005417}
Gilles Peskine878cf602019-01-06 20:50:38 +00005418support_test_mx32 () {
5419 case $(uname -m) in
5420 amd64|x86_64) true;;
5421 *) false;;
5422 esac
5423}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005424
Peter Kolbus60c6da22018-12-27 06:59:04 -06005425component_test_min_mpi_window_size () {
5426 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005427 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005428 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005429 make
5430
5431 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5432 make test
5433}
5434
Gilles Peskine8f073122018-11-27 15:58:47 +01005435component_test_have_int32 () {
5436 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005437 scripts/config.py unset MBEDTLS_HAVE_ASM
5438 scripts/config.py unset MBEDTLS_AESNI_C
5439 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005440 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005441 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005442
Gilles Peskine8f073122018-11-27 15:58:47 +01005443 msg "test: gcc, force 32-bit bignum limbs"
5444 make test
5445}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005446
Gilles Peskine8f073122018-11-27 15:58:47 +01005447component_test_have_int64 () {
5448 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005449 scripts/config.py unset MBEDTLS_HAVE_ASM
5450 scripts/config.py unset MBEDTLS_AESNI_C
5451 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005452 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005453 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005454
Gilles Peskine8f073122018-11-27 15:58:47 +01005455 msg "test: gcc, force 64-bit bignum limbs"
5456 make test
5457}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005458
Gabor Mezeie256cc12023-07-26 17:28:48 +02005459component_test_have_int32_cmake_new_bignum () {
5460 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5461 scripts/config.py unset MBEDTLS_HAVE_ASM
5462 scripts/config.py unset MBEDTLS_AESNI_C
5463 scripts/config.py unset MBEDTLS_PADLOCK_C
5464 scripts/config.py unset MBEDTLS_AESCE_C
5465 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005466 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005467 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005468
5469 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5470 make test
5471}
5472
Gilles Peskine8f073122018-11-27 15:58:47 +01005473component_test_no_udbl_division () {
5474 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005475 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005476 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005477 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005478
Gilles Peskine8f073122018-11-27 15:58:47 +01005479 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5480 make test
5481}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005482
Gilles Peskine8f073122018-11-27 15:58:47 +01005483component_test_no_64bit_multiplication () {
5484 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005485 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005486 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005487 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005488
Gilles Peskine8f073122018-11-27 15:58:47 +01005489 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5490 make test
5491}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005492
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005493component_test_no_strings () {
5494 msg "build: no strings" # ~10s
5495 scripts/config.py full
5496 # Disable options that activate a large amount of string constants.
5497 scripts/config.py unset MBEDTLS_DEBUG_C
5498 scripts/config.py unset MBEDTLS_ERROR_C
5499 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5500 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005501 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005502
5503 msg "test: no strings" # ~ 10s
5504 make test
5505}
5506
Hanno Beckerc5722d12020-10-09 11:10:42 +01005507component_test_no_x509_info () {
5508 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5509 scripts/config.pl full
5510 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5511 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005512 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005513
5514 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5515 make test
5516
5517 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005518 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005519}
5520
Gilles Peskine8f073122018-11-27 15:58:47 +01005521component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005522 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005523 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005524 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 +02005525
Gilles Peskinee36fe812021-09-01 20:00:33 +02005526 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005527 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005528}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005529
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005530component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005531 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005532 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005533 # Build for a target platform that's close to what Debian uses
5534 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005535 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005536 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005537 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005538 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'
5539
Gilles Peskinee36fe812021-09-01 20:00:33 +02005540 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005541 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005542}
5543support_build_arm_linux_gnueabi_gcc_arm5vte () {
5544 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5545}
5546
5547component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005548 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005549 scripts/config.py baremetal
5550 # This is an imperfect substitute for
5551 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005552 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005553 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 +02005554
Gilles Peskinee36fe812021-09-01 20:00:33 +02005555 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005556 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005557}
5558
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005559component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005560 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5561 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005562 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 +02005563
Gilles Peskinee36fe812021-09-01 20:00:33 +02005564 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005565 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005566 for lib in library/*.a; do
5567 echo "$lib:"
5568 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5569 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005570}
5571
Gilles Peskine8f073122018-11-27 15:58:47 +01005572component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005573 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005574 scripts/config.py baremetal
5575 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005576 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 +01005577 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005578 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005579}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005580
Gilles Peskine8f073122018-11-27 15:58:47 +01005581component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005582 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005583 scripts/config.py baremetal
5584 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005585 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 +01005586 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005587 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005588}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005589
Dave Rodgman8c315f22023-06-02 10:26:24 -04005590component_build_arm_clang_thumb () {
5591 # ~ 30s
5592
5593 scripts/config.py baremetal
5594
5595 msg "build: clang thumb 2, make"
5596 make clean
5597 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5598
5599 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5600 msg "build: clang thumb 1 -O0, make"
5601 make clean
5602 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5603
5604 msg "build: clang thumb 1 -Os, make"
5605 make clean
5606 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5607}
5608
Gilles Peskine8f073122018-11-27 15:58:47 +01005609component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005610 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005611 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005612 # armc[56] don't support SHA-512 intrinsics
5613 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005614
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005615 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5616 scripts/config.py unset MBEDTLS_AESCE_C
5617
Dave Rodgman0fddf822023-03-02 15:32:12 +00005618 # Stop armclang warning about feature detection for A64_CRYPTO.
5619 # With this enabled, the library does build correctly under armclang,
5620 # but in baremetal builds (as tested here), feature detection is
5621 # unavailable, and the user is notified via a #warning. So enabling
5622 # this feature would prevent us from building with -Werror on
5623 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005624 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005625
Hanno Beckerf0762e92022-07-15 12:08:19 +01005626 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005627
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005628 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005629
5630 msg "size: ARM Compiler 5"
5631 "$ARMC5_FROMELF" -z library/*.o
5632
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005633 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005634
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005635 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005636 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005637
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005638 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005639 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5640
5641 # ARM Compiler 6 - Target ARMv7-M+DSP
5642 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005643
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005644 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005645 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005646
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005647 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005648 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005649
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005650 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5651 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5652
Dave Rodgman99318e62023-05-24 12:27:42 +01005653 # ARM Compiler 6 - Target Cortex-M0
5654 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005655
5656 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5657 #
5658 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5659 # that we have in our CI
5660 scripts/config.py set MBEDTLS_AESCE_C
5661 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005662}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005663
Pengyu Lvdf070032023-02-24 16:03:31 +08005664support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005665 armc5_cc="$ARMC5_BIN_DIR/armcc"
5666 armc6_cc="$ARMC6_BIN_DIR/armclang"
5667 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005668}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005669
Ronald Crond2cb7f42024-03-18 12:49:18 +01005670component_test_tls12_only () {
5671 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5672 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5673 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5674 make
5675
5676 msg "test: main suites (inc. selftests) (ASan build)"
5677 make test
5678
5679 msg "test: ssl-opt.sh (ASan build)"
5680 tests/ssl-opt.sh
5681
5682 msg "test: compat.sh (ASan build)"
5683 tests/compat.sh
5684}
5685
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005686component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005687 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005688 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005689 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005690 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5691
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005692 msg "test: TLS 1.3 only, all key exchange modes enabled"
5693 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005694
Ronald Cronc3f43b62022-10-17 17:35:32 +02005695 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5696 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005697}
5698
Ronald Cronc3f43b62022-10-17 17:35:32 +02005699component_test_tls13_only_psk () {
5700 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5701 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5702 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5703 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005704 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005705 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5706 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5707 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5708 scripts/config.py unset MBEDTLS_ECDSA_C
5709 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005710 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005711 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005712 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5713
Ronald Cronc3f43b62022-10-17 17:35:32 +02005714 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5715 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005716
Ronald Cronc3f43b62022-10-17 17:35:32 +02005717 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5718 tests/ssl-opt.sh
5719}
5720
5721component_test_tls13_only_ephemeral () {
5722 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5723 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5724 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005725 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005726 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5727
5728 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5729 cd tests; ./test_suite_ssl; cd ..
5730
5731 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5732 tests/ssl-opt.sh
5733}
5734
Przemek Stekiela01c2422023-06-13 10:46:48 +02005735component_test_tls13_only_ephemeral_ffdh () {
5736 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5737 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5738 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5739 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005740 scripts/config.py unset MBEDTLS_ECDH_C
5741
Przemek Stekiela01c2422023-06-13 10:46:48 +02005742 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5743
5744 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5745 cd tests; ./test_suite_ssl; cd ..
5746
5747 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5748 tests/ssl-opt.sh
5749}
5750
Ronald Cronc3f43b62022-10-17 17:35:32 +02005751component_test_tls13_only_psk_ephemeral () {
5752 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5753 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5754 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5755 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5756 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5757 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5758 scripts/config.py unset MBEDTLS_ECDSA_C
5759 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005760 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005761 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005762 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5763
5764 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5765 cd tests; ./test_suite_ssl; cd ..
5766
5767 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5768 tests/ssl-opt.sh
5769}
5770
Przemek Stekiela01c2422023-06-13 10:46:48 +02005771component_test_tls13_only_psk_ephemeral_ffdh () {
5772 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5773 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5774 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5775 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5776 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5777 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5778 scripts/config.py unset MBEDTLS_ECDSA_C
5779 scripts/config.py unset MBEDTLS_PKCS1_V21
5780 scripts/config.py unset MBEDTLS_PKCS7_C
5781 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005782 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005783 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5784
5785 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5786 cd tests; ./test_suite_ssl; cd ..
5787
5788 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5789 tests/ssl-opt.sh
5790}
5791
Ronald Cronc3f43b62022-10-17 17:35:32 +02005792component_test_tls13_only_psk_all () {
5793 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5794 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5795 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5796 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5797 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5798 scripts/config.py unset MBEDTLS_ECDSA_C
5799 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005800 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005801 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005802 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5803
5804 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5805 cd tests; ./test_suite_ssl; cd ..
5806
5807 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5808 tests/ssl-opt.sh
5809}
5810
5811component_test_tls13_only_ephemeral_all () {
5812 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5813 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005814 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005815 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5816
5817 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5818 cd tests; ./test_suite_ssl; cd ..
5819
5820 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5821 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005822}
5823
Ronald Cron46ac0652024-03-18 12:39:04 +01005824component_test_tls13_no_padding () {
5825 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005826 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005827 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005828 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005829 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005830 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005831 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005832 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005833 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005834}
5835
Ronald Cron6f135e12021-12-08 16:57:54 +01005836component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005837 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005838 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005839 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005840 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005841 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005842 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005843 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005844 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005845 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005846}
5847
Ronald Crondd96c0a2024-04-02 12:34:24 +02005848component_test_full_minus_session_tickets() {
5849 msg "build: full config without session tickets"
5850 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005851 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005852 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005853 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5854 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005855 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005856 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005857 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005858 tests/ssl-opt.sh
5859}
5860
Gilles Peskine8f073122018-11-27 15:58:47 +01005861component_build_mingw () {
5862 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005863 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 +00005864
Gilles Peskine8f073122018-11-27 15:58:47 +01005865 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005866 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 +01005867 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005868
Gilles Peskine8f073122018-11-27 15:58:47 +01005869 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005870 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
5871 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 +01005872 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005873
Pengyu Lv158eead2023-10-19 11:27:05 +08005874 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005875 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005876 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 +01005877 make WINDOWS_BUILD=1 clean
5878}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005879support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005880 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5881 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005882 *) true;;
5883 esac
5884}
Simon Butcher91aef332016-11-17 09:20:50 +00005885
Gilles Peskine8f073122018-11-27 15:58:47 +01005886component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005887 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005888 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005889 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5890 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005891
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005892 msg "test: main suites (MSan)" # ~ 10s
5893 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005894
Gilles Peskine6848d172023-11-02 19:58:03 +01005895 msg "test: metatests (MSan)"
5896 tests/scripts/run-metatests.sh any msan
5897
Gilles Peskine82b27272019-06-14 18:27:03 +02005898 msg "program demos (MSan)" # ~20s
5899 tests/scripts/run_demos.py
5900
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005901 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005902 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005903
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005904 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005905
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005906 if [ "$MEMORY" -gt 0 ]; then
5907 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005908 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005909 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005910}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005911
Bence Szépkúti0354d042023-12-06 16:14:37 +01005912component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005913 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005914 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005915 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5916 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005917
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005918 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005919 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005920
Gilles Peskine636c26a2020-03-04 20:46:15 +01005921 # Optional parts (slow; currently broken on OS X because programs don't
5922 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005923 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005924 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005925 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005926 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005927 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005928
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005929 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005930 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005931 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005932 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005933
5934 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005935 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005936 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005937 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005938}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005939
Bence Szépkúti0354d042023-12-06 16:14:37 +01005940component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005941 msg "build: Release, full (clang)"
5942 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5943 scripts/config.py full
5944 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5945 make
5946
5947 msg "test: main suites, Valgrind (full config)"
5948 make memcheck
5949}
5950
Paul Elliott62dc3922021-11-25 17:29:40 +00005951support_test_cmake_out_of_source () {
5952 distrib_id=""
5953 distrib_ver=""
5954 distrib_ver_minor=""
5955 distrib_ver_major=""
5956
5957 # Attempt to parse lsb-release to find out distribution and version. If not
5958 # found this should fail safe (test is supported).
5959 if [[ -f /etc/lsb-release ]]; then
5960
5961 while read -r lsb_line; do
5962 case "$lsb_line" in
5963 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5964 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5965 esac
5966 done < /etc/lsb-release
5967
5968 distrib_ver_major="${distrib_ver%%.*}"
5969 distrib_ver="${distrib_ver#*.}"
5970 distrib_ver_minor="${distrib_ver%%.*}"
5971 fi
5972
5973 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5974 # processor (as the CI does) can create a race condition whereby the build
5975 # fails to see a generated file, despite that file actually having been
5976 # generated. This problem appears to go away with 18.04 or newer, so make
5977 # the out of source tests unsupported on Ubuntu 16.04.
5978 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5979}
5980
Gilles Peskine8f073122018-11-27 15:58:47 +01005981component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005982 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005983 # generates
5984 make neat
5985
Gilles Peskine8f073122018-11-27 15:58:47 +01005986 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005987 MBEDTLS_ROOT_DIR="$PWD"
5988 mkdir "$OUT_OF_SOURCE_DIR"
5989 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005990 # Note: Explicitly generate files as these are turned off in releases
5991 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005992 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005993
Gilles Peskine8f073122018-11-27 15:58:47 +01005994 msg "test: cmake 'out-of-source' build"
5995 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005996 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005997 # Also ensure that there are no error messages such as
5998 # "No such file or directory", which would indicate that some required
5999 # file is missing (ssl-opt.sh tolerates the absence of some files so
6000 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006001 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006002 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006003 cat ssl-opt.err >&2
6004 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006005 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006006 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006007 cd "$MBEDTLS_ROOT_DIR"
6008 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006009}
Andres AGdc192212016-08-31 17:33:13 +01006010
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006011component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006012 # Remove existing generated files so that we use the ones CMake
6013 # generates
6014 make neat
6015
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006016 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006017 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006018 # Note: Explicitly generate files as these are turned off in releases
6019 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006020 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006021 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006022}
Gilles Peskinea3000992022-02-04 00:21:12 +01006023support_test_cmake_as_subdirectory () {
6024 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006025}
6026
Chris Kayd259e342021-03-25 16:03:25 +00006027component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006028 # Remove existing generated files so that we use the ones CMake
6029 # generates
6030 make neat
6031
Chris Kayd259e342021-03-25 16:03:25 +00006032 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006033 cd programs/test/cmake_package
6034 cmake .
6035 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006036 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006037}
Gilles Peskinea3000992022-02-04 00:21:12 +01006038support_test_cmake_as_package () {
6039 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006040}
6041
6042component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006043 # Remove existing generated files so that we use the ones CMake
6044 # generates
6045 make neat
6046
Chris Kayd259e342021-03-25 16:03:25 +00006047 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006048 cd programs/test/cmake_package_install
6049 cmake .
6050 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006051 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006052}
Gilles Peskinea3000992022-02-04 00:21:12 +01006053support_test_cmake_as_package_install () {
6054 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006055}
6056
David Horstmann20550e32023-01-12 14:17:01 +00006057component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006058 # Make a copy of config file to use for the in-tree test
6059 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006060
6061 MBEDTLS_ROOT_DIR="$PWD"
6062 mkdir "$OUT_OF_SOURCE_DIR"
6063 cd "$OUT_OF_SOURCE_DIR"
6064
David Horstmann969c1452023-01-31 10:34:44 +00006065 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006066 cmake "$MBEDTLS_ROOT_DIR"
6067 make
6068
6069 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6070 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006071 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006072 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6073 make
6074
6075 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6076 # In the user config, disable one feature (for simplicity, pick a feature
6077 # that nothing else depends on).
6078 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6079
6080 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6081 make
6082 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6083
6084 rm -f user_config.h full_config.h
6085
6086 cd "$MBEDTLS_ROOT_DIR"
6087 rm -rf "$OUT_OF_SOURCE_DIR"
6088
6089 # Now repeat the test for an in-tree build:
6090
David Horstmann969c1452023-01-31 10:34:44 +00006091 # Restore config for the in-tree test
6092 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006093
David Horstmann969c1452023-01-31 10:34:44 +00006094 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006095 cmake .
6096 make
6097
6098 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6099 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006100 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006101 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6102 make
6103
6104 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6105 # In the user config, disable one feature (for simplicity, pick a feature
6106 # that nothing else depends on).
6107 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6108
6109 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6110 make
6111 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6112
6113 rm -f user_config.h full_config.h
6114}
6115support_build_cmake_custom_config_file () {
6116 support_test_cmake_out_of_source
6117}
6118
6119
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006120component_build_zeroize_checks () {
6121 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6122
6123 scripts/config.py full
6124
6125 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006126 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 +01006127}
6128
6129
Gilles Peskine8f073122018-11-27 15:58:47 +01006130component_test_zeroize () {
6131 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6132 # different combinations of compilers and optimization flags by using an
6133 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6134 # system in all cases that the script fails, so we must manually search the
6135 # output to check whether the pass string is present and no failure strings
6136 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006137
Gilles Peskine4976e822019-01-06 19:52:22 +00006138 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6139 # about a spurious message if Gdb tries and fails, so suppress that.
6140 gdb_disable_aslr=
6141 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6142 gdb_disable_aslr='set disable-randomization off'
6143 fi
6144
Gilles Peskine8f073122018-11-27 15:58:47 +01006145 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006146 for compiler in clang gcc; do
6147 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6148 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006149 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6150 grep "The buffer was correctly zeroized" test_zeroize.log
6151 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006152 rm -f test_zeroize.log
6153 make clean
6154 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006155 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006156}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006157
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006158component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006159 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006160 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006161 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006162
6163 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006164 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006165}
6166
6167support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006168 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006169 ver="$(cmake --version)"
6170 ver="${ver#cmake version }"
6171 ver_major="${ver%%.*}"
6172
6173 ver="${ver#*.}"
6174 ver_minor="${ver%%.*}"
6175
6176 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006177}
6178
Gilles Peskinec848d222022-12-09 12:23:35 +01006179component_check_code_style () {
6180 msg "Check C code style"
6181 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006182}
6183
Gilles Peskinec848d222022-12-09 12:23:35 +01006184support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006185 case $(uncrustify --version) in
6186 *0.75.1*) true;;
6187 *) false;;
6188 esac
6189}
6190
Gilles Peskine8f073122018-11-27 15:58:47 +01006191component_check_python_files () {
6192 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006193 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006194}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006195
Joe Subbianid614c0b2021-07-29 11:18:29 +01006196component_check_test_helpers () {
6197 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006198 # unittest writes out mundane stuff like number or tests run on stderr.
6199 # Our convention is to reserve stderr for actual errors, and write
6200 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006201 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006202
Joe Subbiania25ffab2021-08-06 09:41:27 +01006203 msg "unit test: translate_ciphers.py"
6204 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006205}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006206
Valerio Settid9e42512024-05-06 15:59:51 +02006207component_test_psasim() {
Valerio Settid1b6ef12024-05-07 16:00:21 +02006208 msg "build library for client"
6209
6210 helper_crypto_client_build client
6211
6212 msg "build library for server"
6213
6214 scripts/config.py crypto
6215
6216 helper_crypto_client_build server
6217
Valerio Settid9e42512024-05-06 15:59:51 +02006218 msg "build psasim"
Valerio Setti4362aae2024-05-09 09:15:39 +02006219 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Settid9e42512024-05-06 15:59:51 +02006220
6221 msg "test psasim"
Valerio Setti655b9792024-05-09 12:20:40 +02006222 tests/psa-client-server/psasim/test/run_test.sh
Valerio Settid9e42512024-05-06 15:59:51 +02006223
6224 msg "clean psasim"
6225 make -C tests/psa-client-server/psasim clean
6226}
Jerry Yud767cc42023-03-31 15:03:55 +08006227
Gilles Peskine192c72f2017-12-21 15:59:21 +01006228################################################################
6229#### Termination
6230################################################################
6231
Gilles Peskine8f073122018-11-27 15:58:47 +01006232post_report () {
6233 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006234 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006235
Gilles Peskine8f073122018-11-27 15:58:47 +01006236 final_report
6237}
6238
6239
6240
6241################################################################
6242#### Run all the things
6243################################################################
6244
Gilles Peskine5d996822020-03-28 21:09:21 +01006245# Function invoked by --error-test to test error reporting.
6246pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006247 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006248 if [ $KEEP_GOING -ne 0 ]; then
6249 echo "Expect three failing commands."
6250 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006251 # If the component doesn't run in a subshell, changing error_test_i to an
6252 # invalid integer will cause an error in the loop that runs this function.
6253 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006254 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006255 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006256 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006257 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006258 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006259 make unknown_target
6260 false "this should not be executed"
6261}
6262
Gilles Peskinee48351a2018-11-27 16:06:30 +01006263# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006264run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006265 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006266 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006267
6268 # Unconditionally create a seedfile that's sufficiently long.
6269 # Do this before each component, because a previous component may
6270 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006271 local dd_cmd
6272 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6273 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006274 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006275 esac
6276 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006277
Gilles Peskineec135542021-08-02 23:14:03 +02006278 # Run the component in a subshell, with error trapping and output
6279 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006280 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006281 # We want to keep running if the subshell fails, so 'set -e' must
6282 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006283 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006284 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006285 (
6286 if [ $QUIET -eq 1 ]; then
6287 # msg() will be silenced, so just print the component name here.
6288 echo "${current_component#component_}"
6289 exec >/dev/null
6290 fi
6291 if [ $KEEP_GOING -eq 1 ]; then
6292 # Keep "set -e" off, and run an ERR trap instead to record failures.
6293 set -E
6294 trap err_trap ERR
6295 fi
6296 # The next line is what runs the component
6297 "$@"
6298 if [ $KEEP_GOING -eq 1 ]; then
6299 trap - ERR
6300 exit $last_failure_status
6301 fi
6302 )
6303 component_status=$?
6304 if [ $KEEP_GOING -eq 1 ]; then
6305 set -e
6306 if [ $component_status -ne 0 ]; then
6307 failure_count=$((failure_count + 1))
6308 fi
6309 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006310
6311 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006312 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006313 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006314}
6315
6316# Preliminary setup
6317pre_check_environment
6318pre_initialize_variables
6319pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006320
Dave Rodgman21900632024-02-26 11:41:19 +00006321setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006322pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006323pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006324pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006325
Gilles Peskine878cf602019-01-06 20:50:38 +00006326build_status=0
6327if [ $KEEP_GOING -eq 1 ]; then
6328 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006329fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006330pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006331pre_print_configuration
6332pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006333cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006334if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006335 pre_generate_files
6336fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006337
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006338# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006339for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006340 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006341done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006342unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006343for component in $RUN_COMPONENTS; do
6344 run_component "component_$component"
6345done
Gilles Peskine8f073122018-11-27 15:58:47 +01006346
6347# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006348post_report