blob: 33a2c9f491043bd53e5c201f7a451564e21ea5eb [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
Bence Szépkútic7da1fe2020-05-26 01:54:15 +02006# SPDX-License-Identifier: Apache-2.0
7#
8# Licensed under the Apache License, Version 2.0 (the "License"); you may
9# not use this file except in compliance with the License.
10# You may obtain a copy of the License at
11#
12# http://www.apache.org/licenses/LICENSE-2.0
13#
14# Unless required by applicable law or agreed to in writing, software
15# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17# See the License for the specific language governing permissions and
18# limitations under the License.
Gilles Peskine192c72f2017-12-21 15:59:21 +010019
20
21
22################################################################
23#### Documentation
24################################################################
25
Simon Butcher3ea7f522016-03-07 23:22:10 +000026# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010027# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000028#
SimonB2e23c822016-04-16 21:54:39 +010029# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# Notes for users
32# ---------------
33#
SimonB2e23c822016-04-16 21:54:39 +010034# Warning: the test is destructive. It includes various build modes and
35# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010036# configuration. The following files must be committed into git:
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020037# * include/mbedtls/mbedtls_config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010038# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
39# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010040# After running this script, the CMake cache will be lost and CMake
41# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010042#
Gilles Peskine192c72f2017-12-21 15:59:21 +010043# The script assumes the presence of a number of tools:
44# * Basic Unix tools (Windows users note: a Unix-style find must be before
45# the Windows find in the PATH)
46# * Perl
47# * GNU Make
48# * CMake
49# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040050# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010051# * arm-gcc and mingw-gcc
52# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine192c72f2017-12-21 15:59:21 +010053# * OpenSSL and GnuTLS command line tools, recent enough for the
Mateusz Starzykf5c53512021-04-15 13:28:52 +020054# interoperability tests. If they don't support old features which we want
55# to test, then a legacy version of these tools must be present as well
56# (search for LEGACY below).
Gilles Peskine192c72f2017-12-21 15:59:21 +010057# See the invocation of check_tools below for details.
58#
59# This script must be invoked from the toplevel directory of a git
60# working copy of Mbed TLS.
61#
Gilles Peskinece266c42020-03-28 18:50:43 +010062# The behavior on an error depends on whether --keep-going (alias -k)
63# is in effect.
64# * Without --keep-going: the script stops on the first error without
65# cleaning up. This lets you work in the configuration of the failing
66# component.
67# * With --keep-going: the script runs all requested components and
68# reports failures at the end. In particular the script always cleans
69# up on exit.
70#
Gilles Peskine192c72f2017-12-21 15:59:21 +010071# Note that the output is not saved. You may want to run
72# script -c tests/scripts/all.sh
73# or
74# tests/scripts/all.sh >all.log 2>&1
75#
76# Notes for maintainers
77# ---------------------
78#
Gilles Peskine8f073122018-11-27 15:58:47 +010079# The bulk of the code is organized into functions that follow one of the
80# following naming conventions:
81# * pre_XXX: things to do before running the tests, in order.
82# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010083# * component_check_XXX: quick tests that aren't worth parallelizing.
84# * component_build_XXX: build things but don't run them.
85# * component_test_XXX: build and test.
Gilles Peskine878cf602019-01-06 20:50:38 +000086# * support_XXX: if support_XXX exists and returns false then
87# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010088# * post_XXX: things to do after running the tests.
89# * other: miscellaneous support functions.
90#
Gilles Peskinec70637a2019-01-09 22:29:17 +010091# Each component must start by invoking `msg` with a short informative message.
92#
Gilles Peskinea681c592020-03-28 21:27:40 +010093# Warning: due to the way bash detects errors, the failure of a command
94# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
95#
Gilles Peskinece266c42020-03-28 18:50:43 +010096# Each component is executed in a separate shell process. The component
97# fails if any command in it returns a non-zero status.
98#
Gilles Peskinec70637a2019-01-09 22:29:17 +010099# The framework performs some cleanup tasks after each component. This
100# means that components can assume that the working directory is in a
101# cleaned-up state, and don't need to perform the cleanup themselves.
102# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +0100103# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +0100104# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +0100105# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
106# `tests/Makefile` and `programs/fuzz/Makefile` from git.
107# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100108#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100109# The tests are roughly in order from fastest to slowest. This doesn't
110# have to be exact, but in general you should add slower tests towards
111# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100112
113
114
115################################################################
116#### Initialization and command line parsing
117################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100118
Gilles Peskine36647802020-03-28 18:50:49 +0100119# Abort on errors (even on the left-hand side of a pipe).
120# Treat uninitialised variables as errors.
121set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100122
Gilles Peskine076f7252022-08-30 21:02:44 +0200123# Enable ksh/bash extended file matching patterns
124shopt -s extglob
125
David Horstmann76a77382023-08-17 17:32:26 +0100126in_mbedtls_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100127 test -d include -a -d library -a -d programs -a -d tests
128}
129
130in_psa_crypto_repo () {
131 test -d include -a -d core -a -d drivers -a -d programs -a -d tests
David Horstmann9a6c45b2023-07-14 12:30:00 +0100132}
133
Gilles Peskine8f073122018-11-27 15:58:47 +0100134pre_check_environment () {
David Horstmann58cf7c62023-08-29 10:15:05 +0100135 if in_mbedtls_repo || in_psa_crypto_repo; then :; else
David Horstmannc69074d2023-08-29 13:46:11 +0100136 echo "Must be run from Mbed TLS / psa-crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100137 exit 1
138 fi
139}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100140
Gilles Peskine8f073122018-11-27 15:58:47 +0100141pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100142 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100143 CONFIG_H='include/mbedtls/mbedtls_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100144 else
145 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100146 fi
John Durkopbd069d32020-10-31 22:14:03 -0700147 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100148 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200149
150 # Files that are clobbered by some jobs will be backed up. Use a different
151 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
152 # independently decide when to remove the backup file.
153 backup_suffix='.all.bak'
154 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100155 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100156 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100157 # Files clobbered by in-tree cmake
158 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
159 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200160
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200161 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100162 MEMORY=0
163 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200164 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100165 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100166
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200167 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200168 #
169 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
170 # both values are kept in sync. If you change the value here because it
171 # breaks some tests, you'll definitely want to change it in
172 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200173 RELEASE_SEED=1
174
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200175 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200176 : ${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 +0200177 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200178 export MBEDTLS_TEST_PLATFORM
179
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000180 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100181 : ${OPENSSL:="openssl"}
182 : ${OPENSSL_LEGACY:="$OPENSSL"}
183 : ${OPENSSL_NEXT:="$OPENSSL"}
184 : ${GNUTLS_CLI:="gnutls-cli"}
185 : ${GNUTLS_SERV:="gnutls-serv"}
186 : ${GNUTLS_LEGACY_CLI:="$GNUTLS_CLI"}
187 : ${GNUTLS_LEGACY_SERV:="$GNUTLS_SERV"}
188 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
189 : ${ARMC5_BIN_DIR:=/usr/bin}
190 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200191 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200192 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100193 : ${CLANG_LATEST:="clang-latest"}
194 : ${CLANG_EARLIEST:="clang-earliest"}
195 : ${GCC_LATEST:="gcc-latest"}
196 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100197 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000198 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200199 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100200 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000201
Gilles Peskine396853a2021-09-20 18:57:55 +0200202 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000203 export CTEST_OUTPUT_ON_FAILURE=1
204
Gilles Peskine8fd59422019-10-21 17:11:33 +0200205 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100206 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200207 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Gilles Peskine8fd59422019-10-21 17:11:33 +0200208
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400209 # Platform tests have an allocation that returns null
210 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400211 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400212
Gilles Peskine878cf602019-01-06 20:50:38 +0000213 # Gather the list of available components. These are the functions
214 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100215 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000216
217 # Exclude components that are not supported on this platform.
218 SUPPORTED_COMPONENTS=
219 for component in $ALL_COMPONENTS; do
220 case $(type "support_$component" 2>&1) in
221 *' function'*)
222 if ! support_$component; then continue; fi;;
223 esac
224 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
225 done
Gilles Peskine8f073122018-11-27 15:58:47 +0100226}
Andres AG38495a32016-07-12 16:54:33 +0100227
Gilles Peskinea28db922019-01-10 00:05:18 +0100228# Test whether the component $1 is included in the command line patterns.
229is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100230{
Gilles Peskine03af6782021-08-06 11:35:17 +0200231 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
232 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100233 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000234 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100235 set +f
236 case ${1#component_} in $pattern) return 0;; esac
237 done
238 set +f
239 return 1
240}
Andres AG7770ea82016-10-10 15:46:20 +0100241
Simon Butcher41eeccf2016-09-07 00:07:09 +0100242usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100243{
Gilles Peskine709346a2017-12-10 23:43:39 +0100244 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100245Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100246Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100247By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100248COMPONENT can be the name of a component or a shell wildcard pattern.
249
250Examples:
251 $0 "check_*"
252 Run all sanity checks.
253 $0 --no-armcc --except test_memsan
254 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100255
256Special options:
257 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000258 --list-all-components List all available test components and exit.
259 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100260
261General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200262 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100263 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100264 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100265 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200266 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200267 --arm-none-eabi-gcc-prefix=<string>
268 Prefix for a cross-compiler for arm-none-eabi
269 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200270 --arm-linux-gnueabi-gcc-prefix=<string>
271 Prefix for a cross-compiler for arm-linux-gnueabi
272 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100273 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200274 --restore First clean up the build tree, restoring backed up
275 files. Do not run any components unless they are
276 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100277 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200278 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100279 --except Exclude the COMPONENTs listed on the command line,
280 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200281 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100282 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100283 --no-force Refuse to overwrite modified files (default).
284 --no-keep-going Stop at the first error (default).
285 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800286 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100287 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200288 --outcome-file=<path> File where test outcomes are written (not done if
289 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100290 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200291 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100292 -s|--seed Integer seed value to use for this test run.
293
294Tool path options:
295 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
296 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100297 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
298 --clang-latest=<Clang_latest_path> Latest version of clang available
299 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
300 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100301 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
302 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
303 --gnutls-legacy-cli=<GnuTLS_cli_path> GnuTLS client executable to use for legacy tests.
304 --gnutls-legacy-serv=<GnuTLS_serv_path> GnuTLS server executable to use for legacy tests.
305 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100306 --openssl-legacy=<OpenSSL_path> OpenSSL executable to use for legacy tests..
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100307 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100308EOF
SimonB2e23c822016-04-16 21:54:39 +0100309}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100310
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200311# Cleanup before/after running a component.
312# Remove built files as well as the cmake cache/config.
313# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100314cleanup()
315{
David Horstmann76a77382023-08-17 17:32:26 +0100316 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100317 command make clean
318 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200319
Gilles Peskine31b07e22018-03-21 12:15:06 +0100320 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000321 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100322 -iname CMakeFiles -exec rm -rf {} \+ -o \
323 \( -iname cmake_install.cmake -o \
324 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200325 -iname CMakeCache.txt -o \
326 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100327 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200328 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200329
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100330 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
331 rm -rf programs/test/cmake_subproject/build
332 rm -f programs/test/cmake_subproject/Makefile
333 rm -f programs/test/cmake_subproject/cmake_subproject
334
Chris Kayd259e342021-03-25 16:03:25 +0000335 # Remove any artifacts from the component_test_cmake_as_package test.
336 rm -rf programs/test/cmake_package/build
337 rm -f programs/test/cmake_package/Makefile
338 rm -f programs/test/cmake_package/cmake_package
339
340 # Remove any artifacts from the component_test_cmake_as_installed_package test.
341 rm -rf programs/test/cmake_package_install/build
342 rm -f programs/test/cmake_package_install/Makefile
343 rm -f programs/test/cmake_package_install/cmake_package_install
344
Gilles Peskinef83eb822020-03-30 20:11:39 +0200345 # Restore files that may have been clobbered by the job
346 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200347 if [[ -e "$x$backup_suffix" ]]; then
348 cp -p "$x$backup_suffix" "$x"
349 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200350 done
351}
John Durkopbd069d32020-10-31 22:14:03 -0700352
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200353# Final cleanup when this script exits (except when exiting on a failure
354# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200355final_cleanup () {
356 cleanup
357
358 for x in $files_to_back_up; do
359 rm -f "$x$backup_suffix"
360 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100361}
362
Gilles Peskine7c652162017-12-11 00:01:40 +0100363# Executed on exit. May be redefined depending on command line options.
364final_report () {
365 :
366}
367
368fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200369 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100370 final_report $1
371 trap - $1
372 kill -$1 $$
373}
374
375trap 'fatal_signal HUP' HUP
376trap 'fatal_signal INT' INT
377trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200378
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200379# Number of processors on this machine. Used as the default setting
380# for parallel make.
381all_sh_nproc ()
382{
383 {
384 nproc || # Linux
385 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
386 sysctl -n hw.ncpu || # FreeBSD
387 echo 1
388 } 2>/dev/null
389}
390
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100391msg()
392{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100393 if [ -n "${current_component:-}" ]; then
394 current_section="${current_component#component_}: $1"
395 else
396 current_section="$1"
397 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200398
399 if [ $QUIET -eq 1 ]; then
400 return
401 fi
402
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100403 echo ""
404 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100405 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000406 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100407 echo "******************************************************************"
408}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100409
Gilles Peskine8f073122018-11-27 15:58:47 +0100410armc6_build_test()
411{
412 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100413
Gilles Peskine18487f62020-04-30 23:11:54 +0200414 msg "build: ARM Compiler 6 ($FLAGS)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100415 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000416 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200417
418 msg "size: ARM Compiler 6 ($FLAGS)"
419 "$ARMC6_FROMELF" -z library/*.o
420
Gilles Peskine8f073122018-11-27 15:58:47 +0100421 make clean
422}
Andres AGa5cd9732016-10-17 15:23:10 +0100423
Andres AGd9eba4b2016-08-26 14:42:14 +0100424err_msg()
425{
426 echo "$1" >&2
427}
428
429check_tools()
430{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200431 for tool in "$@"; do
432 if ! `type "$tool" >/dev/null 2>&1`; then
433 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100434 exit 1
435 fi
436 done
437}
438
Tom Cosgrove730addc2023-06-09 14:20:18 +0100439pre_parse_command_line_for_dirs () {
440 # Make an early pass through the options given, so we can set directories
441 # for Arm compilers, before SUPPORTED_COMPONENTS is determined.
442 while [ $# -gt 0 ]; do
443 case "$1" in
444 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
445 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
446 esac
447 shift
448 done
449}
450
Gilles Peskine8f073122018-11-27 15:58:47 +0100451pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000452 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100453 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100454 error_test=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200455 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000456 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100457
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000458 # Note that legacy options are ignored instead of being omitted from this
459 # list of options, so invocations that worked with previous version of
460 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100461 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100462 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200463 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200464 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200465 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000466 --armcc) no_armcc=;;
Tom Cosgrove730addc2023-06-09 14:20:18 +0100467 --armc5-bin-dir) shift; ;; # assignment to ARMC5_BIN_DIR done in pre_parse_command_line_for_dirs
468 --armc6-bin-dir) shift; ;; # assignment to ARMC6_BIN_DIR done in pre_parse_command_line_for_dirs
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100469 --clang-earliest) shift; CLANG_EARLIEST="$1";;
470 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100471 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000472 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100473 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100474 --gcc-earliest) shift; GCC_EARLIEST="$1";;
475 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100476 --gnutls-cli) shift; GNUTLS_CLI="$1";;
477 --gnutls-legacy-cli) shift; GNUTLS_LEGACY_CLI="$1";;
478 --gnutls-legacy-serv) shift; GNUTLS_LEGACY_SERV="$1";;
479 --gnutls-serv) shift; GNUTLS_SERV="$1";;
480 --help|-h) usage; exit;;
481 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000482 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
483 --list-components) printf '%s\n' $SUPPORTED_COMPONENTS; exit;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100484 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200485 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000486 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100487 --no-force) FORCE=0;;
488 --no-keep-going) KEEP_GOING=0;;
489 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200490 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100491 --openssl) shift; OPENSSL="$1";;
492 --openssl-legacy) shift; OPENSSL_LEGACY="$1";;
493 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200494 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100495 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200496 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100497 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200498 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200499 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100500 --seed|-s) shift; SEED="$1";;
501 -*)
502 echo >&2 "Unknown option: $1"
503 echo >&2 "Run $0 --help for usage."
504 exit 120
505 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000506 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100507 esac
508 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100509 done
SimonB2e23c822016-04-16 21:54:39 +0100510
Gilles Peskinea28db922019-01-10 00:05:18 +0100511 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200512 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000513 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100514 fi
515
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000516 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
517 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100518 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000519 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100520 fi
SimonB2e23c822016-04-16 21:54:39 +0100521
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200522 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100523 if [ $all_except -eq 0 ]; then
524 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200525 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
526 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200527 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100528 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200529 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200530 # If the requested name includes a wildcard character, don't
531 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100532 case $component in
533 *[*?\[]*) continue;;
534 esac
535 case " $SUPPORTED_COMPONENTS " in
536 *" $component "*) :;;
537 *)
538 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
539 unsupported=$((unsupported + 1));;
540 esac
541 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200542 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100543 if [ $unsupported -ne 0 ]; then
544 exit 2
545 fi
546 fi
547
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000548 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100549 RUN_COMPONENTS=
550 for component in $SUPPORTED_COMPONENTS; do
551 if is_component_included "$component"; [ $? -eq $all_except ]; then
552 RUN_COMPONENTS="$RUN_COMPONENTS $component"
553 fi
554 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000555
556 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000557 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100558}
SimonB2e23c822016-04-16 21:54:39 +0100559
Gilles Peskine8f073122018-11-27 15:58:47 +0100560pre_check_git () {
561 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100562 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100563 git checkout-index -f -q $CONFIG_H
564 cleanup
565 else
SimonB2e23c822016-04-16 21:54:39 +0100566
Gilles Peskine8f073122018-11-27 15:58:47 +0100567 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
568 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
569 echo "You can either delete this directory manually, or force the test by rerunning"
570 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
571 exit 1
572 fi
573
Ronald Cron7a93ac52023-07-20 09:49:12 +0200574 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100575 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100576 echo "You can either delete or preserve your work, or force the test by rerunning the"
577 echo "script as: $0 --force"
578 exit 1
579 fi
SimonB2e23c822016-04-16 21:54:39 +0100580 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500581}
582
Gilles Peskine568f53a2021-07-12 18:16:01 +0200583pre_restore_files () {
584 # If the makefiles have been generated by a framework such as cmake,
585 # restore them from git. If the makefiles look like modifications from
586 # the ones checked into git, take care not to modify them. Whatever
587 # this function leaves behind is what the script will restore before
588 # each component.
589 case "$(head -n1 Makefile)" in
590 *[Gg]enerated*)
591 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
592 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
593 ;;
594 esac
595}
596
Gilles Peskinef83eb822020-03-30 20:11:39 +0200597pre_back_up () {
598 for x in $files_to_back_up; do
599 cp -p "$x" "$x$backup_suffix"
600 done
601}
602
Gilles Peskine8f073122018-11-27 15:58:47 +0100603pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100604 failure_count=0 # Number of failed components
605 last_failure_status=0 # Last failure status in this component
606
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100607 # See err_trap
608 previous_failure_status=0
609 previous_failed_command=
610 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100611 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100612
Gilles Peskine7c652162017-12-11 00:01:40 +0100613 start_red=
614 end_color=
615 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100616 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100617 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
618 start_red=$(printf '\033[31m')
619 end_color=$(printf '\033[0m')
620 ;;
621 esac
622 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100623
624 # Keep a summary of failures in a file. We'll print it out at the end.
625 failure_summary_file=$PWD/all-sh-failures-$$.log
626 : >"$failure_summary_file"
627
628 # Whether it makes sense to keep a component going after the specified
629 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200630 # This function normally receives the failing simple command
631 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
632 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100633 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200634 # False positives result in running things that can't be expected to
635 # work. False negatives result in things not running after something else
636 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100637 can_keep_going_after_failure () {
638 case "$1" in
639 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200640 "cd "*) false;;
641 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
642 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
643 *make*check*) true;;
644 "grep "*) true;;
645 "[ "*) true;;
646 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100647 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100648 esac
649 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100650
651 # This function runs if there is any error in a component.
652 # It must either exit with a nonzero status, or set
653 # last_failure_status to a nonzero value.
654 err_trap () {
655 # Save $? (status of the failing command). This must be the very
656 # first thing, before $? is overridden.
657 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100658 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100659
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100660 if [[ $last_failure_status -eq $previous_failure_status &&
661 "$failed_command" == "$previous_failed_command" &&
662 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
663 then
664 # The same command failed twice in a row, but this time one level
665 # less deep in the function call stack. This happens when the last
666 # command of a function returns a nonzero status, and the function
667 # returns that same status. Ignore the second failure.
668 previous_failure_funcall_depth=${#FUNCNAME[@]}
669 return
670 fi
671 previous_failure_status=$last_failure_status
672 previous_failed_command=$failed_command
673 previous_failure_funcall_depth=${#FUNCNAME[@]}
674
Gilles Peskinece266c42020-03-28 18:50:43 +0100675 text="$current_section: $failed_command -> $last_failure_status"
676 echo "${start_red}^^^^$text^^^^${end_color}" >&2
677 echo "$text" >>"$failure_summary_file"
678
679 # If the command is fatal (configure or build command), stop this
680 # component. Otherwise (test command) keep the component running
681 # (run more tests from the same build).
682 if ! can_keep_going_after_failure "$failed_command"; then
683 exit $last_failure_status
684 fi
685 }
686
Gilles Peskine7c652162017-12-11 00:01:40 +0100687 final_report () {
688 if [ $failure_count -gt 0 ]; then
689 echo
690 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100691 echo "${start_red}FAILED: $failure_count components${end_color}"
692 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100693 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
694 elif [ -z "${1-}" ]; then
695 echo "SUCCESS :)"
696 fi
697 if [ -n "${1-}" ]; then
698 echo "Killed by SIG$1."
699 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100700 rm -f "$failure_summary_file"
701 if [ $failure_count -gt 0 ]; then
702 exit 1
703 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100704 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100705}
706
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200707# record_status() and if_build_succeeded() are kept temporarily for backward
708# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100709record_status () {
710 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100711}
Gilles Peskine7c652162017-12-11 00:01:40 +0100712if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100713 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100714}
715
Gilles Peskinea681c592020-03-28 21:27:40 +0100716# '! true' does not trigger the ERR trap. Arrange to trigger it, with
717# a reasonably informative error message (not just "$@").
718not () {
719 if "$@"; then
720 report_failed_command="! $*"
721 false
722 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200723 fi
724}
725
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200726pre_prepare_outcome_file () {
727 case "$MBEDTLS_TEST_OUTCOME_FILE" in
728 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
729 esac
730 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
731 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
732 fi
733}
734
Gilles Peskine8f073122018-11-27 15:58:47 +0100735pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200736 if [ $QUIET -eq 1 ]; then
737 return
738 fi
739
Gilles Peskine8f073122018-11-27 15:58:47 +0100740 msg "info: $0 configuration"
741 echo "MEMORY: $MEMORY"
742 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200743 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100744 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100745 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100746 echo "OPENSSL: $OPENSSL"
747 echo "OPENSSL_LEGACY: $OPENSSL_LEGACY"
748 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
749 echo "GNUTLS_CLI: $GNUTLS_CLI"
750 echo "GNUTLS_SERV: $GNUTLS_SERV"
751 echo "GNUTLS_LEGACY_CLI: $GNUTLS_LEGACY_CLI"
752 echo "GNUTLS_LEGACY_SERV: $GNUTLS_LEGACY_SERV"
753 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
754 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
755}
Andres AG7770ea82016-10-10 15:46:20 +0100756
Andres AGd9eba4b2016-08-26 14:42:14 +0100757# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100758pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000759 # Build the list of variables to pass to output_env.sh.
760 set env
SimonB2e23c822016-04-16 21:54:39 +0100761
Gilles Peskine87964262019-01-06 22:40:00 +0000762 case " $RUN_COMPONENTS " in
763 # Require OpenSSL and GnuTLS if running any tests (as opposed to
764 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
765 # is a good enough approximation in practice.
766 *" test_"*)
767 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
768 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100769 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000770 export GNUTLS_CLI="$GNUTLS_CLI"
771 export GNUTLS_SERV="$GNUTLS_SERV"
772 # Avoid passing --seed flag in every call to ssl-opt.sh
773 if [ -n "${SEED-}" ]; then
774 export SEED
775 fi
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000776 set "$@" OPENSSL="$OPENSSL" OPENSSL_LEGACY="$OPENSSL_LEGACY"
777 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
778 set "$@" GNUTLS_LEGACY_CLI="$GNUTLS_LEGACY_CLI"
779 set "$@" GNUTLS_LEGACY_SERV="$GNUTLS_LEGACY_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000780 check_tools "$OPENSSL" "$OPENSSL_LEGACY" "$OPENSSL_NEXT" \
781 "$GNUTLS_CLI" "$GNUTLS_SERV" \
782 "$GNUTLS_LEGACY_CLI" "$GNUTLS_LEGACY_SERV"
783 ;;
784 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200785
Gilles Peskine87964262019-01-06 22:40:00 +0000786 case " $RUN_COMPONENTS " in
787 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
788 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100789
Gilles Peskine87964262019-01-06 22:40:00 +0000790 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200791 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000792 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100793
Gilles Peskine87964262019-01-06 22:40:00 +0000794 case " $RUN_COMPONENTS " in
795 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
796 esac
797
798 case " $RUN_COMPONENTS " in
799 *" test_zeroize "*) check_tools "gdb";;
800 esac
801
802 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000803 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000804 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
805 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200806 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000807 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
808 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200809 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
810 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
811 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000812 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000813
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200814 # past this point, no call to check_tool, only printing output
815 if [ $QUIET -eq 1 ]; then
816 return
817 fi
818
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000819 msg "info: output_env.sh"
820 case $RUN_COMPONENTS in
821 *_armcc*)
822 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
823 *) set "$@" RUN_ARMCC=0;;
824 esac
825 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100826}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100827
Gilles Peskine1570b592021-04-22 01:10:12 +0200828pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200829 # since make doesn't have proper dependencies, remove any possibly outdate
830 # file that might be around before generating fresh ones
831 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200832 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200833 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200834 else
835 make generated_files
836 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200837}
838
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200839################################################################
840#### Helpers for components using libtestdriver1
841################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100842
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200843# How to use libtestdriver1
844# -------------------------
845#
846# 1. Define the list algorithms and key types to accelerate,
847# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
848# Examples:
849# - loc_accel_list="ALG_JPAKE"
850# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200851# 2. Make configurations changes for the driver and/or main libraries.
852# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
853# can be either "default" to start with the default config, or a name
854# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200855# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200856# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
857# These changes affect both the driver and the main libraries.
858# (Note: they need to have the same set of PSA_WANT symbols, as that
859# determines the ABI between them.)
860# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
861# main libraries. Typically, you want to disable the module(s) that are
862# being accelerated. You may need to also disable modules that depend
863# on them or options that are not supported with drivers.
864# 2d. On top of psa/crypto_config.h, the driver library uses its own config
865# file: tests/include/test/drivers/config_test_driver.h. You usually
866# don't need to edit it: using loc_extra_list (see below) is preferred.
867# However, when there's no PSA symbol for what you want to enable,
868# calling scripts/config.py on this file remains the only option.
869# 3. Build the driver library, then the main libraries, test, and programs.
870# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
871# need to enable more algorithms here, typically hash algorithms when
872# accelerating some signature algorithms (ECDSA, RSAv2). This is done
873# by passing a 2nd argument listing the extra algorithms.
874# Example:
875# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
876# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
877# 4b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
878# additional arguments will be passed to make: this can be useful if
879# you don't want to build everything when iterating during development.
880# Example:
881# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
882# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200883
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200884# Adjust the configuration - for both libtestdriver1 and main library,
885# as they should have the same PSA_WANT macros.
886helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200887 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200888 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200889 if [ "$base_config" != "default" ]; then
890 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200891 fi
892
893 # Enable PSA-based config (necessary to use drivers)
894 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
895
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200896 # Disable ALG_STREAM_CIPHER and ALG_ECB_NO_PADDING to avoid having
897 # partial support for cipher operations in the driver test library.
Ronald Cron6b49b552023-07-20 09:57:54 +0200898 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
899 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200900
901 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
902 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
903 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200904}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100905
Valerio Settib2fd6732023-08-15 17:10:47 +0200906# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200907# The function optionally accepts 1 parameter: a space-separated list of the
908# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200909helper_disable_builtin_curves() {
910 allowed_list="${1:-}"
911 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
912
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200913 for curve in $allowed_list; do
914 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200915 done
916}
917
918# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
919# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
920# in the following helpers.
921helper_get_psa_curve_list () {
922 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200923 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
924 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200925 done
926
927 echo "$loc_list"
928}
929
930# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +0200931# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +0200932# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +0200933helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200934 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +0200935 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200936 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 +0200937 # Skip DERIVE for elliptic keys since there is no driver dispatch for
938 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200939 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
940 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200941 fi
942 done
943
944 echo "$loc_list"
945}
946
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200947# Build the drivers library libtestdriver1.a (with ASan).
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200948#
949# Parameters:
950# 1. a space-separated list of things to accelerate;
951# 2. optional: a space-separate list of things to also support.
952# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
953helper_libtestdriver1_make_drivers() {
954 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
955 make -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
956}
957
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200958# Build the main libraries, programs and tests,
959# linking to the drivers library (with ASan).
960#
961# Parameters:
962# 1. a space-separated list of things to accelerate;
963# *. remaining arguments if any are passed directly to make
964# (examples: lib, -C tests test_suite_xxx, etc.)
965# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
966helper_libtestdriver1_make_main() {
967 loc_accel_list=$1
968 shift
969
970 # we need flags both with and without the LIBTESTDRIVER1_ prefix
971 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
972 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
973 make CFLAGS="$ASAN_CFLAGS -I../tests/include -I../tests -I../../tests -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_TEST_LIBTESTDRIVER1 $loc_accel_flags" LDFLAGS="-ltestdriver1 $ASAN_CFLAGS" "$@"
974}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100975
976################################################################
977#### Basic checks
978################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100979
980#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200981# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100982#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +0100983# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200984# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100985# 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 +0200986# time, so start with a GCC build).
987# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100988#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +0100989# Indicative running times are given for reference.
990
Gilles Peskine8f073122018-11-27 15:58:47 +0100991component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200992 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200993 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +0100994}
Janos Follathb72c6782016-07-19 14:54:17 +0100995
Gilles Peskine67debb62021-05-18 16:09:50 +0200996component_check_generated_files () {
997 msg "Check: check-generated-files, files generated with make" # 2s
998 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200999 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001000
1001 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001002 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001003 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001004 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001005
1006 msg "Check: check-generated-files -u, files absent" # 2s
1007 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001008 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001009 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001010 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001011
1012 # This component ends with the generated files present in the source tree.
1013 # This is necessary for subsequent components!
1014}
1015
Gilles Peskine8f073122018-11-27 15:58:47 +01001016component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001017 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001018 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001019}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001020
Gilles Peskine8f073122018-11-27 15:58:47 +01001021component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001022 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001023 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001024}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001025
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001026component_check_changelog () {
1027 msg "Check: changelog entries" # < 1s
1028 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001029 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001030 if [ -e ChangeLog.new ]; then
1031 # Show the diff for information. It isn't an error if the diff is
1032 # non-empty.
1033 diff -u ChangeLog ChangeLog.new || true
1034 rm ChangeLog.new
1035 fi
1036}
1037
Gilles Peskine8f073122018-11-27 15:58:47 +01001038component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001039 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001040 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001041}
Darryl Greena07039c2018-03-13 16:48:16 +00001042
Gilles Peskine895868b2019-09-19 21:30:05 +02001043component_check_test_cases () {
1044 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001045 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001046 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001047 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001048 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001049 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001050 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001051 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001052}
1053
Gilles Peskine8f073122018-11-27 15:58:47 +01001054component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001055 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001056 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001057}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001058
Gilles Peskine192c72f2017-12-21 15:59:21 +01001059
Gilles Peskine636c26a2020-03-04 20:46:15 +01001060
Gilles Peskine192c72f2017-12-21 15:59:21 +01001061################################################################
1062#### Build and test many configurations and targets
1063################################################################
1064
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001065component_test_default_out_of_box () {
1066 msg "build: make, default config (out-of-box)" # ~1min
1067 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001068 # Disable fancy stuff
1069 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001070
1071 msg "test: main suites make, default config (out-of-box)" # ~10s
1072 make test
1073
1074 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001075 programs/test/selftest
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001076}
1077
Gilles Peskine8f073122018-11-27 15:58:47 +01001078component_test_default_cmake_gcc_asan () {
1079 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001080 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1081 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001082
Gilles Peskine8f073122018-11-27 15:58:47 +01001083 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1084 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001085
Gilles Peskine97bea012020-04-23 23:37:45 +02001086 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001087 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001088
Gilles Peskine8f073122018-11-27 15:58:47 +01001089 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001090 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001091
Gilles Peskine8f073122018-11-27 15:58:47 +01001092 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001093 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001094
1095 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001096 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001097}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001098
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001099component_test_default_cmake_gcc_asan_new_bignum () {
1100 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001101 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001102 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001103 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001104
1105 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1106 make test
1107
1108 msg "test: selftest (ASan build)" # ~ 10s
1109 programs/test/selftest
1110
1111 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1112 tests/ssl-opt.sh
1113
1114 msg "test: compat.sh (ASan build)" # ~ 6 min
1115 tests/compat.sh
1116
1117 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1118 tests/context-info.sh
1119}
1120
Hanno Becker01635512019-02-26 14:27:09 +00001121component_test_full_cmake_gcc_asan () {
1122 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001123 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001124 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1125 make
1126
1127 msg "test: main suites (inc. selftests) (full config, ASan build)"
1128 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001129
Gilles Peskine97bea012020-04-23 23:37:45 +02001130 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001131 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001132
Gilles Peskine636c26a2020-03-04 20:46:15 +01001133 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001134 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001135
1136 msg "test: compat.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001137 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001138
1139 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001140 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001141}
1142
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001143
1144component_test_full_cmake_gcc_asan_new_bignum () {
1145 msg "build: full config, cmake, gcc, ASan"
1146 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001147 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001148 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001149 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001150
1151 msg "test: main suites (inc. selftests) (full config, ASan build)"
1152 make test
1153
1154 msg "test: selftest (ASan build)" # ~ 10s
1155 programs/test/selftest
1156
1157 msg "test: ssl-opt.sh (full config, ASan build)"
1158 tests/ssl-opt.sh
1159
1160 msg "test: compat.sh (full config, ASan build)"
1161 tests/compat.sh
1162
1163 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
1164 tests/context-info.sh
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001165}
1166
Gabor Mezei6db60472023-07-05 16:38:42 +02001167component_test_full_cmake_gcc_asan_new_bignum_test_hooks () {
1168 msg "build: full config, cmake, gcc, ASan"
1169 scripts/config.py full
1170 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01001171 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei6db60472023-07-05 16:38:42 +02001172 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001173 make
Gabor Mezei6db60472023-07-05 16:38:42 +02001174
1175 msg "test: main suites (inc. selftests) (full config, ASan build)"
1176 make test
1177
1178 msg "test: selftest (ASan build)" # ~ 10s
1179 programs/test/selftest
1180}
1181
Ronald Cronc3623db2020-10-29 10:51:32 +01001182component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001183 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001184 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001185 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1186 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1187 make
1188
1189 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1190 make test
1191}
1192
Gilles Peskinea3548672021-06-17 11:37:52 +02001193# check_renamed_symbols HEADER LIB
1194# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1195# name is LIB.
1196check_renamed_symbols () {
1197 ! nm "$2" | sed 's/.* //' |
1198 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1199}
1200
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001201component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001202 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001203 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001204 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1205 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1206 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1207 # We can only compile, not link, since our test and sample programs
1208 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1209 # is active.
1210 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001211
1212 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1213 # version is not present.
1214 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001215 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001216}
1217
Ronald Cron336678b2021-01-28 17:54:24 +01001218component_test_psa_crypto_client () {
1219 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1220 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1221 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1222 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001223 scripts/config.py unset MBEDTLS_LMS_C
1224 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Ronald Cron336678b2021-01-28 17:54:24 +01001225 make
1226
1227 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1228 make test
1229}
1230
Jaeden Amero424fa932021-05-14 08:34:32 +01001231component_test_psa_crypto_rsa_no_genprime() {
1232 msg "build: default config minus MBEDTLS_GENPRIME"
1233 scripts/config.py unset MBEDTLS_GENPRIME
1234 make
1235
1236 msg "test: default config minus MBEDTLS_GENPRIME"
1237 make test
1238}
1239
Gilles Peskine782f4112018-11-27 16:11:09 +01001240component_test_ref_configs () {
1241 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001242 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1243 # want to re-generate generated files that depend on it, quite correctly.
1244 # However this doesn't work as the generation script expects a specific
1245 # format for mbedtls_config.h, which the other files don't follow. Also,
1246 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001247 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001248 # whether they're on or off. So, disable cmake's (over-sensitive here)
1249 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001250 # present (thanks to pre_generate_files) by turning GEN_FILES off.
1251 CC=gcc cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001252 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001253}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001254
Gilles Peskine8f073122018-11-27 15:58:47 +01001255component_test_no_renegotiation () {
1256 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001257 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Gilles Peskine8f073122018-11-27 15:58:47 +01001258 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1259 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001260
Gilles Peskine8f073122018-11-27 15:58:47 +01001261 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1262 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001263
Gilles Peskine8f073122018-11-27 15:58:47 +01001264 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001265 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001266}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001267
Gilles Peskine636c26a2020-03-04 20:46:15 +01001268component_test_no_pem_no_fs () {
1269 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1270 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1271 scripts/config.py unset MBEDTLS_FS_IO
1272 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1273 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
1274 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1275 make
1276
1277 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1278 make test
1279
1280 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001281 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001282}
1283
Gilles Peskine8f073122018-11-27 15:58:47 +01001284component_test_rsa_no_crt () {
1285 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001286 scripts/config.py set MBEDTLS_RSA_NO_CRT
Gilles Peskine8f073122018-11-27 15:58:47 +01001287 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1288 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001289
Gilles Peskine8f073122018-11-27 15:58:47 +01001290 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1291 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001292
Gilles Peskine8f073122018-11-27 15:58:47 +01001293 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001294 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001295
Gilles Peskine8f073122018-11-27 15:58:47 +01001296 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001297 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001298
1299 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001300 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001301}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001302
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001303component_test_no_ctr_drbg_classic () {
1304 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001305 scripts/config.py full
1306 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001307 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001308 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001309
1310 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1311 make
1312
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001313 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001314 make test
1315
Gilles Peskineba749042021-01-13 20:02:03 +01001316 # In this configuration, the TLS test programs use HMAC_DRBG.
1317 # The SSL tests are slow, so run a small subset, just enough to get
1318 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001319 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001320 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001321
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001322 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001323 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001324}
1325
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001326component_test_no_ctr_drbg_use_psa () {
1327 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001328 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001329 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1330 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001331
1332 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1333 make
1334
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001335 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1336 make test
1337
1338 # In this configuration, the TLS test programs use HMAC_DRBG.
1339 # The SSL tests are slow, so run a small subset, just enough to get
1340 # confidence that the SSL code copes with HMAC_DRBG.
1341 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001342 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001343
1344 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001345 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001346}
1347
1348component_test_no_hmac_drbg_classic () {
1349 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1350 scripts/config.py full
1351 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1352 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1353 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001354 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001355
1356 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1357 make
1358
1359 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001360 make test
1361
Gilles Peskinea2224342020-11-19 22:14:34 +01001362 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1363 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1364 # instead.
1365 # Test SSL with non-deterministic ECDSA. Only test features that
1366 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001367 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001368 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001369
1370 # To save time, only test one protocol version, since this part of
1371 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001372 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001373 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001374}
1375
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001376component_test_no_hmac_drbg_use_psa () {
1377 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1378 scripts/config.py full
1379 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1380 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1381 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1382
1383 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1384 make
1385
1386 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1387 make test
1388
1389 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1390 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1391 # instead.
1392 # Test SSL with non-deterministic ECDSA. Only test features that
1393 # might be affected by how ECDSA signature is performed.
1394 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001395 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001396
1397 # To save time, only test one protocol version, since this part of
1398 # the protocol is identical in (D)TLS up to 1.2.
1399 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001400 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001401}
1402
1403component_test_psa_external_rng_no_drbg_classic () {
1404 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1405 scripts/config.py full
1406 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001407 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001408 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001409 scripts/config.py unset MBEDTLS_ENTROPY_C
1410 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1411 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001412 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1413 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1414 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001415 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1416 # the SSL test programs don't have an RNG and can't work. Explicitly
1417 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
1418 make CFLAGS="$ASAN_CFLAGS -O2 -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001419
1420 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1421 make test
1422
Gilles Peskine8eb29432021-02-03 20:07:11 +01001423 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001424 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001425}
1426
1427component_test_psa_external_rng_no_drbg_use_psa () {
1428 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001429 scripts/config.py full
1430 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001431 scripts/config.py unset MBEDTLS_ENTROPY_C
1432 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1433 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001434 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1435 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1436 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskinec109b372020-11-23 17:39:04 +01001437 make CFLAGS="$ASAN_CFLAGS -O2" LDFLAGS="$ASAN_CFLAGS"
1438
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001439 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001440 make test
1441
Gilles Peskine8eb29432021-02-03 20:07:11 +01001442 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001443 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001444}
1445
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001446component_test_psa_external_rng_use_psa_crypto () {
1447 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1448 scripts/config.py full
1449 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1450 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1451 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1452 make CFLAGS="$ASAN_CFLAGS -O2" LDFLAGS="$ASAN_CFLAGS"
1453
1454 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1455 make test
1456
1457 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1458 tests/ssl-opt.sh -f 'Default\|opaque'
1459}
1460
Gilles Peskine801c4332023-04-28 21:04:28 +02001461component_test_psa_inject_entropy () {
1462 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1463 scripts/config.py full
1464 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1465 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1466 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1467 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1468 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1469 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
1470 make CFLAGS="$ASAN_CFLAGS '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'" LDFLAGS="$ASAN_CFLAGS"
1471
1472 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1473 make test
1474}
1475
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001476component_test_sw_inet_pton () {
1477 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1478
1479 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1480 scripts/config.py set MBEDTLS_TEST_HOOKS
1481 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1482
1483 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1484 make test
1485}
1486
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001487component_test_crypto_full_md_light_only () {
1488 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001489 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001490 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001491 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001492 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001493 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001494 scripts/config.py unset MBEDTLS_HKDF_C
1495 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001496 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001497 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001498 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001499 # Disable things that would auto-enable MD_C
1500 scripts/config.py unset MBEDTLS_PKCS5_C
1501
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001502 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1503 # which we haven't disabled, so no need to explicitly enable it.
1504 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001505
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001506 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001507 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001508 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001509
1510 msg "test: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001511 make test
1512}
1513
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001514component_test_full_no_cipher () {
1515 msg "build: full minus CIPHER"
1516 scripts/config.py full
1517 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001518 # Don't pull in cipher via PSA mechanisms
1519 # (currently ignored anyway because we completely disable PSA)
1520 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Przemek Stekielda5f4832022-05-12 09:46:29 +02001521 # Direct dependencies
1522 scripts/config.py unset MBEDTLS_CCM_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001523 scripts/config.py unset MBEDTLS_CMAC_C
Przemek Stekielda5f4832022-05-12 09:46:29 +02001524 scripts/config.py unset MBEDTLS_GCM_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001525 scripts/config.py unset MBEDTLS_NIST_KW_C
1526 scripts/config.py unset MBEDTLS_PKCS12_C
1527 scripts/config.py unset MBEDTLS_PKCS5_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001528 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1529 scripts/config.py unset MBEDTLS_SSL_TLS_C
1530 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielda5f4832022-05-12 09:46:29 +02001531 # Indirect dependencies
1532 scripts/config.py unset MBEDTLS_SSL_CLI_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001533 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1534 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001535 scripts/config.py unset MBEDTLS_SSL_DTLS_ANTI_REPLAY
1536 scripts/config.py unset MBEDTLS_SSL_DTLS_CONNECTION_ID
Dave Rodgman1df70702022-10-26 17:08:54 +01001537 scripts/config.py unset MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
Przemek Stekielda5f4832022-05-12 09:46:29 +02001538 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
1539 scripts/config.py unset MBEDTLS_SSL_SRV_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001540 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001541 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001542 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001543 make
1544
1545 msg "test: full minus CIPHER"
1546 make test
1547}
1548
Valerio Settie1655b82023-01-03 15:35:25 +01001549component_test_full_no_bignum () {
1550 msg "build: full minus bignum"
1551 scripts/config.py full
1552 scripts/config.py unset MBEDTLS_BIGNUM_C
1553 # Direct dependencies of bignum
1554 scripts/config.py unset MBEDTLS_ECP_C
1555 scripts/config.py unset MBEDTLS_RSA_C
1556 scripts/config.py unset MBEDTLS_DHM_C
1557 # Direct dependencies of ECP
1558 scripts/config.py unset MBEDTLS_ECDH_C
1559 scripts/config.py unset MBEDTLS_ECDSA_C
1560 scripts/config.py unset MBEDTLS_ECJPAKE_C
1561 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001562 # Disable what auto-enables ECP_LIGHT
1563 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1564 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001565 # Indirect dependencies of ECP
1566 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1567 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1568 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1569 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1570 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1571 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1572 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1573 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1574 # Direct dependencies of DHM
1575 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1576 # Direct dependencies of RSA
1577 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1578 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1579 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1580 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1581 # PK and its dependencies
1582 scripts/config.py unset MBEDTLS_PK_C
1583 scripts/config.py unset MBEDTLS_PK_PARSE_C
1584 scripts/config.py unset MBEDTLS_PK_WRITE_C
1585 scripts/config.py unset MBEDTLS_X509_USE_C
1586 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1587 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1588 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1589 scripts/config.py unset MBEDTLS_X509_CREATE_C
1590 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1591 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1592 scripts/config.py unset MBEDTLS_PKCS7_C
1593 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1594 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1595 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1596
1597 make
1598
1599 msg "test: full minus bignum"
1600 make test
1601}
1602
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001603component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001604 msg "build: default with only stream cipher"
1605
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001606 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001607 scripts/config.py unset MBEDTLS_GCM_C
1608 scripts/config.py unset MBEDTLS_CCM_C
1609 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001610 # 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 +02001611 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001612 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001613 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001614 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1615 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001616 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001617 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001618 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001619
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001620 make
1621
1622 msg "test: default with only stream cipher"
1623 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001624
1625 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001626}
1627
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001628component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001629 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001630
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001631 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001632 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001633 scripts/config.py unset MBEDTLS_GCM_C
1634 scripts/config.py unset MBEDTLS_CCM_C
1635 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001636 # 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 +02001637 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001638 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001639 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001640 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1641 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001642 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001643 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001644 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001645
Przemek Stekiel9550c052022-09-28 09:51:55 +02001646 make
1647
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001648 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001649 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001650
1651 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001652}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001653
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001654component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001655 msg "build: default with only CBC-legacy cipher"
1656
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001657 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001658 scripts/config.py unset MBEDTLS_GCM_C
1659 scripts/config.py unset MBEDTLS_CCM_C
1660 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001661 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1662 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1663 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001664 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001665 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001666 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001667 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001668 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001669 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001670
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001671 make
1672
1673 msg "test: default with only CBC-legacy cipher"
1674 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001675
1676 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1677 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001678}
1679
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001680component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001681 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001682
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001683 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001684 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001685 scripts/config.py unset MBEDTLS_GCM_C
1686 scripts/config.py unset MBEDTLS_CCM_C
1687 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001688 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1689 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1690 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001691 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001692 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001693 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001694 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001695 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001696 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001697
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001698 make
1699
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001700 msg "test: default with only CBC-legacy cipher use psa"
1701 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001702
1703 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1704 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001705}
1706
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001707component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001708 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1709
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001710 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001711 scripts/config.py unset MBEDTLS_GCM_C
1712 scripts/config.py unset MBEDTLS_CCM_C
1713 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001714 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1715 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1716 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1717 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1718 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001719 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001720 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001721 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001722 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001723
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001724 make
1725
1726 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
1727 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001728
1729 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
1730 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001731}
1732
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001733component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
1734 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001735
1736 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001737 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001738 scripts/config.py unset MBEDTLS_GCM_C
1739 scripts/config.py unset MBEDTLS_CCM_C
1740 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001741 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1742 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1743 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1744 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1745 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001746 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001747 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001748 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001749 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001750
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001751 make
1752
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001753 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001754 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001755
1756 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1757 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001758}
1759
Valerio Setti9f0ec532022-11-08 13:03:24 +01001760# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1761# that we could use for interop testing. However, we now have sort of two
1762# implementations ourselves: one using PSA, the other not. At least test that
1763# these two interoperate with each other.
1764component_test_tls1_2_ecjpake_compatibility() {
1765 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1766 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001767 # Explicitly make lib first to avoid a race condition:
1768 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1769 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001770 make -C programs ssl/ssl_server2 ssl/ssl_client2
1771 cp programs/ssl/ssl_server2 s2_no_use_psa
1772 cp programs/ssl/ssl_client2 c2_no_use_psa
1773
1774 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1775 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1776 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001777 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001778 make -C programs ssl/ssl_server2 ssl/ssl_client2
1779 make -C programs test/udp_proxy test/query_compile_time_config
1780
Valerio Setti70e02902022-12-02 16:21:56 +01001781 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1782 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1783 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1784 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1785 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1786 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1787 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1788 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 +01001789
1790 rm s2_no_use_psa c2_no_use_psa
1791}
1792
Gilles Peskine636c26a2020-03-04 20:46:15 +01001793component_test_everest () {
1794 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine636c26a2020-03-04 20:46:15 +01001795 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1796 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1797 make
1798
1799 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1800 make test
1801
1802 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001803 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01001804
1805 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1806 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001807 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001808}
1809
Gilles Peskined3beca92020-07-03 00:15:37 +02001810component_test_everest_curve25519_only () {
1811 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02001812 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1813 scripts/config.py unset MBEDTLS_ECDSA_C
1814 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1815 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02001816 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02001817 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02001818 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02001819 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
1820
1821 make CFLAGS="$ASAN_CFLAGS -O2" LDFLAGS="$ASAN_CFLAGS"
1822
1823 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
1824 make test
1825}
1826
Gilles Peskine8f073122018-11-27 15:58:47 +01001827component_test_small_ssl_out_content_len () {
1828 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001829 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
1830 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Gilles Peskine8f073122018-11-27 15:58:47 +01001831 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1832 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001833
Gilles Peskine8f073122018-11-27 15:58:47 +01001834 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001835 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01001836}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001837
Gilles Peskine8f073122018-11-27 15:58:47 +01001838component_test_small_ssl_in_content_len () {
1839 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001840 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
1841 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Gilles Peskine8f073122018-11-27 15:58:47 +01001842 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1843 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10001844
Gilles Peskine8f073122018-11-27 15:58:47 +01001845 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001846 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01001847}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001848
Gilles Peskine8f073122018-11-27 15:58:47 +01001849component_test_small_ssl_dtls_max_buffering () {
1850 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001851 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Gilles Peskine8f073122018-11-27 15:58:47 +01001852 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1853 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10001854
Gilles Peskine8f073122018-11-27 15:58:47 +01001855 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001856 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 +01001857}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01001858
Gilles Peskine8f073122018-11-27 15:58:47 +01001859component_test_small_mbedtls_ssl_dtls_max_buffering () {
1860 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001861 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Gilles Peskine8f073122018-11-27 15:58:47 +01001862 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1863 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01001864
Gilles Peskine8f073122018-11-27 15:58:47 +01001865 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001866 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01001867}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01001868
Gilles Peskine75cc7712019-09-06 19:47:17 +02001869component_test_psa_collect_statuses () {
1870 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001871 scripts/config.py full
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001872 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02001873 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001874 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02001875 rm -f tests/statuses.log
1876}
1877
Gilles Peskine8f073122018-11-27 15:58:47 +01001878component_test_full_cmake_clang () {
1879 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001880 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01001881 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 +01001882 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01001883
k-stachowiak0291cb72019-06-26 15:52:12 +02001884 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01001885 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01001886
Gilles Peskineda6017c2022-10-30 21:02:40 +01001887 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
1888 programs/test/cpp_dummy_build
1889
k-stachowiak0291cb72019-06-26 15:52:12 +02001890 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001891 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01001892
Gilles Peskine8f073122018-11-27 15:58:47 +01001893 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001894 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02001895
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001896 msg "test: compat.sh NULL (full config)" # ~ 2 min
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01001897 env OPENSSL="$OPENSSL_LEGACY" GNUTLS_CLI="$GNUTLS_LEGACY_CLI" GNUTLS_SERV="$GNUTLS_LEGACY_SERV" tests/compat.sh -e '^$' -f 'NULL'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02001898
Gilles Peskine8f073122018-11-27 15:58:47 +01001899 msg "test: compat.sh ARIA + ChachaPoly"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01001900 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gilles Peskine8f073122018-11-27 15:58:47 +01001901}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02001902
Gilles Peskine0c671602022-11-29 16:01:41 +01001903skip_suites_without_constant_flow () {
1904 # Skip the test suites that don't have any constant-flow annotations.
1905 # This will need to be adjusted if we ever start declaring things as
1906 # secret from macros or functions inside tests/include or tests/src.
1907 SKIP_TEST_SUITES=$(
1908 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
1909 sed 's/test_suite_//; s/\.function$//' |
1910 tr '\n' ,)
1911 export SKIP_TEST_SUITES
1912}
1913
Dave Rodgman246210e2023-07-31 18:07:44 +01001914skip_all_except_given_suite () {
1915 # Skip all but the given test suite
1916 SKIP_TEST_SUITES=$(
1917 ls -1 tests/suites/test_suite_*.function |
1918 grep -v $1.function |
1919 sed 's/tests.suites.test_suite_//; s/\.function$//' |
1920 tr '\n' ,)
1921 export SKIP_TEST_SUITES
1922}
1923
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001924component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02001925 # This tests both (1) accesses to undefined memory, and (2) branches or
1926 # memory access depending on secret values. To distinguish between those:
1927 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
1928 # - or alternatively, change the build type to MemSanDbg, which enables
1929 # origin tracking and nicer stack traces (which are useful for debugging
1930 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01001931 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
1932 scripts/config.py full
1933 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1934 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
1935 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
1936 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
1937 make
1938
1939 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
1940 make test
1941}
1942
1943component_test_memsan_constant_flow_psa () {
1944 # This tests both (1) accesses to undefined memory, and (2) branches or
1945 # memory access depending on secret values. To distinguish between those:
1946 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
1947 # - or alternatively, change the build type to MemSanDbg, which enables
1948 # origin tracking and nicer stack traces (which are useful for debugging
1949 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02001950 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001951 scripts/config.py full
1952 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1953 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
1954 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
1955 make
1956
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02001957 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001958 make test
1959}
1960
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001961component_test_valgrind_constant_flow () {
1962 # This tests both (1) everything that valgrind's memcheck usually checks
1963 # (heap buffer overflows, use of uninitialized memory, use-after-free,
1964 # etc.) and (2) branches or memory access depending on secret values,
1965 # which will be reported as uninitialized memory. To distinguish between
1966 # secret and actually uninitialized:
1967 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
1968 # - or alternatively, build with debug info and manually run the offending
1969 # test suite with valgrind --track-origins=yes, then check if the origin
1970 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01001971 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
1972 scripts/config.py full
1973 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1974 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01001975 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01001976 cmake -D CMAKE_BUILD_TYPE:String=Release .
1977 make
1978
1979 # this only shows a summary of the results (how many of each type)
1980 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01001981 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01001982 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01001983
1984 # Test asm path in constant time module - by default, it will test the plain C
1985 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
1986 msg "test: valgrind asm constant_time"
1987 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
1988 skip_all_except_given_suite test_suite_constant_time
1989 cmake -D CMAKE_BUILD_TYPE:String=Release .
1990 make clean
1991 make
1992 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01001993}
1994
1995component_test_valgrind_constant_flow_psa () {
1996 # This tests both (1) everything that valgrind's memcheck usually checks
1997 # (heap buffer overflows, use of uninitialized memory, use-after-free,
1998 # etc.) and (2) branches or memory access depending on secret values,
1999 # which will be reported as uninitialized memory. To distinguish between
2000 # secret and actually uninitialized:
2001 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2002 # - or alternatively, build with debug info and manually run the offending
2003 # test suite with valgrind --track-origins=yes, then check if the origin
2004 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002005 msg "build: cmake release GCC, full config with constant flow testing"
2006 scripts/config.py full
2007 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002008 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002009 cmake -D CMAKE_BUILD_TYPE:String=Release .
2010 make
2011
2012 # this only shows a summary of the results (how many of each type)
2013 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002014 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002015 make memcheck
2016}
2017
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002018component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002019 # Test that removing the deprecated features from the default
2020 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002021 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2022 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
2023 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
2024
2025 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2026 make test
2027}
2028
2029component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002030 msg "build: make, full_no_deprecated config" # ~ 30s
2031 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002032 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
2033
Gilles Peskine30de2e82020-04-20 21:39:22 +02002034 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002035 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002036
2037 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2038 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002039}
2040
Gilles Peskine8386ea22020-04-30 09:07:29 +02002041component_test_full_no_deprecated_deprecated_warning () {
2042 # Test that there is nothing deprecated in "full_no_deprecated".
2043 # A deprecated feature would trigger a warning (made fatal) from
2044 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002045 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2046 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002047 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2048 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
2049 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
2050
Gilles Peskine30de2e82020-04-20 21:39:22 +02002051 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002052 make test
2053}
2054
Gilles Peskine8386ea22020-04-30 09:07:29 +02002055component_test_full_deprecated_warning () {
2056 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2057 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002058 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002059 scripts/config.py full
2060 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002061 # Expect warnings from '#warning' directives in check_config.h.
2062 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002063
Gilles Peskine8386ea22020-04-30 09:07:29 +02002064 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2065 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2066 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002067 # Expect warnings from '#warning' directives in check_config.h and
2068 # from the use of deprecated functions in test suites.
2069 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 +01002070
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002071 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2072 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01002073}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002074
Gilles Peskineec541fe2020-01-31 14:24:14 +01002075# Check that the specified libraries exist and are empty.
2076are_empty_libraries () {
2077 nm "$@" >/dev/null 2>/dev/null
2078 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2079}
2080
2081component_build_crypto_default () {
2082 msg "build: make, crypto only"
2083 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002084 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002085 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002086}
2087
2088component_build_crypto_full () {
2089 msg "build: make, crypto only, full config"
2090 scripts/config.py crypto_full
Gilles Peskine6bb39152020-02-03 11:59:20 +01002091 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002092 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002093}
2094
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002095component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002096 msg "build: make, config for PSA crypto service"
2097 scripts/config.py crypto
2098 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2099 # Disable things that are not needed for just cryptography, to
2100 # reach a configuration that would be typical for a PSA cryptography
2101 # service providing all implemented PSA algorithms.
2102 # System stuff
2103 scripts/config.py unset MBEDTLS_ERROR_C
2104 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002105 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002106 # Crypto stuff with no PSA interface
2107 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002108 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002109 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002110 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002111 scripts/config.py unset MBEDTLS_NIST_KW_C
2112 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2113 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2114 scripts/config.py unset MBEDTLS_PKCS12_C
2115 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002116 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2117 # in PSA code to work with RSA keys. We don't require users to set those:
2118 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002119 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002120 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002121 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002122 make CFLAGS='-O1 -Werror' all test
2123 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2124}
2125
Gilles Peskineec541fe2020-01-31 14:24:14 +01002126component_build_crypto_baremetal () {
2127 msg "build: make, crypto only, baremetal config"
2128 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002129 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002130 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002131}
Daniel Axtens446af202020-09-02 21:30:13 +10002132support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002133 support_build_baremetal "$@"
2134}
2135
2136component_build_baremetal () {
2137 msg "build: make, baremetal config"
2138 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002139 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002140}
2141support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002142 # Older Glibc versions include time.h from other headers such as stdlib.h,
2143 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2144 # problem, Ubuntu 18.04 is ok.
2145 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2146}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002147
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002148# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002149component_test_depends_py_cipher_id () {
2150 msg "test/build: depends.py cipher_id (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002151 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002152}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002153
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002154component_test_depends_py_cipher_chaining () {
2155 msg "test/build: depends.py cipher_chaining (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002156 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002157}
2158
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002159component_test_depends_py_cipher_padding () {
2160 msg "test/build: depends.py cipher_padding (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002161 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002162}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002163
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002164component_test_depends_py_curves () {
2165 msg "test/build: depends.py curves (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002166 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002167}
2168
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002169component_test_depends_py_hashes () {
2170 msg "test/build: depends.py hashes (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002171 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002172}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002173
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002174component_test_depends_py_kex () {
2175 msg "test/build: depends.py kex (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002176 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002177}
2178
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002179component_test_depends_py_pkalgs () {
2180 msg "test/build: depends.py pkalgs (gcc)"
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002181 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002182}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002183
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002184# PSA equivalents of the depends.py tests
2185component_test_depends_py_cipher_id_psa () {
2186 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2187 tests/scripts/depends.py cipher_id
2188}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002189
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002190component_test_depends_py_cipher_chaining_psa () {
2191 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2192 tests/scripts/depends.py cipher_chaining
2193}
2194
2195component_test_depends_py_cipher_padding_psa () {
2196 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2197 tests/scripts/depends.py cipher_padding
2198}
2199
2200component_test_depends_py_curves_psa () {
2201 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2202 tests/scripts/depends.py curves
2203}
2204
2205component_test_depends_py_hashes_psa () {
2206 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2207 tests/scripts/depends.py hashes
2208}
2209
2210component_test_depends_py_kex_psa () {
2211 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
2212 tests/scripts/depends.py kex
2213}
2214
2215component_test_depends_py_pkalgs_psa () {
2216 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002217 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002218}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002219
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002220component_build_no_pk_rsa_alt_support () {
2221 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2222
2223 scripts/config.py full
2224 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2225 scripts/config.py set MBEDTLS_RSA_C
2226 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2227
2228 # Only compile - this is primarily to test for compile issues
2229 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
2230}
2231
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002232component_build_module_alt () {
2233 msg "build: MBEDTLS_XXX_ALT" # ~30s
2234 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002235
2236 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002237 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2238 scripts/config.py unset MBEDTLS_AESNI_C
2239 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002240 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002241 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2242 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002243 # You can only have one threading implementation: alt or pthread, not both.
2244 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002245 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2246 # directly and assumes the implementation works with partial groups.
2247 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00002248 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_A64_CRYPTO_*
2249 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2250 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002251 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2252 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2253 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002254
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002255 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2256 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2257 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002258 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002259
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002260 # We can only compile, not link, since we don't have any implementations
2261 # suitable for testing with the dummy alt headers.
2262 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
2263}
2264
2265component_build_dhm_alt () {
2266 msg "build: MBEDTLS_DHM_ALT" # ~30s
2267 scripts/config.py full
2268 scripts/config.py set MBEDTLS_DHM_ALT
2269 # debug.c currently references mbedtls_dhm_context fields directly.
2270 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002271 # We can only compile, not link, since we don't have any implementations
2272 # suitable for testing with the dummy alt headers.
2273 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
2274}
2275
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002276component_test_no_use_psa_crypto_full_cmake_asan() {
2277 # full minus MBEDTLS_USE_PSA_CRYPTO: run the same set of tests as basic-build-test.sh
Gilles Peskinedc3a1792019-09-03 11:42:04 +02002278 msg "build: cmake, full config minus MBEDTLS_USE_PSA_CRYPTO, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002279 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002280 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
2281 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002282 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002283 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002284 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002285 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002286 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002287 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Manuel Pégourié-Gonnardd8167e82019-02-01 11:12:52 +01002288 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002289 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002290
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002291 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002292 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002293
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002294 # Note: ssl-opt.sh has some test cases that depend on
2295 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2296 # This is the only component where those tests are not skipped.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002297 msg "test: ssl-opt.sh (full minus MBEDTLS_USE_PSA_CRYPTO)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002298 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002299
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002300 msg "test: compat.sh default (full minus MBEDTLS_USE_PSA_CRYPTO)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002301 tests/compat.sh
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002302
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002303 msg "test: compat.sh NULL (full minus MBEDTLS_USE_PSA_CRYPTO)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002304 env OPENSSL="$OPENSSL_LEGACY" GNUTLS_CLI="$GNUTLS_LEGACY_CLI" GNUTLS_SERV="$GNUTLS_LEGACY_SERV" tests/compat.sh -f 'NULL'
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002305
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002306 msg "test: compat.sh ARIA + ChachaPoly (full minus MBEDTLS_USE_PSA_CRYPTO)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002307 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002308}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002309
Ronald Cron403c15c2021-09-13 09:38:05 +02002310component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002311 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002312
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002313 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002314 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti0a342c92023-09-01 09:12:31 +02002315 $(helper_get_psa_key_type_list "ECC")"
Valerio Settib2fd6732023-08-15 17:10:47 +02002316
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002317 # Note: Those are handled in a special way by the libtestdriver machinery,
2318 # so we only want to include them in the accel list when building the main
2319 # libraries, hence the use of a separate variable.
Valerio Settib2fd6732023-08-15 17:10:47 +02002320 loc_curve_list="$(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002321
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002322 # Configure
2323 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002324
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002325 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002326 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard6d7db932022-12-28 09:48:01 +01002327 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002328
2329 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002330 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002331
2332 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002333 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2334 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2335
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002336 # Build
2337 # -----
2338
2339 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002340 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2341 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002342
2343 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2344
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002345 helper_libtestdriver1_make_main "$loc_accel_list $loc_curve_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002346
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002347 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002348 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002349
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002350 # Run the tests
2351 # -------------
2352
Ronald Cron403c15c2021-09-13 09:38:05 +02002353 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2354 make test
2355}
2356
Valerio Setti44b178c2023-03-22 14:02:57 +01002357component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002358 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002359
2360 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002361 loc_accel_list="ALG_ECDH \
Valerio Setti0a342c92023-09-01 09:12:31 +02002362 $(helper_get_psa_key_type_list "ECC")"
Valerio Settib2fd6732023-08-15 17:10:47 +02002363
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002364 # Note: Those are handled in a special way by the libtestdriver machinery,
2365 # so we only want to include them in the accel list when building the main
2366 # libraries, hence the use of a separate variable.
Valerio Settib2fd6732023-08-15 17:10:47 +02002367 loc_curve_list="$(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002368
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002369 # Configure
2370 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002371
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002372 # Start from default config (no TLS 1.3, no USE_PSA)
2373 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002374
Valerio Setti44b178c2023-03-22 14:02:57 +01002375 # Disable the module that's accelerated
2376 scripts/config.py unset MBEDTLS_ECDH_C
2377
2378 # Disable things that depend on it
2379 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2380 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2381 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2382 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2383 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2384
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002385 # Build
2386 # -----
2387
2388 helper_libtestdriver1_make_drivers "$loc_accel_list"
2389
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002390 helper_libtestdriver1_make_main "$loc_accel_list $loc_curve_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002391
Valerio Setti44b178c2023-03-22 14:02:57 +01002392 # Make sure this was not re-enabled by accident (additive config)
2393 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002394
2395 # Run the tests
2396 # -------------
2397
Valerio Setti44b178c2023-03-22 14:02:57 +01002398 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002399 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002400}
2401
Przemek Stekieldccb2022023-05-11 10:48:50 +02002402component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002403 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002404
2405 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002406 loc_accel_list="ALG_FFDH \
Valerio Setti0a342c92023-09-01 09:12:31 +02002407 $(helper_get_psa_key_type_list "DH")"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002408
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002409 # Configure
2410 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002411
Przemek Stekiel565353e2023-07-05 11:07:07 +02002412 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002413 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002414
2415 # Disable the module that's accelerated
2416 scripts/config.py unset MBEDTLS_DHM_C
2417
2418 # Disable things that depend on it
2419 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2420 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2421
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002422 # Build
2423 # -----
2424
2425 helper_libtestdriver1_make_drivers "$loc_accel_list"
2426
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002427 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002428
2429 # Make sure this was not re-enabled by accident (additive config)
2430 not grep mbedtls_dhm_ library/dhm.o
2431
2432 # Run the tests
2433 # -------------
2434
Gilles Peskine14302ed2023-07-19 19:30:04 +02002435 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002436 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002437
Gilles Peskine14302ed2023-07-19 19:30:04 +02002438 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002439 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002440}
2441
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002442component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002443 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002444
2445 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002446 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002447
2448 # Disable things that are not supported
2449 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2450 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002451 make
2452
Gilles Peskine14302ed2023-07-19 19:30:04 +02002453 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002454 make test
2455
Gilles Peskine14302ed2023-07-19 19:30:04 +02002456 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002457 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002458}
2459
Valerio Setti44b178c2023-03-22 14:02:57 +01002460component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002461 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002462
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002463 loc_accel_list="ALG_JPAKE \
2464 $(helper_get_psa_key_type_list "ECC")"
2465
2466 # Note: Those are handled in a special way by the libtestdriver machinery,
2467 # so we only want to include them in the accel list when building the main
2468 # libraries, hence the use of a separate variable.
2469 loc_curve_list="$(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002470
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002471 # Configure
2472 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002473
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002474 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002475
2476 # Make built-in fallback not available
2477 scripts/config.py unset MBEDTLS_ECJPAKE_C
2478 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2479
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002480 # Build
2481 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002482
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002483 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002484
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002485 helper_libtestdriver1_make_main "$loc_accel_list $loc_curve_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002486
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002487 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002488 not grep mbedtls_ecjpake_init library/ecjpake.o
2489
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002490 # Run the tests
2491 # -------------
2492
Gilles Peskine14302ed2023-07-19 19:30:04 +02002493 msg "test: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002494 make test
2495}
2496
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002497component_test_psa_crypto_config_accel_ecc_some_key_types () {
2498 msg "build: full with accelerated EC algs and some key types"
2499
2500 # Algorithms and key types to accelerate
2501 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2502 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2503 ALG_ECDH \
2504 ALG_JPAKE \
2505 KEY_TYPE_ECC_PUBLIC_KEY \
2506 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2507 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
2508 KEY_TYPE_ECC_KEY_PAIR_EXPORT"
2509
2510 # Note: Curves are handled in a special way by the libtestdriver machinery,
2511 # so we only want to include them in the accel list when building the main
2512 # libraries, hence the use of a separate variable.
2513 loc_curve_list="$(helper_get_psa_curve_list)"
2514
2515 # Configure
2516 # ---------
2517
2518 # start with config full for maximum coverage (also enables USE_PSA)
2519 helper_libtestdriver1_adjust_config "full"
2520
2521 # Disable modules that are accelerated - some will be re-enabled
2522 scripts/config.py unset MBEDTLS_ECDSA_C
2523 scripts/config.py unset MBEDTLS_ECDH_C
2524 scripts/config.py unset MBEDTLS_ECJPAKE_C
2525 scripts/config.py unset MBEDTLS_ECP_C
2526
2527 # Disable all curves - those that aren't accelerated should be re-enabled
2528 helper_disable_builtin_curves
2529
2530 # Restartable feature is not yet supported by PSA. Once it will in
2531 # the future, the following line could be removed (see issues
2532 # 6061, 6332 and following ones)
2533 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2534
2535 # this is not supported by the driver API yet
2536 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2537
2538 # Build
2539 # -----
2540
2541 # These hashes are needed for some ECDSA signature tests.
2542 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2543 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2544 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2545
2546 helper_libtestdriver1_make_main "$loc_accel_list $loc_curve_list"
2547
2548 # ECP should be re-enabled but not the others
2549 not grep mbedtls_ecdh_ library/ecdh.o
2550 not grep mbedtls_ecdsa library/ecdsa.o
2551 not grep mbedtls_ecjpake library/ecjpake.o
2552 grep mbedtls_ecp library/ecp.o
2553
2554 # Run the tests
2555 # -------------
2556
2557 msg "test suites: full with accelerated EC algs and some key types"
2558 make test
2559}
2560
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002561# Run tests with only (non-)Weierstrass accelerated
2562# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002563# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2564# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002565common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002566 weierstrass=$1
2567 if [ $weierstrass -eq 1 ]; then
2568 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002569 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002570 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002571 fi
2572
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002573 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002574
2575 # Algorithms and key types to accelerate
2576 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2577 ALG_ECDH \
2578 ALG_JPAKE \
2579 $(helper_get_psa_key_type_list "ECC")"
2580
2581 # Note: Curves are handled in a special way by the libtestdriver machinery,
2582 # so we only want to include them in the accel list when building the main
2583 # libraries, hence the use of a separate variable.
2584 # Note: the following loop is a modified version of
2585 # helper_get_psa_curve_list that only keeps Weierstrass families.
2586 loc_weierstrass_list=""
2587 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002588 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2589 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002590 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002591 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002592 ;;
2593 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002594 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002595 ;;
2596 esac
2597 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002598 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002599 loc_curve_list=$loc_weierstrass_list
2600 else
2601 loc_curve_list=$loc_non_weierstrass_list
2602 fi
2603
2604 # Configure
2605 # ---------
2606
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002607 # Start with config crypto_full and remove PK_C:
2608 # that's what's supported now, see docs/driver-only-builds.md.
2609 helper_libtestdriver1_adjust_config "crypto_full"
2610 scripts/config.py unset MBEDTLS_PK_C
2611 scripts/config.py unset MBEDTLS_PK_PARSE_C
2612 scripts/config.py unset MBEDTLS_PK_WRITE_C
2613 # We need to disable RSA too or PK will be re-enabled.
2614 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
2615 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_ALG_RSA_[0-9A-Z_a-z]*"
2616 scripts/config.py unset MBEDTLS_RSA_C
2617 scripts/config.py unset MBEDTLS_PKCS1_V15
2618 scripts/config.py unset MBEDTLS_PKCS1_V21
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002619
2620 # Disable modules that are accelerated - some will be re-enabled
2621 scripts/config.py unset MBEDTLS_ECDSA_C
2622 scripts/config.py unset MBEDTLS_ECDH_C
2623 scripts/config.py unset MBEDTLS_ECJPAKE_C
2624 scripts/config.py unset MBEDTLS_ECP_C
2625
2626 # Disable all curves - those that aren't accelerated should be re-enabled
2627 helper_disable_builtin_curves
2628
2629 # Restartable feature is not yet supported by PSA. Once it will in
2630 # the future, the following line could be removed (see issues
2631 # 6061, 6332 and following ones)
2632 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2633
2634 # this is not supported by the driver API yet
2635 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2636
2637 # Build
2638 # -----
2639
2640 # These hashes are needed for some ECDSA signature tests.
2641 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2642 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2643 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2644
2645 helper_libtestdriver1_make_main "$loc_accel_list $loc_curve_list"
2646
2647 # We expect ECDH to be re-enabled for the missing curves
2648 grep mbedtls_ecdh_ library/ecdh.o
2649 # We expect ECP to be re-enabled, however the parts specific to the
2650 # families of curves that are accelerated should be ommited.
2651 # - functions with mxz in the name are specific to Montgomery curves
2652 # - ecp_muladd is specific to Weierstrass curves
2653 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002654 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002655 not grep mbedtls_ecp_muladd library/ecp.o
2656 grep mxz library/ecp.o
2657 else
2658 grep mbedtls_ecp_muladd library/ecp.o
2659 not grep mxz library/ecp.o
2660 fi
2661 # We expect ECDSA and ECJPAKE to be re-enabled only when
2662 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002663 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002664 not grep mbedtls_ecdsa library/ecdsa.o
2665 not grep mbedtls_ecjpake library/ecjpake.o
2666 else
2667 grep mbedtls_ecdsa library/ecdsa.o
2668 grep mbedtls_ecjpake library/ecjpake.o
2669 fi
2670
2671 # Run the tests
2672 # -------------
2673
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002674 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2675 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002676}
2677
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002678component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002679 common_test_psa_crypto_config_accel_ecc_some_curves 1
2680}
2681
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002682component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002683 common_test_psa_crypto_config_accel_ecc_some_curves 0
2684}
2685
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002686# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2687# ECDH, ECDSA) with and without drivers.
2688# The input parameter is a boolean value which indicates:
2689# - 0 keep built-in EC algs,
2690# - 1 exclude built-in EC algs (driver only).
2691#
2692# This is used by the two following components to ensure they always use the
2693# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002694# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2695# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002696# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002697config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002698 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002699 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002700 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002701 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002702 # Disable modules that are accelerated
2703 scripts/config.py unset MBEDTLS_ECDSA_C
2704 scripts/config.py unset MBEDTLS_ECDH_C
2705 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002706 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002707 fi
2708
2709 # Restartable feature is not yet supported by PSA. Once it will in
2710 # the future, the following line could be removed (see issues
2711 # 6061, 6332 and following ones)
2712 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002713}
2714
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002715# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2716component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002717 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002718
2719 # Algorithms and key types to accelerate
2720 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2721 ALG_ECDH \
2722 ALG_JPAKE \
Valerio Setti0a342c92023-09-01 09:12:31 +02002723 $(helper_get_psa_key_type_list "ECC")"
Valerio Settib2fd6732023-08-15 17:10:47 +02002724
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002725 # Note: Those are handled in a special way by the libtestdriver machinery,
2726 # so we only want to include them in the accel list when building the main
2727 # libraries, hence the use of a separate variable.
Valerio Settib2fd6732023-08-15 17:10:47 +02002728 loc_curve_list="$(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002729
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002730 # Configure
2731 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002732
2733 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002734 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002735
Valerio Setti0a342c92023-09-01 09:12:31 +02002736 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002737 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2738 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
2739
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002740 # Build
2741 # -----
2742
2743 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002744 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2745 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002746 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2747
Valerio Settib2fd6732023-08-15 17:10:47 +02002748 helper_libtestdriver1_make_main "$loc_accel_list $loc_curve_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002749
2750 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
2751 not grep mbedtls_ecdsa_ library/ecdsa.o
2752 not grep mbedtls_ecdh_ library/ecdh.o
2753 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02002754 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002755
2756 # Run the tests
2757 # -------------
2758
Gilles Peskine14302ed2023-07-19 19:30:04 +02002759 msg "test suites: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002760 make test
2761
Gilles Peskine14302ed2023-07-19 19:30:04 +02002762 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002763 tests/ssl-opt.sh
2764}
2765
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002766# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2767component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002768 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002769
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002770 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002771
2772 make
2773
Gilles Peskine14302ed2023-07-19 19:30:04 +02002774 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002775 make test
2776
Gilles Peskine14302ed2023-07-19 19:30:04 +02002777 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002778 tests/ssl-opt.sh
2779}
2780
Valerio Settie618cb02023-04-12 14:59:16 +02002781# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002782# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2783# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002784# to ensure that both tests use the same underlying configuration when testing
2785# driver's coverage with analyze_outcomes.py.
2786#
2787# This functions accepts 1 boolean parameter as follows:
2788# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
2789# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
2790# - 0: include built-in implementation of EC algorithms.
2791#
2792# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
2793# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002794config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002795 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02002796 # start with full config for maximum coverage (also enables USE_PSA)
2797 helper_libtestdriver1_adjust_config "full"
2798
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002799 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02002800 # Disable modules that are accelerated
2801 scripts/config.py unset MBEDTLS_ECDSA_C
2802 scripts/config.py unset MBEDTLS_ECDH_C
2803 scripts/config.py unset MBEDTLS_ECJPAKE_C
2804 # Disable ECP module (entirely)
2805 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02002806 fi
2807
Valerio Settiaecd32c2023-06-14 10:42:31 +02002808 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
2809 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02002810 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02002811 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02002812
Valerio Settie618cb02023-04-12 14:59:16 +02002813 # Restartable feature is not yet supported by PSA. Once it will in
2814 # the future, the following line could be removed (see issues
2815 # 6061, 6332 and following ones)
2816 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02002817}
2818
2819# Build and test a configuration where driver accelerates all EC algs while
2820# all support and dependencies from ECP and ECP_LIGHT are removed on the library
2821# side.
2822#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002823# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
2824component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002825 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02002826
2827 # Algorithms and key types to accelerate
2828 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2829 ALG_ECDH \
2830 ALG_JPAKE \
Valerio Setti0a342c92023-09-01 09:12:31 +02002831 $(helper_get_psa_key_type_list "ECC")"
Valerio Settib2fd6732023-08-15 17:10:47 +02002832
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002833 # Note: Those are handled in a special way by the libtestdriver machinery,
2834 # so we only want to include them in the accel list when building the main
2835 # libraries, hence the use of a separate variable.
Valerio Settib2fd6732023-08-15 17:10:47 +02002836 loc_curve_list="$(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02002837
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002838 # Configure
2839 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002840
Valerio Settie618cb02023-04-12 14:59:16 +02002841 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002842 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02002843 # Disable all the builtin curves. All the required algs are accelerated.
2844 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02002845
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002846 # Build
2847 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02002848
2849 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002850 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
2851 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2852 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02002853
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02002854 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02002855
Valerio Settib2fd6732023-08-15 17:10:47 +02002856 helper_libtestdriver1_make_main "$loc_accel_list $loc_curve_list"
Valerio Settie618cb02023-04-12 14:59:16 +02002857
2858 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
2859 not grep mbedtls_ecdsa_ library/ecdsa.o
2860 not grep mbedtls_ecdh_ library/ecdh.o
2861 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02002862 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02002863 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02002864
2865 # Run the tests
2866 # -------------
2867
Gilles Peskine14302ed2023-07-19 19:30:04 +02002868 msg "test: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02002869 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02002870
Gilles Peskine14302ed2023-07-19 19:30:04 +02002871 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02002872 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02002873}
2874
2875# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002876# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02002877# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002878component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002879 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02002880
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002881 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02002882
2883 make
2884
Gilles Peskine14302ed2023-07-19 19:30:04 +02002885 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02002886 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02002887
Gilles Peskine14302ed2023-07-19 19:30:04 +02002888 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02002889 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02002890}
2891
Valerio Setti4e2f2442023-08-15 10:10:26 +02002892# This is a common configuration helper used directly from:
2893# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
2894# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
2895# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02002896# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02002897# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02002898# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02002899# - this is the reference component of the above
2900# - it still disables RSA and FFDH, but it uses builtin EC algs
2901# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
2902# - accelerate all EC and FFDH algs, disable only RSA
2903# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
2904# - this is the reference component of the above
2905# - it still disables RSA, but it uses builtin EC and FFDH algs
2906#
2907# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02002908# $1: a boolean value which states if we are testing an accelerated scenario
2909# or not.
2910# $2: a string value which states which components are tested. Allowed values
2911# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02002912config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002913 driver_only="$1"
2914 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02002915 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02002916 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02002917
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002918 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02002919 # Disable modules that are accelerated
2920 scripts/config.py unset MBEDTLS_ECDSA_C
2921 scripts/config.py unset MBEDTLS_ECDH_C
2922 scripts/config.py unset MBEDTLS_ECJPAKE_C
2923 # Disable ECP module (entirely)
2924 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02002925 # Also disable bignum
2926 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02002927 fi
2928
2929 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
2930 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
2931 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
2932 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2933
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02002934 # RSA support is intentionally disabled on this test because RSA_C depends
2935 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02002936 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
2937 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 +02002938 scripts/config.py unset MBEDTLS_RSA_C
2939 scripts/config.py unset MBEDTLS_PKCS1_V15
2940 scripts/config.py unset MBEDTLS_PKCS1_V21
2941 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
2942 # Also disable key exchanges that depend on RSA
2943 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
2944 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
2945 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2946 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2947 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2948
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002949 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02002950 # When testing ECC only, we disable FFDH support, both from builtin and
2951 # PSA sides, and also disable the key exchanges that depend on DHM.
2952 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
2953 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_DH_[0-9A-Z_a-z]*"
2954 scripts/config.py unset MBEDTLS_DHM_C
2955 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2956 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2957 else
2958 # When testing ECC and DH instead, we disable DHM and depending key
2959 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002960 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02002961 scripts/config.py unset MBEDTLS_DHM_C
2962 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2963 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2964 fi
2965 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02002966
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02002967 # Restartable feature is not yet supported by PSA. Once it will in
2968 # the future, the following line could be removed (see issues
2969 # 6061, 6332 and following ones)
2970 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2971}
2972
Valerio Setti4e2f2442023-08-15 10:10:26 +02002973# Common helper used by:
2974# - component_test_psa_crypto_config_accel_ecc_no_bignum
2975# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02002976#
Valerio Setti4e2f2442023-08-15 10:10:26 +02002977# The goal is to build and test accelerating either:
2978# - ECC only or
2979# - both ECC and FFDH
2980#
2981# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02002982# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
2983# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02002984common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002985 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02002986
Valerio Setti5dfaca42023-09-05 08:48:51 +02002987 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002988 if [ "$test_target" = "ECC_DH" ]; then
2989 accel_text="ECC/FFDH"
2990 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02002991 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002992 accel_text="ECC"
2993 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02002994 fi
2995
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002996 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02002997
2998 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02002999 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3000 ALG_ECDH \
3001 ALG_JPAKE \
Valerio Setti0a342c92023-09-01 09:12:31 +02003002 $(helper_get_psa_key_type_list "ECC")"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003003 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003004 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003005 loc_accel_list="$loc_accel_list \
3006 ALG_FFDH \
Manuel Pégourié-Gonnard85ff5e62023-09-22 09:05:48 +02003007 $(helper_get_psa_key_type_list "DH")"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003008 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003009
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02003010 # Note: Those are handled in a special way by the libtestdriver machinery,
3011 # so we only want to include them in the accel list when building the main
3012 # libraries, hence the use of a separate variable.
Valerio Settib2fd6732023-08-15 17:10:47 +02003013 loc_curve_list="$(helper_get_psa_curve_list)"
3014
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003015 # Configure
3016 # ---------
3017
3018 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003019 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003020 # Disable all the builtin curves. All the required algs are accelerated.
3021 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003022
3023 # Build
3024 # -----
3025
3026 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003027 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3028 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3029 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003030
3031 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3032
Valerio Settib2fd6732023-08-15 17:10:47 +02003033 helper_libtestdriver1_make_main "$loc_accel_list $loc_curve_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003034
3035 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3036 not grep mbedtls_ecdsa_ library/ecdsa.o
3037 not grep mbedtls_ecdh_ library/ecdh.o
3038 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003039 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003040 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003041 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003042 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003043 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003044
3045 # Run the tests
3046 # -------------
3047
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003048 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003049
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003050 make test
3051
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003052 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003053 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003054}
3055
Valerio Setti4e2f2442023-08-15 10:10:26 +02003056# Common helper used by:
3057# - component_test_psa_crypto_config_reference_ecc_no_bignum
3058# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3059#
3060# The goal is to build and test a reference scenario (i.e. with builtin
3061# components) compared to the ones used in
3062# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3063#
3064# It is meant to be used in conjunction with
3065# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3066# coverage analysis in "analyze_outcomes.py" script.
3067common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003068 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003069
Valerio Setti5dfaca42023-09-05 08:48:51 +02003070 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003071 if [ "$test_target" = "ECC_DH" ]; then
3072 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003073 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003074 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003075 fi
3076
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003077 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003078
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003079 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003080
3081 make
3082
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003083 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003084 make test
3085
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003086 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003087 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003088}
3089
Valerio Setti4e2f2442023-08-15 10:10:26 +02003090component_test_psa_crypto_config_accel_ecc_no_bignum () {
3091 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3092}
3093
3094component_test_psa_crypto_config_reference_ecc_no_bignum () {
3095 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3096}
3097
3098component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3099 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3100}
3101
3102component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3103 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3104}
3105
Valerio Settiac6d35f2023-08-04 12:49:11 +02003106# Helper for setting common configurations between:
3107# - component_test_tfm_config_p256m_driver_accel_ec()
3108# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003109common_tfm_config () {
3110 # Enable TF-M config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003111 cp configs/tfm_mbedcrypto_config_profile_medium.h "$CONFIG_H"
3112 cp configs/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
3113
Valerio Setti52ba0e32023-08-04 12:43:03 +02003114 # Adjust for the fact that we're building outside the TF-M environment.
3115 #
3116 # TF-M has separation, our build doesn't
3117 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SPM
3118 scripts/config.py unset MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
3119 # TF-M provdes its own (dummy) implemenation, from their tree
3120 scripts/config.py unset MBEDTLS_AES_DECRYPT_ALT
3121 scripts/config.py unset MBEDTLS_AES_SETKEY_DEC_ALT
3122 # We have an OS that provides entropy, use it
3123 scripts/config.py unset MBEDTLS_NO_PLATFORM_ENTROPY
3124
3125 # Other config adjustments to make the tests pass.
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003126 # Those should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003127 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003128 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3129 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003130 # pkparse.c and pkwrite.c fail to link without this
3131 echo "#define MBEDTLS_OID_C" >> "$CONFIG_H"
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003132 # - ASN1_[PARSE/WRITE]_C found by check_config.h for pkparse/pkwrite
3133 echo "#define MBEDTLS_ASN1_PARSE_C" >> "$CONFIG_H"
3134 echo "#define MBEDTLS_ASN1_WRITE_C" >> "$CONFIG_H"
3135 # - MD_C for HKDF_C
3136 echo "#define MBEDTLS_MD_C" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003137
Manuel Pégourié-Gonnardf7298cd2023-09-18 09:55:24 +02003138 # Config adjustments for better test coverage in our environment.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003139 # These are not needed just to build and pass tests.
3140 #
3141 # Enable filesystem I/O for the benefit of PK parse/write tests.
3142 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003143 # Disable this for maximal ASan efficiency
3144 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
3145
Manuel Pégourié-Gonnardf7298cd2023-09-18 09:55:24 +02003146 # Config adjustments for features that are not supported
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003147 # when using only drivers / by p256-m
3148 #
3149 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3150 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3151 # Disable deterministic ECDSA as p256-m only does randomized
3152 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3153
Valerio Setti52ba0e32023-08-04 12:43:03 +02003154}
3155
Valerio Settiac6d35f2023-08-04 12:49:11 +02003156# Keep this in sync with component_test_tfm_config() as they are both meant
3157# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003158component_test_tfm_config_p256m_driver_accel_ec () {
3159 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3160
3161 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003162
Valerio Settic5c4bd22023-08-03 14:28:20 +02003163 # Build crypto library specifying we want to use P256M code for EC operations
Manuel Pégourié-Gonnardeda70862023-09-22 12:17:50 +02003164 make CFLAGS="$ASAN_CFLAGS -DMBEDTLS_PSA_P256M_DRIVER_ENABLED -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard3c4f3442023-09-22 09:20:42 +02003165
Valerio Settic5c4bd22023-08-03 14:28:20 +02003166 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003167 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settic5c4bd22023-08-03 14:28:20 +02003168 not grep mbedtls_ecdh_ library/ecdh.o
3169 not grep mbedtls_ecjpake_ library/ecjpake.o
3170 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003171 not grep mbedtls_ecp_ library/ecp.o
Valerio Settic5c4bd22023-08-03 14:28:20 +02003172 not grep mbedtls_rsa_ library/rsa.o
3173 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003174 not grep mbedtls_mpi_ library/bignum.o
Valerio Settic5c4bd22023-08-03 14:28:20 +02003175
3176 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003177 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003178 make test
Valerio Setti52ba0e32023-08-04 12:43:03 +02003179}
Valerio Settic5c4bd22023-08-03 14:28:20 +02003180
Valerio Settiac6d35f2023-08-04 12:49:11 +02003181# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3182# they are both meant to be used in analyze_outcomes.py for driver's coverage
3183# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003184component_test_tfm_config() {
3185 common_tfm_config
3186
3187 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003188 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003189
3190 msg "test: TF-M config"
3191 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003192}
3193
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003194# Common helper for component_full_without_ecdhe_ecdsa() and
3195# component_full_without_ecdhe_ecdsa_and_tls13() which:
3196# - starts from the "full" configuration minus the list of symbols passed in
3197# as 1st parameter
3198# - build
3199# - test only TLS (i.e. test_suite_tls and ssl-opt)
3200build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003201 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003202
3203 msg "build: full minus something, test TLS"
3204
3205 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003206 for sym in $symbols_to_disable; do
3207 echo "Disabling $sym"
3208 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003209 done
3210
3211 make
3212
3213 msg "test: full minus something, test TLS"
3214 ( cd tests; ./test_suite_ssl )
3215
3216 msg "ssl-opt: full minus something, test TLS"
3217 tests/ssl-opt.sh
3218}
3219
3220component_full_without_ecdhe_ecdsa () {
3221 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
3222}
3223
3224component_full_without_ecdhe_ecdsa_and_tls13 () {
3225 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3226 MBEDTLS_SSL_PROTO_TLS1_3"
3227}
3228
Valerio Setti249b18a2023-06-20 12:08:30 +02003229# This is an helper used by:
3230# - component_test_psa_ecc_key_pair_no_derive
3231# - component_test_psa_ecc_key_pair_no_generate
3232# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3233# enabled, but one. Input arguments are as follows:
3234# - $1 is the key type under test, i.e. ECC/RSA/DH
3235# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003236build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003237 key_type=$1
3238 unset_option=$2
3239 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003240
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003241 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003242 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003243 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3244 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3245
3246 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3247 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003248 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003249
Valerio Settif6587be2023-06-22 11:33:14 +02003250 make CC=gcc CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003251
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003252 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003253 make test
3254}
3255
3256component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003257 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003258}
3259
3260component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003261 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003262}
3263
Ronald Cron403c15c2021-09-13 09:38:05 +02003264component_test_psa_crypto_config_accel_rsa_signature () {
3265 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated RSA signature"
3266
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003267 loc_accel_list="ALG_RSA_PKCS1V15_SIGN ALG_RSA_PSS KEY_TYPE_RSA_KEY_PAIR KEY_TYPE_RSA_PUBLIC_KEY"
3268
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003269 # Configure
3270 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003271
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003272 # Start from default config (no TLS 1.3, no USE_PSA)
3273 helper_libtestdriver1_adjust_config "default"
Ronald Cron403c15c2021-09-13 09:38:05 +02003274
3275 # It seems it is not possible to remove only the support for RSA signature
3276 # in the library. Thus we have to remove all RSA support (signature and
3277 # encryption/decryption). AS there is no driver support for asymmetric
3278 # encryption/decryption so far remove RSA encryption/decryption from the
3279 # application algorithm list.
Ronald Cron6b49b552023-07-20 09:57:54 +02003280 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
3281 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
Ronald Cron403c15c2021-09-13 09:38:05 +02003282
Manuel Pégourié-Gonnardaed1d782023-06-12 17:22:24 +02003283 # Remove RSA support and its dependencies
3284 scripts/config.py unset MBEDTLS_RSA_C
3285 scripts/config.py unset MBEDTLS_PKCS1_V15
3286 scripts/config.py unset MBEDTLS_PKCS1_V21
3287 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3288 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3289 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3290 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3291 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3292 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3293
Ronald Cron403c15c2021-09-13 09:38:05 +02003294 # Make sure both the library and the test library support the SHA hash
3295 # algorithms and only those ones (SHA256 is included by default). That way:
3296 # - the test library can compute the RSA signatures even in the case of a
3297 # composite RSA signature algorithm based on a SHA hash (no other hash
3298 # used in the unit tests).
3299 # - the dependency of RSA signature tests on PSA_WANT_ALG_SHA_xyz is
3300 # fulfilled as the hash SHA algorithm is supported by the library, and
3301 # thus the tests are run, not skipped.
3302 # - when testing a signature key with an algorithm wildcard built from
3303 # PSA_ALG_ANY_HASH as algorithm to test with the key, the chosen hash
3304 # algorithm based on the hashes supported by the library is also
3305 # supported by the test library.
Manuel Pégourié-Gonnardaed1d782023-06-12 17:22:24 +02003306 # Disable unwanted hashes here, we'll enable hashes we want in loc_extra_list.
Ronald Cron6b49b552023-07-20 09:57:54 +02003307 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3308 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160_C
Ronald Cron403c15c2021-09-13 09:38:05 +02003309 scripts/config.py unset MBEDTLS_MD5_C
3310 scripts/config.py unset MBEDTLS_RIPEMD160_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003311
3312 # We need PEM parsing in the test library as well to support the import
3313 # of PEM encoded RSA keys.
Ronald Cron7612d8c2023-07-20 10:03:54 +02003314 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3315 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003316
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003317 # Build
3318 # -----
3319
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003320 # These hashes are needed for some RSA-PSS signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003321 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3322 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003323 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003324
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003325 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003326
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003327 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01003328 not grep mbedtls_rsa_rsassa_pkcs1_v15_sign library/rsa.o
3329 not grep mbedtls_rsa_rsassa_pss_sign_ext library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003330
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003331 # Run the tests
3332 # -------------
3333
Ronald Cron403c15c2021-09-13 09:38:05 +02003334 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated RSA signature"
3335 make test
3336}
3337
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003338# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003339# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003340component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003341 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003342
Valerio Setti4590bc22023-06-13 15:39:23 +02003343 # Create a temporary output file unless there is already one set
3344 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3345 REMOVE_OUTCOME_ON_EXIT="no"
3346 else
3347 REMOVE_OUTCOME_ON_EXIT="yes"
3348 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3349 export MBEDTLS_TEST_OUTCOME_FILE
3350 fi
3351
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003352 # Start from crypto configuration
3353 scripts/config.py crypto
3354
3355 # Remove RSA support and its dependencies
3356 scripts/config.py unset MBEDTLS_PKCS1_V15
3357 scripts/config.py unset MBEDTLS_PKCS1_V21
3358 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3359 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3360 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3361 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3362 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3363 scripts/config.py unset MBEDTLS_RSA_C
3364 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3365
3366 # Enable PSA support
3367 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3368
Valerio Setti01cc88a2023-06-15 11:53:08 +02003369 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003370 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003371 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3372 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3373 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003374
3375 make
3376
Valerio Setti01cc88a2023-06-15 11:53:08 +02003377 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003378 make test
3379
3380 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3381 # performing RSA signature.
3382 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3383 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3384
3385 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3386 rm $MBEDTLS_TEST_OUTCOME_FILE
3387 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003388}
3389
Ronald Cronb2312452021-05-08 14:32:59 +02003390component_test_psa_crypto_config_accel_hash () {
3391 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3392
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003393 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3394 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3395 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003396
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003397 # Configure
3398 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003399
3400 # Start from default config (no TLS 1.3, no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003401 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003402
3403 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003404 scripts/config.py unset MBEDTLS_MD5_C
3405 scripts/config.py unset MBEDTLS_RIPEMD160_C
3406 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003407 scripts/config.py unset MBEDTLS_SHA224_C
3408 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003409 scripts/config.py unset MBEDTLS_SHA384_C
3410 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003411 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003412
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003413 # Build
3414 # -----
3415
3416 helper_libtestdriver1_make_drivers "$loc_accel_list"
3417
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003418 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003419
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003420 # There's a risk of something getting re-enabled via config_psa.h;
3421 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3422 not grep mbedtls_md5 library/md5.o
3423 not grep mbedtls_sha1 library/sha1.o
3424 not grep mbedtls_sha256 library/sha256.o
3425 not grep mbedtls_sha512 library/sha512.o
3426 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003427
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003428 # Run the tests
3429 # -------------
3430
Ronald Cronb2312452021-05-08 14:32:59 +02003431 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3432 make test
3433}
3434
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003435component_test_psa_crypto_config_accel_hash_keep_builtins () {
3436 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3437 # This component ensures that all the test cases for
3438 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3439
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003440 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3441 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3442 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003443
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003444 # Start from default config (no TLS 1.3, no USE_PSA)
3445 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003446
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003447 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003448
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003449 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003450
3451 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3452 make test
3453}
3454
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003455# Auxiliary function to build config for hashes with and without drivers
3456config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003457 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003458 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003459 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003460 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003461 # disable the built-in implementation of hashes
3462 scripts/config.py unset MBEDTLS_MD5_C
3463 scripts/config.py unset MBEDTLS_RIPEMD160_C
3464 scripts/config.py unset MBEDTLS_SHA1_C
3465 scripts/config.py unset MBEDTLS_SHA224_C
3466 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
3467 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3468 scripts/config.py unset MBEDTLS_SHA384_C
3469 scripts/config.py unset MBEDTLS_SHA512_C
3470 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003471 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003472 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003473}
3474
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003475# Note that component_test_psa_crypto_config_reference_hash_use_psa
3476# is related to this component and both components need to be kept in sync.
3477# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003478component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003479 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003480
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003481 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3482 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3483 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003484
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003485 # Configure
3486 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003487
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003488 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003489
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003490 # Build
3491 # -----
3492
3493 helper_libtestdriver1_make_drivers "$loc_accel_list"
3494
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003495 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003496
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003497 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003498 # 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 +02003499 not grep mbedtls_md5 library/md5.o
3500 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003501 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003502 not grep mbedtls_sha512 library/sha512.o
3503 not grep mbedtls_ripemd160 library/ripemd160.o
3504
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003505 # Run the tests
3506 # -------------
3507
Gilles Peskine14302ed2023-07-19 19:30:04 +02003508 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003509 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003510
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003511 # This is mostly useful so that we can later compare outcome files with
3512 # the reference config in analyze_outcomes.py, to check that the
3513 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003514 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003515 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003516
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003517 # This is to make sure all ciphersuites are exercised, but we don't need
3518 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003519 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003520 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003521}
3522
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003523# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3524# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3525# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3526# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003527component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003528 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003529
3530 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003531
Przemek Stekielab0451b2022-10-24 11:29:35 +02003532 make
3533
Gilles Peskine14302ed2023-07-19 19:30:04 +02003534 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003535 make test
3536
Gilles Peskine14302ed2023-07-19 19:30:04 +02003537 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003538 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003539}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003540
John Durkop4377bf72020-10-23 01:26:57 -07003541component_test_psa_crypto_config_accel_cipher () {
3542 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated cipher"
3543
3544 loc_accel_list="ALG_CBC_NO_PADDING ALG_CBC_PKCS7 ALG_CTR ALG_CFB ALG_OFB ALG_XTS KEY_TYPE_DES"
John Durkop1b7ee052020-11-27 08:51:22 -08003545
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003546 # Configure
3547 # ---------
John Durkop1b7ee052020-11-27 08:51:22 -08003548
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003549 # Start from the default config (no TLS 1.3, no USE_PSA)
3550 helper_libtestdriver1_adjust_config "default"
John Durkop1b7ee052020-11-27 08:51:22 -08003551
Manuel Pégourié-Gonnard7ae342f2023-06-08 09:26:04 +02003552 # There is no intended accelerator support for ALG CMAC. Therefore, asking
3553 # for it in the build implies the inclusion of the Mbed TLS cipher
3554 # operations. As we want to test here with cipher operations solely
3555 # supported by accelerators, disabled this PSA configuration option.
3556 # (Note: the same applies to STREAM_CIPHER and ECB_NO_PADDING, which are
3557 # already disabled by helper_libtestdriver1_adjust_config above.)
Ronald Cron6b49b552023-07-20 09:57:54 +02003558 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
John Durkop1b7ee052020-11-27 08:51:22 -08003559
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003560 # Disable the things that are being accelerated
John Durkop1b7ee052020-11-27 08:51:22 -08003561 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3562 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3563 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3564 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3565 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3566 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3567 scripts/config.py unset MBEDTLS_DES_C
3568
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003569 # Build
3570 # -----
John Durkop1b7ee052020-11-27 08:51:22 -08003571
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003572 helper_libtestdriver1_make_drivers "$loc_accel_list"
3573
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003574 helper_libtestdriver1_make_main "$loc_accel_list"
John Durkop1b7ee052020-11-27 08:51:22 -08003575
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003576 # Make sure this was not re-enabled by accident (additive config)
John Durkop1b7ee052020-11-27 08:51:22 -08003577 not grep mbedtls_des* library/des.o
3578
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003579 # Run the tests
3580 # -------------
3581
John Durkop1b7ee052020-11-27 08:51:22 -08003582 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated cipher"
3583 make test
3584}
3585
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003586component_test_psa_crypto_config_accel_aead () {
3587 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3588
Przemek Stekielee1bb412022-10-11 11:52:25 +02003589 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003590
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003591 # Configure
3592 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003593
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003594 # Start from default config (no TLS 1.3, no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003595 helper_libtestdriver1_adjust_config "default"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003596
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003597 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003598 scripts/config.py unset MBEDTLS_GCM_C
3599 scripts/config.py unset MBEDTLS_CCM_C
3600 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
3601 # Features that depend on AEAD
3602 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel072fad12022-10-13 09:59:52 +02003603 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003604
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003605 # Build
3606 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003607
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003608 helper_libtestdriver1_make_drivers "$loc_accel_list"
3609
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003610 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003611
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003612 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003613 not grep mbedtls_ccm library/ccm.o
3614 not grep mbedtls_gcm library/gcm.o
3615 not grep mbedtls_chachapoly library/chachapoly.o
3616
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003617 # Run the tests
3618 # -------------
3619
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003620 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3621 make test
3622}
3623
Gilles Peskine36dea152023-07-20 22:19:45 +02003624component_test_aead_chachapoly_disabled() {
3625 msg "build: full minus CHACHAPOLY"
John Durkopf4c4cb02020-10-28 20:09:55 -07003626 scripts/config.py full
John Durkop9814fa22020-11-04 12:28:15 -08003627 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02003628 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
John Durkopf4c4cb02020-10-28 20:09:55 -07003629 make CC=gcc CFLAGS="$ASAN_CFLAGS -O2" LDFLAGS="$ASAN_CFLAGS"
John Durkop6ba40d12020-11-10 08:50:04 -08003630
Gilles Peskine36dea152023-07-20 22:19:45 +02003631 msg "test: full minus CHACHAPOLY"
3632 make test
3633}
3634
3635component_test_aead_only_ccm() {
3636 msg "build: full minus CHACHAPOLY and GCM"
3637 scripts/config.py full
3638 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
3639 scripts/config.py unset MBEDTLS_GCM_C
3640 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
3641 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
3642 make CC=gcc CFLAGS="$ASAN_CFLAGS -O2" LDFLAGS="$ASAN_CFLAGS"
3643
3644 msg "test: full minus CHACHAPOLY and GCM"
John Durkop9814fa22020-11-04 12:28:15 -08003645 make test
John Durkopf4c4cb02020-10-28 20:09:55 -07003646}
3647
Ronald Crone501d0e2023-07-10 08:31:19 +02003648component_test_ccm_aes_sha256() {
3649 msg "build: CCM + AES + SHA256 configuration"
3650
Ronald Cron7612d8c2023-07-20 10:03:54 +02003651 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02003652 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02003653
3654 make CC=gcc
3655
3656 msg "test: CCM + AES + SHA256 configuration"
3657 make test
3658}
3659
John Durkop9814fa22020-11-04 12:28:15 -08003660# This should be renamed to test and updated once the accelerator ECDH code is in place and ready to test.
John Durkopf4c4cb02020-10-28 20:09:55 -07003661component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003662 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07003663 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07003664 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003665 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07003666 scripts/config.py unset MBEDTLS_ECDH_C
3667 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3668 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
3669 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3670 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3671 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
3672 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
John Durkop6ba40d12020-11-10 08:50:04 -08003673 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_ECDH -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07003674}
3675
John Durkop1b7ee052020-11-27 08:51:22 -08003676# This should be renamed to test and updated once the accelerator HMAC code is in place and ready to test.
3677component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003678 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkop1b7ee052020-11-27 08:51:22 -08003679 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003680 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003681 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkop1b7ee052020-11-27 08:51:22 -08003682 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3683 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HMAC -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3684}
3685
3686# This should be renamed to test and updated once the accelerator HKDF code is in place and ready to test.
3687component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003688 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkop1b7ee052020-11-27 08:51:22 -08003689 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003690 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003691 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkop1b7ee052020-11-27 08:51:22 -08003692 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01003693 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
3694 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkop1b7ee052020-11-27 08:51:22 -08003695 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3696 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HKDF -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3697}
3698
3699# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
3700component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003701 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003702 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003703 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003704 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003705 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3706 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3707 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3708 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3709 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3710 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3711 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003712 scripts/config.py unset MBEDTLS_LMS_C
3713 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003714 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3715 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_MD5 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3716}
3717
3718# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
3719component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003720 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003721 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003722 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003723 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003724 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3725 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3726 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3727 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3728 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3729 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3730 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003731 scripts/config.py unset MBEDTLS_LMS_C
3732 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003733 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3734 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RIPEMD160 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3735}
3736
3737# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
3738component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003739 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003740 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003741 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003742 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003743 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3744 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3745 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3746 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3747 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3748 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3749 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003750 scripts/config.py unset MBEDTLS_LMS_C
3751 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003752 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3753 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_1 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3754}
3755
3756# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
3757component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003758 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003759 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003760 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003761 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003762 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3763 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3764 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3765 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3766 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3767 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08003768 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3769 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_224 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3770}
3771
3772# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
3773component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003774 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003775 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003776 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003777 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003778 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3779 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3780 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3781 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3782 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3783 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08003784 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3785 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_256 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3786}
3787
3788# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
3789component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003790 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003791 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003792 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003793 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003794 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3795 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3796 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3797 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3798 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3799 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003800 scripts/config.py unset MBEDTLS_LMS_C
3801 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003802 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3803 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_384 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3804}
3805
3806# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
3807component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003808 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003809 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003810 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003811 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003812 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3813 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3814 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3815 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3816 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3817 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3818 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003819 scripts/config.py unset MBEDTLS_LMS_C
3820 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003821 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3822 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_512 -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3823}
3824
John Durkopd0321952020-10-29 21:37:36 -07003825# 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 -08003826component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003827 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 -07003828 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07003829 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003830 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003831 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
3832 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
3833 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
3834 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07003835 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
John Durkopbd069d32020-10-31 22:14:03 -07003836 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_CRYPT -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3837}
3838
3839# 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 -08003840component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003841 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 -07003842 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07003843 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003844 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003845 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
3846 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
3847 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
3848 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07003849 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3850 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_SIGN -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3851}
3852
3853# 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 -08003854component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003855 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 -07003856 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07003857 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003858 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003859 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
3860 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
3861 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
3862 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07003863 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3864 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_OAEP -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3865}
3866
3867# 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 -08003868component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003869 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 -07003870 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07003871 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003872 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003873 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
3874 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
3875 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
3876 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07003877 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3878 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PSS -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3879}
3880
3881# 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 -08003882component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003883 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 -07003884 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07003885 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003886 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003887 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
3888 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
3889 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
3890 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
3891 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07003892 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3893 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_KEY_PAIR -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
3894}
3895
3896# 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 -08003897component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003898 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 -07003899 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07003900 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003901 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003902 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
3903 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07003904 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
3905 make CC=gcc CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_PUBLIC_KEY -I../tests/include -O2" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07003906}
3907
Dave Rodgmanc164c072023-06-28 09:43:23 +01003908
Dave Rodgman904c5892023-06-28 17:36:02 +01003909support_build_tfm_armcc () {
Dave Rodgmanc164c072023-06-28 09:43:23 +01003910 armc6_cc="$ARMC6_BIN_DIR/armclang"
3911 (check_tools "$armc6_cc" > /dev/null 2>&1)
3912}
3913
Dave Rodgman904c5892023-06-28 17:36:02 +01003914component_build_tfm_armcc() {
3915 # test the TF-M configuration can build cleanly with various warning flags enabled
Ronald Cron7a93ac52023-07-20 09:49:12 +02003916 cp configs/tfm_mbedcrypto_config_profile_medium.h "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02003917 cp configs/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01003918
Dave Rodgman88651c42023-06-29 12:35:51 +01003919 msg "build: TF-M config, armclang armv7-m thumb2"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01003920 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003921 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 +01003922}
3923
3924component_build_tfm() {
3925 # test the TF-M configuration can build cleanly with various warning flags enabled
Ronald Cron7a93ac52023-07-20 09:49:12 +02003926 cp configs/tfm_mbedcrypto_config_profile_medium.h "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02003927 cp configs/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01003928
Dave Rodgman88651c42023-06-29 12:35:51 +01003929 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003930 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 +01003931
Dave Rodgman904c5892023-06-28 17:36:02 +01003932 msg "build: TF-M config, gcc native build"
3933 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003934 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 +01003935}
3936
Dave Rodgman920343a2023-10-01 18:41:09 +01003937build_test_config_combos() {
3938 # test that the given file builds with all (valid) combinations of the given options.
3939 # syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
3940 # The validator function may be "" if all combinations are valid
Dave Rodgmancd040202023-06-29 09:29:00 +01003941
Dave Rodgman28e38d82023-10-04 11:50:30 +01003942 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01003943 shift
3944 # this function must echo something iff the clang "-DA -DB ..." string is invalid
Dave Rodgman28e38d82023-10-04 11:50:30 +01003945 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01003946 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01003947 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01003948
Dave Rodgman42436102023-10-03 15:47:05 +01003949 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01003950 for opt in "${options[@]}"; do
3951 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01003952 done
3953
3954 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01003955 cd $(dirname ${file})
3956 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01003957
Dave Rodgman920343a2023-10-01 18:41:09 +01003958 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01003959 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 +01003960
Dave Rodgman42436102023-10-03 15:47:05 +01003961 # Extract the command generated by the Makefile to build the target file.
3962 # This ensures that we have any include paths, macro definitions, etc
3963 # that may be applied by make.
3964 # Add -fsyntax-only as we only want a syntax check and don't need to generate a file.
Dave Rodgman28e38d82023-10-04 11:50:30 +01003965 compile_cmd=$(make -B -n ${file} CC=clang CFLAGS="${warning_flags} -fsyntax-only" | egrep "^clang")
Dave Rodgman42436102023-10-03 15:47:05 +01003966
Dave Rodgman28e38d82023-10-04 11:50:30 +01003967 makefile=$(mktemp)
3968 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01003969
Dave Rodgman28e38d82023-10-04 11:50:30 +01003970 len=${#options[@]}
Dave Rodgman97285622023-09-29 17:32:06 +01003971
Dave Rodgman28e38d82023-10-04 11:50:30 +01003972 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01003973 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01003974 # each bit of $i is used to determine if options[i] will be set or not
3975 target="t"
3976 clang_args=""
3977 for ((j = 0; j < ${len}; j++)); do
3978 opt=${options[j]}
Dave Rodgman920343a2023-10-01 18:41:09 +01003979 X=$(((i >> j) & 1))
Dave Rodgman28e38d82023-10-04 11:50:30 +01003980 [[ $X == 0 ]] && opt="" || opt="-D${opt}"
3981 clang_args="${clang_args} ${opt}"
3982 target="${target}${opt}"
Dave Rodgman920343a2023-10-01 18:41:09 +01003983 done
3984
3985 # check that combination is not known to be invalid
Dave Rodgman28e38d82023-10-04 11:50:30 +01003986 invalid=""
3987 [[ "$validate_options" != "" ]] && invalid=$(${validate_options} "${clang_args}")
Dave Rodgman920343a2023-10-01 18:41:09 +01003988
3989 # if valid, add it to the makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01003990 if [[ "$invalid" == "" ]]; then
3991 cmd="${compile_cmd} ${clang_args}"
3992 echo "${target}:" >> ${makefile}
3993 echo -e "\t$cmd" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01003994
Dave Rodgman28e38d82023-10-04 11:50:30 +01003995 deps="${deps} ${target}"
Dave Rodgman745af9f2023-09-29 15:47:07 +01003996 fi
Dave Rodgman97285622023-09-29 17:32:06 +01003997 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01003998
Dave Rodgman28e38d82023-10-04 11:50:30 +01003999 echo "all: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004000
Dave Rodgman920343a2023-10-01 18:41:09 +01004001 # execute all of the commands via Make (probably in parallel)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004002 make -s -f ${makefile} all
Dave Rodgman920343a2023-10-01 18:41:09 +01004003
4004 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004005 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004006}
4007
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004008validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004009 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4010 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
4011 echo 1
4012 fi
4013 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4014 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
4015 echo 1
4016 fi
4017 fi
4018}
4019
4020component_build_aes_variations() {
4021 # 18s - around 90ms per clang invocation on M1 Pro
4022 #
4023 # aes.o has many #if defined(...) guards that intersect in complex ways.
4024 # Test that all the combinations build cleanly.
4025
4026 msg "build: aes.o for all combinations of relevant config options"
4027
Dave Rodgman42436102023-10-03 15:47:05 +01004028 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004029 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4030 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4031 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4032 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
4033}
4034
Gilles Peskine8f073122018-11-27 15:58:47 +01004035component_test_no_platform () {
4036 # Full configuration build, without platform support, file IO and net sockets.
4037 # This should catch missing mbedtls_printf definitions, and by disabling file
4038 # IO, it should catch missing '#include <stdio.h>'
4039 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004040 scripts/config.py full
4041 scripts/config.py unset MBEDTLS_PLATFORM_C
4042 scripts/config.py unset MBEDTLS_NET_C
4043 scripts/config.py unset MBEDTLS_PLATFORM_MEMORY
4044 scripts/config.py unset MBEDTLS_PLATFORM_PRINTF_ALT
4045 scripts/config.py unset MBEDTLS_PLATFORM_FPRINTF_ALT
4046 scripts/config.py unset MBEDTLS_PLATFORM_SNPRINTF_ALT
Gilles Peskineef843f22022-09-18 14:05:23 +02004047 scripts/config.py unset MBEDTLS_PLATFORM_VSNPRINTF_ALT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004048 scripts/config.py unset MBEDTLS_PLATFORM_TIME_ALT
4049 scripts/config.py unset MBEDTLS_PLATFORM_EXIT_ALT
Gilles Peskine6497b5a2022-06-30 17:01:40 +02004050 scripts/config.py unset MBEDTLS_PLATFORM_SETBUF_ALT
Gilles Peskine32e889d2020-04-12 23:43:28 +02004051 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004052 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4053 scripts/config.py unset MBEDTLS_FS_IO
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004054 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004055 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
4056 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskine8f073122018-11-27 15:58:47 +01004057 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
4058 # to re-enable platform integration features otherwise disabled in C99 builds
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02004059 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
4060 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Gilles Peskine8f073122018-11-27 15:58:47 +01004061}
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004062
Gilles Peskine8f073122018-11-27 15:58:47 +01004063component_build_no_std_function () {
4064 # catch compile bugs in _uninit functions
4065 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004066 scripts/config.py full
4067 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
4068 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Gilles Peskine32e889d2020-04-12 23:43:28 +02004069 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004070 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
Gilles Peskinedbf7b7e2021-10-07 19:34:57 +02004071 make
Gilles Peskine8f073122018-11-27 15:58:47 +01004072}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004073
Gilles Peskine8f073122018-11-27 15:58:47 +01004074component_build_no_ssl_srv () {
Ronald Cronde1adee2022-03-07 16:20:30 +01004075 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004076 scripts/config.py full
4077 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02004078 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004079}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004080
Gilles Peskine8f073122018-11-27 15:58:47 +01004081component_build_no_ssl_cli () {
Ronald Cronde1adee2022-03-07 16:20:30 +01004082 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004083 scripts/config.py full
4084 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02004085 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004086}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004087
Gilles Peskine8f073122018-11-27 15:58:47 +01004088component_build_no_sockets () {
4089 # Note, C99 compliance can also be tested with the sockets support disabled,
4090 # as that requires a POSIX platform (which isn't the same as C99).
4091 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004092 scripts/config.py full
4093 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4094 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02004095 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01004096}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004097
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004098component_test_memory_buffer_allocator_backtrace () {
4099 msg "build: default config with memory buffer allocator and backtrace enabled"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004100 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4101 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4102 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
4103 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004104 CC=gcc cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004105 make
4106
4107 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4108 make test
4109}
4110
4111component_test_memory_buffer_allocator () {
4112 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004113 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4114 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004115 CC=gcc cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004116 make
4117
4118 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4119 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004120
4121 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4122 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004123 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004124}
4125
Gilles Peskine8f073122018-11-27 15:58:47 +01004126component_test_no_max_fragment_length () {
4127 # Run max fragment length tests with MFL disabled
4128 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004129 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004130 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4131 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004132
Gilles Peskine8f073122018-11-27 15:58:47 +01004133 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004134 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004135}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004136
Hanno Becker545ced42019-02-19 11:10:48 +00004137component_test_asan_remove_peer_certificate () {
4138 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004139 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Hanno Becker545ced42019-02-19 11:10:48 +00004140 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4141 make
4142
4143 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4144 make test
4145
4146 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004147 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004148
4149 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004150 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004151
4152 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004153 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004154}
4155
Gilles Peskine8f073122018-11-27 15:58:47 +01004156component_test_no_max_fragment_length_small_ssl_out_content_len () {
4157 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004158 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4159 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4160 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Gilles Peskine8f073122018-11-27 15:58:47 +01004161 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4162 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004163
Gilles Peskine8f073122018-11-27 15:58:47 +01004164 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004165 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004166
4167 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004168 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004169}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004170
Darryl Greenaad82f92019-12-02 10:53:11 +00004171component_test_variable_ssl_in_out_buffer_len () {
4172 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4173 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
4174 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4175 make
4176
4177 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4178 make test
4179
4180 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004181 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004182
4183 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004184 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004185}
4186
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004187component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004188 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004189 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004190
4191 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4192 make
4193
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004194 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004195 make test
4196
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004197 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004198 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004199
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004200 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004201 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004202}
4203
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004204component_test_ssl_alloc_buffer_and_mfl () {
4205 msg "build: default config with memory buffer allocator and MFL extension"
4206 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4207 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4208 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4209 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4210 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004211 CC=gcc cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004212 make
4213
4214 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4215 make test
4216
4217 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 +02004218 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004219}
4220
Gilles Peskine636c26a2020-03-04 20:46:15 +01004221component_test_when_no_ciphersuites_have_mac () {
4222 msg "build: when no ciphersuites have MAC"
4223 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004224 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004225 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004226 make
4227
4228 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4229 make test
4230
4231 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004232 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004233}
4234
Raoul Strackxa4e86142020-06-15 17:03:13 +02004235component_test_no_date_time () {
4236 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4237 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004238 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004239 make
4240
4241 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4242 make test
4243}
4244
Gilles Peskine8f073122018-11-27 15:58:47 +01004245component_test_platform_calloc_macro () {
4246 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004247 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4248 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4249 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Gilles Peskine8f073122018-11-27 15:58:47 +01004250 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4251 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004252
Gilles Peskine8f073122018-11-27 15:58:47 +01004253 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4254 make test
4255}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004256
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004257component_test_malloc_0_null () {
4258 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004259 scripts/config.py full
Gilles Peskinecf4fe582023-07-20 19:00:15 +02004260 make CC=gcc CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"$PWD/tests/configs/user-config-malloc-0-null.h\"' $ASAN_CFLAGS -O" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004261
4262 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4263 make test
4264
4265 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4266 # Just the calloc selftest. "make test" ran the others as part of the
4267 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004268 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004269
4270 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4271 # Run a subset of the tests. The choice is a balance between coverage
4272 # and time (including time indirectly wasted due to flaky tests).
4273 # The current choice is to skip tests whose description includes
4274 # "proxy", which is an approximation of skipping tests that use the
4275 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004276 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004277}
4278
Dave Rodgman6a08b682023-06-19 11:51:33 +01004279support_test_aesni() {
4280 # Check that gcc targets x86_64 (we can build AESNI), and check for
4281 # AESNI support on the host (we can run AESNI).
4282 #
4283 # The name of this function is possibly slightly misleading, but needs to align
4284 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004285 #
4286 # In principle 32-bit x86 can support AESNI, but our implementation does not
4287 # support 32-bit x86, so we check for x86-64.
4288 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004289 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4290 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004291 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004292}
4293
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004294component_test_aesni () { # ~ 60s
4295 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4296 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4297 #
4298 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4299 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4300 # exercise the plain C impl).
4301
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004302 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004303 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004304 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004305 scripts/config.py set MBEDTLS_HAVE_ASM
4306
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004307 # test the intrinsics implementation
4308 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004309 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004310 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004311 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004312 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004313
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004314 # test the asm implementation
4315 msg "AES tests, test assembly"
4316 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004317 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004318 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004319 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004320
4321 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004322 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004323 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004324 msg "AES tests, plain C"
4325 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004326 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004327 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004328 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004329 not grep -q "AES note: using AESNI" ./programs/test/selftest
4330 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004331
4332 # test the intrinsics implementation
4333 scripts/config.py set MBEDTLS_AESNI_C
4334 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4335 msg "AES tests, test AESNI only"
4336 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004337 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004338 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4339 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004340 grep -q "AES note: using AESNI" ./programs/test/selftest
4341 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004342}
4343
Jerry Yu193cbc02023-08-03 17:06:29 +08004344
Jerry Yub6d39c22023-08-16 15:11:48 +08004345
4346support_test_aesni_m32() {
4347 support_test_m32_o0 && (lscpu | grep -qw aes)
4348}
4349
4350component_test_aesni_m32 () { # ~ 60s
4351 # This tests are duplicated from component_test_aesni for i386 target
4352 #
4353 # AESNI intrinsic code supports i386 and assembly code does not support it.
4354
4355 msg "build: default config with different AES implementations"
4356 scripts/config.py set MBEDTLS_AESNI_C
4357 scripts/config.py set MBEDTLS_PADLOCK_C
4358 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4359 scripts/config.py set MBEDTLS_HAVE_ASM
4360
4361 # test the intrinsics implementation
4362 msg "AES tests, test intrinsics"
4363 make clean
4364 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4365 # check that we built intrinsics - this should be used by default when supported by the compiler
4366 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4367 grep -q "AES note: using AESNI" ./programs/test/selftest
4368 grep -q "AES note: built-in implementation." ./programs/test/selftest
4369 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4370 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4371
4372 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004373 scripts/config.py unset MBEDTLS_PADLOCK_C
4374 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4375 msg "AES tests, test AESNI only"
4376 make clean
4377 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4378 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4379 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4380 grep -q "AES note: using AESNI" ./programs/test/selftest
4381 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4382 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4383 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4384}
4385
Jerry Yu193cbc02023-08-03 17:06:29 +08004386# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4387component_build_aes_aesce_armcc () {
4388 msg "Build: AESCE test on arm64 platform without plain C."
4389 scripts/config.py baremetal
4390
4391 # armc[56] don't support SHA-512 intrinsics
4392 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4393
4394 # Stop armclang warning about feature detection for A64_CRYPTO.
4395 # With this enabled, the library does build correctly under armclang,
4396 # but in baremetal builds (as tested here), feature detection is
4397 # unavailable, and the user is notified via a #warning. So enabling
4398 # this feature would prevent us from building with -Werror on
4399 # armclang. Tracked in #7198.
4400 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
4401 scripts/config.py set MBEDTLS_HAVE_ASM
4402
4403 msg "AESCE, build with default configuration."
4404 scripts/config.py set MBEDTLS_AESCE_C
4405 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4406 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4407
4408 msg "AESCE, build AESCE only"
4409 scripts/config.py set MBEDTLS_AESCE_C
4410 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4411 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4412}
4413
Jerry Yuc935aa62023-08-03 17:08:27 +08004414# For timebeing, no VIA Padlock platform available.
4415component_build_aes_via_padlock () {
4416
4417 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004418 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004419 scripts/config.py set MBEDTLS_PADLOCK_C
4420 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4421 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O2" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004422 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004423
4424}
4425
4426support_build_aes_via_padlock_only () {
4427 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4428 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4429 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4430}
4431
Jerry Yu193cbc02023-08-03 17:06:29 +08004432support_build_aes_aesce_armcc () {
4433 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004434}
4435
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004436component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004437 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004438 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004439 scripts/config.py unset MBEDTLS_PADLOCK_C
4440
4441 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004442
Gilles Peskine8f073122018-11-27 15:58:47 +01004443 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4444 make test
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004445}
4446
Gilles Peskine8f073122018-11-27 15:58:47 +01004447component_test_no_ctr_drbg_aes_only_128_bit_keys () {
Hanno Becker83ebf782017-07-07 12:29:15 +01004448 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine8f073122018-11-27 15:58:47 +01004449 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4450 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4451 scripts/config.py unset MBEDTLS_PADLOCK_C
4452
Gilles Peskine592f5912019-10-07 18:49:32 +02004453 make CC=clang CFLAGS='-Werror -Wall -Wextra'
4454
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004455 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4456 make test
4457}
Gilles Peskine592f5912019-10-07 18:49:32 +02004458
4459component_test_aes_only_128_bit_keys_have_builtins () {
4460 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4461 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4462 scripts/config.py unset MBEDTLS_PADLOCK_C
4463 scripts/config.py unset MBEDTLS_AESNI_C
4464 scripts/config.py unset MBEDTLS_AESCE_C
4465
4466 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004467
4468 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4469 make test
Gilles Peskine592f5912019-10-07 18:49:32 +02004470
4471 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4472 programs/test/selftest
4473}
4474
4475component_test_aes_fewer_tables () {
4476 msg "build: default config with AES_FEWER_TABLES enabled"
4477 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4478 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004479
4480 msg "test: AES_FEWER_TABLES"
4481 make test
4482}
Gilles Peskine592f5912019-10-07 18:49:32 +02004483
4484component_test_aes_rom_tables () {
4485 msg "build: default config with AES_ROM_TABLES enabled"
4486 scripts/config.py set MBEDTLS_AES_ROM_TABLES
4487 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
4488
4489 msg "test: AES_ROM_TABLES"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02004490 make test
4491}
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004492
Gilles Peskine004206c2019-10-21 17:11:33 +02004493component_test_aes_fewer_tables_and_rom_tables () {
Gilles Peskinef96aefe2019-07-24 14:58:38 +02004494 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4495 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4496 scripts/config.py set MBEDTLS_AES_ROM_TABLES
4497 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
4498
Steven Cooremand57203d2020-07-16 20:28:59 +02004499 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
Ronald Cron32a432a2023-03-28 09:19:04 +02004500 make test
Steven Cooreman753f9732021-03-15 11:38:44 +01004501}
Steven Cooreman6801f082021-02-19 17:21:22 +01004502
Gilles Peskine3587dfd2021-09-20 19:20:04 +02004503component_test_ctr_drbg_aes_256_sha_256 () {
4504 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Ronald Cron17b3afc2020-12-10 18:17:09 +01004505 scripts/config.py full
4506 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4507 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Steven Cooremand57203d2020-07-16 20:28:59 +02004508 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cron32a432a2023-03-28 09:19:04 +02004509 make
Steven Cooremand57203d2020-07-16 20:28:59 +02004510
4511 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4512 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01004513}
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004514
Andrzej Kurek232e8f92019-10-03 03:18:01 -04004515component_test_ctr_drbg_aes_128_sha_512 () {
Gilles Peskine56c01612019-07-03 20:43:32 +02004516 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskineca144592021-11-04 12:52:14 +01004517 scripts/config.py full
Gilles Peskine8f073122018-11-27 15:58:47 +01004518 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004519 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Gilles Peskinecf740502019-07-03 20:43:05 +02004520 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4521 make
4522
4523 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine56c01612019-07-03 20:43:32 +02004524 make test
Gilles Peskinecf740502019-07-03 20:43:05 +02004525}
Gilles Peskineca144592021-11-04 12:52:14 +01004526
Gilles Peskinecf740502019-07-03 20:43:05 +02004527component_test_ctr_drbg_aes_128_sha_256 () {
4528 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskineec10bf12019-09-20 19:56:06 +02004529 scripts/config.py full
4530 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
4531 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
4532 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Gilles Peskinee094a182020-04-14 20:08:41 +02004533 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskineec10bf12019-09-20 19:56:06 +02004534 make
4535
4536 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
4537 make test
4538}
4539
4540component_test_se_default () {
4541 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
4542 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
4543 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004544
Gilles Peskineec10bf12019-09-20 19:56:06 +02004545 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
4546 make test
4547}
4548
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004549component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02004550 msg "build: full + test drivers dispatching to builtins"
Gilles Peskineec10bf12019-09-20 19:56:06 +02004551 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02004552 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskineec10bf12019-09-20 19:56:06 +02004553 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
4554 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
4555 loc_cflags="${loc_cflags} -I../tests/include -O2"
4556
4557 make CC=gcc CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
4558
Gilles Peskine1997f302023-07-26 18:45:20 +02004559 msg "test: full + test drivers dispatching to builtins"
Gilles Peskineec10bf12019-09-20 19:56:06 +02004560 make test
4561}
4562
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02004563component_test_make_shared () {
4564 msg "build/test: make shared" # ~ 40s
4565 make SHARED=1 all check
4566 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004567 programs/test/dlopen_demo.sh
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02004568}
4569
4570component_test_cmake_shared () {
4571 msg "build/test: cmake shared" # ~ 2min
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004572 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
4573 make
Gilles Peskine8f073122018-11-27 15:58:47 +01004574 ldd programs/util/strerror | grep libmbedcrypto
Simon Butcher8e6a22a2018-07-20 21:27:33 +01004575 make test
4576 programs/test/dlopen_demo.sh
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004577}
Gilles Peskine8fd59422019-10-21 17:11:33 +02004578
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004579test_build_opt () {
Simon Butcher8e6a22a2018-07-20 21:27:33 +01004580 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01004581 $cc --version
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004582 for opt in "$@"; do
Gilles Peskine14c3c062018-01-29 21:25:12 +01004583 msg "build/test: $cc $opt, $info" # ~ 30s
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004584 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskine14c3c062018-01-29 21:25:12 +01004585 # We're confident enough in compilers to not run _all_ the tests,
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004586 # but at least run the unit tests. In particular, runs with
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01004587 # optimizations use inline assembly whereas runs with -O0
Gilles Peskine14c3c062018-01-29 21:25:12 +01004588 # skip inline assembly.
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01004589 make test # ~30s
4590 make clean
4591 done
4592}
4593
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01004594# For FreeBSD we invoke the function by name so this condition is added
4595# to disable the existing test_clang_opt function for linux.
4596if [[ $(uname) != "Linux" ]]; then
4597 component_test_clang_opt () {
4598 scripts/config.py full
4599 test_build_opt 'full config' clang -O0 -Os -O2
4600 }
4601fi
4602
4603component_test_clang_latest_opt () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004604 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01004605 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01004606}
4607support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01004608 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Simon Butcher8e6a22a2018-07-20 21:27:33 +01004609}
4610
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01004611component_test_clang_earliest_opt () {
Gilles Peskine878cf602019-01-06 20:50:38 +00004612 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01004613 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01004614}
4615support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01004616 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01004617}
4618
4619component_test_gcc_latest_opt () {
4620 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01004621 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01004622}
4623support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01004624 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01004625}
4626
4627component_test_gcc_earliest_opt () {
4628 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01004629 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01004630}
4631support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01004632 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskine878cf602019-01-06 20:50:38 +00004633}
4634
4635component_build_mbedtls_config_file () {
4636 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02004637 scripts/config.py -w full_config.h full
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004638 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
4639 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02004640 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02004641 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
4642 make clean
4643
4644 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
4645 # In the user config, disable one feature (for simplicity, pick a feature
4646 # that nothing else depends on).
4647 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
4648 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
4649 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
4650
4651 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004652}
4653
Gilles Peskine7d904e72022-04-07 21:59:14 +02004654component_build_psa_config_file () {
4655 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
4656 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4657 cp "$CRYPTO_CONFIG_H" psa_test_config.h
4658 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
4659 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02004660 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02004661 programs/test/query_compile_time_config MBEDTLS_CMAC_C
4662 make clean
4663
4664 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
4665 # In the user config, disable one feature, which will reflect on the
4666 # mbedtls configuration so we can query it with query_compile_time_config.
4667 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
4668 scripts/config.py unset MBEDTLS_CMAC_C
4669 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
4670 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
4671
4672 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004673}
4674
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01004675component_build_psa_alt_headers () {
4676 msg "build: make with PSA alt headers" # ~20s
4677
4678 # Generate alternative versions of the substitutable headers with the
4679 # same content except different include guards.
4680 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
4681
4682 # Build the library and some programs.
4683 # Don't build the fuzzers to avoid having to go through hoops to set
4684 # a correct include path for programs/fuzz/Makefile.
4685 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
4686 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\"'"
4687
4688 # Check that we're getting the alternative include guards and not the
4689 # original include guards.
4690 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
4691 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
4692 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
4693 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
4694}
4695
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004696component_test_m32_o0 () {
Gilles Peskine77f05352021-10-07 19:27:16 +02004697 # Build without optimization, so as to use portable C code (in a 32-bit
4698 # build) and not the i386-specific inline assembly.
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004699 msg "build: i386, make, gcc -O0 (ASan build)" # ~ 30s
4700 scripts/config.py full
Jerry Yubdd96b92023-08-16 17:34:27 +08004701 scripts/config.py unset MBEDTLS_AESNI_C # AESNI depends on cpu modifiers
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004702 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O0" LDFLAGS="-m32 $ASAN_CFLAGS"
4703
4704 msg "test: i386, make, gcc -O0 (ASan build)"
4705 make test
4706}
4707support_test_m32_o0 () {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004708 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00004709 amd64|x86_64) true;;
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004710 *) false;;
Simon Butcher8e6a22a2018-07-20 21:27:33 +01004711 esac
4712}
4713
Gilles Peskineff0aee02021-10-05 09:36:03 +02004714component_test_m32_o2 () {
4715 # Build with optimization, to use the i386 specific inline assembly
4716 # and go faster for tests.
4717 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004718 scripts/config.py full
Jerry Yubdd96b92023-08-16 17:34:27 +08004719 scripts/config.py unset MBEDTLS_AESNI_C # AESNI depends on cpu modifiers
Gilles Peskineff0aee02021-10-05 09:36:03 +02004720 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O2" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01004721
Gilles Peskineff0aee02021-10-05 09:36:03 +02004722 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004723 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004724
Gilles Peskineff0aee02021-10-05 09:36:03 +02004725 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004726 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004727}
Gilles Peskinecf522222021-10-07 19:25:29 +02004728support_test_m32_o2 () {
Gilles Peskine878cf602019-01-06 20:50:38 +00004729 support_test_m32_o0 "$@"
4730}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004731
Gilles Peskine0c6b7992019-04-12 20:29:48 +02004732component_test_m32_everest () {
4733 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004734 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Jerry Yubdd96b92023-08-16 17:34:27 +08004735 scripts/config.py unset MBEDTLS_AESNI_C # AESNI depends on cpu modifiers
Gilles Peskine8fd59422019-10-21 17:11:33 +02004736 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O2" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02004737
4738 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
4739 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004740
4741 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004742 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01004743
4744 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
4745 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02004746 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02004747}
4748support_test_m32_everest () {
4749 support_test_m32_o0 "$@"
4750}
4751
Gilles Peskine8f073122018-11-27 15:58:47 +01004752component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004753 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004754 scripts/config.py full
Gilles Peskine5d26e7c2019-06-07 14:50:09 +02004755 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004756
4757 msg "test: 64-bit ILP32, make, gcc"
4758 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01004759}
Gilles Peskine878cf602019-01-06 20:50:38 +00004760support_test_mx32 () {
4761 case $(uname -m) in
4762 amd64|x86_64) true;;
4763 *) false;;
4764 esac
4765}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004766
Peter Kolbus60c6da22018-12-27 06:59:04 -06004767component_test_min_mpi_window_size () {
4768 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004769 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Peter Kolbus60c6da22018-12-27 06:59:04 -06004770 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
4771 make
4772
4773 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
4774 make test
4775}
4776
Gilles Peskine8f073122018-11-27 15:58:47 +01004777component_test_have_int32 () {
4778 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004779 scripts/config.py unset MBEDTLS_HAVE_ASM
4780 scripts/config.py unset MBEDTLS_AESNI_C
4781 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08004782 scripts/config.py unset MBEDTLS_AESCE_C
Gilles Peskine8f073122018-11-27 15:58:47 +01004783 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004784
Gilles Peskine8f073122018-11-27 15:58:47 +01004785 msg "test: gcc, force 32-bit bignum limbs"
4786 make test
4787}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01004788
Gilles Peskine8f073122018-11-27 15:58:47 +01004789component_test_have_int64 () {
4790 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004791 scripts/config.py unset MBEDTLS_HAVE_ASM
4792 scripts/config.py unset MBEDTLS_AESNI_C
4793 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08004794 scripts/config.py unset MBEDTLS_AESCE_C
Gilles Peskine8f073122018-11-27 15:58:47 +01004795 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01004796
Gilles Peskine8f073122018-11-27 15:58:47 +01004797 msg "test: gcc, force 64-bit bignum limbs"
4798 make test
4799}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004800
Gabor Mezeie256cc12023-07-26 17:28:48 +02004801component_test_have_int32_cmake_new_bignum () {
4802 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
4803 scripts/config.py unset MBEDTLS_HAVE_ASM
4804 scripts/config.py unset MBEDTLS_AESNI_C
4805 scripts/config.py unset MBEDTLS_PADLOCK_C
4806 scripts/config.py unset MBEDTLS_AESCE_C
4807 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01004808 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01004809 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02004810
4811 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
4812 make test
4813}
4814
Gilles Peskine8f073122018-11-27 15:58:47 +01004815component_test_no_udbl_division () {
4816 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004817 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004818 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine8f073122018-11-27 15:58:47 +01004819 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02004820
Gilles Peskine8f073122018-11-27 15:58:47 +01004821 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
4822 make test
4823}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02004824
Gilles Peskine8f073122018-11-27 15:58:47 +01004825component_test_no_64bit_multiplication () {
4826 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004827 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004828 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine8f073122018-11-27 15:58:47 +01004829 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02004830
Gilles Peskine8f073122018-11-27 15:58:47 +01004831 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
4832 make test
4833}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02004834
Gilles Peskine3809f5f2020-11-09 15:40:05 +01004835component_test_no_strings () {
4836 msg "build: no strings" # ~10s
4837 scripts/config.py full
4838 # Disable options that activate a large amount of string constants.
4839 scripts/config.py unset MBEDTLS_DEBUG_C
4840 scripts/config.py unset MBEDTLS_ERROR_C
4841 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
4842 scripts/config.py unset MBEDTLS_VERSION_FEATURES
4843 make CFLAGS='-Werror -Os'
4844
4845 msg "test: no strings" # ~ 10s
4846 make test
4847}
4848
Hanno Beckerc5722d12020-10-09 11:10:42 +01004849component_test_no_x509_info () {
4850 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
4851 scripts/config.pl full
4852 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
4853 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskineff0aee02021-10-05 09:36:03 +02004854 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01004855
4856 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
4857 make test
4858
4859 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004860 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01004861}
4862
Gilles Peskine8f073122018-11-27 15:58:47 +01004863component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02004864 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004865 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02004866 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 +02004867
Gilles Peskinee36fe812021-09-01 20:00:33 +02004868 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02004869 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01004870}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02004871
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02004872component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02004873 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004874 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02004875 # Build for a target platform that's close to what Debian uses
4876 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01004877 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02004878 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01004879 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02004880 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'
4881
Gilles Peskinee36fe812021-09-01 20:00:33 +02004882 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02004883 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02004884}
4885support_build_arm_linux_gnueabi_gcc_arm5vte () {
4886 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
4887}
4888
4889component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02004890 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02004891 scripts/config.py baremetal
4892 # This is an imperfect substitute for
4893 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02004894 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02004895 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 +02004896
Gilles Peskinee36fe812021-09-01 20:00:33 +02004897 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02004898 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02004899}
4900
Gilles Peskine6e2fb862020-04-30 23:00:53 +02004901component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02004902 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
4903 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02004904 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 +02004905
Gilles Peskinee36fe812021-09-01 20:00:33 +02004906 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02004907 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02004908 for lib in library/*.a; do
4909 echo "$lib:"
4910 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
4911 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02004912}
4913
Gilles Peskine8f073122018-11-27 15:58:47 +01004914component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02004915 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004916 scripts/config.py baremetal
4917 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02004918 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 +01004919 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004920 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01004921}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02004922
Gilles Peskine8f073122018-11-27 15:58:47 +01004923component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02004924 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004925 scripts/config.py baremetal
4926 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02004927 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 +01004928 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004929 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01004930}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02004931
Dave Rodgman8c315f22023-06-02 10:26:24 -04004932component_build_arm_clang_thumb () {
4933 # ~ 30s
4934
4935 scripts/config.py baremetal
4936
4937 msg "build: clang thumb 2, make"
4938 make clean
4939 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
4940
4941 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
4942 msg "build: clang thumb 1 -O0, make"
4943 make clean
4944 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
4945
4946 msg "build: clang thumb 1 -Os, make"
4947 make clean
4948 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
4949}
4950
Gilles Peskine8f073122018-11-27 15:58:47 +01004951component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02004952 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004953 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00004954 # armc[56] don't support SHA-512 intrinsics
4955 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00004956
Dave Rodgman0fddf822023-03-02 15:32:12 +00004957 # Stop armclang warning about feature detection for A64_CRYPTO.
4958 # With this enabled, the library does build correctly under armclang,
4959 # but in baremetal builds (as tested here), feature detection is
4960 # unavailable, and the user is notified via a #warning. So enabling
4961 # this feature would prevent us from building with -Werror on
4962 # armclang. Tracked in #7198.
Dave Rodgman2f386c52023-03-02 13:38:33 +00004963 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
4964
Hanno Beckerf0762e92022-07-15 12:08:19 +01004965 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00004966
Gilles Peskinebca6ab92017-12-19 18:24:31 +01004967 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02004968
4969 msg "size: ARM Compiler 5"
4970 "$ARMC5_FROMELF" -z library/*.o
4971
Gilles Peskinebca6ab92017-12-19 18:24:31 +01004972 make clean
Andres AG87bb5772016-09-27 15:05:15 +01004973
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04004974 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01004975
Gilles Peskinebca6ab92017-12-19 18:24:31 +01004976 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01004977 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02004978
Gilles Peskinebca6ab92017-12-19 18:24:31 +01004979 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01004980 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
4981
4982 # ARM Compiler 6 - Target ARMv7-M+DSP
4983 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02004984
Gilles Peskinebca6ab92017-12-19 18:24:31 +01004985 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01004986 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02004987
Gilles Peskinebca6ab92017-12-19 18:24:31 +01004988 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01004989 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02004990
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01004991 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
4992 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
4993
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04004994 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
4995 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
4996
Dave Rodgman99318e62023-05-24 12:27:42 +01004997 # ARM Compiler 6 - Target Cortex-M0
4998 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Gilles Peskine8f073122018-11-27 15:58:47 +01004999}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005000
Pengyu Lvdf070032023-02-24 16:03:31 +08005001support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005002 armc5_cc="$ARMC5_BIN_DIR/armcc"
5003 armc6_cc="$ARMC6_BIN_DIR/armclang"
5004 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005005}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005006
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005007component_test_tls13_only () {
5008 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3, without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005009 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Jerry Yuda5af222021-12-24 18:45:45 +08005010 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5011
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005012 msg "test: TLS 1.3 only, all key exchange modes enabled"
5013 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005014
Ronald Cronc3f43b62022-10-17 17:35:32 +02005015 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5016 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005017}
5018
Ronald Cronc3f43b62022-10-17 17:35:32 +02005019component_test_tls13_only_psk () {
5020 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5021 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5022 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5023 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005024 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005025 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5026 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5027 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5028 scripts/config.py unset MBEDTLS_ECDSA_C
5029 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005030 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005031 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005032 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5033
Ronald Cronc3f43b62022-10-17 17:35:32 +02005034 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5035 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005036
Ronald Cronc3f43b62022-10-17 17:35:32 +02005037 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5038 tests/ssl-opt.sh
5039}
5040
5041component_test_tls13_only_ephemeral () {
5042 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5043 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5044 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005045 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005046 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5047
5048 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5049 cd tests; ./test_suite_ssl; cd ..
5050
5051 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5052 tests/ssl-opt.sh
5053}
5054
Przemek Stekiela01c2422023-06-13 10:46:48 +02005055component_test_tls13_only_ephemeral_ffdh () {
5056 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5057 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5058 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5059 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005060 scripts/config.py unset MBEDTLS_ECDH_C
5061
Przemek Stekiela01c2422023-06-13 10:46:48 +02005062 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5063
5064 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5065 cd tests; ./test_suite_ssl; cd ..
5066
5067 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5068 tests/ssl-opt.sh
5069}
5070
Ronald Cronc3f43b62022-10-17 17:35:32 +02005071component_test_tls13_only_psk_ephemeral () {
5072 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5073 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5074 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5075 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5076 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5077 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5078 scripts/config.py unset MBEDTLS_ECDSA_C
5079 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005080 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005081 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005082 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5083
5084 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5085 cd tests; ./test_suite_ssl; cd ..
5086
5087 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5088 tests/ssl-opt.sh
5089}
5090
Przemek Stekiela01c2422023-06-13 10:46:48 +02005091component_test_tls13_only_psk_ephemeral_ffdh () {
5092 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5093 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5094 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5095 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5096 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5097 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5098 scripts/config.py unset MBEDTLS_ECDSA_C
5099 scripts/config.py unset MBEDTLS_PKCS1_V21
5100 scripts/config.py unset MBEDTLS_PKCS7_C
5101 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005102 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005103 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5104
5105 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5106 cd tests; ./test_suite_ssl; cd ..
5107
5108 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5109 tests/ssl-opt.sh
5110}
5111
Ronald Cronc3f43b62022-10-17 17:35:32 +02005112component_test_tls13_only_psk_all () {
5113 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5114 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5115 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5116 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5117 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5118 scripts/config.py unset MBEDTLS_ECDSA_C
5119 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005120 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005121 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005122 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5123
5124 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5125 cd tests; ./test_suite_ssl; cd ..
5126
5127 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5128 tests/ssl-opt.sh
5129}
5130
5131component_test_tls13_only_ephemeral_all () {
5132 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5133 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005134 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005135 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5136
5137 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5138 cd tests; ./test_suite_ssl; cd ..
5139
5140 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5141 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005142}
5143
Ronald Cron6f135e12021-12-08 16:57:54 +01005144component_test_tls13 () {
5145 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5146 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005147 scripts/config.py set MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5148 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005149 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005150 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5151 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005152 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005153 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005154 msg "ssl-opt.sh (TLS 1.3)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005155 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005156}
5157
Ronald Cron6f135e12021-12-08 16:57:54 +01005158component_test_tls13_no_compatibility_mode () {
5159 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5160 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005161 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5162 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005163 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Hanno Beckera711f6e2020-05-04 12:03:51 +01005164 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5165 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005166 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005167 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005168 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005169 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005170}
5171
Jan Bruckner151f6422023-02-10 12:45:19 +01005172component_test_tls13_only_record_size_limit () {
5173 msg "build: TLS 1.3 only from default, record size limit extension enabled"
5174 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
5175 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5176
5177 msg "test_suite_ssl: TLS 1.3 only, record size limit extension enabled"
5178 cd tests; ./test_suite_ssl; cd ..
5179
5180 msg "ssl-opt.sh: (TLS 1.3 only, record size limit extension tests only)"
5181 # Both the server and the client will currently abort the handshake when they encounter the
5182 # record size limit extension. There is no way to prevent gnutls-cli from sending the extension
5183 # which makes all G_NEXT_CLI + P_SRV tests fail. Thus, run only the tests for the this extension.
5184 tests/ssl-opt.sh -f "Record Size Limit"
5185}
5186
Gilles Peskine8f073122018-11-27 15:58:47 +01005187component_build_mingw () {
5188 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Jerry Yubdd96b92023-08-16 17:34:27 +08005189 scripts/config.py unset MBEDTLS_AESNI_C # AESNI depends on cpu modifiers
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005190 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra' WINDOWS_BUILD=1 lib programs
Hanno Beckere963efa2018-01-03 10:03:43 +00005191
Gilles Peskine8f073122018-11-27 15:58:47 +01005192 # note Make tests only builds the tests, but doesn't run them
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005193 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror' WINDOWS_BUILD=1 tests
Gilles Peskine8f073122018-11-27 15:58:47 +01005194 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005195
Gilles Peskine8f073122018-11-27 15:58:47 +01005196 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005197 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra' WINDOWS_BUILD=1 SHARED=1 lib programs
5198 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra' WINDOWS_BUILD=1 SHARED=1 tests
Gilles Peskine8f073122018-11-27 15:58:47 +01005199 make WINDOWS_BUILD=1 clean
5200}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005201support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005202 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5203 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005204 *) true;;
5205 esac
5206}
Simon Butcher91aef332016-11-17 09:20:50 +00005207
Gilles Peskine8f073122018-11-27 15:58:47 +01005208component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005209 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005210 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005211 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5212 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005213
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005214 msg "test: main suites (MSan)" # ~ 10s
5215 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005216
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005217 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005218 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005219
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005220 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005221
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005222 if [ "$MEMORY" -gt 0 ]; then
5223 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005224 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005225 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005226}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005227
Gilles Peskine69f190e2019-01-10 00:11:42 +01005228component_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005229 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005230 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005231 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5232 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005233
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005234 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005235 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005236
Gilles Peskine636c26a2020-03-04 20:46:15 +01005237 # Optional parts (slow; currently broken on OS X because programs don't
5238 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005239 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005240 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005241 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005242 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005243 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005244
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005245 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005246 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005247 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005248 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005249
5250 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005251 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005252 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005253 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005254}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005255
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005256component_test_valgrind_psa () {
5257 msg "build: Release, full (clang)"
5258 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5259 scripts/config.py full
5260 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5261 make
5262
5263 msg "test: main suites, Valgrind (full config)"
5264 make memcheck
5265}
5266
Paul Elliott62dc3922021-11-25 17:29:40 +00005267support_test_cmake_out_of_source () {
5268 distrib_id=""
5269 distrib_ver=""
5270 distrib_ver_minor=""
5271 distrib_ver_major=""
5272
5273 # Attempt to parse lsb-release to find out distribution and version. If not
5274 # found this should fail safe (test is supported).
5275 if [[ -f /etc/lsb-release ]]; then
5276
5277 while read -r lsb_line; do
5278 case "$lsb_line" in
5279 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5280 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5281 esac
5282 done < /etc/lsb-release
5283
5284 distrib_ver_major="${distrib_ver%%.*}"
5285 distrib_ver="${distrib_ver#*.}"
5286 distrib_ver_minor="${distrib_ver%%.*}"
5287 fi
5288
5289 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5290 # processor (as the CI does) can create a race condition whereby the build
5291 # fails to see a generated file, despite that file actually having been
5292 # generated. This problem appears to go away with 18.04 or newer, so make
5293 # the out of source tests unsupported on Ubuntu 16.04.
5294 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5295}
5296
Gilles Peskine8f073122018-11-27 15:58:47 +01005297component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005298 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005299 # generates
5300 make neat
5301
Gilles Peskine8f073122018-11-27 15:58:47 +01005302 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005303 MBEDTLS_ROOT_DIR="$PWD"
5304 mkdir "$OUT_OF_SOURCE_DIR"
5305 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005306 # Note: Explicitly generate files as these are turned off in releases
5307 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005308 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005309
Gilles Peskine8f073122018-11-27 15:58:47 +01005310 msg "test: cmake 'out-of-source' build"
5311 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005312 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005313 # Also ensure that there are no error messages such as
5314 # "No such file or directory", which would indicate that some required
5315 # file is missing (ssl-opt.sh tolerates the absence of some files so
5316 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005317 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005318 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005319 cat ssl-opt.err >&2
5320 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005321 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005322 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005323 cd "$MBEDTLS_ROOT_DIR"
5324 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005325}
Andres AGdc192212016-08-31 17:33:13 +01005326
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005327component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005328 # Remove existing generated files so that we use the ones CMake
5329 # generates
5330 make neat
5331
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005332 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005333 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005334 # Note: Explicitly generate files as these are turned off in releases
5335 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005336 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005337 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005338}
Gilles Peskinea3000992022-02-04 00:21:12 +01005339support_test_cmake_as_subdirectory () {
5340 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005341}
5342
Chris Kayd259e342021-03-25 16:03:25 +00005343component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005344 # Remove existing generated files so that we use the ones CMake
5345 # generates
5346 make neat
5347
Chris Kayd259e342021-03-25 16:03:25 +00005348 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005349 cd programs/test/cmake_package
5350 cmake .
5351 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005352 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005353}
Gilles Peskinea3000992022-02-04 00:21:12 +01005354support_test_cmake_as_package () {
5355 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005356}
5357
5358component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005359 # Remove existing generated files so that we use the ones CMake
5360 # generates
5361 make neat
5362
Chris Kayd259e342021-03-25 16:03:25 +00005363 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005364 cd programs/test/cmake_package_install
5365 cmake .
5366 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005367 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005368}
Gilles Peskinea3000992022-02-04 00:21:12 +01005369support_test_cmake_as_package_install () {
5370 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005371}
5372
David Horstmann20550e32023-01-12 14:17:01 +00005373component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005374 # Make a copy of config file to use for the in-tree test
5375 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005376
5377 MBEDTLS_ROOT_DIR="$PWD"
5378 mkdir "$OUT_OF_SOURCE_DIR"
5379 cd "$OUT_OF_SOURCE_DIR"
5380
David Horstmann969c1452023-01-31 10:34:44 +00005381 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005382 cmake "$MBEDTLS_ROOT_DIR"
5383 make
5384
5385 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5386 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005387 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005388 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5389 make
5390
5391 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5392 # In the user config, disable one feature (for simplicity, pick a feature
5393 # that nothing else depends on).
5394 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5395
5396 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5397 make
5398 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5399
5400 rm -f user_config.h full_config.h
5401
5402 cd "$MBEDTLS_ROOT_DIR"
5403 rm -rf "$OUT_OF_SOURCE_DIR"
5404
5405 # Now repeat the test for an in-tree build:
5406
David Horstmann969c1452023-01-31 10:34:44 +00005407 # Restore config for the in-tree test
5408 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005409
David Horstmann969c1452023-01-31 10:34:44 +00005410 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00005411 cmake .
5412 make
5413
5414 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
5415 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005416 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005417 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
5418 make
5419
5420 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5421 # In the user config, disable one feature (for simplicity, pick a feature
5422 # that nothing else depends on).
5423 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5424
5425 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
5426 make
5427 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5428
5429 rm -f user_config.h full_config.h
5430}
5431support_build_cmake_custom_config_file () {
5432 support_test_cmake_out_of_source
5433}
5434
5435
Tom Cosgrovedaddf112023-09-01 10:40:15 +01005436component_build_zeroize_checks () {
5437 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
5438
5439 scripts/config.py full
5440
5441 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Tom Cosgroveb2fafa52023-09-01 14:40:21 +01005442 make CC=gcc 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 +01005443}
5444
5445
Gilles Peskine8f073122018-11-27 15:58:47 +01005446component_test_zeroize () {
5447 # Test that the function mbedtls_platform_zeroize() is not optimized away by
5448 # different combinations of compilers and optimization flags by using an
5449 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
5450 # system in all cases that the script fails, so we must manually search the
5451 # output to check whether the pass string is present and no failure strings
5452 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01005453
Gilles Peskine4976e822019-01-06 19:52:22 +00005454 # Don't try to disable ASLR. We don't care about ASLR here. We do care
5455 # about a spurious message if Gdb tries and fails, so suppress that.
5456 gdb_disable_aslr=
5457 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
5458 gdb_disable_aslr='set disable-randomization off'
5459 fi
5460
Gilles Peskine8f073122018-11-27 15:58:47 +01005461 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01005462 for compiler in clang gcc; do
5463 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
5464 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005465 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
5466 grep "The buffer was correctly zeroized" test_zeroize.log
5467 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01005468 rm -f test_zeroize.log
5469 make clean
5470 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01005471 done
Gilles Peskine8f073122018-11-27 15:58:47 +01005472}
Gilles Peskine192c72f2017-12-21 15:59:21 +01005473
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005474component_test_psa_compliance () {
5475 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Bence Szépkútica9236b2021-10-25 19:29:07 +02005476 make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005477
5478 msg "unit test: test_psa_compliance.py"
5479 ./tests/scripts/test_psa_compliance.py
5480}
5481
5482support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01005483 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02005484 ver="$(cmake --version)"
5485 ver="${ver#cmake version }"
5486 ver_major="${ver%%.*}"
5487
5488 ver="${ver#*.}"
5489 ver_minor="${ver%%.*}"
5490
5491 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02005492}
5493
Gilles Peskinec848d222022-12-09 12:23:35 +01005494component_check_code_style () {
5495 msg "Check C code style"
5496 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00005497}
5498
Gilles Peskinec848d222022-12-09 12:23:35 +01005499support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00005500 case $(uncrustify --version) in
5501 *0.75.1*) true;;
5502 *) false;;
5503 esac
5504}
5505
Gilles Peskine8f073122018-11-27 15:58:47 +01005506component_check_python_files () {
5507 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005508 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005509}
Gilles Peskine192c72f2017-12-21 15:59:21 +01005510
Joe Subbianid614c0b2021-07-29 11:18:29 +01005511component_check_test_helpers () {
5512 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02005513 # unittest writes out mundane stuff like number or tests run on stderr.
5514 # Our convention is to reserve stderr for actual errors, and write
5515 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005516 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01005517
Joe Subbiania25ffab2021-08-06 09:41:27 +01005518 msg "unit test: translate_ciphers.py"
5519 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01005520}
Gilles Peskine192c72f2017-12-21 15:59:21 +01005521
Jerry Yud767cc42023-03-31 15:03:55 +08005522
Gilles Peskine192c72f2017-12-21 15:59:21 +01005523################################################################
5524#### Termination
5525################################################################
5526
Gilles Peskine8f073122018-11-27 15:58:47 +01005527post_report () {
5528 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02005529 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005530
Gilles Peskine8f073122018-11-27 15:58:47 +01005531 final_report
5532}
5533
5534
5535
5536################################################################
5537#### Run all the things
5538################################################################
5539
Gilles Peskine5d996822020-03-28 21:09:21 +01005540# Function invoked by --error-test to test error reporting.
5541pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02005542 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01005543 if [ $KEEP_GOING -ne 0 ]; then
5544 echo "Expect three failing commands."
5545 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02005546 # If the component doesn't run in a subshell, changing error_test_i to an
5547 # invalid integer will cause an error in the loop that runs this function.
5548 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02005549 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01005550 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02005551 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01005552 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02005553 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01005554 make unknown_target
5555 false "this should not be executed"
5556}
5557
Gilles Peskinee48351a2018-11-27 16:06:30 +01005558# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01005559run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01005560 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02005561 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02005562
5563 # Unconditionally create a seedfile that's sufficiently long.
5564 # Do this before each component, because a previous component may
5565 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02005566 local dd_cmd
5567 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
5568 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00005569 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02005570 esac
5571 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02005572
Gilles Peskineec135542021-08-02 23:14:03 +02005573 # Run the component in a subshell, with error trapping and output
5574 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01005575 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02005576 # We want to keep running if the subshell fails, so 'set -e' must
5577 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01005578 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02005579 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01005580 (
5581 if [ $QUIET -eq 1 ]; then
5582 # msg() will be silenced, so just print the component name here.
5583 echo "${current_component#component_}"
5584 exec >/dev/null
5585 fi
5586 if [ $KEEP_GOING -eq 1 ]; then
5587 # Keep "set -e" off, and run an ERR trap instead to record failures.
5588 set -E
5589 trap err_trap ERR
5590 fi
5591 # The next line is what runs the component
5592 "$@"
5593 if [ $KEEP_GOING -eq 1 ]; then
5594 trap - ERR
5595 exit $last_failure_status
5596 fi
5597 )
5598 component_status=$?
5599 if [ $KEEP_GOING -eq 1 ]; then
5600 set -e
5601 if [ $component_status -ne 0 ]; then
5602 failure_count=$((failure_count + 1))
5603 fi
5604 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02005605
5606 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01005607 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02005608 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01005609}
5610
5611# Preliminary setup
5612pre_check_environment
Tom Cosgrove730addc2023-06-09 14:20:18 +01005613pre_parse_command_line_for_dirs "$@"
Gilles Peskine8f073122018-11-27 15:58:47 +01005614pre_initialize_variables
5615pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01005616
Gilles Peskine878cf602019-01-06 20:50:38 +00005617pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02005618pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02005619pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05005620
Gilles Peskine878cf602019-01-06 20:50:38 +00005621build_status=0
5622if [ $KEEP_GOING -eq 1 ]; then
5623 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01005624fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02005625pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00005626pre_print_configuration
5627pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005628cleanup
David Horstmann76a77382023-08-17 17:32:26 +01005629if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01005630 pre_generate_files
5631fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005632
Gilles Peskinebeb3a812019-01-06 22:11:25 +00005633# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02005634for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01005635 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01005636done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02005637unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00005638for component in $RUN_COMPONENTS; do
5639 run_component "component_$component"
5640done
Gilles Peskine8f073122018-11-27 15:58:47 +01005641
5642# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00005643post_report