blob: e5b4eb3d243bc14dcb00b0c7fb6e3bd049398a5b [file] [log] [blame]
Gilles Peskine62cf2e82020-03-27 16:35:23 +01001#! /usr/bin/env bash
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine192c72f2017-12-21 15:59:21 +01007
8
9
10################################################################
11#### Documentation
12################################################################
13
Simon Butcher3ea7f522016-03-07 23:22:10 +000014# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010015# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000016#
SimonB2e23c822016-04-16 21:54:39 +010017# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010018#
Gilles Peskine192c72f2017-12-21 15:59:21 +010019# Notes for users
20# ---------------
21#
SimonB2e23c822016-04-16 21:54:39 +010022# Warning: the test is destructive. It includes various build modes and
23# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010024# configuration. The following files must be committed into git:
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020025# * include/mbedtls/mbedtls_config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010026# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
27# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010028# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040038# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010039# * arm-gcc and mingw-gcc
40# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine7be571a2023-08-27 21:39:21 +020041# * OpenSSL and GnuTLS command line tools, in suitable versions for the
42# interoperability tests. The following are the official versions at the
43# time of writing:
44# * GNUTLS_{CLI,SERV} = 3.4.10
45# * GNUTLS_NEXT_{CLI,SERV} = 3.7.2
46# * OPENSSL = 1.0.2g (without Debian/Ubuntu patches)
Ronald Cronc5e81d22024-04-02 14:39:53 +020047# * OPENSSL_NEXT = 3.1.2
Gilles Peskine192c72f2017-12-21 15:59:21 +010048# See the invocation of check_tools below for details.
49#
50# This script must be invoked from the toplevel directory of a git
51# working copy of Mbed TLS.
52#
Gilles Peskinece266c42020-03-28 18:50:43 +010053# The behavior on an error depends on whether --keep-going (alias -k)
54# is in effect.
55# * Without --keep-going: the script stops on the first error without
56# cleaning up. This lets you work in the configuration of the failing
57# component.
58# * With --keep-going: the script runs all requested components and
59# reports failures at the end. In particular the script always cleans
60# up on exit.
61#
Gilles Peskine192c72f2017-12-21 15:59:21 +010062# Note that the output is not saved. You may want to run
63# script -c tests/scripts/all.sh
64# or
65# tests/scripts/all.sh >all.log 2>&1
66#
67# Notes for maintainers
68# ---------------------
69#
Gilles Peskine8f073122018-11-27 15:58:47 +010070# The bulk of the code is organized into functions that follow one of the
71# following naming conventions:
72# * pre_XXX: things to do before running the tests, in order.
73# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010074# * component_check_XXX: quick tests that aren't worth parallelizing.
75# * component_build_XXX: build things but don't run them.
76# * component_test_XXX: build and test.
Bence Szépkúti89dd5c02023-12-15 17:05:15 +010077# * component_release_XXX: tests that the CI should skip during PR testing.
Gilles Peskine878cf602019-01-06 20:50:38 +000078# * support_XXX: if support_XXX exists and returns false then
79# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010080# * post_XXX: things to do after running the tests.
81# * other: miscellaneous support functions.
82#
Gilles Peskinec70637a2019-01-09 22:29:17 +010083# Each component must start by invoking `msg` with a short informative message.
84#
Gilles Peskinea681c592020-03-28 21:27:40 +010085# Warning: due to the way bash detects errors, the failure of a command
86# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
87#
Gilles Peskinece266c42020-03-28 18:50:43 +010088# Each component is executed in a separate shell process. The component
89# fails if any command in it returns a non-zero status.
90#
Gilles Peskinec70637a2019-01-09 22:29:17 +010091# The framework performs some cleanup tasks after each component. This
92# means that components can assume that the working directory is in a
93# cleaned-up state, and don't need to perform the cleanup themselves.
94# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010095# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010096# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010097# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
98# `tests/Makefile` and `programs/fuzz/Makefile` from git.
99# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100100#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100101# The tests are roughly in order from fastest to slowest. This doesn't
102# have to be exact, but in general you should add slower tests towards
103# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100104
105
106
107################################################################
108#### Initialization and command line parsing
109################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100110
Gilles Peskine36647802020-03-28 18:50:49 +0100111# Abort on errors (even on the left-hand side of a pipe).
112# Treat uninitialised variables as errors.
113set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100114
Gilles Peskine076f7252022-08-30 21:02:44 +0200115# Enable ksh/bash extended file matching patterns
116shopt -s extglob
117
David Horstmann76a77382023-08-17 17:32:26 +0100118in_mbedtls_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100119 test -d include -a -d library -a -d programs -a -d tests
120}
121
Ronald Cron070e8652023-10-09 10:25:45 +0200122in_tf_psa_crypto_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100123 test -d include -a -d core -a -d drivers -a -d programs -a -d tests
David Horstmann9a6c45b2023-07-14 12:30:00 +0100124}
125
Gilles Peskine8f073122018-11-27 15:58:47 +0100126pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200127 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
128 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100129 exit 1
130 fi
131}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100132
Gilles Peskine8f073122018-11-27 15:58:47 +0100133pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100134 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100135 CONFIG_H='include/mbedtls/mbedtls_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100136 else
137 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100138 fi
John Durkopbd069d32020-10-31 22:14:03 -0700139 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100140 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200141
142 # Files that are clobbered by some jobs will be backed up. Use a different
143 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
144 # independently decide when to remove the backup file.
145 backup_suffix='.all.bak'
146 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100147 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100148 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100149 # Files clobbered by in-tree cmake
150 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
151 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200152
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200153 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100154 MEMORY=0
155 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200156 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100157 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100158
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200159 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200160 #
161 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
162 # both values are kept in sync. If you change the value here because it
163 # breaks some tests, you'll definitely want to change it in
164 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200165 RELEASE_SEED=1
166
Yanray Wang18040ed2023-11-23 21:29:56 +0800167 # Specify character collation for regular expressions and sorting with C locale
168 export LC_COLLATE=C
169
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200170 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200171 : ${MBEDTLS_TEST_PLATFORM="$(uname -s | tr -c \\n0-9A-Za-z _)-$(uname -m | tr -c \\n0-9A-Za-z _)"}
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200172 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200173 export MBEDTLS_TEST_PLATFORM
174
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000175 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100176 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100177 : ${OPENSSL_NEXT:="$OPENSSL"}
178 : ${GNUTLS_CLI:="gnutls-cli"}
179 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100180 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
181 : ${ARMC5_BIN_DIR:=/usr/bin}
182 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200183 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200184 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100185 : ${CLANG_LATEST:="clang-latest"}
186 : ${CLANG_EARLIEST:="clang-earliest"}
187 : ${GCC_LATEST:="gcc-latest"}
188 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100189 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000190 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200191 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100192 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000193 # if CC is not set, use clang by default (if present) to improve build times
194 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000195 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000196 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000197
Ronald Cronc5e81d22024-04-02 14:39:53 +0200198 if [ -n "${OPENSSL_3+set}" ]; then
199 export OPENSSL_NEXT="$OPENSSL_3"
200 fi
201
Gilles Peskine396853a2021-09-20 18:57:55 +0200202 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000203 export CTEST_OUTPUT_ON_FAILURE=1
204
Gilles Peskine8fd59422019-10-21 17:11:33 +0200205 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100206 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200207 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000208 # Normally, tests should use this compiler for ASAN testing
209 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200210
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400211 # Platform tests have an allocation that returns null
212 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400213 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400214
Gilles Peskine878cf602019-01-06 20:50:38 +0000215 # Gather the list of available components. These are the functions
216 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100217 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000218
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000219 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100220 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100221}
Andres AG38495a32016-07-12 16:54:33 +0100222
Dave Rodgman21900632024-02-26 11:41:19 +0000223setup_quiet_wrappers()
224{
225 # Pick up "quiet" wrappers for make and cmake, which don't output very much
226 # unless there is an error. This reduces logging overhead in the CI.
227 #
228 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000229 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
230 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000231 fi
232}
233
Gilles Peskinea28db922019-01-10 00:05:18 +0100234# Test whether the component $1 is included in the command line patterns.
235is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100236{
Gilles Peskine03af6782021-08-06 11:35:17 +0200237 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
238 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100239 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000240 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100241 set +f
242 case ${1#component_} in $pattern) return 0;; esac
243 done
244 set +f
245 return 1
246}
Andres AG7770ea82016-10-10 15:46:20 +0100247
Simon Butcher41eeccf2016-09-07 00:07:09 +0100248usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100249{
Gilles Peskine709346a2017-12-10 23:43:39 +0100250 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100251Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100252Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100253By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100254COMPONENT can be the name of a component or a shell wildcard pattern.
255
256Examples:
257 $0 "check_*"
258 Run all sanity checks.
259 $0 --no-armcc --except test_memsan
260 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100261
262Special options:
263 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000264 --list-all-components List all available test components and exit.
265 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100266
267General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200268 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100269 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100270 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100271 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200272 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200273 --arm-none-eabi-gcc-prefix=<string>
274 Prefix for a cross-compiler for arm-none-eabi
275 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200276 --arm-linux-gnueabi-gcc-prefix=<string>
277 Prefix for a cross-compiler for arm-linux-gnueabi
278 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100279 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200280 --restore First clean up the build tree, restoring backed up
281 files. Do not run any components unless they are
282 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100283 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200284 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100285 --except Exclude the COMPONENTs listed on the command line,
286 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200287 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100288 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100289 --no-force Refuse to overwrite modified files (default).
290 --no-keep-going Stop at the first error (default).
291 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800292 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100293 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200294 --outcome-file=<path> File where test outcomes are written (not done if
295 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100296 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200297 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100298 -s|--seed Integer seed value to use for this test run.
299
300Tool path options:
301 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
302 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100303 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
304 --clang-latest=<Clang_latest_path> Latest version of clang available
305 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
306 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100307 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
308 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100309 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100310 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100311EOF
SimonB2e23c822016-04-16 21:54:39 +0100312}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100313
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200314# Cleanup before/after running a component.
315# Remove built files as well as the cmake cache/config.
316# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100317cleanup()
318{
David Horstmann76a77382023-08-17 17:32:26 +0100319 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100320 command make clean
321 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200322
Gilles Peskine31b07e22018-03-21 12:15:06 +0100323 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000324 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100325 -iname CMakeFiles -exec rm -rf {} \+ -o \
326 \( -iname cmake_install.cmake -o \
327 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200328 -iname CMakeCache.txt -o \
329 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100330 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200331 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200332
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100333 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
334 rm -rf programs/test/cmake_subproject/build
335 rm -f programs/test/cmake_subproject/Makefile
336 rm -f programs/test/cmake_subproject/cmake_subproject
337
Chris Kayd259e342021-03-25 16:03:25 +0000338 # Remove any artifacts from the component_test_cmake_as_package test.
339 rm -rf programs/test/cmake_package/build
340 rm -f programs/test/cmake_package/Makefile
341 rm -f programs/test/cmake_package/cmake_package
342
343 # Remove any artifacts from the component_test_cmake_as_installed_package test.
344 rm -rf programs/test/cmake_package_install/build
345 rm -f programs/test/cmake_package_install/Makefile
346 rm -f programs/test/cmake_package_install/cmake_package_install
347
Gilles Peskinef83eb822020-03-30 20:11:39 +0200348 # Restore files that may have been clobbered by the job
349 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200350 if [[ -e "$x$backup_suffix" ]]; then
351 cp -p "$x$backup_suffix" "$x"
352 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200353 done
354}
John Durkopbd069d32020-10-31 22:14:03 -0700355
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200356# Final cleanup when this script exits (except when exiting on a failure
357# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200358final_cleanup () {
359 cleanup
360
361 for x in $files_to_back_up; do
362 rm -f "$x$backup_suffix"
363 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100364}
365
Gilles Peskine7c652162017-12-11 00:01:40 +0100366# Executed on exit. May be redefined depending on command line options.
367final_report () {
368 :
369}
370
371fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200372 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100373 final_report $1
374 trap - $1
375 kill -$1 $$
376}
377
378trap 'fatal_signal HUP' HUP
379trap 'fatal_signal INT' INT
380trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200381
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200382# Number of processors on this machine. Used as the default setting
383# for parallel make.
384all_sh_nproc ()
385{
386 {
387 nproc || # Linux
388 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
389 sysctl -n hw.ncpu || # FreeBSD
390 echo 1
391 } 2>/dev/null
392}
393
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100394msg()
395{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100396 if [ -n "${current_component:-}" ]; then
397 current_section="${current_component#component_}: $1"
398 else
399 current_section="$1"
400 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200401
402 if [ $QUIET -eq 1 ]; then
403 return
404 fi
405
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100406 echo ""
407 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100408 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000409 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100410 echo "******************************************************************"
411}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100412
Gilles Peskine8f073122018-11-27 15:58:47 +0100413armc6_build_test()
414{
415 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100416
Gilles Peskine18487f62020-04-30 23:11:54 +0200417 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800418 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100419 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000420 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200421
422 msg "size: ARM Compiler 6 ($FLAGS)"
423 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100424}
Andres AGa5cd9732016-10-17 15:23:10 +0100425
Andres AGd9eba4b2016-08-26 14:42:14 +0100426err_msg()
427{
428 echo "$1" >&2
429}
430
431check_tools()
432{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200433 for tool in "$@"; do
434 if ! `type "$tool" >/dev/null 2>&1`; then
435 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100436 exit 1
437 fi
438 done
439}
440
Gilles Peskine8f073122018-11-27 15:58:47 +0100441pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000442 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100443 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100444 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100445 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200446 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000447 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100448
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000449 # Note that legacy options are ignored instead of being omitted from this
450 # list of options, so invocations that worked with previous version of
451 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100452 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100453 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200454 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200455 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200456 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000457 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100458 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
459 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100460 --clang-earliest) shift; CLANG_EARLIEST="$1";;
461 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100462 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000463 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100464 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100465 --gcc-earliest) shift; GCC_EARLIEST="$1";;
466 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100467 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200468 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
469 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100470 --gnutls-serv) shift; GNUTLS_SERV="$1";;
471 --help|-h) usage; exit;;
472 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000473 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100474 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100475 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200476 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000477 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --no-force) FORCE=0;;
479 --no-keep-going) KEEP_GOING=0;;
480 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200481 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100482 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200484 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100485 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200486 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100487 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200488 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200489 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100490 --seed|-s) shift; SEED="$1";;
491 -*)
492 echo >&2 "Unknown option: $1"
493 echo >&2 "Run $0 --help for usage."
494 exit 120
495 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000496 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100497 esac
498 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100499 done
SimonB2e23c822016-04-16 21:54:39 +0100500
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100501 # Exclude components that are not supported on this platform.
502 SUPPORTED_COMPONENTS=
503 for component in $ALL_COMPONENTS; do
504 case $(type "support_$component" 2>&1) in
505 *' function'*)
506 if ! support_$component; then continue; fi;;
507 esac
508 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
509 done
510
511 if [ $list_components -eq 1 ]; then
512 printf '%s\n' $SUPPORTED_COMPONENTS
513 exit
514 fi
515
Gilles Peskinea28db922019-01-10 00:05:18 +0100516 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200517 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000518 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100519 fi
520
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000521 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
522 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100523 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000524 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100525 fi
SimonB2e23c822016-04-16 21:54:39 +0100526
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200527 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100528 if [ $all_except -eq 0 ]; then
529 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200530 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
531 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200532 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100533 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200534 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200535 # If the requested name includes a wildcard character, don't
536 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100537 case $component in
538 *[*?\[]*) continue;;
539 esac
540 case " $SUPPORTED_COMPONENTS " in
541 *" $component "*) :;;
542 *)
543 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
544 unsupported=$((unsupported + 1));;
545 esac
546 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200547 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100548 if [ $unsupported -ne 0 ]; then
549 exit 2
550 fi
551 fi
552
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000553 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100554 RUN_COMPONENTS=
555 for component in $SUPPORTED_COMPONENTS; do
556 if is_component_included "$component"; [ $? -eq $all_except ]; then
557 RUN_COMPONENTS="$RUN_COMPONENTS $component"
558 fi
559 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000560
561 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000562 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100563}
SimonB2e23c822016-04-16 21:54:39 +0100564
Gilles Peskine8f073122018-11-27 15:58:47 +0100565pre_check_git () {
566 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100567 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100568 git checkout-index -f -q $CONFIG_H
569 cleanup
570 else
SimonB2e23c822016-04-16 21:54:39 +0100571
Gilles Peskine8f073122018-11-27 15:58:47 +0100572 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
573 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
574 echo "You can either delete this directory manually, or force the test by rerunning"
575 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
576 exit 1
577 fi
578
Ronald Cron7a93ac52023-07-20 09:49:12 +0200579 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100580 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100581 echo "You can either delete or preserve your work, or force the test by rerunning the"
582 echo "script as: $0 --force"
583 exit 1
584 fi
SimonB2e23c822016-04-16 21:54:39 +0100585 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500586}
587
Gilles Peskine568f53a2021-07-12 18:16:01 +0200588pre_restore_files () {
589 # If the makefiles have been generated by a framework such as cmake,
590 # restore them from git. If the makefiles look like modifications from
591 # the ones checked into git, take care not to modify them. Whatever
592 # this function leaves behind is what the script will restore before
593 # each component.
594 case "$(head -n1 Makefile)" in
595 *[Gg]enerated*)
596 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
597 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
598 ;;
599 esac
600}
601
Gilles Peskinef83eb822020-03-30 20:11:39 +0200602pre_back_up () {
603 for x in $files_to_back_up; do
604 cp -p "$x" "$x$backup_suffix"
605 done
606}
607
Gilles Peskine8f073122018-11-27 15:58:47 +0100608pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100609 failure_count=0 # Number of failed components
610 last_failure_status=0 # Last failure status in this component
611
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100612 # See err_trap
613 previous_failure_status=0
614 previous_failed_command=
615 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100616 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100617
Gilles Peskine7c652162017-12-11 00:01:40 +0100618 start_red=
619 end_color=
620 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100621 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100622 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
623 start_red=$(printf '\033[31m')
624 end_color=$(printf '\033[0m')
625 ;;
626 esac
627 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100628
629 # Keep a summary of failures in a file. We'll print it out at the end.
630 failure_summary_file=$PWD/all-sh-failures-$$.log
631 : >"$failure_summary_file"
632
633 # Whether it makes sense to keep a component going after the specified
634 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200635 # This function normally receives the failing simple command
636 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
637 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100638 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200639 # False positives result in running things that can't be expected to
640 # work. False negatives result in things not running after something else
641 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100642 can_keep_going_after_failure () {
643 case "$1" in
644 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200645 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100646 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200647 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
648 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
649 *make*check*) true;;
650 "grep "*) true;;
651 "[ "*) true;;
652 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100653 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100654 esac
655 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100656
657 # This function runs if there is any error in a component.
658 # It must either exit with a nonzero status, or set
659 # last_failure_status to a nonzero value.
660 err_trap () {
661 # Save $? (status of the failing command). This must be the very
662 # first thing, before $? is overridden.
663 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100664 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100665
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100666 if [[ $last_failure_status -eq $previous_failure_status &&
667 "$failed_command" == "$previous_failed_command" &&
668 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
669 then
670 # The same command failed twice in a row, but this time one level
671 # less deep in the function call stack. This happens when the last
672 # command of a function returns a nonzero status, and the function
673 # returns that same status. Ignore the second failure.
674 previous_failure_funcall_depth=${#FUNCNAME[@]}
675 return
676 fi
677 previous_failure_status=$last_failure_status
678 previous_failed_command=$failed_command
679 previous_failure_funcall_depth=${#FUNCNAME[@]}
680
Gilles Peskinece266c42020-03-28 18:50:43 +0100681 text="$current_section: $failed_command -> $last_failure_status"
682 echo "${start_red}^^^^$text^^^^${end_color}" >&2
683 echo "$text" >>"$failure_summary_file"
684
685 # If the command is fatal (configure or build command), stop this
686 # component. Otherwise (test command) keep the component running
687 # (run more tests from the same build).
688 if ! can_keep_going_after_failure "$failed_command"; then
689 exit $last_failure_status
690 fi
691 }
692
Gilles Peskine7c652162017-12-11 00:01:40 +0100693 final_report () {
694 if [ $failure_count -gt 0 ]; then
695 echo
696 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100697 echo "${start_red}FAILED: $failure_count components${end_color}"
698 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100699 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
700 elif [ -z "${1-}" ]; then
701 echo "SUCCESS :)"
702 fi
703 if [ -n "${1-}" ]; then
704 echo "Killed by SIG$1."
705 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100706 rm -f "$failure_summary_file"
707 if [ $failure_count -gt 0 ]; then
708 exit 1
709 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100710 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100711}
712
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200713# record_status() and if_build_succeeded() are kept temporarily for backward
714# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100715record_status () {
716 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100717}
Gilles Peskine7c652162017-12-11 00:01:40 +0100718if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100719 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100720}
721
Gilles Peskinea681c592020-03-28 21:27:40 +0100722# '! true' does not trigger the ERR trap. Arrange to trigger it, with
723# a reasonably informative error message (not just "$@").
724not () {
725 if "$@"; then
726 report_failed_command="! $*"
727 false
728 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200729 fi
730}
731
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200732pre_prepare_outcome_file () {
733 case "$MBEDTLS_TEST_OUTCOME_FILE" in
734 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
735 esac
736 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
737 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
738 fi
739}
740
Gilles Peskine8f073122018-11-27 15:58:47 +0100741pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200742 if [ $QUIET -eq 1 ]; then
743 return
744 fi
745
Gilles Peskine8f073122018-11-27 15:58:47 +0100746 msg "info: $0 configuration"
747 echo "MEMORY: $MEMORY"
748 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200749 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100750 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100751 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100752 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100753 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
754 echo "GNUTLS_CLI: $GNUTLS_CLI"
755 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100756 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
757 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
758}
Andres AG7770ea82016-10-10 15:46:20 +0100759
Andres AGd9eba4b2016-08-26 14:42:14 +0100760# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100761pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000762 # Build the list of variables to pass to output_env.sh.
763 set env
SimonB2e23c822016-04-16 21:54:39 +0100764
Gilles Peskine87964262019-01-06 22:40:00 +0000765 case " $RUN_COMPONENTS " in
766 # Require OpenSSL and GnuTLS if running any tests (as opposed to
767 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
768 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100769 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000770 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
771 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100772 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000773 export GNUTLS_CLI="$GNUTLS_CLI"
774 export GNUTLS_SERV="$GNUTLS_SERV"
775 # Avoid passing --seed flag in every call to ssl-opt.sh
776 if [ -n "${SEED-}" ]; then
777 export SEED
778 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200779 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000780 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200781 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
782 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000783 ;;
784 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200785
Gilles Peskine87964262019-01-06 22:40:00 +0000786 case " $RUN_COMPONENTS " in
787 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
788 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100789
Gilles Peskine87964262019-01-06 22:40:00 +0000790 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200791 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000792 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100793
Gilles Peskine87964262019-01-06 22:40:00 +0000794 case " $RUN_COMPONENTS " in
795 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
796 esac
797
798 case " $RUN_COMPONENTS " in
799 *" test_zeroize "*) check_tools "gdb";;
800 esac
801
802 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000803 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000804 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
805 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200806 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000807 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
808 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200809 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
810 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
811 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000812 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000813
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200814 # past this point, no call to check_tool, only printing output
815 if [ $QUIET -eq 1 ]; then
816 return
817 fi
818
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000819 msg "info: output_env.sh"
820 case $RUN_COMPONENTS in
821 *_armcc*)
822 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
823 *) set "$@" RUN_ARMCC=0;;
824 esac
825 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100826}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100827
Gilles Peskine1570b592021-04-22 01:10:12 +0200828pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200829 # since make doesn't have proper dependencies, remove any possibly outdate
830 # file that might be around before generating fresh ones
831 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200832 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200833 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200834 else
835 make generated_files
836 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200837}
838
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000839clang_version() {
840 if command -v clang > /dev/null ; then
841 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
842 else
843 echo 0 # report version 0 for "no clang"
844 fi
845}
846
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200847################################################################
848#### Helpers for components using libtestdriver1
849################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100850
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200851# How to use libtestdriver1
852# -------------------------
853#
854# 1. Define the list algorithms and key types to accelerate,
855# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
856# Examples:
857# - loc_accel_list="ALG_JPAKE"
858# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200859# 2. Make configurations changes for the driver and/or main libraries.
860# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
861# can be either "default" to start with the default config, or a name
862# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200863# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200864# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
865# These changes affect both the driver and the main libraries.
866# (Note: they need to have the same set of PSA_WANT symbols, as that
867# determines the ABI between them.)
868# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
869# main libraries. Typically, you want to disable the module(s) that are
870# being accelerated. You may need to also disable modules that depend
871# on them or options that are not supported with drivers.
872# 2d. On top of psa/crypto_config.h, the driver library uses its own config
873# file: tests/include/test/drivers/config_test_driver.h. You usually
874# don't need to edit it: using loc_extra_list (see below) is preferred.
875# However, when there's no PSA symbol for what you want to enable,
876# calling scripts/config.py on this file remains the only option.
877# 3. Build the driver library, then the main libraries, test, and programs.
878# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
879# need to enable more algorithms here, typically hash algorithms when
880# accelerating some signature algorithms (ECDSA, RSAv2). This is done
881# by passing a 2nd argument listing the extra algorithms.
882# Example:
883# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
884# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800885# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200886# additional arguments will be passed to make: this can be useful if
887# you don't want to build everything when iterating during development.
888# Example:
889# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
890# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200891
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200892# Adjust the configuration - for both libtestdriver1 and main library,
893# as they should have the same PSA_WANT macros.
894helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200895 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200896 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200897 if [ "$base_config" != "default" ]; then
898 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200899 fi
900
901 # Enable PSA-based config (necessary to use drivers)
902 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
903
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200904 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
905 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
906 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000907
908 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
909 # otherwise we will end up running multithreaded tests without mutexes to protect them.
910 if scripts/config.py get MBEDTLS_THREADING_C; then
911 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
912 fi
913
914 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
915 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
916 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200917}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100918
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100919# Build the drivers library libtestdriver1.a (with ASan).
920#
921# Parameters:
922# 1. a space-separated list of things to accelerate;
923# 2. optional: a space-separate list of things to also support.
924# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
925helper_libtestdriver1_make_drivers() {
926 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
927 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
928}
929
930# Build the main libraries, programs and tests,
931# linking to the drivers library (with ASan).
932#
933# Parameters:
934# 1. a space-separated list of things to accelerate;
935# *. remaining arguments if any are passed directly to make
936# (examples: lib, -C tests test_suite_xxx, etc.)
937# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
938helper_libtestdriver1_make_main() {
939 loc_accel_list=$1
940 shift
941
942 # we need flags both with and without the LIBTESTDRIVER1_ prefix
943 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
944 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
945 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include -I../tests -I../../tests -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_TEST_LIBTESTDRIVER1 $loc_accel_flags" LDFLAGS="-ltestdriver1 $ASAN_CFLAGS" "$@"
946}
947
Valerio Settid1b6ef12024-05-07 16:00:21 +0200948# $1: target which can be "client" or "server"
949helper_crypto_client_build() {
950 TARGET=$1
Valerio Settic98f8ab2024-05-10 15:53:40 +0200951 shift
Valerio Settid1b6ef12024-05-07 16:00:21 +0200952 TARGET_LIB=libpsa$TARGET
953
Valerio Settid1b6ef12024-05-07 16:00:21 +0200954 if [ "$TARGET" == "client" ]; then
955 scripts/config.py full
956 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
957 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
958 # Dynamic secure element support is a deprecated feature and it is not
959 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
960 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
961 # Disable potentially problematic features
962 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
963 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
964 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
965 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
966 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
967 else
968 scripts/config.py crypto_full
969 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
970 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200971 fi
972
Valerio Settif57afd52024-05-14 10:39:20 +0200973 make -C tests/psa-client-server/psasim/ CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
Valerio Settid1b6ef12024-05-07 16:00:21 +0200974
Valerio Settif57afd52024-05-14 10:39:20 +0200975 # cleanup() will restore some backed-up files which include $CONFIG_H and
976 # $CRYPTO_CONFIG_H. Built libraries were already copied to psasim at this
977 # point.
978 cleanup
Valerio Settid1b6ef12024-05-07 16:00:21 +0200979}
980
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100981################################################################
982#### Configuration helpers
983################################################################
984
Valerio Settib2fd6732023-08-15 17:10:47 +0200985# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200986# The function optionally accepts 1 parameter: a space-separated list of the
987# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200988helper_disable_builtin_curves() {
989 allowed_list="${1:-}"
990 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
991
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200992 for curve in $allowed_list; do
993 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200994 done
995}
996
997# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
998# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
999# in the following helpers.
1000helper_get_psa_curve_list () {
1001 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001002 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1003 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001004 done
1005
1006 echo "$loc_list"
1007}
1008
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001009# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1010# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1011# in the following helpers.
1012helper_get_psa_dh_group_list () {
1013 loc_list=""
1014 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1015 loc_list="$loc_list $item"
1016 done
1017
1018 echo "$loc_list"
1019}
1020
Valerio Settib2fd6732023-08-15 17:10:47 +02001021# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001022# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001023# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001024helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001025 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001026 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001027 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 +02001028 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1029 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001030 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1031 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001032 fi
1033 done
1034
1035 echo "$loc_list"
1036}
1037
Gilles Peskine192c72f2017-12-21 15:59:21 +01001038################################################################
1039#### Basic checks
1040################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001041
1042#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001043# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001044#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001045# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001046# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001047# 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 +02001048# time, so start with a GCC build).
1049# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001050#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001051# Indicative running times are given for reference.
1052
Gilles Peskine8f073122018-11-27 15:58:47 +01001053component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001054 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001055 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001056}
Janos Follathb72c6782016-07-19 14:54:17 +01001057
Gilles Peskine67debb62021-05-18 16:09:50 +02001058component_check_generated_files () {
1059 msg "Check: check-generated-files, files generated with make" # 2s
1060 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001061 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001062
1063 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001064 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001065 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001066 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001067
1068 msg "Check: check-generated-files -u, files absent" # 2s
1069 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001070 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001071 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001072 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001073
1074 # This component ends with the generated files present in the source tree.
1075 # This is necessary for subsequent components!
1076}
1077
Gilles Peskine8f073122018-11-27 15:58:47 +01001078component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001079 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001080 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001081}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001082
Gilles Peskine8f073122018-11-27 15:58:47 +01001083component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001084 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001085 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001086}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001087
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001088component_check_changelog () {
1089 msg "Check: changelog entries" # < 1s
1090 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001091 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001092 if [ -e ChangeLog.new ]; then
1093 # Show the diff for information. It isn't an error if the diff is
1094 # non-empty.
1095 diff -u ChangeLog ChangeLog.new || true
1096 rm ChangeLog.new
1097 fi
1098}
1099
Gilles Peskine8f073122018-11-27 15:58:47 +01001100component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001101 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001102 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001103}
Darryl Greena07039c2018-03-13 16:48:16 +00001104
Gilles Peskine895868b2019-09-19 21:30:05 +02001105component_check_test_cases () {
1106 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001107 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001108 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001109 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001110 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001111 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001112 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001113 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001114}
1115
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001116component_check_test_dependencies () {
1117 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001118 # The purpose of this component is to catch unjustified dependencies on
1119 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1120 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1121 # MBEDTLS_PSA_xxx).
1122 #
1123 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1124 # this component is meant to catch. However a few of them are justified,
1125 # mostly by the absence of a PSA equivalent, so this component includes a
1126 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001127
1128 found="check-test-deps-found-$$"
1129 expected="check-test-deps-expected-$$"
1130
1131 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001132 grep 'depends_on' \
1133 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001134 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001135 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001136 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001137
Yanray Wang18040ed2023-11-23 21:29:56 +08001138 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001139 rm -f $expected
1140 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1141 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001142 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1143 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001144 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1145 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001146 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1147 # the test code and that's probably the most convenient way of achieving
1148 # the test's goal.
1149 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1150 # No PSA equivalent - we should probably have one in the future.
1151 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1152 # No PSA equivalent - needed by some init tests
1153 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001154 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001155 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001156
1157 # Compare reality with expectation.
1158 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001159 #
1160 # The output should be empty. When it's not:
1161 # - Each '+' line is a macro that was found but not expected. You want to
1162 # find where that macro occurs, and either replace it with PSA macros, or
1163 # add it to the exceptions list above with a justification.
1164 # - Each '-' line is a macro that was expected but not found; it means the
1165 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001166 diff -U0 $expected $found
1167
1168 rm $found $expected
1169}
1170
Gilles Peskine8f073122018-11-27 15:58:47 +01001171component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001172 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001173 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001174}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001175
Gilles Peskine192c72f2017-12-21 15:59:21 +01001176
Gilles Peskine636c26a2020-03-04 20:46:15 +01001177
Gilles Peskine192c72f2017-12-21 15:59:21 +01001178################################################################
1179#### Build and test many configurations and targets
1180################################################################
1181
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001182component_test_default_out_of_box () {
1183 msg "build: make, default config (out-of-box)" # ~1min
1184 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001185 # Disable fancy stuff
1186 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001187
1188 msg "test: main suites make, default config (out-of-box)" # ~10s
1189 make test
1190
1191 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001192 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001193
1194 msg "program demos: make, default config (out-of-box)" # ~10s
1195 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001196}
1197
Gilles Peskine8f073122018-11-27 15:58:47 +01001198component_test_default_cmake_gcc_asan () {
1199 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001200 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1201 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001202
Gilles Peskine8f073122018-11-27 15:58:47 +01001203 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1204 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001205
Gilles Peskine82b27272019-06-14 18:27:03 +02001206 msg "program demos (ASan build)" # ~10s
1207 tests/scripts/run_demos.py
1208
Gilles Peskine97bea012020-04-23 23:37:45 +02001209 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001210 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001211
Gilles Peskine6848d172023-11-02 19:58:03 +01001212 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001213 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001214
Gilles Peskine8f073122018-11-27 15:58:47 +01001215 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001216 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001217
Gilles Peskine8f073122018-11-27 15:58:47 +01001218 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001219 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001220
1221 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001222 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001223}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001224
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001225component_test_default_cmake_gcc_asan_new_bignum () {
1226 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001227 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001228 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001229 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001230
1231 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1232 make test
1233
1234 msg "test: selftest (ASan build)" # ~ 10s
1235 programs/test/selftest
1236
1237 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1238 tests/ssl-opt.sh
1239
1240 msg "test: compat.sh (ASan build)" # ~ 6 min
1241 tests/compat.sh
1242
1243 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1244 tests/context-info.sh
1245}
1246
Hanno Becker01635512019-02-26 14:27:09 +00001247component_test_full_cmake_gcc_asan () {
1248 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001249 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001250 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1251 make
1252
1253 msg "test: main suites (inc. selftests) (full config, ASan build)"
1254 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001255
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001256 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001257 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001258
Gilles Peskine636c26a2020-03-04 20:46:15 +01001259 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001260 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001261
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001262 # Note: the next two invocations cover all compat.sh test cases.
1263 # We should use the same here and in basic-build-test.sh.
1264 msg "test: compat.sh: default version (full config, ASan build)"
1265 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001266
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001267 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1268 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001269
1270 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001271 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001272}
1273
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001274
1275component_test_full_cmake_gcc_asan_new_bignum () {
1276 msg "build: full config, cmake, gcc, ASan"
1277 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001278 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001279 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001280 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001281
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001282 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001283 make test
1284
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001285 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001286 programs/test/selftest
1287
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001288 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001289 tests/ssl-opt.sh
1290
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001291 # Note: the next two invocations cover all compat.sh test cases.
1292 # We should use the same here and in basic-build-test.sh.
1293 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1294 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001295
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001296 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1297 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001298
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001299 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001300 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001301}
1302
Ronald Cronc3623db2020-10-29 10:51:32 +01001303component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001304 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001305 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001306 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1307 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1308 make
1309
1310 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1311 make test
1312}
1313
David Horstmann4a48bec2024-03-13 15:42:31 +00001314component_test_psa_assume_exclusive_buffers () {
1315 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001316 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001317 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001318 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1319 make
1320
David Horstmann4a48bec2024-03-13 15:42:31 +00001321 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001322 make test
1323}
1324
Gilles Peskinea3548672021-06-17 11:37:52 +02001325# check_renamed_symbols HEADER LIB
1326# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1327# name is LIB.
1328check_renamed_symbols () {
1329 ! nm "$2" | sed 's/.* //' |
1330 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1331}
1332
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001333component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001334 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001335 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001336 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1337 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1338 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1339 # We can only compile, not link, since our test and sample programs
1340 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1341 # is active.
1342 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001343
1344 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1345 # version is not present.
1346 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001347 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001348}
1349
Valerio Setti63097752024-03-12 13:18:13 +01001350# Get a list of library-wise undefined symbols and ensure that they only
1351# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1352# This function is a common helper used by both:
1353# - component_test_default_psa_crypto_client_without_crypto_provider
1354# - component_build_full_psa_crypto_client_without_crypto_provider.
1355common_check_mbedtls_missing_symbols() {
1356 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1357 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1358 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1359 not grep mbedtls_ linking_errors.txt
1360
1361 rm sym_def.txt sym_undef.txt linking_errors.txt
1362}
1363
1364component_test_default_psa_crypto_client_without_crypto_provider () {
1365 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1366
Ronald Cron336678b2021-01-28 17:54:24 +01001367 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1368 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001369 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001370 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001371 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001372 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001373
Ronald Cron336678b2021-01-28 17:54:24 +01001374 make
1375
Valerio Setti63097752024-03-12 13:18:13 +01001376 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1377 common_check_mbedtls_missing_symbols
1378
1379 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001380 make test
1381}
1382
Valerio Setti63097752024-03-12 13:18:13 +01001383component_build_full_psa_crypto_client_without_crypto_provider () {
1384 msg "build: full config - PSA_CRYPTO_C"
1385
1386 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1387 scripts/config.py full
1388
1389 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1390 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1391 # Dynamic secure element support is a deprecated feature and it is not
1392 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1393 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1394
1395 # Since there is no crypto provider in this build it is not possible to
1396 # build all the test executables and progrems due to missing PSA functions
1397 # at link time. Therefore we will just build libraries and we'll check
1398 # that symbols of interest are there.
1399 make lib
1400
1401 msg "check missing symbols: full config - PSA_CRYPTO_C"
1402
1403 common_check_mbedtls_missing_symbols
1404
1405 # Ensure that desired functions are included into the build (extend the
1406 # following list as required).
1407 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1408 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1409 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1410}
1411
Ryan Everettdaa322a2024-04-18 16:48:55 +01001412component_test_no_rsa_key_pair_generation() {
1413 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001414 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001415 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001416 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001417 make
1418
Ryan Everettdaa322a2024-04-18 16:48:55 +01001419 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001420 make test
1421}
1422
Gilles Peskine782f4112018-11-27 16:11:09 +01001423component_test_ref_configs () {
1424 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001425 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1426 # want to re-generate generated files that depend on it, quite correctly.
1427 # However this doesn't work as the generation script expects a specific
1428 # format for mbedtls_config.h, which the other files don't follow. Also,
1429 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001430 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001431 # whether they're on or off. So, disable cmake's (over-sensitive here)
1432 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001433 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001434 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001435 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001436}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001437
Gilles Peskine8f073122018-11-27 15:58:47 +01001438component_test_no_renegotiation () {
1439 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001440 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001441 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001442 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001443
Gilles Peskine8f073122018-11-27 15:58:47 +01001444 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1445 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001446
Gilles Peskine8f073122018-11-27 15:58:47 +01001447 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001448 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001449}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001450
Gilles Peskine636c26a2020-03-04 20:46:15 +01001451component_test_no_pem_no_fs () {
1452 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1453 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1454 scripts/config.py unset MBEDTLS_FS_IO
1455 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1456 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001457 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001458 make
1459
1460 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1461 make test
1462
1463 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001464 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001465}
1466
Gilles Peskine8f073122018-11-27 15:58:47 +01001467component_test_rsa_no_crt () {
1468 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001469 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001470 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001471 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001472
Gilles Peskine8f073122018-11-27 15:58:47 +01001473 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1474 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001475
Gilles Peskine8f073122018-11-27 15:58:47 +01001476 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001477 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001478
Gilles Peskine8f073122018-11-27 15:58:47 +01001479 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001480 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001481
1482 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001483 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001484}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001485
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001486component_test_no_ctr_drbg_classic () {
1487 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001488 scripts/config.py full
1489 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001490 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001491 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001492
Dave Rodgman17127e92023-12-14 16:42:48 +00001493 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001494 make
1495
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001496 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001497 make test
1498
Gilles Peskineba749042021-01-13 20:02:03 +01001499 # In this configuration, the TLS test programs use HMAC_DRBG.
1500 # The SSL tests are slow, so run a small subset, just enough to get
1501 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001502 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001503 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001504
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001505 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001506 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001507}
1508
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001509component_test_no_ctr_drbg_use_psa () {
1510 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001511 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001512 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1513 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001514
Dave Rodgman17127e92023-12-14 16:42:48 +00001515 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001516 make
1517
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001518 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1519 make test
1520
1521 # In this configuration, the TLS test programs use HMAC_DRBG.
1522 # The SSL tests are slow, so run a small subset, just enough to get
1523 # confidence that the SSL code copes with HMAC_DRBG.
1524 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001525 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001526
1527 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001528 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001529}
1530
1531component_test_no_hmac_drbg_classic () {
1532 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1533 scripts/config.py full
1534 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1535 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1536 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001537 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001538
Dave Rodgman17127e92023-12-14 16:42:48 +00001539 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001540 make
1541
1542 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001543 make test
1544
Gilles Peskinea2224342020-11-19 22:14:34 +01001545 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1546 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1547 # instead.
1548 # Test SSL with non-deterministic ECDSA. Only test features that
1549 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001550 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001551 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001552
1553 # To save time, only test one protocol version, since this part of
1554 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001555 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001556 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001557}
1558
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001559component_test_no_hmac_drbg_use_psa () {
1560 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1561 scripts/config.py full
1562 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1563 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1564 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1565
Dave Rodgman17127e92023-12-14 16:42:48 +00001566 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001567 make
1568
1569 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1570 make test
1571
1572 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1573 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1574 # instead.
1575 # Test SSL with non-deterministic ECDSA. Only test features that
1576 # might be affected by how ECDSA signature is performed.
1577 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001578 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001579
1580 # To save time, only test one protocol version, since this part of
1581 # the protocol is identical in (D)TLS up to 1.2.
1582 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001583 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001584}
1585
1586component_test_psa_external_rng_no_drbg_classic () {
1587 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1588 scripts/config.py full
1589 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001590 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001591 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001592 scripts/config.py unset MBEDTLS_ENTROPY_C
1593 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1594 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001595 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1596 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1597 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001598 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1599 # the SSL test programs don't have an RNG and can't work. Explicitly
1600 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001601 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001602
1603 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1604 make test
1605
Gilles Peskine8eb29432021-02-03 20:07:11 +01001606 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001607 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001608}
1609
1610component_test_psa_external_rng_no_drbg_use_psa () {
1611 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001612 scripts/config.py full
1613 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001614 scripts/config.py unset MBEDTLS_ENTROPY_C
1615 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1616 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001617 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1618 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1619 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001620 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001621
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001622 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001623 make test
1624
Gilles Peskine8eb29432021-02-03 20:07:11 +01001625 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001626 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001627}
1628
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001629component_test_psa_external_rng_use_psa_crypto () {
1630 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1631 scripts/config.py full
1632 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1633 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1634 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001635 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001636
1637 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1638 make test
1639
1640 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1641 tests/ssl-opt.sh -f 'Default\|opaque'
1642}
1643
Gilles Peskine801c4332023-04-28 21:04:28 +02001644component_test_psa_inject_entropy () {
1645 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1646 scripts/config.py full
1647 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1648 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1649 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1650 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1651 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1652 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001653 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine801c4332023-04-28 21:04:28 +02001654
1655 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1656 make test
1657}
1658
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001659component_test_sw_inet_pton () {
1660 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1661
1662 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1663 scripts/config.py set MBEDTLS_TEST_HOOKS
1664 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1665
1666 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1667 make test
1668}
1669
Valerio Settia41654d2024-02-08 10:33:11 +01001670component_full_no_pkparse_pkwrite() {
1671 msg "build: full without pkparse and pkwrite"
1672
1673 scripts/config.py crypto_full
1674 scripts/config.py unset MBEDTLS_PK_PARSE_C
1675 scripts/config.py unset MBEDTLS_PK_WRITE_C
1676
Valerio Settia41654d2024-02-08 10:33:11 +01001677 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1678
1679 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1680 not grep mbedtls_pk_parse_key library/pkparse.o
1681 not grep mbedtls_pk_write_key_der library/pkwrite.o
1682
1683 msg "test: full without pkparse and pkwrite"
1684 make test
1685}
1686
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001687component_test_crypto_full_md_light_only () {
1688 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001689 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001690 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001691 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001692 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001693 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001694 scripts/config.py unset MBEDTLS_HKDF_C
1695 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001696 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001697 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001698 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001699 # Disable things that would auto-enable MD_C
1700 scripts/config.py unset MBEDTLS_PKCS5_C
1701
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001702 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1703 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001704 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001705
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001706 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001707 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001708 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001709
1710 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001711 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001712}
1713
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001714component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001715 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001716 scripts/config.py full
1717 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001718 # Don't pull in cipher via PSA mechanisms
1719 # (currently ignored anyway because we completely disable PSA)
1720 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001721 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001722 scripts/config.py unset MBEDTLS_CMAC_C
1723 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001724 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001725 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001726 scripts/config.py unset MBEDTLS_SSL_TLS_C
1727 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001728 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001729 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1730 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001731 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001732 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001733 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001734
Valerio Settidf17a102023-10-23 14:14:19 +02001735 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001736 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001737}
1738
Valerio Setti7e710e82023-08-25 09:14:15 +02001739# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001740# - component_test_full_no_cipher_with_psa_crypto
1741# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001742# It accepts 2 input parameters:
1743# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1744# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001745common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001746 USE_CRYPTO_CONFIG="$1"
1747 COMPONENT_DESCRIPTION="$2"
1748
1749 msg "build: $COMPONENT_DESCRIPTION"
1750
1751 scripts/config.py full
1752 scripts/config.py unset MBEDTLS_CIPHER_C
1753
1754 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001755 # The built-in implementation of the following algs/key-types depends
1756 # on CIPHER_C so we disable them.
1757 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1758 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001759 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001760 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1761 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1762 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1763 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1764 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1765 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1766 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1767 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001768 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001769 else
1770 # Don't pull in cipher via PSA mechanisms
1771 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001772 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1773 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1774 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001775 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001776 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001777 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001778 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001779
Gilles Peskine21570cf2023-12-22 11:49:50 +01001780 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001781
Valerio Setti7e710e82023-08-25 09:14:15 +02001782 # Ensure that CIPHER_C was not re-enabled
1783 not grep mbedtls_cipher_init library/cipher.o
1784
1785 msg "test: $COMPONENT_DESCRIPTION"
1786 make test
1787}
1788
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001789component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001790 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001791}
1792
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001793component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001794 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001795}
1796
Valerio Settibdfecb62023-11-07 15:37:20 +01001797component_test_full_no_ccm() {
1798 msg "build: full no PSA_WANT_ALG_CCM"
1799
1800 # Full config enables:
1801 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1802 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1803 scripts/config.py full
1804
1805 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1806 # enabled, but not used from TLS since USE_PSA is set.
1807 # This is helpful to ensure that TLS tests below have proper dependencies.
1808 #
1809 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1810 # PSA_WANT_ALG_CCM to be re-enabled.
1811 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1812
Gilles Peskine21570cf2023-12-22 11:49:50 +01001813 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001814
1815 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001816 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001817}
1818
1819component_test_full_no_ccm_star_no_tag() {
1820 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1821
1822 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1823 scripts/config.py full
1824
1825 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1826 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1827 # This basically disables all unauthenticated ciphers on the PSA side, while
1828 # keeping AEADs enabled.
1829 #
1830 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1831 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1832 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1833 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1834 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1835 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1836 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1837 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1838 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1839 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1840
Gilles Peskine21570cf2023-12-22 11:49:50 +01001841 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001842
1843 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001844 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001845
1846 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001847 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001848}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001849
Valerio Settie1655b82023-01-03 15:35:25 +01001850component_test_full_no_bignum () {
1851 msg "build: full minus bignum"
1852 scripts/config.py full
1853 scripts/config.py unset MBEDTLS_BIGNUM_C
1854 # Direct dependencies of bignum
1855 scripts/config.py unset MBEDTLS_ECP_C
1856 scripts/config.py unset MBEDTLS_RSA_C
1857 scripts/config.py unset MBEDTLS_DHM_C
1858 # Direct dependencies of ECP
1859 scripts/config.py unset MBEDTLS_ECDH_C
1860 scripts/config.py unset MBEDTLS_ECDSA_C
1861 scripts/config.py unset MBEDTLS_ECJPAKE_C
1862 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001863 # Disable what auto-enables ECP_LIGHT
1864 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1865 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001866 # Indirect dependencies of ECP
1867 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1868 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1869 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1870 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1871 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1872 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1873 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1874 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1875 # Direct dependencies of DHM
1876 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1877 # Direct dependencies of RSA
1878 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1879 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1880 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1881 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1882 # PK and its dependencies
1883 scripts/config.py unset MBEDTLS_PK_C
1884 scripts/config.py unset MBEDTLS_PK_PARSE_C
1885 scripts/config.py unset MBEDTLS_PK_WRITE_C
1886 scripts/config.py unset MBEDTLS_X509_USE_C
1887 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1888 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1889 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1890 scripts/config.py unset MBEDTLS_X509_CREATE_C
1891 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1892 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1893 scripts/config.py unset MBEDTLS_PKCS7_C
1894 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1895 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1896 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1897
Gilles Peskine21570cf2023-12-22 11:49:50 +01001898 make
Valerio Settie1655b82023-01-03 15:35:25 +01001899
1900 msg "test: full minus bignum"
1901 make test
1902}
1903
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001904component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001905 msg "build: default with only stream cipher"
1906
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001907 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001908 scripts/config.py unset MBEDTLS_GCM_C
1909 scripts/config.py unset MBEDTLS_CCM_C
1910 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001911 #Disable TLS 1.3 (as no AEAD)
1912 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001913 # 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 +02001914 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001915 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001916 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001917 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1918 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001919 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001920 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001921 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001922
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001923 make
1924
1925 msg "test: default with only stream cipher"
1926 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001927
1928 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001929}
1930
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001931component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001932 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001933
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001934 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001935 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001936 scripts/config.py unset MBEDTLS_GCM_C
1937 scripts/config.py unset MBEDTLS_CCM_C
1938 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001939 #Disable TLS 1.3 (as no AEAD)
1940 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001941 # 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 +02001942 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001943 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001944 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001945 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1946 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001947 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001948 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001949 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001950
Przemek Stekiel9550c052022-09-28 09:51:55 +02001951 make
1952
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001953 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001954 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001955
1956 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001957}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001958
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001959component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001960 msg "build: default with only CBC-legacy cipher"
1961
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001962 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001963 scripts/config.py unset MBEDTLS_GCM_C
1964 scripts/config.py unset MBEDTLS_CCM_C
1965 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001966 #Disable TLS 1.3 (as no AEAD)
1967 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001968 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1969 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1970 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001971 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001972 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001973 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001974 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001975 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001976 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001977
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001978 make
1979
1980 msg "test: default with only CBC-legacy cipher"
1981 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001982
1983 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1984 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001985}
1986
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001987component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001988 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001989
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001990 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001991 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001992 scripts/config.py unset MBEDTLS_GCM_C
1993 scripts/config.py unset MBEDTLS_CCM_C
1994 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001995 #Disable TLS 1.3 (as no AEAD)
1996 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001997 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1998 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1999 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002000 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002001 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002002 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002003 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002004 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002005 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002006
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002007 make
2008
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002009 msg "test: default with only CBC-legacy cipher use psa"
2010 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002011
2012 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
2013 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002014}
2015
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002016component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002017 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
2018
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002019 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002020 scripts/config.py unset MBEDTLS_GCM_C
2021 scripts/config.py unset MBEDTLS_CCM_C
2022 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002023 #Disable TLS 1.3 (as no AEAD)
2024 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002025 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2026 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2027 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2028 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2029 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002030 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002031 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002032 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002033 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002034
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002035 make
2036
2037 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
2038 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002039
2040 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
2041 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002042}
2043
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002044component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
2045 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002046
2047 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002048 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002049 scripts/config.py unset MBEDTLS_GCM_C
2050 scripts/config.py unset MBEDTLS_CCM_C
2051 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002052 #Disable TLS 1.3 (as no AEAD)
2053 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002054 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2055 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2056 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2057 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2058 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002059 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002060 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002061 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002062 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002063
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002064 make
2065
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002066 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002067 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002068
2069 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2070 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002071}
2072
Valerio Setti9f0ec532022-11-08 13:03:24 +01002073# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2074# that we could use for interop testing. However, we now have sort of two
2075# implementations ourselves: one using PSA, the other not. At least test that
2076# these two interoperate with each other.
2077component_test_tls1_2_ecjpake_compatibility() {
2078 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2079 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002080 # Explicitly make lib first to avoid a race condition:
2081 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2082 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002083 make -C programs ssl/ssl_server2 ssl/ssl_client2
2084 cp programs/ssl/ssl_server2 s2_no_use_psa
2085 cp programs/ssl/ssl_client2 c2_no_use_psa
2086
2087 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2088 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2089 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002090 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002091 make -C programs ssl/ssl_server2 ssl/ssl_client2
2092 make -C programs test/udp_proxy test/query_compile_time_config
2093
Valerio Setti70e02902022-12-02 16:21:56 +01002094 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2095 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2096 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2097 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2098 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2099 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2100 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2101 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 +01002102
2103 rm s2_no_use_psa c2_no_use_psa
2104}
2105
Gilles Peskine636c26a2020-03-04 20:46:15 +01002106component_test_everest () {
2107 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2108 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2109 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2110 make
2111
2112 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2113 make test
2114
Gilles Peskine6848d172023-11-02 19:58:03 +01002115 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002116 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002117
Gilles Peskine636c26a2020-03-04 20:46:15 +01002118 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2119 tests/ssl-opt.sh -f ECDH
2120
2121 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2122 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002123 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002124}
2125
Gilles Peskined3beca92020-07-03 00:15:37 +02002126component_test_everest_curve25519_only () {
2127 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002128 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskined3beca92020-07-03 00:15:37 +02002129 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2130 scripts/config.py unset MBEDTLS_ECDSA_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002131 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
2132 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECDSA
2133 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ALG_ECDH
Gilles Peskined3beca92020-07-03 00:15:37 +02002134 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2135 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002136 scripts/config.py unset MBEDTLS_ECJPAKE_C
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002137 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_JPAKE
2138
Gilles Peskined3beca92020-07-03 00:15:37 +02002139 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002140 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Thomas Daubneyf29bf872024-05-29 17:11:02 +01002141 scripts/config.py -f $CRYPTO_CONFIG_H unset-all "PSA_WANT_ECC_[0-9A-Z_a-z]*$"
2142 scripts/config.py -f $CRYPTO_CONFIG_H set PSA_WANT_ECC_MONTGOMERY_255
Gilles Peskined3beca92020-07-03 00:15:37 +02002143
Dave Rodgman17127e92023-12-14 16:42:48 +00002144 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002145
2146 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2147 make test
2148}
2149
Gilles Peskine8f073122018-11-27 15:58:47 +01002150component_test_small_ssl_out_content_len () {
2151 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002152 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2153 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002154 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002155 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002156
Gilles Peskine8f073122018-11-27 15:58:47 +01002157 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002158 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002159}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002160
Gilles Peskine8f073122018-11-27 15:58:47 +01002161component_test_small_ssl_in_content_len () {
2162 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002163 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2164 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002165 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002166 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002167
Gilles Peskine8f073122018-11-27 15:58:47 +01002168 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002169 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002170}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002171
Gilles Peskine8f073122018-11-27 15:58:47 +01002172component_test_small_ssl_dtls_max_buffering () {
2173 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002174 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002175 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002176 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002177
Gilles Peskine8f073122018-11-27 15:58:47 +01002178 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002179 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 +01002180}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002181
Gilles Peskine8f073122018-11-27 15:58:47 +01002182component_test_small_mbedtls_ssl_dtls_max_buffering () {
2183 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002184 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002185 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002186 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002187
Gilles Peskine8f073122018-11-27 15:58:47 +01002188 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002189 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002190}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002191
Gilles Peskine75cc7712019-09-06 19:47:17 +02002192component_test_psa_collect_statuses () {
2193 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002194 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002195 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002196 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002197 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002198 rm -f tests/statuses.log
2199}
2200
Gilles Peskine8f073122018-11-27 15:58:47 +01002201component_test_full_cmake_clang () {
2202 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002203 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002204 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 +01002205 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002206
k-stachowiak0291cb72019-06-26 15:52:12 +02002207 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002208 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002209
Gilles Peskineda6017c2022-10-30 21:02:40 +01002210 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2211 programs/test/cpp_dummy_build
2212
Gilles Peskine6848d172023-11-02 19:58:03 +01002213 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002214 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002215
Gilles Peskine82b27272019-06-14 18:27:03 +02002216 msg "program demos (full config, clang)" # ~10s
2217 tests/scripts/run_demos.py
2218
k-stachowiak0291cb72019-06-26 15:52:12 +02002219 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002220 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002221
Gilles Peskine8f073122018-11-27 15:58:47 +01002222 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002223 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002224}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002225
Gilles Peskine0c671602022-11-29 16:01:41 +01002226skip_suites_without_constant_flow () {
2227 # Skip the test suites that don't have any constant-flow annotations.
2228 # This will need to be adjusted if we ever start declaring things as
2229 # secret from macros or functions inside tests/include or tests/src.
2230 SKIP_TEST_SUITES=$(
2231 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2232 sed 's/test_suite_//; s/\.function$//' |
2233 tr '\n' ,)
2234 export SKIP_TEST_SUITES
2235}
2236
Dave Rodgman246210e2023-07-31 18:07:44 +01002237skip_all_except_given_suite () {
2238 # Skip all but the given test suite
2239 SKIP_TEST_SUITES=$(
2240 ls -1 tests/suites/test_suite_*.function |
2241 grep -v $1.function |
2242 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2243 tr '\n' ,)
2244 export SKIP_TEST_SUITES
2245}
2246
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002247component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002248 # This tests both (1) accesses to undefined memory, and (2) branches or
2249 # memory access depending on secret values. To distinguish between those:
2250 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2251 # - or alternatively, change the build type to MemSanDbg, which enables
2252 # origin tracking and nicer stack traces (which are useful for debugging
2253 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002254 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2255 scripts/config.py full
2256 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2257 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2258 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2259 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2260 make
2261
2262 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2263 make test
2264}
2265
2266component_test_memsan_constant_flow_psa () {
2267 # This tests both (1) accesses to undefined memory, and (2) branches or
2268 # memory access depending on secret values. To distinguish between those:
2269 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2270 # - or alternatively, change the build type to MemSanDbg, which enables
2271 # origin tracking and nicer stack traces (which are useful for debugging
2272 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002273 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002274 scripts/config.py full
2275 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2276 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2277 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2278 make
2279
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002280 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002281 make test
2282}
2283
Bence Szépkúti0354d042023-12-06 16:14:37 +01002284component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002285 # This tests both (1) everything that valgrind's memcheck usually checks
2286 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2287 # etc.) and (2) branches or memory access depending on secret values,
2288 # which will be reported as uninitialized memory. To distinguish between
2289 # secret and actually uninitialized:
2290 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2291 # - or alternatively, build with debug info and manually run the offending
2292 # test suite with valgrind --track-origins=yes, then check if the origin
2293 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002294 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2295 scripts/config.py full
2296 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2297 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002298 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002299 cmake -D CMAKE_BUILD_TYPE:String=Release .
2300 make
2301
2302 # this only shows a summary of the results (how many of each type)
2303 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002304 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002305 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002306
2307 # Test asm path in constant time module - by default, it will test the plain C
2308 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2309 msg "test: valgrind asm constant_time"
2310 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2311 skip_all_except_given_suite test_suite_constant_time
2312 cmake -D CMAKE_BUILD_TYPE:String=Release .
2313 make clean
2314 make
2315 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002316}
2317
Bence Szépkúti0354d042023-12-06 16:14:37 +01002318component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002319 # This tests both (1) everything that valgrind's memcheck usually checks
2320 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2321 # etc.) and (2) branches or memory access depending on secret values,
2322 # which will be reported as uninitialized memory. To distinguish between
2323 # secret and actually uninitialized:
2324 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2325 # - or alternatively, build with debug info and manually run the offending
2326 # test suite with valgrind --track-origins=yes, then check if the origin
2327 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002328 msg "build: cmake release GCC, full config with constant flow testing"
2329 scripts/config.py full
2330 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002331 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002332 cmake -D CMAKE_BUILD_TYPE:String=Release .
2333 make
2334
2335 # this only shows a summary of the results (how many of each type)
2336 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002337 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002338 make memcheck
2339}
2340
Janos Follath9338cac2023-10-04 18:55:39 +01002341component_test_tsan () {
2342 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002343 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002344 scripts/config.py set MBEDTLS_THREADING_C
2345 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002346 # Self-tests do not currently use multiple threads.
2347 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002348
Ryan6caf84f2024-03-05 13:57:00 +00002349 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2350 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2351
Janos Follath9338cac2023-10-04 18:55:39 +01002352 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2353 make
2354
2355 msg "test: main suites (TSan)"
2356 make test
2357}
2358
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002359component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002360 # Test that removing the deprecated features from the default
2361 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002362 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2363 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002364 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002365
2366 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2367 make test
2368}
2369
2370component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002371 msg "build: make, full_no_deprecated config" # ~ 30s
2372 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002373 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002374
Gilles Peskine30de2e82020-04-20 21:39:22 +02002375 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002376 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002377
2378 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2379 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002380}
2381
Gilles Peskine8386ea22020-04-30 09:07:29 +02002382component_test_full_no_deprecated_deprecated_warning () {
2383 # Test that there is nothing deprecated in "full_no_deprecated".
2384 # A deprecated feature would trigger a warning (made fatal) from
2385 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002386 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2387 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002388 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2389 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002390 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002391
Gilles Peskine30de2e82020-04-20 21:39:22 +02002392 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002393 make test
2394}
2395
Gilles Peskine8386ea22020-04-30 09:07:29 +02002396component_test_full_deprecated_warning () {
2397 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2398 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002399 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002400 scripts/config.py full
2401 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002402 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002403 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2404 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002405 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002406
Gilles Peskine8386ea22020-04-30 09:07:29 +02002407 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2408 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2409 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002410 # Expect warnings from '#warning' directives in check_config.h and
2411 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002412 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 +01002413
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002414 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2415 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002416
2417 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2418 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002419}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002420
Gilles Peskineec541fe2020-01-31 14:24:14 +01002421# Check that the specified libraries exist and are empty.
2422are_empty_libraries () {
2423 nm "$@" >/dev/null 2>/dev/null
2424 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2425}
2426
2427component_build_crypto_default () {
2428 msg "build: make, crypto only"
2429 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002430 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002431 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002432}
2433
2434component_build_crypto_full () {
2435 msg "build: make, crypto only, full config"
2436 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002437 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002438 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002439}
2440
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002441component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002442 msg "build: make, config for PSA crypto service"
2443 scripts/config.py crypto
2444 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2445 # Disable things that are not needed for just cryptography, to
2446 # reach a configuration that would be typical for a PSA cryptography
2447 # service providing all implemented PSA algorithms.
2448 # System stuff
2449 scripts/config.py unset MBEDTLS_ERROR_C
2450 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002451 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002452 # Crypto stuff with no PSA interface
2453 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002454 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002455 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002456 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002457 scripts/config.py unset MBEDTLS_NIST_KW_C
2458 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2459 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2460 scripts/config.py unset MBEDTLS_PKCS12_C
2461 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002462 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2463 # in PSA code to work with RSA keys. We don't require users to set those:
2464 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002465 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002466 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002467 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002468 make CFLAGS='-O1 -Werror' all test
2469 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2470}
2471
Gilles Peskineec541fe2020-01-31 14:24:14 +01002472component_build_crypto_baremetal () {
2473 msg "build: make, crypto only, baremetal config"
2474 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002475 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002476 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002477}
Daniel Axtens446af202020-09-02 21:30:13 +10002478support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002479 support_build_baremetal "$@"
2480}
2481
2482component_build_baremetal () {
2483 msg "build: make, baremetal config"
2484 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002485 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002486}
2487support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002488 # Older Glibc versions include time.h from other headers such as stdlib.h,
2489 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2490 # problem, Ubuntu 18.04 is ok.
2491 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2492}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002493
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002494# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002495component_test_depends_py_cipher_id () {
2496 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002497 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002498}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002499
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002500component_test_depends_py_cipher_chaining () {
2501 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002502 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002503}
2504
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002505component_test_depends_py_cipher_padding () {
2506 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002507 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002508}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002509
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002510component_test_depends_py_curves () {
2511 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002512 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002513}
2514
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002515component_test_depends_py_hashes () {
2516 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002517 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002518}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002519
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002520component_test_depends_py_kex () {
2521 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002522 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002523}
2524
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002525component_test_depends_py_pkalgs () {
2526 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002527 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002528}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002529
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002530# PSA equivalents of the depends.py tests
2531component_test_depends_py_cipher_id_psa () {
2532 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002533 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002534}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002535
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002536component_test_depends_py_cipher_chaining_psa () {
2537 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002538 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002539}
2540
2541component_test_depends_py_cipher_padding_psa () {
2542 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002543 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002544}
2545
2546component_test_depends_py_curves_psa () {
2547 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002548 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002549}
2550
2551component_test_depends_py_hashes_psa () {
2552 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002553 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002554}
2555
2556component_test_depends_py_kex_psa () {
2557 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002558 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002559}
2560
2561component_test_depends_py_pkalgs_psa () {
2562 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002563 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002564}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002565
Valerio Setti6bed64e2024-01-17 15:21:44 +01002566component_test_psa_crypto_config_ffdh_2048_only () {
2567 msg "build: full config - only DH 2048"
2568
2569 scripts/config.py full
2570
2571 # Disable all DH groups other than 2048.
2572 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2573 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2574 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2575 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2576
2577 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2578
2579 msg "test: full config - only DH 2048"
2580 make test
2581
2582 msg "ssl-opt: full config - only DH 2048"
2583 tests/ssl-opt.sh -f "ffdh"
2584}
2585
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002586component_build_no_pk_rsa_alt_support () {
2587 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2588
2589 scripts/config.py full
2590 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2591 scripts/config.py set MBEDTLS_RSA_C
2592 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2593
2594 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002595 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002596}
2597
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002598component_build_module_alt () {
2599 msg "build: MBEDTLS_XXX_ALT" # ~30s
2600 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002601
2602 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002603 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2604 scripts/config.py unset MBEDTLS_AESNI_C
2605 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002606 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002607 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2608 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002609 # You can only have one threading implementation: alt or pthread, not both.
2610 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002611 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2612 # directly and assumes the implementation works with partial groups.
2613 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002614 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2615 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2616 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002617 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2618 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2619 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002620
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002621 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2622 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2623 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002624 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002625
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002626 # We can only compile, not link, since we don't have any implementations
2627 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002628 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002629}
2630
2631component_build_dhm_alt () {
2632 msg "build: MBEDTLS_DHM_ALT" # ~30s
2633 scripts/config.py full
2634 scripts/config.py set MBEDTLS_DHM_ALT
2635 # debug.c currently references mbedtls_dhm_context fields directly.
2636 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002637 # We can only compile, not link, since we don't have any implementations
2638 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002639 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002640}
2641
Gilles Peskine64996c32024-01-23 20:25:47 +01002642component_test_no_psa_crypto_full_cmake_asan() {
2643 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2644 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002645 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002646 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002647 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002648 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002649 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002650 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002651 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002652 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002653 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002654 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002655 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002656 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002657
Gilles Peskine64996c32024-01-23 20:25:47 +01002658 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002659 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002660
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002661 # Note: ssl-opt.sh has some test cases that depend on
2662 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2663 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002664 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002665 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002666
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002667 # Note: the next two invocations cover all compat.sh test cases.
2668 # We should use the same here and in basic-build-test.sh.
2669 msg "test: compat.sh: default version (full minus PSA crypto)"
2670 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002671
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002672 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002673 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002674}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002675
Ronald Cron403c15c2021-09-13 09:38:05 +02002676component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002677 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002678
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002679 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002680 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002681 $(helper_get_psa_key_type_list "ECC") \
2682 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002683
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002684 # Configure
2685 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002686
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002687 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002688 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002689
2690 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002691 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002692
2693 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002694 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2695 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2696
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002697 # Build
2698 # -----
2699
2700 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002701 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2702 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002703
2704 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2705
Valerio Setti3fe105b2023-10-30 11:08:12 +01002706 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002707
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002708 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002709 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002710
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002711 # Run the tests
2712 # -------------
2713
Ronald Cron403c15c2021-09-13 09:38:05 +02002714 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2715 make test
2716}
2717
Valerio Setti44b178c2023-03-22 14:02:57 +01002718component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002719 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002720
2721 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002722 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002723 $(helper_get_psa_key_type_list "ECC") \
2724 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002725
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002726 # Configure
2727 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002728
Ronald Cron46ac0652024-03-18 12:39:04 +01002729 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002730 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002731
Valerio Setti44b178c2023-03-22 14:02:57 +01002732 # Disable the module that's accelerated
2733 scripts/config.py unset MBEDTLS_ECDH_C
2734
2735 # Disable things that depend on it
2736 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2737 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2738 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2739 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2740 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2741
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002742 # Build
2743 # -----
2744
2745 helper_libtestdriver1_make_drivers "$loc_accel_list"
2746
Valerio Setti3fe105b2023-10-30 11:08:12 +01002747 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002748
Valerio Setti44b178c2023-03-22 14:02:57 +01002749 # Make sure this was not re-enabled by accident (additive config)
2750 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002751
2752 # Run the tests
2753 # -------------
2754
Valerio Setti44b178c2023-03-22 14:02:57 +01002755 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002756 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002757}
2758
Przemek Stekieldccb2022023-05-11 10:48:50 +02002759component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002760 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002761
2762 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002763 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002764 $(helper_get_psa_key_type_list "DH") \
2765 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002766
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002767 # Configure
2768 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002769
Przemek Stekiel565353e2023-07-05 11:07:07 +02002770 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002771 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002772
2773 # Disable the module that's accelerated
2774 scripts/config.py unset MBEDTLS_DHM_C
2775
2776 # Disable things that depend on it
2777 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2778 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2779
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002780 # Build
2781 # -----
2782
2783 helper_libtestdriver1_make_drivers "$loc_accel_list"
2784
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002785 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002786
2787 # Make sure this was not re-enabled by accident (additive config)
2788 not grep mbedtls_dhm_ library/dhm.o
2789
2790 # Run the tests
2791 # -------------
2792
Gilles Peskine14302ed2023-07-19 19:30:04 +02002793 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002794 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002795
Gilles Peskine14302ed2023-07-19 19:30:04 +02002796 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002797 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002798}
2799
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002800component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002801 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002802
2803 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002804 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002805
2806 # Disable things that are not supported
2807 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2808 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002809 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002810
Gilles Peskine14302ed2023-07-19 19:30:04 +02002811 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002812 make test
2813
Gilles Peskine14302ed2023-07-19 19:30:04 +02002814 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002815 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002816}
2817
Valerio Setti44b178c2023-03-22 14:02:57 +01002818component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002819 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002820
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002821 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002822 $(helper_get_psa_key_type_list "ECC") \
2823 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002824
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002825 # Configure
2826 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002827
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002828 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002829
2830 # Make built-in fallback not available
2831 scripts/config.py unset MBEDTLS_ECJPAKE_C
2832 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2833
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002834 # Build
2835 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002836
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002837 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002838
Valerio Setti3fe105b2023-10-30 11:08:12 +01002839 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002840
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002841 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002842 not grep mbedtls_ecjpake_init library/ecjpake.o
2843
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002844 # Run the tests
2845 # -------------
2846
Gilles Peskine14302ed2023-07-19 19:30:04 +02002847 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002848 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002849}
2850
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002851component_test_psa_crypto_config_accel_ecc_some_key_types () {
2852 msg "build: full with accelerated EC algs and some key types"
2853
2854 # Algorithms and key types to accelerate
2855 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2856 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2857 ALG_ECDH \
2858 ALG_JPAKE \
2859 KEY_TYPE_ECC_PUBLIC_KEY \
2860 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2861 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002862 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2863 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002864
2865 # Configure
2866 # ---------
2867
2868 # start with config full for maximum coverage (also enables USE_PSA)
2869 helper_libtestdriver1_adjust_config "full"
2870
2871 # Disable modules that are accelerated - some will be re-enabled
2872 scripts/config.py unset MBEDTLS_ECDSA_C
2873 scripts/config.py unset MBEDTLS_ECDH_C
2874 scripts/config.py unset MBEDTLS_ECJPAKE_C
2875 scripts/config.py unset MBEDTLS_ECP_C
2876
2877 # Disable all curves - those that aren't accelerated should be re-enabled
2878 helper_disable_builtin_curves
2879
2880 # Restartable feature is not yet supported by PSA. Once it will in
2881 # the future, the following line could be removed (see issues
2882 # 6061, 6332 and following ones)
2883 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2884
2885 # this is not supported by the driver API yet
2886 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2887
2888 # Build
2889 # -----
2890
2891 # These hashes are needed for some ECDSA signature tests.
2892 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2893 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2894 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2895
Valerio Setti3fe105b2023-10-30 11:08:12 +01002896 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002897
2898 # ECP should be re-enabled but not the others
2899 not grep mbedtls_ecdh_ library/ecdh.o
2900 not grep mbedtls_ecdsa library/ecdsa.o
2901 not grep mbedtls_ecjpake library/ecjpake.o
2902 grep mbedtls_ecp library/ecp.o
2903
2904 # Run the tests
2905 # -------------
2906
2907 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002908 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002909}
2910
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002911# Run tests with only (non-)Weierstrass accelerated
2912# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002913# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2914# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002915common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002916 weierstrass=$1
2917 if [ $weierstrass -eq 1 ]; then
2918 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002919 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002920 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002921 fi
2922
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002923 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002924
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002925 # Note: Curves are handled in a special way by the libtestdriver machinery,
2926 # so we only want to include them in the accel list when building the main
2927 # libraries, hence the use of a separate variable.
2928 # Note: the following loop is a modified version of
2929 # helper_get_psa_curve_list that only keeps Weierstrass families.
2930 loc_weierstrass_list=""
2931 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002932 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2933 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002934 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002935 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002936 ;;
2937 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002938 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002939 ;;
2940 esac
2941 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002942 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002943 loc_curve_list=$loc_weierstrass_list
2944 else
2945 loc_curve_list=$loc_non_weierstrass_list
2946 fi
2947
Valerio Setti3fe105b2023-10-30 11:08:12 +01002948 # Algorithms and key types to accelerate
2949 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2950 ALG_ECDH \
2951 ALG_JPAKE \
2952 $(helper_get_psa_key_type_list "ECC") \
2953 $loc_curve_list"
2954
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002955 # Configure
2956 # ---------
2957
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002958 # Start with config crypto_full and remove PK_C:
2959 # that's what's supported now, see docs/driver-only-builds.md.
2960 helper_libtestdriver1_adjust_config "crypto_full"
2961 scripts/config.py unset MBEDTLS_PK_C
2962 scripts/config.py unset MBEDTLS_PK_PARSE_C
2963 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002964
2965 # Disable modules that are accelerated - some will be re-enabled
2966 scripts/config.py unset MBEDTLS_ECDSA_C
2967 scripts/config.py unset MBEDTLS_ECDH_C
2968 scripts/config.py unset MBEDTLS_ECJPAKE_C
2969 scripts/config.py unset MBEDTLS_ECP_C
2970
2971 # Disable all curves - those that aren't accelerated should be re-enabled
2972 helper_disable_builtin_curves
2973
2974 # Restartable feature is not yet supported by PSA. Once it will in
2975 # the future, the following line could be removed (see issues
2976 # 6061, 6332 and following ones)
2977 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2978
2979 # this is not supported by the driver API yet
2980 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2981
2982 # Build
2983 # -----
2984
2985 # These hashes are needed for some ECDSA signature tests.
2986 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2987 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2988 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2989
Valerio Settiac7a8092023-10-31 12:23:44 +01002990 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002991
2992 # We expect ECDH to be re-enabled for the missing curves
2993 grep mbedtls_ecdh_ library/ecdh.o
2994 # We expect ECP to be re-enabled, however the parts specific to the
2995 # families of curves that are accelerated should be ommited.
2996 # - functions with mxz in the name are specific to Montgomery curves
2997 # - ecp_muladd is specific to Weierstrass curves
2998 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002999 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003000 not grep mbedtls_ecp_muladd library/ecp.o
3001 grep mxz library/ecp.o
3002 else
3003 grep mbedtls_ecp_muladd library/ecp.o
3004 not grep mxz library/ecp.o
3005 fi
3006 # We expect ECDSA and ECJPAKE to be re-enabled only when
3007 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003008 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003009 not grep mbedtls_ecdsa library/ecdsa.o
3010 not grep mbedtls_ecjpake library/ecjpake.o
3011 else
3012 grep mbedtls_ecdsa library/ecdsa.o
3013 grep mbedtls_ecjpake library/ecjpake.o
3014 fi
3015
3016 # Run the tests
3017 # -------------
3018
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02003019 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
3020 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003021}
3022
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02003023component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003024 common_test_psa_crypto_config_accel_ecc_some_curves 1
3025}
3026
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02003027component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003028 common_test_psa_crypto_config_accel_ecc_some_curves 0
3029}
3030
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01003031# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
3032# ECDH, ECDSA) with and without drivers.
3033# The input parameter is a boolean value which indicates:
3034# - 0 keep built-in EC algs,
3035# - 1 exclude built-in EC algs (driver only).
3036#
3037# This is used by the two following components to ensure they always use the
3038# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003039# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
3040# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01003041# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003042config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003043 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01003044 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003045 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003046 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01003047 # Disable modules that are accelerated
3048 scripts/config.py unset MBEDTLS_ECDSA_C
3049 scripts/config.py unset MBEDTLS_ECDH_C
3050 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02003051 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01003052 fi
3053
3054 # Restartable feature is not yet supported by PSA. Once it will in
3055 # the future, the following line could be removed (see issues
3056 # 6061, 6332 and following ones)
3057 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003058}
3059
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003060# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3061component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003062 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003063
3064 # Algorithms and key types to accelerate
3065 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3066 ALG_ECDH \
3067 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003068 $(helper_get_psa_key_type_list "ECC") \
3069 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003070
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003071 # Configure
3072 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003073
3074 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003075 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003076
Valerio Setti0a342c92023-09-01 09:12:31 +02003077 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003078 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3079 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003080
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003081 # Build
3082 # -----
3083
3084 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003085 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3086 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003087 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3088
Valerio Setti3fe105b2023-10-30 11:08:12 +01003089 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003090
3091 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3092 not grep mbedtls_ecdsa_ library/ecdsa.o
3093 not grep mbedtls_ecdh_ library/ecdh.o
3094 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003095 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003096
3097 # Run the tests
3098 # -------------
3099
Gilles Peskine14302ed2023-07-19 19:30:04 +02003100 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003101 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003102
Gilles Peskine14302ed2023-07-19 19:30:04 +02003103 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003104 tests/ssl-opt.sh
3105}
3106
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003107# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3108component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003109 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003110
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003111 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003112
Gilles Peskine21570cf2023-12-22 11:49:50 +01003113 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003114
Gilles Peskine14302ed2023-07-19 19:30:04 +02003115 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003116 make test
3117
Gilles Peskine14302ed2023-07-19 19:30:04 +02003118 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003119 tests/ssl-opt.sh
3120}
3121
Valerio Settie618cb02023-04-12 14:59:16 +02003122# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003123# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3124# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003125# to ensure that both tests use the same underlying configuration when testing
3126# driver's coverage with analyze_outcomes.py.
3127#
3128# This functions accepts 1 boolean parameter as follows:
3129# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3130# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3131# - 0: include built-in implementation of EC algorithms.
3132#
3133# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3134# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003135config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003136 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003137 # start with full config for maximum coverage (also enables USE_PSA)
3138 helper_libtestdriver1_adjust_config "full"
3139
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003140 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003141 # Disable modules that are accelerated
3142 scripts/config.py unset MBEDTLS_ECDSA_C
3143 scripts/config.py unset MBEDTLS_ECDH_C
3144 scripts/config.py unset MBEDTLS_ECJPAKE_C
3145 # Disable ECP module (entirely)
3146 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003147 fi
3148
Valerio Settiaecd32c2023-06-14 10:42:31 +02003149 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3150 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003151 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003152 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003153
Valerio Settie618cb02023-04-12 14:59:16 +02003154 # Restartable feature is not yet supported by PSA. Once it will in
3155 # the future, the following line could be removed (see issues
3156 # 6061, 6332 and following ones)
3157 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003158}
3159
3160# Build and test a configuration where driver accelerates all EC algs while
3161# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3162# side.
3163#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003164# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3165component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003166 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003167
3168 # Algorithms and key types to accelerate
3169 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3170 ALG_ECDH \
3171 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003172 $(helper_get_psa_key_type_list "ECC") \
3173 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003174
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003175 # Configure
3176 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003177
Valerio Settie618cb02023-04-12 14:59:16 +02003178 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003179 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003180 # Disable all the builtin curves. All the required algs are accelerated.
3181 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003182
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003183 # Build
3184 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003185
3186 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003187 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3188 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3189 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003190
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003191 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003192
Valerio Setti3fe105b2023-10-30 11:08:12 +01003193 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003194
3195 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3196 not grep mbedtls_ecdsa_ library/ecdsa.o
3197 not grep mbedtls_ecdh_ library/ecdh.o
3198 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003199 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003200 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003201
3202 # Run the tests
3203 # -------------
3204
Gilles Peskine14302ed2023-07-19 19:30:04 +02003205 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003206 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003207
Gilles Peskine14302ed2023-07-19 19:30:04 +02003208 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003209 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003210}
3211
3212# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003213# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003214# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003215component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003216 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003217
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003218 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003219
Gilles Peskine21570cf2023-12-22 11:49:50 +01003220 make
Valerio Settie618cb02023-04-12 14:59:16 +02003221
Gilles Peskine14302ed2023-07-19 19:30:04 +02003222 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003223 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003224
Gilles Peskine14302ed2023-07-19 19:30:04 +02003225 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003226 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003227}
3228
Valerio Setti4e2f2442023-08-15 10:10:26 +02003229# This is a common configuration helper used directly from:
3230# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3231# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3232# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003233# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003234# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003235# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003236# - this is the reference component of the above
3237# - it still disables RSA and FFDH, but it uses builtin EC algs
3238# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3239# - accelerate all EC and FFDH algs, disable only RSA
3240# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3241# - this is the reference component of the above
3242# - it still disables RSA, but it uses builtin EC and FFDH algs
3243#
3244# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003245# $1: a boolean value which states if we are testing an accelerated scenario
3246# or not.
3247# $2: a string value which states which components are tested. Allowed values
3248# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003249config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003250 driver_only="$1"
3251 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003252 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003253 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003254
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003255 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003256 # Disable modules that are accelerated
3257 scripts/config.py unset MBEDTLS_ECDSA_C
3258 scripts/config.py unset MBEDTLS_ECDH_C
3259 scripts/config.py unset MBEDTLS_ECJPAKE_C
3260 # Disable ECP module (entirely)
3261 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003262 # Also disable bignum
3263 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003264 fi
3265
3266 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3267 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3268 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3269 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3270
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003271 # RSA support is intentionally disabled on this test because RSA_C depends
3272 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003273 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3274 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 +02003275 scripts/config.py unset MBEDTLS_RSA_C
3276 scripts/config.py unset MBEDTLS_PKCS1_V15
3277 scripts/config.py unset MBEDTLS_PKCS1_V21
3278 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3279 # Also disable key exchanges that depend on RSA
3280 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3281 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3282 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3283 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3284 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3285
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003286 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003287 # When testing ECC only, we disable FFDH support, both from builtin and
3288 # PSA sides, and also disable the key exchanges that depend on DHM.
3289 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3290 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_DH_[0-9A-Z_a-z]*"
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003291 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003292 scripts/config.py unset MBEDTLS_DHM_C
3293 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3294 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3295 else
3296 # When testing ECC and DH instead, we disable DHM and depending key
3297 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003298 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003299 scripts/config.py unset MBEDTLS_DHM_C
3300 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3301 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3302 fi
3303 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003304
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003305 # Restartable feature is not yet supported by PSA. Once it will in
3306 # the future, the following line could be removed (see issues
3307 # 6061, 6332 and following ones)
3308 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3309}
3310
Valerio Setti4e2f2442023-08-15 10:10:26 +02003311# Common helper used by:
3312# - component_test_psa_crypto_config_accel_ecc_no_bignum
3313# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003314#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003315# The goal is to build and test accelerating either:
3316# - ECC only or
3317# - both ECC and FFDH
3318#
3319# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003320# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3321# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003322common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003323 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003324
Valerio Setti5dfaca42023-09-05 08:48:51 +02003325 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003326 if [ "$test_target" = "ECC_DH" ]; then
3327 accel_text="ECC/FFDH"
3328 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003329 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003330 accel_text="ECC"
3331 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003332 fi
3333
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003334 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003335
3336 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003337 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3338 ALG_ECDH \
3339 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003340 $(helper_get_psa_key_type_list "ECC") \
3341 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003342 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003343 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003344 loc_accel_list="$loc_accel_list \
3345 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003346 $(helper_get_psa_key_type_list "DH") \
3347 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003348 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003349
3350 # Configure
3351 # ---------
3352
3353 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003354 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003355 # Disable all the builtin curves. All the required algs are accelerated.
3356 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003357
3358 # Build
3359 # -----
3360
3361 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003362 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3363 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3364 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003365
3366 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3367
Valerio Setti3fe105b2023-10-30 11:08:12 +01003368 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003369
3370 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3371 not grep mbedtls_ecdsa_ library/ecdsa.o
3372 not grep mbedtls_ecdh_ library/ecdh.o
3373 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003374 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003375 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003376 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003377 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003378 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003379
3380 # Run the tests
3381 # -------------
3382
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003383 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003384
Gilles Peskine21570cf2023-12-22 11:49:50 +01003385 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003386
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003387 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003388 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003389}
3390
Valerio Setti4e2f2442023-08-15 10:10:26 +02003391# Common helper used by:
3392# - component_test_psa_crypto_config_reference_ecc_no_bignum
3393# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3394#
3395# The goal is to build and test a reference scenario (i.e. with builtin
3396# components) compared to the ones used in
3397# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3398#
3399# It is meant to be used in conjunction with
3400# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3401# coverage analysis in "analyze_outcomes.py" script.
3402common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003403 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003404
Valerio Setti5dfaca42023-09-05 08:48:51 +02003405 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003406 if [ "$test_target" = "ECC_DH" ]; then
3407 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003408 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003409 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003410 fi
3411
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003412 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003413
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003414 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003415
Gilles Peskine21570cf2023-12-22 11:49:50 +01003416 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003417
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003418 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003419 make test
3420
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003421 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003422 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003423}
3424
Valerio Setti4e2f2442023-08-15 10:10:26 +02003425component_test_psa_crypto_config_accel_ecc_no_bignum () {
3426 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3427}
3428
3429component_test_psa_crypto_config_reference_ecc_no_bignum () {
3430 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3431}
3432
3433component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3434 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3435}
3436
3437component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3438 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3439}
3440
Valerio Settiac6d35f2023-08-04 12:49:11 +02003441# Helper for setting common configurations between:
3442# - component_test_tfm_config_p256m_driver_accel_ec()
3443# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003444common_tfm_config () {
3445 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003446 cp configs/config-tfm.h "$CONFIG_H"
3447 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3448 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003449
Yanray Wang73bb2312023-09-25 11:21:15 +08003450 # Other config adjustment to make the tests pass.
3451 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003452 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003453 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3454 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003455
Yanray Wang73bb2312023-09-25 11:21:15 +08003456 # Config adjustment for better test coverage in our environment.
3457 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003458 #
3459 # Enable filesystem I/O for the benefit of PK parse/write tests.
3460 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3461}
3462
Valerio Settiac6d35f2023-08-04 12:49:11 +02003463# Keep this in sync with component_test_tfm_config() as they are both meant
3464# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003465component_test_tfm_config_p256m_driver_accel_ec () {
3466 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3467
3468 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003469
Dave Rodgman897bb772023-11-15 16:34:20 +00003470 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003471 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003472
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003473 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3474 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003475 not grep mbedtls_ecdh_ library/ecdh.o
3476 not grep mbedtls_ecjpake_ library/ecjpake.o
3477 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3478 not grep mbedtls_ecp_ library/ecp.o
3479 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003480 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003481 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003482 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003483 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003484
Valerio Setti5e18b902023-12-04 12:07:30 +01003485 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3486 # files, so we want to ensure that it has not be re-enabled accidentally.
3487 not grep mbedtls_cipher library/cipher.o
3488
Valerio Settib7e95442023-03-21 11:52:33 +01003489 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003490 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003491 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003492}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003493
Valerio Settiac6d35f2023-08-04 12:49:11 +02003494# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3495# they are both meant to be used in analyze_outcomes.py for driver's coverage
3496# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003497component_test_tfm_config() {
3498 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003499
Dave Rodgman897bb772023-11-15 16:34:20 +00003500 # Disable P256M driver, which is on by default, so that analyze_outcomes
3501 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3502 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3503
Valerio Setti52ba0e32023-08-04 12:43:03 +02003504 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003505 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003506
Dave Rodgman897bb772023-11-15 16:34:20 +00003507 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003508 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003509
Valerio Setti5e18b902023-12-04 12:07:30 +01003510 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3511 # files, so we want to ensure that it has not be re-enabled accidentally.
3512 not grep mbedtls_cipher library/cipher.o
3513
Valerio Setti52ba0e32023-08-04 12:43:03 +02003514 msg "test: TF-M config"
3515 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003516}
3517
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003518# Common helper for component_full_without_ecdhe_ecdsa() and
3519# component_full_without_ecdhe_ecdsa_and_tls13() which:
3520# - starts from the "full" configuration minus the list of symbols passed in
3521# as 1st parameter
3522# - build
3523# - test only TLS (i.e. test_suite_tls and ssl-opt)
3524build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003525 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003526
3527 msg "build: full minus something, test TLS"
3528
3529 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003530 for sym in $symbols_to_disable; do
3531 echo "Disabling $sym"
3532 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003533 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003534
Gilles Peskine21570cf2023-12-22 11:49:50 +01003535 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003536
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003537 msg "test: full minus something, test TLS"
3538 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003539
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003540 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003541 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003542}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003543
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003544component_full_without_ecdhe_ecdsa () {
3545 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003546}
3547
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003548component_full_without_ecdhe_ecdsa_and_tls13 () {
3549 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3550 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003551}
3552
Valerio Setti249b18a2023-06-20 12:08:30 +02003553# This is an helper used by:
3554# - component_test_psa_ecc_key_pair_no_derive
3555# - component_test_psa_ecc_key_pair_no_generate
3556# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3557# enabled, but one. Input arguments are as follows:
3558# - $1 is the key type under test, i.e. ECC/RSA/DH
3559# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003560build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003561 key_type=$1
3562 unset_option=$2
3563 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003564
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003565 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003566 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003567 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3568 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3569
3570 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3571 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003572 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003573
Gilles Peskine21570cf2023-12-22 11:49:50 +01003574 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003575
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003576 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003577 make test
3578}
3579
3580component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003581 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003582}
3583
3584component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003585 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003586}
3587
Pengyu Lve705f572023-12-06 16:38:15 +08003588config_psa_crypto_accel_rsa () {
3589 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003590
Pengyu Lve705f572023-12-06 16:38:15 +08003591 # Start from crypto_full config (no X.509, no TLS)
3592 helper_libtestdriver1_adjust_config "crypto_full"
3593
3594 if [ "$driver_only" -eq 1 ]; then
3595 # Remove RSA support and its dependencies
3596 scripts/config.py unset MBEDTLS_RSA_C
3597 scripts/config.py unset MBEDTLS_PKCS1_V15
3598 scripts/config.py unset MBEDTLS_PKCS1_V21
3599
3600 # We need PEM parsing in the test library as well to support the import
3601 # of PEM encoded RSA keys.
3602 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3603 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3604 fi
3605}
3606
3607component_test_psa_crypto_config_accel_rsa_crypto () {
3608 msg "build: crypto_full with accelerated RSA"
3609
3610 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3611 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3612 KEY_TYPE_RSA_PUBLIC_KEY \
3613 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3614 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3615 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3616 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003617
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003618 # Configure
3619 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003620
Pengyu Lve705f572023-12-06 16:38:15 +08003621 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003622
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003623 # Build
3624 # -----
3625
Pengyu Lve705f572023-12-06 16:38:15 +08003626 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003627 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
Pengyu Lve705f572023-12-06 16:38:15 +08003628 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003629 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003630
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003631 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003632
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003633 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003634 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003635
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003636 # Run the tests
3637 # -------------
3638
Pengyu Lve705f572023-12-06 16:38:15 +08003639 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003640 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003641}
3642
3643component_test_psa_crypto_config_reference_rsa_crypto () {
3644 msg "build: crypto_full with non-accelerated RSA"
3645
3646 # Configure
3647 # ---------
3648 config_psa_crypto_accel_rsa 0
3649
3650 # Build
3651 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003652 make
Pengyu Lve705f572023-12-06 16:38:15 +08003653
3654 # Run the tests
3655 # -------------
3656 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003657 make test
3658}
3659
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003660# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003661# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003662component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003663 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003664
Valerio Setti4590bc22023-06-13 15:39:23 +02003665 # Create a temporary output file unless there is already one set
3666 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3667 REMOVE_OUTCOME_ON_EXIT="no"
3668 else
3669 REMOVE_OUTCOME_ON_EXIT="yes"
3670 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3671 export MBEDTLS_TEST_OUTCOME_FILE
3672 fi
3673
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003674 # Start from crypto configuration
3675 scripts/config.py crypto
3676
3677 # Remove RSA support and its dependencies
3678 scripts/config.py unset MBEDTLS_PKCS1_V15
3679 scripts/config.py unset MBEDTLS_PKCS1_V21
3680 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3681 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3682 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3683 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3684 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3685 scripts/config.py unset MBEDTLS_RSA_C
3686 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3687
3688 # Enable PSA support
3689 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3690
Valerio Setti01cc88a2023-06-15 11:53:08 +02003691 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003692 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003693 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3694 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3695 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003696
3697 make
3698
Valerio Setti01cc88a2023-06-15 11:53:08 +02003699 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003700 make test
3701
3702 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3703 # performing RSA signature.
3704 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3705 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3706
3707 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3708 rm $MBEDTLS_TEST_OUTCOME_FILE
3709 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003710}
3711
Ronald Cronb2312452021-05-08 14:32:59 +02003712component_test_psa_crypto_config_accel_hash () {
3713 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3714
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003715 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3716 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3717 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003718
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003719 # Configure
3720 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003721
Ronald Cron46ac0652024-03-18 12:39:04 +01003722 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003723 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003724
3725 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003726 scripts/config.py unset MBEDTLS_MD5_C
3727 scripts/config.py unset MBEDTLS_RIPEMD160_C
3728 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003729 scripts/config.py unset MBEDTLS_SHA224_C
3730 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003731 scripts/config.py unset MBEDTLS_SHA384_C
3732 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003733 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003734
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003735 # Build
3736 # -----
3737
3738 helper_libtestdriver1_make_drivers "$loc_accel_list"
3739
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003740 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003741
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003742 # There's a risk of something getting re-enabled via config_psa.h;
3743 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3744 not grep mbedtls_md5 library/md5.o
3745 not grep mbedtls_sha1 library/sha1.o
3746 not grep mbedtls_sha256 library/sha256.o
3747 not grep mbedtls_sha512 library/sha512.o
3748 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003749
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003750 # Run the tests
3751 # -------------
3752
Ronald Cronb2312452021-05-08 14:32:59 +02003753 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3754 make test
3755}
3756
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003757# Auxiliary function to build config for hashes with and without drivers
3758config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003759 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003760 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003761 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003762 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003763 # disable the built-in implementation of hashes
3764 scripts/config.py unset MBEDTLS_MD5_C
3765 scripts/config.py unset MBEDTLS_RIPEMD160_C
3766 scripts/config.py unset MBEDTLS_SHA1_C
3767 scripts/config.py unset MBEDTLS_SHA224_C
3768 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003769 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003770 scripts/config.py unset MBEDTLS_SHA384_C
3771 scripts/config.py unset MBEDTLS_SHA512_C
3772 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003773 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003774 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003775}
3776
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003777# Note that component_test_psa_crypto_config_reference_hash_use_psa
3778# is related to this component and both components need to be kept in sync.
3779# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003780component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003781 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003782
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003783 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3784 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3785 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003786
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003787 # Configure
3788 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003789
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003790 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003791
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003792 # Build
3793 # -----
3794
3795 helper_libtestdriver1_make_drivers "$loc_accel_list"
3796
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003797 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003798
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003799 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003800 # 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 +02003801 not grep mbedtls_md5 library/md5.o
3802 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003803 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003804 not grep mbedtls_sha512 library/sha512.o
3805 not grep mbedtls_ripemd160 library/ripemd160.o
3806
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003807 # Run the tests
3808 # -------------
3809
Gilles Peskine14302ed2023-07-19 19:30:04 +02003810 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003811 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003812
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003813 # This is mostly useful so that we can later compare outcome files with
3814 # the reference config in analyze_outcomes.py, to check that the
3815 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003816 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003817 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003818
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003819 # This is to make sure all ciphersuites are exercised, but we don't need
3820 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003821 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003822 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003823}
3824
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003825# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3826# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3827# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3828# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003829component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003830 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003831
3832 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003833
Gilles Peskine21570cf2023-12-22 11:49:50 +01003834 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003835
Gilles Peskine14302ed2023-07-19 19:30:04 +02003836 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003837 make test
3838
Gilles Peskine14302ed2023-07-19 19:30:04 +02003839 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003840 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003841}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003842
Valerio Setti8eb310c2024-01-22 16:22:57 +01003843# Auxiliary function to build config for hashes with and without drivers
3844config_psa_crypto_hmac_use_psa () {
3845 driver_only="$1"
3846 # start with config full for maximum coverage (also enables USE_PSA)
3847 helper_libtestdriver1_adjust_config "full"
3848
Valerio Setticd89b0b2024-01-24 14:24:55 +01003849 if [ "$driver_only" -eq 1 ]; then
3850 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3851 # is still enabled though (for ENTROPY_C among others).
3852 scripts/config.py unset MBEDTLS_MD_C
3853 # Disable also the builtin hashes since they are supported by the driver
3854 # and MD module is able to perform PSA dispathing.
3855 scripts/config.py unset-all MBEDTLS_SHA
3856 scripts/config.py unset MBEDTLS_MD5_C
3857 scripts/config.py unset MBEDTLS_RIPEMD160_C
3858 fi
3859
Valerio Setti8eb310c2024-01-22 16:22:57 +01003860 # Direct dependencies of MD_C. We disable them also in the reference
3861 # component to work with the same set of features.
3862 scripts/config.py unset MBEDTLS_PKCS7_C
3863 scripts/config.py unset MBEDTLS_PKCS5_C
3864 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3865 scripts/config.py unset MBEDTLS_HKDF_C
3866 # Dependencies of HMAC_DRBG
3867 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3868 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3869}
3870
3871component_test_psa_crypto_config_accel_hmac() {
3872 msg "test: full with accelerated hmac"
3873
3874 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3875 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3876 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3877 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3878
3879 # Configure
3880 # ---------
3881
3882 config_psa_crypto_hmac_use_psa 1
3883
Valerio Setti8eb310c2024-01-22 16:22:57 +01003884 # Build
3885 # -----
3886
3887 helper_libtestdriver1_make_drivers "$loc_accel_list"
3888
3889 helper_libtestdriver1_make_main "$loc_accel_list"
3890
3891 # Ensure that built-in support for HMAC is disabled.
3892 not grep mbedtls_md_hmac library/md.o
3893
3894 # Run the tests
3895 # -------------
3896
3897 msg "test: full with accelerated hmac"
3898 make test
3899}
3900
3901component_test_psa_crypto_config_reference_hmac() {
3902 msg "test: full without accelerated hmac"
3903
3904 config_psa_crypto_hmac_use_psa 0
3905
3906 make
3907
3908 msg "test: full without accelerated hmac"
3909 make test
3910}
3911
Valerio Setti9da01a72023-12-18 17:38:18 +01003912component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003913 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003914
Valerio Setti9da01a72023-12-18 17:38:18 +01003915 # Albeit this components aims at accelerating DES which should only support
3916 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3917 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003918 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3919 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3920 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003921
Valerio Setti9da01a72023-12-18 17:38:18 +01003922 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3923 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3924 # of this component. This limitation will be addressed by #8598.
3925
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003926 # Configure
3927 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003928
Valerio Setti9a427302023-10-17 11:40:42 +02003929 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003930 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003931
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003932 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003933 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3934 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3935 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3936 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3937 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3938 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3939 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003940 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003941
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003942 # Build
3943 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003944
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003945 helper_libtestdriver1_make_drivers "$loc_accel_list"
3946
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003947 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003948
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003949 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003950 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003951
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003952 # Run the tests
3953 # -------------
3954
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003955 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003956 make test
3957}
3958
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003959component_test_psa_crypto_config_accel_aead () {
3960 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3961
Valerio Setti3f02bb72023-10-02 15:57:33 +02003962 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3963 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003964
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003965 # Configure
3966 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003967
Valerio Setti3f02bb72023-10-02 15:57:33 +02003968 # Start from full config
3969 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003970
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003971 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003972 scripts/config.py unset MBEDTLS_GCM_C
3973 scripts/config.py unset MBEDTLS_CCM_C
3974 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003975
Valerio Settia50b89e2023-11-08 15:58:47 +01003976 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3977 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003978
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003979 # Build
3980 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003981
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003982 helper_libtestdriver1_make_drivers "$loc_accel_list"
3983
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003984 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003985
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003986 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003987 not grep mbedtls_ccm library/ccm.o
3988 not grep mbedtls_gcm library/gcm.o
3989 not grep mbedtls_chachapoly library/chachapoly.o
3990
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003991 # Run the tests
3992 # -------------
3993
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003994 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3995 make test
3996}
3997
Valerio Settib680fc42023-10-13 09:29:37 +02003998# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003999# - component_test_psa_crypto_config_accel_cipher_aead_cmac
4000# - component_test_psa_crypto_config_reference_cipher_aead_cmac
4001common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08004002 # Start from the full config
4003 helper_libtestdriver1_adjust_config "full"
4004
Valerio Settib680fc42023-10-13 09:29:37 +02004005 scripts/config.py unset MBEDTLS_NIST_KW_C
4006}
4007
Valerio Settib6b301f2023-10-04 12:05:05 +02004008# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004009# - component_test_psa_crypto_config_accel_cipher_aead_cmac
4010# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004011# are meant to be used together in analyze_outcomes.py script in order to test
4012# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004013component_test_psa_crypto_config_accel_cipher_aead_cmac () {
4014 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004015
Valerio Settiad8b7f02023-10-25 12:39:50 +02004016 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 ALG_CTR ALG_CFB \
Valerio Setti51d5b192023-11-08 10:56:54 +01004017 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02004018 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02004019 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
4020
4021 # Configure
4022 # ---------
4023
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004024 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004025
4026 # Disable the things that are being accelerated
4027 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4028 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
4029 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
4030 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
4031 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
4032 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4033 scripts/config.py unset MBEDTLS_GCM_C
4034 scripts/config.py unset MBEDTLS_CCM_C
4035 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02004036 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02004037 scripts/config.py unset MBEDTLS_DES_C
4038 scripts/config.py unset MBEDTLS_AES_C
4039 scripts/config.py unset MBEDTLS_ARIA_C
4040 scripts/config.py unset MBEDTLS_CHACHA20_C
4041 scripts/config.py unset MBEDTLS_CAMELLIA_C
4042
Valerio Settiec9b2582023-11-08 16:50:54 +01004043 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
4044 # does not depend on it.
4045 scripts/config.py unset MBEDTLS_CIPHER_C
4046
Valerio Settib6b301f2023-10-04 12:05:05 +02004047 # Build
4048 # -----
4049
4050 helper_libtestdriver1_make_drivers "$loc_accel_list"
4051
4052 helper_libtestdriver1_make_main "$loc_accel_list"
4053
4054 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01004055 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02004056 not grep mbedtls_des library/des.o
4057 not grep mbedtls_aes library/aes.o
4058 not grep mbedtls_aria library/aria.o
4059 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004060 not grep mbedtls_ccm library/ccm.o
4061 not grep mbedtls_gcm library/gcm.o
4062 not grep mbedtls_chachapoly library/chachapoly.o
4063 not grep mbedtls_cmac library/cmac.o
4064
4065 # Run the tests
4066 # -------------
4067
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004068 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004069 make test
Valerio Settif9414552023-11-09 10:43:20 +01004070
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004071 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004072 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004073
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004074 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004075 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004076}
4077
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004078component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4079 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4080 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004081
Gilles Peskine21570cf2023-12-22 11:49:50 +01004082 make
Valerio Settif9414552023-11-09 10:43:20 +01004083
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004084 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004085 make test
Valerio Settif9414552023-11-09 10:43:20 +01004086
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004087 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004088 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004089
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004090 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004091 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004092}
4093
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004094common_block_cipher_dispatch() {
4095 TEST_WITH_DRIVER="$1"
4096
4097 # Start from the full config
4098 helper_libtestdriver1_adjust_config "full"
4099
4100 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4101 # Disable key types that are accelerated (there is no legacy equivalent
4102 # symbol for ECB)
4103 scripts/config.py unset MBEDTLS_AES_C
4104 scripts/config.py unset MBEDTLS_ARIA_C
4105 scripts/config.py unset MBEDTLS_CAMELLIA_C
4106 fi
4107
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004108 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004109 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004110 # Keep this also in the reference component in order to skip the same tests
4111 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004112 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4113 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4114 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4115 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4116 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4117 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4118 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004119
4120 # Disable direct dependency on AES_C
4121 scripts/config.py unset MBEDTLS_NIST_KW_C
4122
4123 # Prevent the cipher module from using deprecated PSA path. The reason is
4124 # that otherwise there will be tests relying on "aes_info" (defined in
4125 # "cipher_wrap.c") whose functions are not available when AES_C is
4126 # not defined. ARIA and Camellia are not a problem in this case because
4127 # the PSA path is not tested for these key types.
4128 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4129}
4130
Valerio Settif8e6cba2023-12-12 11:53:39 +01004131component_test_full_block_cipher_psa_dispatch () {
4132 msg "build: full + PSA dispatch in block_cipher"
4133
4134 loc_accel_list="ALG_ECB_NO_PADDING \
4135 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4136
4137 # Configure
4138 # ---------
4139
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004140 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004141
Valerio Settif8e6cba2023-12-12 11:53:39 +01004142 # Build
4143 # -----
4144
4145 helper_libtestdriver1_make_drivers "$loc_accel_list"
4146
4147 helper_libtestdriver1_make_main "$loc_accel_list"
4148
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004149 # Make sure disabled components were not re-enabled by accident (additive
4150 # config)
4151 not grep mbedtls_aes_ library/aes.o
4152 not grep mbedtls_aria_ library/aria.o
4153 not grep mbedtls_camellia_ library/camellia.o
4154
Valerio Settif8e6cba2023-12-12 11:53:39 +01004155 # Run the tests
4156 # -------------
4157
4158 msg "test: full + PSA dispatch in block_cipher"
4159 make test
4160}
4161
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004162# This is the reference component of component_test_full_block_cipher_psa_dispatch
4163component_test_full_block_cipher_legacy_dispatch () {
4164 msg "build: full + legacy dispatch in block_cipher"
4165
4166 common_block_cipher_dispatch 0
4167
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004168 make
4169
4170 msg "test: full + legacy dispatch in block_cipher"
4171 make test
4172}
4173
Gilles Peskine36dea152023-07-20 22:19:45 +02004174component_test_aead_chachapoly_disabled() {
4175 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004176 scripts/config.py full
4177 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004178 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004179 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004180
Gilles Peskine36dea152023-07-20 22:19:45 +02004181 msg "test: full minus CHACHAPOLY"
4182 make test
4183}
4184
4185component_test_aead_only_ccm() {
4186 msg "build: full minus CHACHAPOLY and GCM"
4187 scripts/config.py full
4188 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4189 scripts/config.py unset MBEDTLS_GCM_C
4190 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4191 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004192 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004193
4194 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004195 make test
4196}
4197
Ronald Crone501d0e2023-07-10 08:31:19 +02004198component_test_ccm_aes_sha256() {
4199 msg "build: CCM + AES + SHA256 configuration"
4200
Ronald Cron7612d8c2023-07-20 10:03:54 +02004201 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004202 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004203
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004204 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004205
4206 msg "test: CCM + AES + SHA256 configuration"
4207 make test
4208}
4209
Dave Rodgman904c5892023-06-28 17:36:02 +01004210support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004211 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004212}
4213
Dave Rodgman904c5892023-06-28 17:36:02 +01004214component_build_tfm_armcc() {
4215 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004216 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004217
Dave Rodgman88651c42023-06-29 12:35:51 +01004218 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004219 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 +01004220}
4221
4222component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004223 # Check that the TF-M configuration can build cleanly with various
4224 # warning flags enabled. We don't build or run tests, since the
4225 # TF-M configuration needs a TF-M platform. A tweaked version of
4226 # the configuration that works on mainstream platforms is in
4227 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004228 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004229
Dave Rodgman88651c42023-06-29 12:35:51 +01004230 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004231 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 +01004232
Dave Rodgman904c5892023-06-28 17:36:02 +01004233 msg "build: TF-M config, gcc native build"
4234 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004235 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 +01004236}
4237
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004238# Test that the given .o file builds with all (valid) combinations of the given options.
4239#
4240# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4241#
4242# The validator function is the name of a function to validate the combination of options.
4243# It may be "" if all combinations are valid.
4244# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004245# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004246build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004247 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004248 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004249 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004250 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004251 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004252
Dave Rodgman42436102023-10-03 15:47:05 +01004253 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004254 for opt in "${options[@]}"; do
4255 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004256 done
4257
4258 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004259 cd $(dirname ${file})
4260 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004261
Dave Rodgman920343a2023-10-01 18:41:09 +01004262 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004263 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 +01004264
Dave Rodgman42436102023-10-03 15:47:05 +01004265 # Extract the command generated by the Makefile to build the target file.
4266 # This ensures that we have any include paths, macro definitions, etc
4267 # that may be applied by make.
4268 # Add -fsyntax-only as we only want a syntax check and don't need to generate a file.
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004269 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004270
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004271 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004272 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004273
Dave Rodgman28e38d82023-10-04 11:50:30 +01004274 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004275 source_file=${file%.o}.c
4276
4277 targets=0
4278 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004279
Dave Rodgman28e38d82023-10-04 11:50:30 +01004280 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004281 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004282 # each bit of $i is used to determine if options[i] will be set or not
4283 target="t"
4284 clang_args=""
4285 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004286 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004287 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004288 clang_args="${clang_args} ${opt}"
4289 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004290 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004291 done
4292
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004293 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004294 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004295 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004296 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004297
Dave Rodgman28e38d82023-10-04 11:50:30 +01004298 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004299 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004300 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004301 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004302
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004303 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004304
Dave Rodgman920343a2023-10-01 18:41:09 +01004305 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004306 make -s -f ${makefile} build_test_config_combos
4307 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004308
4309 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004310 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004311}
4312
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004313validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004314 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4315 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004316 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004317 fi
4318 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4319 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004320 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004321 fi
4322 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004323 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004324}
4325
4326component_build_aes_variations() {
4327 # 18s - around 90ms per clang invocation on M1 Pro
4328 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004329 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004330 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004331
Yanray Wangbc29aef2023-11-06 11:08:17 +08004332 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004333 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004334
Dave Rodgman42436102023-10-03 15:47:05 +01004335 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004336 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4337 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4338 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4339 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004340
4341 cd "$MBEDTLS_ROOT_DIR"
4342 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4343
Yanray Wang42be1ba2023-11-23 14:28:47 +08004344 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004345 # manually set or unset those configurations to check
4346 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004347 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4348 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4349 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4350 scripts/config.py unset MBEDTLS_DES_C
4351 scripts/config.py unset MBEDTLS_NIST_KW_C
4352 build_test_config_combos library/aes.o validate_aes_config_variations \
4353 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4354 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4355 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4356 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004357}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004358
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004359component_test_no_platform () {
4360 # Full configuration build, without platform support, file IO and net sockets.
4361 # This should catch missing mbedtls_printf definitions, and by disabling file
4362 # IO, it should catch missing '#include <stdio.h>'
4363 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004364 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004365 scripts/config.py unset MBEDTLS_PLATFORM_C
4366 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004367 scripts/config.py unset MBEDTLS_FS_IO
4368 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004369 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004370 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004371 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004372 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004373 # to re-enable platform integration features otherwise disabled in C99 builds
4374 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004375 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004376}
Gilles Peskine7c652162017-12-11 00:01:40 +01004377
4378component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004379 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004380 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4381 scripts/config.py full
4382 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004383 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4384 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4385 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4386 make
4387}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004388
Gilles Peskine8f073122018-11-27 15:58:47 +01004389component_build_no_ssl_srv () {
4390 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004391 scripts/config.py full
4392 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004393 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004394}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004395
Gilles Peskine8f073122018-11-27 15:58:47 +01004396component_build_no_ssl_cli () {
4397 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004398 scripts/config.py full
4399 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004400 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004401}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004402
Gilles Peskine8f073122018-11-27 15:58:47 +01004403component_build_no_sockets () {
4404 # Note, C99 compliance can also be tested with the sockets support disabled,
4405 # as that requires a POSIX platform (which isn't the same as C99).
4406 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004407 scripts/config.py full
4408 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4409 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4410 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4411}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004412
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004413component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004414 msg "build: default config with memory buffer allocator and backtrace enabled"
4415 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4416 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4417 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004418 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004419 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004420 make
4421
4422 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4423 make test
4424}
4425
4426component_test_memory_buffer_allocator () {
4427 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004428 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4429 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004430 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004431 make
4432
4433 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4434 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004435
4436 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4437 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004438 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004439}
4440
Gilles Peskine8f073122018-11-27 15:58:47 +01004441component_test_no_max_fragment_length () {
4442 # Run max fragment length tests with MFL disabled
4443 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004444 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004445 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004446 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004447
Gilles Peskine8f073122018-11-27 15:58:47 +01004448 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004449 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004450}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004451
Hanno Becker545ced42019-02-19 11:10:48 +00004452component_test_asan_remove_peer_certificate () {
4453 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004454 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004455 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004456 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004457 make
4458
4459 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4460 make test
4461
4462 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004463 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004464
4465 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004466 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004467
4468 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004469 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004470}
4471
Gilles Peskine8f073122018-11-27 15:58:47 +01004472component_test_no_max_fragment_length_small_ssl_out_content_len () {
4473 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004474 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4475 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4476 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004477 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004478 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004479
Gilles Peskine8f073122018-11-27 15:58:47 +01004480 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004481 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004482
4483 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004484 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004485}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004486
Darryl Greenaad82f92019-12-02 10:53:11 +00004487component_test_variable_ssl_in_out_buffer_len () {
4488 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4489 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004490 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004491 make
4492
4493 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4494 make test
4495
4496 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004497 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004498
4499 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004500 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004501}
4502
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004503component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004504 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004505 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004506
Dave Rodgman17127e92023-12-14 16:42:48 +00004507 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004508 make
4509
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004510 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004511 make test
4512
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004513 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004514 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004515
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004516 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004517 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004518}
4519
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004520component_test_ssl_alloc_buffer_and_mfl () {
4521 msg "build: default config with memory buffer allocator and MFL extension"
4522 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4523 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4524 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4525 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4526 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004527 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004528 make
4529
4530 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4531 make test
4532
4533 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 +02004534 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004535}
4536
Gilles Peskine636c26a2020-03-04 20:46:15 +01004537component_test_when_no_ciphersuites_have_mac () {
4538 msg "build: when no ciphersuites have MAC"
4539 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004540 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004541 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004542 make
4543
4544 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4545 make test
4546
4547 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004548 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004549}
4550
Raoul Strackxa4e86142020-06-15 17:03:13 +02004551component_test_no_date_time () {
4552 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4553 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004554 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004555 make
4556
4557 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4558 make test
4559}
4560
Gilles Peskine8f073122018-11-27 15:58:47 +01004561component_test_platform_calloc_macro () {
4562 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004563 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4564 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4565 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004566 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004567 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004568
Gilles Peskine8f073122018-11-27 15:58:47 +01004569 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4570 make test
4571}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004572
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004573component_test_malloc_0_null () {
4574 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004575 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004576 make CC=$ASAN_CC CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"$PWD/tests/configs/user-config-malloc-0-null.h\"' $ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004577
4578 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4579 make test
4580
4581 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4582 # Just the calloc selftest. "make test" ran the others as part of the
4583 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004584 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004585
4586 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4587 # Run a subset of the tests. The choice is a balance between coverage
4588 # and time (including time indirectly wasted due to flaky tests).
4589 # The current choice is to skip tests whose description includes
4590 # "proxy", which is an approximation of skipping tests that use the
4591 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004592 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004593}
4594
Dave Rodgman6a08b682023-06-19 11:51:33 +01004595support_test_aesni() {
4596 # Check that gcc targets x86_64 (we can build AESNI), and check for
4597 # AESNI support on the host (we can run AESNI).
4598 #
4599 # The name of this function is possibly slightly misleading, but needs to align
4600 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004601 #
4602 # In principle 32-bit x86 can support AESNI, but our implementation does not
4603 # support 32-bit x86, so we check for x86-64.
4604 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004605 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4606 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004607 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004608}
4609
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004610component_test_aesni () { # ~ 60s
4611 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4612 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4613 #
4614 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4615 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4616 # exercise the plain C impl).
4617
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004618 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004619 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004620 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004621 scripts/config.py set MBEDTLS_HAVE_ASM
4622
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004623 # test the intrinsics implementation
4624 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004625 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004626 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004627 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004628 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004629
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004630 # test the asm implementation
4631 msg "AES tests, test assembly"
4632 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004633 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004634 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004635 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004636
4637 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004638 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004639 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004640 msg "AES tests, plain C"
4641 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004642 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004643 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004644 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004645 not grep -q "AES note: using AESNI" ./programs/test/selftest
4646 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004647
4648 # test the intrinsics implementation
4649 scripts/config.py set MBEDTLS_AESNI_C
4650 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4651 msg "AES tests, test AESNI only"
4652 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004653 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004654 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4655 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004656 grep -q "AES note: using AESNI" ./programs/test/selftest
4657 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004658}
4659
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004660component_test_sha3_variations() {
4661 msg "sha3 loop unroll variations"
4662
4663 # define minimal config sufficient to test SHA3
4664 cat > include/mbedtls/mbedtls_config.h << END
4665 #define MBEDTLS_SELF_TEST
4666 #define MBEDTLS_SHA3_C
4667END
4668
4669 msg "all loops unrolled"
4670 make clean
4671 make -C tests test_suite_shax CFLAGS="-DMBEDTLS_SHA3_THETA_UNROLL=1 -DMBEDTLS_SHA3_PI_UNROLL=1 -DMBEDTLS_SHA3_CHI_UNROLL=1 -DMBEDTLS_SHA3_RHO_UNROLL=1"
4672 ./tests/test_suite_shax
4673
4674 msg "all loops rolled up"
4675 make clean
4676 make -C tests test_suite_shax CFLAGS="-DMBEDTLS_SHA3_THETA_UNROLL=0 -DMBEDTLS_SHA3_PI_UNROLL=0 -DMBEDTLS_SHA3_CHI_UNROLL=0 -DMBEDTLS_SHA3_RHO_UNROLL=0"
4677 ./tests/test_suite_shax
4678}
4679
Jerry Yub6d39c22023-08-16 15:11:48 +08004680support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004681 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004682}
4683
4684component_test_aesni_m32 () { # ~ 60s
4685 # This tests are duplicated from component_test_aesni for i386 target
4686 #
4687 # AESNI intrinsic code supports i386 and assembly code does not support it.
4688
4689 msg "build: default config with different AES implementations"
4690 scripts/config.py set MBEDTLS_AESNI_C
4691 scripts/config.py set MBEDTLS_PADLOCK_C
4692 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4693 scripts/config.py set MBEDTLS_HAVE_ASM
4694
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004695 # test the intrinsics implementation with gcc
4696 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004697 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004698 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004699 # check that we built intrinsics - this should be used by default when supported by the compiler
4700 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4701 grep -q "AES note: using AESNI" ./programs/test/selftest
4702 grep -q "AES note: built-in implementation." ./programs/test/selftest
4703 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4704 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4705
4706 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004707 scripts/config.py unset MBEDTLS_PADLOCK_C
4708 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4709 msg "AES tests, test AESNI only"
4710 make clean
4711 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4712 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4713 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4714 grep -q "AES note: using AESNI" ./programs/test/selftest
4715 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4716 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4717 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4718}
4719
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004720support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004721 # clang >= 4 is required to build with target attributes
4722 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004723}
4724
4725component_test_aesni_m32_clang() {
4726
4727 scripts/config.py set MBEDTLS_AESNI_C
4728 scripts/config.py set MBEDTLS_PADLOCK_C
4729 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4730 scripts/config.py set MBEDTLS_HAVE_ASM
4731
4732 # test the intrinsics implementation with clang
4733 msg "AES tests, test intrinsics (clang)"
4734 make clean
4735 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4736 # check that we built intrinsics - this should be used by default when supported by the compiler
4737 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4738 grep -q "AES note: using AESNI" ./programs/test/selftest
4739 grep -q "AES note: built-in implementation." ./programs/test/selftest
4740 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4741 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4742}
4743
Jerry Yu193cbc02023-08-03 17:06:29 +08004744# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4745component_build_aes_aesce_armcc () {
4746 msg "Build: AESCE test on arm64 platform without plain C."
4747 scripts/config.py baremetal
4748
4749 # armc[56] don't support SHA-512 intrinsics
4750 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4751
4752 # Stop armclang warning about feature detection for A64_CRYPTO.
4753 # With this enabled, the library does build correctly under armclang,
4754 # but in baremetal builds (as tested here), feature detection is
4755 # unavailable, and the user is notified via a #warning. So enabling
4756 # this feature would prevent us from building with -Werror on
4757 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004758 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004759 scripts/config.py set MBEDTLS_HAVE_ASM
4760
4761 msg "AESCE, build with default configuration."
4762 scripts/config.py set MBEDTLS_AESCE_C
4763 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4764 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4765
4766 msg "AESCE, build AESCE only"
4767 scripts/config.py set MBEDTLS_AESCE_C
4768 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4769 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4770}
4771
Dave Rodgman0c584032023-10-08 12:26:54 +01004772support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004773 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004774 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004775}
4776
4777component_build_aes_armce () {
4778 # Test variations of AES with Armv8 crypto extensions
4779 scripts/config.py set MBEDTLS_AESCE_C
4780 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4781
4782 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004783 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004784
4785 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4786 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4787
4788 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4789 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4790
Dave Rodgman5e419372023-10-23 15:30:20 +01004791 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004792
Dave Rodgman5e419372023-10-23 15:30:20 +01004793 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4794 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004795
Dave Rodgman5e419372023-10-23 15:30:20 +01004796 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4797 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004798
Dave Rodgman5e419372023-10-23 15:30:20 +01004799 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4800 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004801
4802 # test for presence of AES instructions
4803 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4804 msg "clang, test A32 crypto instructions built"
4805 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4806 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4807 msg "clang, test T32 crypto instructions built"
4808 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4809 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4810 msg "clang, test aarch64 crypto instructions built"
4811 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4812 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4813
4814 # test for absence of AES instructions
4815 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4816 scripts/config.py unset MBEDTLS_AESCE_C
4817 msg "clang, test A32 crypto instructions not built"
4818 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4819 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4820 msg "clang, test T32 crypto instructions not built"
4821 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4822 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4823 msg "clang, test aarch64 crypto instructions not built"
4824 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4825 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004826}
4827
Dave Rodgman9ed18532023-10-05 00:06:47 +01004828support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004829 # clang >= 4 is required to build with SHA extensions
4830 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004831}
4832
Dave Rodgmand9e80832023-10-04 17:17:46 +01004833component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004834 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004835
4836
4837 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004838 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004839 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4840 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4841 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4842 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4843 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004844
Dave Rodgmand9e80832023-10-04 17:17:46 +01004845
Dave Rodgman94a634d2023-10-10 12:59:29 +01004846 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004847 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004848 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4849 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4850 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004851
Dave Rodgman5b89c552023-10-10 14:59:02 +01004852 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004853 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4854 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4855 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004856
Dave Rodgmancd654002023-10-05 09:40:07 +01004857
Dave Rodgman94a634d2023-10-10 12:59:29 +01004858 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004859 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004860 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4861 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4862 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4863 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4864 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004865
Dave Rodgmancd654002023-10-05 09:40:07 +01004866
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004867 # examine the disassembly for presence of SHA instructions
4868 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4869 scripts/config.py set ${opt}
4870 msg "${opt} clang, test A32 crypto instructions built"
4871 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4872 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4873
4874 msg "${opt} clang, test T32 crypto instructions built"
4875 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4876 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4877
4878 msg "${opt} clang, test aarch64 crypto instructions built"
4879 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4880 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4881 scripts/config.py unset ${opt}
4882 done
4883
4884
4885 # examine the disassembly for absence of SHA instructions
4886 msg "clang, test A32 crypto instructions not built"
4887 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4888 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4889
4890 msg "clang, test T32 crypto instructions not built"
4891 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4892 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4893
4894 msg "clang, test aarch64 crypto instructions not built"
4895 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4896 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004897}
4898
Jerry Yuc935aa62023-08-03 17:08:27 +08004899# For timebeing, no VIA Padlock platform available.
4900component_build_aes_via_padlock () {
4901
4902 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004903 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004904 scripts/config.py set MBEDTLS_PADLOCK_C
4905 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00004906 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004907 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004908
4909}
4910
4911support_build_aes_via_padlock_only () {
4912 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4913 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4914 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4915}
4916
Jerry Yu193cbc02023-08-03 17:06:29 +08004917support_build_aes_aesce_armcc () {
4918 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004919}
4920
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004921component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004922 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004923 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004924 scripts/config.py unset MBEDTLS_PADLOCK_C
4925
Dave Rodgmand8d64512023-12-19 12:20:21 +00004926 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004927
4928 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4929 make test
4930}
4931
4932component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4933 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4934 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004935 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4936 scripts/config.py unset MBEDTLS_PADLOCK_C
4937
Hanno Becker83ebf782017-07-07 12:29:15 +01004938 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004939
4940 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004941 make test
4942}
Gilles Peskine8f073122018-11-27 15:58:47 +01004943
Hanno Becker83ebf782017-07-07 12:29:15 +01004944component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004945 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4946 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4947 scripts/config.py unset MBEDTLS_PADLOCK_C
4948 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004949 scripts/config.py unset MBEDTLS_AESCE_C
4950
Dave Rodgmand8d64512023-12-19 12:20:21 +00004951 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004952
4953 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004954 make test
4955
4956 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4957 programs/test/selftest
4958}
4959
Matthias Schulz0767fda2024-02-07 10:46:28 +01004960component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004961 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4962 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004963 scripts/config.py unset MBEDTLS_PADLOCK_C
4964 scripts/config.py unset MBEDTLS_AESNI_C
4965 scripts/config.py unset MBEDTLS_AESCE_C
4966
4967 make CFLAGS='-O2 -Werror -Wall -Wextra'
4968
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004969 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004970 make test
4971}
4972
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004973component_test_aes_fewer_tables () {
4974 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004975 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004976 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004977
Gilles Peskine7c652162017-12-11 00:01:40 +01004978 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004979 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004980}
4981
4982component_test_aes_rom_tables () {
4983 msg "build: default config with AES_ROM_TABLES enabled"
4984 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004985 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004986
4987 msg "test: AES_ROM_TABLES"
4988 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004989}
4990
Gilles Peskine14c3c062018-01-29 21:25:12 +01004991component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004992 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4993 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4994 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004995 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004996
Gilles Peskine8f073122018-11-27 15:58:47 +01004997 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4998 make test
4999}
5000
Yanray Wang49cd4b52023-11-10 11:58:37 +08005001# helper for common_block_cipher_no_decrypt() which:
5002# - enable/disable the list of config options passed from -s/-u respectively.
5003# - build
5004# - test for tests_suite_xxx
5005# - selftest
5006#
5007# Usage: helper_block_cipher_no_decrypt_build_test
5008# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5009# Options: -s set_opts the list of config options to enable
5010# -u unset_opts the list of config options to disable
5011# -c cflags the list of options passed to CFLAGS
5012# -l ldflags the list of options passed to LDFLAGS
5013helper_block_cipher_no_decrypt_build_test () {
5014 while [ $# -gt 0 ]; do
5015 case "$1" in
5016 -s)
5017 shift; local set_opts="$1";;
5018 -u)
5019 shift; local unset_opts="$1";;
5020 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005021 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005022 -l)
5023 shift; local ldflags="$1";;
5024 esac
5025 shift
5026 done
5027 set_opts="${set_opts:-}"
5028 unset_opts="${unset_opts:-}"
5029 cflags="${cflags:-}"
5030 ldflags="${ldflags:-}"
5031
Yanray Wangb2d6e522023-11-13 16:57:47 +08005032 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5033 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005034
5035 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5036 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005037 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005038
5039 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5040 not grep mbedtls_aes_setkey_dec library/aes.o
5041 not grep mbedtls_aria_setkey_dec library/aria.o
5042 not grep mbedtls_camellia_setkey_dec library/camellia.o
5043 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5044 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005045 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5046 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005047
5048 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5049 make test
5050
5051 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5052 programs/test/selftest
5053}
5054
5055# This is a common configuration function used in:
5056# - component_test_block_cipher_no_decrypt_aesni_legacy()
5057# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5058# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5059# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5060# on x86.
5061common_block_cipher_no_decrypt () {
5062 # test AESNI intrinsics
5063 helper_block_cipher_no_decrypt_build_test \
5064 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005065 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005066
5067 # test AESNI assembly
5068 helper_block_cipher_no_decrypt_build_test \
5069 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005070 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005071
5072 # test AES C implementation
5073 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005074 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005075
5076 # test AESNI intrinsics for i386 target
5077 helper_block_cipher_no_decrypt_build_test \
5078 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005079 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005080 -l "-m32"
5081}
5082
Yanray Wang3ae11992023-11-13 17:32:09 +08005083# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5084# usage: 0: no PSA crypto configuration
5085# 1: use PSA crypto configuration
5086config_block_cipher_no_decrypt () {
5087 use_psa=$1
5088
Yanray Wang66111392023-10-31 18:54:54 +08005089 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005090 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5091 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005092 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005093 scripts/config.py unset MBEDTLS_NIST_KW_C
5094
Yanray Wang3ae11992023-11-13 17:32:09 +08005095 if [ "$use_psa" -eq 1 ]; then
5096 # Enable support for cryptographic mechanisms through the PSA API.
5097 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5098 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5099 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5100 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5101 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5102 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5103 fi
5104}
5105
5106component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005107 # This consistently causes an llvm crash on clang 3.8, so use gcc
5108 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005109 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005110 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005111}
5112
Yanray Wangf1496402023-11-01 18:55:13 +08005113component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005114 # This consistently causes an llvm crash on clang 3.8, so use gcc
5115 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005116 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005117 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005118}
5119
Yanray Wang66111392023-10-31 18:54:54 +08005120support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005121 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005122}
5123
Yanray Wang66111392023-10-31 18:54:54 +08005124component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005125 scripts/config.py baremetal
5126
5127 # armc[56] don't support SHA-512 intrinsics
5128 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5129
5130 # Stop armclang warning about feature detection for A64_CRYPTO.
5131 # With this enabled, the library does build correctly under armclang,
5132 # but in baremetal builds (as tested here), feature detection is
5133 # unavailable, and the user is notified via a #warning. So enabling
5134 # this feature would prevent us from building with -Werror on
5135 # armclang. Tracked in #7198.
5136 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5137 scripts/config.py set MBEDTLS_HAVE_ASM
5138
Yanray Wang3ae11992023-11-13 17:32:09 +08005139 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005140
5141 # test AESCE baremetal build
5142 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005143 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005144 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005145
Yanray Wangef1b04d2023-09-08 11:09:26 +08005146 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5147 not grep mbedtls_aes_setkey_dec library/aes.o
5148 not grep mbedtls_aria_setkey_dec library/aria.o
5149 not grep mbedtls_camellia_setkey_dec library/camellia.o
5150 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5151 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005152 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005153 not grep mbedtls_aesce_inverse_key library/aesce.o
5154 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005155}
5156
Gilles Peskine592f5912019-10-07 18:49:32 +02005157component_test_ctr_drbg_aes_256_sha_256 () {
5158 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5159 scripts/config.py full
5160 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5161 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005162 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005163 make
5164
5165 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5166 make test
5167}
5168
5169component_test_ctr_drbg_aes_128_sha_512 () {
5170 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005171 scripts/config.py full
5172 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5173 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005174 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005175 make
5176
5177 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5178 make test
5179}
5180
5181component_test_ctr_drbg_aes_128_sha_256 () {
5182 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005183 scripts/config.py full
5184 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5185 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5186 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005187 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005188 make
5189
5190 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5191 make test
5192}
5193
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005194component_test_se_default () {
5195 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005196 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005197 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005198
5199 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5200 make test
5201}
5202
Steven Cooremand57203d2020-07-16 20:28:59 +02005203component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005204 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005205 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005206 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005207 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5208 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005209 loc_cflags="${loc_cflags} -I../tests/include -O2"
5210
Gilles Peskine21570cf2023-12-22 11:49:50 +01005211 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005212
Gilles Peskine1997f302023-07-26 18:45:20 +02005213 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005214 make test
5215}
5216
Gilles Peskine8f073122018-11-27 15:58:47 +01005217component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005218 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005219 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005220 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005221 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005222}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005223
Gilles Peskinecf740502019-07-03 20:43:05 +02005224component_test_cmake_shared () {
5225 msg "build/test: cmake shared" # ~ 2min
5226 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5227 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005228 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005229 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005230 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005231}
5232
Gilles Peskineec10bf12019-09-20 19:56:06 +02005233test_build_opt () {
5234 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005235 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005236 for opt in "$@"; do
5237 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005238 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005239 # We're confident enough in compilers to not run _all_ the tests,
5240 # but at least run the unit tests. In particular, runs with
5241 # optimizations use inline assembly whereas runs with -O0
5242 # skip inline assembly.
5243 make test # ~30s
5244 make clean
5245 done
5246}
5247
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005248# For FreeBSD we invoke the function by name so this condition is added
5249# to disable the existing test_clang_opt function for linux.
5250if [[ $(uname) != "Linux" ]]; then
5251 component_test_clang_opt () {
5252 scripts/config.py full
5253 test_build_opt 'full config' clang -O0 -Os -O2
5254 }
5255fi
5256
5257component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005258 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005259 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005260}
5261support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005262 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005263}
5264
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005265component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005266 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005267 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005268}
5269support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005270 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005271}
5272
5273component_test_gcc_latest_opt () {
5274 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005275 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005276}
5277support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005278 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005279}
5280
5281component_test_gcc_earliest_opt () {
5282 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005283 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005284}
5285support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005286 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005287}
5288
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005289component_build_mbedtls_config_file () {
5290 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005291 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005292 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005293 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005294 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005295 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5296 make clean
5297
5298 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5299 # In the user config, disable one feature (for simplicity, pick a feature
5300 # that nothing else depends on).
5301 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005302 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005303 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5304
5305 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005306}
5307
Gilles Peskine7d904e72022-04-07 21:59:14 +02005308component_build_psa_config_file () {
5309 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5310 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5311 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5312 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5313 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005314 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005315 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5316 make clean
5317
5318 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
5319 # In the user config, disable one feature, which will reflect on the
5320 # mbedtls configuration so we can query it with query_compile_time_config.
5321 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
5322 scripts/config.py unset MBEDTLS_CMAC_C
5323 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5324 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5325
5326 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005327}
5328
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005329component_build_psa_alt_headers () {
5330 msg "build: make with PSA alt headers" # ~20s
5331
5332 # Generate alternative versions of the substitutable headers with the
5333 # same content except different include guards.
5334 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5335
5336 # Build the library and some programs.
5337 # Don't build the fuzzers to avoid having to go through hoops to set
5338 # a correct include path for programs/fuzz/Makefile.
5339 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
5340 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\"'"
5341
5342 # Check that we're getting the alternative include guards and not the
5343 # original include guards.
5344 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5345 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5346 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5347 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5348}
5349
Dave Rodgman852de3c2023-12-14 14:46:45 +00005350component_test_m32_no_asm () {
5351 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005352 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005353 #
5354 # Note that we require gcc, because clang Asan builds fail to link for
5355 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005356 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005357 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005358 scripts/config.py unset MBEDTLS_HAVE_ASM
5359 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005360 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005361 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005362
Dave Rodgman852de3c2023-12-14 14:46:45 +00005363 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005364 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005365}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005366support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005367 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005368 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005369 *) false;;
5370 esac
5371}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005372
Gilles Peskineff0aee02021-10-05 09:36:03 +02005373component_test_m32_o2 () {
5374 # Build with optimization, to use the i386 specific inline assembly
5375 # and go faster for tests.
5376 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005377 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005378 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005379 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005380
Gilles Peskineff0aee02021-10-05 09:36:03 +02005381 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005382 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005383
Gilles Peskineff0aee02021-10-05 09:36:03 +02005384 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005385 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005386}
Gilles Peskinecf522222021-10-07 19:25:29 +02005387support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005388 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005389}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005390
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005391component_test_m32_everest () {
5392 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005393 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005394 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005395 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005396
5397 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5398 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005399
5400 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005401 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005402
5403 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5404 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005405 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005406}
5407support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005408 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005409}
5410
Gilles Peskine8f073122018-11-27 15:58:47 +01005411component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005412 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005413 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005414 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005415
5416 msg "test: 64-bit ILP32, make, gcc"
5417 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005418}
Gilles Peskine878cf602019-01-06 20:50:38 +00005419support_test_mx32 () {
5420 case $(uname -m) in
5421 amd64|x86_64) true;;
5422 *) false;;
5423 esac
5424}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005425
Peter Kolbus60c6da22018-12-27 06:59:04 -06005426component_test_min_mpi_window_size () {
5427 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005428 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005429 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005430 make
5431
5432 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5433 make test
5434}
5435
Gilles Peskine8f073122018-11-27 15:58:47 +01005436component_test_have_int32 () {
5437 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005438 scripts/config.py unset MBEDTLS_HAVE_ASM
5439 scripts/config.py unset MBEDTLS_AESNI_C
5440 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005441 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005442 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005443
Gilles Peskine8f073122018-11-27 15:58:47 +01005444 msg "test: gcc, force 32-bit bignum limbs"
5445 make test
5446}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005447
Gilles Peskine8f073122018-11-27 15:58:47 +01005448component_test_have_int64 () {
5449 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005450 scripts/config.py unset MBEDTLS_HAVE_ASM
5451 scripts/config.py unset MBEDTLS_AESNI_C
5452 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005453 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005454 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005455
Gilles Peskine8f073122018-11-27 15:58:47 +01005456 msg "test: gcc, force 64-bit bignum limbs"
5457 make test
5458}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005459
Gabor Mezeie256cc12023-07-26 17:28:48 +02005460component_test_have_int32_cmake_new_bignum () {
5461 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5462 scripts/config.py unset MBEDTLS_HAVE_ASM
5463 scripts/config.py unset MBEDTLS_AESNI_C
5464 scripts/config.py unset MBEDTLS_PADLOCK_C
5465 scripts/config.py unset MBEDTLS_AESCE_C
5466 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005467 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005468 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005469
5470 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5471 make test
5472}
5473
Gilles Peskine8f073122018-11-27 15:58:47 +01005474component_test_no_udbl_division () {
5475 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005476 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005477 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005478 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005479
Gilles Peskine8f073122018-11-27 15:58:47 +01005480 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5481 make test
5482}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005483
Gilles Peskine8f073122018-11-27 15:58:47 +01005484component_test_no_64bit_multiplication () {
5485 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005486 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005487 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005488 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005489
Gilles Peskine8f073122018-11-27 15:58:47 +01005490 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5491 make test
5492}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005493
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005494component_test_no_strings () {
5495 msg "build: no strings" # ~10s
5496 scripts/config.py full
5497 # Disable options that activate a large amount of string constants.
5498 scripts/config.py unset MBEDTLS_DEBUG_C
5499 scripts/config.py unset MBEDTLS_ERROR_C
5500 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5501 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005502 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005503
5504 msg "test: no strings" # ~ 10s
5505 make test
5506}
5507
Hanno Beckerc5722d12020-10-09 11:10:42 +01005508component_test_no_x509_info () {
5509 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5510 scripts/config.pl full
5511 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5512 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005513 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005514
5515 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5516 make test
5517
5518 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005519 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005520}
5521
Gilles Peskine8f073122018-11-27 15:58:47 +01005522component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005523 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005524 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005525 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 +02005526
Gilles Peskinee36fe812021-09-01 20:00:33 +02005527 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005528 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005529}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005530
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005531component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005532 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005533 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005534 # Build for a target platform that's close to what Debian uses
5535 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005536 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005537 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005538 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005539 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'
5540
Gilles Peskinee36fe812021-09-01 20:00:33 +02005541 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005542 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005543}
5544support_build_arm_linux_gnueabi_gcc_arm5vte () {
5545 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5546}
5547
5548component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005549 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005550 scripts/config.py baremetal
5551 # This is an imperfect substitute for
5552 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005553 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005554 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 +02005555
Gilles Peskinee36fe812021-09-01 20:00:33 +02005556 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005557 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005558}
5559
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005560component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005561 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5562 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005563 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 +02005564
Gilles Peskinee36fe812021-09-01 20:00:33 +02005565 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005566 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005567 for lib in library/*.a; do
5568 echo "$lib:"
5569 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5570 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005571}
5572
Gilles Peskine8f073122018-11-27 15:58:47 +01005573component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005574 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005575 scripts/config.py baremetal
5576 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005577 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 +01005578 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005579 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005580}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005581
Gilles Peskine8f073122018-11-27 15:58:47 +01005582component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005583 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005584 scripts/config.py baremetal
5585 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005586 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 +01005587 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005588 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005589}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005590
Dave Rodgman8c315f22023-06-02 10:26:24 -04005591component_build_arm_clang_thumb () {
5592 # ~ 30s
5593
5594 scripts/config.py baremetal
5595
5596 msg "build: clang thumb 2, make"
5597 make clean
5598 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5599
5600 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5601 msg "build: clang thumb 1 -O0, make"
5602 make clean
5603 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5604
5605 msg "build: clang thumb 1 -Os, make"
5606 make clean
5607 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5608}
5609
Gilles Peskine8f073122018-11-27 15:58:47 +01005610component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005611 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005612 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005613 # armc[56] don't support SHA-512 intrinsics
5614 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005615
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005616 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5617 scripts/config.py unset MBEDTLS_AESCE_C
5618
Dave Rodgman0fddf822023-03-02 15:32:12 +00005619 # Stop armclang warning about feature detection for A64_CRYPTO.
5620 # With this enabled, the library does build correctly under armclang,
5621 # but in baremetal builds (as tested here), feature detection is
5622 # unavailable, and the user is notified via a #warning. So enabling
5623 # this feature would prevent us from building with -Werror on
5624 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005625 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005626
Hanno Beckerf0762e92022-07-15 12:08:19 +01005627 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005628
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005629 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005630
5631 msg "size: ARM Compiler 5"
5632 "$ARMC5_FROMELF" -z library/*.o
5633
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005634 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005635
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005636 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005637 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005638
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005639 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005640 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5641
5642 # ARM Compiler 6 - Target ARMv7-M+DSP
5643 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005644
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005645 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005646 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005647
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005648 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005649 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005650
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005651 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5652 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5653
Dave Rodgman99318e62023-05-24 12:27:42 +01005654 # ARM Compiler 6 - Target Cortex-M0
5655 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005656
5657 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5658 #
5659 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5660 # that we have in our CI
5661 scripts/config.py set MBEDTLS_AESCE_C
5662 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005663}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005664
Pengyu Lvdf070032023-02-24 16:03:31 +08005665support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005666 armc5_cc="$ARMC5_BIN_DIR/armcc"
5667 armc6_cc="$ARMC6_BIN_DIR/armclang"
5668 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005669}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005670
Ronald Crond2cb7f42024-03-18 12:49:18 +01005671component_test_tls12_only () {
5672 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5673 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5674 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5675 make
5676
5677 msg "test: main suites (inc. selftests) (ASan build)"
5678 make test
5679
5680 msg "test: ssl-opt.sh (ASan build)"
5681 tests/ssl-opt.sh
5682
5683 msg "test: compat.sh (ASan build)"
5684 tests/compat.sh
5685}
5686
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005687component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005688 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005689 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005690 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005691 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5692
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005693 msg "test: TLS 1.3 only, all key exchange modes enabled"
5694 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005695
Ronald Cronc3f43b62022-10-17 17:35:32 +02005696 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5697 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005698}
5699
Ronald Cronc3f43b62022-10-17 17:35:32 +02005700component_test_tls13_only_psk () {
5701 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5702 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5703 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5704 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005705 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005706 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5707 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5708 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5709 scripts/config.py unset MBEDTLS_ECDSA_C
5710 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005711 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005712 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005713 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5714
Ronald Cronc3f43b62022-10-17 17:35:32 +02005715 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5716 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005717
Ronald Cronc3f43b62022-10-17 17:35:32 +02005718 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5719 tests/ssl-opt.sh
5720}
5721
5722component_test_tls13_only_ephemeral () {
5723 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5724 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5725 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005726 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005727 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5728
5729 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5730 cd tests; ./test_suite_ssl; cd ..
5731
5732 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5733 tests/ssl-opt.sh
5734}
5735
Przemek Stekiela01c2422023-06-13 10:46:48 +02005736component_test_tls13_only_ephemeral_ffdh () {
5737 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5738 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5739 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5740 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005741 scripts/config.py unset MBEDTLS_ECDH_C
5742
Przemek Stekiela01c2422023-06-13 10:46:48 +02005743 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5744
5745 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5746 cd tests; ./test_suite_ssl; cd ..
5747
5748 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5749 tests/ssl-opt.sh
5750}
5751
Ronald Cronc3f43b62022-10-17 17:35:32 +02005752component_test_tls13_only_psk_ephemeral () {
5753 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5754 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5755 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5756 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5757 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5758 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5759 scripts/config.py unset MBEDTLS_ECDSA_C
5760 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005761 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005762 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005763 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5764
5765 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5766 cd tests; ./test_suite_ssl; cd ..
5767
5768 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5769 tests/ssl-opt.sh
5770}
5771
Przemek Stekiela01c2422023-06-13 10:46:48 +02005772component_test_tls13_only_psk_ephemeral_ffdh () {
5773 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5774 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5775 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5776 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5777 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5778 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5779 scripts/config.py unset MBEDTLS_ECDSA_C
5780 scripts/config.py unset MBEDTLS_PKCS1_V21
5781 scripts/config.py unset MBEDTLS_PKCS7_C
5782 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005783 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005784 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5785
5786 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5787 cd tests; ./test_suite_ssl; cd ..
5788
5789 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5790 tests/ssl-opt.sh
5791}
5792
Ronald Cronc3f43b62022-10-17 17:35:32 +02005793component_test_tls13_only_psk_all () {
5794 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5795 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5796 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5797 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5798 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5799 scripts/config.py unset MBEDTLS_ECDSA_C
5800 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005801 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005802 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005803 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5804
5805 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5806 cd tests; ./test_suite_ssl; cd ..
5807
5808 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5809 tests/ssl-opt.sh
5810}
5811
5812component_test_tls13_only_ephemeral_all () {
5813 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5814 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005815 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005816 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5817
5818 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5819 cd tests; ./test_suite_ssl; cd ..
5820
5821 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5822 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005823}
5824
Ronald Cron46ac0652024-03-18 12:39:04 +01005825component_test_tls13_no_padding () {
5826 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005827 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005828 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005829 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005830 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005831 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005832 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005833 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005834 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005835}
5836
Ronald Cron6f135e12021-12-08 16:57:54 +01005837component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005838 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005839 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005840 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005841 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005842 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005843 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005844 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005845 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005846 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005847}
5848
Ronald Crondd96c0a2024-04-02 12:34:24 +02005849component_test_full_minus_session_tickets() {
5850 msg "build: full config without session tickets"
5851 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005852 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005853 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005854 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5855 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005856 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005857 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005858 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005859 tests/ssl-opt.sh
5860}
5861
Gilles Peskine8f073122018-11-27 15:58:47 +01005862component_build_mingw () {
5863 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005864 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra -maes -msse2 -mpclmul' WINDOWS_BUILD=1 lib programs
Hanno Beckere963efa2018-01-03 10:03:43 +00005865
Gilles Peskine8f073122018-11-27 15:58:47 +01005866 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005867 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -maes -msse2 -mpclmul' WINDOWS_BUILD=1 tests
Gilles Peskine8f073122018-11-27 15:58:47 +01005868 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005869
Gilles Peskine8f073122018-11-27 15:58:47 +01005870 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005871 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra -maes -msse2 -mpclmul' WINDOWS_BUILD=1 SHARED=1 lib programs
5872 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra -maes -msse2 -mpclmul' WINDOWS_BUILD=1 SHARED=1 tests
Gilles Peskine8f073122018-11-27 15:58:47 +01005873 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005874
Pengyu Lv158eead2023-10-19 11:27:05 +08005875 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005876 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005877 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra' WINDOWS_BUILD=1 lib
Gilles Peskine8f073122018-11-27 15:58:47 +01005878 make WINDOWS_BUILD=1 clean
5879}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005880support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005881 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5882 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005883 *) true;;
5884 esac
5885}
Simon Butcher91aef332016-11-17 09:20:50 +00005886
Gilles Peskine8f073122018-11-27 15:58:47 +01005887component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005888 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005889 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005890 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5891 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005892
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005893 msg "test: main suites (MSan)" # ~ 10s
5894 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005895
Gilles Peskine6848d172023-11-02 19:58:03 +01005896 msg "test: metatests (MSan)"
5897 tests/scripts/run-metatests.sh any msan
5898
Gilles Peskine82b27272019-06-14 18:27:03 +02005899 msg "program demos (MSan)" # ~20s
5900 tests/scripts/run_demos.py
5901
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005902 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005903 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005904
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005905 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005906
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005907 if [ "$MEMORY" -gt 0 ]; then
5908 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005909 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005910 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005911}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005912
Bence Szépkúti0354d042023-12-06 16:14:37 +01005913component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005914 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005915 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005916 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5917 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005918
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005919 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005920 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005921
Gilles Peskine636c26a2020-03-04 20:46:15 +01005922 # Optional parts (slow; currently broken on OS X because programs don't
5923 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005924 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005925 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005926 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005927 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005928 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005929
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005930 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005931 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005932 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005933 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005934
5935 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005936 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005937 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005938 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005939}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005940
Bence Szépkúti0354d042023-12-06 16:14:37 +01005941component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005942 msg "build: Release, full (clang)"
5943 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5944 scripts/config.py full
5945 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5946 make
5947
5948 msg "test: main suites, Valgrind (full config)"
5949 make memcheck
5950}
5951
Paul Elliott62dc3922021-11-25 17:29:40 +00005952support_test_cmake_out_of_source () {
5953 distrib_id=""
5954 distrib_ver=""
5955 distrib_ver_minor=""
5956 distrib_ver_major=""
5957
5958 # Attempt to parse lsb-release to find out distribution and version. If not
5959 # found this should fail safe (test is supported).
5960 if [[ -f /etc/lsb-release ]]; then
5961
5962 while read -r lsb_line; do
5963 case "$lsb_line" in
5964 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5965 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5966 esac
5967 done < /etc/lsb-release
5968
5969 distrib_ver_major="${distrib_ver%%.*}"
5970 distrib_ver="${distrib_ver#*.}"
5971 distrib_ver_minor="${distrib_ver%%.*}"
5972 fi
5973
5974 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5975 # processor (as the CI does) can create a race condition whereby the build
5976 # fails to see a generated file, despite that file actually having been
5977 # generated. This problem appears to go away with 18.04 or newer, so make
5978 # the out of source tests unsupported on Ubuntu 16.04.
5979 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5980}
5981
Gilles Peskine8f073122018-11-27 15:58:47 +01005982component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005983 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005984 # generates
5985 make neat
5986
Gilles Peskine8f073122018-11-27 15:58:47 +01005987 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005988 MBEDTLS_ROOT_DIR="$PWD"
5989 mkdir "$OUT_OF_SOURCE_DIR"
5990 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005991 # Note: Explicitly generate files as these are turned off in releases
5992 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005993 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005994
Gilles Peskine8f073122018-11-27 15:58:47 +01005995 msg "test: cmake 'out-of-source' build"
5996 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005997 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005998 # Also ensure that there are no error messages such as
5999 # "No such file or directory", which would indicate that some required
6000 # file is missing (ssl-opt.sh tolerates the absence of some files so
6001 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006002 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006003 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006004 cat ssl-opt.err >&2
6005 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006006 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006007 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006008 cd "$MBEDTLS_ROOT_DIR"
6009 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006010}
Andres AGdc192212016-08-31 17:33:13 +01006011
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006012component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006013 # Remove existing generated files so that we use the ones CMake
6014 # generates
6015 make neat
6016
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006017 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006018 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006019 # Note: Explicitly generate files as these are turned off in releases
6020 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006021 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006022 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006023}
Gilles Peskinea3000992022-02-04 00:21:12 +01006024support_test_cmake_as_subdirectory () {
6025 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006026}
6027
Chris Kayd259e342021-03-25 16:03:25 +00006028component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006029 # Remove existing generated files so that we use the ones CMake
6030 # generates
6031 make neat
6032
Chris Kayd259e342021-03-25 16:03:25 +00006033 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006034 cd programs/test/cmake_package
6035 cmake .
6036 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006037 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006038}
Gilles Peskinea3000992022-02-04 00:21:12 +01006039support_test_cmake_as_package () {
6040 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006041}
6042
6043component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006044 # Remove existing generated files so that we use the ones CMake
6045 # generates
6046 make neat
6047
Chris Kayd259e342021-03-25 16:03:25 +00006048 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006049 cd programs/test/cmake_package_install
6050 cmake .
6051 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006052 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006053}
Gilles Peskinea3000992022-02-04 00:21:12 +01006054support_test_cmake_as_package_install () {
6055 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006056}
6057
David Horstmann20550e32023-01-12 14:17:01 +00006058component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006059 # Make a copy of config file to use for the in-tree test
6060 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006061
6062 MBEDTLS_ROOT_DIR="$PWD"
6063 mkdir "$OUT_OF_SOURCE_DIR"
6064 cd "$OUT_OF_SOURCE_DIR"
6065
David Horstmann969c1452023-01-31 10:34:44 +00006066 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006067 cmake "$MBEDTLS_ROOT_DIR"
6068 make
6069
6070 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6071 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006072 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006073 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6074 make
6075
6076 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6077 # In the user config, disable one feature (for simplicity, pick a feature
6078 # that nothing else depends on).
6079 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6080
6081 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6082 make
6083 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6084
6085 rm -f user_config.h full_config.h
6086
6087 cd "$MBEDTLS_ROOT_DIR"
6088 rm -rf "$OUT_OF_SOURCE_DIR"
6089
6090 # Now repeat the test for an in-tree build:
6091
David Horstmann969c1452023-01-31 10:34:44 +00006092 # Restore config for the in-tree test
6093 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006094
David Horstmann969c1452023-01-31 10:34:44 +00006095 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006096 cmake .
6097 make
6098
6099 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6100 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006101 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006102 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6103 make
6104
6105 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6106 # In the user config, disable one feature (for simplicity, pick a feature
6107 # that nothing else depends on).
6108 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6109
6110 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6111 make
6112 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6113
6114 rm -f user_config.h full_config.h
6115}
6116support_build_cmake_custom_config_file () {
6117 support_test_cmake_out_of_source
6118}
6119
David Horstmann041ed422024-05-10 14:37:48 +01006120component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01006121 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01006122 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
6123 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
6124 make
6125}
6126support_build_cmake_programs_no_testing () {
6127 support_test_cmake_out_of_source
6128}
David Horstmann20550e32023-01-12 14:17:01 +00006129
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006130component_build_zeroize_checks () {
6131 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6132
6133 scripts/config.py full
6134
6135 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006136 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-zeroize-memset.h\"' -DMBEDTLS_TEST_DEFINES_ZEROIZE -Werror -Wsizeof-pointer-memaccess"
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006137}
6138
6139
Gilles Peskine8f073122018-11-27 15:58:47 +01006140component_test_zeroize () {
6141 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6142 # different combinations of compilers and optimization flags by using an
6143 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6144 # system in all cases that the script fails, so we must manually search the
6145 # output to check whether the pass string is present and no failure strings
6146 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006147
Gilles Peskine4976e822019-01-06 19:52:22 +00006148 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6149 # about a spurious message if Gdb tries and fails, so suppress that.
6150 gdb_disable_aslr=
6151 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6152 gdb_disable_aslr='set disable-randomization off'
6153 fi
6154
Gilles Peskine8f073122018-11-27 15:58:47 +01006155 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006156 for compiler in clang gcc; do
6157 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6158 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006159 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6160 grep "The buffer was correctly zeroized" test_zeroize.log
6161 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006162 rm -f test_zeroize.log
6163 make clean
6164 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006165 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006166}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006167
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006168component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006169 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006170 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006171 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006172
6173 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006174 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006175}
6176
6177support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006178 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006179 ver="$(cmake --version)"
6180 ver="${ver#cmake version }"
6181 ver_major="${ver%%.*}"
6182
6183 ver="${ver#*.}"
6184 ver_minor="${ver%%.*}"
6185
6186 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006187}
6188
Gilles Peskinec848d222022-12-09 12:23:35 +01006189component_check_code_style () {
6190 msg "Check C code style"
6191 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006192}
6193
Gilles Peskinec848d222022-12-09 12:23:35 +01006194support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006195 case $(uncrustify --version) in
6196 *0.75.1*) true;;
6197 *) false;;
6198 esac
6199}
6200
Gilles Peskine8f073122018-11-27 15:58:47 +01006201component_check_python_files () {
6202 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006203 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006204}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006205
Joe Subbianid614c0b2021-07-29 11:18:29 +01006206component_check_test_helpers () {
6207 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006208 # unittest writes out mundane stuff like number or tests run on stderr.
6209 # Our convention is to reserve stderr for actual errors, and write
6210 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006211 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006212
Joe Subbiania25ffab2021-08-06 09:41:27 +01006213 msg "unit test: translate_ciphers.py"
6214 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006215}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006216
Valerio Settid9e42512024-05-06 15:59:51 +02006217component_test_psasim() {
Valerio Settid1b6ef12024-05-07 16:00:21 +02006218 msg "build library for client"
6219
6220 helper_crypto_client_build client
6221
6222 msg "build library for server"
6223
6224 scripts/config.py crypto
6225
6226 helper_crypto_client_build server
6227
Valerio Settid9e42512024-05-06 15:59:51 +02006228 msg "build psasim"
Valerio Setti4362aae2024-05-09 09:15:39 +02006229 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Settid9e42512024-05-06 15:59:51 +02006230
6231 msg "test psasim"
Valerio Setti655b9792024-05-09 12:20:40 +02006232 tests/psa-client-server/psasim/test/run_test.sh
Valerio Settid9e42512024-05-06 15:59:51 +02006233
6234 msg "clean psasim"
6235 make -C tests/psa-client-server/psasim clean
6236}
Jerry Yud767cc42023-03-31 15:03:55 +08006237
Gilles Peskine192c72f2017-12-21 15:59:21 +01006238################################################################
6239#### Termination
6240################################################################
6241
Gilles Peskine8f073122018-11-27 15:58:47 +01006242post_report () {
6243 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006244 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006245
Gilles Peskine8f073122018-11-27 15:58:47 +01006246 final_report
6247}
6248
6249
6250
6251################################################################
6252#### Run all the things
6253################################################################
6254
Gilles Peskine5d996822020-03-28 21:09:21 +01006255# Function invoked by --error-test to test error reporting.
6256pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006257 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006258 if [ $KEEP_GOING -ne 0 ]; then
6259 echo "Expect three failing commands."
6260 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006261 # If the component doesn't run in a subshell, changing error_test_i to an
6262 # invalid integer will cause an error in the loop that runs this function.
6263 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006264 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006265 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006266 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006267 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006268 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006269 make unknown_target
6270 false "this should not be executed"
6271}
6272
Gilles Peskinee48351a2018-11-27 16:06:30 +01006273# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006274run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006275 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006276 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006277
6278 # Unconditionally create a seedfile that's sufficiently long.
6279 # Do this before each component, because a previous component may
6280 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006281 local dd_cmd
6282 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6283 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006284 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006285 esac
6286 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006287
Gilles Peskineec135542021-08-02 23:14:03 +02006288 # Run the component in a subshell, with error trapping and output
6289 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006290 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006291 # We want to keep running if the subshell fails, so 'set -e' must
6292 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006293 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006294 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006295 (
6296 if [ $QUIET -eq 1 ]; then
6297 # msg() will be silenced, so just print the component name here.
6298 echo "${current_component#component_}"
6299 exec >/dev/null
6300 fi
6301 if [ $KEEP_GOING -eq 1 ]; then
6302 # Keep "set -e" off, and run an ERR trap instead to record failures.
6303 set -E
6304 trap err_trap ERR
6305 fi
6306 # The next line is what runs the component
6307 "$@"
6308 if [ $KEEP_GOING -eq 1 ]; then
6309 trap - ERR
6310 exit $last_failure_status
6311 fi
6312 )
6313 component_status=$?
6314 if [ $KEEP_GOING -eq 1 ]; then
6315 set -e
6316 if [ $component_status -ne 0 ]; then
6317 failure_count=$((failure_count + 1))
6318 fi
6319 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006320
6321 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006322 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006323 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006324}
6325
6326# Preliminary setup
6327pre_check_environment
6328pre_initialize_variables
6329pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006330
Dave Rodgman21900632024-02-26 11:41:19 +00006331setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006332pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006333pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006334pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006335
Gilles Peskine878cf602019-01-06 20:50:38 +00006336build_status=0
6337if [ $KEEP_GOING -eq 1 ]; then
6338 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006339fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006340pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006341pre_print_configuration
6342pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006343cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006344if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006345 pre_generate_files
6346fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006347
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006348# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006349for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006350 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006351done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006352unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006353for component in $RUN_COMPONENTS; do
6354 run_component "component_$component"
6355done
Gilles Peskine8f073122018-11-27 15:58:47 +01006356
6357# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006358post_report