blob: 467ff8e7cfb58170695d0123dd5cc1f9bd464b72 [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)
47# * OPENSSL_NEXT = 1.1.1a
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
Gilles Peskine396853a2021-09-20 18:57:55 +0200198 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000199 export CTEST_OUTPUT_ON_FAILURE=1
200
Gilles Peskine8fd59422019-10-21 17:11:33 +0200201 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100202 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200203 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000204 # Normally, tests should use this compiler for ASAN testing
205 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200206
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400207 # Platform tests have an allocation that returns null
208 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400209 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400210
Gilles Peskine878cf602019-01-06 20:50:38 +0000211 # Gather the list of available components. These are the functions
212 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100213 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000214
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000215 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100216 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100217}
Andres AG38495a32016-07-12 16:54:33 +0100218
Dave Rodgman21900632024-02-26 11:41:19 +0000219setup_quiet_wrappers()
220{
221 # Pick up "quiet" wrappers for make and cmake, which don't output very much
222 # unless there is an error. This reduces logging overhead in the CI.
223 #
224 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000225 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
226 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000227 fi
228}
229
Gilles Peskinea28db922019-01-10 00:05:18 +0100230# Test whether the component $1 is included in the command line patterns.
231is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100232{
Gilles Peskine03af6782021-08-06 11:35:17 +0200233 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
234 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100235 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000236 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100237 set +f
238 case ${1#component_} in $pattern) return 0;; esac
239 done
240 set +f
241 return 1
242}
Andres AG7770ea82016-10-10 15:46:20 +0100243
Simon Butcher41eeccf2016-09-07 00:07:09 +0100244usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100245{
Gilles Peskine709346a2017-12-10 23:43:39 +0100246 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100247Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100248Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100249By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100250COMPONENT can be the name of a component or a shell wildcard pattern.
251
252Examples:
253 $0 "check_*"
254 Run all sanity checks.
255 $0 --no-armcc --except test_memsan
256 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100257
258Special options:
259 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000260 --list-all-components List all available test components and exit.
261 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100262
263General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200264 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100265 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100266 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100267 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200268 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200269 --arm-none-eabi-gcc-prefix=<string>
270 Prefix for a cross-compiler for arm-none-eabi
271 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200272 --arm-linux-gnueabi-gcc-prefix=<string>
273 Prefix for a cross-compiler for arm-linux-gnueabi
274 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100275 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200276 --restore First clean up the build tree, restoring backed up
277 files. Do not run any components unless they are
278 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100279 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200280 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100281 --except Exclude the COMPONENTs listed on the command line,
282 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200283 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100284 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100285 --no-force Refuse to overwrite modified files (default).
286 --no-keep-going Stop at the first error (default).
287 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800288 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100289 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200290 --outcome-file=<path> File where test outcomes are written (not done if
291 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100292 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200293 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100294 -s|--seed Integer seed value to use for this test run.
295
296Tool path options:
297 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
298 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100299 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
300 --clang-latest=<Clang_latest_path> Latest version of clang available
301 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
302 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100303 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
304 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100305 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100306 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100307EOF
SimonB2e23c822016-04-16 21:54:39 +0100308}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100309
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200310# Cleanup before/after running a component.
311# Remove built files as well as the cmake cache/config.
312# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100313cleanup()
314{
David Horstmann76a77382023-08-17 17:32:26 +0100315 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100316 command make clean
317 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200318
Gilles Peskine31b07e22018-03-21 12:15:06 +0100319 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000320 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100321 -iname CMakeFiles -exec rm -rf {} \+ -o \
322 \( -iname cmake_install.cmake -o \
323 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200324 -iname CMakeCache.txt -o \
325 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100326 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200327 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200328
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100329 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
330 rm -rf programs/test/cmake_subproject/build
331 rm -f programs/test/cmake_subproject/Makefile
332 rm -f programs/test/cmake_subproject/cmake_subproject
333
Chris Kayd259e342021-03-25 16:03:25 +0000334 # Remove any artifacts from the component_test_cmake_as_package test.
335 rm -rf programs/test/cmake_package/build
336 rm -f programs/test/cmake_package/Makefile
337 rm -f programs/test/cmake_package/cmake_package
338
339 # Remove any artifacts from the component_test_cmake_as_installed_package test.
340 rm -rf programs/test/cmake_package_install/build
341 rm -f programs/test/cmake_package_install/Makefile
342 rm -f programs/test/cmake_package_install/cmake_package_install
343
Gilles Peskinef83eb822020-03-30 20:11:39 +0200344 # Restore files that may have been clobbered by the job
345 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200346 if [[ -e "$x$backup_suffix" ]]; then
347 cp -p "$x$backup_suffix" "$x"
348 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200349 done
350}
John Durkopbd069d32020-10-31 22:14:03 -0700351
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200352# Final cleanup when this script exits (except when exiting on a failure
353# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200354final_cleanup () {
355 cleanup
356
357 for x in $files_to_back_up; do
358 rm -f "$x$backup_suffix"
359 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100360}
361
Gilles Peskine7c652162017-12-11 00:01:40 +0100362# Executed on exit. May be redefined depending on command line options.
363final_report () {
364 :
365}
366
367fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200368 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100369 final_report $1
370 trap - $1
371 kill -$1 $$
372}
373
374trap 'fatal_signal HUP' HUP
375trap 'fatal_signal INT' INT
376trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200377
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200378# Number of processors on this machine. Used as the default setting
379# for parallel make.
380all_sh_nproc ()
381{
382 {
383 nproc || # Linux
384 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
385 sysctl -n hw.ncpu || # FreeBSD
386 echo 1
387 } 2>/dev/null
388}
389
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100390msg()
391{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100392 if [ -n "${current_component:-}" ]; then
393 current_section="${current_component#component_}: $1"
394 else
395 current_section="$1"
396 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200397
398 if [ $QUIET -eq 1 ]; then
399 return
400 fi
401
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100402 echo ""
403 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100404 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000405 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100406 echo "******************************************************************"
407}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100408
Gilles Peskine8f073122018-11-27 15:58:47 +0100409armc6_build_test()
410{
411 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100412
Gilles Peskine18487f62020-04-30 23:11:54 +0200413 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800414 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100415 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000416 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200417
418 msg "size: ARM Compiler 6 ($FLAGS)"
419 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100420}
Andres AGa5cd9732016-10-17 15:23:10 +0100421
Andres AGd9eba4b2016-08-26 14:42:14 +0100422err_msg()
423{
424 echo "$1" >&2
425}
426
427check_tools()
428{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200429 for tool in "$@"; do
430 if ! `type "$tool" >/dev/null 2>&1`; then
431 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100432 exit 1
433 fi
434 done
435}
436
Gilles Peskine8f073122018-11-27 15:58:47 +0100437pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000438 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100439 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100440 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100441 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200442 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000443 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100444
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000445 # Note that legacy options are ignored instead of being omitted from this
446 # list of options, so invocations that worked with previous version of
447 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100448 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100449 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200450 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200451 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200452 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000453 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100454 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
455 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100456 --clang-earliest) shift; CLANG_EARLIEST="$1";;
457 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100458 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000459 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100460 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100461 --gcc-earliest) shift; GCC_EARLIEST="$1";;
462 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100463 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200464 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
465 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100466 --gnutls-serv) shift; GNUTLS_SERV="$1";;
467 --help|-h) usage; exit;;
468 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000469 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100470 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100471 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200472 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000473 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100474 --no-force) FORCE=0;;
475 --no-keep-going) KEEP_GOING=0;;
476 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200477 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100479 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200480 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100481 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200482 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200484 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200485 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100486 --seed|-s) shift; SEED="$1";;
487 -*)
488 echo >&2 "Unknown option: $1"
489 echo >&2 "Run $0 --help for usage."
490 exit 120
491 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000492 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100493 esac
494 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100495 done
SimonB2e23c822016-04-16 21:54:39 +0100496
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100497 # Exclude components that are not supported on this platform.
498 SUPPORTED_COMPONENTS=
499 for component in $ALL_COMPONENTS; do
500 case $(type "support_$component" 2>&1) in
501 *' function'*)
502 if ! support_$component; then continue; fi;;
503 esac
504 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
505 done
506
507 if [ $list_components -eq 1 ]; then
508 printf '%s\n' $SUPPORTED_COMPONENTS
509 exit
510 fi
511
Gilles Peskinea28db922019-01-10 00:05:18 +0100512 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200513 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000514 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100515 fi
516
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000517 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
518 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100519 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000520 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100521 fi
SimonB2e23c822016-04-16 21:54:39 +0100522
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200523 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100524 if [ $all_except -eq 0 ]; then
525 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200526 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
527 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200528 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100529 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200530 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200531 # If the requested name includes a wildcard character, don't
532 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100533 case $component in
534 *[*?\[]*) continue;;
535 esac
536 case " $SUPPORTED_COMPONENTS " in
537 *" $component "*) :;;
538 *)
539 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
540 unsupported=$((unsupported + 1));;
541 esac
542 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200543 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100544 if [ $unsupported -ne 0 ]; then
545 exit 2
546 fi
547 fi
548
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000549 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100550 RUN_COMPONENTS=
551 for component in $SUPPORTED_COMPONENTS; do
552 if is_component_included "$component"; [ $? -eq $all_except ]; then
553 RUN_COMPONENTS="$RUN_COMPONENTS $component"
554 fi
555 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000556
557 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000558 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100559}
SimonB2e23c822016-04-16 21:54:39 +0100560
Gilles Peskine8f073122018-11-27 15:58:47 +0100561pre_check_git () {
562 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100563 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100564 git checkout-index -f -q $CONFIG_H
565 cleanup
566 else
SimonB2e23c822016-04-16 21:54:39 +0100567
Gilles Peskine8f073122018-11-27 15:58:47 +0100568 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
569 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
570 echo "You can either delete this directory manually, or force the test by rerunning"
571 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
572 exit 1
573 fi
574
Ronald Cron7a93ac52023-07-20 09:49:12 +0200575 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100576 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100577 echo "You can either delete or preserve your work, or force the test by rerunning the"
578 echo "script as: $0 --force"
579 exit 1
580 fi
SimonB2e23c822016-04-16 21:54:39 +0100581 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500582}
583
Gilles Peskine568f53a2021-07-12 18:16:01 +0200584pre_restore_files () {
585 # If the makefiles have been generated by a framework such as cmake,
586 # restore them from git. If the makefiles look like modifications from
587 # the ones checked into git, take care not to modify them. Whatever
588 # this function leaves behind is what the script will restore before
589 # each component.
590 case "$(head -n1 Makefile)" in
591 *[Gg]enerated*)
592 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
593 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
594 ;;
595 esac
596}
597
Gilles Peskinef83eb822020-03-30 20:11:39 +0200598pre_back_up () {
599 for x in $files_to_back_up; do
600 cp -p "$x" "$x$backup_suffix"
601 done
602}
603
Gilles Peskine8f073122018-11-27 15:58:47 +0100604pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100605 failure_count=0 # Number of failed components
606 last_failure_status=0 # Last failure status in this component
607
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100608 # See err_trap
609 previous_failure_status=0
610 previous_failed_command=
611 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100612 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100613
Gilles Peskine7c652162017-12-11 00:01:40 +0100614 start_red=
615 end_color=
616 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100617 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100618 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
619 start_red=$(printf '\033[31m')
620 end_color=$(printf '\033[0m')
621 ;;
622 esac
623 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100624
625 # Keep a summary of failures in a file. We'll print it out at the end.
626 failure_summary_file=$PWD/all-sh-failures-$$.log
627 : >"$failure_summary_file"
628
629 # Whether it makes sense to keep a component going after the specified
630 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200631 # This function normally receives the failing simple command
632 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
633 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100634 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200635 # False positives result in running things that can't be expected to
636 # work. False negatives result in things not running after something else
637 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100638 can_keep_going_after_failure () {
639 case "$1" in
640 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200641 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100642 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200643 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
644 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
645 *make*check*) true;;
646 "grep "*) true;;
647 "[ "*) true;;
648 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100649 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100650 esac
651 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100652
653 # This function runs if there is any error in a component.
654 # It must either exit with a nonzero status, or set
655 # last_failure_status to a nonzero value.
656 err_trap () {
657 # Save $? (status of the failing command). This must be the very
658 # first thing, before $? is overridden.
659 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100660 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100661
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100662 if [[ $last_failure_status -eq $previous_failure_status &&
663 "$failed_command" == "$previous_failed_command" &&
664 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
665 then
666 # The same command failed twice in a row, but this time one level
667 # less deep in the function call stack. This happens when the last
668 # command of a function returns a nonzero status, and the function
669 # returns that same status. Ignore the second failure.
670 previous_failure_funcall_depth=${#FUNCNAME[@]}
671 return
672 fi
673 previous_failure_status=$last_failure_status
674 previous_failed_command=$failed_command
675 previous_failure_funcall_depth=${#FUNCNAME[@]}
676
Gilles Peskinece266c42020-03-28 18:50:43 +0100677 text="$current_section: $failed_command -> $last_failure_status"
678 echo "${start_red}^^^^$text^^^^${end_color}" >&2
679 echo "$text" >>"$failure_summary_file"
680
681 # If the command is fatal (configure or build command), stop this
682 # component. Otherwise (test command) keep the component running
683 # (run more tests from the same build).
684 if ! can_keep_going_after_failure "$failed_command"; then
685 exit $last_failure_status
686 fi
687 }
688
Gilles Peskine7c652162017-12-11 00:01:40 +0100689 final_report () {
690 if [ $failure_count -gt 0 ]; then
691 echo
692 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100693 echo "${start_red}FAILED: $failure_count components${end_color}"
694 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100695 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
696 elif [ -z "${1-}" ]; then
697 echo "SUCCESS :)"
698 fi
699 if [ -n "${1-}" ]; then
700 echo "Killed by SIG$1."
701 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100702 rm -f "$failure_summary_file"
703 if [ $failure_count -gt 0 ]; then
704 exit 1
705 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100706 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100707}
708
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200709# record_status() and if_build_succeeded() are kept temporarily for backward
710# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100711record_status () {
712 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100713}
Gilles Peskine7c652162017-12-11 00:01:40 +0100714if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100715 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100716}
717
Gilles Peskinea681c592020-03-28 21:27:40 +0100718# '! true' does not trigger the ERR trap. Arrange to trigger it, with
719# a reasonably informative error message (not just "$@").
720not () {
721 if "$@"; then
722 report_failed_command="! $*"
723 false
724 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200725 fi
726}
727
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200728pre_prepare_outcome_file () {
729 case "$MBEDTLS_TEST_OUTCOME_FILE" in
730 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
731 esac
732 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
733 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
734 fi
735}
736
Gilles Peskine8f073122018-11-27 15:58:47 +0100737pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200738 if [ $QUIET -eq 1 ]; then
739 return
740 fi
741
Gilles Peskine8f073122018-11-27 15:58:47 +0100742 msg "info: $0 configuration"
743 echo "MEMORY: $MEMORY"
744 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200745 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100746 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100747 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100748 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100749 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
750 echo "GNUTLS_CLI: $GNUTLS_CLI"
751 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100752 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
753 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
754}
Andres AG7770ea82016-10-10 15:46:20 +0100755
Andres AGd9eba4b2016-08-26 14:42:14 +0100756# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100757pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000758 # Build the list of variables to pass to output_env.sh.
759 set env
SimonB2e23c822016-04-16 21:54:39 +0100760
Gilles Peskine87964262019-01-06 22:40:00 +0000761 case " $RUN_COMPONENTS " in
762 # Require OpenSSL and GnuTLS if running any tests (as opposed to
763 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
764 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100765 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000766 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
767 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100768 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000769 export GNUTLS_CLI="$GNUTLS_CLI"
770 export GNUTLS_SERV="$GNUTLS_SERV"
771 # Avoid passing --seed flag in every call to ssl-opt.sh
772 if [ -n "${SEED-}" ]; then
773 export SEED
774 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200775 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000776 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200777 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
778 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000779 ;;
780 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200781
Gilles Peskine87964262019-01-06 22:40:00 +0000782 case " $RUN_COMPONENTS " in
783 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
784 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100785
Gilles Peskine87964262019-01-06 22:40:00 +0000786 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200787 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000788 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100789
Gilles Peskine87964262019-01-06 22:40:00 +0000790 case " $RUN_COMPONENTS " in
791 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
792 esac
793
794 case " $RUN_COMPONENTS " in
795 *" test_zeroize "*) check_tools "gdb";;
796 esac
797
798 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000799 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000800 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
801 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200802 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000803 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
804 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200805 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
806 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
807 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000808 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000809
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200810 # past this point, no call to check_tool, only printing output
811 if [ $QUIET -eq 1 ]; then
812 return
813 fi
814
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000815 msg "info: output_env.sh"
816 case $RUN_COMPONENTS in
817 *_armcc*)
818 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
819 *) set "$@" RUN_ARMCC=0;;
820 esac
821 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100822}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100823
Gilles Peskine1570b592021-04-22 01:10:12 +0200824pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200825 # since make doesn't have proper dependencies, remove any possibly outdate
826 # file that might be around before generating fresh ones
827 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200828 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200829 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200830 else
831 make generated_files
832 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200833}
834
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000835clang_version() {
836 if command -v clang > /dev/null ; then
837 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
838 else
839 echo 0 # report version 0 for "no clang"
840 fi
841}
842
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200843################################################################
844#### Helpers for components using libtestdriver1
845################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100846
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200847# How to use libtestdriver1
848# -------------------------
849#
850# 1. Define the list algorithms and key types to accelerate,
851# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
852# Examples:
853# - loc_accel_list="ALG_JPAKE"
854# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200855# 2. Make configurations changes for the driver and/or main libraries.
856# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
857# can be either "default" to start with the default config, or a name
858# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200859# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200860# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
861# These changes affect both the driver and the main libraries.
862# (Note: they need to have the same set of PSA_WANT symbols, as that
863# determines the ABI between them.)
864# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
865# main libraries. Typically, you want to disable the module(s) that are
866# being accelerated. You may need to also disable modules that depend
867# on them or options that are not supported with drivers.
868# 2d. On top of psa/crypto_config.h, the driver library uses its own config
869# file: tests/include/test/drivers/config_test_driver.h. You usually
870# don't need to edit it: using loc_extra_list (see below) is preferred.
871# However, when there's no PSA symbol for what you want to enable,
872# calling scripts/config.py on this file remains the only option.
873# 3. Build the driver library, then the main libraries, test, and programs.
874# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
875# need to enable more algorithms here, typically hash algorithms when
876# accelerating some signature algorithms (ECDSA, RSAv2). This is done
877# by passing a 2nd argument listing the extra algorithms.
878# Example:
879# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
880# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800881# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200882# additional arguments will be passed to make: this can be useful if
883# you don't want to build everything when iterating during development.
884# Example:
885# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
886# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200887
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200888# Adjust the configuration - for both libtestdriver1 and main library,
889# as they should have the same PSA_WANT macros.
890helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200891 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200892 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200893 if [ "$base_config" != "default" ]; then
894 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200895 fi
896
897 # Enable PSA-based config (necessary to use drivers)
898 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
899
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200900 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
901 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
902 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000903
904 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
905 # otherwise we will end up running multithreaded tests without mutexes to protect them.
906 if scripts/config.py get MBEDTLS_THREADING_C; then
907 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
908 fi
909
910 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
911 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
912 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200913}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100914
Valerio Settib2fd6732023-08-15 17:10:47 +0200915# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200916# The function optionally accepts 1 parameter: a space-separated list of the
917# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200918helper_disable_builtin_curves() {
919 allowed_list="${1:-}"
920 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
921
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200922 for curve in $allowed_list; do
923 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200924 done
925}
926
927# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
928# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
929# in the following helpers.
930helper_get_psa_curve_list () {
931 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200932 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
933 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200934 done
935
936 echo "$loc_list"
937}
938
Valerio Setti78aa0bc2024-01-17 15:53:46 +0100939# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
940# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
941# in the following helpers.
942helper_get_psa_dh_group_list () {
943 loc_list=""
944 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
945 loc_list="$loc_list $item"
946 done
947
948 echo "$loc_list"
949}
950
Valerio Settib2fd6732023-08-15 17:10:47 +0200951# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +0200952# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +0200953# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +0200954helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200955 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +0200956 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200957 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 +0200958 # Skip DERIVE for elliptic keys since there is no driver dispatch for
959 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200960 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
961 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200962 fi
963 done
964
965 echo "$loc_list"
966}
967
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200968# Build the drivers library libtestdriver1.a (with ASan).
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200969#
970# Parameters:
971# 1. a space-separated list of things to accelerate;
972# 2. optional: a space-separate list of things to also support.
973# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
974helper_libtestdriver1_make_drivers() {
975 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
Gilles Peskine21570cf2023-12-22 11:49:50 +0100976 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200977}
978
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200979# Build the main libraries, programs and tests,
980# linking to the drivers library (with ASan).
981#
982# Parameters:
983# 1. a space-separated list of things to accelerate;
984# *. remaining arguments if any are passed directly to make
985# (examples: lib, -C tests test_suite_xxx, etc.)
986# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
987helper_libtestdriver1_make_main() {
988 loc_accel_list=$1
989 shift
990
991 # we need flags both with and without the LIBTESTDRIVER1_ prefix
992 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
993 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
Gilles Peskine21570cf2023-12-22 11:49:50 +0100994 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include -I../tests -I../../tests -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_TEST_LIBTESTDRIVER1 $loc_accel_flags" LDFLAGS="-ltestdriver1 $ASAN_CFLAGS" "$@"
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200995}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100996
997################################################################
998#### Basic checks
999################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001000
1001#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001002# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001003#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001004# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001005# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001006# 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 +02001007# time, so start with a GCC build).
1008# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001009#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001010# Indicative running times are given for reference.
1011
Gilles Peskine8f073122018-11-27 15:58:47 +01001012component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001013 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001014 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001015}
Janos Follathb72c6782016-07-19 14:54:17 +01001016
Gilles Peskine67debb62021-05-18 16:09:50 +02001017component_check_generated_files () {
1018 msg "Check: check-generated-files, files generated with make" # 2s
1019 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001020 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001021
1022 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001023 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001024 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001025 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001026
1027 msg "Check: check-generated-files -u, files absent" # 2s
1028 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001029 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001030 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001031 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001032
1033 # This component ends with the generated files present in the source tree.
1034 # This is necessary for subsequent components!
1035}
1036
Gilles Peskine8f073122018-11-27 15:58:47 +01001037component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001038 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001039 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001040}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001041
Gilles Peskine8f073122018-11-27 15:58:47 +01001042component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001043 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001044 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001045}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001046
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001047component_check_changelog () {
1048 msg "Check: changelog entries" # < 1s
1049 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001050 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001051 if [ -e ChangeLog.new ]; then
1052 # Show the diff for information. It isn't an error if the diff is
1053 # non-empty.
1054 diff -u ChangeLog ChangeLog.new || true
1055 rm ChangeLog.new
1056 fi
1057}
1058
Gilles Peskine8f073122018-11-27 15:58:47 +01001059component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001060 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001061 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001062}
Darryl Greena07039c2018-03-13 16:48:16 +00001063
Gilles Peskine895868b2019-09-19 21:30:05 +02001064component_check_test_cases () {
1065 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001066 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001067 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001068 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001069 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001070 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001071 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001072 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001073}
1074
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001075component_check_test_dependencies () {
1076 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001077 # The purpose of this component is to catch unjustified dependencies on
1078 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1079 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1080 # MBEDTLS_PSA_xxx).
1081 #
1082 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1083 # this component is meant to catch. However a few of them are justified,
1084 # mostly by the absence of a PSA equivalent, so this component includes a
1085 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001086
1087 found="check-test-deps-found-$$"
1088 expected="check-test-deps-expected-$$"
1089
1090 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001091 grep 'depends_on' \
1092 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001093 grep -Eo '!?MBEDTLS_[^: ]*' |
1094 grep -v MBEDTLS_PSA_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001095 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001096
Yanray Wang18040ed2023-11-23 21:29:56 +08001097 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001098 rm -f $expected
1099 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1100 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001101 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1102 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001103 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1104 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001105 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1106 # the test code and that's probably the most convenient way of achieving
1107 # the test's goal.
1108 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1109 # No PSA equivalent - we should probably have one in the future.
1110 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1111 # No PSA equivalent - needed by some init tests
1112 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001113 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001114 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001115
1116 # Compare reality with expectation.
1117 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001118 #
1119 # The output should be empty. When it's not:
1120 # - Each '+' line is a macro that was found but not expected. You want to
1121 # find where that macro occurs, and either replace it with PSA macros, or
1122 # add it to the exceptions list above with a justification.
1123 # - Each '-' line is a macro that was expected but not found; it means the
1124 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001125 diff -U0 $expected $found
1126
1127 rm $found $expected
1128}
1129
Gilles Peskine8f073122018-11-27 15:58:47 +01001130component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001131 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001132 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001133}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001134
Gilles Peskine192c72f2017-12-21 15:59:21 +01001135
Gilles Peskine636c26a2020-03-04 20:46:15 +01001136
Gilles Peskine192c72f2017-12-21 15:59:21 +01001137################################################################
1138#### Build and test many configurations and targets
1139################################################################
1140
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001141component_test_default_out_of_box () {
1142 msg "build: make, default config (out-of-box)" # ~1min
1143 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001144 # Disable fancy stuff
1145 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001146
1147 msg "test: main suites make, default config (out-of-box)" # ~10s
1148 make test
1149
1150 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001151 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001152
1153 msg "program demos: make, default config (out-of-box)" # ~10s
1154 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001155}
1156
Gilles Peskine8f073122018-11-27 15:58:47 +01001157component_test_default_cmake_gcc_asan () {
1158 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001159 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1160 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001161
Gilles Peskine8f073122018-11-27 15:58:47 +01001162 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1163 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001164
Gilles Peskine82b27272019-06-14 18:27:03 +02001165 msg "program demos (ASan build)" # ~10s
1166 tests/scripts/run_demos.py
1167
Gilles Peskine97bea012020-04-23 23:37:45 +02001168 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001169 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001170
Gilles Peskine6848d172023-11-02 19:58:03 +01001171 msg "test: metatests (GCC, ASan build)"
1172 tests/scripts/run-metatests.sh any asan
1173
Gilles Peskine8f073122018-11-27 15:58:47 +01001174 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001175 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001176
Gilles Peskine8f073122018-11-27 15:58:47 +01001177 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001178 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001179
1180 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001181 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001182}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001183
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001184component_test_default_cmake_gcc_asan_new_bignum () {
1185 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001186 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001187 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001188 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001189
1190 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1191 make test
1192
1193 msg "test: selftest (ASan build)" # ~ 10s
1194 programs/test/selftest
1195
1196 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1197 tests/ssl-opt.sh
1198
1199 msg "test: compat.sh (ASan build)" # ~ 6 min
1200 tests/compat.sh
1201
1202 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1203 tests/context-info.sh
1204}
1205
Hanno Becker01635512019-02-26 14:27:09 +00001206component_test_full_cmake_gcc_asan () {
1207 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001208 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001209 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1210 make
1211
1212 msg "test: main suites (inc. selftests) (full config, ASan build)"
1213 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001214
Gilles Peskine97bea012020-04-23 23:37:45 +02001215 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001216 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001217
Gilles Peskine636c26a2020-03-04 20:46:15 +01001218 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001219 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001220
1221 msg "test: compat.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001222 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001223
1224 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001225 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001226}
1227
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001228
1229component_test_full_cmake_gcc_asan_new_bignum () {
1230 msg "build: full config, cmake, gcc, ASan"
1231 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001232 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001233 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001234 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001235
1236 msg "test: main suites (inc. selftests) (full config, ASan build)"
1237 make test
1238
1239 msg "test: selftest (ASan build)" # ~ 10s
1240 programs/test/selftest
1241
1242 msg "test: ssl-opt.sh (full config, ASan build)"
1243 tests/ssl-opt.sh
1244
1245 msg "test: compat.sh (full config, ASan build)"
1246 tests/compat.sh
1247
1248 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
1249 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001250}
1251
Ronald Cronc3623db2020-10-29 10:51:32 +01001252component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001253 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001254 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001255 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1256 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1257 make
1258
1259 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1260 make test
1261}
1262
Gilles Peskinea3548672021-06-17 11:37:52 +02001263# check_renamed_symbols HEADER LIB
1264# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1265# name is LIB.
1266check_renamed_symbols () {
1267 ! nm "$2" | sed 's/.* //' |
1268 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1269}
1270
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001271component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001272 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001273 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001274 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1275 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1276 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1277 # We can only compile, not link, since our test and sample programs
1278 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1279 # is active.
1280 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001281
1282 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1283 # version is not present.
1284 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001285 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001286}
1287
Ronald Cron336678b2021-01-28 17:54:24 +01001288component_test_psa_crypto_client () {
1289 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1290 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1291 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1292 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001293 scripts/config.py unset MBEDTLS_LMS_C
1294 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Ronald Cron336678b2021-01-28 17:54:24 +01001295 make
1296
1297 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1298 make test
1299}
1300
Jaeden Amero424fa932021-05-14 08:34:32 +01001301component_test_psa_crypto_rsa_no_genprime() {
1302 msg "build: default config minus MBEDTLS_GENPRIME"
1303 scripts/config.py unset MBEDTLS_GENPRIME
1304 make
1305
1306 msg "test: default config minus MBEDTLS_GENPRIME"
1307 make test
1308}
1309
Gilles Peskine782f4112018-11-27 16:11:09 +01001310component_test_ref_configs () {
1311 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001312 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1313 # want to re-generate generated files that depend on it, quite correctly.
1314 # However this doesn't work as the generation script expects a specific
1315 # format for mbedtls_config.h, which the other files don't follow. Also,
1316 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001317 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001318 # whether they're on or off. So, disable cmake's (over-sensitive here)
1319 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001320 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001321 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001322 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001323}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001324
Gilles Peskine8f073122018-11-27 15:58:47 +01001325component_test_no_renegotiation () {
1326 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001327 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001328 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001329 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001330
Gilles Peskine8f073122018-11-27 15:58:47 +01001331 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1332 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001333
Gilles Peskine8f073122018-11-27 15:58:47 +01001334 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001335 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001336}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001337
Gilles Peskine636c26a2020-03-04 20:46:15 +01001338component_test_no_pem_no_fs () {
1339 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1340 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1341 scripts/config.py unset MBEDTLS_FS_IO
1342 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1343 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001344 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001345 make
1346
1347 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1348 make test
1349
1350 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001351 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001352}
1353
Gilles Peskine8f073122018-11-27 15:58:47 +01001354component_test_rsa_no_crt () {
1355 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001356 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001357 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001358 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001359
Gilles Peskine8f073122018-11-27 15:58:47 +01001360 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1361 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001362
Gilles Peskine8f073122018-11-27 15:58:47 +01001363 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001364 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001365
Gilles Peskine8f073122018-11-27 15:58:47 +01001366 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001367 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001368
1369 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001370 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001371}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001372
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001373component_test_no_ctr_drbg_classic () {
1374 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001375 scripts/config.py full
1376 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001377 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001378 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001379
Dave Rodgman17127e92023-12-14 16:42:48 +00001380 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001381 make
1382
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001383 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001384 make test
1385
Gilles Peskineba749042021-01-13 20:02:03 +01001386 # In this configuration, the TLS test programs use HMAC_DRBG.
1387 # The SSL tests are slow, so run a small subset, just enough to get
1388 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001389 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001390 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001391
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001392 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001393 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001394}
1395
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001396component_test_no_ctr_drbg_use_psa () {
1397 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001398 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001399 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1400 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001401
Dave Rodgman17127e92023-12-14 16:42:48 +00001402 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001403 make
1404
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001405 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1406 make test
1407
1408 # In this configuration, the TLS test programs use HMAC_DRBG.
1409 # The SSL tests are slow, so run a small subset, just enough to get
1410 # confidence that the SSL code copes with HMAC_DRBG.
1411 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001412 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001413
1414 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001415 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001416}
1417
1418component_test_no_hmac_drbg_classic () {
1419 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1420 scripts/config.py full
1421 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1422 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1423 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001424 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001425
Dave Rodgman17127e92023-12-14 16:42:48 +00001426 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001427 make
1428
1429 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001430 make test
1431
Gilles Peskinea2224342020-11-19 22:14:34 +01001432 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1433 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1434 # instead.
1435 # Test SSL with non-deterministic ECDSA. Only test features that
1436 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001437 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001438 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001439
1440 # To save time, only test one protocol version, since this part of
1441 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001442 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001443 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001444}
1445
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001446component_test_no_hmac_drbg_use_psa () {
1447 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1448 scripts/config.py full
1449 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1450 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1451 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1452
Dave Rodgman17127e92023-12-14 16:42:48 +00001453 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001454 make
1455
1456 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1457 make test
1458
1459 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1460 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1461 # instead.
1462 # Test SSL with non-deterministic ECDSA. Only test features that
1463 # might be affected by how ECDSA signature is performed.
1464 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001465 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001466
1467 # To save time, only test one protocol version, since this part of
1468 # the protocol is identical in (D)TLS up to 1.2.
1469 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001470 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001471}
1472
1473component_test_psa_external_rng_no_drbg_classic () {
1474 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1475 scripts/config.py full
1476 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001477 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001478 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001479 scripts/config.py unset MBEDTLS_ENTROPY_C
1480 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1481 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001482 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1483 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1484 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001485 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1486 # the SSL test programs don't have an RNG and can't work. Explicitly
1487 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001488 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001489
1490 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1491 make test
1492
Gilles Peskine8eb29432021-02-03 20:07:11 +01001493 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001494 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001495}
1496
1497component_test_psa_external_rng_no_drbg_use_psa () {
1498 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001499 scripts/config.py full
1500 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001501 scripts/config.py unset MBEDTLS_ENTROPY_C
1502 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1503 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001504 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1505 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1506 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001507 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001508
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001509 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001510 make test
1511
Gilles Peskine8eb29432021-02-03 20:07:11 +01001512 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001513 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001514}
1515
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001516component_test_psa_external_rng_use_psa_crypto () {
1517 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1518 scripts/config.py full
1519 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1520 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1521 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001522 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001523
1524 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1525 make test
1526
1527 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1528 tests/ssl-opt.sh -f 'Default\|opaque'
1529}
1530
Gilles Peskine801c4332023-04-28 21:04:28 +02001531component_test_psa_inject_entropy () {
1532 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1533 scripts/config.py full
1534 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1535 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1536 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1537 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1538 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1539 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001540 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 +02001541
1542 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1543 make test
1544}
1545
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001546component_test_sw_inet_pton () {
1547 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1548
1549 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1550 scripts/config.py set MBEDTLS_TEST_HOOKS
1551 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1552
1553 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1554 make test
1555}
1556
Valerio Settia41654d2024-02-08 10:33:11 +01001557component_full_no_pkparse_pkwrite() {
1558 msg "build: full without pkparse and pkwrite"
1559
1560 scripts/config.py crypto_full
1561 scripts/config.py unset MBEDTLS_PK_PARSE_C
1562 scripts/config.py unset MBEDTLS_PK_WRITE_C
1563
Valerio Settia41654d2024-02-08 10:33:11 +01001564 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1565
1566 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1567 not grep mbedtls_pk_parse_key library/pkparse.o
1568 not grep mbedtls_pk_write_key_der library/pkwrite.o
1569
1570 msg "test: full without pkparse and pkwrite"
1571 make test
1572}
1573
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001574component_test_crypto_full_md_light_only () {
1575 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001576 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001577 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001578 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001579 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001580 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001581 scripts/config.py unset MBEDTLS_HKDF_C
1582 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001583 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001584 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001585 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001586 # Disable things that would auto-enable MD_C
1587 scripts/config.py unset MBEDTLS_PKCS5_C
1588
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001589 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1590 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001591 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001592
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001593 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001594 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001595 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001596
1597 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001598 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001599}
1600
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001601component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001602 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001603 scripts/config.py full
1604 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001605 # Don't pull in cipher via PSA mechanisms
1606 # (currently ignored anyway because we completely disable PSA)
1607 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001608 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001609 scripts/config.py unset MBEDTLS_CMAC_C
1610 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001611 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001612 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001613 scripts/config.py unset MBEDTLS_SSL_TLS_C
1614 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001615 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001616 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1617 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001618 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001619 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001620 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001621
Valerio Settidf17a102023-10-23 14:14:19 +02001622 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001623 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001624}
1625
Valerio Setti7e710e82023-08-25 09:14:15 +02001626# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001627# - component_test_full_no_cipher_with_psa_crypto
1628# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001629# It accepts 2 input parameters:
1630# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1631# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001632common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001633 USE_CRYPTO_CONFIG="$1"
1634 COMPONENT_DESCRIPTION="$2"
1635
1636 msg "build: $COMPONENT_DESCRIPTION"
1637
1638 scripts/config.py full
1639 scripts/config.py unset MBEDTLS_CIPHER_C
1640
1641 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001642 # The built-in implementation of the following algs/key-types depends
1643 # on CIPHER_C so we disable them.
1644 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1645 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001646 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001647 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1648 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1649 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1650 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1651 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1652 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1653 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1654 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001655 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001656 else
1657 # Don't pull in cipher via PSA mechanisms
1658 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001659 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1660 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1661 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001662 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001663 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001664 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001665 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001666
Gilles Peskine21570cf2023-12-22 11:49:50 +01001667 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001668
Valerio Setti7e710e82023-08-25 09:14:15 +02001669 # Ensure that CIPHER_C was not re-enabled
1670 not grep mbedtls_cipher_init library/cipher.o
1671
1672 msg "test: $COMPONENT_DESCRIPTION"
1673 make test
1674}
1675
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001676component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001677 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001678}
1679
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001680component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001681 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001682}
1683
Valerio Settibdfecb62023-11-07 15:37:20 +01001684component_test_full_no_ccm() {
1685 msg "build: full no PSA_WANT_ALG_CCM"
1686
1687 # Full config enables:
1688 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1689 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1690 scripts/config.py full
1691
1692 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1693 # enabled, but not used from TLS since USE_PSA is set.
1694 # This is helpful to ensure that TLS tests below have proper dependencies.
1695 #
1696 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1697 # PSA_WANT_ALG_CCM to be re-enabled.
1698 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1699
Gilles Peskine21570cf2023-12-22 11:49:50 +01001700 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001701
1702 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001703 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001704}
1705
1706component_test_full_no_ccm_star_no_tag() {
1707 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1708
1709 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1710 scripts/config.py full
1711
1712 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1713 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1714 # This basically disables all unauthenticated ciphers on the PSA side, while
1715 # keeping AEADs enabled.
1716 #
1717 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1718 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1719 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1720 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1721 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1722 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1723 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1724 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1725 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1726 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1727
Gilles Peskine21570cf2023-12-22 11:49:50 +01001728 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001729
1730 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001731 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001732
1733 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001734 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001735}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001736
Valerio Settie1655b82023-01-03 15:35:25 +01001737component_test_full_no_bignum () {
1738 msg "build: full minus bignum"
1739 scripts/config.py full
1740 scripts/config.py unset MBEDTLS_BIGNUM_C
1741 # Direct dependencies of bignum
1742 scripts/config.py unset MBEDTLS_ECP_C
1743 scripts/config.py unset MBEDTLS_RSA_C
1744 scripts/config.py unset MBEDTLS_DHM_C
1745 # Direct dependencies of ECP
1746 scripts/config.py unset MBEDTLS_ECDH_C
1747 scripts/config.py unset MBEDTLS_ECDSA_C
1748 scripts/config.py unset MBEDTLS_ECJPAKE_C
1749 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001750 # Disable what auto-enables ECP_LIGHT
1751 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1752 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001753 # Indirect dependencies of ECP
1754 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1755 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1756 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1757 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1758 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1759 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1760 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1761 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1762 # Direct dependencies of DHM
1763 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1764 # Direct dependencies of RSA
1765 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1766 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1767 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1768 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1769 # PK and its dependencies
1770 scripts/config.py unset MBEDTLS_PK_C
1771 scripts/config.py unset MBEDTLS_PK_PARSE_C
1772 scripts/config.py unset MBEDTLS_PK_WRITE_C
1773 scripts/config.py unset MBEDTLS_X509_USE_C
1774 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1775 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1776 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1777 scripts/config.py unset MBEDTLS_X509_CREATE_C
1778 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1779 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1780 scripts/config.py unset MBEDTLS_PKCS7_C
1781 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1782 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1783 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1784
Gilles Peskine21570cf2023-12-22 11:49:50 +01001785 make
Valerio Settie1655b82023-01-03 15:35:25 +01001786
1787 msg "test: full minus bignum"
1788 make test
1789}
1790
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001791component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001792 msg "build: default with only stream cipher"
1793
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001794 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001795 scripts/config.py unset MBEDTLS_GCM_C
1796 scripts/config.py unset MBEDTLS_CCM_C
1797 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001798 # 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 +02001799 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001800 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001801 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001802 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1803 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001804 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001805 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001806 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001807
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001808 make
1809
1810 msg "test: default with only stream cipher"
1811 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001812
1813 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001814}
1815
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001816component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001817 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001818
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001819 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001820 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001821 scripts/config.py unset MBEDTLS_GCM_C
1822 scripts/config.py unset MBEDTLS_CCM_C
1823 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001824 # 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 +02001825 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001826 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001827 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001828 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1829 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001830 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001831 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001832 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001833
Przemek Stekiel9550c052022-09-28 09:51:55 +02001834 make
1835
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001836 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001837 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001838
1839 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001840}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001841
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001842component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001843 msg "build: default with only CBC-legacy cipher"
1844
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001845 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001846 scripts/config.py unset MBEDTLS_GCM_C
1847 scripts/config.py unset MBEDTLS_CCM_C
1848 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001849 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1850 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1851 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001852 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001853 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001854 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001855 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001856 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001857 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001858
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001859 make
1860
1861 msg "test: default with only CBC-legacy cipher"
1862 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001863
1864 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1865 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001866}
1867
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001868component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001869 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001870
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001871 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001872 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001873 scripts/config.py unset MBEDTLS_GCM_C
1874 scripts/config.py unset MBEDTLS_CCM_C
1875 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001876 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1877 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1878 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001879 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001880 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001881 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001882 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001883 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001884 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001885
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001886 make
1887
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001888 msg "test: default with only CBC-legacy cipher use psa"
1889 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001890
1891 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1892 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001893}
1894
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001895component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001896 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1897
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001898 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001899 scripts/config.py unset MBEDTLS_GCM_C
1900 scripts/config.py unset MBEDTLS_CCM_C
1901 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001902 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1903 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1904 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1905 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1906 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001907 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001908 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001909 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001910 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001911
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001912 make
1913
1914 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
1915 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001916
1917 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
1918 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001919}
1920
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001921component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
1922 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001923
1924 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001925 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001926 scripts/config.py unset MBEDTLS_GCM_C
1927 scripts/config.py unset MBEDTLS_CCM_C
1928 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001929 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1930 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1931 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1932 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1933 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001934 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001935 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001936 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001937 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001938
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001939 make
1940
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001941 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001942 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001943
1944 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1945 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001946}
1947
Valerio Setti9f0ec532022-11-08 13:03:24 +01001948# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1949# that we could use for interop testing. However, we now have sort of two
1950# implementations ourselves: one using PSA, the other not. At least test that
1951# these two interoperate with each other.
1952component_test_tls1_2_ecjpake_compatibility() {
1953 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1954 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001955 # Explicitly make lib first to avoid a race condition:
1956 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1957 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001958 make -C programs ssl/ssl_server2 ssl/ssl_client2
1959 cp programs/ssl/ssl_server2 s2_no_use_psa
1960 cp programs/ssl/ssl_client2 c2_no_use_psa
1961
1962 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1963 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1964 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001965 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001966 make -C programs ssl/ssl_server2 ssl/ssl_client2
1967 make -C programs test/udp_proxy test/query_compile_time_config
1968
Valerio Setti70e02902022-12-02 16:21:56 +01001969 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1970 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1971 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1972 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1973 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1974 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1975 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1976 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 +01001977
1978 rm s2_no_use_psa c2_no_use_psa
1979}
1980
Gilles Peskine636c26a2020-03-04 20:46:15 +01001981component_test_everest () {
1982 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
1983 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1984 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1985 make
1986
1987 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1988 make test
1989
Gilles Peskine6848d172023-11-02 19:58:03 +01001990 msg "test: metatests (clang, ASan)"
1991 tests/scripts/run-metatests.sh any asan
1992
Gilles Peskine636c26a2020-03-04 20:46:15 +01001993 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
1994 tests/ssl-opt.sh -f ECDH
1995
1996 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1997 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001998 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001999}
2000
Gilles Peskined3beca92020-07-03 00:15:37 +02002001component_test_everest_curve25519_only () {
2002 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002003 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2004 scripts/config.py unset MBEDTLS_ECDSA_C
2005 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2006 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002007 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002008 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002009 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002010 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2011
Dave Rodgman17127e92023-12-14 16:42:48 +00002012 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002013
2014 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2015 make test
2016}
2017
Gilles Peskine8f073122018-11-27 15:58:47 +01002018component_test_small_ssl_out_content_len () {
2019 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002020 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2021 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002022 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002023 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002024
Gilles Peskine8f073122018-11-27 15:58:47 +01002025 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002026 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002027}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002028
Gilles Peskine8f073122018-11-27 15:58:47 +01002029component_test_small_ssl_in_content_len () {
2030 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002031 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2032 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002033 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002034 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002035
Gilles Peskine8f073122018-11-27 15:58:47 +01002036 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002037 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002038}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002039
Gilles Peskine8f073122018-11-27 15:58:47 +01002040component_test_small_ssl_dtls_max_buffering () {
2041 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002042 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002043 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002044 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002045
Gilles Peskine8f073122018-11-27 15:58:47 +01002046 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002047 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 +01002048}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002049
Gilles Peskine8f073122018-11-27 15:58:47 +01002050component_test_small_mbedtls_ssl_dtls_max_buffering () {
2051 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002052 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002053 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002054 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002055
Gilles Peskine8f073122018-11-27 15:58:47 +01002056 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002057 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002058}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002059
Gilles Peskine75cc7712019-09-06 19:47:17 +02002060component_test_psa_collect_statuses () {
2061 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002062 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002063 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002064 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002065 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002066 rm -f tests/statuses.log
2067}
2068
Gilles Peskine8f073122018-11-27 15:58:47 +01002069component_test_full_cmake_clang () {
2070 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002071 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002072 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 +01002073 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002074
k-stachowiak0291cb72019-06-26 15:52:12 +02002075 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002076 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002077
Gilles Peskineda6017c2022-10-30 21:02:40 +01002078 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2079 programs/test/cpp_dummy_build
2080
Gilles Peskine6848d172023-11-02 19:58:03 +01002081 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002082 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002083
Gilles Peskine82b27272019-06-14 18:27:03 +02002084 msg "program demos (full config, clang)" # ~10s
2085 tests/scripts/run_demos.py
2086
k-stachowiak0291cb72019-06-26 15:52:12 +02002087 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002088 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002089
Gilles Peskine8f073122018-11-27 15:58:47 +01002090 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002091 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002092
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002093 msg "test: compat.sh NULL (full config)" # ~ 2 min
Gilles Peskinee29203b2023-08-27 21:43:00 +02002094 tests/compat.sh -e '^$' -f 'NULL'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002095
Gilles Peskine8f073122018-11-27 15:58:47 +01002096 msg "test: compat.sh ARIA + ChachaPoly"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002097 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gilles Peskine8f073122018-11-27 15:58:47 +01002098}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002099
Gilles Peskine0c671602022-11-29 16:01:41 +01002100skip_suites_without_constant_flow () {
2101 # Skip the test suites that don't have any constant-flow annotations.
2102 # This will need to be adjusted if we ever start declaring things as
2103 # secret from macros or functions inside tests/include or tests/src.
2104 SKIP_TEST_SUITES=$(
2105 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2106 sed 's/test_suite_//; s/\.function$//' |
2107 tr '\n' ,)
2108 export SKIP_TEST_SUITES
2109}
2110
Dave Rodgman246210e2023-07-31 18:07:44 +01002111skip_all_except_given_suite () {
2112 # Skip all but the given test suite
2113 SKIP_TEST_SUITES=$(
2114 ls -1 tests/suites/test_suite_*.function |
2115 grep -v $1.function |
2116 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2117 tr '\n' ,)
2118 export SKIP_TEST_SUITES
2119}
2120
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002121component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002122 # This tests both (1) accesses to undefined memory, and (2) branches or
2123 # memory access depending on secret values. To distinguish between those:
2124 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2125 # - or alternatively, change the build type to MemSanDbg, which enables
2126 # origin tracking and nicer stack traces (which are useful for debugging
2127 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002128 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2129 scripts/config.py full
2130 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2131 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2132 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2133 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2134 make
2135
2136 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2137 make test
2138}
2139
2140component_test_memsan_constant_flow_psa () {
2141 # This tests both (1) accesses to undefined memory, and (2) branches or
2142 # memory access depending on secret values. To distinguish between those:
2143 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2144 # - or alternatively, change the build type to MemSanDbg, which enables
2145 # origin tracking and nicer stack traces (which are useful for debugging
2146 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002147 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002148 scripts/config.py full
2149 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2150 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2151 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2152 make
2153
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002154 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002155 make test
2156}
2157
Bence Szépkúti0354d042023-12-06 16:14:37 +01002158component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002159 # This tests both (1) everything that valgrind's memcheck usually checks
2160 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2161 # etc.) and (2) branches or memory access depending on secret values,
2162 # which will be reported as uninitialized memory. To distinguish between
2163 # secret and actually uninitialized:
2164 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2165 # - or alternatively, build with debug info and manually run the offending
2166 # test suite with valgrind --track-origins=yes, then check if the origin
2167 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002168 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2169 scripts/config.py full
2170 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2171 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002172 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002173 cmake -D CMAKE_BUILD_TYPE:String=Release .
2174 make
2175
2176 # this only shows a summary of the results (how many of each type)
2177 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002178 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002179 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002180
2181 # Test asm path in constant time module - by default, it will test the plain C
2182 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2183 msg "test: valgrind asm constant_time"
2184 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2185 skip_all_except_given_suite test_suite_constant_time
2186 cmake -D CMAKE_BUILD_TYPE:String=Release .
2187 make clean
2188 make
2189 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002190}
2191
Bence Szépkúti0354d042023-12-06 16:14:37 +01002192component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002193 # This tests both (1) everything that valgrind's memcheck usually checks
2194 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2195 # etc.) and (2) branches or memory access depending on secret values,
2196 # which will be reported as uninitialized memory. To distinguish between
2197 # secret and actually uninitialized:
2198 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2199 # - or alternatively, build with debug info and manually run the offending
2200 # test suite with valgrind --track-origins=yes, then check if the origin
2201 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002202 msg "build: cmake release GCC, full config with constant flow testing"
2203 scripts/config.py full
2204 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002205 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002206 cmake -D CMAKE_BUILD_TYPE:String=Release .
2207 make
2208
2209 # this only shows a summary of the results (how many of each type)
2210 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002211 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002212 make memcheck
2213}
2214
Janos Follath9338cac2023-10-04 18:55:39 +01002215component_test_tsan () {
2216 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002217 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002218 scripts/config.py set MBEDTLS_THREADING_C
2219 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002220 # Self-tests do not currently use multiple threads.
2221 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002222
2223 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2224 make
2225
2226 msg "test: main suites (TSan)"
2227 make test
2228}
2229
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002230component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002231 # Test that removing the deprecated features from the default
2232 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002233 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2234 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002235 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002236
2237 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2238 make test
2239}
2240
2241component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002242 msg "build: make, full_no_deprecated config" # ~ 30s
2243 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002244 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002245
Gilles Peskine30de2e82020-04-20 21:39:22 +02002246 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002247 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002248
2249 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2250 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002251}
2252
Gilles Peskine8386ea22020-04-30 09:07:29 +02002253component_test_full_no_deprecated_deprecated_warning () {
2254 # Test that there is nothing deprecated in "full_no_deprecated".
2255 # A deprecated feature would trigger a warning (made fatal) from
2256 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002257 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2258 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002259 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2260 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002261 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002262
Gilles Peskine30de2e82020-04-20 21:39:22 +02002263 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002264 make test
2265}
2266
Gilles Peskine8386ea22020-04-30 09:07:29 +02002267component_test_full_deprecated_warning () {
2268 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2269 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002270 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002271 scripts/config.py full
2272 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002273 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002274 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2275 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002276 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002277
Gilles Peskine8386ea22020-04-30 09:07:29 +02002278 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2279 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2280 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002281 # Expect warnings from '#warning' directives in check_config.h and
2282 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002283 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 +01002284
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002285 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2286 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002287
2288 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2289 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002290}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002291
Gilles Peskineec541fe2020-01-31 14:24:14 +01002292# Check that the specified libraries exist and are empty.
2293are_empty_libraries () {
2294 nm "$@" >/dev/null 2>/dev/null
2295 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2296}
2297
2298component_build_crypto_default () {
2299 msg "build: make, crypto only"
2300 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002301 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002302 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002303}
2304
2305component_build_crypto_full () {
2306 msg "build: make, crypto only, full config"
2307 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002308 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002309 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002310}
2311
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002312component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002313 msg "build: make, config for PSA crypto service"
2314 scripts/config.py crypto
2315 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2316 # Disable things that are not needed for just cryptography, to
2317 # reach a configuration that would be typical for a PSA cryptography
2318 # service providing all implemented PSA algorithms.
2319 # System stuff
2320 scripts/config.py unset MBEDTLS_ERROR_C
2321 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002322 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002323 # Crypto stuff with no PSA interface
2324 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002325 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002326 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002327 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002328 scripts/config.py unset MBEDTLS_NIST_KW_C
2329 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2330 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2331 scripts/config.py unset MBEDTLS_PKCS12_C
2332 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002333 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2334 # in PSA code to work with RSA keys. We don't require users to set those:
2335 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002336 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002337 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002338 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002339 make CFLAGS='-O1 -Werror' all test
2340 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2341}
2342
Gilles Peskineec541fe2020-01-31 14:24:14 +01002343component_build_crypto_baremetal () {
2344 msg "build: make, crypto only, baremetal config"
2345 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002346 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002347 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002348}
Daniel Axtens446af202020-09-02 21:30:13 +10002349support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002350 support_build_baremetal "$@"
2351}
2352
2353component_build_baremetal () {
2354 msg "build: make, baremetal config"
2355 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002356 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002357}
2358support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002359 # Older Glibc versions include time.h from other headers such as stdlib.h,
2360 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2361 # problem, Ubuntu 18.04 is ok.
2362 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2363}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002364
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002365# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002366component_test_depends_py_cipher_id () {
2367 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002368 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002369}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002370
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002371component_test_depends_py_cipher_chaining () {
2372 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002373 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002374}
2375
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002376component_test_depends_py_cipher_padding () {
2377 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002378 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002379}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002380
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002381component_test_depends_py_curves () {
2382 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002383 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002384}
2385
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002386component_test_depends_py_hashes () {
2387 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002388 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002389}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002390
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002391component_test_depends_py_kex () {
2392 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002393 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002394}
2395
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002396component_test_depends_py_pkalgs () {
2397 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002398 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002399}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002400
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002401# PSA equivalents of the depends.py tests
2402component_test_depends_py_cipher_id_psa () {
2403 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002404 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002405}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002406
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002407component_test_depends_py_cipher_chaining_psa () {
2408 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002409 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002410}
2411
2412component_test_depends_py_cipher_padding_psa () {
2413 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002414 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002415}
2416
2417component_test_depends_py_curves_psa () {
2418 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002419 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002420}
2421
2422component_test_depends_py_hashes_psa () {
2423 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002424 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002425}
2426
2427component_test_depends_py_kex_psa () {
2428 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002429 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002430}
2431
2432component_test_depends_py_pkalgs_psa () {
2433 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002434 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002435}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002436
Valerio Setti6bed64e2024-01-17 15:21:44 +01002437component_test_psa_crypto_config_ffdh_2048_only () {
2438 msg "build: full config - only DH 2048"
2439
2440 scripts/config.py full
2441
2442 # Disable all DH groups other than 2048.
2443 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2444 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2445 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2446 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2447
2448 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2449
2450 msg "test: full config - only DH 2048"
2451 make test
2452
2453 msg "ssl-opt: full config - only DH 2048"
2454 tests/ssl-opt.sh -f "ffdh"
2455}
2456
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002457component_build_no_pk_rsa_alt_support () {
2458 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2459
2460 scripts/config.py full
2461 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2462 scripts/config.py set MBEDTLS_RSA_C
2463 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2464
2465 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002466 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002467}
2468
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002469component_build_module_alt () {
2470 msg "build: MBEDTLS_XXX_ALT" # ~30s
2471 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002472
2473 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002474 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2475 scripts/config.py unset MBEDTLS_AESNI_C
2476 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002477 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002478 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2479 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002480 # You can only have one threading implementation: alt or pthread, not both.
2481 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002482 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2483 # directly and assumes the implementation works with partial groups.
2484 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002485 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2486 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2487 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002488 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2489 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2490 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002491
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002492 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2493 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2494 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002495 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002496
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002497 # We can only compile, not link, since we don't have any implementations
2498 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002499 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002500}
2501
2502component_build_dhm_alt () {
2503 msg "build: MBEDTLS_DHM_ALT" # ~30s
2504 scripts/config.py full
2505 scripts/config.py set MBEDTLS_DHM_ALT
2506 # debug.c currently references mbedtls_dhm_context fields directly.
2507 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002508 # We can only compile, not link, since we don't have any implementations
2509 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002510 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002511}
2512
Gilles Peskine64996c32024-01-23 20:25:47 +01002513component_test_no_psa_crypto_full_cmake_asan() {
2514 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2515 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002516 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002517 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002518 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002519 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002520 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002521 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002522 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002523 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002524 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002525 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002526 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002527 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002528
Gilles Peskine64996c32024-01-23 20:25:47 +01002529 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002530 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002531
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002532 # Note: ssl-opt.sh has some test cases that depend on
2533 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2534 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002535 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002536 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002537
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002538 msg "test: compat.sh default (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002539 tests/compat.sh
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002540
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002541 msg "test: compat.sh NULL (full minus PSA crypto)"
Gilles Peskinee29203b2023-08-27 21:43:00 +02002542 tests/compat.sh -f 'NULL'
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002543
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002544 msg "test: compat.sh ARIA + ChachaPoly (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002545 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002546}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002547
Ronald Cron403c15c2021-09-13 09:38:05 +02002548component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002549 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002550
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002551 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002552 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002553 $(helper_get_psa_key_type_list "ECC") \
2554 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002555
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002556 # Configure
2557 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002558
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002559 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002560 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard6d7db932022-12-28 09:48:01 +01002561 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002562
2563 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002564 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002565
2566 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002567 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2568 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2569
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002570 # Build
2571 # -----
2572
2573 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002574 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2575 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002576
2577 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2578
Valerio Setti3fe105b2023-10-30 11:08:12 +01002579 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002580
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002581 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002582 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002583
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002584 # Run the tests
2585 # -------------
2586
Ronald Cron403c15c2021-09-13 09:38:05 +02002587 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2588 make test
2589}
2590
Valerio Setti44b178c2023-03-22 14:02:57 +01002591component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002592 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002593
2594 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002595 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002596 $(helper_get_psa_key_type_list "ECC") \
2597 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002598
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002599 # Configure
2600 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002601
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002602 # Start from default config (no TLS 1.3, no USE_PSA)
2603 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002604
Valerio Setti44b178c2023-03-22 14:02:57 +01002605 # Disable the module that's accelerated
2606 scripts/config.py unset MBEDTLS_ECDH_C
2607
2608 # Disable things that depend on it
2609 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2610 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2611 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2612 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2613 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2614
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002615 # Build
2616 # -----
2617
2618 helper_libtestdriver1_make_drivers "$loc_accel_list"
2619
Valerio Setti3fe105b2023-10-30 11:08:12 +01002620 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002621
Valerio Setti44b178c2023-03-22 14:02:57 +01002622 # Make sure this was not re-enabled by accident (additive config)
2623 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002624
2625 # Run the tests
2626 # -------------
2627
Valerio Setti44b178c2023-03-22 14:02:57 +01002628 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002629 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002630}
2631
Przemek Stekieldccb2022023-05-11 10:48:50 +02002632component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002633 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002634
2635 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002636 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002637 $(helper_get_psa_key_type_list "DH") \
2638 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002639
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002640 # Configure
2641 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002642
Przemek Stekiel565353e2023-07-05 11:07:07 +02002643 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002644 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002645
2646 # Disable the module that's accelerated
2647 scripts/config.py unset MBEDTLS_DHM_C
2648
2649 # Disable things that depend on it
2650 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2651 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2652
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002653 # Build
2654 # -----
2655
2656 helper_libtestdriver1_make_drivers "$loc_accel_list"
2657
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002658 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002659
2660 # Make sure this was not re-enabled by accident (additive config)
2661 not grep mbedtls_dhm_ library/dhm.o
2662
2663 # Run the tests
2664 # -------------
2665
Gilles Peskine14302ed2023-07-19 19:30:04 +02002666 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002667 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002668
Gilles Peskine14302ed2023-07-19 19:30:04 +02002669 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002670 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002671}
2672
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002673component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002674 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002675
2676 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002677 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002678
2679 # Disable things that are not supported
2680 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2681 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002682 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002683
Gilles Peskine14302ed2023-07-19 19:30:04 +02002684 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002685 make test
2686
Gilles Peskine14302ed2023-07-19 19:30:04 +02002687 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002688 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002689}
2690
Valerio Setti44b178c2023-03-22 14:02:57 +01002691component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002692 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002693
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002694 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002695 $(helper_get_psa_key_type_list "ECC") \
2696 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002697
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002698 # Configure
2699 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002700
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002701 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002702
2703 # Make built-in fallback not available
2704 scripts/config.py unset MBEDTLS_ECJPAKE_C
2705 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2706
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002707 # Build
2708 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002709
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002710 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002711
Valerio Setti3fe105b2023-10-30 11:08:12 +01002712 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002713
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002714 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002715 not grep mbedtls_ecjpake_init library/ecjpake.o
2716
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002717 # Run the tests
2718 # -------------
2719
Gilles Peskine14302ed2023-07-19 19:30:04 +02002720 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002721 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002722}
2723
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002724component_test_psa_crypto_config_accel_ecc_some_key_types () {
2725 msg "build: full with accelerated EC algs and some key types"
2726
2727 # Algorithms and key types to accelerate
2728 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2729 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2730 ALG_ECDH \
2731 ALG_JPAKE \
2732 KEY_TYPE_ECC_PUBLIC_KEY \
2733 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2734 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002735 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2736 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002737
2738 # Configure
2739 # ---------
2740
2741 # start with config full for maximum coverage (also enables USE_PSA)
2742 helper_libtestdriver1_adjust_config "full"
2743
2744 # Disable modules that are accelerated - some will be re-enabled
2745 scripts/config.py unset MBEDTLS_ECDSA_C
2746 scripts/config.py unset MBEDTLS_ECDH_C
2747 scripts/config.py unset MBEDTLS_ECJPAKE_C
2748 scripts/config.py unset MBEDTLS_ECP_C
2749
2750 # Disable all curves - those that aren't accelerated should be re-enabled
2751 helper_disable_builtin_curves
2752
2753 # Restartable feature is not yet supported by PSA. Once it will in
2754 # the future, the following line could be removed (see issues
2755 # 6061, 6332 and following ones)
2756 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2757
2758 # this is not supported by the driver API yet
2759 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2760
2761 # Build
2762 # -----
2763
2764 # These hashes are needed for some ECDSA signature tests.
2765 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2766 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2767 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2768
Valerio Setti3fe105b2023-10-30 11:08:12 +01002769 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002770
2771 # ECP should be re-enabled but not the others
2772 not grep mbedtls_ecdh_ library/ecdh.o
2773 not grep mbedtls_ecdsa library/ecdsa.o
2774 not grep mbedtls_ecjpake library/ecjpake.o
2775 grep mbedtls_ecp library/ecp.o
2776
2777 # Run the tests
2778 # -------------
2779
2780 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002781 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002782}
2783
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002784# Run tests with only (non-)Weierstrass accelerated
2785# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002786# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2787# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002788common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002789 weierstrass=$1
2790 if [ $weierstrass -eq 1 ]; then
2791 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002792 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002793 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002794 fi
2795
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002796 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002797
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002798 # Note: Curves are handled in a special way by the libtestdriver machinery,
2799 # so we only want to include them in the accel list when building the main
2800 # libraries, hence the use of a separate variable.
2801 # Note: the following loop is a modified version of
2802 # helper_get_psa_curve_list that only keeps Weierstrass families.
2803 loc_weierstrass_list=""
2804 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002805 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2806 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002807 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002808 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002809 ;;
2810 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002811 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002812 ;;
2813 esac
2814 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002815 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002816 loc_curve_list=$loc_weierstrass_list
2817 else
2818 loc_curve_list=$loc_non_weierstrass_list
2819 fi
2820
Valerio Setti3fe105b2023-10-30 11:08:12 +01002821 # Algorithms and key types to accelerate
2822 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2823 ALG_ECDH \
2824 ALG_JPAKE \
2825 $(helper_get_psa_key_type_list "ECC") \
2826 $loc_curve_list"
2827
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002828 # Configure
2829 # ---------
2830
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002831 # Start with config crypto_full and remove PK_C:
2832 # that's what's supported now, see docs/driver-only-builds.md.
2833 helper_libtestdriver1_adjust_config "crypto_full"
2834 scripts/config.py unset MBEDTLS_PK_C
2835 scripts/config.py unset MBEDTLS_PK_PARSE_C
2836 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002837
2838 # Disable modules that are accelerated - some will be re-enabled
2839 scripts/config.py unset MBEDTLS_ECDSA_C
2840 scripts/config.py unset MBEDTLS_ECDH_C
2841 scripts/config.py unset MBEDTLS_ECJPAKE_C
2842 scripts/config.py unset MBEDTLS_ECP_C
2843
2844 # Disable all curves - those that aren't accelerated should be re-enabled
2845 helper_disable_builtin_curves
2846
2847 # Restartable feature is not yet supported by PSA. Once it will in
2848 # the future, the following line could be removed (see issues
2849 # 6061, 6332 and following ones)
2850 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2851
2852 # this is not supported by the driver API yet
2853 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2854
2855 # Build
2856 # -----
2857
2858 # These hashes are needed for some ECDSA signature tests.
2859 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2860 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2861 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2862
Valerio Settiac7a8092023-10-31 12:23:44 +01002863 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002864
2865 # We expect ECDH to be re-enabled for the missing curves
2866 grep mbedtls_ecdh_ library/ecdh.o
2867 # We expect ECP to be re-enabled, however the parts specific to the
2868 # families of curves that are accelerated should be ommited.
2869 # - functions with mxz in the name are specific to Montgomery curves
2870 # - ecp_muladd is specific to Weierstrass curves
2871 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002872 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002873 not grep mbedtls_ecp_muladd library/ecp.o
2874 grep mxz library/ecp.o
2875 else
2876 grep mbedtls_ecp_muladd library/ecp.o
2877 not grep mxz library/ecp.o
2878 fi
2879 # We expect ECDSA and ECJPAKE to be re-enabled only when
2880 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002881 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002882 not grep mbedtls_ecdsa library/ecdsa.o
2883 not grep mbedtls_ecjpake library/ecjpake.o
2884 else
2885 grep mbedtls_ecdsa library/ecdsa.o
2886 grep mbedtls_ecjpake library/ecjpake.o
2887 fi
2888
2889 # Run the tests
2890 # -------------
2891
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002892 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2893 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002894}
2895
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002896component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002897 common_test_psa_crypto_config_accel_ecc_some_curves 1
2898}
2899
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002900component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002901 common_test_psa_crypto_config_accel_ecc_some_curves 0
2902}
2903
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002904# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2905# ECDH, ECDSA) with and without drivers.
2906# The input parameter is a boolean value which indicates:
2907# - 0 keep built-in EC algs,
2908# - 1 exclude built-in EC algs (driver only).
2909#
2910# This is used by the two following components to ensure they always use the
2911# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002912# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2913# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002914# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002915config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002916 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002917 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002918 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002919 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002920 # Disable modules that are accelerated
2921 scripts/config.py unset MBEDTLS_ECDSA_C
2922 scripts/config.py unset MBEDTLS_ECDH_C
2923 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002924 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002925 fi
2926
2927 # Restartable feature is not yet supported by PSA. Once it will in
2928 # the future, the following line could be removed (see issues
2929 # 6061, 6332 and following ones)
2930 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002931}
2932
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002933# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2934component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002935 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002936
2937 # Algorithms and key types to accelerate
2938 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2939 ALG_ECDH \
2940 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002941 $(helper_get_psa_key_type_list "ECC") \
2942 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002943
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002944 # Configure
2945 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002946
2947 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002948 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002949
Valerio Setti0a342c92023-09-01 09:12:31 +02002950 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002951 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2952 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002953
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002954 # Build
2955 # -----
2956
2957 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002958 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2959 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002960 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2961
Valerio Setti3fe105b2023-10-30 11:08:12 +01002962 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002963
2964 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
2965 not grep mbedtls_ecdsa_ library/ecdsa.o
2966 not grep mbedtls_ecdh_ library/ecdh.o
2967 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02002968 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002969
2970 # Run the tests
2971 # -------------
2972
Gilles Peskine14302ed2023-07-19 19:30:04 +02002973 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002974 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01002975
Gilles Peskine14302ed2023-07-19 19:30:04 +02002976 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002977 tests/ssl-opt.sh
2978}
2979
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002980# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2981component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002982 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002983
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002984 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002985
Gilles Peskine21570cf2023-12-22 11:49:50 +01002986 make
Valerio Setti42d5f192023-03-20 13:54:41 +01002987
Gilles Peskine14302ed2023-07-19 19:30:04 +02002988 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002989 make test
2990
Gilles Peskine14302ed2023-07-19 19:30:04 +02002991 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002992 tests/ssl-opt.sh
2993}
2994
Valerio Settie618cb02023-04-12 14:59:16 +02002995# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002996# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2997# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002998# to ensure that both tests use the same underlying configuration when testing
2999# driver's coverage with analyze_outcomes.py.
3000#
3001# This functions accepts 1 boolean parameter as follows:
3002# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3003# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3004# - 0: include built-in implementation of EC algorithms.
3005#
3006# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3007# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003008config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003009 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003010 # start with full config for maximum coverage (also enables USE_PSA)
3011 helper_libtestdriver1_adjust_config "full"
3012
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003013 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003014 # Disable modules that are accelerated
3015 scripts/config.py unset MBEDTLS_ECDSA_C
3016 scripts/config.py unset MBEDTLS_ECDH_C
3017 scripts/config.py unset MBEDTLS_ECJPAKE_C
3018 # Disable ECP module (entirely)
3019 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003020 fi
3021
Valerio Settiaecd32c2023-06-14 10:42:31 +02003022 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3023 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003024 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003025 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003026
Valerio Settie618cb02023-04-12 14:59:16 +02003027 # Restartable feature is not yet supported by PSA. Once it will in
3028 # the future, the following line could be removed (see issues
3029 # 6061, 6332 and following ones)
3030 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003031}
3032
3033# Build and test a configuration where driver accelerates all EC algs while
3034# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3035# side.
3036#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003037# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3038component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003039 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003040
3041 # Algorithms and key types to accelerate
3042 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3043 ALG_ECDH \
3044 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003045 $(helper_get_psa_key_type_list "ECC") \
3046 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003047
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003048 # Configure
3049 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003050
Valerio Settie618cb02023-04-12 14:59:16 +02003051 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003052 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003053 # Disable all the builtin curves. All the required algs are accelerated.
3054 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003055
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003056 # Build
3057 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003058
3059 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003060 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3061 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3062 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003063
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003064 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003065
Valerio Setti3fe105b2023-10-30 11:08:12 +01003066 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003067
3068 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3069 not grep mbedtls_ecdsa_ library/ecdsa.o
3070 not grep mbedtls_ecdh_ library/ecdh.o
3071 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003072 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003073 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003074
3075 # Run the tests
3076 # -------------
3077
Gilles Peskine14302ed2023-07-19 19:30:04 +02003078 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003079 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003080
Gilles Peskine14302ed2023-07-19 19:30:04 +02003081 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003082 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003083}
3084
3085# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003086# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003087# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003088component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003089 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003090
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003091 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003092
Gilles Peskine21570cf2023-12-22 11:49:50 +01003093 make
Valerio Settie618cb02023-04-12 14:59:16 +02003094
Gilles Peskine14302ed2023-07-19 19:30:04 +02003095 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003096 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003097
Gilles Peskine14302ed2023-07-19 19:30:04 +02003098 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003099 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003100}
3101
Valerio Setti4e2f2442023-08-15 10:10:26 +02003102# This is a common configuration helper used directly from:
3103# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3104# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3105# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003106# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003107# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003108# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003109# - this is the reference component of the above
3110# - it still disables RSA and FFDH, but it uses builtin EC algs
3111# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3112# - accelerate all EC and FFDH algs, disable only RSA
3113# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3114# - this is the reference component of the above
3115# - it still disables RSA, but it uses builtin EC and FFDH algs
3116#
3117# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003118# $1: a boolean value which states if we are testing an accelerated scenario
3119# or not.
3120# $2: a string value which states which components are tested. Allowed values
3121# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003122config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003123 driver_only="$1"
3124 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003125 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003126 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003127
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003128 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003129 # Disable modules that are accelerated
3130 scripts/config.py unset MBEDTLS_ECDSA_C
3131 scripts/config.py unset MBEDTLS_ECDH_C
3132 scripts/config.py unset MBEDTLS_ECJPAKE_C
3133 # Disable ECP module (entirely)
3134 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003135 # Also disable bignum
3136 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003137 fi
3138
3139 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3140 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3141 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3142 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3143
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003144 # RSA support is intentionally disabled on this test because RSA_C depends
3145 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003146 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3147 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 +02003148 scripts/config.py unset MBEDTLS_RSA_C
3149 scripts/config.py unset MBEDTLS_PKCS1_V15
3150 scripts/config.py unset MBEDTLS_PKCS1_V21
3151 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3152 # Also disable key exchanges that depend on RSA
3153 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3154 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3155 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3156 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3157 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3158
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003159 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003160 # When testing ECC only, we disable FFDH support, both from builtin and
3161 # PSA sides, and also disable the key exchanges that depend on DHM.
3162 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3163 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 +01003164 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003165 scripts/config.py unset MBEDTLS_DHM_C
3166 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3167 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3168 else
3169 # When testing ECC and DH instead, we disable DHM and depending key
3170 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003171 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003172 scripts/config.py unset MBEDTLS_DHM_C
3173 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3174 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3175 fi
3176 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003177
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003178 # Restartable feature is not yet supported by PSA. Once it will in
3179 # the future, the following line could be removed (see issues
3180 # 6061, 6332 and following ones)
3181 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3182}
3183
Valerio Setti4e2f2442023-08-15 10:10:26 +02003184# Common helper used by:
3185# - component_test_psa_crypto_config_accel_ecc_no_bignum
3186# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003187#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003188# The goal is to build and test accelerating either:
3189# - ECC only or
3190# - both ECC and FFDH
3191#
3192# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003193# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3194# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003195common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003196 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003197
Valerio Setti5dfaca42023-09-05 08:48:51 +02003198 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003199 if [ "$test_target" = "ECC_DH" ]; then
3200 accel_text="ECC/FFDH"
3201 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003202 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003203 accel_text="ECC"
3204 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003205 fi
3206
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003207 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003208
3209 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003210 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3211 ALG_ECDH \
3212 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003213 $(helper_get_psa_key_type_list "ECC") \
3214 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003215 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003216 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003217 loc_accel_list="$loc_accel_list \
3218 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003219 $(helper_get_psa_key_type_list "DH") \
3220 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003221 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003222
3223 # Configure
3224 # ---------
3225
3226 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003227 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003228 # Disable all the builtin curves. All the required algs are accelerated.
3229 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003230
3231 # Build
3232 # -----
3233
3234 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003235 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3236 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3237 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003238
3239 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3240
Valerio Setti3fe105b2023-10-30 11:08:12 +01003241 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003242
3243 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3244 not grep mbedtls_ecdsa_ library/ecdsa.o
3245 not grep mbedtls_ecdh_ library/ecdh.o
3246 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003247 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003248 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003249 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003250 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003251 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003252
3253 # Run the tests
3254 # -------------
3255
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003256 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003257
Gilles Peskine21570cf2023-12-22 11:49:50 +01003258 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003259
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003260 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003261 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003262}
3263
Valerio Setti4e2f2442023-08-15 10:10:26 +02003264# Common helper used by:
3265# - component_test_psa_crypto_config_reference_ecc_no_bignum
3266# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3267#
3268# The goal is to build and test a reference scenario (i.e. with builtin
3269# components) compared to the ones used in
3270# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3271#
3272# It is meant to be used in conjunction with
3273# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3274# coverage analysis in "analyze_outcomes.py" script.
3275common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003276 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003277
Valerio Setti5dfaca42023-09-05 08:48:51 +02003278 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003279 if [ "$test_target" = "ECC_DH" ]; then
3280 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003281 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003282 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003283 fi
3284
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003285 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003286
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003287 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003288
Gilles Peskine21570cf2023-12-22 11:49:50 +01003289 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003290
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003291 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003292 make test
3293
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003294 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003295 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003296}
3297
Valerio Setti4e2f2442023-08-15 10:10:26 +02003298component_test_psa_crypto_config_accel_ecc_no_bignum () {
3299 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3300}
3301
3302component_test_psa_crypto_config_reference_ecc_no_bignum () {
3303 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3304}
3305
3306component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3307 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3308}
3309
3310component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3311 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3312}
3313
Valerio Settiac6d35f2023-08-04 12:49:11 +02003314# Helper for setting common configurations between:
3315# - component_test_tfm_config_p256m_driver_accel_ec()
3316# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003317common_tfm_config () {
3318 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003319 cp configs/config-tfm.h "$CONFIG_H"
3320 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3321 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003322
Yanray Wang73bb2312023-09-25 11:21:15 +08003323 # Other config adjustment to make the tests pass.
3324 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003325 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003326 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3327 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003328
Yanray Wang73bb2312023-09-25 11:21:15 +08003329 # Config adjustment for better test coverage in our environment.
3330 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003331 #
3332 # Enable filesystem I/O for the benefit of PK parse/write tests.
3333 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3334}
3335
Valerio Settiac6d35f2023-08-04 12:49:11 +02003336# Keep this in sync with component_test_tfm_config() as they are both meant
3337# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003338component_test_tfm_config_p256m_driver_accel_ec () {
3339 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3340
3341 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003342
Dave Rodgman897bb772023-11-15 16:34:20 +00003343 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003344 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003345
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003346 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3347 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003348 not grep mbedtls_ecdh_ library/ecdh.o
3349 not grep mbedtls_ecjpake_ library/ecjpake.o
3350 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3351 not grep mbedtls_ecp_ library/ecp.o
3352 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003353 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003354 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003355 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003356 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003357
Valerio Setti5e18b902023-12-04 12:07:30 +01003358 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3359 # files, so we want to ensure that it has not be re-enabled accidentally.
3360 not grep mbedtls_cipher library/cipher.o
3361
Valerio Settib7e95442023-03-21 11:52:33 +01003362 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003363 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003364 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003365}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003366
Valerio Settiac6d35f2023-08-04 12:49:11 +02003367# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3368# they are both meant to be used in analyze_outcomes.py for driver's coverage
3369# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003370component_test_tfm_config() {
3371 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003372
Dave Rodgman897bb772023-11-15 16:34:20 +00003373 # Disable P256M driver, which is on by default, so that analyze_outcomes
3374 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3375 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3376
Valerio Setti52ba0e32023-08-04 12:43:03 +02003377 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003378 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003379
Dave Rodgman897bb772023-11-15 16:34:20 +00003380 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003381 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003382
Valerio Setti5e18b902023-12-04 12:07:30 +01003383 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3384 # files, so we want to ensure that it has not be re-enabled accidentally.
3385 not grep mbedtls_cipher library/cipher.o
3386
Valerio Setti52ba0e32023-08-04 12:43:03 +02003387 msg "test: TF-M config"
3388 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003389}
3390
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003391# Common helper for component_full_without_ecdhe_ecdsa() and
3392# component_full_without_ecdhe_ecdsa_and_tls13() which:
3393# - starts from the "full" configuration minus the list of symbols passed in
3394# as 1st parameter
3395# - build
3396# - test only TLS (i.e. test_suite_tls and ssl-opt)
3397build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003398 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003399
3400 msg "build: full minus something, test TLS"
3401
3402 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003403 for sym in $symbols_to_disable; do
3404 echo "Disabling $sym"
3405 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003406 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003407
Gilles Peskine21570cf2023-12-22 11:49:50 +01003408 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003409
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003410 msg "test: full minus something, test TLS"
3411 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003412
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003413 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003414 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003415}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003416
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003417component_full_without_ecdhe_ecdsa () {
3418 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003419}
3420
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003421component_full_without_ecdhe_ecdsa_and_tls13 () {
3422 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3423 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003424}
3425
Valerio Setti249b18a2023-06-20 12:08:30 +02003426# This is an helper used by:
3427# - component_test_psa_ecc_key_pair_no_derive
3428# - component_test_psa_ecc_key_pair_no_generate
3429# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3430# enabled, but one. Input arguments are as follows:
3431# - $1 is the key type under test, i.e. ECC/RSA/DH
3432# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003433build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003434 key_type=$1
3435 unset_option=$2
3436 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003437
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003438 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003439 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003440 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3441 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3442
3443 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3444 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003445 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003446
Gilles Peskine21570cf2023-12-22 11:49:50 +01003447 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003448
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003449 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003450 make test
3451}
3452
3453component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003454 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003455}
3456
3457component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003458 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003459}
3460
Pengyu Lve705f572023-12-06 16:38:15 +08003461config_psa_crypto_accel_rsa () {
3462 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003463
Pengyu Lve705f572023-12-06 16:38:15 +08003464 # Start from crypto_full config (no X.509, no TLS)
3465 helper_libtestdriver1_adjust_config "crypto_full"
3466
3467 if [ "$driver_only" -eq 1 ]; then
3468 # Remove RSA support and its dependencies
3469 scripts/config.py unset MBEDTLS_RSA_C
3470 scripts/config.py unset MBEDTLS_PKCS1_V15
3471 scripts/config.py unset MBEDTLS_PKCS1_V21
3472
3473 # We need PEM parsing in the test library as well to support the import
3474 # of PEM encoded RSA keys.
3475 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3476 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3477 fi
3478}
3479
3480component_test_psa_crypto_config_accel_rsa_crypto () {
3481 msg "build: crypto_full with accelerated RSA"
3482
3483 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3484 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3485 KEY_TYPE_RSA_PUBLIC_KEY \
3486 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3487 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3488 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3489 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003490
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003491 # Configure
3492 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003493
Pengyu Lve705f572023-12-06 16:38:15 +08003494 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003495
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003496 # Build
3497 # -----
3498
Pengyu Lve705f572023-12-06 16:38:15 +08003499 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003500 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 +08003501 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003502 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003503
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003504 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003505
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003506 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003507 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003508
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003509 # Run the tests
3510 # -------------
3511
Pengyu Lve705f572023-12-06 16:38:15 +08003512 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003513 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003514}
3515
3516component_test_psa_crypto_config_reference_rsa_crypto () {
3517 msg "build: crypto_full with non-accelerated RSA"
3518
3519 # Configure
3520 # ---------
3521 config_psa_crypto_accel_rsa 0
3522
3523 # Build
3524 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003525 make
Pengyu Lve705f572023-12-06 16:38:15 +08003526
3527 # Run the tests
3528 # -------------
3529 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003530 make test
3531}
3532
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003533# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003534# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003535component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003536 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003537
Valerio Setti4590bc22023-06-13 15:39:23 +02003538 # Create a temporary output file unless there is already one set
3539 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3540 REMOVE_OUTCOME_ON_EXIT="no"
3541 else
3542 REMOVE_OUTCOME_ON_EXIT="yes"
3543 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3544 export MBEDTLS_TEST_OUTCOME_FILE
3545 fi
3546
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003547 # Start from crypto configuration
3548 scripts/config.py crypto
3549
3550 # Remove RSA support and its dependencies
3551 scripts/config.py unset MBEDTLS_PKCS1_V15
3552 scripts/config.py unset MBEDTLS_PKCS1_V21
3553 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3554 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3555 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3556 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3557 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3558 scripts/config.py unset MBEDTLS_RSA_C
3559 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3560
3561 # Enable PSA support
3562 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3563
Valerio Setti01cc88a2023-06-15 11:53:08 +02003564 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003565 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003566 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3567 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3568 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003569
3570 make
3571
Valerio Setti01cc88a2023-06-15 11:53:08 +02003572 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003573 make test
3574
3575 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3576 # performing RSA signature.
3577 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3578 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3579
3580 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3581 rm $MBEDTLS_TEST_OUTCOME_FILE
3582 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003583}
3584
Ronald Cronb2312452021-05-08 14:32:59 +02003585component_test_psa_crypto_config_accel_hash () {
3586 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3587
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003588 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3589 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3590 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003591
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003592 # Configure
3593 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003594
3595 # Start from default config (no TLS 1.3, no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003596 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003597
3598 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003599 scripts/config.py unset MBEDTLS_MD5_C
3600 scripts/config.py unset MBEDTLS_RIPEMD160_C
3601 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003602 scripts/config.py unset MBEDTLS_SHA224_C
3603 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003604 scripts/config.py unset MBEDTLS_SHA384_C
3605 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003606 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003607
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003608 # Build
3609 # -----
3610
3611 helper_libtestdriver1_make_drivers "$loc_accel_list"
3612
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003613 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003614
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003615 # There's a risk of something getting re-enabled via config_psa.h;
3616 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3617 not grep mbedtls_md5 library/md5.o
3618 not grep mbedtls_sha1 library/sha1.o
3619 not grep mbedtls_sha256 library/sha256.o
3620 not grep mbedtls_sha512 library/sha512.o
3621 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003622
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003623 # Run the tests
3624 # -------------
3625
Ronald Cronb2312452021-05-08 14:32:59 +02003626 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3627 make test
3628}
3629
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003630component_test_psa_crypto_config_accel_hash_keep_builtins () {
3631 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3632 # This component ensures that all the test cases for
3633 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3634
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003635 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3636 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3637 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003638
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003639 # Start from default config (no TLS 1.3, no USE_PSA)
3640 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003641
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003642 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003643
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003644 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003645
3646 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3647 make test
3648}
3649
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003650# Auxiliary function to build config for hashes with and without drivers
3651config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003652 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003653 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003654 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003655 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003656 # disable the built-in implementation of hashes
3657 scripts/config.py unset MBEDTLS_MD5_C
3658 scripts/config.py unset MBEDTLS_RIPEMD160_C
3659 scripts/config.py unset MBEDTLS_SHA1_C
3660 scripts/config.py unset MBEDTLS_SHA224_C
3661 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003662 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003663 scripts/config.py unset MBEDTLS_SHA384_C
3664 scripts/config.py unset MBEDTLS_SHA512_C
3665 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003666 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003667 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003668}
3669
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003670# Note that component_test_psa_crypto_config_reference_hash_use_psa
3671# is related to this component and both components need to be kept in sync.
3672# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003673component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003674 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003675
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003676 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3677 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3678 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003679
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003680 # Configure
3681 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003682
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003683 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003684
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003685 # Build
3686 # -----
3687
3688 helper_libtestdriver1_make_drivers "$loc_accel_list"
3689
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003690 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003691
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003692 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003693 # 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 +02003694 not grep mbedtls_md5 library/md5.o
3695 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003696 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003697 not grep mbedtls_sha512 library/sha512.o
3698 not grep mbedtls_ripemd160 library/ripemd160.o
3699
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003700 # Run the tests
3701 # -------------
3702
Gilles Peskine14302ed2023-07-19 19:30:04 +02003703 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003704 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003705
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003706 # This is mostly useful so that we can later compare outcome files with
3707 # the reference config in analyze_outcomes.py, to check that the
3708 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003709 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003710 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003711
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003712 # This is to make sure all ciphersuites are exercised, but we don't need
3713 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003714 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003715 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003716}
3717
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003718# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3719# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3720# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3721# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003722component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003723 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003724
3725 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003726
Gilles Peskine21570cf2023-12-22 11:49:50 +01003727 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003728
Gilles Peskine14302ed2023-07-19 19:30:04 +02003729 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003730 make test
3731
Gilles Peskine14302ed2023-07-19 19:30:04 +02003732 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003733 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003734}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003735
Valerio Setti8eb310c2024-01-22 16:22:57 +01003736# Auxiliary function to build config for hashes with and without drivers
3737config_psa_crypto_hmac_use_psa () {
3738 driver_only="$1"
3739 # start with config full for maximum coverage (also enables USE_PSA)
3740 helper_libtestdriver1_adjust_config "full"
3741
Valerio Setticd89b0b2024-01-24 14:24:55 +01003742 if [ "$driver_only" -eq 1 ]; then
3743 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3744 # is still enabled though (for ENTROPY_C among others).
3745 scripts/config.py unset MBEDTLS_MD_C
3746 # Disable also the builtin hashes since they are supported by the driver
3747 # and MD module is able to perform PSA dispathing.
3748 scripts/config.py unset-all MBEDTLS_SHA
3749 scripts/config.py unset MBEDTLS_MD5_C
3750 scripts/config.py unset MBEDTLS_RIPEMD160_C
3751 fi
3752
Valerio Setti8eb310c2024-01-22 16:22:57 +01003753 # Direct dependencies of MD_C. We disable them also in the reference
3754 # component to work with the same set of features.
3755 scripts/config.py unset MBEDTLS_PKCS7_C
3756 scripts/config.py unset MBEDTLS_PKCS5_C
3757 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3758 scripts/config.py unset MBEDTLS_HKDF_C
3759 # Dependencies of HMAC_DRBG
3760 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3761 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3762}
3763
3764component_test_psa_crypto_config_accel_hmac() {
3765 msg "test: full with accelerated hmac"
3766
3767 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3768 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3769 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3770 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3771
3772 # Configure
3773 # ---------
3774
3775 config_psa_crypto_hmac_use_psa 1
3776
Valerio Setti8eb310c2024-01-22 16:22:57 +01003777 # Build
3778 # -----
3779
3780 helper_libtestdriver1_make_drivers "$loc_accel_list"
3781
3782 helper_libtestdriver1_make_main "$loc_accel_list"
3783
3784 # Ensure that built-in support for HMAC is disabled.
3785 not grep mbedtls_md_hmac library/md.o
3786
3787 # Run the tests
3788 # -------------
3789
3790 msg "test: full with accelerated hmac"
3791 make test
3792}
3793
3794component_test_psa_crypto_config_reference_hmac() {
3795 msg "test: full without accelerated hmac"
3796
3797 config_psa_crypto_hmac_use_psa 0
3798
3799 make
3800
3801 msg "test: full without accelerated hmac"
3802 make test
3803}
3804
Valerio Setti9da01a72023-12-18 17:38:18 +01003805component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003806 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003807
Valerio Setti9da01a72023-12-18 17:38:18 +01003808 # Albeit this components aims at accelerating DES which should only support
3809 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3810 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003811 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3812 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3813 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003814
Valerio Setti9da01a72023-12-18 17:38:18 +01003815 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3816 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3817 # of this component. This limitation will be addressed by #8598.
3818
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003819 # Configure
3820 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003821
Valerio Setti9a427302023-10-17 11:40:42 +02003822 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003823 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003824
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003825 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003826 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3827 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3828 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3829 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3830 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3831 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3832 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003833 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003834
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003835 # Build
3836 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003837
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003838 helper_libtestdriver1_make_drivers "$loc_accel_list"
3839
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003840 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003841
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003842 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003843 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003844
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003845 # Run the tests
3846 # -------------
3847
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003848 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003849 make test
3850}
3851
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003852component_test_psa_crypto_config_accel_aead () {
3853 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3854
Valerio Setti3f02bb72023-10-02 15:57:33 +02003855 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3856 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003857
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003858 # Configure
3859 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003860
Valerio Setti3f02bb72023-10-02 15:57:33 +02003861 # Start from full config
3862 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003863
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003864 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003865 scripts/config.py unset MBEDTLS_GCM_C
3866 scripts/config.py unset MBEDTLS_CCM_C
3867 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003868
Valerio Settia50b89e2023-11-08 15:58:47 +01003869 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3870 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003871
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003872 # Build
3873 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003874
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003875 helper_libtestdriver1_make_drivers "$loc_accel_list"
3876
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003877 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003878
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003879 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003880 not grep mbedtls_ccm library/ccm.o
3881 not grep mbedtls_gcm library/gcm.o
3882 not grep mbedtls_chachapoly library/chachapoly.o
3883
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003884 # Run the tests
3885 # -------------
3886
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003887 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3888 make test
3889}
3890
Valerio Settib680fc42023-10-13 09:29:37 +02003891# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003892# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3893# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3894common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003895 # Start from the full config
3896 helper_libtestdriver1_adjust_config "full"
3897
Valerio Settib680fc42023-10-13 09:29:37 +02003898 scripts/config.py unset MBEDTLS_NIST_KW_C
3899}
3900
Valerio Settib6b301f2023-10-04 12:05:05 +02003901# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003902# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3903# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003904# are meant to be used together in analyze_outcomes.py script in order to test
3905# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003906component_test_psa_crypto_config_accel_cipher_aead_cmac () {
3907 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003908
Valerio Settiad8b7f02023-10-25 12:39:50 +02003909 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 +01003910 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003911 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003912 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3913
3914 # Configure
3915 # ---------
3916
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003917 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003918
3919 # Disable the things that are being accelerated
3920 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3921 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3922 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3923 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3924 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3925 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3926 scripts/config.py unset MBEDTLS_GCM_C
3927 scripts/config.py unset MBEDTLS_CCM_C
3928 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003929 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003930 scripts/config.py unset MBEDTLS_DES_C
3931 scripts/config.py unset MBEDTLS_AES_C
3932 scripts/config.py unset MBEDTLS_ARIA_C
3933 scripts/config.py unset MBEDTLS_CHACHA20_C
3934 scripts/config.py unset MBEDTLS_CAMELLIA_C
3935
Valerio Settiec9b2582023-11-08 16:50:54 +01003936 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3937 # does not depend on it.
3938 scripts/config.py unset MBEDTLS_CIPHER_C
3939
Valerio Settib6b301f2023-10-04 12:05:05 +02003940 # Build
3941 # -----
3942
3943 helper_libtestdriver1_make_drivers "$loc_accel_list"
3944
3945 helper_libtestdriver1_make_main "$loc_accel_list"
3946
3947 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01003948 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02003949 not grep mbedtls_des library/des.o
3950 not grep mbedtls_aes library/aes.o
3951 not grep mbedtls_aria library/aria.o
3952 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003953 not grep mbedtls_ccm library/ccm.o
3954 not grep mbedtls_gcm library/gcm.o
3955 not grep mbedtls_chachapoly library/chachapoly.o
3956 not grep mbedtls_cmac library/cmac.o
3957
3958 # Run the tests
3959 # -------------
3960
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003961 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003962 make test
Valerio Settif9414552023-11-09 10:43:20 +01003963
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003964 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003965 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003966
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003967 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003968 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003969}
3970
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003971component_test_psa_crypto_config_reference_cipher_aead_cmac () {
3972 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
3973 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02003974
Gilles Peskine21570cf2023-12-22 11:49:50 +01003975 make
Valerio Settif9414552023-11-09 10:43:20 +01003976
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003977 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02003978 make test
Valerio Settif9414552023-11-09 10:43:20 +01003979
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003980 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01003981 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003982
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003983 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003984 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003985}
3986
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01003987common_block_cipher_dispatch() {
3988 TEST_WITH_DRIVER="$1"
3989
3990 # Start from the full config
3991 helper_libtestdriver1_adjust_config "full"
3992
3993 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
3994 # Disable key types that are accelerated (there is no legacy equivalent
3995 # symbol for ECB)
3996 scripts/config.py unset MBEDTLS_AES_C
3997 scripts/config.py unset MBEDTLS_ARIA_C
3998 scripts/config.py unset MBEDTLS_CAMELLIA_C
3999 fi
4000
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004001 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004002 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004003 # Keep this also in the reference component in order to skip the same tests
4004 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004005 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4006 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4007 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4008 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4009 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4010 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4011 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004012
4013 # Disable direct dependency on AES_C
4014 scripts/config.py unset MBEDTLS_NIST_KW_C
4015
4016 # Prevent the cipher module from using deprecated PSA path. The reason is
4017 # that otherwise there will be tests relying on "aes_info" (defined in
4018 # "cipher_wrap.c") whose functions are not available when AES_C is
4019 # not defined. ARIA and Camellia are not a problem in this case because
4020 # the PSA path is not tested for these key types.
4021 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4022}
4023
Valerio Settif8e6cba2023-12-12 11:53:39 +01004024component_test_full_block_cipher_psa_dispatch () {
4025 msg "build: full + PSA dispatch in block_cipher"
4026
4027 loc_accel_list="ALG_ECB_NO_PADDING \
4028 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4029
4030 # Configure
4031 # ---------
4032
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004033 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004034
Valerio Settif8e6cba2023-12-12 11:53:39 +01004035 # Build
4036 # -----
4037
4038 helper_libtestdriver1_make_drivers "$loc_accel_list"
4039
4040 helper_libtestdriver1_make_main "$loc_accel_list"
4041
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004042 # Make sure disabled components were not re-enabled by accident (additive
4043 # config)
4044 not grep mbedtls_aes_ library/aes.o
4045 not grep mbedtls_aria_ library/aria.o
4046 not grep mbedtls_camellia_ library/camellia.o
4047
Valerio Settif8e6cba2023-12-12 11:53:39 +01004048 # Run the tests
4049 # -------------
4050
4051 msg "test: full + PSA dispatch in block_cipher"
4052 make test
4053}
4054
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004055# This is the reference component of component_test_full_block_cipher_psa_dispatch
4056component_test_full_block_cipher_legacy_dispatch () {
4057 msg "build: full + legacy dispatch in block_cipher"
4058
4059 common_block_cipher_dispatch 0
4060
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004061 make
4062
4063 msg "test: full + legacy dispatch in block_cipher"
4064 make test
4065}
4066
Gilles Peskine36dea152023-07-20 22:19:45 +02004067component_test_aead_chachapoly_disabled() {
4068 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004069 scripts/config.py full
4070 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004071 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004072 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004073
Gilles Peskine36dea152023-07-20 22:19:45 +02004074 msg "test: full minus CHACHAPOLY"
4075 make test
4076}
4077
4078component_test_aead_only_ccm() {
4079 msg "build: full minus CHACHAPOLY and GCM"
4080 scripts/config.py full
4081 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4082 scripts/config.py unset MBEDTLS_GCM_C
4083 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4084 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004085 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004086
4087 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004088 make test
4089}
4090
Ronald Crone501d0e2023-07-10 08:31:19 +02004091component_test_ccm_aes_sha256() {
4092 msg "build: CCM + AES + SHA256 configuration"
4093
Ronald Cron7612d8c2023-07-20 10:03:54 +02004094 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004095 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004096
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004097 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004098
4099 msg "test: CCM + AES + SHA256 configuration"
4100 make test
4101}
4102
John Durkopd0321952020-10-29 21:37:36 -07004103# This should be renamed to test and updated once the accelerator ECDH code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004104component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004105 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07004106 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004107 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004108 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004109 scripts/config.py unset MBEDTLS_ECDH_C
4110 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
4111 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
4112 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
4113 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
4114 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
4115 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004116 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_ECDH -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004117}
4118
4119# This should be renamed to test and updated once the accelerator HMAC code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004120component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004121 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkopd0321952020-10-29 21:37:36 -07004122 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004123 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004124 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004125 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004126 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HMAC -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004127}
4128
4129# This should be renamed to test and updated once the accelerator HKDF code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004130component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004131 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkopd0321952020-10-29 21:37:36 -07004132 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004133 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004134 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004135 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01004136 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
4137 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07004138 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004139 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HKDF -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004140}
4141
John Durkop1b7ee052020-11-27 08:51:22 -08004142# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
4143component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004144 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004145 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004146 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004147 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004148 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4149 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4150 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4151 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4152 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4153 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4154 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004155 scripts/config.py unset MBEDTLS_LMS_C
4156 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004157 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004158 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_MD5 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004159}
4160
4161# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
4162component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004163 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004164 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004165 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004166 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004167 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4168 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4169 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4170 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4171 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4172 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4173 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004174 scripts/config.py unset MBEDTLS_LMS_C
4175 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004176 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004177 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RIPEMD160 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004178}
4179
4180# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
4181component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004182 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004183 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004184 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004185 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004186 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4187 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4188 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4189 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4190 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4191 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4192 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004193 scripts/config.py unset MBEDTLS_LMS_C
4194 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004195 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004196 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_1 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004197}
4198
4199# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
4200component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004201 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004202 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004203 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004204 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004205 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4206 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4207 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4208 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4209 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
4210 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08004211 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004212 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_224 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004213}
4214
4215# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
4216component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004217 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004218 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004219 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004220 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004221 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4222 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4223 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4224 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4225 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4226 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08004227 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004228 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_256 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004229}
4230
4231# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
4232component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004233 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004234 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004235 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004236 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004237 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4238 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4239 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4240 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4241 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4242 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004243 scripts/config.py unset MBEDTLS_LMS_C
4244 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004245 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004246 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_384 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004247}
4248
4249# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
4250component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004251 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004252 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004253 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004254 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004255 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4256 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4257 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4258 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4259 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4260 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4261 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004262 scripts/config.py unset MBEDTLS_LMS_C
4263 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004264 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004265 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_512 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004266}
4267
John Durkopd0321952020-10-29 21:37:36 -07004268# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004269component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004270 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_CRYPT + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopd0321952020-10-29 21:37:36 -07004271 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004272 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004273 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004274 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
4275 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4276 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4277 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07004278 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004279 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_CRYPT -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004280}
4281
4282# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004283component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004284 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_SIGN + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004285 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004286 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004287 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004288 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
4289 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4290 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4291 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004292 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004293 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_SIGN -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004294}
4295
4296# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004297component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004298 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_OAEP + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004299 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004300 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004301 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004302 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
4303 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4304 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4305 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004306 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004307 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_OAEP -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004308}
4309
4310# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004311component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004312 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PSS + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004313 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004314 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004315 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004316 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4317 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4318 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4319 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07004320 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004321 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PSS -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004322}
4323
4324# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004325component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004326 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_xxx + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004327 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004328 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004329 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004330 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4331 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
4332 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
4333 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
4334 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07004335 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004336 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_KEY_PAIR -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004337}
4338
4339# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004340component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004341 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004342 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004343 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004344 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004345 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4346 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07004347 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004348 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_PUBLIC_KEY -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004349}
4350
Dave Rodgmanc164c072023-06-28 09:43:23 +01004351
Dave Rodgman904c5892023-06-28 17:36:02 +01004352support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004353 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004354}
4355
Dave Rodgman904c5892023-06-28 17:36:02 +01004356component_build_tfm_armcc() {
4357 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004358 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004359
Dave Rodgman88651c42023-06-29 12:35:51 +01004360 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004361 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 +01004362}
4363
4364component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004365 # Check that the TF-M configuration can build cleanly with various
4366 # warning flags enabled. We don't build or run tests, since the
4367 # TF-M configuration needs a TF-M platform. A tweaked version of
4368 # the configuration that works on mainstream platforms is in
4369 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004370 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004371
Dave Rodgman88651c42023-06-29 12:35:51 +01004372 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004373 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 +01004374
Dave Rodgman904c5892023-06-28 17:36:02 +01004375 msg "build: TF-M config, gcc native build"
4376 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004377 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 +01004378}
4379
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004380# Test that the given .o file builds with all (valid) combinations of the given options.
4381#
4382# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4383#
4384# The validator function is the name of a function to validate the combination of options.
4385# It may be "" if all combinations are valid.
4386# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004387# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004388build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004389 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004390 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004391 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004392 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004393 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004394
Dave Rodgman42436102023-10-03 15:47:05 +01004395 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004396 for opt in "${options[@]}"; do
4397 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004398 done
4399
4400 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004401 cd $(dirname ${file})
4402 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004403
Dave Rodgman920343a2023-10-01 18:41:09 +01004404 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004405 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 +01004406
Dave Rodgman42436102023-10-03 15:47:05 +01004407 # Extract the command generated by the Makefile to build the target file.
4408 # This ensures that we have any include paths, macro definitions, etc
4409 # that may be applied by make.
4410 # 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 +01004411 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004412
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004413 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004414 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004415
Dave Rodgman28e38d82023-10-04 11:50:30 +01004416 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004417 source_file=${file%.o}.c
4418
4419 targets=0
4420 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004421
Dave Rodgman28e38d82023-10-04 11:50:30 +01004422 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004423 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004424 # each bit of $i is used to determine if options[i] will be set or not
4425 target="t"
4426 clang_args=""
4427 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004428 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004429 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004430 clang_args="${clang_args} ${opt}"
4431 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004432 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004433 done
4434
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004435 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004436 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004437 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004438 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004439
Dave Rodgman28e38d82023-10-04 11:50:30 +01004440 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004441 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004442 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004443 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004444
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004445 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004446
Dave Rodgman920343a2023-10-01 18:41:09 +01004447 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004448 make -s -f ${makefile} build_test_config_combos
4449 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004450
4451 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004452 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004453}
4454
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004455validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004456 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4457 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004458 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004459 fi
4460 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4461 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004462 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004463 fi
4464 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004465 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004466}
4467
4468component_build_aes_variations() {
4469 # 18s - around 90ms per clang invocation on M1 Pro
4470 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004471 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004472 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004473
Yanray Wangbc29aef2023-11-06 11:08:17 +08004474 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004475 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004476
Dave Rodgman42436102023-10-03 15:47:05 +01004477 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004478 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4479 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4480 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4481 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004482
4483 cd "$MBEDTLS_ROOT_DIR"
4484 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4485
Yanray Wang42be1ba2023-11-23 14:28:47 +08004486 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004487 # manually set or unset those configurations to check
4488 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004489 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4490 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4491 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4492 scripts/config.py unset MBEDTLS_DES_C
4493 scripts/config.py unset MBEDTLS_NIST_KW_C
4494 build_test_config_combos library/aes.o validate_aes_config_variations \
4495 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4496 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4497 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4498 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004499}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004500
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004501component_test_no_platform () {
4502 # Full configuration build, without platform support, file IO and net sockets.
4503 # This should catch missing mbedtls_printf definitions, and by disabling file
4504 # IO, it should catch missing '#include <stdio.h>'
4505 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004506 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004507 scripts/config.py unset MBEDTLS_PLATFORM_C
4508 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004509 scripts/config.py unset MBEDTLS_FS_IO
4510 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004511 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004512 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004513 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004514 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004515 # to re-enable platform integration features otherwise disabled in C99 builds
4516 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004517 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004518}
Gilles Peskine7c652162017-12-11 00:01:40 +01004519
4520component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004521 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004522 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4523 scripts/config.py full
4524 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004525 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4526 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4527 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4528 make
4529}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004530
Gilles Peskine8f073122018-11-27 15:58:47 +01004531component_build_no_ssl_srv () {
4532 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004533 scripts/config.py full
4534 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004535 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004536}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004537
Gilles Peskine8f073122018-11-27 15:58:47 +01004538component_build_no_ssl_cli () {
4539 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004540 scripts/config.py full
4541 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004542 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004543}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004544
Gilles Peskine8f073122018-11-27 15:58:47 +01004545component_build_no_sockets () {
4546 # Note, C99 compliance can also be tested with the sockets support disabled,
4547 # as that requires a POSIX platform (which isn't the same as C99).
4548 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004549 scripts/config.py full
4550 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4551 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4552 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4553}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004554
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004555component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004556 msg "build: default config with memory buffer allocator and backtrace enabled"
4557 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4558 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4559 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004560 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004561 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004562 make
4563
4564 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4565 make test
4566}
4567
4568component_test_memory_buffer_allocator () {
4569 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004570 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4571 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004572 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004573 make
4574
4575 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4576 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004577
4578 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4579 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004580 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004581}
4582
Gilles Peskine8f073122018-11-27 15:58:47 +01004583component_test_no_max_fragment_length () {
4584 # Run max fragment length tests with MFL disabled
4585 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004586 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004587 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004588 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004589
Gilles Peskine8f073122018-11-27 15:58:47 +01004590 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004591 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004592}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004593
Hanno Becker545ced42019-02-19 11:10:48 +00004594component_test_asan_remove_peer_certificate () {
4595 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004596 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Dave Rodgman17127e92023-12-14 16:42:48 +00004597 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004598 make
4599
4600 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4601 make test
4602
4603 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004604 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004605
4606 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004607 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004608
4609 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004610 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004611}
4612
Gilles Peskine8f073122018-11-27 15:58:47 +01004613component_test_no_max_fragment_length_small_ssl_out_content_len () {
4614 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004615 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4616 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4617 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004618 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004619 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004620
Gilles Peskine8f073122018-11-27 15:58:47 +01004621 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004622 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004623
4624 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004625 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004626}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004627
Darryl Greenaad82f92019-12-02 10:53:11 +00004628component_test_variable_ssl_in_out_buffer_len () {
4629 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4630 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004631 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004632 make
4633
4634 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4635 make test
4636
4637 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004638 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004639
4640 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004641 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004642}
4643
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004644component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004645 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004646 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004647
Dave Rodgman17127e92023-12-14 16:42:48 +00004648 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004649 make
4650
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004651 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004652 make test
4653
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004654 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004655 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004656
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004657 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004658 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004659}
4660
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004661component_test_ssl_alloc_buffer_and_mfl () {
4662 msg "build: default config with memory buffer allocator and MFL extension"
4663 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4664 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4665 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4666 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4667 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004668 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004669 make
4670
4671 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4672 make test
4673
4674 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 +02004675 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004676}
4677
Gilles Peskine636c26a2020-03-04 20:46:15 +01004678component_test_when_no_ciphersuites_have_mac () {
4679 msg "build: when no ciphersuites have MAC"
4680 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004681 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004682 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004683 make
4684
4685 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4686 make test
4687
4688 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004689 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004690}
4691
Raoul Strackxa4e86142020-06-15 17:03:13 +02004692component_test_no_date_time () {
4693 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4694 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004695 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004696 make
4697
4698 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4699 make test
4700}
4701
Gilles Peskine8f073122018-11-27 15:58:47 +01004702component_test_platform_calloc_macro () {
4703 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004704 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4705 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4706 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004707 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004708 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004709
Gilles Peskine8f073122018-11-27 15:58:47 +01004710 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4711 make test
4712}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004713
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004714component_test_malloc_0_null () {
4715 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004716 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004717 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 +02004718
4719 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4720 make test
4721
4722 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4723 # Just the calloc selftest. "make test" ran the others as part of the
4724 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004725 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004726
4727 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4728 # Run a subset of the tests. The choice is a balance between coverage
4729 # and time (including time indirectly wasted due to flaky tests).
4730 # The current choice is to skip tests whose description includes
4731 # "proxy", which is an approximation of skipping tests that use the
4732 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004733 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004734}
4735
Dave Rodgman6a08b682023-06-19 11:51:33 +01004736support_test_aesni() {
4737 # Check that gcc targets x86_64 (we can build AESNI), and check for
4738 # AESNI support on the host (we can run AESNI).
4739 #
4740 # The name of this function is possibly slightly misleading, but needs to align
4741 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004742 #
4743 # In principle 32-bit x86 can support AESNI, but our implementation does not
4744 # support 32-bit x86, so we check for x86-64.
4745 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004746 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4747 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004748 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004749}
4750
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004751component_test_aesni () { # ~ 60s
4752 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4753 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4754 #
4755 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4756 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4757 # exercise the plain C impl).
4758
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004759 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004760 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004761 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004762 scripts/config.py set MBEDTLS_HAVE_ASM
4763
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004764 # test the intrinsics implementation
4765 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004766 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004767 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004768 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004769 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004770
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004771 # test the asm implementation
4772 msg "AES tests, test assembly"
4773 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004774 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004775 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004776 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004777
4778 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004779 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004780 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004781 msg "AES tests, plain C"
4782 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004783 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004784 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004785 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004786 not grep -q "AES note: using AESNI" ./programs/test/selftest
4787 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004788
4789 # test the intrinsics implementation
4790 scripts/config.py set MBEDTLS_AESNI_C
4791 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4792 msg "AES tests, test AESNI only"
4793 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004794 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004795 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4796 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004797 grep -q "AES note: using AESNI" ./programs/test/selftest
4798 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004799}
4800
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004801component_test_sha3_variations() {
4802 msg "sha3 loop unroll variations"
4803
4804 # define minimal config sufficient to test SHA3
4805 cat > include/mbedtls/mbedtls_config.h << END
4806 #define MBEDTLS_SELF_TEST
4807 #define MBEDTLS_SHA3_C
4808END
4809
4810 msg "all loops unrolled"
4811 make clean
4812 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"
4813 ./tests/test_suite_shax
4814
4815 msg "all loops rolled up"
4816 make clean
4817 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"
4818 ./tests/test_suite_shax
4819}
4820
Jerry Yub6d39c22023-08-16 15:11:48 +08004821support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004822 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004823}
4824
4825component_test_aesni_m32 () { # ~ 60s
4826 # This tests are duplicated from component_test_aesni for i386 target
4827 #
4828 # AESNI intrinsic code supports i386 and assembly code does not support it.
4829
4830 msg "build: default config with different AES implementations"
4831 scripts/config.py set MBEDTLS_AESNI_C
4832 scripts/config.py set MBEDTLS_PADLOCK_C
4833 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4834 scripts/config.py set MBEDTLS_HAVE_ASM
4835
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004836 # test the intrinsics implementation with gcc
4837 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004838 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004839 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004840 # check that we built intrinsics - this should be used by default when supported by the compiler
4841 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4842 grep -q "AES note: using AESNI" ./programs/test/selftest
4843 grep -q "AES note: built-in implementation." ./programs/test/selftest
4844 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4845 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4846
4847 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004848 scripts/config.py unset MBEDTLS_PADLOCK_C
4849 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4850 msg "AES tests, test AESNI only"
4851 make clean
4852 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4853 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4854 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4855 grep -q "AES note: using AESNI" ./programs/test/selftest
4856 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4857 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4858 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4859}
4860
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004861support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004862 # clang >= 4 is required to build with target attributes
4863 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004864}
4865
4866component_test_aesni_m32_clang() {
4867
4868 scripts/config.py set MBEDTLS_AESNI_C
4869 scripts/config.py set MBEDTLS_PADLOCK_C
4870 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4871 scripts/config.py set MBEDTLS_HAVE_ASM
4872
4873 # test the intrinsics implementation with clang
4874 msg "AES tests, test intrinsics (clang)"
4875 make clean
4876 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4877 # check that we built intrinsics - this should be used by default when supported by the compiler
4878 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4879 grep -q "AES note: using AESNI" ./programs/test/selftest
4880 grep -q "AES note: built-in implementation." ./programs/test/selftest
4881 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4882 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4883}
4884
Jerry Yu193cbc02023-08-03 17:06:29 +08004885# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4886component_build_aes_aesce_armcc () {
4887 msg "Build: AESCE test on arm64 platform without plain C."
4888 scripts/config.py baremetal
4889
4890 # armc[56] don't support SHA-512 intrinsics
4891 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4892
4893 # Stop armclang warning about feature detection for A64_CRYPTO.
4894 # With this enabled, the library does build correctly under armclang,
4895 # but in baremetal builds (as tested here), feature detection is
4896 # unavailable, and the user is notified via a #warning. So enabling
4897 # this feature would prevent us from building with -Werror on
4898 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004899 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004900 scripts/config.py set MBEDTLS_HAVE_ASM
4901
4902 msg "AESCE, build with default configuration."
4903 scripts/config.py set MBEDTLS_AESCE_C
4904 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4905 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4906
4907 msg "AESCE, build AESCE only"
4908 scripts/config.py set MBEDTLS_AESCE_C
4909 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4910 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4911}
4912
Dave Rodgman0c584032023-10-08 12:26:54 +01004913support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004914 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004915 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004916}
4917
4918component_build_aes_armce () {
4919 # Test variations of AES with Armv8 crypto extensions
4920 scripts/config.py set MBEDTLS_AESCE_C
4921 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4922
4923 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004924 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004925
4926 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4927 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4928
4929 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4930 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4931
Dave Rodgman5e419372023-10-23 15:30:20 +01004932 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004933
Dave Rodgman5e419372023-10-23 15:30:20 +01004934 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4935 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004936
Dave Rodgman5e419372023-10-23 15:30:20 +01004937 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4938 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004939
Dave Rodgman5e419372023-10-23 15:30:20 +01004940 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4941 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004942
4943 # test for presence of AES instructions
4944 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4945 msg "clang, test A32 crypto instructions built"
4946 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4947 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4948 msg "clang, test T32 crypto instructions built"
4949 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4950 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4951 msg "clang, test aarch64 crypto instructions built"
4952 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4953 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4954
4955 # test for absence of AES instructions
4956 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4957 scripts/config.py unset MBEDTLS_AESCE_C
4958 msg "clang, test A32 crypto instructions not built"
4959 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4960 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4961 msg "clang, test T32 crypto instructions not built"
4962 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4963 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4964 msg "clang, test aarch64 crypto instructions not built"
4965 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4966 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004967}
4968
Dave Rodgman9ed18532023-10-05 00:06:47 +01004969support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004970 # clang >= 4 is required to build with SHA extensions
4971 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004972}
4973
Dave Rodgmand9e80832023-10-04 17:17:46 +01004974component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004975 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004976
4977
4978 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004979 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004980 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4981 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4982 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4983 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4984 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004985
Dave Rodgmand9e80832023-10-04 17:17:46 +01004986
Dave Rodgman94a634d2023-10-10 12:59:29 +01004987 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004988 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004989 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4990 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4991 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004992
Dave Rodgman5b89c552023-10-10 14:59:02 +01004993 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004994 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4995 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4996 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004997
Dave Rodgmancd654002023-10-05 09:40:07 +01004998
Dave Rodgman94a634d2023-10-10 12:59:29 +01004999 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01005000 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005001 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
5002 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
5003 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
5004 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
5005 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01005006
Dave Rodgmancd654002023-10-05 09:40:07 +01005007
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01005008 # examine the disassembly for presence of SHA instructions
5009 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
5010 scripts/config.py set ${opt}
5011 msg "${opt} clang, test A32 crypto instructions built"
5012 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5013 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5014
5015 msg "${opt} clang, test T32 crypto instructions built"
5016 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5017 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5018
5019 msg "${opt} clang, test aarch64 crypto instructions built"
5020 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5021 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
5022 scripts/config.py unset ${opt}
5023 done
5024
5025
5026 # examine the disassembly for absence of SHA instructions
5027 msg "clang, test A32 crypto instructions not built"
5028 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
5029 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5030
5031 msg "clang, test T32 crypto instructions not built"
5032 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
5033 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
5034
5035 msg "clang, test aarch64 crypto instructions not built"
5036 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
5037 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01005038}
5039
Jerry Yuc935aa62023-08-03 17:08:27 +08005040# For timebeing, no VIA Padlock platform available.
5041component_build_aes_via_padlock () {
5042
5043 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08005044 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08005045 scripts/config.py set MBEDTLS_PADLOCK_C
5046 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005047 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08005048 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08005049
5050}
5051
5052support_build_aes_via_padlock_only () {
5053 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
5054 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
5055 [ "`dpkg --print-foreign-architectures`" == "i386" ]
5056}
5057
Jerry Yu193cbc02023-08-03 17:06:29 +08005058support_build_aes_aesce_armcc () {
5059 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01005060}
5061
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005062component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005063 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01005064 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005065 scripts/config.py unset MBEDTLS_PADLOCK_C
5066
Dave Rodgmand8d64512023-12-19 12:20:21 +00005067 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01005068
5069 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
5070 make test
5071}
5072
5073component_test_no_ctr_drbg_aes_only_128_bit_keys () {
5074 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
5075 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01005076 scripts/config.py unset MBEDTLS_CTR_DRBG_C
5077 scripts/config.py unset MBEDTLS_PADLOCK_C
5078
Hanno Becker83ebf782017-07-07 12:29:15 +01005079 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01005080
5081 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005082 make test
5083}
Gilles Peskine8f073122018-11-27 15:58:47 +01005084
Hanno Becker83ebf782017-07-07 12:29:15 +01005085component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01005086 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5087 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
5088 scripts/config.py unset MBEDTLS_PADLOCK_C
5089 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02005090 scripts/config.py unset MBEDTLS_AESCE_C
5091
Dave Rodgmand8d64512023-12-19 12:20:21 +00005092 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005093
5094 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02005095 make test
5096
5097 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
5098 programs/test/selftest
5099}
5100
Matthias Schulz0767fda2024-02-07 10:46:28 +01005101component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005102 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
5103 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01005104 scripts/config.py unset MBEDTLS_PADLOCK_C
5105 scripts/config.py unset MBEDTLS_AESNI_C
5106 scripts/config.py unset MBEDTLS_AESCE_C
5107
5108 make CFLAGS='-O2 -Werror -Wall -Wextra'
5109
Matthias Schulza6ac0f12024-02-09 17:09:42 +01005110 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01005111 make test
5112}
5113
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02005114component_test_aes_fewer_tables () {
5115 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005116 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005117 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005118
Gilles Peskine7c652162017-12-11 00:01:40 +01005119 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005120 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005121}
5122
5123component_test_aes_rom_tables () {
5124 msg "build: default config with AES_ROM_TABLES enabled"
5125 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005126 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005127
5128 msg "test: AES_ROM_TABLES"
5129 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005130}
5131
Gilles Peskine14c3c062018-01-29 21:25:12 +01005132component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005133 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
5134 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
5135 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005136 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005137
Gilles Peskine8f073122018-11-27 15:58:47 +01005138 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
5139 make test
5140}
5141
Yanray Wang49cd4b52023-11-10 11:58:37 +08005142# helper for common_block_cipher_no_decrypt() which:
5143# - enable/disable the list of config options passed from -s/-u respectively.
5144# - build
5145# - test for tests_suite_xxx
5146# - selftest
5147#
5148# Usage: helper_block_cipher_no_decrypt_build_test
5149# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5150# Options: -s set_opts the list of config options to enable
5151# -u unset_opts the list of config options to disable
5152# -c cflags the list of options passed to CFLAGS
5153# -l ldflags the list of options passed to LDFLAGS
5154helper_block_cipher_no_decrypt_build_test () {
5155 while [ $# -gt 0 ]; do
5156 case "$1" in
5157 -s)
5158 shift; local set_opts="$1";;
5159 -u)
5160 shift; local unset_opts="$1";;
5161 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005162 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005163 -l)
5164 shift; local ldflags="$1";;
5165 esac
5166 shift
5167 done
5168 set_opts="${set_opts:-}"
5169 unset_opts="${unset_opts:-}"
5170 cflags="${cflags:-}"
5171 ldflags="${ldflags:-}"
5172
Yanray Wangb2d6e522023-11-13 16:57:47 +08005173 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5174 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005175
5176 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5177 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005178 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005179
5180 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5181 not grep mbedtls_aes_setkey_dec library/aes.o
5182 not grep mbedtls_aria_setkey_dec library/aria.o
5183 not grep mbedtls_camellia_setkey_dec library/camellia.o
5184 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5185 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005186 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5187 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005188
5189 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5190 make test
5191
5192 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5193 programs/test/selftest
5194}
5195
5196# This is a common configuration function used in:
5197# - component_test_block_cipher_no_decrypt_aesni_legacy()
5198# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5199# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5200# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5201# on x86.
5202common_block_cipher_no_decrypt () {
5203 # test AESNI intrinsics
5204 helper_block_cipher_no_decrypt_build_test \
5205 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005206 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005207
5208 # test AESNI assembly
5209 helper_block_cipher_no_decrypt_build_test \
5210 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005211 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005212
5213 # test AES C implementation
5214 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005215 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005216
5217 # test AESNI intrinsics for i386 target
5218 helper_block_cipher_no_decrypt_build_test \
5219 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005220 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005221 -l "-m32"
5222}
5223
Yanray Wang3ae11992023-11-13 17:32:09 +08005224# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5225# usage: 0: no PSA crypto configuration
5226# 1: use PSA crypto configuration
5227config_block_cipher_no_decrypt () {
5228 use_psa=$1
5229
Yanray Wang66111392023-10-31 18:54:54 +08005230 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005231 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5232 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005233 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005234 scripts/config.py unset MBEDTLS_NIST_KW_C
5235
Yanray Wang3ae11992023-11-13 17:32:09 +08005236 if [ "$use_psa" -eq 1 ]; then
5237 # Enable support for cryptographic mechanisms through the PSA API.
5238 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5239 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5240 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5241 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5242 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5243 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5244 fi
5245}
5246
5247component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005248 # This consistently causes an llvm crash on clang 3.8, so use gcc
5249 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005250 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005251 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005252}
5253
Yanray Wangf1496402023-11-01 18:55:13 +08005254component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005255 # This consistently causes an llvm crash on clang 3.8, so use gcc
5256 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005257 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005258 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005259}
5260
Yanray Wang66111392023-10-31 18:54:54 +08005261support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005262 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005263}
5264
Yanray Wang66111392023-10-31 18:54:54 +08005265component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005266 scripts/config.py baremetal
5267
5268 # armc[56] don't support SHA-512 intrinsics
5269 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5270
5271 # Stop armclang warning about feature detection for A64_CRYPTO.
5272 # With this enabled, the library does build correctly under armclang,
5273 # but in baremetal builds (as tested here), feature detection is
5274 # unavailable, and the user is notified via a #warning. So enabling
5275 # this feature would prevent us from building with -Werror on
5276 # armclang. Tracked in #7198.
5277 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5278 scripts/config.py set MBEDTLS_HAVE_ASM
5279
Yanray Wang3ae11992023-11-13 17:32:09 +08005280 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005281
5282 # test AESCE baremetal build
5283 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005284 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005285 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005286
Yanray Wangef1b04d2023-09-08 11:09:26 +08005287 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5288 not grep mbedtls_aes_setkey_dec library/aes.o
5289 not grep mbedtls_aria_setkey_dec library/aria.o
5290 not grep mbedtls_camellia_setkey_dec library/camellia.o
5291 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5292 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005293 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005294 not grep mbedtls_aesce_inverse_key library/aesce.o
5295 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005296}
5297
Gilles Peskine592f5912019-10-07 18:49:32 +02005298component_test_ctr_drbg_aes_256_sha_256 () {
5299 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5300 scripts/config.py full
5301 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5302 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005303 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005304 make
5305
5306 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5307 make test
5308}
5309
5310component_test_ctr_drbg_aes_128_sha_512 () {
5311 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005312 scripts/config.py full
5313 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5314 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005315 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005316 make
5317
5318 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5319 make test
5320}
5321
5322component_test_ctr_drbg_aes_128_sha_256 () {
5323 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005324 scripts/config.py full
5325 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5326 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5327 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005328 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005329 make
5330
5331 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5332 make test
5333}
5334
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005335component_test_se_default () {
5336 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005337 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005338 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005339
5340 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5341 make test
5342}
5343
Steven Cooremand57203d2020-07-16 20:28:59 +02005344component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005345 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005346 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005347 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005348 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5349 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005350 loc_cflags="${loc_cflags} -I../tests/include -O2"
5351
Gilles Peskine21570cf2023-12-22 11:49:50 +01005352 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005353
Gilles Peskine1997f302023-07-26 18:45:20 +02005354 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005355 make test
5356}
5357
Gilles Peskine8f073122018-11-27 15:58:47 +01005358component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005359 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005360 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005361 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005362 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005363}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005364
Gilles Peskinecf740502019-07-03 20:43:05 +02005365component_test_cmake_shared () {
5366 msg "build/test: cmake shared" # ~ 2min
5367 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5368 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005369 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005370 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005371 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005372}
5373
Gilles Peskineec10bf12019-09-20 19:56:06 +02005374test_build_opt () {
5375 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005376 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005377 for opt in "$@"; do
5378 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005379 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005380 # We're confident enough in compilers to not run _all_ the tests,
5381 # but at least run the unit tests. In particular, runs with
5382 # optimizations use inline assembly whereas runs with -O0
5383 # skip inline assembly.
5384 make test # ~30s
5385 make clean
5386 done
5387}
5388
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005389# For FreeBSD we invoke the function by name so this condition is added
5390# to disable the existing test_clang_opt function for linux.
5391if [[ $(uname) != "Linux" ]]; then
5392 component_test_clang_opt () {
5393 scripts/config.py full
5394 test_build_opt 'full config' clang -O0 -Os -O2
5395 }
5396fi
5397
5398component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005399 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005400 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005401}
5402support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005403 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005404}
5405
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005406component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005407 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005408 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005409}
5410support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005411 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005412}
5413
5414component_test_gcc_latest_opt () {
5415 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005416 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005417}
5418support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005419 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005420}
5421
5422component_test_gcc_earliest_opt () {
5423 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005424 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005425}
5426support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005427 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005428}
5429
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005430component_build_mbedtls_config_file () {
5431 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005432 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005433 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005434 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005435 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005436 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5437 make clean
5438
5439 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5440 # In the user config, disable one feature (for simplicity, pick a feature
5441 # that nothing else depends on).
5442 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005443 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005444 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5445
5446 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005447}
5448
Gilles Peskine7d904e72022-04-07 21:59:14 +02005449component_build_psa_config_file () {
5450 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5451 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5452 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5453 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5454 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005455 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005456 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5457 make clean
5458
5459 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
5460 # In the user config, disable one feature, which will reflect on the
5461 # mbedtls configuration so we can query it with query_compile_time_config.
5462 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
5463 scripts/config.py unset MBEDTLS_CMAC_C
5464 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5465 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5466
5467 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005468}
5469
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005470component_build_psa_alt_headers () {
5471 msg "build: make with PSA alt headers" # ~20s
5472
5473 # Generate alternative versions of the substitutable headers with the
5474 # same content except different include guards.
5475 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5476
5477 # Build the library and some programs.
5478 # Don't build the fuzzers to avoid having to go through hoops to set
5479 # a correct include path for programs/fuzz/Makefile.
5480 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
5481 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\"'"
5482
5483 # Check that we're getting the alternative include guards and not the
5484 # original include guards.
5485 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5486 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5487 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5488 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5489}
5490
Dave Rodgman852de3c2023-12-14 14:46:45 +00005491component_test_m32_no_asm () {
5492 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005493 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005494 #
5495 # Note that we require gcc, because clang Asan builds fail to link for
5496 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005497 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005498 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005499 scripts/config.py unset MBEDTLS_HAVE_ASM
5500 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005501 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005502 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005503
Dave Rodgman852de3c2023-12-14 14:46:45 +00005504 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005505 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005506}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005507support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005508 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005509 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005510 *) false;;
5511 esac
5512}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005513
Gilles Peskineff0aee02021-10-05 09:36:03 +02005514component_test_m32_o2 () {
5515 # Build with optimization, to use the i386 specific inline assembly
5516 # and go faster for tests.
5517 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005518 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005519 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005520 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005521
Gilles Peskineff0aee02021-10-05 09:36:03 +02005522 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005523 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005524
Gilles Peskineff0aee02021-10-05 09:36:03 +02005525 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005526 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005527}
Gilles Peskinecf522222021-10-07 19:25:29 +02005528support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005529 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005530}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005531
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005532component_test_m32_everest () {
5533 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005534 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005535 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005536 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005537
5538 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5539 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005540
5541 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005542 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005543
5544 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5545 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005546 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005547}
5548support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005549 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005550}
5551
Gilles Peskine8f073122018-11-27 15:58:47 +01005552component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005553 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005554 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005555 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005556
5557 msg "test: 64-bit ILP32, make, gcc"
5558 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005559}
Gilles Peskine878cf602019-01-06 20:50:38 +00005560support_test_mx32 () {
5561 case $(uname -m) in
5562 amd64|x86_64) true;;
5563 *) false;;
5564 esac
5565}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005566
Peter Kolbus60c6da22018-12-27 06:59:04 -06005567component_test_min_mpi_window_size () {
5568 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005569 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005570 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005571 make
5572
5573 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5574 make test
5575}
5576
Gilles Peskine8f073122018-11-27 15:58:47 +01005577component_test_have_int32 () {
5578 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005579 scripts/config.py unset MBEDTLS_HAVE_ASM
5580 scripts/config.py unset MBEDTLS_AESNI_C
5581 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005582 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005583 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005584
Gilles Peskine8f073122018-11-27 15:58:47 +01005585 msg "test: gcc, force 32-bit bignum limbs"
5586 make test
5587}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005588
Gilles Peskine8f073122018-11-27 15:58:47 +01005589component_test_have_int64 () {
5590 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005591 scripts/config.py unset MBEDTLS_HAVE_ASM
5592 scripts/config.py unset MBEDTLS_AESNI_C
5593 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005594 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005595 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005596
Gilles Peskine8f073122018-11-27 15:58:47 +01005597 msg "test: gcc, force 64-bit bignum limbs"
5598 make test
5599}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005600
Gabor Mezeie256cc12023-07-26 17:28:48 +02005601component_test_have_int32_cmake_new_bignum () {
5602 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5603 scripts/config.py unset MBEDTLS_HAVE_ASM
5604 scripts/config.py unset MBEDTLS_AESNI_C
5605 scripts/config.py unset MBEDTLS_PADLOCK_C
5606 scripts/config.py unset MBEDTLS_AESCE_C
5607 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005608 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005609 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005610
5611 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5612 make test
5613}
5614
Gilles Peskine8f073122018-11-27 15:58:47 +01005615component_test_no_udbl_division () {
5616 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005617 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005618 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005619 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005620
Gilles Peskine8f073122018-11-27 15:58:47 +01005621 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5622 make test
5623}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005624
Gilles Peskine8f073122018-11-27 15:58:47 +01005625component_test_no_64bit_multiplication () {
5626 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005627 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005628 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005629 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005630
Gilles Peskine8f073122018-11-27 15:58:47 +01005631 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5632 make test
5633}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005634
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005635component_test_no_strings () {
5636 msg "build: no strings" # ~10s
5637 scripts/config.py full
5638 # Disable options that activate a large amount of string constants.
5639 scripts/config.py unset MBEDTLS_DEBUG_C
5640 scripts/config.py unset MBEDTLS_ERROR_C
5641 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5642 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005643 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005644
5645 msg "test: no strings" # ~ 10s
5646 make test
5647}
5648
Hanno Beckerc5722d12020-10-09 11:10:42 +01005649component_test_no_x509_info () {
5650 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5651 scripts/config.pl full
5652 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5653 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005654 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005655
5656 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5657 make test
5658
5659 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005660 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005661}
5662
Gilles Peskine8f073122018-11-27 15:58:47 +01005663component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005664 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005665 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005666 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 +02005667
Gilles Peskinee36fe812021-09-01 20:00:33 +02005668 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005669 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005670}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005671
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005672component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005673 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005674 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005675 # Build for a target platform that's close to what Debian uses
5676 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005677 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005678 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005679 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005680 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'
5681
Gilles Peskinee36fe812021-09-01 20:00:33 +02005682 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005683 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005684}
5685support_build_arm_linux_gnueabi_gcc_arm5vte () {
5686 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5687}
5688
5689component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005690 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005691 scripts/config.py baremetal
5692 # This is an imperfect substitute for
5693 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005694 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005695 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 +02005696
Gilles Peskinee36fe812021-09-01 20:00:33 +02005697 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005698 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005699}
5700
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005701component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005702 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5703 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005704 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 +02005705
Gilles Peskinee36fe812021-09-01 20:00:33 +02005706 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005707 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005708 for lib in library/*.a; do
5709 echo "$lib:"
5710 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5711 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005712}
5713
Gilles Peskine8f073122018-11-27 15:58:47 +01005714component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005715 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005716 scripts/config.py baremetal
5717 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005718 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 +01005719 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005720 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005721}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005722
Gilles Peskine8f073122018-11-27 15:58:47 +01005723component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005724 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005725 scripts/config.py baremetal
5726 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005727 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 +01005728 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005729 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005730}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005731
Dave Rodgman8c315f22023-06-02 10:26:24 -04005732component_build_arm_clang_thumb () {
5733 # ~ 30s
5734
5735 scripts/config.py baremetal
5736
5737 msg "build: clang thumb 2, make"
5738 make clean
5739 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5740
5741 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5742 msg "build: clang thumb 1 -O0, make"
5743 make clean
5744 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5745
5746 msg "build: clang thumb 1 -Os, make"
5747 make clean
5748 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5749}
5750
Gilles Peskine8f073122018-11-27 15:58:47 +01005751component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005752 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005753 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005754 # armc[56] don't support SHA-512 intrinsics
5755 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005756
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005757 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5758 scripts/config.py unset MBEDTLS_AESCE_C
5759
Dave Rodgman0fddf822023-03-02 15:32:12 +00005760 # Stop armclang warning about feature detection for A64_CRYPTO.
5761 # With this enabled, the library does build correctly under armclang,
5762 # but in baremetal builds (as tested here), feature detection is
5763 # unavailable, and the user is notified via a #warning. So enabling
5764 # this feature would prevent us from building with -Werror on
5765 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005766 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005767
Hanno Beckerf0762e92022-07-15 12:08:19 +01005768 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005769
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005770 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005771
5772 msg "size: ARM Compiler 5"
5773 "$ARMC5_FROMELF" -z library/*.o
5774
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005775 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005776
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005777 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005778 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005779
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005780 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005781 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5782
5783 # ARM Compiler 6 - Target ARMv7-M+DSP
5784 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005785
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005786 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005787 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005788
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005789 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005790 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005791
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005792 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5793 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5794
Dave Rodgman99318e62023-05-24 12:27:42 +01005795 # ARM Compiler 6 - Target Cortex-M0
5796 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005797
5798 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5799 #
5800 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5801 # that we have in our CI
5802 scripts/config.py set MBEDTLS_AESCE_C
5803 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005804}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005805
Pengyu Lvdf070032023-02-24 16:03:31 +08005806support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005807 armc5_cc="$ARMC5_BIN_DIR/armcc"
5808 armc6_cc="$ARMC6_BIN_DIR/armclang"
5809 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005810}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005811
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005812component_test_tls13_only () {
5813 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3, without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005814 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005815 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005816 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5817
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005818 msg "test: TLS 1.3 only, all key exchange modes enabled"
5819 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005820
Ronald Cronc3f43b62022-10-17 17:35:32 +02005821 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5822 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005823}
5824
Ronald Cronc3f43b62022-10-17 17:35:32 +02005825component_test_tls13_only_psk () {
5826 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5827 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5828 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5829 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005830 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005831 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5832 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5833 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5834 scripts/config.py unset MBEDTLS_ECDSA_C
5835 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005836 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005837 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005838 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5839
Ronald Cronc3f43b62022-10-17 17:35:32 +02005840 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5841 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005842
Ronald Cronc3f43b62022-10-17 17:35:32 +02005843 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5844 tests/ssl-opt.sh
5845}
5846
5847component_test_tls13_only_ephemeral () {
5848 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5849 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5850 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005851 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005852 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5853
5854 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5855 cd tests; ./test_suite_ssl; cd ..
5856
5857 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5858 tests/ssl-opt.sh
5859}
5860
Przemek Stekiela01c2422023-06-13 10:46:48 +02005861component_test_tls13_only_ephemeral_ffdh () {
5862 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5863 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5864 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5865 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005866 scripts/config.py unset MBEDTLS_ECDH_C
5867
Przemek Stekiela01c2422023-06-13 10:46:48 +02005868 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5869
5870 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5871 cd tests; ./test_suite_ssl; cd ..
5872
5873 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5874 tests/ssl-opt.sh
5875}
5876
Ronald Cronc3f43b62022-10-17 17:35:32 +02005877component_test_tls13_only_psk_ephemeral () {
5878 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5879 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5880 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5881 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5882 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5883 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5884 scripts/config.py unset MBEDTLS_ECDSA_C
5885 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005886 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005887 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005888 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5889
5890 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5891 cd tests; ./test_suite_ssl; cd ..
5892
5893 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5894 tests/ssl-opt.sh
5895}
5896
Przemek Stekiela01c2422023-06-13 10:46:48 +02005897component_test_tls13_only_psk_ephemeral_ffdh () {
5898 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5899 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5900 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5901 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5902 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5903 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5904 scripts/config.py unset MBEDTLS_ECDSA_C
5905 scripts/config.py unset MBEDTLS_PKCS1_V21
5906 scripts/config.py unset MBEDTLS_PKCS7_C
5907 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005908 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005909 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5910
5911 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5912 cd tests; ./test_suite_ssl; cd ..
5913
5914 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5915 tests/ssl-opt.sh
5916}
5917
Ronald Cronc3f43b62022-10-17 17:35:32 +02005918component_test_tls13_only_psk_all () {
5919 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5920 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5921 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5922 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5923 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5924 scripts/config.py unset MBEDTLS_ECDSA_C
5925 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005926 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005927 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005928 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5929
5930 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5931 cd tests; ./test_suite_ssl; cd ..
5932
5933 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5934 tests/ssl-opt.sh
5935}
5936
5937component_test_tls13_only_ephemeral_all () {
5938 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5939 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005940 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005941 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5942
5943 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5944 cd tests; ./test_suite_ssl; cd ..
5945
5946 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5947 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005948}
5949
Ronald Cron6f135e12021-12-08 16:57:54 +01005950component_test_tls13 () {
5951 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5952 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005953 scripts/config.py set MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5954 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005955 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005956 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005957 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005958 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005959 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005960 msg "ssl-opt.sh (TLS 1.3)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005961 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005962}
5963
Ronald Cron6f135e12021-12-08 16:57:54 +01005964component_test_tls13_no_compatibility_mode () {
5965 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5966 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005967 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5968 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005969 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005970 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005971 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005972 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005973 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005974 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005975 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005976}
5977
Gilles Peskine8f073122018-11-27 15:58:47 +01005978component_build_mingw () {
5979 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005980 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 +00005981
Gilles Peskine8f073122018-11-27 15:58:47 +01005982 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005983 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 +01005984 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005985
Gilles Peskine8f073122018-11-27 15:58:47 +01005986 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005987 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
5988 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 +01005989 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005990
Pengyu Lv158eead2023-10-19 11:27:05 +08005991 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005992 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005993 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 +01005994 make WINDOWS_BUILD=1 clean
5995}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005996support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005997 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5998 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005999 *) true;;
6000 esac
6001}
Simon Butcher91aef332016-11-17 09:20:50 +00006002
Gilles Peskine8f073122018-11-27 15:58:47 +01006003component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006004 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02006005 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006006 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
6007 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02006008
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006009 msg "test: main suites (MSan)" # ~ 10s
6010 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006011
Gilles Peskine6848d172023-11-02 19:58:03 +01006012 msg "test: metatests (MSan)"
6013 tests/scripts/run-metatests.sh any msan
6014
Gilles Peskine82b27272019-06-14 18:27:03 +02006015 msg "program demos (MSan)" # ~20s
6016 tests/scripts/run_demos.py
6017
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006018 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006019 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006020
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006021 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01006022
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006023 if [ "$MEMORY" -gt 0 ]; then
6024 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006025 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006026 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006027}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006028
Bence Szépkúti0354d042023-12-06 16:14:37 +01006029component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006030 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006031 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006032 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6033 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006034
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006035 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006036 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006037
Gilles Peskine636c26a2020-03-04 20:46:15 +01006038 # Optional parts (slow; currently broken on OS X because programs don't
6039 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006040 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006041 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006042 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006043 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006044 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006045
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006046 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006047 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006048 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01006049 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006050
6051 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006052 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006053 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02006054 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01006055}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006056
Bence Szépkúti0354d042023-12-06 16:14:37 +01006057component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01006058 msg "build: Release, full (clang)"
6059 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
6060 scripts/config.py full
6061 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
6062 make
6063
6064 msg "test: main suites, Valgrind (full config)"
6065 make memcheck
6066}
6067
Paul Elliott62dc3922021-11-25 17:29:40 +00006068support_test_cmake_out_of_source () {
6069 distrib_id=""
6070 distrib_ver=""
6071 distrib_ver_minor=""
6072 distrib_ver_major=""
6073
6074 # Attempt to parse lsb-release to find out distribution and version. If not
6075 # found this should fail safe (test is supported).
6076 if [[ -f /etc/lsb-release ]]; then
6077
6078 while read -r lsb_line; do
6079 case "$lsb_line" in
6080 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
6081 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
6082 esac
6083 done < /etc/lsb-release
6084
6085 distrib_ver_major="${distrib_ver%%.*}"
6086 distrib_ver="${distrib_ver#*.}"
6087 distrib_ver_minor="${distrib_ver%%.*}"
6088 fi
6089
6090 # Running the out of source CMake test on Ubuntu 16.04 using more than one
6091 # processor (as the CI does) can create a race condition whereby the build
6092 # fails to see a generated file, despite that file actually having been
6093 # generated. This problem appears to go away with 18.04 or newer, so make
6094 # the out of source tests unsupported on Ubuntu 16.04.
6095 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
6096}
6097
Gilles Peskine8f073122018-11-27 15:58:47 +01006098component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01006099 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01006100 # generates
6101 make neat
6102
Gilles Peskine8f073122018-11-27 15:58:47 +01006103 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01006104 MBEDTLS_ROOT_DIR="$PWD"
6105 mkdir "$OUT_OF_SOURCE_DIR"
6106 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01006107 # Note: Explicitly generate files as these are turned off in releases
6108 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006109 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006110
Gilles Peskine8f073122018-11-27 15:58:47 +01006111 msg "test: cmake 'out-of-source' build"
6112 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006113 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01006114 # Also ensure that there are no error messages such as
6115 # "No such file or directory", which would indicate that some required
6116 # file is missing (ssl-opt.sh tolerates the absence of some files so
6117 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006118 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006119 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006120 cat ssl-opt.err >&2
6121 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006122 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006123 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006124 cd "$MBEDTLS_ROOT_DIR"
6125 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006126}
Andres AGdc192212016-08-31 17:33:13 +01006127
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006128component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006129 # Remove existing generated files so that we use the ones CMake
6130 # generates
6131 make neat
6132
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006133 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006134 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006135 # Note: Explicitly generate files as these are turned off in releases
6136 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006137 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006138 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006139}
Gilles Peskinea3000992022-02-04 00:21:12 +01006140support_test_cmake_as_subdirectory () {
6141 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006142}
6143
Chris Kayd259e342021-03-25 16:03:25 +00006144component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006145 # Remove existing generated files so that we use the ones CMake
6146 # generates
6147 make neat
6148
Chris Kayd259e342021-03-25 16:03:25 +00006149 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006150 cd programs/test/cmake_package
6151 cmake .
6152 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006153 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006154}
Gilles Peskinea3000992022-02-04 00:21:12 +01006155support_test_cmake_as_package () {
6156 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006157}
6158
6159component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006160 # Remove existing generated files so that we use the ones CMake
6161 # generates
6162 make neat
6163
Chris Kayd259e342021-03-25 16:03:25 +00006164 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006165 cd programs/test/cmake_package_install
6166 cmake .
6167 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006168 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006169}
Gilles Peskinea3000992022-02-04 00:21:12 +01006170support_test_cmake_as_package_install () {
6171 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006172}
6173
David Horstmann20550e32023-01-12 14:17:01 +00006174component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006175 # Make a copy of config file to use for the in-tree test
6176 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006177
6178 MBEDTLS_ROOT_DIR="$PWD"
6179 mkdir "$OUT_OF_SOURCE_DIR"
6180 cd "$OUT_OF_SOURCE_DIR"
6181
David Horstmann969c1452023-01-31 10:34:44 +00006182 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006183 cmake "$MBEDTLS_ROOT_DIR"
6184 make
6185
6186 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6187 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006188 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006189 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6190 make
6191
6192 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6193 # In the user config, disable one feature (for simplicity, pick a feature
6194 # that nothing else depends on).
6195 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6196
6197 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6198 make
6199 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6200
6201 rm -f user_config.h full_config.h
6202
6203 cd "$MBEDTLS_ROOT_DIR"
6204 rm -rf "$OUT_OF_SOURCE_DIR"
6205
6206 # Now repeat the test for an in-tree build:
6207
David Horstmann969c1452023-01-31 10:34:44 +00006208 # Restore config for the in-tree test
6209 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006210
David Horstmann969c1452023-01-31 10:34:44 +00006211 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006212 cmake .
6213 make
6214
6215 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6216 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006217 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006218 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6219 make
6220
6221 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6222 # In the user config, disable one feature (for simplicity, pick a feature
6223 # that nothing else depends on).
6224 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6225
6226 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6227 make
6228 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6229
6230 rm -f user_config.h full_config.h
6231}
6232support_build_cmake_custom_config_file () {
6233 support_test_cmake_out_of_source
6234}
6235
6236
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006237component_build_zeroize_checks () {
6238 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6239
6240 scripts/config.py full
6241
6242 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006243 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 +01006244}
6245
6246
Gilles Peskine8f073122018-11-27 15:58:47 +01006247component_test_zeroize () {
6248 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6249 # different combinations of compilers and optimization flags by using an
6250 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6251 # system in all cases that the script fails, so we must manually search the
6252 # output to check whether the pass string is present and no failure strings
6253 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006254
Gilles Peskine4976e822019-01-06 19:52:22 +00006255 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6256 # about a spurious message if Gdb tries and fails, so suppress that.
6257 gdb_disable_aslr=
6258 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6259 gdb_disable_aslr='set disable-randomization off'
6260 fi
6261
Gilles Peskine8f073122018-11-27 15:58:47 +01006262 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006263 for compiler in clang gcc; do
6264 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6265 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006266 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6267 grep "The buffer was correctly zeroized" test_zeroize.log
6268 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006269 rm -f test_zeroize.log
6270 make clean
6271 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006272 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006273}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006274
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006275component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006276 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006277 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006278 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006279
6280 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006281 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006282}
6283
6284support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006285 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006286 ver="$(cmake --version)"
6287 ver="${ver#cmake version }"
6288 ver_major="${ver%%.*}"
6289
6290 ver="${ver#*.}"
6291 ver_minor="${ver%%.*}"
6292
6293 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006294}
6295
Gilles Peskinec848d222022-12-09 12:23:35 +01006296component_check_code_style () {
6297 msg "Check C code style"
6298 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006299}
6300
Gilles Peskinec848d222022-12-09 12:23:35 +01006301support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006302 case $(uncrustify --version) in
6303 *0.75.1*) true;;
6304 *) false;;
6305 esac
6306}
6307
Gilles Peskine8f073122018-11-27 15:58:47 +01006308component_check_python_files () {
6309 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006310 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006311}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006312
Joe Subbianid614c0b2021-07-29 11:18:29 +01006313component_check_test_helpers () {
6314 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006315 # unittest writes out mundane stuff like number or tests run on stderr.
6316 # Our convention is to reserve stderr for actual errors, and write
6317 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006318 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006319
Joe Subbiania25ffab2021-08-06 09:41:27 +01006320 msg "unit test: translate_ciphers.py"
6321 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006322}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006323
Jerry Yud767cc42023-03-31 15:03:55 +08006324
Gilles Peskine192c72f2017-12-21 15:59:21 +01006325################################################################
6326#### Termination
6327################################################################
6328
Gilles Peskine8f073122018-11-27 15:58:47 +01006329post_report () {
6330 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006331 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006332
Gilles Peskine8f073122018-11-27 15:58:47 +01006333 final_report
6334}
6335
6336
6337
6338################################################################
6339#### Run all the things
6340################################################################
6341
Gilles Peskine5d996822020-03-28 21:09:21 +01006342# Function invoked by --error-test to test error reporting.
6343pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006344 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006345 if [ $KEEP_GOING -ne 0 ]; then
6346 echo "Expect three failing commands."
6347 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006348 # If the component doesn't run in a subshell, changing error_test_i to an
6349 # invalid integer will cause an error in the loop that runs this function.
6350 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006351 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006352 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006353 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006354 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006355 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006356 make unknown_target
6357 false "this should not be executed"
6358}
6359
Gilles Peskinee48351a2018-11-27 16:06:30 +01006360# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006361run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006362 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006363 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006364
6365 # Unconditionally create a seedfile that's sufficiently long.
6366 # Do this before each component, because a previous component may
6367 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006368 local dd_cmd
6369 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6370 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006371 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006372 esac
6373 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006374
Gilles Peskineec135542021-08-02 23:14:03 +02006375 # Run the component in a subshell, with error trapping and output
6376 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006377 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006378 # We want to keep running if the subshell fails, so 'set -e' must
6379 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006380 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006381 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006382 (
6383 if [ $QUIET -eq 1 ]; then
6384 # msg() will be silenced, so just print the component name here.
6385 echo "${current_component#component_}"
6386 exec >/dev/null
6387 fi
6388 if [ $KEEP_GOING -eq 1 ]; then
6389 # Keep "set -e" off, and run an ERR trap instead to record failures.
6390 set -E
6391 trap err_trap ERR
6392 fi
6393 # The next line is what runs the component
6394 "$@"
6395 if [ $KEEP_GOING -eq 1 ]; then
6396 trap - ERR
6397 exit $last_failure_status
6398 fi
6399 )
6400 component_status=$?
6401 if [ $KEEP_GOING -eq 1 ]; then
6402 set -e
6403 if [ $component_status -ne 0 ]; then
6404 failure_count=$((failure_count + 1))
6405 fi
6406 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006407
6408 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006409 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006410 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006411}
6412
6413# Preliminary setup
6414pre_check_environment
6415pre_initialize_variables
6416pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006417
Dave Rodgman21900632024-02-26 11:41:19 +00006418setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006419pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006420pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006421pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006422
Gilles Peskine878cf602019-01-06 20:50:38 +00006423build_status=0
6424if [ $KEEP_GOING -eq 1 ]; then
6425 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006426fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006427pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006428pre_print_configuration
6429pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006430cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006431if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006432 pre_generate_files
6433fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006434
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006435# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006436for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006437 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006438done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006439unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006440for component in $RUN_COMPONENTS; do
6441 run_component "component_$component"
6442done
Gilles Peskine8f073122018-11-27 15:58:47 +01006443
6444# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006445post_report