blob: 5cf8e606cd7b192de8566eec86ae5e9129608cac [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 Cron561181c2024-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
Thomas Daubney2f556402024-07-30 15:52:58 +0100118# For project detection
119PROJECT_NAME_FILE='./scripts/project_name.txt'
120if read -r PROJECT_NAME < "$PROJECT_NAME_FILE"; then :; else
121 echo "$PROJECT_NAME_FILE does not exist... Exiting..." >&2
122 exit 1
123fi
124
David Horstmann76a77382023-08-17 17:32:26 +0100125in_mbedtls_repo () {
Thomas Daubney2f556402024-07-30 15:52:58 +0100126 test "$PROJECT_NAME" = "Mbed TLS"
David Horstmannd02b5f82023-08-29 09:53:52 +0100127}
128
Ronald Cron070e8652023-10-09 10:25:45 +0200129in_tf_psa_crypto_repo () {
Thomas Daubney2f556402024-07-30 15:52:58 +0100130 test "$PROJECT_NAME" = "TF-PSA-Crypto"
David Horstmann9a6c45b2023-07-14 12:30:00 +0100131}
132
Gilles Peskine8f073122018-11-27 15:58:47 +0100133pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200134 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
135 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100136 exit 1
137 fi
138}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100139
Gilles Peskine8f073122018-11-27 15:58:47 +0100140pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100141 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100142 CONFIG_H='include/mbedtls/mbedtls_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100143 else
144 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100145 fi
John Durkopbd069d32020-10-31 22:14:03 -0700146 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100147 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200148
149 # Files that are clobbered by some jobs will be backed up. Use a different
150 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
151 # independently decide when to remove the backup file.
152 backup_suffix='.all.bak'
153 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100154 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100155 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100156 # Files clobbered by in-tree cmake
157 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
158 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200159
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200160 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100161 MEMORY=0
162 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200163 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100164 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100165
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200166 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200167 #
168 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
169 # both values are kept in sync. If you change the value here because it
170 # breaks some tests, you'll definitely want to change it in
171 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200172 RELEASE_SEED=1
173
Yanray Wang18040ed2023-11-23 21:29:56 +0800174 # Specify character collation for regular expressions and sorting with C locale
175 export LC_COLLATE=C
176
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200177 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200178 : ${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 +0200179 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200180 export MBEDTLS_TEST_PLATFORM
181
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000182 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100183 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100184 : ${OPENSSL_NEXT:="$OPENSSL"}
185 : ${GNUTLS_CLI:="gnutls-cli"}
186 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100187 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
188 : ${ARMC5_BIN_DIR:=/usr/bin}
189 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200190 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200191 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100192 : ${CLANG_LATEST:="clang-latest"}
193 : ${CLANG_EARLIEST:="clang-earliest"}
194 : ${GCC_LATEST:="gcc-latest"}
195 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100196 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000197 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200198 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100199 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000200 # if CC is not set, use clang by default (if present) to improve build times
201 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000202 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000203 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000204
Ronald Cron561181c2024-04-02 14:39:53 +0200205 if [ -n "${OPENSSL_3+set}" ]; then
206 export OPENSSL_NEXT="$OPENSSL_3"
207 fi
208
Gilles Peskine396853a2021-09-20 18:57:55 +0200209 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000210 export CTEST_OUTPUT_ON_FAILURE=1
211
Gilles Peskine8fd59422019-10-21 17:11:33 +0200212 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100213 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200214 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000215 # Normally, tests should use this compiler for ASAN testing
216 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200217
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400218 # Platform tests have an allocation that returns null
219 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400220 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400221
Gilles Peskine878cf602019-01-06 20:50:38 +0000222 # Gather the list of available components. These are the functions
223 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100224 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000225
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000226 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100227 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100228}
Andres AG38495a32016-07-12 16:54:33 +0100229
Dave Rodgman21900632024-02-26 11:41:19 +0000230setup_quiet_wrappers()
231{
232 # Pick up "quiet" wrappers for make and cmake, which don't output very much
233 # unless there is an error. This reduces logging overhead in the CI.
234 #
235 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000236 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
237 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000238 fi
239}
240
Gilles Peskinea28db922019-01-10 00:05:18 +0100241# Test whether the component $1 is included in the command line patterns.
242is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100243{
Gilles Peskine03af6782021-08-06 11:35:17 +0200244 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
245 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100246 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000247 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100248 set +f
249 case ${1#component_} in $pattern) return 0;; esac
250 done
251 set +f
252 return 1
253}
Andres AG7770ea82016-10-10 15:46:20 +0100254
Simon Butcher41eeccf2016-09-07 00:07:09 +0100255usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100256{
Gilles Peskine709346a2017-12-10 23:43:39 +0100257 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100258Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100259Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100260By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100261COMPONENT can be the name of a component or a shell wildcard pattern.
262
263Examples:
264 $0 "check_*"
265 Run all sanity checks.
266 $0 --no-armcc --except test_memsan
267 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100268
269Special options:
270 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000271 --list-all-components List all available test components and exit.
272 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100273
274General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200275 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100276 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100277 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100278 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200279 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200280 --arm-none-eabi-gcc-prefix=<string>
281 Prefix for a cross-compiler for arm-none-eabi
282 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200283 --arm-linux-gnueabi-gcc-prefix=<string>
284 Prefix for a cross-compiler for arm-linux-gnueabi
285 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100286 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200287 --restore First clean up the build tree, restoring backed up
288 files. Do not run any components unless they are
289 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100290 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200291 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100292 --except Exclude the COMPONENTs listed on the command line,
293 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200294 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100295 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100296 --no-force Refuse to overwrite modified files (default).
297 --no-keep-going Stop at the first error (default).
298 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800299 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100300 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200301 --outcome-file=<path> File where test outcomes are written (not done if
302 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100303 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200304 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100305 -s|--seed Integer seed value to use for this test run.
306
307Tool path options:
308 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
309 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100310 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
311 --clang-latest=<Clang_latest_path> Latest version of clang available
312 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
313 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100314 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
315 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100316 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100317 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100318EOF
SimonB2e23c822016-04-16 21:54:39 +0100319}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100320
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200321# Cleanup before/after running a component.
322# Remove built files as well as the cmake cache/config.
323# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100324cleanup()
325{
David Horstmann76a77382023-08-17 17:32:26 +0100326 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100327 command make clean
328 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200329
Gilles Peskine31b07e22018-03-21 12:15:06 +0100330 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000331 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100332 -iname CMakeFiles -exec rm -rf {} \+ -o \
333 \( -iname cmake_install.cmake -o \
334 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200335 -iname CMakeCache.txt -o \
336 -path './cmake/*.cmake' \) -exec rm -f {} \+
Ronald Cronda224022024-06-12 10:04:22 +0200337 # Remove Makefiles generated by in-tree CMake builds
338 rm -f 3rdparty/Makefile 3rdparty/*/Makefile pkgconfig/Makefile framework/Makefile
339 rm -f include/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200340
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100341 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
342 rm -rf programs/test/cmake_subproject/build
343 rm -f programs/test/cmake_subproject/Makefile
344 rm -f programs/test/cmake_subproject/cmake_subproject
345
Chris Kayd259e342021-03-25 16:03:25 +0000346 # Remove any artifacts from the component_test_cmake_as_package test.
347 rm -rf programs/test/cmake_package/build
348 rm -f programs/test/cmake_package/Makefile
349 rm -f programs/test/cmake_package/cmake_package
350
351 # Remove any artifacts from the component_test_cmake_as_installed_package test.
352 rm -rf programs/test/cmake_package_install/build
353 rm -f programs/test/cmake_package_install/Makefile
354 rm -f programs/test/cmake_package_install/cmake_package_install
355
Gilles Peskinef83eb822020-03-30 20:11:39 +0200356 # Restore files that may have been clobbered by the job
357 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200358 if [[ -e "$x$backup_suffix" ]]; then
359 cp -p "$x$backup_suffix" "$x"
360 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200361 done
362}
John Durkopbd069d32020-10-31 22:14:03 -0700363
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200364# Final cleanup when this script exits (except when exiting on a failure
365# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200366final_cleanup () {
367 cleanup
368
369 for x in $files_to_back_up; do
370 rm -f "$x$backup_suffix"
371 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100372}
373
Gilles Peskine7c652162017-12-11 00:01:40 +0100374# Executed on exit. May be redefined depending on command line options.
375final_report () {
376 :
377}
378
379fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200380 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100381 final_report $1
382 trap - $1
383 kill -$1 $$
384}
385
386trap 'fatal_signal HUP' HUP
387trap 'fatal_signal INT' INT
388trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200389
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200390# Number of processors on this machine. Used as the default setting
391# for parallel make.
392all_sh_nproc ()
393{
394 {
395 nproc || # Linux
396 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
397 sysctl -n hw.ncpu || # FreeBSD
398 echo 1
399 } 2>/dev/null
400}
401
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100402msg()
403{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100404 if [ -n "${current_component:-}" ]; then
405 current_section="${current_component#component_}: $1"
406 else
407 current_section="$1"
408 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200409
410 if [ $QUIET -eq 1 ]; then
411 return
412 fi
413
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100414 echo ""
415 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100416 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000417 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100418 echo "******************************************************************"
419}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100420
Gilles Peskine8f073122018-11-27 15:58:47 +0100421armc6_build_test()
422{
423 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100424
Gilles Peskine18487f62020-04-30 23:11:54 +0200425 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800426 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100427 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000428 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200429
430 msg "size: ARM Compiler 6 ($FLAGS)"
431 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100432}
Andres AGa5cd9732016-10-17 15:23:10 +0100433
Andres AGd9eba4b2016-08-26 14:42:14 +0100434err_msg()
435{
436 echo "$1" >&2
437}
438
439check_tools()
440{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200441 for tool in "$@"; do
442 if ! `type "$tool" >/dev/null 2>&1`; then
443 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100444 exit 1
445 fi
446 done
447}
448
Gilles Peskine8f073122018-11-27 15:58:47 +0100449pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000450 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100451 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100452 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100453 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200454 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000455 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100456
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000457 # Note that legacy options are ignored instead of being omitted from this
458 # list of options, so invocations that worked with previous version of
459 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100460 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100461 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200462 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200463 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200464 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000465 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100466 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
467 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100468 --clang-earliest) shift; CLANG_EARLIEST="$1";;
469 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100470 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000471 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100472 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100473 --gcc-earliest) shift; GCC_EARLIEST="$1";;
474 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100475 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200476 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
477 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --gnutls-serv) shift; GNUTLS_SERV="$1";;
479 --help|-h) usage; exit;;
480 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000481 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100482 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200484 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000485 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100486 --no-force) FORCE=0;;
487 --no-keep-going) KEEP_GOING=0;;
488 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200489 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100490 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100491 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200492 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100493 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200494 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100495 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200496 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200497 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100498 --seed|-s) shift; SEED="$1";;
499 -*)
500 echo >&2 "Unknown option: $1"
501 echo >&2 "Run $0 --help for usage."
502 exit 120
503 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000504 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100505 esac
506 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100507 done
SimonB2e23c822016-04-16 21:54:39 +0100508
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100509 # Exclude components that are not supported on this platform.
510 SUPPORTED_COMPONENTS=
511 for component in $ALL_COMPONENTS; do
512 case $(type "support_$component" 2>&1) in
513 *' function'*)
514 if ! support_$component; then continue; fi;;
515 esac
516 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
517 done
518
519 if [ $list_components -eq 1 ]; then
520 printf '%s\n' $SUPPORTED_COMPONENTS
521 exit
522 fi
523
Gilles Peskinea28db922019-01-10 00:05:18 +0100524 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200525 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000526 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100527 fi
528
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000529 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
530 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100531 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000532 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100533 fi
SimonB2e23c822016-04-16 21:54:39 +0100534
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200535 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100536 if [ $all_except -eq 0 ]; then
537 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200538 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
539 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200540 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100541 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200542 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200543 # If the requested name includes a wildcard character, don't
544 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100545 case $component in
546 *[*?\[]*) continue;;
547 esac
548 case " $SUPPORTED_COMPONENTS " in
549 *" $component "*) :;;
550 *)
551 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
552 unsupported=$((unsupported + 1));;
553 esac
554 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200555 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100556 if [ $unsupported -ne 0 ]; then
557 exit 2
558 fi
559 fi
560
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000561 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100562 RUN_COMPONENTS=
563 for component in $SUPPORTED_COMPONENTS; do
564 if is_component_included "$component"; [ $? -eq $all_except ]; then
565 RUN_COMPONENTS="$RUN_COMPONENTS $component"
566 fi
567 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000568
569 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000570 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100571}
SimonB2e23c822016-04-16 21:54:39 +0100572
Gilles Peskine8f073122018-11-27 15:58:47 +0100573pre_check_git () {
574 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100575 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100576 git checkout-index -f -q $CONFIG_H
577 cleanup
578 else
SimonB2e23c822016-04-16 21:54:39 +0100579
Gilles Peskine8f073122018-11-27 15:58:47 +0100580 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
581 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
582 echo "You can either delete this directory manually, or force the test by rerunning"
583 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
584 exit 1
585 fi
586
Ronald Cron7a93ac52023-07-20 09:49:12 +0200587 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100588 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100589 echo "You can either delete or preserve your work, or force the test by rerunning the"
590 echo "script as: $0 --force"
591 exit 1
592 fi
SimonB2e23c822016-04-16 21:54:39 +0100593 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500594}
595
Gilles Peskine568f53a2021-07-12 18:16:01 +0200596pre_restore_files () {
597 # If the makefiles have been generated by a framework such as cmake,
598 # restore them from git. If the makefiles look like modifications from
599 # the ones checked into git, take care not to modify them. Whatever
600 # this function leaves behind is what the script will restore before
601 # each component.
602 case "$(head -n1 Makefile)" in
603 *[Gg]enerated*)
604 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
605 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
606 ;;
607 esac
608}
609
Gilles Peskinef83eb822020-03-30 20:11:39 +0200610pre_back_up () {
611 for x in $files_to_back_up; do
612 cp -p "$x" "$x$backup_suffix"
613 done
614}
615
Gilles Peskine8f073122018-11-27 15:58:47 +0100616pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100617 failure_count=0 # Number of failed components
618 last_failure_status=0 # Last failure status in this component
619
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100620 # See err_trap
621 previous_failure_status=0
622 previous_failed_command=
623 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100624 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100625
Gilles Peskine7c652162017-12-11 00:01:40 +0100626 start_red=
627 end_color=
628 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100629 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100630 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
631 start_red=$(printf '\033[31m')
632 end_color=$(printf '\033[0m')
633 ;;
634 esac
635 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100636
637 # Keep a summary of failures in a file. We'll print it out at the end.
638 failure_summary_file=$PWD/all-sh-failures-$$.log
639 : >"$failure_summary_file"
640
641 # Whether it makes sense to keep a component going after the specified
642 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200643 # This function normally receives the failing simple command
644 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
645 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100646 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200647 # False positives result in running things that can't be expected to
648 # work. False negatives result in things not running after something else
649 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100650 can_keep_going_after_failure () {
651 case "$1" in
652 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200653 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100654 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200655 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
656 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
657 *make*check*) true;;
658 "grep "*) true;;
659 "[ "*) true;;
660 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100661 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100662 esac
663 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100664
665 # This function runs if there is any error in a component.
666 # It must either exit with a nonzero status, or set
667 # last_failure_status to a nonzero value.
668 err_trap () {
669 # Save $? (status of the failing command). This must be the very
670 # first thing, before $? is overridden.
671 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100672 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100673
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100674 if [[ $last_failure_status -eq $previous_failure_status &&
675 "$failed_command" == "$previous_failed_command" &&
676 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
677 then
678 # The same command failed twice in a row, but this time one level
679 # less deep in the function call stack. This happens when the last
680 # command of a function returns a nonzero status, and the function
681 # returns that same status. Ignore the second failure.
682 previous_failure_funcall_depth=${#FUNCNAME[@]}
683 return
684 fi
685 previous_failure_status=$last_failure_status
686 previous_failed_command=$failed_command
687 previous_failure_funcall_depth=${#FUNCNAME[@]}
688
Gilles Peskinece266c42020-03-28 18:50:43 +0100689 text="$current_section: $failed_command -> $last_failure_status"
690 echo "${start_red}^^^^$text^^^^${end_color}" >&2
691 echo "$text" >>"$failure_summary_file"
692
693 # If the command is fatal (configure or build command), stop this
694 # component. Otherwise (test command) keep the component running
695 # (run more tests from the same build).
696 if ! can_keep_going_after_failure "$failed_command"; then
697 exit $last_failure_status
698 fi
699 }
700
Gilles Peskine7c652162017-12-11 00:01:40 +0100701 final_report () {
702 if [ $failure_count -gt 0 ]; then
703 echo
704 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100705 echo "${start_red}FAILED: $failure_count components${end_color}"
706 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100707 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
708 elif [ -z "${1-}" ]; then
709 echo "SUCCESS :)"
710 fi
711 if [ -n "${1-}" ]; then
712 echo "Killed by SIG$1."
713 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100714 rm -f "$failure_summary_file"
715 if [ $failure_count -gt 0 ]; then
716 exit 1
717 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100718 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100719}
720
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200721# record_status() and if_build_succeeded() are kept temporarily for backward
722# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100723record_status () {
724 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100725}
Gilles Peskine7c652162017-12-11 00:01:40 +0100726if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100727 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100728}
729
Gilles Peskinea681c592020-03-28 21:27:40 +0100730# '! true' does not trigger the ERR trap. Arrange to trigger it, with
731# a reasonably informative error message (not just "$@").
732not () {
733 if "$@"; then
734 report_failed_command="! $*"
735 false
736 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200737 fi
738}
739
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200740pre_prepare_outcome_file () {
741 case "$MBEDTLS_TEST_OUTCOME_FILE" in
742 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
743 esac
744 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
745 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
746 fi
747}
748
Gilles Peskine8f073122018-11-27 15:58:47 +0100749pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200750 if [ $QUIET -eq 1 ]; then
751 return
752 fi
753
Gilles Peskine8f073122018-11-27 15:58:47 +0100754 msg "info: $0 configuration"
755 echo "MEMORY: $MEMORY"
756 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200757 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100758 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100759 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100760 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100761 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
762 echo "GNUTLS_CLI: $GNUTLS_CLI"
763 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100764 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
765 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
766}
Andres AG7770ea82016-10-10 15:46:20 +0100767
Andres AGd9eba4b2016-08-26 14:42:14 +0100768# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100769pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000770 # Build the list of variables to pass to output_env.sh.
771 set env
SimonB2e23c822016-04-16 21:54:39 +0100772
Gilles Peskine87964262019-01-06 22:40:00 +0000773 case " $RUN_COMPONENTS " in
774 # Require OpenSSL and GnuTLS if running any tests (as opposed to
775 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
776 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100777 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000778 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
779 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100780 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000781 export GNUTLS_CLI="$GNUTLS_CLI"
782 export GNUTLS_SERV="$GNUTLS_SERV"
783 # Avoid passing --seed flag in every call to ssl-opt.sh
784 if [ -n "${SEED-}" ]; then
785 export SEED
786 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200787 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000788 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200789 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
790 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000791 ;;
792 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200793
Gilles Peskine87964262019-01-06 22:40:00 +0000794 case " $RUN_COMPONENTS " in
795 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
796 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100797
Gilles Peskine87964262019-01-06 22:40:00 +0000798 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200799 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000800 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100801
Gilles Peskine87964262019-01-06 22:40:00 +0000802 case " $RUN_COMPONENTS " in
803 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
804 esac
805
806 case " $RUN_COMPONENTS " in
807 *" test_zeroize "*) check_tools "gdb";;
808 esac
809
810 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000811 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000812 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
813 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200814 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000815 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
816 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200817 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
818 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
819 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000820 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000821
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200822 # past this point, no call to check_tool, only printing output
823 if [ $QUIET -eq 1 ]; then
824 return
825 fi
826
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000827 msg "info: output_env.sh"
828 case $RUN_COMPONENTS in
829 *_armcc*)
830 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
831 *) set "$@" RUN_ARMCC=0;;
832 esac
833 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100834}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100835
Gilles Peskine1570b592021-04-22 01:10:12 +0200836pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200837 # since make doesn't have proper dependencies, remove any possibly outdate
838 # file that might be around before generating fresh ones
839 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200840 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200841 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200842 else
843 make generated_files
844 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200845}
846
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000847clang_version() {
848 if command -v clang > /dev/null ; then
849 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
850 else
851 echo 0 # report version 0 for "no clang"
852 fi
853}
854
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200855################################################################
856#### Helpers for components using libtestdriver1
857################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100858
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200859# How to use libtestdriver1
860# -------------------------
861#
862# 1. Define the list algorithms and key types to accelerate,
863# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
864# Examples:
865# - loc_accel_list="ALG_JPAKE"
866# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200867# 2. Make configurations changes for the driver and/or main libraries.
868# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
869# can be either "default" to start with the default config, or a name
870# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200871# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200872# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
873# These changes affect both the driver and the main libraries.
874# (Note: they need to have the same set of PSA_WANT symbols, as that
875# determines the ABI between them.)
876# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
877# main libraries. Typically, you want to disable the module(s) that are
878# being accelerated. You may need to also disable modules that depend
879# on them or options that are not supported with drivers.
880# 2d. On top of psa/crypto_config.h, the driver library uses its own config
881# file: tests/include/test/drivers/config_test_driver.h. You usually
882# don't need to edit it: using loc_extra_list (see below) is preferred.
883# However, when there's no PSA symbol for what you want to enable,
884# calling scripts/config.py on this file remains the only option.
885# 3. Build the driver library, then the main libraries, test, and programs.
886# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
887# need to enable more algorithms here, typically hash algorithms when
888# accelerating some signature algorithms (ECDSA, RSAv2). This is done
889# by passing a 2nd argument listing the extra algorithms.
890# Example:
891# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
892# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800893# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200894# additional arguments will be passed to make: this can be useful if
895# you don't want to build everything when iterating during development.
896# Example:
897# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
898# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200899
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200900# Adjust the configuration - for both libtestdriver1 and main library,
901# as they should have the same PSA_WANT macros.
902helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200903 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200904 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200905 if [ "$base_config" != "default" ]; then
906 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200907 fi
908
909 # Enable PSA-based config (necessary to use drivers)
910 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
911
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200912 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
913 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
914 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000915
916 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
917 # otherwise we will end up running multithreaded tests without mutexes to protect them.
918 if scripts/config.py get MBEDTLS_THREADING_C; then
919 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
920 fi
921
922 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
923 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
924 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200925}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100926
Valerio Settib2fd6732023-08-15 17:10:47 +0200927# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200928# The function optionally accepts 1 parameter: a space-separated list of the
929# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200930helper_disable_builtin_curves() {
931 allowed_list="${1:-}"
932 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
933
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200934 for curve in $allowed_list; do
935 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200936 done
937}
938
939# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
940# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
941# in the following helpers.
942helper_get_psa_curve_list () {
943 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200944 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
945 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200946 done
947
948 echo "$loc_list"
949}
950
Valerio Setti78aa0bc2024-01-17 15:53:46 +0100951# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
952# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
953# in the following helpers.
954helper_get_psa_dh_group_list () {
955 loc_list=""
956 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
957 loc_list="$loc_list $item"
958 done
959
960 echo "$loc_list"
961}
962
Valerio Settib2fd6732023-08-15 17:10:47 +0200963# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +0200964# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +0200965# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +0200966helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200967 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +0200968 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200969 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 +0200970 # Skip DERIVE for elliptic keys since there is no driver dispatch for
971 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200972 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
973 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200974 fi
975 done
976
977 echo "$loc_list"
978}
979
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200980# Build the drivers library libtestdriver1.a (with ASan).
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200981#
982# Parameters:
983# 1. a space-separated list of things to accelerate;
984# 2. optional: a space-separate list of things to also support.
985# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
986helper_libtestdriver1_make_drivers() {
987 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
Gilles Peskine21570cf2023-12-22 11:49:50 +0100988 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200989}
990
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200991# Build the main libraries, programs and tests,
992# linking to the drivers library (with ASan).
993#
994# Parameters:
995# 1. a space-separated list of things to accelerate;
996# *. remaining arguments if any are passed directly to make
997# (examples: lib, -C tests test_suite_xxx, etc.)
998# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
999helper_libtestdriver1_make_main() {
1000 loc_accel_list=$1
1001 shift
1002
1003 # we need flags both with and without the LIBTESTDRIVER1_ prefix
1004 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
1005 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001006 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include -I../tests -I../../tests -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_TEST_LIBTESTDRIVER1 $loc_accel_flags" LDFLAGS="-ltestdriver1 $ASAN_CFLAGS" "$@"
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02001007}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001008
1009################################################################
1010#### Basic checks
1011################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001012
1013#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001014# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001015#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001016# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001017# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001018# 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 +02001019# time, so start with a GCC build).
1020# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001021#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001022# Indicative running times are given for reference.
1023
Gilles Peskine8f073122018-11-27 15:58:47 +01001024component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001025 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001026 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001027}
Janos Follathb72c6782016-07-19 14:54:17 +01001028
Gilles Peskine67debb62021-05-18 16:09:50 +02001029component_check_generated_files () {
1030 msg "Check: check-generated-files, files generated with make" # 2s
1031 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001032 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001033
1034 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001035 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001036 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001037 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001038
1039 msg "Check: check-generated-files -u, files absent" # 2s
1040 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001041 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001042 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001043 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001044
1045 # This component ends with the generated files present in the source tree.
1046 # This is necessary for subsequent components!
1047}
1048
Gilles Peskine8f073122018-11-27 15:58:47 +01001049component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001050 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001051 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001052}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001053
Gilles Peskine8f073122018-11-27 15:58:47 +01001054component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001055 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001056 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001057}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001058
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001059component_check_changelog () {
1060 msg "Check: changelog entries" # < 1s
1061 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001062 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001063 if [ -e ChangeLog.new ]; then
1064 # Show the diff for information. It isn't an error if the diff is
1065 # non-empty.
1066 diff -u ChangeLog ChangeLog.new || true
1067 rm ChangeLog.new
1068 fi
1069}
1070
Gilles Peskine8f073122018-11-27 15:58:47 +01001071component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001072 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001073 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001074}
Darryl Greena07039c2018-03-13 16:48:16 +00001075
Gilles Peskine895868b2019-09-19 21:30:05 +02001076component_check_test_cases () {
1077 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001078 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001079 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001080 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001081 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001082 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001083 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001084 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001085}
1086
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001087component_check_test_dependencies () {
1088 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001089 # The purpose of this component is to catch unjustified dependencies on
1090 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1091 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1092 # MBEDTLS_PSA_xxx).
1093 #
1094 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1095 # this component is meant to catch. However a few of them are justified,
1096 # mostly by the absence of a PSA equivalent, so this component includes a
1097 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001098
1099 found="check-test-deps-found-$$"
1100 expected="check-test-deps-expected-$$"
1101
1102 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001103 grep 'depends_on' \
1104 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001105 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001106 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001107 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001108
Yanray Wang18040ed2023-11-23 21:29:56 +08001109 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001110 rm -f $expected
1111 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1112 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001113 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1114 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001115 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1116 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001117 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1118 # the test code and that's probably the most convenient way of achieving
1119 # the test's goal.
1120 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1121 # No PSA equivalent - we should probably have one in the future.
1122 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1123 # No PSA equivalent - needed by some init tests
1124 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001125 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001126 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001127
1128 # Compare reality with expectation.
1129 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001130 #
1131 # The output should be empty. When it's not:
1132 # - Each '+' line is a macro that was found but not expected. You want to
1133 # find where that macro occurs, and either replace it with PSA macros, or
1134 # add it to the exceptions list above with a justification.
1135 # - Each '-' line is a macro that was expected but not found; it means the
1136 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001137 diff -U0 $expected $found
1138
1139 rm $found $expected
1140}
1141
Gilles Peskine8f073122018-11-27 15:58:47 +01001142component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001143 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001144 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001145}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001146
Gilles Peskine192c72f2017-12-21 15:59:21 +01001147
Gilles Peskine636c26a2020-03-04 20:46:15 +01001148
Gilles Peskine192c72f2017-12-21 15:59:21 +01001149################################################################
1150#### Build and test many configurations and targets
1151################################################################
1152
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001153component_test_default_out_of_box () {
1154 msg "build: make, default config (out-of-box)" # ~1min
1155 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001156 # Disable fancy stuff
1157 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001158
1159 msg "test: main suites make, default config (out-of-box)" # ~10s
1160 make test
1161
1162 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001163 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001164
1165 msg "program demos: make, default config (out-of-box)" # ~10s
1166 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001167}
1168
Gilles Peskine8f073122018-11-27 15:58:47 +01001169component_test_default_cmake_gcc_asan () {
1170 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001171 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1172 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001173
Gilles Peskine8f073122018-11-27 15:58:47 +01001174 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1175 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001176
Gilles Peskine82b27272019-06-14 18:27:03 +02001177 msg "program demos (ASan build)" # ~10s
1178 tests/scripts/run_demos.py
1179
Gilles Peskine97bea012020-04-23 23:37:45 +02001180 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001181 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001182
Gilles Peskine6848d172023-11-02 19:58:03 +01001183 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001184 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001185
Gilles Peskine8f073122018-11-27 15:58:47 +01001186 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001187 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001188
Gilles Peskine8f073122018-11-27 15:58:47 +01001189 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001190 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001191
1192 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001193 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001194}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001195
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001196component_test_default_cmake_gcc_asan_new_bignum () {
1197 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001198 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001199 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001200 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001201
1202 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1203 make test
1204
1205 msg "test: selftest (ASan build)" # ~ 10s
1206 programs/test/selftest
1207
1208 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1209 tests/ssl-opt.sh
1210
1211 msg "test: compat.sh (ASan build)" # ~ 6 min
1212 tests/compat.sh
1213
1214 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1215 tests/context-info.sh
1216}
1217
Hanno Becker01635512019-02-26 14:27:09 +00001218component_test_full_cmake_gcc_asan () {
1219 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001220 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001221 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1222 make
1223
1224 msg "test: main suites (inc. selftests) (full config, ASan build)"
1225 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001226
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001227 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001228 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001229
Gilles Peskine636c26a2020-03-04 20:46:15 +01001230 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001231 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001232
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001233 # Note: the next two invocations cover all compat.sh test cases.
1234 # We should use the same here and in basic-build-test.sh.
1235 msg "test: compat.sh: default version (full config, ASan build)"
1236 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnarde7987b62024-04-17 12:30:05 +02001237
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001238 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1239 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001240
1241 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001242 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001243}
1244
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001245
1246component_test_full_cmake_gcc_asan_new_bignum () {
1247 msg "build: full config, cmake, gcc, ASan"
1248 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001249 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001250 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001251 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001252
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001253 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001254 make test
1255
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001256 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001257 programs/test/selftest
1258
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001259 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001260 tests/ssl-opt.sh
1261
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001262 # Note: the next two invocations cover all compat.sh test cases.
1263 # We should use the same here and in basic-build-test.sh.
1264 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1265 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001266
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001267 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1268 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001269
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02001270 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001271 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001272}
1273
Ronald Cronc3623db2020-10-29 10:51:32 +01001274component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001275 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001276 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001277 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1278 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1279 make
1280
1281 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1282 make test
1283}
1284
David Horstmann4a48bec2024-03-13 15:42:31 +00001285component_test_psa_assume_exclusive_buffers () {
1286 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001287 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001288 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001289 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1290 make
1291
David Horstmann4a48bec2024-03-13 15:42:31 +00001292 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001293 make test
1294}
1295
Gilles Peskinea3548672021-06-17 11:37:52 +02001296# check_renamed_symbols HEADER LIB
1297# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1298# name is LIB.
1299check_renamed_symbols () {
1300 ! nm "$2" | sed 's/.* //' |
1301 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1302}
1303
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001304component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001305 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001306 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001307 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1308 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1309 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1310 # We can only compile, not link, since our test and sample programs
1311 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1312 # is active.
1313 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001314
1315 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1316 # version is not present.
1317 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001318 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001319}
1320
Valerio Setti63097752024-03-12 13:18:13 +01001321# Get a list of library-wise undefined symbols and ensure that they only
1322# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1323# This function is a common helper used by both:
1324# - component_test_default_psa_crypto_client_without_crypto_provider
1325# - component_build_full_psa_crypto_client_without_crypto_provider.
1326common_check_mbedtls_missing_symbols() {
1327 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1328 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1329 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1330 not grep mbedtls_ linking_errors.txt
1331
1332 rm sym_def.txt sym_undef.txt linking_errors.txt
1333}
1334
1335component_test_default_psa_crypto_client_without_crypto_provider () {
1336 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1337
Ronald Cron336678b2021-01-28 17:54:24 +01001338 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1339 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001340 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001341 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001342 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001343 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001344
Ronald Cron336678b2021-01-28 17:54:24 +01001345 make
1346
Valerio Setti63097752024-03-12 13:18:13 +01001347 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1348 common_check_mbedtls_missing_symbols
1349
1350 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001351 make test
1352}
1353
Valerio Setti63097752024-03-12 13:18:13 +01001354component_build_full_psa_crypto_client_without_crypto_provider () {
1355 msg "build: full config - PSA_CRYPTO_C"
1356
1357 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1358 scripts/config.py full
1359
1360 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1361 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1362 # Dynamic secure element support is a deprecated feature and it is not
1363 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1364 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1365
1366 # Since there is no crypto provider in this build it is not possible to
1367 # build all the test executables and progrems due to missing PSA functions
1368 # at link time. Therefore we will just build libraries and we'll check
1369 # that symbols of interest are there.
1370 make lib
1371
1372 msg "check missing symbols: full config - PSA_CRYPTO_C"
1373
1374 common_check_mbedtls_missing_symbols
1375
1376 # Ensure that desired functions are included into the build (extend the
1377 # following list as required).
1378 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1379 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1380 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1381}
1382
Jaeden Amero424fa932021-05-14 08:34:32 +01001383component_test_psa_crypto_rsa_no_genprime() {
1384 msg "build: default config minus MBEDTLS_GENPRIME"
1385 scripts/config.py unset MBEDTLS_GENPRIME
1386 make
1387
1388 msg "test: default config minus MBEDTLS_GENPRIME"
1389 make test
1390}
1391
Gilles Peskine782f4112018-11-27 16:11:09 +01001392component_test_ref_configs () {
1393 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001394 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1395 # want to re-generate generated files that depend on it, quite correctly.
1396 # However this doesn't work as the generation script expects a specific
1397 # format for mbedtls_config.h, which the other files don't follow. Also,
1398 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001399 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001400 # whether they're on or off. So, disable cmake's (over-sensitive here)
1401 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001402 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001403 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001404 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001405}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001406
Gilles Peskine8f073122018-11-27 15:58:47 +01001407component_test_no_renegotiation () {
1408 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001409 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001410 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001411 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001412
Gilles Peskine8f073122018-11-27 15:58:47 +01001413 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1414 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001415
Gilles Peskine8f073122018-11-27 15:58:47 +01001416 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001417 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001418}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001419
Gilles Peskine636c26a2020-03-04 20:46:15 +01001420component_test_no_pem_no_fs () {
1421 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1422 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1423 scripts/config.py unset MBEDTLS_FS_IO
1424 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1425 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001426 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001427 make
1428
1429 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1430 make test
1431
1432 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001433 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001434}
1435
Gilles Peskine8f073122018-11-27 15:58:47 +01001436component_test_rsa_no_crt () {
1437 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001438 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001439 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001440 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001441
Gilles Peskine8f073122018-11-27 15:58:47 +01001442 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1443 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001444
Gilles Peskine8f073122018-11-27 15:58:47 +01001445 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001446 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001447
Gilles Peskine8f073122018-11-27 15:58:47 +01001448 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001449 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001450
1451 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001452 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001453}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001454
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001455component_test_no_ctr_drbg_classic () {
1456 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001457 scripts/config.py full
1458 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001459 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001460 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001461
Dave Rodgman17127e92023-12-14 16:42:48 +00001462 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001463 make
1464
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001465 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001466 make test
1467
Gilles Peskineba749042021-01-13 20:02:03 +01001468 # In this configuration, the TLS test programs use HMAC_DRBG.
1469 # The SSL tests are slow, so run a small subset, just enough to get
1470 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001471 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001472 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001473
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001474 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001475 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001476}
1477
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001478component_test_no_ctr_drbg_use_psa () {
1479 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001480 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001481 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1482 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001483
Dave Rodgman17127e92023-12-14 16:42:48 +00001484 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001485 make
1486
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001487 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1488 make test
1489
1490 # In this configuration, the TLS test programs use HMAC_DRBG.
1491 # The SSL tests are slow, so run a small subset, just enough to get
1492 # confidence that the SSL code copes with HMAC_DRBG.
1493 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001494 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001495
1496 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001497 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001498}
1499
1500component_test_no_hmac_drbg_classic () {
1501 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1502 scripts/config.py full
1503 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1504 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1505 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001506 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001507
Dave Rodgman17127e92023-12-14 16:42:48 +00001508 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001509 make
1510
1511 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001512 make test
1513
Gilles Peskinea2224342020-11-19 22:14:34 +01001514 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1515 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1516 # instead.
1517 # Test SSL with non-deterministic ECDSA. Only test features that
1518 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001519 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001520 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001521
1522 # To save time, only test one protocol version, since this part of
1523 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001524 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001525 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001526}
1527
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001528component_test_no_hmac_drbg_use_psa () {
1529 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1530 scripts/config.py full
1531 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1532 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1533 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1534
Dave Rodgman17127e92023-12-14 16:42:48 +00001535 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001536 make
1537
1538 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1539 make test
1540
1541 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1542 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1543 # instead.
1544 # Test SSL with non-deterministic ECDSA. Only test features that
1545 # might be affected by how ECDSA signature is performed.
1546 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001547 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001548
1549 # To save time, only test one protocol version, since this part of
1550 # the protocol is identical in (D)TLS up to 1.2.
1551 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001552 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001553}
1554
1555component_test_psa_external_rng_no_drbg_classic () {
1556 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1557 scripts/config.py full
1558 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001559 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001560 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001561 scripts/config.py unset MBEDTLS_ENTROPY_C
1562 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1563 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001564 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1565 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1566 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001567 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1568 # the SSL test programs don't have an RNG and can't work. Explicitly
1569 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001570 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001571
1572 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1573 make test
1574
Gilles Peskine8eb29432021-02-03 20:07:11 +01001575 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001576 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001577}
1578
1579component_test_psa_external_rng_no_drbg_use_psa () {
1580 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001581 scripts/config.py full
1582 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001583 scripts/config.py unset MBEDTLS_ENTROPY_C
1584 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1585 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001586 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1587 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1588 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001589 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001590
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001591 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001592 make test
1593
Gilles Peskine8eb29432021-02-03 20:07:11 +01001594 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001595 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001596}
1597
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001598component_test_psa_external_rng_use_psa_crypto () {
1599 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1600 scripts/config.py full
1601 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1602 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1603 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001604 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001605
1606 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1607 make test
1608
1609 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1610 tests/ssl-opt.sh -f 'Default\|opaque'
1611}
1612
Gilles Peskine801c4332023-04-28 21:04:28 +02001613component_test_psa_inject_entropy () {
1614 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1615 scripts/config.py full
1616 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1617 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1618 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1619 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1620 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1621 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001622 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 +02001623
1624 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1625 make test
1626}
1627
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001628component_test_sw_inet_pton () {
1629 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1630
1631 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1632 scripts/config.py set MBEDTLS_TEST_HOOKS
1633 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1634
1635 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1636 make test
1637}
1638
Valerio Settia41654d2024-02-08 10:33:11 +01001639component_full_no_pkparse_pkwrite() {
1640 msg "build: full without pkparse and pkwrite"
1641
1642 scripts/config.py crypto_full
1643 scripts/config.py unset MBEDTLS_PK_PARSE_C
1644 scripts/config.py unset MBEDTLS_PK_WRITE_C
1645
Valerio Settia41654d2024-02-08 10:33:11 +01001646 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1647
1648 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1649 not grep mbedtls_pk_parse_key library/pkparse.o
1650 not grep mbedtls_pk_write_key_der library/pkwrite.o
1651
1652 msg "test: full without pkparse and pkwrite"
1653 make test
1654}
1655
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001656component_test_crypto_full_md_light_only () {
1657 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001658 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001659 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001660 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001661 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001662 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001663 scripts/config.py unset MBEDTLS_HKDF_C
1664 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001665 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001666 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001667 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001668 # Disable things that would auto-enable MD_C
1669 scripts/config.py unset MBEDTLS_PKCS5_C
1670
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001671 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1672 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001673 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001674
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001675 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001676 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001677 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001678
1679 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001680 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001681}
1682
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001683component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001684 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001685 scripts/config.py full
1686 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001687 # Don't pull in cipher via PSA mechanisms
1688 # (currently ignored anyway because we completely disable PSA)
1689 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001690 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001691 scripts/config.py unset MBEDTLS_CMAC_C
1692 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001693 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001694 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001695 scripts/config.py unset MBEDTLS_SSL_TLS_C
1696 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001697 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001698 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1699 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001700 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001701 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001702 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001703
Valerio Settidf17a102023-10-23 14:14:19 +02001704 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001705 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001706}
1707
Valerio Setti7e710e82023-08-25 09:14:15 +02001708# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001709# - component_test_full_no_cipher_with_psa_crypto
1710# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001711# It accepts 2 input parameters:
1712# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1713# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001714common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001715 USE_CRYPTO_CONFIG="$1"
1716 COMPONENT_DESCRIPTION="$2"
1717
1718 msg "build: $COMPONENT_DESCRIPTION"
1719
1720 scripts/config.py full
1721 scripts/config.py unset MBEDTLS_CIPHER_C
1722
1723 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001724 # The built-in implementation of the following algs/key-types depends
1725 # on CIPHER_C so we disable them.
1726 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1727 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001728 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001729 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1730 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1731 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1732 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1733 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1734 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1735 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
Ronald Cron7d949ae2024-05-15 18:31:17 +02001736 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti7e710e82023-08-25 09:14:15 +02001737 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001738 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001739 else
1740 # Don't pull in cipher via PSA mechanisms
1741 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001742 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1743 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1744 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001745 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001746 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001747 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001748 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001749
Gilles Peskine21570cf2023-12-22 11:49:50 +01001750 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001751
Valerio Setti7e710e82023-08-25 09:14:15 +02001752 # Ensure that CIPHER_C was not re-enabled
1753 not grep mbedtls_cipher_init library/cipher.o
1754
1755 msg "test: $COMPONENT_DESCRIPTION"
1756 make test
1757}
1758
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001759component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001760 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001761}
1762
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001763component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001764 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001765}
1766
Valerio Settibdfecb62023-11-07 15:37:20 +01001767component_test_full_no_ccm() {
1768 msg "build: full no PSA_WANT_ALG_CCM"
1769
1770 # Full config enables:
1771 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1772 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1773 scripts/config.py full
1774
1775 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1776 # enabled, but not used from TLS since USE_PSA is set.
1777 # This is helpful to ensure that TLS tests below have proper dependencies.
1778 #
1779 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1780 # PSA_WANT_ALG_CCM to be re-enabled.
1781 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1782
Gilles Peskine21570cf2023-12-22 11:49:50 +01001783 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001784
1785 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001786 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001787}
1788
1789component_test_full_no_ccm_star_no_tag() {
1790 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1791
1792 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1793 scripts/config.py full
1794
1795 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1796 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1797 # This basically disables all unauthenticated ciphers on the PSA side, while
1798 # keeping AEADs enabled.
1799 #
1800 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1801 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1802 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1803 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1804 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1805 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1806 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1807 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1808 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1809 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1810
Gilles Peskine21570cf2023-12-22 11:49:50 +01001811 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001812
1813 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001814 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001815
1816 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001817 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001818}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001819
Valerio Settie1655b82023-01-03 15:35:25 +01001820component_test_full_no_bignum () {
1821 msg "build: full minus bignum"
1822 scripts/config.py full
1823 scripts/config.py unset MBEDTLS_BIGNUM_C
1824 # Direct dependencies of bignum
1825 scripts/config.py unset MBEDTLS_ECP_C
1826 scripts/config.py unset MBEDTLS_RSA_C
1827 scripts/config.py unset MBEDTLS_DHM_C
1828 # Direct dependencies of ECP
1829 scripts/config.py unset MBEDTLS_ECDH_C
1830 scripts/config.py unset MBEDTLS_ECDSA_C
1831 scripts/config.py unset MBEDTLS_ECJPAKE_C
1832 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001833 # Disable what auto-enables ECP_LIGHT
1834 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1835 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001836 # Indirect dependencies of ECP
1837 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1838 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1839 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1840 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1841 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1842 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1843 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1844 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1845 # Direct dependencies of DHM
1846 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1847 # Direct dependencies of RSA
1848 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1849 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1850 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1851 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1852 # PK and its dependencies
1853 scripts/config.py unset MBEDTLS_PK_C
1854 scripts/config.py unset MBEDTLS_PK_PARSE_C
1855 scripts/config.py unset MBEDTLS_PK_WRITE_C
1856 scripts/config.py unset MBEDTLS_X509_USE_C
1857 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1858 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1859 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1860 scripts/config.py unset MBEDTLS_X509_CREATE_C
1861 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1862 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1863 scripts/config.py unset MBEDTLS_PKCS7_C
1864 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1865 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1866 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1867
Gilles Peskine21570cf2023-12-22 11:49:50 +01001868 make
Valerio Settie1655b82023-01-03 15:35:25 +01001869
1870 msg "test: full minus bignum"
1871 make test
1872}
1873
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001874component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001875 msg "build: default with only stream cipher"
1876
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001877 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001878 scripts/config.py unset MBEDTLS_GCM_C
1879 scripts/config.py unset MBEDTLS_CCM_C
1880 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001881 #Disable TLS 1.3 (as no AEAD)
1882 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001883 # 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 +02001884 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001885 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001886 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001887 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1888 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001889 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001890 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001891 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001892
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001893 make
1894
1895 msg "test: default with only stream cipher"
1896 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001897
1898 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001899}
1900
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001901component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001902 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001903
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001904 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001905 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001906 scripts/config.py unset MBEDTLS_GCM_C
1907 scripts/config.py unset MBEDTLS_CCM_C
1908 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001909 #Disable TLS 1.3 (as no AEAD)
1910 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001911 # 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 +02001912 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001913 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001914 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001915 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1916 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001917 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001918 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001919 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001920
Przemek Stekiel9550c052022-09-28 09:51:55 +02001921 make
1922
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001923 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001924 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001925
1926 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001927}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001928
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001929component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001930 msg "build: default with only CBC-legacy cipher"
1931
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001932 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001933 scripts/config.py unset MBEDTLS_GCM_C
1934 scripts/config.py unset MBEDTLS_CCM_C
1935 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001936 #Disable TLS 1.3 (as no AEAD)
1937 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001938 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1939 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1940 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001941 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001942 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001943 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001944 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001945 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001946 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001947
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001948 make
1949
1950 msg "test: default with only CBC-legacy cipher"
1951 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001952
1953 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1954 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001955}
1956
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001957component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001958 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001959
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001960 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001961 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001962 scripts/config.py unset MBEDTLS_GCM_C
1963 scripts/config.py unset MBEDTLS_CCM_C
1964 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001965 #Disable TLS 1.3 (as no AEAD)
1966 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001967 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1968 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1969 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001970 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001971 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001972 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001973 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001974 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001975 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001976
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001977 make
1978
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001979 msg "test: default with only CBC-legacy cipher use psa"
1980 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001981
1982 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1983 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001984}
1985
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001986component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001987 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1988
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001989 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001990 scripts/config.py unset MBEDTLS_GCM_C
1991 scripts/config.py unset MBEDTLS_CCM_C
1992 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001993 #Disable TLS 1.3 (as no AEAD)
1994 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001995 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1996 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1997 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1998 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1999 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002000 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002001 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002002 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002003 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002004
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002005 make
2006
2007 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
2008 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002009
2010 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
2011 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002012}
2013
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002014component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
2015 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002016
2017 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002018 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002019 scripts/config.py unset MBEDTLS_GCM_C
2020 scripts/config.py unset MBEDTLS_CCM_C
2021 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002022 #Disable TLS 1.3 (as no AEAD)
2023 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002024 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2025 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2026 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2027 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2028 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002029 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002030 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002031 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002032 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002033
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002034 make
2035
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002036 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002037 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002038
2039 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2040 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002041}
2042
Valerio Setti9f0ec532022-11-08 13:03:24 +01002043# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2044# that we could use for interop testing. However, we now have sort of two
2045# implementations ourselves: one using PSA, the other not. At least test that
2046# these two interoperate with each other.
2047component_test_tls1_2_ecjpake_compatibility() {
2048 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2049 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002050 # Explicitly make lib first to avoid a race condition:
2051 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2052 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002053 make -C programs ssl/ssl_server2 ssl/ssl_client2
2054 cp programs/ssl/ssl_server2 s2_no_use_psa
2055 cp programs/ssl/ssl_client2 c2_no_use_psa
2056
2057 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2058 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2059 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002060 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002061 make -C programs ssl/ssl_server2 ssl/ssl_client2
2062 make -C programs test/udp_proxy test/query_compile_time_config
2063
Valerio Setti70e02902022-12-02 16:21:56 +01002064 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2065 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2066 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2067 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2068 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2069 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2070 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2071 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 +01002072
2073 rm s2_no_use_psa c2_no_use_psa
2074}
2075
Gilles Peskine636c26a2020-03-04 20:46:15 +01002076component_test_everest () {
2077 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2078 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2079 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2080 make
2081
2082 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2083 make test
2084
Gilles Peskine6848d172023-11-02 19:58:03 +01002085 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002086 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002087
Gilles Peskine636c26a2020-03-04 20:46:15 +01002088 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2089 tests/ssl-opt.sh -f ECDH
2090
2091 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2092 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002093 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002094}
2095
Gilles Peskined3beca92020-07-03 00:15:37 +02002096component_test_everest_curve25519_only () {
2097 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002098 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2099 scripts/config.py unset MBEDTLS_ECDSA_C
2100 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2101 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002102 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002103 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002104 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002105 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2106
Dave Rodgman17127e92023-12-14 16:42:48 +00002107 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002108
2109 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2110 make test
2111}
2112
Gilles Peskine8f073122018-11-27 15:58:47 +01002113component_test_small_ssl_out_content_len () {
2114 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002115 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2116 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002117 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002118 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002119
Gilles Peskine8f073122018-11-27 15:58:47 +01002120 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002121 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002122}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002123
Gilles Peskine8f073122018-11-27 15:58:47 +01002124component_test_small_ssl_in_content_len () {
2125 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002126 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2127 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002128 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002129 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002130
Gilles Peskine8f073122018-11-27 15:58:47 +01002131 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002132 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002133}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002134
Gilles Peskine8f073122018-11-27 15:58:47 +01002135component_test_small_ssl_dtls_max_buffering () {
2136 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002137 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002138 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002139 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002140
Gilles Peskine8f073122018-11-27 15:58:47 +01002141 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002142 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 +01002143}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002144
Gilles Peskine8f073122018-11-27 15:58:47 +01002145component_test_small_mbedtls_ssl_dtls_max_buffering () {
2146 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002147 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002148 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002149 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002150
Gilles Peskine8f073122018-11-27 15:58:47 +01002151 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002152 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002153}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002154
Gilles Peskine75cc7712019-09-06 19:47:17 +02002155component_test_psa_collect_statuses () {
2156 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002157 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002158 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002159 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002160 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002161 rm -f tests/statuses.log
2162}
2163
Gilles Peskine8f073122018-11-27 15:58:47 +01002164component_test_full_cmake_clang () {
2165 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002166 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002167 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 +01002168 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002169
k-stachowiak0291cb72019-06-26 15:52:12 +02002170 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002171 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002172
Gilles Peskineda6017c2022-10-30 21:02:40 +01002173 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2174 programs/test/cpp_dummy_build
2175
Gilles Peskine6848d172023-11-02 19:58:03 +01002176 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002177 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002178
Gilles Peskine82b27272019-06-14 18:27:03 +02002179 msg "program demos (full config, clang)" # ~10s
2180 tests/scripts/run_demos.py
2181
k-stachowiak0291cb72019-06-26 15:52:12 +02002182 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002183 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002184
Gilles Peskine8f073122018-11-27 15:58:47 +01002185 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002186 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002187}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002188
Gilles Peskine0c671602022-11-29 16:01:41 +01002189skip_suites_without_constant_flow () {
2190 # Skip the test suites that don't have any constant-flow annotations.
2191 # This will need to be adjusted if we ever start declaring things as
2192 # secret from macros or functions inside tests/include or tests/src.
2193 SKIP_TEST_SUITES=$(
2194 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2195 sed 's/test_suite_//; s/\.function$//' |
2196 tr '\n' ,)
2197 export SKIP_TEST_SUITES
2198}
2199
Dave Rodgman246210e2023-07-31 18:07:44 +01002200skip_all_except_given_suite () {
2201 # Skip all but the given test suite
2202 SKIP_TEST_SUITES=$(
2203 ls -1 tests/suites/test_suite_*.function |
2204 grep -v $1.function |
2205 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2206 tr '\n' ,)
2207 export SKIP_TEST_SUITES
2208}
2209
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002210component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002211 # This tests both (1) accesses to undefined memory, and (2) branches or
2212 # memory access depending on secret values. To distinguish between those:
2213 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2214 # - or alternatively, change the build type to MemSanDbg, which enables
2215 # origin tracking and nicer stack traces (which are useful for debugging
2216 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002217 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2218 scripts/config.py full
2219 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2220 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2221 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2222 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2223 make
2224
2225 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2226 make test
2227}
2228
2229component_test_memsan_constant_flow_psa () {
2230 # This tests both (1) accesses to undefined memory, and (2) branches or
2231 # memory access depending on secret values. To distinguish between those:
2232 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2233 # - or alternatively, change the build type to MemSanDbg, which enables
2234 # origin tracking and nicer stack traces (which are useful for debugging
2235 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002236 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002237 scripts/config.py full
2238 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2239 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2240 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2241 make
2242
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002243 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002244 make test
2245}
2246
Bence Szépkúti0354d042023-12-06 16:14:37 +01002247component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002248 # This tests both (1) everything that valgrind's memcheck usually checks
2249 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2250 # etc.) and (2) branches or memory access depending on secret values,
2251 # which will be reported as uninitialized memory. To distinguish between
2252 # secret and actually uninitialized:
2253 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2254 # - or alternatively, build with debug info and manually run the offending
2255 # test suite with valgrind --track-origins=yes, then check if the origin
2256 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002257 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2258 scripts/config.py full
2259 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2260 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002261 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002262 cmake -D CMAKE_BUILD_TYPE:String=Release .
2263 make
2264
2265 # this only shows a summary of the results (how many of each type)
2266 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002267 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002268 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002269
2270 # Test asm path in constant time module - by default, it will test the plain C
2271 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2272 msg "test: valgrind asm constant_time"
2273 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2274 skip_all_except_given_suite test_suite_constant_time
2275 cmake -D CMAKE_BUILD_TYPE:String=Release .
2276 make clean
2277 make
2278 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002279}
2280
Bence Szépkúti0354d042023-12-06 16:14:37 +01002281component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002282 # This tests both (1) everything that valgrind's memcheck usually checks
2283 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2284 # etc.) and (2) branches or memory access depending on secret values,
2285 # which will be reported as uninitialized memory. To distinguish between
2286 # secret and actually uninitialized:
2287 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2288 # - or alternatively, build with debug info and manually run the offending
2289 # test suite with valgrind --track-origins=yes, then check if the origin
2290 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002291 msg "build: cmake release GCC, full config with constant flow testing"
2292 scripts/config.py full
2293 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002294 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002295 cmake -D CMAKE_BUILD_TYPE:String=Release .
2296 make
2297
2298 # this only shows a summary of the results (how many of each type)
2299 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002300 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002301 make memcheck
2302}
2303
Janos Follath9338cac2023-10-04 18:55:39 +01002304component_test_tsan () {
2305 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002306 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002307 scripts/config.py set MBEDTLS_THREADING_C
2308 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002309 # Self-tests do not currently use multiple threads.
2310 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002311
Ryan6caf84f2024-03-05 13:57:00 +00002312 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2313 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2314
Janos Follath9338cac2023-10-04 18:55:39 +01002315 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2316 make
2317
2318 msg "test: main suites (TSan)"
2319 make test
2320}
2321
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002322component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002323 # Test that removing the deprecated features from the default
2324 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002325 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2326 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002327 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002328
2329 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2330 make test
2331}
2332
2333component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002334 msg "build: make, full_no_deprecated config" # ~ 30s
2335 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002336 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002337
Gilles Peskine30de2e82020-04-20 21:39:22 +02002338 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002339 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002340
2341 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2342 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002343}
2344
Gilles Peskine8386ea22020-04-30 09:07:29 +02002345component_test_full_no_deprecated_deprecated_warning () {
2346 # Test that there is nothing deprecated in "full_no_deprecated".
2347 # A deprecated feature would trigger a warning (made fatal) from
2348 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002349 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2350 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002351 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2352 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002353 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002354
Gilles Peskine30de2e82020-04-20 21:39:22 +02002355 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002356 make test
2357}
2358
Gilles Peskine8386ea22020-04-30 09:07:29 +02002359component_test_full_deprecated_warning () {
2360 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2361 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002362 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002363 scripts/config.py full
2364 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002365 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002366 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2367 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002368 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002369
Gilles Peskine8386ea22020-04-30 09:07:29 +02002370 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2371 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2372 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002373 # Expect warnings from '#warning' directives in check_config.h and
2374 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002375 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 +01002376
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002377 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2378 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002379
2380 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2381 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002382}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002383
Gilles Peskineec541fe2020-01-31 14:24:14 +01002384# Check that the specified libraries exist and are empty.
2385are_empty_libraries () {
2386 nm "$@" >/dev/null 2>/dev/null
2387 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2388}
2389
2390component_build_crypto_default () {
2391 msg "build: make, crypto only"
2392 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002393 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002394 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002395}
2396
2397component_build_crypto_full () {
2398 msg "build: make, crypto only, full config"
2399 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002400 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002401 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002402}
2403
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002404component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002405 msg "build: make, config for PSA crypto service"
2406 scripts/config.py crypto
2407 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2408 # Disable things that are not needed for just cryptography, to
2409 # reach a configuration that would be typical for a PSA cryptography
2410 # service providing all implemented PSA algorithms.
2411 # System stuff
2412 scripts/config.py unset MBEDTLS_ERROR_C
2413 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002414 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002415 # Crypto stuff with no PSA interface
2416 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002417 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002418 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002419 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002420 scripts/config.py unset MBEDTLS_NIST_KW_C
2421 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2422 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2423 scripts/config.py unset MBEDTLS_PKCS12_C
2424 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002425 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2426 # in PSA code to work with RSA keys. We don't require users to set those:
2427 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002428 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002429 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002430 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002431 make CFLAGS='-O1 -Werror' all test
2432 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2433}
2434
Gilles Peskineec541fe2020-01-31 14:24:14 +01002435component_build_crypto_baremetal () {
2436 msg "build: make, crypto only, baremetal config"
2437 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002438 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002439 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002440}
Daniel Axtens446af202020-09-02 21:30:13 +10002441support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002442 support_build_baremetal "$@"
2443}
2444
2445component_build_baremetal () {
2446 msg "build: make, baremetal config"
2447 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002448 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002449}
2450support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002451 # Older Glibc versions include time.h from other headers such as stdlib.h,
2452 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2453 # problem, Ubuntu 18.04 is ok.
2454 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2455}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002456
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002457# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002458component_test_depends_py_cipher_id () {
2459 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002460 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002461}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002462
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002463component_test_depends_py_cipher_chaining () {
2464 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002465 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002466}
2467
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002468component_test_depends_py_cipher_padding () {
2469 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002470 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002471}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002472
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002473component_test_depends_py_curves () {
2474 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002475 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002476}
2477
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002478component_test_depends_py_hashes () {
2479 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002480 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002481}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002482
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002483component_test_depends_py_kex () {
2484 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002485 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002486}
2487
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002488component_test_depends_py_pkalgs () {
2489 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002490 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002491}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002492
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002493# PSA equivalents of the depends.py tests
2494component_test_depends_py_cipher_id_psa () {
2495 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002496 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002497}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002498
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002499component_test_depends_py_cipher_chaining_psa () {
2500 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002501 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002502}
2503
2504component_test_depends_py_cipher_padding_psa () {
2505 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002506 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002507}
2508
2509component_test_depends_py_curves_psa () {
2510 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002511 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002512}
2513
2514component_test_depends_py_hashes_psa () {
2515 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002516 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002517}
2518
2519component_test_depends_py_kex_psa () {
2520 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002521 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002522}
2523
2524component_test_depends_py_pkalgs_psa () {
2525 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002526 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002527}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002528
Valerio Setti6bed64e2024-01-17 15:21:44 +01002529component_test_psa_crypto_config_ffdh_2048_only () {
2530 msg "build: full config - only DH 2048"
2531
2532 scripts/config.py full
2533
2534 # Disable all DH groups other than 2048.
2535 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2536 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2537 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2538 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2539
2540 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2541
2542 msg "test: full config - only DH 2048"
2543 make test
2544
2545 msg "ssl-opt: full config - only DH 2048"
2546 tests/ssl-opt.sh -f "ffdh"
2547}
2548
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002549component_build_no_pk_rsa_alt_support () {
2550 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2551
2552 scripts/config.py full
2553 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2554 scripts/config.py set MBEDTLS_RSA_C
2555 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2556
2557 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002558 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002559}
2560
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002561component_build_module_alt () {
2562 msg "build: MBEDTLS_XXX_ALT" # ~30s
2563 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002564
2565 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002566 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2567 scripts/config.py unset MBEDTLS_AESNI_C
2568 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002569 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002570 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2571 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002572 # You can only have one threading implementation: alt or pthread, not both.
2573 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002574 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2575 # directly and assumes the implementation works with partial groups.
2576 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002577 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2578 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2579 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002580 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2581 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2582 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002583
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002584 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2585 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2586 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002587 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002588
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002589 # We can only compile, not link, since we don't have any implementations
2590 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002591 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002592}
2593
2594component_build_dhm_alt () {
2595 msg "build: MBEDTLS_DHM_ALT" # ~30s
2596 scripts/config.py full
2597 scripts/config.py set MBEDTLS_DHM_ALT
2598 # debug.c currently references mbedtls_dhm_context fields directly.
2599 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002600 # We can only compile, not link, since we don't have any implementations
2601 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002602 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002603}
2604
Gilles Peskine64996c32024-01-23 20:25:47 +01002605component_test_no_psa_crypto_full_cmake_asan() {
2606 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2607 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002608 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002609 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002610 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002611 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002612 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002613 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002614 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002615 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002616 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002617 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002618 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002619 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002620
Gilles Peskine64996c32024-01-23 20:25:47 +01002621 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002622 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002623
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002624 # Note: ssl-opt.sh has some test cases that depend on
2625 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2626 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002627 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002628 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002629
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02002630 # Note: the next two invocations cover all compat.sh test cases.
2631 # We should use the same here and in basic-build-test.sh.
2632 msg "test: compat.sh: default version (full minus PSA crypto)"
2633 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002634
Manuel Pégourié-Gonnard763b2402024-04-22 10:25:09 +02002635 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002636 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002637}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002638
Ronald Cron403c15c2021-09-13 09:38:05 +02002639component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002640 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002641
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002642 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002643 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002644 $(helper_get_psa_key_type_list "ECC") \
2645 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002646
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002647 # Configure
2648 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002649
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002650 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002651 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002652
2653 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002654 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002655
2656 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002657 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2658 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2659
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002660 # Build
2661 # -----
2662
2663 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002664 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2665 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002666
2667 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2668
Valerio Setti3fe105b2023-10-30 11:08:12 +01002669 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002670
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002671 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002672 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002673
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002674 # Run the tests
2675 # -------------
2676
Ronald Cron403c15c2021-09-13 09:38:05 +02002677 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2678 make test
2679}
2680
Valerio Setti44b178c2023-03-22 14:02:57 +01002681component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002682 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002683
2684 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002685 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002686 $(helper_get_psa_key_type_list "ECC") \
2687 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002688
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002689 # Configure
2690 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002691
Ronald Cron46ac0652024-03-18 12:39:04 +01002692 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002693 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002694
Valerio Setti44b178c2023-03-22 14:02:57 +01002695 # Disable the module that's accelerated
2696 scripts/config.py unset MBEDTLS_ECDH_C
2697
2698 # Disable things that depend on it
2699 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2700 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2701 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2702 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2703 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2704
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002705 # Build
2706 # -----
2707
2708 helper_libtestdriver1_make_drivers "$loc_accel_list"
2709
Valerio Setti3fe105b2023-10-30 11:08:12 +01002710 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002711
Valerio Setti44b178c2023-03-22 14:02:57 +01002712 # Make sure this was not re-enabled by accident (additive config)
2713 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002714
2715 # Run the tests
2716 # -------------
2717
Valerio Setti44b178c2023-03-22 14:02:57 +01002718 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002719 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002720}
2721
Przemek Stekieldccb2022023-05-11 10:48:50 +02002722component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002723 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002724
2725 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002726 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002727 $(helper_get_psa_key_type_list "DH") \
2728 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002729
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002730 # Configure
2731 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002732
Przemek Stekiel565353e2023-07-05 11:07:07 +02002733 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002734 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002735
2736 # Disable the module that's accelerated
2737 scripts/config.py unset MBEDTLS_DHM_C
2738
2739 # Disable things that depend on it
2740 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2741 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2742
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002743 # Build
2744 # -----
2745
2746 helper_libtestdriver1_make_drivers "$loc_accel_list"
2747
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002748 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002749
2750 # Make sure this was not re-enabled by accident (additive config)
2751 not grep mbedtls_dhm_ library/dhm.o
2752
2753 # Run the tests
2754 # -------------
2755
Gilles Peskine14302ed2023-07-19 19:30:04 +02002756 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002757 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002758
Gilles Peskine14302ed2023-07-19 19:30:04 +02002759 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002760 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002761}
2762
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002763component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002764 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002765
2766 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002767 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002768
2769 # Disable things that are not supported
2770 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2771 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002772 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002773
Gilles Peskine14302ed2023-07-19 19:30:04 +02002774 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002775 make test
2776
Gilles Peskine14302ed2023-07-19 19:30:04 +02002777 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002778 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002779}
2780
Valerio Setti44b178c2023-03-22 14:02:57 +01002781component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002782 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002783
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002784 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002785 $(helper_get_psa_key_type_list "ECC") \
2786 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002787
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002788 # Configure
2789 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002790
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002791 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002792
2793 # Make built-in fallback not available
2794 scripts/config.py unset MBEDTLS_ECJPAKE_C
2795 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2796
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002797 # Build
2798 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002799
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002800 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002801
Valerio Setti3fe105b2023-10-30 11:08:12 +01002802 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002803
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002804 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002805 not grep mbedtls_ecjpake_init library/ecjpake.o
2806
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002807 # Run the tests
2808 # -------------
2809
Gilles Peskine14302ed2023-07-19 19:30:04 +02002810 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002811 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002812}
2813
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002814component_test_psa_crypto_config_accel_ecc_some_key_types () {
2815 msg "build: full with accelerated EC algs and some key types"
2816
2817 # Algorithms and key types to accelerate
2818 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2819 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2820 ALG_ECDH \
2821 ALG_JPAKE \
2822 KEY_TYPE_ECC_PUBLIC_KEY \
2823 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2824 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002825 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2826 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002827
2828 # Configure
2829 # ---------
2830
2831 # start with config full for maximum coverage (also enables USE_PSA)
2832 helper_libtestdriver1_adjust_config "full"
2833
2834 # Disable modules that are accelerated - some will be re-enabled
2835 scripts/config.py unset MBEDTLS_ECDSA_C
2836 scripts/config.py unset MBEDTLS_ECDH_C
2837 scripts/config.py unset MBEDTLS_ECJPAKE_C
2838 scripts/config.py unset MBEDTLS_ECP_C
2839
2840 # Disable all curves - those that aren't accelerated should be re-enabled
2841 helper_disable_builtin_curves
2842
2843 # Restartable feature is not yet supported by PSA. Once it will in
2844 # the future, the following line could be removed (see issues
2845 # 6061, 6332 and following ones)
2846 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2847
2848 # this is not supported by the driver API yet
2849 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2850
2851 # Build
2852 # -----
2853
2854 # These hashes are needed for some ECDSA signature tests.
2855 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2856 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2857 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2858
Valerio Setti3fe105b2023-10-30 11:08:12 +01002859 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002860
2861 # ECP should be re-enabled but not the others
2862 not grep mbedtls_ecdh_ library/ecdh.o
2863 not grep mbedtls_ecdsa library/ecdsa.o
2864 not grep mbedtls_ecjpake library/ecjpake.o
2865 grep mbedtls_ecp library/ecp.o
2866
2867 # Run the tests
2868 # -------------
2869
2870 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002871 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002872}
2873
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002874# Run tests with only (non-)Weierstrass accelerated
2875# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002876# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2877# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002878common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002879 weierstrass=$1
2880 if [ $weierstrass -eq 1 ]; then
2881 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002882 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002883 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002884 fi
2885
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002886 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002887
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002888 # Note: Curves are handled in a special way by the libtestdriver machinery,
2889 # so we only want to include them in the accel list when building the main
2890 # libraries, hence the use of a separate variable.
2891 # Note: the following loop is a modified version of
2892 # helper_get_psa_curve_list that only keeps Weierstrass families.
2893 loc_weierstrass_list=""
2894 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002895 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2896 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002897 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002898 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002899 ;;
2900 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002901 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002902 ;;
2903 esac
2904 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002905 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002906 loc_curve_list=$loc_weierstrass_list
2907 else
2908 loc_curve_list=$loc_non_weierstrass_list
2909 fi
2910
Valerio Setti3fe105b2023-10-30 11:08:12 +01002911 # Algorithms and key types to accelerate
2912 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2913 ALG_ECDH \
2914 ALG_JPAKE \
2915 $(helper_get_psa_key_type_list "ECC") \
2916 $loc_curve_list"
2917
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002918 # Configure
2919 # ---------
2920
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002921 # Start with config crypto_full and remove PK_C:
2922 # that's what's supported now, see docs/driver-only-builds.md.
2923 helper_libtestdriver1_adjust_config "crypto_full"
2924 scripts/config.py unset MBEDTLS_PK_C
2925 scripts/config.py unset MBEDTLS_PK_PARSE_C
2926 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002927
2928 # Disable modules that are accelerated - some will be re-enabled
2929 scripts/config.py unset MBEDTLS_ECDSA_C
2930 scripts/config.py unset MBEDTLS_ECDH_C
2931 scripts/config.py unset MBEDTLS_ECJPAKE_C
2932 scripts/config.py unset MBEDTLS_ECP_C
2933
2934 # Disable all curves - those that aren't accelerated should be re-enabled
2935 helper_disable_builtin_curves
2936
2937 # Restartable feature is not yet supported by PSA. Once it will in
2938 # the future, the following line could be removed (see issues
2939 # 6061, 6332 and following ones)
2940 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2941
2942 # this is not supported by the driver API yet
2943 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2944
2945 # Build
2946 # -----
2947
2948 # These hashes are needed for some ECDSA signature tests.
2949 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2950 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2951 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2952
Valerio Settiac7a8092023-10-31 12:23:44 +01002953 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002954
2955 # We expect ECDH to be re-enabled for the missing curves
2956 grep mbedtls_ecdh_ library/ecdh.o
2957 # We expect ECP to be re-enabled, however the parts specific to the
2958 # families of curves that are accelerated should be ommited.
2959 # - functions with mxz in the name are specific to Montgomery curves
2960 # - ecp_muladd is specific to Weierstrass curves
2961 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002962 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002963 not grep mbedtls_ecp_muladd library/ecp.o
2964 grep mxz library/ecp.o
2965 else
2966 grep mbedtls_ecp_muladd library/ecp.o
2967 not grep mxz library/ecp.o
2968 fi
2969 # We expect ECDSA and ECJPAKE to be re-enabled only when
2970 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002971 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002972 not grep mbedtls_ecdsa library/ecdsa.o
2973 not grep mbedtls_ecjpake library/ecjpake.o
2974 else
2975 grep mbedtls_ecdsa library/ecdsa.o
2976 grep mbedtls_ecjpake library/ecjpake.o
2977 fi
2978
2979 # Run the tests
2980 # -------------
2981
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002982 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2983 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002984}
2985
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002986component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002987 common_test_psa_crypto_config_accel_ecc_some_curves 1
2988}
2989
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002990component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002991 common_test_psa_crypto_config_accel_ecc_some_curves 0
2992}
2993
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002994# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2995# ECDH, ECDSA) with and without drivers.
2996# The input parameter is a boolean value which indicates:
2997# - 0 keep built-in EC algs,
2998# - 1 exclude built-in EC algs (driver only).
2999#
3000# This is used by the two following components to ensure they always use the
3001# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003002# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
3003# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01003004# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003005config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003006 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01003007 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003008 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003009 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01003010 # Disable modules that are accelerated
3011 scripts/config.py unset MBEDTLS_ECDSA_C
3012 scripts/config.py unset MBEDTLS_ECDH_C
3013 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02003014 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01003015 fi
3016
3017 # Restartable feature is not yet supported by PSA. Once it will in
3018 # the future, the following line could be removed (see issues
3019 # 6061, 6332 and following ones)
3020 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003021}
3022
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003023# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3024component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003025 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003026
3027 # Algorithms and key types to accelerate
3028 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3029 ALG_ECDH \
3030 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003031 $(helper_get_psa_key_type_list "ECC") \
3032 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003033
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003034 # Configure
3035 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003036
3037 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003038 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003039
Valerio Setti0a342c92023-09-01 09:12:31 +02003040 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003041 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3042 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003043
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003044 # Build
3045 # -----
3046
3047 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003048 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3049 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003050 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3051
Valerio Setti3fe105b2023-10-30 11:08:12 +01003052 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003053
3054 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3055 not grep mbedtls_ecdsa_ library/ecdsa.o
3056 not grep mbedtls_ecdh_ library/ecdh.o
3057 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003058 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003059
3060 # Run the tests
3061 # -------------
3062
Gilles Peskine14302ed2023-07-19 19:30:04 +02003063 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003064 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003065
Gilles Peskine14302ed2023-07-19 19:30:04 +02003066 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003067 tests/ssl-opt.sh
3068}
3069
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003070# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3071component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003072 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003073
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003074 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003075
Gilles Peskine21570cf2023-12-22 11:49:50 +01003076 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003077
Gilles Peskine14302ed2023-07-19 19:30:04 +02003078 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003079 make test
3080
Gilles Peskine14302ed2023-07-19 19:30:04 +02003081 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003082 tests/ssl-opt.sh
3083}
3084
Valerio Settie618cb02023-04-12 14:59:16 +02003085# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003086# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3087# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003088# to ensure that both tests use the same underlying configuration when testing
3089# driver's coverage with analyze_outcomes.py.
3090#
3091# This functions accepts 1 boolean parameter as follows:
3092# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3093# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3094# - 0: include built-in implementation of EC algorithms.
3095#
3096# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3097# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003098config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003099 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003100 # start with full config for maximum coverage (also enables USE_PSA)
3101 helper_libtestdriver1_adjust_config "full"
3102
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003103 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003104 # Disable modules that are accelerated
3105 scripts/config.py unset MBEDTLS_ECDSA_C
3106 scripts/config.py unset MBEDTLS_ECDH_C
3107 scripts/config.py unset MBEDTLS_ECJPAKE_C
3108 # Disable ECP module (entirely)
3109 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003110 fi
3111
Valerio Settiaecd32c2023-06-14 10:42:31 +02003112 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3113 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003114 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003115 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003116
Valerio Settie618cb02023-04-12 14:59:16 +02003117 # Restartable feature is not yet supported by PSA. Once it will in
3118 # the future, the following line could be removed (see issues
3119 # 6061, 6332 and following ones)
3120 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003121}
3122
3123# Build and test a configuration where driver accelerates all EC algs while
3124# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3125# side.
3126#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003127# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3128component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003129 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003130
3131 # Algorithms and key types to accelerate
3132 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3133 ALG_ECDH \
3134 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003135 $(helper_get_psa_key_type_list "ECC") \
3136 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003137
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003138 # Configure
3139 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003140
Valerio Settie618cb02023-04-12 14:59:16 +02003141 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003142 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003143 # Disable all the builtin curves. All the required algs are accelerated.
3144 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003145
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003146 # Build
3147 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003148
3149 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003150 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3151 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3152 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003153
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003154 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003155
Valerio Setti3fe105b2023-10-30 11:08:12 +01003156 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003157
3158 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3159 not grep mbedtls_ecdsa_ library/ecdsa.o
3160 not grep mbedtls_ecdh_ library/ecdh.o
3161 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003162 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003163 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003164
3165 # Run the tests
3166 # -------------
3167
Gilles Peskine14302ed2023-07-19 19:30:04 +02003168 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003169 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003170
Gilles Peskine14302ed2023-07-19 19:30:04 +02003171 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003172 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003173}
3174
3175# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003176# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003177# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003178component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003179 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003180
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003181 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003182
Gilles Peskine21570cf2023-12-22 11:49:50 +01003183 make
Valerio Settie618cb02023-04-12 14:59:16 +02003184
Gilles Peskine14302ed2023-07-19 19:30:04 +02003185 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003186 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003187
Gilles Peskine14302ed2023-07-19 19:30:04 +02003188 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003189 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003190}
3191
Valerio Setti4e2f2442023-08-15 10:10:26 +02003192# This is a common configuration helper used directly from:
3193# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3194# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3195# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003196# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003197# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003198# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003199# - this is the reference component of the above
3200# - it still disables RSA and FFDH, but it uses builtin EC algs
3201# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3202# - accelerate all EC and FFDH algs, disable only RSA
3203# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3204# - this is the reference component of the above
3205# - it still disables RSA, but it uses builtin EC and FFDH algs
3206#
3207# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003208# $1: a boolean value which states if we are testing an accelerated scenario
3209# or not.
3210# $2: a string value which states which components are tested. Allowed values
3211# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003212config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003213 driver_only="$1"
3214 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003215 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003216 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003217
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003218 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003219 # Disable modules that are accelerated
3220 scripts/config.py unset MBEDTLS_ECDSA_C
3221 scripts/config.py unset MBEDTLS_ECDH_C
3222 scripts/config.py unset MBEDTLS_ECJPAKE_C
3223 # Disable ECP module (entirely)
3224 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003225 # Also disable bignum
3226 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003227 fi
3228
3229 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3230 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3231 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3232 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3233
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003234 # RSA support is intentionally disabled on this test because RSA_C depends
3235 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003236 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3237 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 +02003238 scripts/config.py unset MBEDTLS_RSA_C
3239 scripts/config.py unset MBEDTLS_PKCS1_V15
3240 scripts/config.py unset MBEDTLS_PKCS1_V21
3241 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3242 # Also disable key exchanges that depend on RSA
3243 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3244 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3245 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3246 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3247 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3248
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003249 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003250 # When testing ECC only, we disable FFDH support, both from builtin and
3251 # PSA sides, and also disable the key exchanges that depend on DHM.
3252 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3253 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 +01003254 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003255 scripts/config.py unset MBEDTLS_DHM_C
3256 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3257 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3258 else
3259 # When testing ECC and DH instead, we disable DHM and depending key
3260 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003261 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003262 scripts/config.py unset MBEDTLS_DHM_C
3263 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3264 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3265 fi
3266 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003267
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003268 # Restartable feature is not yet supported by PSA. Once it will in
3269 # the future, the following line could be removed (see issues
3270 # 6061, 6332 and following ones)
3271 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3272}
3273
Valerio Setti4e2f2442023-08-15 10:10:26 +02003274# Common helper used by:
3275# - component_test_psa_crypto_config_accel_ecc_no_bignum
3276# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003277#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003278# The goal is to build and test accelerating either:
3279# - ECC only or
3280# - both ECC and FFDH
3281#
3282# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003283# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3284# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003285common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003286 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003287
Valerio Setti5dfaca42023-09-05 08:48:51 +02003288 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003289 if [ "$test_target" = "ECC_DH" ]; then
3290 accel_text="ECC/FFDH"
3291 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003292 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003293 accel_text="ECC"
3294 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003295 fi
3296
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003297 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003298
3299 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003300 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3301 ALG_ECDH \
3302 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003303 $(helper_get_psa_key_type_list "ECC") \
3304 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003305 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003306 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003307 loc_accel_list="$loc_accel_list \
3308 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003309 $(helper_get_psa_key_type_list "DH") \
3310 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003311 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003312
3313 # Configure
3314 # ---------
3315
3316 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003317 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003318 # Disable all the builtin curves. All the required algs are accelerated.
3319 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003320
3321 # Build
3322 # -----
3323
3324 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003325 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3326 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3327 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003328
3329 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3330
Valerio Setti3fe105b2023-10-30 11:08:12 +01003331 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003332
3333 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3334 not grep mbedtls_ecdsa_ library/ecdsa.o
3335 not grep mbedtls_ecdh_ library/ecdh.o
3336 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003337 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003338 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003339 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003340 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003341 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003342
3343 # Run the tests
3344 # -------------
3345
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003346 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003347
Gilles Peskine21570cf2023-12-22 11:49:50 +01003348 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003349
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003350 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003351 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003352}
3353
Valerio Setti4e2f2442023-08-15 10:10:26 +02003354# Common helper used by:
3355# - component_test_psa_crypto_config_reference_ecc_no_bignum
3356# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3357#
3358# The goal is to build and test a reference scenario (i.e. with builtin
3359# components) compared to the ones used in
3360# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3361#
3362# It is meant to be used in conjunction with
3363# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3364# coverage analysis in "analyze_outcomes.py" script.
3365common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003366 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003367
Valerio Setti5dfaca42023-09-05 08:48:51 +02003368 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003369 if [ "$test_target" = "ECC_DH" ]; then
3370 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003371 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003372 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003373 fi
3374
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003375 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003376
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003377 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003378
Gilles Peskine21570cf2023-12-22 11:49:50 +01003379 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003380
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003381 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003382 make test
3383
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003384 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003385 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003386}
3387
Valerio Setti4e2f2442023-08-15 10:10:26 +02003388component_test_psa_crypto_config_accel_ecc_no_bignum () {
3389 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3390}
3391
3392component_test_psa_crypto_config_reference_ecc_no_bignum () {
3393 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3394}
3395
3396component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3397 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3398}
3399
3400component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3401 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3402}
3403
Valerio Settiac6d35f2023-08-04 12:49:11 +02003404# Helper for setting common configurations between:
3405# - component_test_tfm_config_p256m_driver_accel_ec()
3406# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003407common_tfm_config () {
3408 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003409 cp configs/config-tfm.h "$CONFIG_H"
3410 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3411 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003412
Yanray Wang73bb2312023-09-25 11:21:15 +08003413 # Other config adjustment to make the tests pass.
3414 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003415 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003416 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3417 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003418
Yanray Wang73bb2312023-09-25 11:21:15 +08003419 # Config adjustment for better test coverage in our environment.
3420 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003421 #
3422 # Enable filesystem I/O for the benefit of PK parse/write tests.
3423 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3424}
3425
Valerio Settiac6d35f2023-08-04 12:49:11 +02003426# Keep this in sync with component_test_tfm_config() as they are both meant
3427# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003428component_test_tfm_config_p256m_driver_accel_ec () {
3429 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3430
3431 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003432
Dave Rodgman897bb772023-11-15 16:34:20 +00003433 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003434 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003435
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003436 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3437 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003438 not grep mbedtls_ecdh_ library/ecdh.o
3439 not grep mbedtls_ecjpake_ library/ecjpake.o
3440 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3441 not grep mbedtls_ecp_ library/ecp.o
3442 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003443 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003444 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003445 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003446 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003447
Valerio Setti5e18b902023-12-04 12:07:30 +01003448 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3449 # files, so we want to ensure that it has not be re-enabled accidentally.
3450 not grep mbedtls_cipher library/cipher.o
3451
Valerio Settib7e95442023-03-21 11:52:33 +01003452 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003453 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003454 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003455}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003456
Valerio Settiac6d35f2023-08-04 12:49:11 +02003457# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3458# they are both meant to be used in analyze_outcomes.py for driver's coverage
3459# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003460component_test_tfm_config() {
3461 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003462
Dave Rodgman897bb772023-11-15 16:34:20 +00003463 # Disable P256M driver, which is on by default, so that analyze_outcomes
3464 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3465 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3466
Valerio Setti52ba0e32023-08-04 12:43:03 +02003467 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003468 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003469
Dave Rodgman897bb772023-11-15 16:34:20 +00003470 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003471 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003472
Valerio Setti5e18b902023-12-04 12:07:30 +01003473 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3474 # files, so we want to ensure that it has not be re-enabled accidentally.
3475 not grep mbedtls_cipher library/cipher.o
3476
Valerio Setti52ba0e32023-08-04 12:43:03 +02003477 msg "test: TF-M config"
3478 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003479}
3480
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003481# Common helper for component_full_without_ecdhe_ecdsa() and
3482# component_full_without_ecdhe_ecdsa_and_tls13() which:
3483# - starts from the "full" configuration minus the list of symbols passed in
3484# as 1st parameter
3485# - build
3486# - test only TLS (i.e. test_suite_tls and ssl-opt)
3487build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003488 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003489
3490 msg "build: full minus something, test TLS"
3491
3492 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003493 for sym in $symbols_to_disable; do
3494 echo "Disabling $sym"
3495 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003496 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003497
Gilles Peskine21570cf2023-12-22 11:49:50 +01003498 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003499
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003500 msg "test: full minus something, test TLS"
3501 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003502
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003503 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003504 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003505}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003506
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003507component_full_without_ecdhe_ecdsa () {
3508 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003509}
3510
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003511component_full_without_ecdhe_ecdsa_and_tls13 () {
3512 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3513 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003514}
3515
Valerio Setti249b18a2023-06-20 12:08:30 +02003516# This is an helper used by:
3517# - component_test_psa_ecc_key_pair_no_derive
3518# - component_test_psa_ecc_key_pair_no_generate
3519# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3520# enabled, but one. Input arguments are as follows:
3521# - $1 is the key type under test, i.e. ECC/RSA/DH
3522# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003523build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003524 key_type=$1
3525 unset_option=$2
3526 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003527
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003528 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003529 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003530 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3531 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3532
3533 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3534 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003535 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003536
Gilles Peskine21570cf2023-12-22 11:49:50 +01003537 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003538
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003539 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003540 make test
3541}
3542
3543component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003544 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003545}
3546
3547component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003548 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003549}
3550
Pengyu Lve705f572023-12-06 16:38:15 +08003551config_psa_crypto_accel_rsa () {
3552 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003553
Pengyu Lve705f572023-12-06 16:38:15 +08003554 # Start from crypto_full config (no X.509, no TLS)
3555 helper_libtestdriver1_adjust_config "crypto_full"
3556
3557 if [ "$driver_only" -eq 1 ]; then
3558 # Remove RSA support and its dependencies
3559 scripts/config.py unset MBEDTLS_RSA_C
3560 scripts/config.py unset MBEDTLS_PKCS1_V15
3561 scripts/config.py unset MBEDTLS_PKCS1_V21
3562
3563 # We need PEM parsing in the test library as well to support the import
3564 # of PEM encoded RSA keys.
3565 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3566 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3567 fi
3568}
3569
3570component_test_psa_crypto_config_accel_rsa_crypto () {
3571 msg "build: crypto_full with accelerated RSA"
3572
3573 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3574 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3575 KEY_TYPE_RSA_PUBLIC_KEY \
3576 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3577 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3578 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3579 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003580
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003581 # Configure
3582 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003583
Pengyu Lve705f572023-12-06 16:38:15 +08003584 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003585
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003586 # Build
3587 # -----
3588
Pengyu Lve705f572023-12-06 16:38:15 +08003589 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003590 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 +08003591 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003592 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003593
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003594 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003595
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003596 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003597 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003598
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003599 # Run the tests
3600 # -------------
3601
Pengyu Lve705f572023-12-06 16:38:15 +08003602 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003603 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003604}
3605
3606component_test_psa_crypto_config_reference_rsa_crypto () {
3607 msg "build: crypto_full with non-accelerated RSA"
3608
3609 # Configure
3610 # ---------
3611 config_psa_crypto_accel_rsa 0
3612
3613 # Build
3614 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003615 make
Pengyu Lve705f572023-12-06 16:38:15 +08003616
3617 # Run the tests
3618 # -------------
3619 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003620 make test
3621}
3622
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003623# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003624# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003625component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003626 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003627
Valerio Setti4590bc22023-06-13 15:39:23 +02003628 # Create a temporary output file unless there is already one set
3629 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3630 REMOVE_OUTCOME_ON_EXIT="no"
3631 else
3632 REMOVE_OUTCOME_ON_EXIT="yes"
3633 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3634 export MBEDTLS_TEST_OUTCOME_FILE
3635 fi
3636
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003637 # Start from crypto configuration
3638 scripts/config.py crypto
3639
3640 # Remove RSA support and its dependencies
3641 scripts/config.py unset MBEDTLS_PKCS1_V15
3642 scripts/config.py unset MBEDTLS_PKCS1_V21
3643 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3644 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3645 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3646 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3647 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3648 scripts/config.py unset MBEDTLS_RSA_C
3649 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3650
3651 # Enable PSA support
3652 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3653
Valerio Setti01cc88a2023-06-15 11:53:08 +02003654 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003655 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003656 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3657 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3658 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003659
3660 make
3661
Valerio Setti01cc88a2023-06-15 11:53:08 +02003662 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003663 make test
3664
3665 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3666 # performing RSA signature.
3667 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3668 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3669
3670 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3671 rm $MBEDTLS_TEST_OUTCOME_FILE
3672 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003673}
3674
Ronald Cronb2312452021-05-08 14:32:59 +02003675component_test_psa_crypto_config_accel_hash () {
3676 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3677
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003678 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3679 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3680 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003681
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003682 # Configure
3683 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003684
Ronald Cron46ac0652024-03-18 12:39:04 +01003685 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003686 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003687
3688 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003689 scripts/config.py unset MBEDTLS_MD5_C
3690 scripts/config.py unset MBEDTLS_RIPEMD160_C
3691 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003692 scripts/config.py unset MBEDTLS_SHA224_C
3693 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003694 scripts/config.py unset MBEDTLS_SHA384_C
3695 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003696 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003697
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003698 # Build
3699 # -----
3700
3701 helper_libtestdriver1_make_drivers "$loc_accel_list"
3702
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003703 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003704
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003705 # There's a risk of something getting re-enabled via config_psa.h;
3706 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3707 not grep mbedtls_md5 library/md5.o
3708 not grep mbedtls_sha1 library/sha1.o
3709 not grep mbedtls_sha256 library/sha256.o
3710 not grep mbedtls_sha512 library/sha512.o
3711 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003712
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003713 # Run the tests
3714 # -------------
3715
Ronald Cronb2312452021-05-08 14:32:59 +02003716 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3717 make test
3718}
3719
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003720component_test_psa_crypto_config_accel_hash_keep_builtins () {
3721 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3722 # This component ensures that all the test cases for
3723 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3724
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003725 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3726 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3727 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003728
Ronald Cron46ac0652024-03-18 12:39:04 +01003729 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003730 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003731
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003732 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003733
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003734 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003735
3736 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3737 make test
3738}
3739
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003740# Auxiliary function to build config for hashes with and without drivers
3741config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003742 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003743 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003744 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003745 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003746 # disable the built-in implementation of hashes
3747 scripts/config.py unset MBEDTLS_MD5_C
3748 scripts/config.py unset MBEDTLS_RIPEMD160_C
3749 scripts/config.py unset MBEDTLS_SHA1_C
3750 scripts/config.py unset MBEDTLS_SHA224_C
3751 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003752 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003753 scripts/config.py unset MBEDTLS_SHA384_C
3754 scripts/config.py unset MBEDTLS_SHA512_C
3755 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003756 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003757 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003758}
3759
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003760# Note that component_test_psa_crypto_config_reference_hash_use_psa
3761# is related to this component and both components need to be kept in sync.
3762# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003763component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003764 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003765
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003766 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3767 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3768 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003769
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003770 # Configure
3771 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003772
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003773 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003774
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003775 # Build
3776 # -----
3777
3778 helper_libtestdriver1_make_drivers "$loc_accel_list"
3779
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003780 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003781
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003782 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003783 # 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 +02003784 not grep mbedtls_md5 library/md5.o
3785 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003786 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003787 not grep mbedtls_sha512 library/sha512.o
3788 not grep mbedtls_ripemd160 library/ripemd160.o
3789
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003790 # Run the tests
3791 # -------------
3792
Gilles Peskine14302ed2023-07-19 19:30:04 +02003793 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003794 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003795
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003796 # This is mostly useful so that we can later compare outcome files with
3797 # the reference config in analyze_outcomes.py, to check that the
3798 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003799 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003800 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003801
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003802 # This is to make sure all ciphersuites are exercised, but we don't need
3803 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003804 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003805 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003806}
3807
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003808# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3809# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3810# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3811# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003812component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003813 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003814
3815 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003816
Gilles Peskine21570cf2023-12-22 11:49:50 +01003817 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003818
Gilles Peskine14302ed2023-07-19 19:30:04 +02003819 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003820 make test
3821
Gilles Peskine14302ed2023-07-19 19:30:04 +02003822 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003823 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003824}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003825
Valerio Setti8eb310c2024-01-22 16:22:57 +01003826# Auxiliary function to build config for hashes with and without drivers
3827config_psa_crypto_hmac_use_psa () {
3828 driver_only="$1"
3829 # start with config full for maximum coverage (also enables USE_PSA)
3830 helper_libtestdriver1_adjust_config "full"
3831
Valerio Setticd89b0b2024-01-24 14:24:55 +01003832 if [ "$driver_only" -eq 1 ]; then
3833 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3834 # is still enabled though (for ENTROPY_C among others).
3835 scripts/config.py unset MBEDTLS_MD_C
3836 # Disable also the builtin hashes since they are supported by the driver
3837 # and MD module is able to perform PSA dispathing.
3838 scripts/config.py unset-all MBEDTLS_SHA
3839 scripts/config.py unset MBEDTLS_MD5_C
3840 scripts/config.py unset MBEDTLS_RIPEMD160_C
3841 fi
3842
Valerio Setti8eb310c2024-01-22 16:22:57 +01003843 # Direct dependencies of MD_C. We disable them also in the reference
3844 # component to work with the same set of features.
3845 scripts/config.py unset MBEDTLS_PKCS7_C
3846 scripts/config.py unset MBEDTLS_PKCS5_C
3847 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3848 scripts/config.py unset MBEDTLS_HKDF_C
3849 # Dependencies of HMAC_DRBG
3850 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3851 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3852}
3853
3854component_test_psa_crypto_config_accel_hmac() {
3855 msg "test: full with accelerated hmac"
3856
3857 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3858 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3859 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3860 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3861
3862 # Configure
3863 # ---------
3864
3865 config_psa_crypto_hmac_use_psa 1
3866
Valerio Setti8eb310c2024-01-22 16:22:57 +01003867 # Build
3868 # -----
3869
3870 helper_libtestdriver1_make_drivers "$loc_accel_list"
3871
3872 helper_libtestdriver1_make_main "$loc_accel_list"
3873
3874 # Ensure that built-in support for HMAC is disabled.
3875 not grep mbedtls_md_hmac library/md.o
3876
3877 # Run the tests
3878 # -------------
3879
3880 msg "test: full with accelerated hmac"
3881 make test
3882}
3883
3884component_test_psa_crypto_config_reference_hmac() {
3885 msg "test: full without accelerated hmac"
3886
3887 config_psa_crypto_hmac_use_psa 0
3888
3889 make
3890
3891 msg "test: full without accelerated hmac"
3892 make test
3893}
3894
Valerio Setti9da01a72023-12-18 17:38:18 +01003895component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003896 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003897
Valerio Setti9da01a72023-12-18 17:38:18 +01003898 # Albeit this components aims at accelerating DES which should only support
3899 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3900 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003901 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3902 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3903 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003904
Valerio Setti9da01a72023-12-18 17:38:18 +01003905 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3906 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3907 # of this component. This limitation will be addressed by #8598.
3908
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003909 # Configure
3910 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003911
Valerio Setti9a427302023-10-17 11:40:42 +02003912 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003913 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003914
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003915 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003916 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3917 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3918 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3919 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3920 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3921 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3922 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003923 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003924
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003925 # Build
3926 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003927
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003928 helper_libtestdriver1_make_drivers "$loc_accel_list"
3929
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003930 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003931
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003932 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003933 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003934
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003935 # Run the tests
3936 # -------------
3937
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003938 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003939 make test
3940}
3941
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003942component_test_psa_crypto_config_accel_aead () {
3943 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3944
Valerio Setti3f02bb72023-10-02 15:57:33 +02003945 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3946 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003947
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003948 # Configure
3949 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003950
Valerio Setti3f02bb72023-10-02 15:57:33 +02003951 # Start from full config
3952 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003953
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003954 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003955 scripts/config.py unset MBEDTLS_GCM_C
3956 scripts/config.py unset MBEDTLS_CCM_C
3957 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003958
Valerio Settia50b89e2023-11-08 15:58:47 +01003959 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3960 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003961
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003962 # Build
3963 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003964
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003965 helper_libtestdriver1_make_drivers "$loc_accel_list"
3966
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003967 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003968
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003969 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003970 not grep mbedtls_ccm library/ccm.o
3971 not grep mbedtls_gcm library/gcm.o
3972 not grep mbedtls_chachapoly library/chachapoly.o
3973
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003974 # Run the tests
3975 # -------------
3976
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003977 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3978 make test
3979}
3980
Valerio Settib680fc42023-10-13 09:29:37 +02003981# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003982# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3983# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3984common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003985 # Start from the full config
3986 helper_libtestdriver1_adjust_config "full"
3987
Valerio Settib680fc42023-10-13 09:29:37 +02003988 scripts/config.py unset MBEDTLS_NIST_KW_C
3989}
3990
Valerio Settib6b301f2023-10-04 12:05:05 +02003991# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003992# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3993# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003994# are meant to be used together in analyze_outcomes.py script in order to test
3995# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003996component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3997 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003998
Valerio Settiad8b7f02023-10-25 12:39:50 +02003999 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 +01004000 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02004001 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02004002 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
4003
4004 # Configure
4005 # ---------
4006
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004007 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004008
4009 # Disable the things that are being accelerated
4010 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4011 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
4012 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
4013 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
4014 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
4015 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4016 scripts/config.py unset MBEDTLS_GCM_C
4017 scripts/config.py unset MBEDTLS_CCM_C
4018 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02004019 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02004020 scripts/config.py unset MBEDTLS_DES_C
4021 scripts/config.py unset MBEDTLS_AES_C
4022 scripts/config.py unset MBEDTLS_ARIA_C
4023 scripts/config.py unset MBEDTLS_CHACHA20_C
4024 scripts/config.py unset MBEDTLS_CAMELLIA_C
4025
Valerio Settiec9b2582023-11-08 16:50:54 +01004026 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
4027 # does not depend on it.
4028 scripts/config.py unset MBEDTLS_CIPHER_C
4029
Valerio Settib6b301f2023-10-04 12:05:05 +02004030 # Build
4031 # -----
4032
4033 helper_libtestdriver1_make_drivers "$loc_accel_list"
4034
4035 helper_libtestdriver1_make_main "$loc_accel_list"
4036
4037 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01004038 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02004039 not grep mbedtls_des library/des.o
4040 not grep mbedtls_aes library/aes.o
4041 not grep mbedtls_aria library/aria.o
4042 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004043 not grep mbedtls_ccm library/ccm.o
4044 not grep mbedtls_gcm library/gcm.o
4045 not grep mbedtls_chachapoly library/chachapoly.o
4046 not grep mbedtls_cmac library/cmac.o
4047
4048 # Run the tests
4049 # -------------
4050
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004051 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004052 make test
Valerio Settif9414552023-11-09 10:43:20 +01004053
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004054 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004055 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004056
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004057 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004058 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004059}
4060
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004061component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4062 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4063 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004064
Gilles Peskine21570cf2023-12-22 11:49:50 +01004065 make
Valerio Settif9414552023-11-09 10:43:20 +01004066
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004067 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004068 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 non-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 non-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
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004077common_block_cipher_dispatch() {
4078 TEST_WITH_DRIVER="$1"
4079
4080 # Start from the full config
4081 helper_libtestdriver1_adjust_config "full"
4082
4083 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4084 # Disable key types that are accelerated (there is no legacy equivalent
4085 # symbol for ECB)
4086 scripts/config.py unset MBEDTLS_AES_C
4087 scripts/config.py unset MBEDTLS_ARIA_C
4088 scripts/config.py unset MBEDTLS_CAMELLIA_C
4089 fi
4090
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004091 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004092 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004093 # Keep this also in the reference component in order to skip the same tests
4094 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004095 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4096 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4097 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4098 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4099 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4100 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4101 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Cron7d949ae2024-05-15 18:31:17 +02004102 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004103
4104 # Disable direct dependency on AES_C
4105 scripts/config.py unset MBEDTLS_NIST_KW_C
4106
4107 # Prevent the cipher module from using deprecated PSA path. The reason is
4108 # that otherwise there will be tests relying on "aes_info" (defined in
4109 # "cipher_wrap.c") whose functions are not available when AES_C is
4110 # not defined. ARIA and Camellia are not a problem in this case because
4111 # the PSA path is not tested for these key types.
4112 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4113}
4114
Valerio Settif8e6cba2023-12-12 11:53:39 +01004115component_test_full_block_cipher_psa_dispatch () {
4116 msg "build: full + PSA dispatch in block_cipher"
4117
4118 loc_accel_list="ALG_ECB_NO_PADDING \
4119 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4120
4121 # Configure
4122 # ---------
4123
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004124 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004125
Valerio Settif8e6cba2023-12-12 11:53:39 +01004126 # Build
4127 # -----
4128
4129 helper_libtestdriver1_make_drivers "$loc_accel_list"
4130
4131 helper_libtestdriver1_make_main "$loc_accel_list"
4132
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004133 # Make sure disabled components were not re-enabled by accident (additive
4134 # config)
4135 not grep mbedtls_aes_ library/aes.o
4136 not grep mbedtls_aria_ library/aria.o
4137 not grep mbedtls_camellia_ library/camellia.o
4138
Valerio Settif8e6cba2023-12-12 11:53:39 +01004139 # Run the tests
4140 # -------------
4141
4142 msg "test: full + PSA dispatch in block_cipher"
4143 make test
4144}
4145
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004146# This is the reference component of component_test_full_block_cipher_psa_dispatch
4147component_test_full_block_cipher_legacy_dispatch () {
4148 msg "build: full + legacy dispatch in block_cipher"
4149
4150 common_block_cipher_dispatch 0
4151
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004152 make
4153
4154 msg "test: full + legacy dispatch in block_cipher"
4155 make test
4156}
4157
Gilles Peskine36dea152023-07-20 22:19:45 +02004158component_test_aead_chachapoly_disabled() {
4159 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004160 scripts/config.py full
4161 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004162 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004163 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004164
Gilles Peskine36dea152023-07-20 22:19:45 +02004165 msg "test: full minus CHACHAPOLY"
4166 make test
4167}
4168
4169component_test_aead_only_ccm() {
4170 msg "build: full minus CHACHAPOLY and GCM"
4171 scripts/config.py full
4172 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4173 scripts/config.py unset MBEDTLS_GCM_C
4174 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4175 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004176 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004177
4178 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004179 make test
4180}
4181
Ronald Crone501d0e2023-07-10 08:31:19 +02004182component_test_ccm_aes_sha256() {
4183 msg "build: CCM + AES + SHA256 configuration"
4184
Ronald Cron7612d8c2023-07-20 10:03:54 +02004185 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004186 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004187
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004188 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004189
4190 msg "test: CCM + AES + SHA256 configuration"
4191 make test
4192}
4193
John Durkopd0321952020-10-29 21:37:36 -07004194# This should be renamed to test and updated once the accelerator ECDH code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004195component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004196 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07004197 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004198 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004199 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004200 scripts/config.py unset MBEDTLS_ECDH_C
4201 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
4202 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
4203 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
4204 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
4205 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
4206 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004207 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_ECDH -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004208}
4209
4210# This should be renamed to test and updated once the accelerator HMAC code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004211component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004212 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkopd0321952020-10-29 21:37:36 -07004213 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004214 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004215 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004216 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004217 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HMAC -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004218}
4219
4220# This should be renamed to test and updated once the accelerator HKDF code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004221component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004222 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkopd0321952020-10-29 21:37:36 -07004223 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004224 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
4225 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01004226 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
4227 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004228 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004229 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HKDF -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004230}
4231
John Durkop1b7ee052020-11-27 08:51:22 -08004232# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
4233component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004234 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004235 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004236 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004237 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004238 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4239 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4240 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4241 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4242 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4243 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4244 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004245 scripts/config.py unset MBEDTLS_LMS_C
4246 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004247 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004248 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_MD5 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004249}
4250
4251# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
4252component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004253 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004254 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004255 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004256 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004257 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4258 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4259 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4260 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4261 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4262 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4263 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004264 scripts/config.py unset MBEDTLS_LMS_C
4265 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004266 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004267 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RIPEMD160 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004268}
4269
4270# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
4271component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004272 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004273 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004274 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004275 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004276 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4277 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4278 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4279 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4280 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4281 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4282 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004283 scripts/config.py unset MBEDTLS_LMS_C
4284 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004285 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004286 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_1 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004287}
4288
4289# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
4290component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004291 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004292 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004293 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004294 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004295 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4296 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4297 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4298 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4299 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4300 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08004301 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004302 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_224 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004303}
4304
4305# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
4306component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004307 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004308 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004309 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004310 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004311 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4312 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4313 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4314 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4315 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4316 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08004317 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004318 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_256 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004319}
4320
4321# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
4322component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004323 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004324 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004325 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004326 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004327 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4328 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4329 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4330 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4331 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4332 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004333 scripts/config.py unset MBEDTLS_LMS_C
4334 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004335 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004336 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_384 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004337}
4338
4339# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
4340component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004341 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004342 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004343 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004344 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004345 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4346 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4347 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4348 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4349 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4350 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4351 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004352 scripts/config.py unset MBEDTLS_LMS_C
4353 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004354 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004355 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_512 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004356}
4357
John Durkopd0321952020-10-29 21:37:36 -07004358# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004359component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004360 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_CRYPT + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopd0321952020-10-29 21:37:36 -07004361 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004362 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004363 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004364 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
4365 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4366 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4367 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07004368 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004369 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_CRYPT -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004370}
4371
4372# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004373component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004374 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_SIGN + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004375 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004376 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004377 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004378 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
4379 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4380 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4381 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004382 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004383 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_SIGN -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004384}
4385
4386# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004387component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004388 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_OAEP + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004389 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004390 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004391 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004392 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
4393 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4394 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4395 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004396 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004397 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_OAEP -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004398}
4399
4400# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004401component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004402 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PSS + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004403 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004404 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004405 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004406 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4407 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4408 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4409 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07004410 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004411 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PSS -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004412}
4413
4414# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004415component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004416 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_xxx + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004417 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004418 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004419 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004420 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4421 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
4422 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
4423 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
4424 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07004425 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004426 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_KEY_PAIR -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004427}
4428
4429# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004430component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004431 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004432 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004433 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004434 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004435 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4436 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07004437 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004438 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_PUBLIC_KEY -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004439}
4440
Dave Rodgmanc164c072023-06-28 09:43:23 +01004441
Dave Rodgman904c5892023-06-28 17:36:02 +01004442support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004443 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004444}
4445
Dave Rodgman904c5892023-06-28 17:36:02 +01004446component_build_tfm_armcc() {
4447 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004448 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004449
Dave Rodgman88651c42023-06-29 12:35:51 +01004450 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004451 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 +01004452}
4453
4454component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004455 # Check that the TF-M configuration can build cleanly with various
4456 # warning flags enabled. We don't build or run tests, since the
4457 # TF-M configuration needs a TF-M platform. A tweaked version of
4458 # the configuration that works on mainstream platforms is in
4459 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004460 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004461
Dave Rodgman88651c42023-06-29 12:35:51 +01004462 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004463 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 +01004464
Dave Rodgman904c5892023-06-28 17:36:02 +01004465 msg "build: TF-M config, gcc native build"
4466 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004467 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 +01004468}
4469
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004470# Test that the given .o file builds with all (valid) combinations of the given options.
4471#
4472# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4473#
4474# The validator function is the name of a function to validate the combination of options.
4475# It may be "" if all combinations are valid.
4476# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004477# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004478build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004479 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004480 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004481 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004482 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004483 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004484
Dave Rodgman42436102023-10-03 15:47:05 +01004485 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004486 for opt in "${options[@]}"; do
4487 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004488 done
4489
4490 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004491 cd $(dirname ${file})
4492 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004493
Dave Rodgman920343a2023-10-01 18:41:09 +01004494 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004495 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 +01004496
Dave Rodgman42436102023-10-03 15:47:05 +01004497 # Extract the command generated by the Makefile to build the target file.
4498 # This ensures that we have any include paths, macro definitions, etc
4499 # that may be applied by make.
4500 # 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 +01004501 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004502
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004503 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004504 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004505
Dave Rodgman28e38d82023-10-04 11:50:30 +01004506 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004507 source_file=${file%.o}.c
4508
4509 targets=0
4510 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004511
Dave Rodgman28e38d82023-10-04 11:50:30 +01004512 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004513 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004514 # each bit of $i is used to determine if options[i] will be set or not
4515 target="t"
4516 clang_args=""
4517 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004518 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004519 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004520 clang_args="${clang_args} ${opt}"
4521 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004522 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004523 done
4524
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004525 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004526 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004527 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004528 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004529
Dave Rodgman28e38d82023-10-04 11:50:30 +01004530 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004531 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004532 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004533 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004534
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004535 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004536
Dave Rodgman920343a2023-10-01 18:41:09 +01004537 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004538 make -s -f ${makefile} build_test_config_combos
4539 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004540
4541 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004542 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004543}
4544
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004545validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004546 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4547 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004548 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004549 fi
4550 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4551 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004552 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004553 fi
4554 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004555 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004556}
4557
4558component_build_aes_variations() {
4559 # 18s - around 90ms per clang invocation on M1 Pro
4560 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004561 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004562 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004563
Yanray Wangbc29aef2023-11-06 11:08:17 +08004564 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004565 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004566
Dave Rodgman42436102023-10-03 15:47:05 +01004567 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004568 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4569 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4570 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4571 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004572
4573 cd "$MBEDTLS_ROOT_DIR"
4574 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4575
Yanray Wang42be1ba2023-11-23 14:28:47 +08004576 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004577 # manually set or unset those configurations to check
4578 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004579 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4580 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4581 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4582 scripts/config.py unset MBEDTLS_DES_C
4583 scripts/config.py unset MBEDTLS_NIST_KW_C
4584 build_test_config_combos library/aes.o validate_aes_config_variations \
4585 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4586 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4587 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4588 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004589}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004590
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004591component_test_no_platform () {
4592 # Full configuration build, without platform support, file IO and net sockets.
4593 # This should catch missing mbedtls_printf definitions, and by disabling file
4594 # IO, it should catch missing '#include <stdio.h>'
4595 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004596 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004597 scripts/config.py unset MBEDTLS_PLATFORM_C
4598 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004599 scripts/config.py unset MBEDTLS_FS_IO
4600 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004601 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004602 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004603 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004604 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004605 # to re-enable platform integration features otherwise disabled in C99 builds
4606 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004607 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004608}
Gilles Peskine7c652162017-12-11 00:01:40 +01004609
4610component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004611 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004612 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4613 scripts/config.py full
4614 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004615 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4616 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4617 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4618 make
4619}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004620
Gilles Peskine8f073122018-11-27 15:58:47 +01004621component_build_no_ssl_srv () {
4622 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004623 scripts/config.py full
4624 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004625 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004626}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004627
Gilles Peskine8f073122018-11-27 15:58:47 +01004628component_build_no_ssl_cli () {
4629 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004630 scripts/config.py full
4631 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004632 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004633}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004634
Gilles Peskine8f073122018-11-27 15:58:47 +01004635component_build_no_sockets () {
4636 # Note, C99 compliance can also be tested with the sockets support disabled,
4637 # as that requires a POSIX platform (which isn't the same as C99).
4638 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004639 scripts/config.py full
4640 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4641 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4642 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4643}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004644
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004645component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004646 msg "build: default config with memory buffer allocator and backtrace enabled"
4647 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4648 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4649 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004650 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004651 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004652 make
4653
4654 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4655 make test
4656}
4657
4658component_test_memory_buffer_allocator () {
4659 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004660 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4661 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004662 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004663 make
4664
4665 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4666 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004667
4668 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4669 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004670 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004671}
4672
Gilles Peskine8f073122018-11-27 15:58:47 +01004673component_test_no_max_fragment_length () {
4674 # Run max fragment length tests with MFL disabled
4675 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004676 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004677 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004678 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004679
Gilles Peskine8f073122018-11-27 15:58:47 +01004680 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004681 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004682}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004683
Hanno Becker545ced42019-02-19 11:10:48 +00004684component_test_asan_remove_peer_certificate () {
4685 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004686 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004687 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004688 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004689 make
4690
4691 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4692 make test
4693
4694 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004695 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004696
4697 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004698 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004699
4700 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004701 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004702}
4703
Gilles Peskine8f073122018-11-27 15:58:47 +01004704component_test_no_max_fragment_length_small_ssl_out_content_len () {
4705 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004706 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4707 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4708 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004709 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004710 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004711
Gilles Peskine8f073122018-11-27 15:58:47 +01004712 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004713 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004714
4715 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004716 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004717}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004718
Darryl Greenaad82f92019-12-02 10:53:11 +00004719component_test_variable_ssl_in_out_buffer_len () {
4720 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4721 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004722 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004723 make
4724
4725 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4726 make test
4727
4728 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004729 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004730
4731 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004732 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004733}
4734
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004735component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004736 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004737 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004738
Dave Rodgman17127e92023-12-14 16:42:48 +00004739 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004740 make
4741
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004742 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004743 make test
4744
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004745 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004746 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004747
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004748 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004749 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004750}
4751
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004752component_test_ssl_alloc_buffer_and_mfl () {
4753 msg "build: default config with memory buffer allocator and MFL extension"
4754 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4755 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4756 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4757 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4758 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004759 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004760 make
4761
4762 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4763 make test
4764
4765 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 +02004766 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004767}
4768
Gilles Peskine636c26a2020-03-04 20:46:15 +01004769component_test_when_no_ciphersuites_have_mac () {
4770 msg "build: when no ciphersuites have MAC"
4771 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004772 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004773 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004774 make
4775
Ronald Cron7b66beb2024-05-27 08:14:27 +02004776 msg "test: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine636c26a2020-03-04 20:46:15 +01004777 make test
4778
Ronald Cron7b66beb2024-05-27 08:14:27 +02004779 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_SUITES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004780 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004781}
4782
Raoul Strackxa4e86142020-06-15 17:03:13 +02004783component_test_no_date_time () {
4784 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4785 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004786 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004787 make
4788
4789 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4790 make test
4791}
4792
Gilles Peskine8f073122018-11-27 15:58:47 +01004793component_test_platform_calloc_macro () {
4794 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004795 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4796 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4797 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004798 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004799 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004800
Gilles Peskine8f073122018-11-27 15:58:47 +01004801 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4802 make test
4803}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004804
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004805component_test_malloc_0_null () {
4806 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004807 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004808 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 +02004809
4810 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4811 make test
4812
4813 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4814 # Just the calloc selftest. "make test" ran the others as part of the
4815 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004816 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004817
4818 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4819 # Run a subset of the tests. The choice is a balance between coverage
4820 # and time (including time indirectly wasted due to flaky tests).
4821 # The current choice is to skip tests whose description includes
4822 # "proxy", which is an approximation of skipping tests that use the
4823 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004824 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004825}
4826
Dave Rodgman6a08b682023-06-19 11:51:33 +01004827support_test_aesni() {
4828 # Check that gcc targets x86_64 (we can build AESNI), and check for
4829 # AESNI support on the host (we can run AESNI).
4830 #
4831 # The name of this function is possibly slightly misleading, but needs to align
4832 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004833 #
4834 # In principle 32-bit x86 can support AESNI, but our implementation does not
4835 # support 32-bit x86, so we check for x86-64.
4836 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004837 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4838 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004839 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004840}
4841
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004842component_test_aesni () { # ~ 60s
4843 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4844 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4845 #
4846 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4847 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4848 # exercise the plain C impl).
4849
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004850 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004851 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004852 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004853 scripts/config.py set MBEDTLS_HAVE_ASM
4854
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004855 # test the intrinsics implementation
4856 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004857 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004858 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004859 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004860 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004861
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004862 # test the asm implementation
4863 msg "AES tests, test assembly"
4864 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004865 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004866 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004867 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004868
4869 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004870 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004871 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004872 msg "AES tests, plain C"
4873 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004874 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004875 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004876 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004877 not grep -q "AES note: using AESNI" ./programs/test/selftest
4878 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004879
4880 # test the intrinsics implementation
4881 scripts/config.py set MBEDTLS_AESNI_C
4882 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4883 msg "AES tests, test AESNI only"
4884 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004885 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004886 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4887 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004888 grep -q "AES note: using AESNI" ./programs/test/selftest
4889 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004890}
4891
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004892component_test_sha3_variations() {
4893 msg "sha3 loop unroll variations"
4894
4895 # define minimal config sufficient to test SHA3
4896 cat > include/mbedtls/mbedtls_config.h << END
4897 #define MBEDTLS_SELF_TEST
4898 #define MBEDTLS_SHA3_C
4899END
4900
4901 msg "all loops unrolled"
4902 make clean
4903 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"
4904 ./tests/test_suite_shax
4905
4906 msg "all loops rolled up"
4907 make clean
4908 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"
4909 ./tests/test_suite_shax
4910}
4911
Jerry Yub6d39c22023-08-16 15:11:48 +08004912support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004913 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004914}
4915
4916component_test_aesni_m32 () { # ~ 60s
4917 # This tests are duplicated from component_test_aesni for i386 target
4918 #
4919 # AESNI intrinsic code supports i386 and assembly code does not support it.
4920
4921 msg "build: default config with different AES implementations"
4922 scripts/config.py set MBEDTLS_AESNI_C
4923 scripts/config.py set MBEDTLS_PADLOCK_C
4924 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4925 scripts/config.py set MBEDTLS_HAVE_ASM
4926
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004927 # test the intrinsics implementation with gcc
4928 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004929 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004930 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004931 # check that we built intrinsics - this should be used by default when supported by the compiler
4932 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4933 grep -q "AES note: using AESNI" ./programs/test/selftest
4934 grep -q "AES note: built-in implementation." ./programs/test/selftest
4935 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4936 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4937
4938 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004939 scripts/config.py unset MBEDTLS_PADLOCK_C
4940 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4941 msg "AES tests, test AESNI only"
4942 make clean
4943 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4944 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4945 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4946 grep -q "AES note: using AESNI" ./programs/test/selftest
4947 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4948 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4949 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4950}
4951
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004952support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004953 # clang >= 4 is required to build with target attributes
4954 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004955}
4956
4957component_test_aesni_m32_clang() {
4958
4959 scripts/config.py set MBEDTLS_AESNI_C
4960 scripts/config.py set MBEDTLS_PADLOCK_C
4961 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4962 scripts/config.py set MBEDTLS_HAVE_ASM
4963
4964 # test the intrinsics implementation with clang
4965 msg "AES tests, test intrinsics (clang)"
4966 make clean
4967 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4968 # check that we built intrinsics - this should be used by default when supported by the compiler
4969 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4970 grep -q "AES note: using AESNI" ./programs/test/selftest
4971 grep -q "AES note: built-in implementation." ./programs/test/selftest
4972 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4973 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4974}
4975
Jerry Yu193cbc02023-08-03 17:06:29 +08004976# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4977component_build_aes_aesce_armcc () {
4978 msg "Build: AESCE test on arm64 platform without plain C."
4979 scripts/config.py baremetal
4980
4981 # armc[56] don't support SHA-512 intrinsics
4982 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4983
4984 # Stop armclang warning about feature detection for A64_CRYPTO.
4985 # With this enabled, the library does build correctly under armclang,
4986 # but in baremetal builds (as tested here), feature detection is
4987 # unavailable, and the user is notified via a #warning. So enabling
4988 # this feature would prevent us from building with -Werror on
4989 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004990 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004991 scripts/config.py set MBEDTLS_HAVE_ASM
4992
4993 msg "AESCE, build with default configuration."
4994 scripts/config.py set MBEDTLS_AESCE_C
4995 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4996 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4997
4998 msg "AESCE, build AESCE only"
4999 scripts/config.py set MBEDTLS_AESCE_C
5000 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
5001 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
5002}
5003
Dave Rodgman0c584032023-10-08 12:26:54 +01005004support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00005005 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00005006 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01005007}
5008
5009component_build_aes_armce () {
5010 # Test variations of AES with Armv8 crypto extensions
5011 scripts/config.py set MBEDTLS_AESCE_C
5012 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
5013
5014 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01005015 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01005016
5017 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
5018 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
5019
5020 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
5021 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5022
Dave Rodgman5e419372023-10-23 15:30:20 +01005023 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01005024
Dave Rodgman5e419372023-10-23 15:30:20 +01005025 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
5026 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01005027
Dave Rodgman5e419372023-10-23 15:30:20 +01005028 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
5029 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01005030
Dave Rodgman5e419372023-10-23 15:30:20 +01005031 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
5032 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01005033
5034 # test for presence of AES instructions
5035 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
5036 msg "clang, test A32 crypto instructions built"
5037 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5038 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5039 msg "clang, test T32 crypto instructions built"
5040 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5041 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5042 msg "clang, test aarch64 crypto instructions built"
5043 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5044 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
5045
5046 # test for absence of AES instructions
5047 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
5048 scripts/config.py unset MBEDTLS_AESCE_C
5049 msg "clang, test A32 crypto instructions not built"
5050 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5051 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5052 msg "clang, test T32 crypto instructions not built"
5053 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5054 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
5055 msg "clang, test aarch64 crypto instructions not built"
5056 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5057 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01005058}
5059
Dave Rodgman9ed18532023-10-05 00:06:47 +01005060support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00005061 # clang >= 4 is required to build with SHA extensions
5062 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01005063}
5064
Dave Rodgmand9e80832023-10-04 17:17:46 +01005065component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01005066 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005067
5068
5069 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01005070 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005071 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
5072 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5073 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
5074 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
5075 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005076
Dave Rodgmand9e80832023-10-04 17:17:46 +01005077
Dave Rodgman94a634d2023-10-10 12:59:29 +01005078 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005079 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005080 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
5081 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5082 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01005083
Dave Rodgman5b89c552023-10-10 14:59:02 +01005084 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005085 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
5086 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
5087 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01005088
Dave Rodgmancd654002023-10-05 09:40:07 +01005089
Dave Rodgman94a634d2023-10-10 12:59:29 +01005090 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005091 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005092 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
5093 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
5094 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
5095 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5096 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01005097
Dave Rodgmancd654002023-10-05 09:40:07 +01005098
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005099 # examine the disassembly for presence of SHA instructions
5100 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
5101 scripts/config.py set ${opt}
5102 msg "${opt} clang, test A32 crypto instructions built"
5103 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5104 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5105
5106 msg "${opt} clang, test T32 crypto instructions built"
5107 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5108 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5109
5110 msg "${opt} clang, test aarch64 crypto instructions built"
5111 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5112 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
5113 scripts/config.py unset ${opt}
5114 done
5115
5116
5117 # examine the disassembly for absence of SHA instructions
5118 msg "clang, test A32 crypto instructions not built"
5119 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5120 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5121
5122 msg "clang, test T32 crypto instructions not built"
5123 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5124 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5125
5126 msg "clang, test aarch64 crypto instructions not built"
5127 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5128 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01005129}
5130
Jerry Yuc935aa62023-08-03 17:08:27 +08005131# For timebeing, no VIA Padlock platform available.
5132component_build_aes_via_padlock () {
5133
5134 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08005135 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08005136 scripts/config.py set MBEDTLS_PADLOCK_C
5137 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005138 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08005139 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08005140
5141}
5142
5143support_build_aes_via_padlock_only () {
5144 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
5145 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
5146 [ "`dpkg --print-foreign-architectures`" == "i386" ]
5147}
5148
Jerry Yu193cbc02023-08-03 17:06:29 +08005149support_build_aes_aesce_armcc () {
5150 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01005151}
5152
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005153component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005154 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01005155 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005156 scripts/config.py unset MBEDTLS_PADLOCK_C
5157
Dave Rodgmand8d64512023-12-19 12:20:21 +00005158 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01005159
5160 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
5161 make test
5162}
5163
5164component_test_no_ctr_drbg_aes_only_128_bit_keys () {
5165 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
5166 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005167 scripts/config.py unset MBEDTLS_CTR_DRBG_C
5168 scripts/config.py unset MBEDTLS_PADLOCK_C
5169
Hanno Becker83ebf782017-07-07 12:29:15 +01005170 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01005171
5172 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005173 make test
5174}
Gilles Peskine8f073122018-11-27 15:58:47 +01005175
Hanno Becker83ebf782017-07-07 12:29:15 +01005176component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005177 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5178 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
5179 scripts/config.py unset MBEDTLS_PADLOCK_C
5180 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02005181 scripts/config.py unset MBEDTLS_AESCE_C
5182
Dave Rodgmand8d64512023-12-19 12:20:21 +00005183 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005184
5185 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02005186 make test
5187
5188 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5189 programs/test/selftest
5190}
5191
Matthias Schulz0767fda2024-02-07 10:46:28 +01005192component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005193 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
5194 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01005195 scripts/config.py unset MBEDTLS_PADLOCK_C
5196 scripts/config.py unset MBEDTLS_AESNI_C
5197 scripts/config.py unset MBEDTLS_AESCE_C
5198
5199 make CFLAGS='-O2 -Werror -Wall -Wextra'
5200
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005201 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01005202 make test
5203}
5204
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02005205component_test_aes_fewer_tables () {
5206 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005207 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005208 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005209
Gilles Peskine7c652162017-12-11 00:01:40 +01005210 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005211 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005212}
5213
5214component_test_aes_rom_tables () {
5215 msg "build: default config with AES_ROM_TABLES enabled"
5216 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005217 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005218
5219 msg "test: AES_ROM_TABLES"
5220 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005221}
5222
Gilles Peskine14c3c062018-01-29 21:25:12 +01005223component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005224 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
5225 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
5226 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005227 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005228
Gilles Peskine8f073122018-11-27 15:58:47 +01005229 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
5230 make test
5231}
5232
Yanray Wang49cd4b52023-11-10 11:58:37 +08005233# helper for common_block_cipher_no_decrypt() which:
5234# - enable/disable the list of config options passed from -s/-u respectively.
5235# - build
5236# - test for tests_suite_xxx
5237# - selftest
5238#
5239# Usage: helper_block_cipher_no_decrypt_build_test
5240# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5241# Options: -s set_opts the list of config options to enable
5242# -u unset_opts the list of config options to disable
5243# -c cflags the list of options passed to CFLAGS
5244# -l ldflags the list of options passed to LDFLAGS
5245helper_block_cipher_no_decrypt_build_test () {
5246 while [ $# -gt 0 ]; do
5247 case "$1" in
5248 -s)
5249 shift; local set_opts="$1";;
5250 -u)
5251 shift; local unset_opts="$1";;
5252 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005253 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005254 -l)
5255 shift; local ldflags="$1";;
5256 esac
5257 shift
5258 done
5259 set_opts="${set_opts:-}"
5260 unset_opts="${unset_opts:-}"
5261 cflags="${cflags:-}"
5262 ldflags="${ldflags:-}"
5263
Yanray Wangb2d6e522023-11-13 16:57:47 +08005264 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5265 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005266
5267 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5268 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005269 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005270
5271 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5272 not grep mbedtls_aes_setkey_dec library/aes.o
5273 not grep mbedtls_aria_setkey_dec library/aria.o
5274 not grep mbedtls_camellia_setkey_dec library/camellia.o
5275 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5276 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005277 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5278 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005279
5280 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5281 make test
5282
5283 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5284 programs/test/selftest
5285}
5286
5287# This is a common configuration function used in:
5288# - component_test_block_cipher_no_decrypt_aesni_legacy()
5289# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5290# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5291# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5292# on x86.
5293common_block_cipher_no_decrypt () {
5294 # test AESNI intrinsics
5295 helper_block_cipher_no_decrypt_build_test \
5296 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005297 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005298
5299 # test AESNI assembly
5300 helper_block_cipher_no_decrypt_build_test \
5301 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005302 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005303
5304 # test AES C implementation
5305 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005306 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005307
5308 # test AESNI intrinsics for i386 target
5309 helper_block_cipher_no_decrypt_build_test \
5310 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005311 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005312 -l "-m32"
5313}
5314
Yanray Wang3ae11992023-11-13 17:32:09 +08005315# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5316# usage: 0: no PSA crypto configuration
5317# 1: use PSA crypto configuration
5318config_block_cipher_no_decrypt () {
5319 use_psa=$1
5320
Yanray Wang66111392023-10-31 18:54:54 +08005321 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005322 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5323 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005324 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005325 scripts/config.py unset MBEDTLS_NIST_KW_C
5326
Yanray Wang3ae11992023-11-13 17:32:09 +08005327 if [ "$use_psa" -eq 1 ]; then
5328 # Enable support for cryptographic mechanisms through the PSA API.
5329 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5330 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5331 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5332 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5333 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5334 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5335 fi
5336}
5337
5338component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005339 # This consistently causes an llvm crash on clang 3.8, so use gcc
5340 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005341 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005342 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005343}
5344
Yanray Wangf1496402023-11-01 18:55:13 +08005345component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005346 # This consistently causes an llvm crash on clang 3.8, so use gcc
5347 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005348 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005349 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005350}
5351
Yanray Wang66111392023-10-31 18:54:54 +08005352support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005353 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005354}
5355
Yanray Wang66111392023-10-31 18:54:54 +08005356component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005357 scripts/config.py baremetal
5358
5359 # armc[56] don't support SHA-512 intrinsics
5360 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5361
5362 # Stop armclang warning about feature detection for A64_CRYPTO.
5363 # With this enabled, the library does build correctly under armclang,
5364 # but in baremetal builds (as tested here), feature detection is
5365 # unavailable, and the user is notified via a #warning. So enabling
5366 # this feature would prevent us from building with -Werror on
5367 # armclang. Tracked in #7198.
5368 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5369 scripts/config.py set MBEDTLS_HAVE_ASM
5370
Yanray Wang3ae11992023-11-13 17:32:09 +08005371 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005372
5373 # test AESCE baremetal build
5374 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005375 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005376 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005377
Yanray Wangef1b04d2023-09-08 11:09:26 +08005378 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5379 not grep mbedtls_aes_setkey_dec library/aes.o
5380 not grep mbedtls_aria_setkey_dec library/aria.o
5381 not grep mbedtls_camellia_setkey_dec library/camellia.o
5382 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5383 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005384 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005385 not grep mbedtls_aesce_inverse_key library/aesce.o
5386 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005387}
5388
Gilles Peskine592f5912019-10-07 18:49:32 +02005389component_test_ctr_drbg_aes_256_sha_256 () {
5390 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5391 scripts/config.py full
5392 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5393 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005394 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005395 make
5396
5397 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5398 make test
5399}
5400
5401component_test_ctr_drbg_aes_128_sha_512 () {
5402 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005403 scripts/config.py full
5404 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5405 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005406 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005407 make
5408
5409 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5410 make test
5411}
5412
5413component_test_ctr_drbg_aes_128_sha_256 () {
5414 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005415 scripts/config.py full
5416 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5417 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5418 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005419 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005420 make
5421
5422 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5423 make test
5424}
5425
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005426component_test_se_default () {
5427 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005428 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005429 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005430
5431 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5432 make test
5433}
5434
Steven Cooremand57203d2020-07-16 20:28:59 +02005435component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005436 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005437 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005438 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005439 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5440 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005441 loc_cflags="${loc_cflags} -I../tests/include -O2"
5442
Gilles Peskine21570cf2023-12-22 11:49:50 +01005443 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005444
Gilles Peskine1997f302023-07-26 18:45:20 +02005445 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005446 make test
5447}
5448
Gilles Peskine8f073122018-11-27 15:58:47 +01005449component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005450 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005451 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005452 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005453 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005454}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005455
Gilles Peskinecf740502019-07-03 20:43:05 +02005456component_test_cmake_shared () {
5457 msg "build/test: cmake shared" # ~ 2min
5458 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5459 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005460 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005461 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005462 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005463}
5464
Gilles Peskineec10bf12019-09-20 19:56:06 +02005465test_build_opt () {
5466 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005467 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005468 for opt in "$@"; do
5469 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005470 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005471 # We're confident enough in compilers to not run _all_ the tests,
5472 # but at least run the unit tests. In particular, runs with
5473 # optimizations use inline assembly whereas runs with -O0
5474 # skip inline assembly.
5475 make test # ~30s
5476 make clean
5477 done
5478}
5479
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005480# For FreeBSD we invoke the function by name so this condition is added
5481# to disable the existing test_clang_opt function for linux.
5482if [[ $(uname) != "Linux" ]]; then
5483 component_test_clang_opt () {
5484 scripts/config.py full
5485 test_build_opt 'full config' clang -O0 -Os -O2
5486 }
5487fi
5488
5489component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005490 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005491 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005492}
5493support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005494 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005495}
5496
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005497component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005498 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005499 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005500}
5501support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005502 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005503}
5504
5505component_test_gcc_latest_opt () {
5506 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005507 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005508}
5509support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005510 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005511}
5512
5513component_test_gcc_earliest_opt () {
5514 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005515 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005516}
5517support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005518 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005519}
5520
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005521component_build_mbedtls_config_file () {
5522 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005523 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005524 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005525 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005526 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005527 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5528 make clean
5529
5530 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5531 # In the user config, disable one feature (for simplicity, pick a feature
5532 # that nothing else depends on).
5533 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005534 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005535 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5536
5537 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005538}
5539
Gilles Peskine7d904e72022-04-07 21:59:14 +02005540component_build_psa_config_file () {
5541 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5542 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5543 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5544 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5545 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005546 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005547 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5548 make clean
5549
5550 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Cron7d949ae2024-05-15 18:31:17 +02005551 # In the user config, disable one feature and its dependencies, which will
5552 # reflect on the mbedtls configuration so we can query it with
5553 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005554 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Cron7d949ae2024-05-15 18:31:17 +02005555 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005556 scripts/config.py unset MBEDTLS_CMAC_C
5557 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5558 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5559
5560 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005561}
5562
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005563component_build_psa_alt_headers () {
5564 msg "build: make with PSA alt headers" # ~20s
5565
5566 # Generate alternative versions of the substitutable headers with the
5567 # same content except different include guards.
5568 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5569
5570 # Build the library and some programs.
5571 # Don't build the fuzzers to avoid having to go through hoops to set
5572 # a correct include path for programs/fuzz/Makefile.
5573 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
5574 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\"'"
5575
5576 # Check that we're getting the alternative include guards and not the
5577 # original include guards.
5578 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5579 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5580 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5581 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5582}
5583
Dave Rodgman852de3c2023-12-14 14:46:45 +00005584component_test_m32_no_asm () {
5585 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005586 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005587 #
5588 # Note that we require gcc, because clang Asan builds fail to link for
5589 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005590 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005591 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005592 scripts/config.py unset MBEDTLS_HAVE_ASM
5593 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005594 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005595 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005596
Dave Rodgman852de3c2023-12-14 14:46:45 +00005597 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005598 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005599}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005600support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005601 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005602 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005603 *) false;;
5604 esac
5605}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005606
Gilles Peskineff0aee02021-10-05 09:36:03 +02005607component_test_m32_o2 () {
5608 # Build with optimization, to use the i386 specific inline assembly
5609 # and go faster for tests.
5610 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005611 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005612 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005613 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005614
Gilles Peskineff0aee02021-10-05 09:36:03 +02005615 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005616 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005617
Gilles Peskineff0aee02021-10-05 09:36:03 +02005618 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005619 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005620}
Gilles Peskinecf522222021-10-07 19:25:29 +02005621support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005622 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005623}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005624
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005625component_test_m32_everest () {
5626 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005627 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005628 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005629 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005630
5631 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5632 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005633
5634 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005635 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005636
5637 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5638 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005639 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005640}
5641support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005642 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005643}
5644
Gilles Peskine8f073122018-11-27 15:58:47 +01005645component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005646 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005647 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005648 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005649
5650 msg "test: 64-bit ILP32, make, gcc"
5651 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005652}
Gilles Peskine878cf602019-01-06 20:50:38 +00005653support_test_mx32 () {
5654 case $(uname -m) in
5655 amd64|x86_64) true;;
5656 *) false;;
5657 esac
5658}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005659
Peter Kolbus60c6da22018-12-27 06:59:04 -06005660component_test_min_mpi_window_size () {
5661 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005662 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005663 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005664 make
5665
5666 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5667 make test
5668}
5669
Gilles Peskine8f073122018-11-27 15:58:47 +01005670component_test_have_int32 () {
5671 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005672 scripts/config.py unset MBEDTLS_HAVE_ASM
5673 scripts/config.py unset MBEDTLS_AESNI_C
5674 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005675 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005676 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005677
Gilles Peskine8f073122018-11-27 15:58:47 +01005678 msg "test: gcc, force 32-bit bignum limbs"
5679 make test
5680}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005681
Gilles Peskine8f073122018-11-27 15:58:47 +01005682component_test_have_int64 () {
5683 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005684 scripts/config.py unset MBEDTLS_HAVE_ASM
5685 scripts/config.py unset MBEDTLS_AESNI_C
5686 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005687 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005688 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005689
Gilles Peskine8f073122018-11-27 15:58:47 +01005690 msg "test: gcc, force 64-bit bignum limbs"
5691 make test
5692}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005693
Gabor Mezeie256cc12023-07-26 17:28:48 +02005694component_test_have_int32_cmake_new_bignum () {
5695 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5696 scripts/config.py unset MBEDTLS_HAVE_ASM
5697 scripts/config.py unset MBEDTLS_AESNI_C
5698 scripts/config.py unset MBEDTLS_PADLOCK_C
5699 scripts/config.py unset MBEDTLS_AESCE_C
5700 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005701 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005702 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005703
5704 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5705 make test
5706}
5707
Gilles Peskine8f073122018-11-27 15:58:47 +01005708component_test_no_udbl_division () {
5709 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005710 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005711 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005712 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005713
Gilles Peskine8f073122018-11-27 15:58:47 +01005714 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5715 make test
5716}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005717
Gilles Peskine8f073122018-11-27 15:58:47 +01005718component_test_no_64bit_multiplication () {
5719 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005720 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005721 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005722 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005723
Gilles Peskine8f073122018-11-27 15:58:47 +01005724 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5725 make test
5726}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005727
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005728component_test_no_strings () {
5729 msg "build: no strings" # ~10s
5730 scripts/config.py full
5731 # Disable options that activate a large amount of string constants.
5732 scripts/config.py unset MBEDTLS_DEBUG_C
5733 scripts/config.py unset MBEDTLS_ERROR_C
5734 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5735 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005736 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005737
5738 msg "test: no strings" # ~ 10s
5739 make test
5740}
5741
Hanno Beckerc5722d12020-10-09 11:10:42 +01005742component_test_no_x509_info () {
5743 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5744 scripts/config.pl full
5745 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5746 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005747 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005748
5749 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5750 make test
5751
5752 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005753 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005754}
5755
Gilles Peskine8f073122018-11-27 15:58:47 +01005756component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005757 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005758 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005759 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 +02005760
Gilles Peskinee36fe812021-09-01 20:00:33 +02005761 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005762 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005763}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005764
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005765component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005766 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005767 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005768 # Build for a target platform that's close to what Debian uses
5769 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005770 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005771 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005772 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005773 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'
5774
Gilles Peskinee36fe812021-09-01 20:00:33 +02005775 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005776 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005777}
5778support_build_arm_linux_gnueabi_gcc_arm5vte () {
5779 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5780}
5781
5782component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005783 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005784 scripts/config.py baremetal
5785 # This is an imperfect substitute for
5786 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005787 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005788 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 +02005789
Gilles Peskinee36fe812021-09-01 20:00:33 +02005790 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005791 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005792}
5793
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005794component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005795 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5796 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005797 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 +02005798
Gilles Peskinee36fe812021-09-01 20:00:33 +02005799 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005800 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005801 for lib in library/*.a; do
5802 echo "$lib:"
5803 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5804 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005805}
5806
Gilles Peskine8f073122018-11-27 15:58:47 +01005807component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005808 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005809 scripts/config.py baremetal
5810 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005811 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 +01005812 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005813 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005814}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005815
Gilles Peskine8f073122018-11-27 15:58:47 +01005816component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005817 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005818 scripts/config.py baremetal
5819 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005820 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 +01005821 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005822 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005823}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005824
Dave Rodgman8c315f22023-06-02 10:26:24 -04005825component_build_arm_clang_thumb () {
5826 # ~ 30s
5827
5828 scripts/config.py baremetal
5829
5830 msg "build: clang thumb 2, make"
5831 make clean
5832 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5833
5834 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5835 msg "build: clang thumb 1 -O0, make"
5836 make clean
5837 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5838
5839 msg "build: clang thumb 1 -Os, make"
5840 make clean
5841 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5842}
5843
Gilles Peskine8f073122018-11-27 15:58:47 +01005844component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005845 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005846 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005847 # armc[56] don't support SHA-512 intrinsics
5848 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005849
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005850 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5851 scripts/config.py unset MBEDTLS_AESCE_C
5852
Dave Rodgman0fddf822023-03-02 15:32:12 +00005853 # Stop armclang warning about feature detection for A64_CRYPTO.
5854 # With this enabled, the library does build correctly under armclang,
5855 # but in baremetal builds (as tested here), feature detection is
5856 # unavailable, and the user is notified via a #warning. So enabling
5857 # this feature would prevent us from building with -Werror on
5858 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005859 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005860
Hanno Beckerf0762e92022-07-15 12:08:19 +01005861 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005862
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005863 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005864
5865 msg "size: ARM Compiler 5"
5866 "$ARMC5_FROMELF" -z library/*.o
5867
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005868 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005869
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005870 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005871 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005872
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005873 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005874 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5875
5876 # ARM Compiler 6 - Target ARMv7-M+DSP
5877 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005878
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005879 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005880 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005881
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005882 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005883 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005884
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005885 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5886 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5887
Dave Rodgman99318e62023-05-24 12:27:42 +01005888 # ARM Compiler 6 - Target Cortex-M0
5889 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005890
5891 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5892 #
5893 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5894 # that we have in our CI
5895 scripts/config.py set MBEDTLS_AESCE_C
5896 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005897}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005898
Pengyu Lvdf070032023-02-24 16:03:31 +08005899support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005900 armc5_cc="$ARMC5_BIN_DIR/armcc"
5901 armc6_cc="$ARMC6_BIN_DIR/armclang"
5902 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005903}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005904
Ronald Crond2cb7f42024-03-18 12:49:18 +01005905component_test_tls12_only () {
5906 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5907 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5908 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5909 make
5910
5911 msg "test: main suites (inc. selftests) (ASan build)"
5912 make test
5913
5914 msg "test: ssl-opt.sh (ASan build)"
5915 tests/ssl-opt.sh
5916
5917 msg "test: compat.sh (ASan build)"
5918 tests/compat.sh
5919}
5920
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005921component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005922 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005923 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005924 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005925 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5926
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005927 msg "test: TLS 1.3 only, all key exchange modes enabled"
5928 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005929
Ronald Cronc3f43b62022-10-17 17:35:32 +02005930 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5931 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005932}
5933
Ronald Cronc3f43b62022-10-17 17:35:32 +02005934component_test_tls13_only_psk () {
5935 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5936 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5937 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5938 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005939 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005940 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5941 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5942 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5943 scripts/config.py unset MBEDTLS_ECDSA_C
5944 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005945 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005946 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005947 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5948
Ronald Cronc3f43b62022-10-17 17:35:32 +02005949 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5950 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005951
Ronald Cronc3f43b62022-10-17 17:35:32 +02005952 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5953 tests/ssl-opt.sh
5954}
5955
5956component_test_tls13_only_ephemeral () {
5957 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5958 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5959 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005960 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005961 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5962
5963 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5964 cd tests; ./test_suite_ssl; cd ..
5965
5966 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5967 tests/ssl-opt.sh
5968}
5969
Przemek Stekiela01c2422023-06-13 10:46:48 +02005970component_test_tls13_only_ephemeral_ffdh () {
5971 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5972 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5973 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5974 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005975 scripts/config.py unset MBEDTLS_ECDH_C
5976
Przemek Stekiela01c2422023-06-13 10:46:48 +02005977 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5978
5979 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5980 cd tests; ./test_suite_ssl; cd ..
5981
5982 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5983 tests/ssl-opt.sh
5984}
5985
Ronald Cronc3f43b62022-10-17 17:35:32 +02005986component_test_tls13_only_psk_ephemeral () {
5987 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5988 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5989 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5990 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5991 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5992 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5993 scripts/config.py unset MBEDTLS_ECDSA_C
5994 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005995 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005996 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005997 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5998
5999 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
6000 cd tests; ./test_suite_ssl; cd ..
6001
6002 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
6003 tests/ssl-opt.sh
6004}
6005
Przemek Stekiela01c2422023-06-13 10:46:48 +02006006component_test_tls13_only_psk_ephemeral_ffdh () {
6007 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
6008 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
6009 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
6010 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
6011 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
6012 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
6013 scripts/config.py unset MBEDTLS_ECDSA_C
6014 scripts/config.py unset MBEDTLS_PKCS1_V21
6015 scripts/config.py unset MBEDTLS_PKCS7_C
6016 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02006017 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02006018 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6019
6020 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
6021 cd tests; ./test_suite_ssl; cd ..
6022
6023 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
6024 tests/ssl-opt.sh
6025}
6026
Ronald Cronc3f43b62022-10-17 17:35:32 +02006027component_test_tls13_only_psk_all () {
6028 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
6029 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
6030 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
6031 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
6032 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
6033 scripts/config.py unset MBEDTLS_ECDSA_C
6034 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00006035 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01006036 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006037 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6038
6039 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6040 cd tests; ./test_suite_ssl; cd ..
6041
6042 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
6043 tests/ssl-opt.sh
6044}
6045
6046component_test_tls13_only_ephemeral_all () {
6047 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
6048 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01006049 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02006050 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
6051
6052 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6053 cd tests; ./test_suite_ssl; cd ..
6054
6055 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
6056 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02006057}
6058
Ronald Cron46ac0652024-03-18 12:39:04 +01006059component_test_tls13_no_padding () {
6060 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006061 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01006062 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006063 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006064 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006065 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006066 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01006067 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006068 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006069}
6070
Ronald Cron6f135e12021-12-08 16:57:54 +01006071component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01006072 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01006073 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01006074 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00006075 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01006076 make
Ronald Cron46ac0652024-03-18 12:39:04 +01006077 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006078 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01006079 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01006080 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01006081}
6082
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006083component_test_full_minus_session_tickets() {
6084 msg "build: full config without session tickets"
6085 scripts/config.py full
Norbert Fabritius06d99342023-04-11 15:40:05 +02006086 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006087 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritius06d99342023-04-11 15:40:05 +02006088 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
6089 make
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006090 msg "test: full config without session tickets"
Norbert Fabritius06d99342023-04-11 15:40:05 +02006091 make test
Ronald Cron6a8e4eb2024-04-02 12:34:24 +02006092 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritius06d99342023-04-11 15:40:05 +02006093 tests/ssl-opt.sh
6094}
6095
Gilles Peskine8f073122018-11-27 15:58:47 +01006096component_build_mingw () {
6097 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006098 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 +00006099
Gilles Peskine8f073122018-11-27 15:58:47 +01006100 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006101 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 +01006102 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02006103
Gilles Peskine8f073122018-11-27 15:58:47 +01006104 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08006105 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
6106 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 +01006107 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006108
Pengyu Lv158eead2023-10-19 11:27:05 +08006109 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08006110 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08006111 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 +01006112 make WINDOWS_BUILD=1 clean
6113}
Jaeden Amero117b8a42019-04-17 15:19:26 +01006114support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08006115 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
6116 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01006117 *) true;;
6118 esac
6119}
Simon Butcher91aef332016-11-17 09:20:50 +00006120
Gilles Peskine8f073122018-11-27 15:58:47 +01006121component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006122 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02006123 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006124 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
6125 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02006126
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006127 msg "test: main suites (MSan)" # ~ 10s
6128 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006129
Gilles Peskine6848d172023-11-02 19:58:03 +01006130 msg "test: metatests (MSan)"
6131 tests/scripts/run-metatests.sh any msan
6132
Gilles Peskine82b27272019-06-14 18:27:03 +02006133 msg "program demos (MSan)" # ~20s
6134 tests/scripts/run_demos.py
6135
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006136 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006137 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006138
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006139 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006140
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006141 if [ "$MEMORY" -gt 0 ]; then
6142 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006143 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006144 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006145}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006146
Bence Szépkúti0354d042023-12-06 16:14:37 +01006147component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006148 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006149 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006150 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6151 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006152
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006153 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006154 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006155
Gilles Peskine636c26a2020-03-04 20:46:15 +01006156 # Optional parts (slow; currently broken on OS X because programs don't
6157 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006158 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006159 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006160 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006161 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006162 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006163
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006164 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006165 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006166 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006167 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006168
6169 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006170 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006171 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006172 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006173}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006174
Bence Szépkúti0354d042023-12-06 16:14:37 +01006175component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006176 msg "build: Release, full (clang)"
6177 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
6178 scripts/config.py full
6179 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6180 make
6181
6182 msg "test: main suites, Valgrind (full config)"
6183 make memcheck
6184}
6185
Paul Elliott62dc3922021-11-25 17:29:40 +00006186support_test_cmake_out_of_source () {
6187 distrib_id=""
6188 distrib_ver=""
6189 distrib_ver_minor=""
6190 distrib_ver_major=""
6191
6192 # Attempt to parse lsb-release to find out distribution and version. If not
6193 # found this should fail safe (test is supported).
6194 if [[ -f /etc/lsb-release ]]; then
6195
6196 while read -r lsb_line; do
6197 case "$lsb_line" in
6198 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
6199 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
6200 esac
6201 done < /etc/lsb-release
6202
6203 distrib_ver_major="${distrib_ver%%.*}"
6204 distrib_ver="${distrib_ver#*.}"
6205 distrib_ver_minor="${distrib_ver%%.*}"
6206 fi
6207
6208 # Running the out of source CMake test on Ubuntu 16.04 using more than one
6209 # processor (as the CI does) can create a race condition whereby the build
6210 # fails to see a generated file, despite that file actually having been
6211 # generated. This problem appears to go away with 18.04 or newer, so make
6212 # the out of source tests unsupported on Ubuntu 16.04.
6213 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
6214}
6215
Gilles Peskine8f073122018-11-27 15:58:47 +01006216component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01006217 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01006218 # generates
6219 make neat
6220
Gilles Peskine8f073122018-11-27 15:58:47 +01006221 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01006222 MBEDTLS_ROOT_DIR="$PWD"
6223 mkdir "$OUT_OF_SOURCE_DIR"
6224 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01006225 # Note: Explicitly generate files as these are turned off in releases
6226 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006227 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006228
Gilles Peskine8f073122018-11-27 15:58:47 +01006229 msg "test: cmake 'out-of-source' build"
6230 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006231 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01006232 # Also ensure that there are no error messages such as
6233 # "No such file or directory", which would indicate that some required
6234 # file is missing (ssl-opt.sh tolerates the absence of some files so
6235 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006236 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006237 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006238 cat ssl-opt.err >&2
6239 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006240 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006241 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006242 cd "$MBEDTLS_ROOT_DIR"
6243 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006244}
Andres AGdc192212016-08-31 17:33:13 +01006245
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006246component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006247 # Remove existing generated files so that we use the ones CMake
6248 # generates
6249 make neat
6250
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006251 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006252 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006253 # Note: Explicitly generate files as these are turned off in releases
6254 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006255 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006256 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006257}
Gilles Peskinea3000992022-02-04 00:21:12 +01006258support_test_cmake_as_subdirectory () {
6259 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006260}
6261
Chris Kayd259e342021-03-25 16:03:25 +00006262component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006263 # Remove existing generated files so that we use the ones CMake
6264 # generates
6265 make neat
6266
Chris Kayd259e342021-03-25 16:03:25 +00006267 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006268 cd programs/test/cmake_package
6269 cmake .
6270 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006271 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006272}
Gilles Peskinea3000992022-02-04 00:21:12 +01006273support_test_cmake_as_package () {
6274 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006275}
6276
6277component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006278 # Remove existing generated files so that we use the ones CMake
6279 # generates
6280 make neat
6281
Chris Kayd259e342021-03-25 16:03:25 +00006282 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006283 cd programs/test/cmake_package_install
6284 cmake .
6285 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006286 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006287}
Gilles Peskinea3000992022-02-04 00:21:12 +01006288support_test_cmake_as_package_install () {
6289 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006290}
6291
David Horstmann20550e32023-01-12 14:17:01 +00006292component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006293 # Make a copy of config file to use for the in-tree test
6294 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006295
6296 MBEDTLS_ROOT_DIR="$PWD"
6297 mkdir "$OUT_OF_SOURCE_DIR"
6298 cd "$OUT_OF_SOURCE_DIR"
6299
David Horstmann969c1452023-01-31 10:34:44 +00006300 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006301 cmake "$MBEDTLS_ROOT_DIR"
6302 make
6303
6304 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6305 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006306 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006307 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6308 make
6309
6310 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6311 # In the user config, disable one feature (for simplicity, pick a feature
6312 # that nothing else depends on).
6313 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6314
6315 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6316 make
6317 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6318
6319 rm -f user_config.h full_config.h
6320
6321 cd "$MBEDTLS_ROOT_DIR"
6322 rm -rf "$OUT_OF_SOURCE_DIR"
6323
6324 # Now repeat the test for an in-tree build:
6325
David Horstmann969c1452023-01-31 10:34:44 +00006326 # Restore config for the in-tree test
6327 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006328
David Horstmann969c1452023-01-31 10:34:44 +00006329 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006330 cmake .
6331 make
6332
6333 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6334 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006335 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006336 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6337 make
6338
6339 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6340 # In the user config, disable one feature (for simplicity, pick a feature
6341 # that nothing else depends on).
6342 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6343
6344 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6345 make
6346 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6347
6348 rm -f user_config.h full_config.h
6349}
6350support_build_cmake_custom_config_file () {
6351 support_test_cmake_out_of_source
6352}
6353
David Horstmann90dddc62024-05-10 14:37:48 +01006354component_build_cmake_programs_no_testing () {
David Horstmanndf097d32024-05-10 15:37:57 +01006355 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann90dddc62024-05-10 14:37:48 +01006356 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
6357 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
6358 make
6359}
6360support_build_cmake_programs_no_testing () {
6361 support_test_cmake_out_of_source
6362}
David Horstmann20550e32023-01-12 14:17:01 +00006363
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006364component_build_zeroize_checks () {
6365 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6366
6367 scripts/config.py full
6368
6369 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006370 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 +01006371}
6372
6373
Gilles Peskine8f073122018-11-27 15:58:47 +01006374component_test_zeroize () {
6375 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6376 # different combinations of compilers and optimization flags by using an
6377 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6378 # system in all cases that the script fails, so we must manually search the
6379 # output to check whether the pass string is present and no failure strings
6380 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006381
Gilles Peskine4976e822019-01-06 19:52:22 +00006382 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6383 # about a spurious message if Gdb tries and fails, so suppress that.
6384 gdb_disable_aslr=
6385 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6386 gdb_disable_aslr='set disable-randomization off'
6387 fi
6388
Gilles Peskine8f073122018-11-27 15:58:47 +01006389 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006390 for compiler in clang gcc; do
6391 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6392 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006393 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6394 grep "The buffer was correctly zeroized" test_zeroize.log
6395 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006396 rm -f test_zeroize.log
6397 make clean
6398 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006399 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006400}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006401
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006402component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006403 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006404 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006405 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006406
6407 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006408 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006409}
6410
6411support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006412 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006413 ver="$(cmake --version)"
6414 ver="${ver#cmake version }"
6415 ver_major="${ver%%.*}"
6416
6417 ver="${ver#*.}"
6418 ver_minor="${ver%%.*}"
6419
6420 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006421}
6422
Gilles Peskinec848d222022-12-09 12:23:35 +01006423component_check_code_style () {
6424 msg "Check C code style"
6425 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006426}
6427
Gilles Peskinec848d222022-12-09 12:23:35 +01006428support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006429 case $(uncrustify --version) in
6430 *0.75.1*) true;;
6431 *) false;;
6432 esac
6433}
6434
Gilles Peskine8f073122018-11-27 15:58:47 +01006435component_check_python_files () {
6436 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006437 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006438}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006439
Joe Subbianid614c0b2021-07-29 11:18:29 +01006440component_check_test_helpers () {
6441 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006442 # unittest writes out mundane stuff like number or tests run on stderr.
6443 # Our convention is to reserve stderr for actual errors, and write
6444 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannea091522024-05-29 17:57:08 +01006445 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006446
Joe Subbiania25ffab2021-08-06 09:41:27 +01006447 msg "unit test: translate_ciphers.py"
6448 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006449}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006450
Jerry Yud767cc42023-03-31 15:03:55 +08006451
Gilles Peskine192c72f2017-12-21 15:59:21 +01006452################################################################
6453#### Termination
6454################################################################
6455
Gilles Peskine8f073122018-11-27 15:58:47 +01006456post_report () {
6457 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006458 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006459
Gilles Peskine8f073122018-11-27 15:58:47 +01006460 final_report
6461}
6462
6463
6464
6465################################################################
6466#### Run all the things
6467################################################################
6468
Gilles Peskine5d996822020-03-28 21:09:21 +01006469# Function invoked by --error-test to test error reporting.
6470pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006471 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006472 if [ $KEEP_GOING -ne 0 ]; then
6473 echo "Expect three failing commands."
6474 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006475 # If the component doesn't run in a subshell, changing error_test_i to an
6476 # invalid integer will cause an error in the loop that runs this function.
6477 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006478 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006479 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006480 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006481 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006482 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006483 make unknown_target
6484 false "this should not be executed"
6485}
6486
Gilles Peskinee48351a2018-11-27 16:06:30 +01006487# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006488run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006489 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006490 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006491
6492 # Unconditionally create a seedfile that's sufficiently long.
6493 # Do this before each component, because a previous component may
6494 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006495 local dd_cmd
6496 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6497 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006498 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006499 esac
6500 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006501
Gilles Peskineec135542021-08-02 23:14:03 +02006502 # Run the component in a subshell, with error trapping and output
6503 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006504 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006505 # We want to keep running if the subshell fails, so 'set -e' must
6506 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006507 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006508 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006509 (
6510 if [ $QUIET -eq 1 ]; then
6511 # msg() will be silenced, so just print the component name here.
6512 echo "${current_component#component_}"
6513 exec >/dev/null
6514 fi
6515 if [ $KEEP_GOING -eq 1 ]; then
6516 # Keep "set -e" off, and run an ERR trap instead to record failures.
6517 set -E
6518 trap err_trap ERR
6519 fi
6520 # The next line is what runs the component
6521 "$@"
6522 if [ $KEEP_GOING -eq 1 ]; then
6523 trap - ERR
6524 exit $last_failure_status
6525 fi
6526 )
6527 component_status=$?
6528 if [ $KEEP_GOING -eq 1 ]; then
6529 set -e
6530 if [ $component_status -ne 0 ]; then
6531 failure_count=$((failure_count + 1))
6532 fi
6533 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006534
6535 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006536 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006537 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006538}
6539
6540# Preliminary setup
6541pre_check_environment
6542pre_initialize_variables
6543pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006544
Dave Rodgman21900632024-02-26 11:41:19 +00006545setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006546pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006547pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006548pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006549
Gilles Peskine878cf602019-01-06 20:50:38 +00006550build_status=0
6551if [ $KEEP_GOING -eq 1 ]; then
6552 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006553fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006554pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006555pre_print_configuration
6556pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006557cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006558if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006559 pre_generate_files
6560fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006561
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006562# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006563for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006564 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006565done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006566unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006567for component in $RUN_COMPONENTS; do
6568 run_component "component_$component"
6569done
Gilles Peskine8f073122018-11-27 15:58:47 +01006570
6571# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006572post_report