blob: 825cc673b7ed44531f9f79a56565321a0acedb97 [file] [log] [blame]
Gilles Peskine62cf2e82020-03-27 16:35:23 +01001#! /usr/bin/env bash
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine192c72f2017-12-21 15:59:21 +01007
8
9
10################################################################
11#### Documentation
12################################################################
13
Simon Butcher3ea7f522016-03-07 23:22:10 +000014# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010015# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000016#
SimonB2e23c822016-04-16 21:54:39 +010017# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010018#
Gilles Peskine192c72f2017-12-21 15:59:21 +010019# Notes for users
20# ---------------
21#
SimonB2e23c822016-04-16 21:54:39 +010022# Warning: the test is destructive. It includes various build modes and
23# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010024# configuration. The following files must be committed into git:
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020025# * include/mbedtls/mbedtls_config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010026# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
27# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010028# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040038# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010039# * arm-gcc and mingw-gcc
40# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine7be571a2023-08-27 21:39:21 +020041# * OpenSSL and GnuTLS command line tools, in suitable versions for the
42# interoperability tests. The following are the official versions at the
43# time of writing:
44# * GNUTLS_{CLI,SERV} = 3.4.10
45# * GNUTLS_NEXT_{CLI,SERV} = 3.7.2
46# * OPENSSL = 1.0.2g (without Debian/Ubuntu patches)
Ronald Cronc5e81d22024-04-02 14:39:53 +020047# * OPENSSL_NEXT = 3.1.2
Gilles Peskine192c72f2017-12-21 15:59:21 +010048# See the invocation of check_tools below for details.
49#
50# This script must be invoked from the toplevel directory of a git
51# working copy of Mbed TLS.
52#
Gilles Peskinece266c42020-03-28 18:50:43 +010053# The behavior on an error depends on whether --keep-going (alias -k)
54# is in effect.
55# * Without --keep-going: the script stops on the first error without
56# cleaning up. This lets you work in the configuration of the failing
57# component.
58# * With --keep-going: the script runs all requested components and
59# reports failures at the end. In particular the script always cleans
60# up on exit.
61#
Gilles Peskine192c72f2017-12-21 15:59:21 +010062# Note that the output is not saved. You may want to run
63# script -c tests/scripts/all.sh
64# or
65# tests/scripts/all.sh >all.log 2>&1
66#
67# Notes for maintainers
68# ---------------------
69#
Gilles Peskine8f073122018-11-27 15:58:47 +010070# The bulk of the code is organized into functions that follow one of the
71# following naming conventions:
72# * pre_XXX: things to do before running the tests, in order.
73# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010074# * component_check_XXX: quick tests that aren't worth parallelizing.
75# * component_build_XXX: build things but don't run them.
76# * component_test_XXX: build and test.
Bence Szépkúti89dd5c02023-12-15 17:05:15 +010077# * component_release_XXX: tests that the CI should skip during PR testing.
Gilles Peskine878cf602019-01-06 20:50:38 +000078# * support_XXX: if support_XXX exists and returns false then
79# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010080# * post_XXX: things to do after running the tests.
81# * other: miscellaneous support functions.
82#
Gilles Peskinec70637a2019-01-09 22:29:17 +010083# Each component must start by invoking `msg` with a short informative message.
84#
Gilles Peskinea681c592020-03-28 21:27:40 +010085# Warning: due to the way bash detects errors, the failure of a command
86# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
87#
Gilles Peskinece266c42020-03-28 18:50:43 +010088# Each component is executed in a separate shell process. The component
89# fails if any command in it returns a non-zero status.
90#
Gilles Peskinec70637a2019-01-09 22:29:17 +010091# The framework performs some cleanup tasks after each component. This
92# means that components can assume that the working directory is in a
93# cleaned-up state, and don't need to perform the cleanup themselves.
94# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010095# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010096# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010097# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
98# `tests/Makefile` and `programs/fuzz/Makefile` from git.
99# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100100#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100101# The tests are roughly in order from fastest to slowest. This doesn't
102# have to be exact, but in general you should add slower tests towards
103# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100104
105
106
107################################################################
108#### Initialization and command line parsing
109################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100110
Gilles Peskine36647802020-03-28 18:50:49 +0100111# Abort on errors (even on the left-hand side of a pipe).
112# Treat uninitialised variables as errors.
113set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100114
Gilles Peskine076f7252022-08-30 21:02:44 +0200115# Enable ksh/bash extended file matching patterns
116shopt -s extglob
117
Thomas Daubneyd9312ea2023-12-05 11:24:06 +0000118# For project detection
119PROJECT_NAME_FILE='./scripts/project_name.txt'
Thomas Daubneybda3e462024-07-30 15:52:58 +0100120if read -r PROJECT_NAME < "$PROJECT_NAME_FILE"; then :; else
121 echo "$PROJECT_NAME_FILE does not exist... Exiting..." >&2
122 exit 1
123fi
Thomas Daubneyd9312ea2023-12-05 11:24:06 +0000124
David Horstmann76a77382023-08-17 17:32:26 +0100125in_mbedtls_repo () {
Thomas Daubneybda3e462024-07-30 15:52:58 +0100126 test "$PROJECT_NAME" = "Mbed TLS"
Thomas Daubneyb991ac22024-07-29 12:10:27 +0100127}
David Horstmannd02b5f82023-08-29 09:53:52 +0100128
Ronald Cron070e8652023-10-09 10:25:45 +0200129in_tf_psa_crypto_repo () {
Thomas Daubneybda3e462024-07-30 15:52:58 +0100130 test "$PROJECT_NAME" = "TF-PSA-Crypto"
David Horstmann9a6c45b2023-07-14 12:30:00 +0100131}
132
Gilles Peskine8f073122018-11-27 15:58:47 +0100133pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200134 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
135 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100136 exit 1
137 fi
138}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100139
Gilles Peskine8f073122018-11-27 15:58:47 +0100140pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100141 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100142 CONFIG_H='include/mbedtls/mbedtls_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100143 else
144 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100145 fi
John Durkopbd069d32020-10-31 22:14:03 -0700146 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100147 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200148
149 # Files that are clobbered by some jobs will be backed up. Use a different
150 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
151 # independently decide when to remove the backup file.
152 backup_suffix='.all.bak'
153 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100154 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100155 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100156 # Files clobbered by in-tree cmake
157 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
158 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200159
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200160 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100161 MEMORY=0
162 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200163 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100164 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100165
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200166 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200167 #
168 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
169 # both values are kept in sync. If you change the value here because it
170 # breaks some tests, you'll definitely want to change it in
171 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200172 RELEASE_SEED=1
173
Yanray Wang18040ed2023-11-23 21:29:56 +0800174 # Specify character collation for regular expressions and sorting with C locale
175 export LC_COLLATE=C
176
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200177 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200178 : ${MBEDTLS_TEST_PLATFORM="$(uname -s | tr -c \\n0-9A-Za-z _)-$(uname -m | tr -c \\n0-9A-Za-z _)"}
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200179 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200180 export MBEDTLS_TEST_PLATFORM
181
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000182 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100183 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100184 : ${OPENSSL_NEXT:="$OPENSSL"}
185 : ${GNUTLS_CLI:="gnutls-cli"}
186 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100187 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
188 : ${ARMC5_BIN_DIR:=/usr/bin}
189 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200190 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200191 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100192 : ${CLANG_LATEST:="clang-latest"}
193 : ${CLANG_EARLIEST:="clang-earliest"}
194 : ${GCC_LATEST:="gcc-latest"}
195 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100196 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000197 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200198 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100199 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000200 # if CC is not set, use clang by default (if present) to improve build times
201 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000202 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000203 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000204
Ronald Cronc5e81d22024-04-02 14:39:53 +0200205 if [ -n "${OPENSSL_3+set}" ]; then
206 export OPENSSL_NEXT="$OPENSSL_3"
207 fi
208
Gilles Peskine396853a2021-09-20 18:57:55 +0200209 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000210 export CTEST_OUTPUT_ON_FAILURE=1
211
Gilles Peskine8fd59422019-10-21 17:11:33 +0200212 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100213 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200214 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000215 # Normally, tests should use this compiler for ASAN testing
216 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200217
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400218 # Platform tests have an allocation that returns null
219 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400220 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400221
Gilles Peskine878cf602019-01-06 20:50:38 +0000222 # Gather the list of available components. These are the functions
223 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100224 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000225
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000226 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100227 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100228}
Andres AG38495a32016-07-12 16:54:33 +0100229
Dave Rodgman21900632024-02-26 11:41:19 +0000230setup_quiet_wrappers()
231{
232 # Pick up "quiet" wrappers for make and cmake, which don't output very much
233 # unless there is an error. This reduces logging overhead in the CI.
234 #
235 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000236 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
237 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000238 fi
239}
240
Gilles Peskinea28db922019-01-10 00:05:18 +0100241# Test whether the component $1 is included in the command line patterns.
242is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100243{
Gilles Peskine03af6782021-08-06 11:35:17 +0200244 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
245 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100246 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000247 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100248 set +f
249 case ${1#component_} in $pattern) return 0;; esac
250 done
251 set +f
252 return 1
253}
Andres AG7770ea82016-10-10 15:46:20 +0100254
Simon Butcher41eeccf2016-09-07 00:07:09 +0100255usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100256{
Gilles Peskine709346a2017-12-10 23:43:39 +0100257 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100258Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100259Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100260By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100261COMPONENT can be the name of a component or a shell wildcard pattern.
262
263Examples:
264 $0 "check_*"
265 Run all sanity checks.
266 $0 --no-armcc --except test_memsan
267 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100268
269Special options:
270 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000271 --list-all-components List all available test components and exit.
272 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100273
274General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200275 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100276 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100277 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100278 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200279 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200280 --arm-none-eabi-gcc-prefix=<string>
281 Prefix for a cross-compiler for arm-none-eabi
282 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200283 --arm-linux-gnueabi-gcc-prefix=<string>
284 Prefix for a cross-compiler for arm-linux-gnueabi
285 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100286 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200287 --restore First clean up the build tree, restoring backed up
288 files. Do not run any components unless they are
289 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100290 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200291 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100292 --except Exclude the COMPONENTs listed on the command line,
293 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200294 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100295 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100296 --no-force Refuse to overwrite modified files (default).
297 --no-keep-going Stop at the first error (default).
298 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800299 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100300 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200301 --outcome-file=<path> File where test outcomes are written (not done if
302 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100303 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200304 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100305 -s|--seed Integer seed value to use for this test run.
306
307Tool path options:
308 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
309 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100310 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
311 --clang-latest=<Clang_latest_path> Latest version of clang available
312 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
313 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100314 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
315 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100316 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100317 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100318EOF
SimonB2e23c822016-04-16 21:54:39 +0100319}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100320
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200321# Cleanup before/after running a component.
322# Remove built files as well as the cmake cache/config.
323# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100324cleanup()
325{
David Horstmann76a77382023-08-17 17:32:26 +0100326 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100327 command make clean
328 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200329
Gilles Peskine31b07e22018-03-21 12:15:06 +0100330 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000331 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100332 -iname CMakeFiles -exec rm -rf {} \+ -o \
333 \( -iname cmake_install.cmake -o \
334 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200335 -iname CMakeCache.txt -o \
336 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100337 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200338 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200339
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100340 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
341 rm -rf programs/test/cmake_subproject/build
342 rm -f programs/test/cmake_subproject/Makefile
343 rm -f programs/test/cmake_subproject/cmake_subproject
344
Chris Kayd259e342021-03-25 16:03:25 +0000345 # Remove any artifacts from the component_test_cmake_as_package test.
346 rm -rf programs/test/cmake_package/build
347 rm -f programs/test/cmake_package/Makefile
348 rm -f programs/test/cmake_package/cmake_package
349
350 # Remove any artifacts from the component_test_cmake_as_installed_package test.
351 rm -rf programs/test/cmake_package_install/build
352 rm -f programs/test/cmake_package_install/Makefile
353 rm -f programs/test/cmake_package_install/cmake_package_install
354
Gilles Peskinef83eb822020-03-30 20:11:39 +0200355 # Restore files that may have been clobbered by the job
356 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200357 if [[ -e "$x$backup_suffix" ]]; then
358 cp -p "$x$backup_suffix" "$x"
359 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200360 done
361}
John Durkopbd069d32020-10-31 22:14:03 -0700362
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200363# Final cleanup when this script exits (except when exiting on a failure
364# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200365final_cleanup () {
366 cleanup
367
368 for x in $files_to_back_up; do
369 rm -f "$x$backup_suffix"
370 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100371}
372
Gilles Peskine7c652162017-12-11 00:01:40 +0100373# Executed on exit. May be redefined depending on command line options.
374final_report () {
375 :
376}
377
378fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200379 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100380 final_report $1
381 trap - $1
382 kill -$1 $$
383}
384
385trap 'fatal_signal HUP' HUP
386trap 'fatal_signal INT' INT
387trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200388
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200389# Number of processors on this machine. Used as the default setting
390# for parallel make.
391all_sh_nproc ()
392{
393 {
394 nproc || # Linux
395 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
396 sysctl -n hw.ncpu || # FreeBSD
397 echo 1
398 } 2>/dev/null
399}
400
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100401msg()
402{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100403 if [ -n "${current_component:-}" ]; then
404 current_section="${current_component#component_}: $1"
405 else
406 current_section="$1"
407 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200408
409 if [ $QUIET -eq 1 ]; then
410 return
411 fi
412
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100413 echo ""
414 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100415 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000416 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100417 echo "******************************************************************"
418}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100419
Gilles Peskine8f073122018-11-27 15:58:47 +0100420armc6_build_test()
421{
422 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100423
Gilles Peskine18487f62020-04-30 23:11:54 +0200424 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800425 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100426 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000427 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200428
429 msg "size: ARM Compiler 6 ($FLAGS)"
430 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100431}
Andres AGa5cd9732016-10-17 15:23:10 +0100432
Andres AGd9eba4b2016-08-26 14:42:14 +0100433err_msg()
434{
435 echo "$1" >&2
436}
437
438check_tools()
439{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200440 for tool in "$@"; do
441 if ! `type "$tool" >/dev/null 2>&1`; then
442 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100443 exit 1
444 fi
445 done
446}
447
Gilles Peskine8f073122018-11-27 15:58:47 +0100448pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000449 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100450 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100451 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100452 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200453 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000454 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100455
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000456 # Note that legacy options are ignored instead of being omitted from this
457 # list of options, so invocations that worked with previous version of
458 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100459 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100460 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200461 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200462 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200463 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000464 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100465 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
466 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100467 --clang-earliest) shift; CLANG_EARLIEST="$1";;
468 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100469 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000470 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100471 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100472 --gcc-earliest) shift; GCC_EARLIEST="$1";;
473 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100474 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200475 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
476 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100477 --gnutls-serv) shift; GNUTLS_SERV="$1";;
478 --help|-h) usage; exit;;
479 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000480 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100481 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100482 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200483 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000484 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100485 --no-force) FORCE=0;;
486 --no-keep-going) KEEP_GOING=0;;
487 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200488 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100489 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100490 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200491 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100492 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200493 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100494 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200495 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200496 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100497 --seed|-s) shift; SEED="$1";;
498 -*)
499 echo >&2 "Unknown option: $1"
500 echo >&2 "Run $0 --help for usage."
501 exit 120
502 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000503 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100504 esac
505 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100506 done
SimonB2e23c822016-04-16 21:54:39 +0100507
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100508 # Exclude components that are not supported on this platform.
509 SUPPORTED_COMPONENTS=
510 for component in $ALL_COMPONENTS; do
511 case $(type "support_$component" 2>&1) in
512 *' function'*)
513 if ! support_$component; then continue; fi;;
514 esac
515 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
516 done
517
518 if [ $list_components -eq 1 ]; then
519 printf '%s\n' $SUPPORTED_COMPONENTS
520 exit
521 fi
522
Gilles Peskinea28db922019-01-10 00:05:18 +0100523 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200524 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000525 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100526 fi
527
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000528 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
529 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100530 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000531 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100532 fi
SimonB2e23c822016-04-16 21:54:39 +0100533
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200534 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100535 if [ $all_except -eq 0 ]; then
536 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200537 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
538 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200539 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100540 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200541 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200542 # If the requested name includes a wildcard character, don't
543 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100544 case $component in
545 *[*?\[]*) continue;;
546 esac
547 case " $SUPPORTED_COMPONENTS " in
548 *" $component "*) :;;
549 *)
550 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
551 unsupported=$((unsupported + 1));;
552 esac
553 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200554 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100555 if [ $unsupported -ne 0 ]; then
556 exit 2
557 fi
558 fi
559
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000560 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100561 RUN_COMPONENTS=
562 for component in $SUPPORTED_COMPONENTS; do
563 if is_component_included "$component"; [ $? -eq $all_except ]; then
564 RUN_COMPONENTS="$RUN_COMPONENTS $component"
565 fi
566 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000567
568 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000569 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100570}
SimonB2e23c822016-04-16 21:54:39 +0100571
Gilles Peskine8f073122018-11-27 15:58:47 +0100572pre_check_git () {
573 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100574 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100575 git checkout-index -f -q $CONFIG_H
576 cleanup
577 else
SimonB2e23c822016-04-16 21:54:39 +0100578
Gilles Peskine8f073122018-11-27 15:58:47 +0100579 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
580 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
581 echo "You can either delete this directory manually, or force the test by rerunning"
582 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
583 exit 1
584 fi
585
Ronald Cron7a93ac52023-07-20 09:49:12 +0200586 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100587 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100588 echo "You can either delete or preserve your work, or force the test by rerunning the"
589 echo "script as: $0 --force"
590 exit 1
591 fi
SimonB2e23c822016-04-16 21:54:39 +0100592 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500593}
594
Gilles Peskine568f53a2021-07-12 18:16:01 +0200595pre_restore_files () {
596 # If the makefiles have been generated by a framework such as cmake,
597 # restore them from git. If the makefiles look like modifications from
598 # the ones checked into git, take care not to modify them. Whatever
599 # this function leaves behind is what the script will restore before
600 # each component.
601 case "$(head -n1 Makefile)" in
602 *[Gg]enerated*)
603 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
604 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
605 ;;
606 esac
607}
608
Gilles Peskinef83eb822020-03-30 20:11:39 +0200609pre_back_up () {
610 for x in $files_to_back_up; do
611 cp -p "$x" "$x$backup_suffix"
612 done
613}
614
Gilles Peskine8f073122018-11-27 15:58:47 +0100615pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100616 failure_count=0 # Number of failed components
617 last_failure_status=0 # Last failure status in this component
618
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100619 # See err_trap
620 previous_failure_status=0
621 previous_failed_command=
622 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100623 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100624
Gilles Peskine7c652162017-12-11 00:01:40 +0100625 start_red=
626 end_color=
627 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100628 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100629 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
630 start_red=$(printf '\033[31m')
631 end_color=$(printf '\033[0m')
632 ;;
633 esac
634 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100635
636 # Keep a summary of failures in a file. We'll print it out at the end.
637 failure_summary_file=$PWD/all-sh-failures-$$.log
638 : >"$failure_summary_file"
639
640 # Whether it makes sense to keep a component going after the specified
641 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200642 # This function normally receives the failing simple command
643 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
644 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100645 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200646 # False positives result in running things that can't be expected to
647 # work. False negatives result in things not running after something else
648 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100649 can_keep_going_after_failure () {
650 case "$1" in
651 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200652 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100653 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200654 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
655 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
656 *make*check*) true;;
657 "grep "*) true;;
658 "[ "*) true;;
659 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100660 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100661 esac
662 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100663
664 # This function runs if there is any error in a component.
665 # It must either exit with a nonzero status, or set
666 # last_failure_status to a nonzero value.
667 err_trap () {
668 # Save $? (status of the failing command). This must be the very
669 # first thing, before $? is overridden.
670 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100671 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100672
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100673 if [[ $last_failure_status -eq $previous_failure_status &&
674 "$failed_command" == "$previous_failed_command" &&
675 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
676 then
677 # The same command failed twice in a row, but this time one level
678 # less deep in the function call stack. This happens when the last
679 # command of a function returns a nonzero status, and the function
680 # returns that same status. Ignore the second failure.
681 previous_failure_funcall_depth=${#FUNCNAME[@]}
682 return
683 fi
684 previous_failure_status=$last_failure_status
685 previous_failed_command=$failed_command
686 previous_failure_funcall_depth=${#FUNCNAME[@]}
687
Gilles Peskinece266c42020-03-28 18:50:43 +0100688 text="$current_section: $failed_command -> $last_failure_status"
689 echo "${start_red}^^^^$text^^^^${end_color}" >&2
690 echo "$text" >>"$failure_summary_file"
691
692 # If the command is fatal (configure or build command), stop this
693 # component. Otherwise (test command) keep the component running
694 # (run more tests from the same build).
695 if ! can_keep_going_after_failure "$failed_command"; then
696 exit $last_failure_status
697 fi
698 }
699
Gilles Peskine7c652162017-12-11 00:01:40 +0100700 final_report () {
701 if [ $failure_count -gt 0 ]; then
702 echo
703 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100704 echo "${start_red}FAILED: $failure_count components${end_color}"
705 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100706 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
707 elif [ -z "${1-}" ]; then
708 echo "SUCCESS :)"
709 fi
710 if [ -n "${1-}" ]; then
711 echo "Killed by SIG$1."
712 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100713 rm -f "$failure_summary_file"
714 if [ $failure_count -gt 0 ]; then
715 exit 1
716 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100717 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100718}
719
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200720# record_status() and if_build_succeeded() are kept temporarily for backward
721# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100722record_status () {
723 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100724}
Gilles Peskine7c652162017-12-11 00:01:40 +0100725if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100726 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100727}
728
Gilles Peskinea681c592020-03-28 21:27:40 +0100729# '! true' does not trigger the ERR trap. Arrange to trigger it, with
730# a reasonably informative error message (not just "$@").
731not () {
732 if "$@"; then
733 report_failed_command="! $*"
734 false
735 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200736 fi
737}
738
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200739pre_prepare_outcome_file () {
740 case "$MBEDTLS_TEST_OUTCOME_FILE" in
741 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
742 esac
743 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
744 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
745 fi
746}
747
Gilles Peskine8f073122018-11-27 15:58:47 +0100748pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200749 if [ $QUIET -eq 1 ]; then
750 return
751 fi
752
Gilles Peskine8f073122018-11-27 15:58:47 +0100753 msg "info: $0 configuration"
754 echo "MEMORY: $MEMORY"
755 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200756 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100757 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100758 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100759 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100760 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
761 echo "GNUTLS_CLI: $GNUTLS_CLI"
762 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100763 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
764 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
765}
Andres AG7770ea82016-10-10 15:46:20 +0100766
Andres AGd9eba4b2016-08-26 14:42:14 +0100767# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100768pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000769 # Build the list of variables to pass to output_env.sh.
770 set env
SimonB2e23c822016-04-16 21:54:39 +0100771
Gilles Peskine87964262019-01-06 22:40:00 +0000772 case " $RUN_COMPONENTS " in
773 # Require OpenSSL and GnuTLS if running any tests (as opposed to
774 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
775 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100776 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000777 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
778 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100779 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000780 export GNUTLS_CLI="$GNUTLS_CLI"
781 export GNUTLS_SERV="$GNUTLS_SERV"
782 # Avoid passing --seed flag in every call to ssl-opt.sh
783 if [ -n "${SEED-}" ]; then
784 export SEED
785 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200786 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000787 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200788 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
789 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000790 ;;
791 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200792
Gilles Peskine87964262019-01-06 22:40:00 +0000793 case " $RUN_COMPONENTS " in
794 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
795 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100796
Gilles Peskine87964262019-01-06 22:40:00 +0000797 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200798 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000799 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100800
Gilles Peskine87964262019-01-06 22:40:00 +0000801 case " $RUN_COMPONENTS " in
802 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
803 esac
804
805 case " $RUN_COMPONENTS " in
806 *" test_zeroize "*) check_tools "gdb";;
807 esac
808
809 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000810 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000811 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
812 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200813 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000814 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
815 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200816 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
817 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
818 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000819 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000820
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200821 # past this point, no call to check_tool, only printing output
822 if [ $QUIET -eq 1 ]; then
823 return
824 fi
825
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000826 msg "info: output_env.sh"
827 case $RUN_COMPONENTS in
828 *_armcc*)
829 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
830 *) set "$@" RUN_ARMCC=0;;
831 esac
832 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100833}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100834
Gilles Peskine1570b592021-04-22 01:10:12 +0200835pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200836 # since make doesn't have proper dependencies, remove any possibly outdate
837 # file that might be around before generating fresh ones
838 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200839 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200840 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200841 else
842 make generated_files
843 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200844}
845
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000846clang_version() {
847 if command -v clang > /dev/null ; then
848 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
849 else
850 echo 0 # report version 0 for "no clang"
851 fi
852}
853
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200854################################################################
855#### Helpers for components using libtestdriver1
856################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100857
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200858# How to use libtestdriver1
859# -------------------------
860#
861# 1. Define the list algorithms and key types to accelerate,
862# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
863# Examples:
864# - loc_accel_list="ALG_JPAKE"
865# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200866# 2. Make configurations changes for the driver and/or main libraries.
867# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
868# can be either "default" to start with the default config, or a name
869# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200870# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200871# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
872# These changes affect both the driver and the main libraries.
873# (Note: they need to have the same set of PSA_WANT symbols, as that
874# determines the ABI between them.)
875# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
876# main libraries. Typically, you want to disable the module(s) that are
877# being accelerated. You may need to also disable modules that depend
878# on them or options that are not supported with drivers.
879# 2d. On top of psa/crypto_config.h, the driver library uses its own config
880# file: tests/include/test/drivers/config_test_driver.h. You usually
881# don't need to edit it: using loc_extra_list (see below) is preferred.
882# However, when there's no PSA symbol for what you want to enable,
883# calling scripts/config.py on this file remains the only option.
884# 3. Build the driver library, then the main libraries, test, and programs.
885# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
886# need to enable more algorithms here, typically hash algorithms when
887# accelerating some signature algorithms (ECDSA, RSAv2). This is done
888# by passing a 2nd argument listing the extra algorithms.
889# Example:
890# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
891# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800892# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200893# additional arguments will be passed to make: this can be useful if
894# you don't want to build everything when iterating during development.
895# Example:
896# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
897# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200898
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200899# Adjust the configuration - for both libtestdriver1 and main library,
900# as they should have the same PSA_WANT macros.
901helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200902 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200903 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200904 if [ "$base_config" != "default" ]; then
905 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200906 fi
907
908 # Enable PSA-based config (necessary to use drivers)
909 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
910
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200911 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
912 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
913 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000914
915 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
916 # otherwise we will end up running multithreaded tests without mutexes to protect them.
917 if scripts/config.py get MBEDTLS_THREADING_C; then
918 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
919 fi
920
921 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
922 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
923 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200924}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100925
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100926# Build the drivers library libtestdriver1.a (with ASan).
927#
928# Parameters:
929# 1. a space-separated list of things to accelerate;
930# 2. optional: a space-separate list of things to also support.
931# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
932helper_libtestdriver1_make_drivers() {
933 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
934 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
935}
936
937# Build the main libraries, programs and tests,
938# linking to the drivers library (with ASan).
939#
940# Parameters:
941# 1. a space-separated list of things to accelerate;
942# *. remaining arguments if any are passed directly to make
943# (examples: lib, -C tests test_suite_xxx, etc.)
944# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
945helper_libtestdriver1_make_main() {
946 loc_accel_list=$1
947 shift
948
949 # we need flags both with and without the LIBTESTDRIVER1_ prefix
950 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
951 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
952 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" "$@"
953}
954
Valerio Settid1b6ef12024-05-07 16:00:21 +0200955# $1: target which can be "client" or "server"
956helper_crypto_client_build() {
957 TARGET=$1
Valerio Settic98f8ab2024-05-10 15:53:40 +0200958 shift
Valerio Settid1b6ef12024-05-07 16:00:21 +0200959 TARGET_LIB=libpsa$TARGET
960
Valerio Settid1b6ef12024-05-07 16:00:21 +0200961 if [ "$TARGET" == "client" ]; then
962 scripts/config.py full
963 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
964 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
965 # Dynamic secure element support is a deprecated feature and it is not
966 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
967 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
968 # Disable potentially problematic features
969 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
970 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
971 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
972 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
973 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
974 else
975 scripts/config.py crypto_full
976 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
977 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200978 fi
979
Valerio Settif57afd52024-05-14 10:39:20 +0200980 make -C tests/psa-client-server/psasim/ CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
Valerio Settid1b6ef12024-05-07 16:00:21 +0200981
Valerio Settif57afd52024-05-14 10:39:20 +0200982 # cleanup() will restore some backed-up files which include $CONFIG_H and
983 # $CRYPTO_CONFIG_H. Built libraries were already copied to psasim at this
984 # point.
985 cleanup
Valerio Settid1b6ef12024-05-07 16:00:21 +0200986}
987
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100988################################################################
989#### Configuration helpers
990################################################################
991
Valerio Settib2fd6732023-08-15 17:10:47 +0200992# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200993# The function optionally accepts 1 parameter: a space-separated list of the
994# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200995helper_disable_builtin_curves() {
996 allowed_list="${1:-}"
997 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
998
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200999 for curve in $allowed_list; do
1000 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +02001001 done
1002}
1003
1004# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1005# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1006# in the following helpers.
1007helper_get_psa_curve_list () {
1008 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001009 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1010 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001011 done
1012
1013 echo "$loc_list"
1014}
1015
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001016# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1017# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1018# in the following helpers.
1019helper_get_psa_dh_group_list () {
1020 loc_list=""
1021 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1022 loc_list="$loc_list $item"
1023 done
1024
1025 echo "$loc_list"
1026}
1027
Valerio Settib2fd6732023-08-15 17:10:47 +02001028# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001029# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001030# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001031helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001032 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001033 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001034 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 +02001035 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1036 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001037 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1038 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001039 fi
1040 done
1041
1042 echo "$loc_list"
1043}
1044
Gilles Peskine192c72f2017-12-21 15:59:21 +01001045################################################################
1046#### Basic checks
1047################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001048
1049#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001050# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001051#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001052# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001053# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001054# 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 +02001055# time, so start with a GCC build).
1056# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001057#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001058# Indicative running times are given for reference.
1059
Gilles Peskine8f073122018-11-27 15:58:47 +01001060component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001061 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001062 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001063}
Janos Follathb72c6782016-07-19 14:54:17 +01001064
Gilles Peskine67debb62021-05-18 16:09:50 +02001065component_check_generated_files () {
1066 msg "Check: check-generated-files, files generated with make" # 2s
1067 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001068 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001069
1070 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001071 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001072 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001073 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001074
1075 msg "Check: check-generated-files -u, files absent" # 2s
1076 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001077 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001078 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001079 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001080
1081 # This component ends with the generated files present in the source tree.
1082 # This is necessary for subsequent components!
1083}
1084
Gilles Peskine8f073122018-11-27 15:58:47 +01001085component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001086 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001087 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001088}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001089
Gilles Peskine8f073122018-11-27 15:58:47 +01001090component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001091 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001092 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001093}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001094
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001095component_check_changelog () {
1096 msg "Check: changelog entries" # < 1s
1097 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001098 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001099 if [ -e ChangeLog.new ]; then
1100 # Show the diff for information. It isn't an error if the diff is
1101 # non-empty.
1102 diff -u ChangeLog ChangeLog.new || true
1103 rm ChangeLog.new
1104 fi
1105}
1106
Gilles Peskine8f073122018-11-27 15:58:47 +01001107component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001108 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001109 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001110}
Darryl Greena07039c2018-03-13 16:48:16 +00001111
Gilles Peskine895868b2019-09-19 21:30:05 +02001112component_check_test_cases () {
1113 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001114 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001115 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001116 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001117 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001118 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001119 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001120 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001121}
1122
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001123component_check_test_dependencies () {
1124 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001125 # The purpose of this component is to catch unjustified dependencies on
1126 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1127 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1128 # MBEDTLS_PSA_xxx).
1129 #
1130 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1131 # this component is meant to catch. However a few of them are justified,
1132 # mostly by the absence of a PSA equivalent, so this component includes a
1133 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001134
1135 found="check-test-deps-found-$$"
1136 expected="check-test-deps-expected-$$"
1137
1138 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001139 grep 'depends_on' \
1140 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001141 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001142 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001143 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001144
Yanray Wang18040ed2023-11-23 21:29:56 +08001145 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001146 rm -f $expected
1147 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1148 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001149 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1150 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001151 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1152 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001153 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1154 # the test code and that's probably the most convenient way of achieving
1155 # the test's goal.
1156 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1157 # No PSA equivalent - we should probably have one in the future.
1158 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1159 # No PSA equivalent - needed by some init tests
1160 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001161 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001162 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001163
1164 # Compare reality with expectation.
1165 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001166 #
1167 # The output should be empty. When it's not:
1168 # - Each '+' line is a macro that was found but not expected. You want to
1169 # find where that macro occurs, and either replace it with PSA macros, or
1170 # add it to the exceptions list above with a justification.
1171 # - Each '-' line is a macro that was expected but not found; it means the
1172 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001173 diff -U0 $expected $found
1174
1175 rm $found $expected
1176}
1177
Gilles Peskine8f073122018-11-27 15:58:47 +01001178component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001179 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001180 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001181}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001182
Gilles Peskine192c72f2017-12-21 15:59:21 +01001183
Gilles Peskine636c26a2020-03-04 20:46:15 +01001184
Gilles Peskine192c72f2017-12-21 15:59:21 +01001185################################################################
1186#### Build and test many configurations and targets
1187################################################################
1188
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001189component_test_default_out_of_box () {
1190 msg "build: make, default config (out-of-box)" # ~1min
1191 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001192 # Disable fancy stuff
1193 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001194
1195 msg "test: main suites make, default config (out-of-box)" # ~10s
1196 make test
1197
1198 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001199 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001200
1201 msg "program demos: make, default config (out-of-box)" # ~10s
1202 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001203}
1204
Gilles Peskine8f073122018-11-27 15:58:47 +01001205component_test_default_cmake_gcc_asan () {
1206 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001207 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1208 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001209
Gilles Peskine8f073122018-11-27 15:58:47 +01001210 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1211 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001212
Gilles Peskine82b27272019-06-14 18:27:03 +02001213 msg "program demos (ASan build)" # ~10s
1214 tests/scripts/run_demos.py
1215
Gilles Peskine97bea012020-04-23 23:37:45 +02001216 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001217 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001218
Gilles Peskine6848d172023-11-02 19:58:03 +01001219 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001220 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001221
Gilles Peskine8f073122018-11-27 15:58:47 +01001222 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001223 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001224
Gilles Peskine8f073122018-11-27 15:58:47 +01001225 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001226 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001227
1228 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001229 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001230}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001231
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001232component_test_default_cmake_gcc_asan_new_bignum () {
1233 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001234 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001235 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001236 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001237
1238 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1239 make test
1240
1241 msg "test: selftest (ASan build)" # ~ 10s
1242 programs/test/selftest
1243
1244 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1245 tests/ssl-opt.sh
1246
1247 msg "test: compat.sh (ASan build)" # ~ 6 min
1248 tests/compat.sh
1249
1250 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1251 tests/context-info.sh
1252}
1253
Hanno Becker01635512019-02-26 14:27:09 +00001254component_test_full_cmake_gcc_asan () {
1255 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001256 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001257 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1258 make
1259
1260 msg "test: main suites (inc. selftests) (full config, ASan build)"
1261 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001262
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001263 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001264 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001265
Gilles Peskine636c26a2020-03-04 20:46:15 +01001266 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001267 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001268
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001269 # Note: the next two invocations cover all compat.sh test cases.
1270 # We should use the same here and in basic-build-test.sh.
1271 msg "test: compat.sh: default version (full config, ASan build)"
1272 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001273
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001274 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1275 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001276
1277 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001278 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001279}
1280
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001281
1282component_test_full_cmake_gcc_asan_new_bignum () {
1283 msg "build: full config, cmake, gcc, ASan"
1284 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001285 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001286 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001287 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001288
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001289 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001290 make test
1291
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001292 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001293 programs/test/selftest
1294
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001295 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001296 tests/ssl-opt.sh
1297
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001298 # Note: the next two invocations cover all compat.sh test cases.
1299 # We should use the same here and in basic-build-test.sh.
1300 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1301 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001302
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001303 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1304 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001305
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001306 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001307 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001308}
1309
Ronald Cronc3623db2020-10-29 10:51:32 +01001310component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001311 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001312 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001313 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1314 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1315 make
1316
1317 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1318 make test
1319}
1320
David Horstmann4a48bec2024-03-13 15:42:31 +00001321component_test_psa_assume_exclusive_buffers () {
1322 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001323 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001324 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001325 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1326 make
1327
David Horstmann4a48bec2024-03-13 15:42:31 +00001328 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001329 make test
1330}
1331
Gilles Peskinea3548672021-06-17 11:37:52 +02001332# check_renamed_symbols HEADER LIB
1333# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1334# name is LIB.
1335check_renamed_symbols () {
1336 ! nm "$2" | sed 's/.* //' |
1337 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1338}
1339
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001340component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001341 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001342 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001343 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1344 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1345 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1346 # We can only compile, not link, since our test and sample programs
1347 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1348 # is active.
1349 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001350
1351 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1352 # version is not present.
1353 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001354 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001355}
1356
Valerio Setti63097752024-03-12 13:18:13 +01001357# Get a list of library-wise undefined symbols and ensure that they only
1358# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1359# This function is a common helper used by both:
1360# - component_test_default_psa_crypto_client_without_crypto_provider
1361# - component_build_full_psa_crypto_client_without_crypto_provider.
1362common_check_mbedtls_missing_symbols() {
1363 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1364 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1365 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1366 not grep mbedtls_ linking_errors.txt
1367
1368 rm sym_def.txt sym_undef.txt linking_errors.txt
1369}
1370
1371component_test_default_psa_crypto_client_without_crypto_provider () {
1372 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1373
Ronald Cron336678b2021-01-28 17:54:24 +01001374 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1375 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001376 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001377 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001378 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001379 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001380
Ronald Cron336678b2021-01-28 17:54:24 +01001381 make
1382
Valerio Setti63097752024-03-12 13:18:13 +01001383 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1384 common_check_mbedtls_missing_symbols
1385
1386 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001387 make test
1388}
1389
Valerio Setti63097752024-03-12 13:18:13 +01001390component_build_full_psa_crypto_client_without_crypto_provider () {
1391 msg "build: full config - PSA_CRYPTO_C"
1392
1393 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1394 scripts/config.py full
1395
1396 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1397 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1398 # Dynamic secure element support is a deprecated feature and it is not
1399 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1400 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1401
1402 # Since there is no crypto provider in this build it is not possible to
1403 # build all the test executables and progrems due to missing PSA functions
1404 # at link time. Therefore we will just build libraries and we'll check
1405 # that symbols of interest are there.
1406 make lib
1407
1408 msg "check missing symbols: full config - PSA_CRYPTO_C"
1409
1410 common_check_mbedtls_missing_symbols
1411
1412 # Ensure that desired functions are included into the build (extend the
1413 # following list as required).
1414 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1415 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1416 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1417}
1418
Ryan Everettdaa322a2024-04-18 16:48:55 +01001419component_test_no_rsa_key_pair_generation() {
1420 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001421 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001422 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001423 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001424 make
1425
Ryan Everettdaa322a2024-04-18 16:48:55 +01001426 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001427 make test
1428}
1429
Gilles Peskine782f4112018-11-27 16:11:09 +01001430component_test_ref_configs () {
1431 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001432 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1433 # want to re-generate generated files that depend on it, quite correctly.
1434 # However this doesn't work as the generation script expects a specific
1435 # format for mbedtls_config.h, which the other files don't follow. Also,
1436 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001437 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001438 # whether they're on or off. So, disable cmake's (over-sensitive here)
1439 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001440 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001441 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001442 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001443}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001444
Gilles Peskine8f073122018-11-27 15:58:47 +01001445component_test_no_renegotiation () {
1446 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001447 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001448 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001449 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001450
Gilles Peskine8f073122018-11-27 15:58:47 +01001451 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1452 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001453
Gilles Peskine8f073122018-11-27 15:58:47 +01001454 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001455 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001456}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001457
Gilles Peskine636c26a2020-03-04 20:46:15 +01001458component_test_no_pem_no_fs () {
1459 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1460 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1461 scripts/config.py unset MBEDTLS_FS_IO
1462 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1463 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001464 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001465 make
1466
1467 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1468 make test
1469
1470 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001471 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001472}
1473
Gilles Peskine8f073122018-11-27 15:58:47 +01001474component_test_rsa_no_crt () {
1475 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001476 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001477 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001478 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001479
Gilles Peskine8f073122018-11-27 15:58:47 +01001480 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1481 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001482
Gilles Peskine8f073122018-11-27 15:58:47 +01001483 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001484 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001485
Gilles Peskine8f073122018-11-27 15:58:47 +01001486 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001487 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001488
1489 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001490 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001491}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001492
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001493component_test_no_ctr_drbg_classic () {
1494 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001495 scripts/config.py full
1496 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001497 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001498 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001499
Dave Rodgman17127e92023-12-14 16:42:48 +00001500 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001501 make
1502
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001503 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001504 make test
1505
Gilles Peskineba749042021-01-13 20:02:03 +01001506 # In this configuration, the TLS test programs use HMAC_DRBG.
1507 # The SSL tests are slow, so run a small subset, just enough to get
1508 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001509 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001510 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001511
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001512 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001513 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001514}
1515
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001516component_test_no_ctr_drbg_use_psa () {
1517 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001518 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001519 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1520 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001521
Dave Rodgman17127e92023-12-14 16:42:48 +00001522 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001523 make
1524
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001525 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1526 make test
1527
1528 # In this configuration, the TLS test programs use HMAC_DRBG.
1529 # The SSL tests are slow, so run a small subset, just enough to get
1530 # confidence that the SSL code copes with HMAC_DRBG.
1531 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001532 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001533
1534 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001535 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001536}
1537
1538component_test_no_hmac_drbg_classic () {
1539 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1540 scripts/config.py full
1541 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1542 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1543 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001544 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001545
Dave Rodgman17127e92023-12-14 16:42:48 +00001546 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001547 make
1548
1549 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001550 make test
1551
Gilles Peskinea2224342020-11-19 22:14:34 +01001552 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1553 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1554 # instead.
1555 # Test SSL with non-deterministic ECDSA. Only test features that
1556 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001557 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001558 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001559
1560 # To save time, only test one protocol version, since this part of
1561 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001562 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001563 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001564}
1565
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001566component_test_no_hmac_drbg_use_psa () {
1567 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1568 scripts/config.py full
1569 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1570 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1571 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1572
Dave Rodgman17127e92023-12-14 16:42:48 +00001573 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001574 make
1575
1576 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1577 make test
1578
1579 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1580 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1581 # instead.
1582 # Test SSL with non-deterministic ECDSA. Only test features that
1583 # might be affected by how ECDSA signature is performed.
1584 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001585 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001586
1587 # To save time, only test one protocol version, since this part of
1588 # the protocol is identical in (D)TLS up to 1.2.
1589 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001590 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001591}
1592
1593component_test_psa_external_rng_no_drbg_classic () {
1594 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1595 scripts/config.py full
1596 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001597 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001598 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001599 scripts/config.py unset MBEDTLS_ENTROPY_C
1600 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1601 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001602 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1603 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1604 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001605 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1606 # the SSL test programs don't have an RNG and can't work. Explicitly
1607 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001608 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001609
1610 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1611 make test
1612
Gilles Peskine8eb29432021-02-03 20:07:11 +01001613 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001614 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001615}
1616
1617component_test_psa_external_rng_no_drbg_use_psa () {
1618 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001619 scripts/config.py full
1620 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001621 scripts/config.py unset MBEDTLS_ENTROPY_C
1622 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1623 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001624 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1625 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1626 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001627 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001628
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001629 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001630 make test
1631
Gilles Peskine8eb29432021-02-03 20:07:11 +01001632 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001633 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001634}
1635
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001636component_test_psa_external_rng_use_psa_crypto () {
1637 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1638 scripts/config.py full
1639 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1640 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1641 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001642 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001643
1644 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1645 make test
1646
1647 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1648 tests/ssl-opt.sh -f 'Default\|opaque'
1649}
1650
Gilles Peskine801c4332023-04-28 21:04:28 +02001651component_test_psa_inject_entropy () {
1652 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1653 scripts/config.py full
1654 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1655 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1656 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1657 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1658 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1659 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001660 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 +02001661
1662 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1663 make test
1664}
1665
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001666component_test_sw_inet_pton () {
1667 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1668
1669 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1670 scripts/config.py set MBEDTLS_TEST_HOOKS
1671 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1672
1673 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1674 make test
1675}
1676
Valerio Settia41654d2024-02-08 10:33:11 +01001677component_full_no_pkparse_pkwrite() {
1678 msg "build: full without pkparse and pkwrite"
1679
1680 scripts/config.py crypto_full
1681 scripts/config.py unset MBEDTLS_PK_PARSE_C
1682 scripts/config.py unset MBEDTLS_PK_WRITE_C
1683
Valerio Settia41654d2024-02-08 10:33:11 +01001684 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1685
1686 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1687 not grep mbedtls_pk_parse_key library/pkparse.o
1688 not grep mbedtls_pk_write_key_der library/pkwrite.o
1689
1690 msg "test: full without pkparse and pkwrite"
1691 make test
1692}
1693
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001694component_test_crypto_full_md_light_only () {
1695 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001696 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001697 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001698 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001699 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001700 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001701 scripts/config.py unset MBEDTLS_HKDF_C
1702 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001703 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001704 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001705 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001706 # Disable things that would auto-enable MD_C
1707 scripts/config.py unset MBEDTLS_PKCS5_C
1708
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001709 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1710 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001711 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001712
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001713 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001714 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001715 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001716
1717 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001718 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001719}
1720
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001721component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001722 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001723 scripts/config.py full
1724 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001725 # Don't pull in cipher via PSA mechanisms
1726 # (currently ignored anyway because we completely disable PSA)
1727 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001728 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001729 scripts/config.py unset MBEDTLS_CMAC_C
1730 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001731 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001732 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001733 scripts/config.py unset MBEDTLS_SSL_TLS_C
1734 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001735 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001736 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1737 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001738 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001739 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001740 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001741
Valerio Settidf17a102023-10-23 14:14:19 +02001742 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001743 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001744}
1745
Valerio Setti7e710e82023-08-25 09:14:15 +02001746# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001747# - component_test_full_no_cipher_with_psa_crypto
1748# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001749# It accepts 2 input parameters:
1750# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1751# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001752common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001753 USE_CRYPTO_CONFIG="$1"
1754 COMPONENT_DESCRIPTION="$2"
1755
1756 msg "build: $COMPONENT_DESCRIPTION"
1757
1758 scripts/config.py full
1759 scripts/config.py unset MBEDTLS_CIPHER_C
1760
1761 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001762 # The built-in implementation of the following algs/key-types depends
1763 # on CIPHER_C so we disable them.
1764 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1765 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001766 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001767 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1768 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1769 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1770 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1771 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1772 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1773 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
Ronald Crona33a8242024-05-15 18:31:17 +02001774 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti7e710e82023-08-25 09:14:15 +02001775 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001776 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001777 else
1778 # Don't pull in cipher via PSA mechanisms
1779 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001780 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1781 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1782 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001783 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001784 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001785 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001786 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001787
Gilles Peskine21570cf2023-12-22 11:49:50 +01001788 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001789
Valerio Setti7e710e82023-08-25 09:14:15 +02001790 # Ensure that CIPHER_C was not re-enabled
1791 not grep mbedtls_cipher_init library/cipher.o
1792
1793 msg "test: $COMPONENT_DESCRIPTION"
1794 make test
1795}
1796
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001797component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001798 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001799}
1800
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001801component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001802 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001803}
1804
Valerio Settibdfecb62023-11-07 15:37:20 +01001805component_test_full_no_ccm() {
1806 msg "build: full no PSA_WANT_ALG_CCM"
1807
1808 # Full config enables:
1809 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1810 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1811 scripts/config.py full
1812
1813 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1814 # enabled, but not used from TLS since USE_PSA is set.
1815 # This is helpful to ensure that TLS tests below have proper dependencies.
1816 #
1817 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1818 # PSA_WANT_ALG_CCM to be re-enabled.
1819 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1820
Gilles Peskine21570cf2023-12-22 11:49:50 +01001821 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001822
1823 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001824 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001825}
1826
1827component_test_full_no_ccm_star_no_tag() {
1828 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1829
1830 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1831 scripts/config.py full
1832
1833 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1834 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1835 # This basically disables all unauthenticated ciphers on the PSA side, while
1836 # keeping AEADs enabled.
1837 #
1838 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1839 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1840 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1841 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1842 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1843 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1844 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1845 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1846 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1847 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1848
Gilles Peskine21570cf2023-12-22 11:49:50 +01001849 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001850
1851 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001852 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001853
1854 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001855 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001856}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001857
Valerio Settie1655b82023-01-03 15:35:25 +01001858component_test_full_no_bignum () {
1859 msg "build: full minus bignum"
1860 scripts/config.py full
1861 scripts/config.py unset MBEDTLS_BIGNUM_C
1862 # Direct dependencies of bignum
1863 scripts/config.py unset MBEDTLS_ECP_C
1864 scripts/config.py unset MBEDTLS_RSA_C
1865 scripts/config.py unset MBEDTLS_DHM_C
1866 # Direct dependencies of ECP
1867 scripts/config.py unset MBEDTLS_ECDH_C
1868 scripts/config.py unset MBEDTLS_ECDSA_C
1869 scripts/config.py unset MBEDTLS_ECJPAKE_C
1870 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001871 # Disable what auto-enables ECP_LIGHT
1872 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1873 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001874 # Indirect dependencies of ECP
1875 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1876 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1877 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1878 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1879 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1880 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1881 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1882 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1883 # Direct dependencies of DHM
1884 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1885 # Direct dependencies of RSA
1886 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1887 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1888 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1889 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1890 # PK and its dependencies
1891 scripts/config.py unset MBEDTLS_PK_C
1892 scripts/config.py unset MBEDTLS_PK_PARSE_C
1893 scripts/config.py unset MBEDTLS_PK_WRITE_C
1894 scripts/config.py unset MBEDTLS_X509_USE_C
1895 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1896 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1897 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1898 scripts/config.py unset MBEDTLS_X509_CREATE_C
1899 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1900 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1901 scripts/config.py unset MBEDTLS_PKCS7_C
1902 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1903 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1904 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1905
Gilles Peskine21570cf2023-12-22 11:49:50 +01001906 make
Valerio Settie1655b82023-01-03 15:35:25 +01001907
1908 msg "test: full minus bignum"
1909 make test
1910}
1911
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001912component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001913 msg "build: default with only stream cipher"
1914
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001915 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001916 scripts/config.py unset MBEDTLS_GCM_C
1917 scripts/config.py unset MBEDTLS_CCM_C
1918 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001919 #Disable TLS 1.3 (as no AEAD)
1920 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001921 # 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 +02001922 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001923 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001924 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001925 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1926 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001927 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001928 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001929 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001930
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001931 make
1932
1933 msg "test: default with only stream cipher"
1934 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001935
1936 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001937}
1938
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001939component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001940 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001941
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001942 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001943 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001944 scripts/config.py unset MBEDTLS_GCM_C
1945 scripts/config.py unset MBEDTLS_CCM_C
1946 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001947 #Disable TLS 1.3 (as no AEAD)
1948 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001949 # 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 +02001950 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001951 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001952 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001953 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1954 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001955 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001956 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001957 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001958
Przemek Stekiel9550c052022-09-28 09:51:55 +02001959 make
1960
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001961 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001962 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001963
1964 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001965}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001966
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001967component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001968 msg "build: default with only CBC-legacy cipher"
1969
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001970 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001971 scripts/config.py unset MBEDTLS_GCM_C
1972 scripts/config.py unset MBEDTLS_CCM_C
1973 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001974 #Disable TLS 1.3 (as no AEAD)
1975 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001976 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1977 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1978 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001979 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001980 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001981 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001982 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001983 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001984 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001985
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001986 make
1987
1988 msg "test: default with only CBC-legacy cipher"
1989 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001990
1991 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1992 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001993}
1994
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001995component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001996 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001997
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001998 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001999 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002000 scripts/config.py unset MBEDTLS_GCM_C
2001 scripts/config.py unset MBEDTLS_CCM_C
2002 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002003 #Disable TLS 1.3 (as no AEAD)
2004 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002005 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2006 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2007 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002008 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002009 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002010 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002011 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002012 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002013 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002014
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002015 make
2016
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002017 msg "test: default with only CBC-legacy cipher use psa"
2018 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002019
2020 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
2021 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002022}
2023
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002024component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002025 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
2026
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002027 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002028 scripts/config.py unset MBEDTLS_GCM_C
2029 scripts/config.py unset MBEDTLS_CCM_C
2030 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002031 #Disable TLS 1.3 (as no AEAD)
2032 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002033 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2034 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2035 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2036 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2037 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002038 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002039 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002040 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002041 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002042
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002043 make
2044
2045 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
2046 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002047
2048 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
2049 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002050}
2051
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002052component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
2053 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002054
2055 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002056 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002057 scripts/config.py unset MBEDTLS_GCM_C
2058 scripts/config.py unset MBEDTLS_CCM_C
2059 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002060 #Disable TLS 1.3 (as no AEAD)
2061 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002062 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2063 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2064 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2065 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2066 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002067 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002068 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002069 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002070 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002071
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002072 make
2073
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002074 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002075 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002076
2077 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2078 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002079}
2080
Valerio Setti9f0ec532022-11-08 13:03:24 +01002081# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2082# that we could use for interop testing. However, we now have sort of two
2083# implementations ourselves: one using PSA, the other not. At least test that
2084# these two interoperate with each other.
2085component_test_tls1_2_ecjpake_compatibility() {
2086 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2087 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002088 # Explicitly make lib first to avoid a race condition:
2089 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2090 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002091 make -C programs ssl/ssl_server2 ssl/ssl_client2
2092 cp programs/ssl/ssl_server2 s2_no_use_psa
2093 cp programs/ssl/ssl_client2 c2_no_use_psa
2094
2095 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2096 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2097 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002098 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002099 make -C programs ssl/ssl_server2 ssl/ssl_client2
2100 make -C programs test/udp_proxy test/query_compile_time_config
2101
Valerio Setti70e02902022-12-02 16:21:56 +01002102 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2103 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2104 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2105 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2106 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2107 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2108 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2109 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 +01002110
2111 rm s2_no_use_psa c2_no_use_psa
2112}
2113
Gilles Peskine636c26a2020-03-04 20:46:15 +01002114component_test_everest () {
2115 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2116 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2117 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2118 make
2119
2120 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2121 make test
2122
Gilles Peskine6848d172023-11-02 19:58:03 +01002123 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002124 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002125
Gilles Peskine636c26a2020-03-04 20:46:15 +01002126 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2127 tests/ssl-opt.sh -f ECDH
2128
2129 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2130 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002131 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002132}
2133
Gilles Peskined3beca92020-07-03 00:15:37 +02002134component_test_everest_curve25519_only () {
2135 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002136 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2137 scripts/config.py unset MBEDTLS_ECDSA_C
2138 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2139 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002140 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002141 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002142 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002143 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2144
Dave Rodgman17127e92023-12-14 16:42:48 +00002145 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002146
2147 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2148 make test
2149}
2150
Gilles Peskine8f073122018-11-27 15:58:47 +01002151component_test_small_ssl_out_content_len () {
2152 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002153 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2154 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002155 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002156 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002157
Gilles Peskine8f073122018-11-27 15:58:47 +01002158 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002159 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002160}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002161
Gilles Peskine8f073122018-11-27 15:58:47 +01002162component_test_small_ssl_in_content_len () {
2163 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002164 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2165 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002166 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002167 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002168
Gilles Peskine8f073122018-11-27 15:58:47 +01002169 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002170 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002171}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002172
Gilles Peskine8f073122018-11-27 15:58:47 +01002173component_test_small_ssl_dtls_max_buffering () {
2174 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002175 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002176 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002177 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002178
Gilles Peskine8f073122018-11-27 15:58:47 +01002179 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002180 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 +01002181}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002182
Gilles Peskine8f073122018-11-27 15:58:47 +01002183component_test_small_mbedtls_ssl_dtls_max_buffering () {
2184 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002185 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002186 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002187 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002188
Gilles Peskine8f073122018-11-27 15:58:47 +01002189 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002190 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002191}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002192
Gilles Peskine75cc7712019-09-06 19:47:17 +02002193component_test_psa_collect_statuses () {
2194 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002195 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002196 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002197 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002198 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002199 rm -f tests/statuses.log
2200}
2201
Gilles Peskine8f073122018-11-27 15:58:47 +01002202component_test_full_cmake_clang () {
2203 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002204 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002205 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 +01002206 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002207
k-stachowiak0291cb72019-06-26 15:52:12 +02002208 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002209 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002210
Gilles Peskineda6017c2022-10-30 21:02:40 +01002211 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2212 programs/test/cpp_dummy_build
2213
Gilles Peskine6848d172023-11-02 19:58:03 +01002214 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002215 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002216
Gilles Peskine82b27272019-06-14 18:27:03 +02002217 msg "program demos (full config, clang)" # ~10s
2218 tests/scripts/run_demos.py
2219
k-stachowiak0291cb72019-06-26 15:52:12 +02002220 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002221 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002222
Gilles Peskine8f073122018-11-27 15:58:47 +01002223 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002224 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002225}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002226
Gilles Peskine0c671602022-11-29 16:01:41 +01002227skip_suites_without_constant_flow () {
2228 # Skip the test suites that don't have any constant-flow annotations.
2229 # This will need to be adjusted if we ever start declaring things as
2230 # secret from macros or functions inside tests/include or tests/src.
2231 SKIP_TEST_SUITES=$(
2232 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2233 sed 's/test_suite_//; s/\.function$//' |
2234 tr '\n' ,)
2235 export SKIP_TEST_SUITES
2236}
2237
Dave Rodgman246210e2023-07-31 18:07:44 +01002238skip_all_except_given_suite () {
2239 # Skip all but the given test suite
2240 SKIP_TEST_SUITES=$(
2241 ls -1 tests/suites/test_suite_*.function |
2242 grep -v $1.function |
2243 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2244 tr '\n' ,)
2245 export SKIP_TEST_SUITES
2246}
2247
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002248component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002249 # This tests both (1) accesses to undefined memory, and (2) branches or
2250 # memory access depending on secret values. To distinguish between those:
2251 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2252 # - or alternatively, change the build type to MemSanDbg, which enables
2253 # origin tracking and nicer stack traces (which are useful for debugging
2254 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002255 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2256 scripts/config.py full
2257 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2258 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2259 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2260 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2261 make
2262
2263 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2264 make test
2265}
2266
2267component_test_memsan_constant_flow_psa () {
2268 # This tests both (1) accesses to undefined memory, and (2) branches or
2269 # memory access depending on secret values. To distinguish between those:
2270 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2271 # - or alternatively, change the build type to MemSanDbg, which enables
2272 # origin tracking and nicer stack traces (which are useful for debugging
2273 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002274 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002275 scripts/config.py full
2276 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2277 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2278 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2279 make
2280
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002281 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002282 make test
2283}
2284
Bence Szépkúti0354d042023-12-06 16:14:37 +01002285component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002286 # This tests both (1) everything that valgrind's memcheck usually checks
2287 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2288 # etc.) and (2) branches or memory access depending on secret values,
2289 # which will be reported as uninitialized memory. To distinguish between
2290 # secret and actually uninitialized:
2291 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2292 # - or alternatively, build with debug info and manually run the offending
2293 # test suite with valgrind --track-origins=yes, then check if the origin
2294 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002295 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2296 scripts/config.py full
2297 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2298 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002299 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002300 cmake -D CMAKE_BUILD_TYPE:String=Release .
2301 make
2302
2303 # this only shows a summary of the results (how many of each type)
2304 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002305 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002306 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002307
2308 # Test asm path in constant time module - by default, it will test the plain C
2309 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2310 msg "test: valgrind asm constant_time"
2311 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2312 skip_all_except_given_suite test_suite_constant_time
2313 cmake -D CMAKE_BUILD_TYPE:String=Release .
2314 make clean
2315 make
2316 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002317}
2318
Bence Szépkúti0354d042023-12-06 16:14:37 +01002319component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002320 # This tests both (1) everything that valgrind's memcheck usually checks
2321 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2322 # etc.) and (2) branches or memory access depending on secret values,
2323 # which will be reported as uninitialized memory. To distinguish between
2324 # secret and actually uninitialized:
2325 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2326 # - or alternatively, build with debug info and manually run the offending
2327 # test suite with valgrind --track-origins=yes, then check if the origin
2328 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002329 msg "build: cmake release GCC, full config with constant flow testing"
2330 scripts/config.py full
2331 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002332 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002333 cmake -D CMAKE_BUILD_TYPE:String=Release .
2334 make
2335
2336 # this only shows a summary of the results (how many of each type)
2337 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002338 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002339 make memcheck
2340}
2341
Janos Follath9338cac2023-10-04 18:55:39 +01002342component_test_tsan () {
2343 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002344 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002345 scripts/config.py set MBEDTLS_THREADING_C
2346 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002347 # Self-tests do not currently use multiple threads.
2348 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002349
Ryan6caf84f2024-03-05 13:57:00 +00002350 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2351 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2352
Janos Follath9338cac2023-10-04 18:55:39 +01002353 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2354 make
2355
2356 msg "test: main suites (TSan)"
2357 make test
2358}
2359
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002360component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002361 # Test that removing the deprecated features from the default
2362 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002363 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2364 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002365 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002366
2367 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2368 make test
2369}
2370
2371component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002372 msg "build: make, full_no_deprecated config" # ~ 30s
2373 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002374 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002375
Gilles Peskine30de2e82020-04-20 21:39:22 +02002376 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002377 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002378
2379 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2380 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002381}
2382
Gilles Peskine8386ea22020-04-30 09:07:29 +02002383component_test_full_no_deprecated_deprecated_warning () {
2384 # Test that there is nothing deprecated in "full_no_deprecated".
2385 # A deprecated feature would trigger a warning (made fatal) from
2386 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002387 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2388 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002389 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2390 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002391 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002392
Gilles Peskine30de2e82020-04-20 21:39:22 +02002393 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002394 make test
2395}
2396
Gilles Peskine8386ea22020-04-30 09:07:29 +02002397component_test_full_deprecated_warning () {
2398 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2399 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002400 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002401 scripts/config.py full
2402 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002403 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002404 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2405 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002406 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002407
Gilles Peskine8386ea22020-04-30 09:07:29 +02002408 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2409 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2410 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002411 # Expect warnings from '#warning' directives in check_config.h and
2412 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002413 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 +01002414
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002415 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2416 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002417
2418 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2419 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002420}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002421
Gilles Peskineec541fe2020-01-31 14:24:14 +01002422# Check that the specified libraries exist and are empty.
2423are_empty_libraries () {
2424 nm "$@" >/dev/null 2>/dev/null
2425 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2426}
2427
2428component_build_crypto_default () {
2429 msg "build: make, crypto only"
2430 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002431 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002432 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002433}
2434
2435component_build_crypto_full () {
2436 msg "build: make, crypto only, full config"
2437 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002438 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002439 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002440}
2441
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002442component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002443 msg "build: make, config for PSA crypto service"
2444 scripts/config.py crypto
2445 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2446 # Disable things that are not needed for just cryptography, to
2447 # reach a configuration that would be typical for a PSA cryptography
2448 # service providing all implemented PSA algorithms.
2449 # System stuff
2450 scripts/config.py unset MBEDTLS_ERROR_C
2451 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002452 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002453 # Crypto stuff with no PSA interface
2454 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002455 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002456 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002457 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002458 scripts/config.py unset MBEDTLS_NIST_KW_C
2459 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2460 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2461 scripts/config.py unset MBEDTLS_PKCS12_C
2462 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002463 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2464 # in PSA code to work with RSA keys. We don't require users to set those:
2465 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002466 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002467 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002468 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002469 make CFLAGS='-O1 -Werror' all test
2470 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2471}
2472
Gilles Peskineec541fe2020-01-31 14:24:14 +01002473component_build_crypto_baremetal () {
2474 msg "build: make, crypto only, baremetal config"
2475 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002476 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002477 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002478}
Daniel Axtens446af202020-09-02 21:30:13 +10002479support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002480 support_build_baremetal "$@"
2481}
2482
2483component_build_baremetal () {
2484 msg "build: make, baremetal config"
2485 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002486 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002487}
2488support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002489 # Older Glibc versions include time.h from other headers such as stdlib.h,
2490 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2491 # problem, Ubuntu 18.04 is ok.
2492 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2493}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002494
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002495# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002496component_test_depends_py_cipher_id () {
2497 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002498 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002499}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002500
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002501component_test_depends_py_cipher_chaining () {
2502 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002503 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002504}
2505
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002506component_test_depends_py_cipher_padding () {
2507 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002508 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002509}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002510
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002511component_test_depends_py_curves () {
2512 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002513 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002514}
2515
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002516component_test_depends_py_hashes () {
2517 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002518 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002519}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002520
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002521component_test_depends_py_kex () {
2522 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002523 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002524}
2525
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002526component_test_depends_py_pkalgs () {
2527 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002528 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002529}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002530
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002531# PSA equivalents of the depends.py tests
2532component_test_depends_py_cipher_id_psa () {
2533 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002534 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002535}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002536
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002537component_test_depends_py_cipher_chaining_psa () {
2538 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002539 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002540}
2541
2542component_test_depends_py_cipher_padding_psa () {
2543 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002544 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002545}
2546
2547component_test_depends_py_curves_psa () {
2548 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002549 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002550}
2551
2552component_test_depends_py_hashes_psa () {
2553 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002554 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002555}
2556
2557component_test_depends_py_kex_psa () {
2558 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002559 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002560}
2561
2562component_test_depends_py_pkalgs_psa () {
2563 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002564 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002565}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002566
Valerio Setti6bed64e2024-01-17 15:21:44 +01002567component_test_psa_crypto_config_ffdh_2048_only () {
2568 msg "build: full config - only DH 2048"
2569
2570 scripts/config.py full
2571
2572 # Disable all DH groups other than 2048.
2573 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2574 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2575 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2576 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2577
2578 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2579
2580 msg "test: full config - only DH 2048"
2581 make test
2582
2583 msg "ssl-opt: full config - only DH 2048"
2584 tests/ssl-opt.sh -f "ffdh"
2585}
2586
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002587component_build_no_pk_rsa_alt_support () {
2588 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2589
2590 scripts/config.py full
2591 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2592 scripts/config.py set MBEDTLS_RSA_C
2593 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2594
2595 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002596 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002597}
2598
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002599component_build_module_alt () {
2600 msg "build: MBEDTLS_XXX_ALT" # ~30s
2601 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002602
2603 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002604 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2605 scripts/config.py unset MBEDTLS_AESNI_C
2606 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002607 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002608 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2609 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002610 # You can only have one threading implementation: alt or pthread, not both.
2611 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002612 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2613 # directly and assumes the implementation works with partial groups.
2614 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002615 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2616 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2617 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002618 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2619 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2620 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002621
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002622 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2623 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2624 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002625 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002626
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002627 # We can only compile, not link, since we don't have any implementations
2628 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002629 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002630}
2631
2632component_build_dhm_alt () {
2633 msg "build: MBEDTLS_DHM_ALT" # ~30s
2634 scripts/config.py full
2635 scripts/config.py set MBEDTLS_DHM_ALT
2636 # debug.c currently references mbedtls_dhm_context fields directly.
2637 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002638 # We can only compile, not link, since we don't have any implementations
2639 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002640 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002641}
2642
Gilles Peskine64996c32024-01-23 20:25:47 +01002643component_test_no_psa_crypto_full_cmake_asan() {
2644 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2645 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002646 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002647 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002648 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002649 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002650 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002651 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002652 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002653 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002654 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002655 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002656 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002657 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002658
Gilles Peskine64996c32024-01-23 20:25:47 +01002659 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002660 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002661
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002662 # Note: ssl-opt.sh has some test cases that depend on
2663 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2664 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002665 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002666 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002667
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002668 # Note: the next two invocations cover all compat.sh test cases.
2669 # We should use the same here and in basic-build-test.sh.
2670 msg "test: compat.sh: default version (full minus PSA crypto)"
2671 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002672
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002673 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002674 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002675}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002676
Ronald Cron403c15c2021-09-13 09:38:05 +02002677component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002678 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002679
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002680 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002681 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002682 $(helper_get_psa_key_type_list "ECC") \
2683 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002684
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002685 # Configure
2686 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002687
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002688 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002689 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002690
2691 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002692 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002693
2694 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002695 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2696 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2697
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002698 # Build
2699 # -----
2700
2701 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002702 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2703 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002704
2705 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2706
Valerio Setti3fe105b2023-10-30 11:08:12 +01002707 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002708
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002709 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002710 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002711
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002712 # Run the tests
2713 # -------------
2714
Ronald Cron403c15c2021-09-13 09:38:05 +02002715 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2716 make test
2717}
2718
Valerio Setti44b178c2023-03-22 14:02:57 +01002719component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002720 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002721
2722 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002723 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002724 $(helper_get_psa_key_type_list "ECC") \
2725 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002726
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002727 # Configure
2728 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002729
Ronald Cron46ac0652024-03-18 12:39:04 +01002730 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002731 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002732
Valerio Setti44b178c2023-03-22 14:02:57 +01002733 # Disable the module that's accelerated
2734 scripts/config.py unset MBEDTLS_ECDH_C
2735
2736 # Disable things that depend on it
2737 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2738 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2739 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2740 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2741 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2742
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002743 # Build
2744 # -----
2745
2746 helper_libtestdriver1_make_drivers "$loc_accel_list"
2747
Valerio Setti3fe105b2023-10-30 11:08:12 +01002748 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002749
Valerio Setti44b178c2023-03-22 14:02:57 +01002750 # Make sure this was not re-enabled by accident (additive config)
2751 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002752
2753 # Run the tests
2754 # -------------
2755
Valerio Setti44b178c2023-03-22 14:02:57 +01002756 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002757 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002758}
2759
Przemek Stekieldccb2022023-05-11 10:48:50 +02002760component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002761 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002762
2763 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002764 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002765 $(helper_get_psa_key_type_list "DH") \
2766 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002767
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002768 # Configure
2769 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002770
Przemek Stekiel565353e2023-07-05 11:07:07 +02002771 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002772 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002773
2774 # Disable the module that's accelerated
2775 scripts/config.py unset MBEDTLS_DHM_C
2776
2777 # Disable things that depend on it
2778 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2779 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2780
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002781 # Build
2782 # -----
2783
2784 helper_libtestdriver1_make_drivers "$loc_accel_list"
2785
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002786 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002787
2788 # Make sure this was not re-enabled by accident (additive config)
2789 not grep mbedtls_dhm_ library/dhm.o
2790
2791 # Run the tests
2792 # -------------
2793
Gilles Peskine14302ed2023-07-19 19:30:04 +02002794 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002795 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002796
Gilles Peskine14302ed2023-07-19 19:30:04 +02002797 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002798 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002799}
2800
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002801component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002802 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002803
2804 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002805 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002806
2807 # Disable things that are not supported
2808 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2809 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002810 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002811
Gilles Peskine14302ed2023-07-19 19:30:04 +02002812 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002813 make test
2814
Gilles Peskine14302ed2023-07-19 19:30:04 +02002815 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002816 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002817}
2818
Valerio Setti44b178c2023-03-22 14:02:57 +01002819component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002820 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002821
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002822 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002823 $(helper_get_psa_key_type_list "ECC") \
2824 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002825
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002826 # Configure
2827 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002828
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002829 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002830
2831 # Make built-in fallback not available
2832 scripts/config.py unset MBEDTLS_ECJPAKE_C
2833 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2834
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002835 # Build
2836 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002837
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002838 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002839
Valerio Setti3fe105b2023-10-30 11:08:12 +01002840 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002841
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002842 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002843 not grep mbedtls_ecjpake_init library/ecjpake.o
2844
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002845 # Run the tests
2846 # -------------
2847
Gilles Peskine14302ed2023-07-19 19:30:04 +02002848 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002849 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002850}
2851
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002852component_test_psa_crypto_config_accel_ecc_some_key_types () {
2853 msg "build: full with accelerated EC algs and some key types"
2854
2855 # Algorithms and key types to accelerate
2856 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2857 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2858 ALG_ECDH \
2859 ALG_JPAKE \
2860 KEY_TYPE_ECC_PUBLIC_KEY \
2861 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2862 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002863 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2864 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002865
2866 # Configure
2867 # ---------
2868
2869 # start with config full for maximum coverage (also enables USE_PSA)
2870 helper_libtestdriver1_adjust_config "full"
2871
2872 # Disable modules that are accelerated - some will be re-enabled
2873 scripts/config.py unset MBEDTLS_ECDSA_C
2874 scripts/config.py unset MBEDTLS_ECDH_C
2875 scripts/config.py unset MBEDTLS_ECJPAKE_C
2876 scripts/config.py unset MBEDTLS_ECP_C
2877
2878 # Disable all curves - those that aren't accelerated should be re-enabled
2879 helper_disable_builtin_curves
2880
2881 # Restartable feature is not yet supported by PSA. Once it will in
2882 # the future, the following line could be removed (see issues
2883 # 6061, 6332 and following ones)
2884 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2885
2886 # this is not supported by the driver API yet
2887 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2888
2889 # Build
2890 # -----
2891
2892 # These hashes are needed for some ECDSA signature tests.
2893 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2894 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2895 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2896
Valerio Setti3fe105b2023-10-30 11:08:12 +01002897 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002898
2899 # ECP should be re-enabled but not the others
2900 not grep mbedtls_ecdh_ library/ecdh.o
2901 not grep mbedtls_ecdsa library/ecdsa.o
2902 not grep mbedtls_ecjpake library/ecjpake.o
2903 grep mbedtls_ecp library/ecp.o
2904
2905 # Run the tests
2906 # -------------
2907
2908 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002909 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002910}
2911
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002912# Run tests with only (non-)Weierstrass accelerated
2913# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002914# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2915# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002916common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002917 weierstrass=$1
2918 if [ $weierstrass -eq 1 ]; then
2919 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002920 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002921 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002922 fi
2923
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002924 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002925
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002926 # Note: Curves are handled in a special way by the libtestdriver machinery,
2927 # so we only want to include them in the accel list when building the main
2928 # libraries, hence the use of a separate variable.
2929 # Note: the following loop is a modified version of
2930 # helper_get_psa_curve_list that only keeps Weierstrass families.
2931 loc_weierstrass_list=""
2932 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002933 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2934 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002935 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002936 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002937 ;;
2938 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002939 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002940 ;;
2941 esac
2942 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002943 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002944 loc_curve_list=$loc_weierstrass_list
2945 else
2946 loc_curve_list=$loc_non_weierstrass_list
2947 fi
2948
Valerio Setti3fe105b2023-10-30 11:08:12 +01002949 # Algorithms and key types to accelerate
2950 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2951 ALG_ECDH \
2952 ALG_JPAKE \
2953 $(helper_get_psa_key_type_list "ECC") \
2954 $loc_curve_list"
2955
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002956 # Configure
2957 # ---------
2958
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002959 # Start with config crypto_full and remove PK_C:
2960 # that's what's supported now, see docs/driver-only-builds.md.
2961 helper_libtestdriver1_adjust_config "crypto_full"
2962 scripts/config.py unset MBEDTLS_PK_C
2963 scripts/config.py unset MBEDTLS_PK_PARSE_C
2964 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002965
2966 # Disable modules that are accelerated - some will be re-enabled
2967 scripts/config.py unset MBEDTLS_ECDSA_C
2968 scripts/config.py unset MBEDTLS_ECDH_C
2969 scripts/config.py unset MBEDTLS_ECJPAKE_C
2970 scripts/config.py unset MBEDTLS_ECP_C
2971
2972 # Disable all curves - those that aren't accelerated should be re-enabled
2973 helper_disable_builtin_curves
2974
2975 # Restartable feature is not yet supported by PSA. Once it will in
2976 # the future, the following line could be removed (see issues
2977 # 6061, 6332 and following ones)
2978 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2979
2980 # this is not supported by the driver API yet
2981 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2982
2983 # Build
2984 # -----
2985
2986 # These hashes are needed for some ECDSA signature tests.
2987 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2988 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2989 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2990
Valerio Settiac7a8092023-10-31 12:23:44 +01002991 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002992
2993 # We expect ECDH to be re-enabled for the missing curves
2994 grep mbedtls_ecdh_ library/ecdh.o
2995 # We expect ECP to be re-enabled, however the parts specific to the
2996 # families of curves that are accelerated should be ommited.
2997 # - functions with mxz in the name are specific to Montgomery curves
2998 # - ecp_muladd is specific to Weierstrass curves
2999 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003000 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003001 not grep mbedtls_ecp_muladd library/ecp.o
3002 grep mxz library/ecp.o
3003 else
3004 grep mbedtls_ecp_muladd library/ecp.o
3005 not grep mxz library/ecp.o
3006 fi
3007 # We expect ECDSA and ECJPAKE to be re-enabled only when
3008 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003009 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003010 not grep mbedtls_ecdsa library/ecdsa.o
3011 not grep mbedtls_ecjpake library/ecjpake.o
3012 else
3013 grep mbedtls_ecdsa library/ecdsa.o
3014 grep mbedtls_ecjpake library/ecjpake.o
3015 fi
3016
3017 # Run the tests
3018 # -------------
3019
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02003020 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
3021 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003022}
3023
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02003024component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003025 common_test_psa_crypto_config_accel_ecc_some_curves 1
3026}
3027
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02003028component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003029 common_test_psa_crypto_config_accel_ecc_some_curves 0
3030}
3031
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01003032# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
3033# ECDH, ECDSA) with and without drivers.
3034# The input parameter is a boolean value which indicates:
3035# - 0 keep built-in EC algs,
3036# - 1 exclude built-in EC algs (driver only).
3037#
3038# This is used by the two following components to ensure they always use the
3039# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003040# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
3041# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01003042# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003043config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003044 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01003045 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003046 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003047 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01003048 # Disable modules that are accelerated
3049 scripts/config.py unset MBEDTLS_ECDSA_C
3050 scripts/config.py unset MBEDTLS_ECDH_C
3051 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02003052 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01003053 fi
3054
3055 # Restartable feature is not yet supported by PSA. Once it will in
3056 # the future, the following line could be removed (see issues
3057 # 6061, 6332 and following ones)
3058 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003059}
3060
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003061# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3062component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003063 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003064
3065 # Algorithms and key types to accelerate
3066 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3067 ALG_ECDH \
3068 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003069 $(helper_get_psa_key_type_list "ECC") \
3070 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003071
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003072 # Configure
3073 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003074
3075 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003076 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003077
Valerio Setti0a342c92023-09-01 09:12:31 +02003078 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003079 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3080 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003081
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003082 # Build
3083 # -----
3084
3085 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003086 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3087 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003088 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3089
Valerio Setti3fe105b2023-10-30 11:08:12 +01003090 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003091
3092 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3093 not grep mbedtls_ecdsa_ library/ecdsa.o
3094 not grep mbedtls_ecdh_ library/ecdh.o
3095 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003096 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003097
3098 # Run the tests
3099 # -------------
3100
Gilles Peskine14302ed2023-07-19 19:30:04 +02003101 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003102 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003103
Gilles Peskine14302ed2023-07-19 19:30:04 +02003104 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003105 tests/ssl-opt.sh
3106}
3107
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003108# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3109component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003110 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003111
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003112 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003113
Gilles Peskine21570cf2023-12-22 11:49:50 +01003114 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003115
Gilles Peskine14302ed2023-07-19 19:30:04 +02003116 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003117 make test
3118
Gilles Peskine14302ed2023-07-19 19:30:04 +02003119 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003120 tests/ssl-opt.sh
3121}
3122
Valerio Settie618cb02023-04-12 14:59:16 +02003123# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003124# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3125# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003126# to ensure that both tests use the same underlying configuration when testing
3127# driver's coverage with analyze_outcomes.py.
3128#
3129# This functions accepts 1 boolean parameter as follows:
3130# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3131# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3132# - 0: include built-in implementation of EC algorithms.
3133#
3134# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3135# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003136config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003137 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003138 # start with full config for maximum coverage (also enables USE_PSA)
3139 helper_libtestdriver1_adjust_config "full"
3140
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003141 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003142 # Disable modules that are accelerated
3143 scripts/config.py unset MBEDTLS_ECDSA_C
3144 scripts/config.py unset MBEDTLS_ECDH_C
3145 scripts/config.py unset MBEDTLS_ECJPAKE_C
3146 # Disable ECP module (entirely)
3147 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003148 fi
3149
Valerio Settiaecd32c2023-06-14 10:42:31 +02003150 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3151 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003152 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003153 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003154
Valerio Settie618cb02023-04-12 14:59:16 +02003155 # Restartable feature is not yet supported by PSA. Once it will in
3156 # the future, the following line could be removed (see issues
3157 # 6061, 6332 and following ones)
3158 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003159}
3160
3161# Build and test a configuration where driver accelerates all EC algs while
3162# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3163# side.
3164#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003165# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3166component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003167 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003168
3169 # Algorithms and key types to accelerate
3170 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3171 ALG_ECDH \
3172 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003173 $(helper_get_psa_key_type_list "ECC") \
3174 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003175
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003176 # Configure
3177 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003178
Valerio Settie618cb02023-04-12 14:59:16 +02003179 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003180 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003181 # Disable all the builtin curves. All the required algs are accelerated.
3182 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003183
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003184 # Build
3185 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003186
3187 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003188 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3189 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3190 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003191
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003192 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003193
Valerio Setti3fe105b2023-10-30 11:08:12 +01003194 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003195
3196 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3197 not grep mbedtls_ecdsa_ library/ecdsa.o
3198 not grep mbedtls_ecdh_ library/ecdh.o
3199 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003200 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003201 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003202
3203 # Run the tests
3204 # -------------
3205
Gilles Peskine14302ed2023-07-19 19:30:04 +02003206 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003207 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003208
Gilles Peskine14302ed2023-07-19 19:30:04 +02003209 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003210 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003211}
3212
3213# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003214# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003215# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003216component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003217 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003218
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003219 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003220
Gilles Peskine21570cf2023-12-22 11:49:50 +01003221 make
Valerio Settie618cb02023-04-12 14:59:16 +02003222
Gilles Peskine14302ed2023-07-19 19:30:04 +02003223 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003224 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003225
Gilles Peskine14302ed2023-07-19 19:30:04 +02003226 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003227 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003228}
3229
Valerio Setti4e2f2442023-08-15 10:10:26 +02003230# This is a common configuration helper used directly from:
3231# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3232# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3233# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003234# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003235# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003236# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003237# - this is the reference component of the above
3238# - it still disables RSA and FFDH, but it uses builtin EC algs
3239# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3240# - accelerate all EC and FFDH algs, disable only RSA
3241# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3242# - this is the reference component of the above
3243# - it still disables RSA, but it uses builtin EC and FFDH algs
3244#
3245# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003246# $1: a boolean value which states if we are testing an accelerated scenario
3247# or not.
3248# $2: a string value which states which components are tested. Allowed values
3249# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003250config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003251 driver_only="$1"
3252 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003253 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003254 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003255
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003256 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003257 # Disable modules that are accelerated
3258 scripts/config.py unset MBEDTLS_ECDSA_C
3259 scripts/config.py unset MBEDTLS_ECDH_C
3260 scripts/config.py unset MBEDTLS_ECJPAKE_C
3261 # Disable ECP module (entirely)
3262 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003263 # Also disable bignum
3264 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003265 fi
3266
3267 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3268 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3269 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3270 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3271
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003272 # RSA support is intentionally disabled on this test because RSA_C depends
3273 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003274 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3275 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 +02003276 scripts/config.py unset MBEDTLS_RSA_C
3277 scripts/config.py unset MBEDTLS_PKCS1_V15
3278 scripts/config.py unset MBEDTLS_PKCS1_V21
3279 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3280 # Also disable key exchanges that depend on RSA
3281 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3282 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3283 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3284 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3285 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3286
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003287 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003288 # When testing ECC only, we disable FFDH support, both from builtin and
3289 # PSA sides, and also disable the key exchanges that depend on DHM.
3290 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3291 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 +01003292 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003293 scripts/config.py unset MBEDTLS_DHM_C
3294 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3295 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3296 else
3297 # When testing ECC and DH instead, we disable DHM and depending key
3298 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003299 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003300 scripts/config.py unset MBEDTLS_DHM_C
3301 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3302 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3303 fi
3304 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003305
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003306 # Restartable feature is not yet supported by PSA. Once it will in
3307 # the future, the following line could be removed (see issues
3308 # 6061, 6332 and following ones)
3309 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3310}
3311
Valerio Setti4e2f2442023-08-15 10:10:26 +02003312# Common helper used by:
3313# - component_test_psa_crypto_config_accel_ecc_no_bignum
3314# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003315#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003316# The goal is to build and test accelerating either:
3317# - ECC only or
3318# - both ECC and FFDH
3319#
3320# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003321# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3322# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003323common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003324 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003325
Valerio Setti5dfaca42023-09-05 08:48:51 +02003326 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003327 if [ "$test_target" = "ECC_DH" ]; then
3328 accel_text="ECC/FFDH"
3329 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003330 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003331 accel_text="ECC"
3332 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003333 fi
3334
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003335 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003336
3337 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003338 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3339 ALG_ECDH \
3340 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003341 $(helper_get_psa_key_type_list "ECC") \
3342 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003343 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003344 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003345 loc_accel_list="$loc_accel_list \
3346 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003347 $(helper_get_psa_key_type_list "DH") \
3348 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003349 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003350
3351 # Configure
3352 # ---------
3353
3354 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003355 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003356 # Disable all the builtin curves. All the required algs are accelerated.
3357 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003358
3359 # Build
3360 # -----
3361
3362 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003363 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3364 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3365 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003366
3367 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3368
Valerio Setti3fe105b2023-10-30 11:08:12 +01003369 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003370
3371 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3372 not grep mbedtls_ecdsa_ library/ecdsa.o
3373 not grep mbedtls_ecdh_ library/ecdh.o
3374 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003375 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003376 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003377 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003378 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003379 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003380
3381 # Run the tests
3382 # -------------
3383
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003384 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003385
Gilles Peskine21570cf2023-12-22 11:49:50 +01003386 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003387
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003388 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003389 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003390}
3391
Valerio Setti4e2f2442023-08-15 10:10:26 +02003392# Common helper used by:
3393# - component_test_psa_crypto_config_reference_ecc_no_bignum
3394# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3395#
3396# The goal is to build and test a reference scenario (i.e. with builtin
3397# components) compared to the ones used in
3398# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3399#
3400# It is meant to be used in conjunction with
3401# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3402# coverage analysis in "analyze_outcomes.py" script.
3403common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003404 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003405
Valerio Setti5dfaca42023-09-05 08:48:51 +02003406 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003407 if [ "$test_target" = "ECC_DH" ]; then
3408 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003409 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003410 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003411 fi
3412
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003413 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003414
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003415 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003416
Gilles Peskine21570cf2023-12-22 11:49:50 +01003417 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003418
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003419 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003420 make test
3421
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003422 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003423 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003424}
3425
Valerio Setti4e2f2442023-08-15 10:10:26 +02003426component_test_psa_crypto_config_accel_ecc_no_bignum () {
3427 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3428}
3429
3430component_test_psa_crypto_config_reference_ecc_no_bignum () {
3431 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3432}
3433
3434component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3435 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3436}
3437
3438component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3439 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3440}
3441
Valerio Settiac6d35f2023-08-04 12:49:11 +02003442# Helper for setting common configurations between:
3443# - component_test_tfm_config_p256m_driver_accel_ec()
3444# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003445common_tfm_config () {
3446 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003447 cp configs/config-tfm.h "$CONFIG_H"
3448 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3449 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003450
Yanray Wang73bb2312023-09-25 11:21:15 +08003451 # Other config adjustment to make the tests pass.
3452 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003453 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003454 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3455 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003456
Yanray Wang73bb2312023-09-25 11:21:15 +08003457 # Config adjustment for better test coverage in our environment.
3458 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003459 #
3460 # Enable filesystem I/O for the benefit of PK parse/write tests.
3461 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3462}
3463
Valerio Settiac6d35f2023-08-04 12:49:11 +02003464# Keep this in sync with component_test_tfm_config() as they are both meant
3465# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003466component_test_tfm_config_p256m_driver_accel_ec () {
3467 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3468
3469 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003470
Dave Rodgman897bb772023-11-15 16:34:20 +00003471 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003472 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003473
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003474 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3475 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003476 not grep mbedtls_ecdh_ library/ecdh.o
3477 not grep mbedtls_ecjpake_ library/ecjpake.o
3478 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3479 not grep mbedtls_ecp_ library/ecp.o
3480 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003481 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003482 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003483 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003484 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003485
Valerio Setti5e18b902023-12-04 12:07:30 +01003486 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3487 # files, so we want to ensure that it has not be re-enabled accidentally.
3488 not grep mbedtls_cipher library/cipher.o
3489
Valerio Settib7e95442023-03-21 11:52:33 +01003490 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003491 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003492 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003493}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003494
Valerio Settiac6d35f2023-08-04 12:49:11 +02003495# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3496# they are both meant to be used in analyze_outcomes.py for driver's coverage
3497# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003498component_test_tfm_config() {
3499 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003500
Dave Rodgman897bb772023-11-15 16:34:20 +00003501 # Disable P256M driver, which is on by default, so that analyze_outcomes
3502 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3503 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3504
Valerio Setti52ba0e32023-08-04 12:43:03 +02003505 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003506 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003507
Dave Rodgman897bb772023-11-15 16:34:20 +00003508 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003509 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003510
Valerio Setti5e18b902023-12-04 12:07:30 +01003511 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3512 # files, so we want to ensure that it has not be re-enabled accidentally.
3513 not grep mbedtls_cipher library/cipher.o
3514
Valerio Setti52ba0e32023-08-04 12:43:03 +02003515 msg "test: TF-M config"
3516 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003517}
3518
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003519# Common helper for component_full_without_ecdhe_ecdsa() and
3520# component_full_without_ecdhe_ecdsa_and_tls13() which:
3521# - starts from the "full" configuration minus the list of symbols passed in
3522# as 1st parameter
3523# - build
3524# - test only TLS (i.e. test_suite_tls and ssl-opt)
3525build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003526 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003527
3528 msg "build: full minus something, test TLS"
3529
3530 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003531 for sym in $symbols_to_disable; do
3532 echo "Disabling $sym"
3533 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003534 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003535
Gilles Peskine21570cf2023-12-22 11:49:50 +01003536 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003537
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003538 msg "test: full minus something, test TLS"
3539 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003540
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003541 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003542 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003543}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003544
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003545component_full_without_ecdhe_ecdsa () {
3546 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003547}
3548
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003549component_full_without_ecdhe_ecdsa_and_tls13 () {
3550 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3551 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003552}
3553
Valerio Setti249b18a2023-06-20 12:08:30 +02003554# This is an helper used by:
3555# - component_test_psa_ecc_key_pair_no_derive
3556# - component_test_psa_ecc_key_pair_no_generate
3557# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3558# enabled, but one. Input arguments are as follows:
3559# - $1 is the key type under test, i.e. ECC/RSA/DH
3560# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003561build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003562 key_type=$1
3563 unset_option=$2
3564 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003565
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003566 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003567 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003568 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3569 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3570
3571 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3572 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003573 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003574
Gilles Peskine21570cf2023-12-22 11:49:50 +01003575 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003576
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003577 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003578 make test
3579}
3580
3581component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003582 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003583}
3584
3585component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003586 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003587}
3588
Pengyu Lve705f572023-12-06 16:38:15 +08003589config_psa_crypto_accel_rsa () {
3590 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003591
Pengyu Lve705f572023-12-06 16:38:15 +08003592 # Start from crypto_full config (no X.509, no TLS)
3593 helper_libtestdriver1_adjust_config "crypto_full"
3594
3595 if [ "$driver_only" -eq 1 ]; then
3596 # Remove RSA support and its dependencies
3597 scripts/config.py unset MBEDTLS_RSA_C
3598 scripts/config.py unset MBEDTLS_PKCS1_V15
3599 scripts/config.py unset MBEDTLS_PKCS1_V21
3600
3601 # We need PEM parsing in the test library as well to support the import
3602 # of PEM encoded RSA keys.
3603 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3604 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3605 fi
3606}
3607
3608component_test_psa_crypto_config_accel_rsa_crypto () {
3609 msg "build: crypto_full with accelerated RSA"
3610
3611 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3612 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3613 KEY_TYPE_RSA_PUBLIC_KEY \
3614 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3615 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3616 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3617 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003618
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003619 # Configure
3620 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003621
Pengyu Lve705f572023-12-06 16:38:15 +08003622 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003623
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003624 # Build
3625 # -----
3626
Pengyu Lve705f572023-12-06 16:38:15 +08003627 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003628 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 +08003629 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003630 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003631
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003632 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003633
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003634 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003635 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003636
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003637 # Run the tests
3638 # -------------
3639
Pengyu Lve705f572023-12-06 16:38:15 +08003640 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003641 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003642}
3643
3644component_test_psa_crypto_config_reference_rsa_crypto () {
3645 msg "build: crypto_full with non-accelerated RSA"
3646
3647 # Configure
3648 # ---------
3649 config_psa_crypto_accel_rsa 0
3650
3651 # Build
3652 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003653 make
Pengyu Lve705f572023-12-06 16:38:15 +08003654
3655 # Run the tests
3656 # -------------
3657 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003658 make test
3659}
3660
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003661# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003662# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003663component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003664 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003665
Valerio Setti4590bc22023-06-13 15:39:23 +02003666 # Create a temporary output file unless there is already one set
3667 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3668 REMOVE_OUTCOME_ON_EXIT="no"
3669 else
3670 REMOVE_OUTCOME_ON_EXIT="yes"
3671 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3672 export MBEDTLS_TEST_OUTCOME_FILE
3673 fi
3674
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003675 # Start from crypto configuration
3676 scripts/config.py crypto
3677
3678 # Remove RSA support and its dependencies
3679 scripts/config.py unset MBEDTLS_PKCS1_V15
3680 scripts/config.py unset MBEDTLS_PKCS1_V21
3681 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3682 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3683 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3684 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3685 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3686 scripts/config.py unset MBEDTLS_RSA_C
3687 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3688
3689 # Enable PSA support
3690 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3691
Valerio Setti01cc88a2023-06-15 11:53:08 +02003692 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003693 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003694 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3695 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3696 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003697
3698 make
3699
Valerio Setti01cc88a2023-06-15 11:53:08 +02003700 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003701 make test
3702
3703 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3704 # performing RSA signature.
3705 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3706 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3707
3708 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3709 rm $MBEDTLS_TEST_OUTCOME_FILE
3710 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003711}
3712
Ronald Cronb2312452021-05-08 14:32:59 +02003713component_test_psa_crypto_config_accel_hash () {
3714 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3715
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003716 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3717 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3718 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003719
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003720 # Configure
3721 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003722
Ronald Cron46ac0652024-03-18 12:39:04 +01003723 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003724 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003725
3726 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003727 scripts/config.py unset MBEDTLS_MD5_C
3728 scripts/config.py unset MBEDTLS_RIPEMD160_C
3729 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003730 scripts/config.py unset MBEDTLS_SHA224_C
3731 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003732 scripts/config.py unset MBEDTLS_SHA384_C
3733 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003734 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003735
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003736 # Build
3737 # -----
3738
3739 helper_libtestdriver1_make_drivers "$loc_accel_list"
3740
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003741 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003742
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003743 # There's a risk of something getting re-enabled via config_psa.h;
3744 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3745 not grep mbedtls_md5 library/md5.o
3746 not grep mbedtls_sha1 library/sha1.o
3747 not grep mbedtls_sha256 library/sha256.o
3748 not grep mbedtls_sha512 library/sha512.o
3749 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003750
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003751 # Run the tests
3752 # -------------
3753
Ronald Cronb2312452021-05-08 14:32:59 +02003754 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3755 make test
3756}
3757
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003758# Auxiliary function to build config for hashes with and without drivers
3759config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003760 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003761 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003762 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003763 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003764 # disable the built-in implementation of hashes
3765 scripts/config.py unset MBEDTLS_MD5_C
3766 scripts/config.py unset MBEDTLS_RIPEMD160_C
3767 scripts/config.py unset MBEDTLS_SHA1_C
3768 scripts/config.py unset MBEDTLS_SHA224_C
3769 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003770 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003771 scripts/config.py unset MBEDTLS_SHA384_C
3772 scripts/config.py unset MBEDTLS_SHA512_C
3773 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003774 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003775 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003776}
3777
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003778# Note that component_test_psa_crypto_config_reference_hash_use_psa
3779# is related to this component and both components need to be kept in sync.
3780# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003781component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003782 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003783
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003784 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3785 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3786 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003787
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003788 # Configure
3789 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003790
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003791 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003792
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003793 # Build
3794 # -----
3795
3796 helper_libtestdriver1_make_drivers "$loc_accel_list"
3797
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003798 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003799
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003800 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003801 # 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 +02003802 not grep mbedtls_md5 library/md5.o
3803 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003804 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003805 not grep mbedtls_sha512 library/sha512.o
3806 not grep mbedtls_ripemd160 library/ripemd160.o
3807
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003808 # Run the tests
3809 # -------------
3810
Gilles Peskine14302ed2023-07-19 19:30:04 +02003811 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003812 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003813
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003814 # This is mostly useful so that we can later compare outcome files with
3815 # the reference config in analyze_outcomes.py, to check that the
3816 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003817 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003818 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003819
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003820 # This is to make sure all ciphersuites are exercised, but we don't need
3821 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003822 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003823 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003824}
3825
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003826# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3827# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3828# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3829# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003830component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003831 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003832
3833 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003834
Gilles Peskine21570cf2023-12-22 11:49:50 +01003835 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003836
Gilles Peskine14302ed2023-07-19 19:30:04 +02003837 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003838 make test
3839
Gilles Peskine14302ed2023-07-19 19:30:04 +02003840 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003841 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003842}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003843
Valerio Setti8eb310c2024-01-22 16:22:57 +01003844# Auxiliary function to build config for hashes with and without drivers
3845config_psa_crypto_hmac_use_psa () {
3846 driver_only="$1"
3847 # start with config full for maximum coverage (also enables USE_PSA)
3848 helper_libtestdriver1_adjust_config "full"
3849
Valerio Setticd89b0b2024-01-24 14:24:55 +01003850 if [ "$driver_only" -eq 1 ]; then
3851 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3852 # is still enabled though (for ENTROPY_C among others).
3853 scripts/config.py unset MBEDTLS_MD_C
3854 # Disable also the builtin hashes since they are supported by the driver
3855 # and MD module is able to perform PSA dispathing.
3856 scripts/config.py unset-all MBEDTLS_SHA
3857 scripts/config.py unset MBEDTLS_MD5_C
3858 scripts/config.py unset MBEDTLS_RIPEMD160_C
3859 fi
3860
Valerio Setti8eb310c2024-01-22 16:22:57 +01003861 # Direct dependencies of MD_C. We disable them also in the reference
3862 # component to work with the same set of features.
3863 scripts/config.py unset MBEDTLS_PKCS7_C
3864 scripts/config.py unset MBEDTLS_PKCS5_C
3865 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3866 scripts/config.py unset MBEDTLS_HKDF_C
3867 # Dependencies of HMAC_DRBG
3868 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3869 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3870}
3871
3872component_test_psa_crypto_config_accel_hmac() {
3873 msg "test: full with accelerated hmac"
3874
3875 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3876 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3877 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3878 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3879
3880 # Configure
3881 # ---------
3882
3883 config_psa_crypto_hmac_use_psa 1
3884
Valerio Setti8eb310c2024-01-22 16:22:57 +01003885 # Build
3886 # -----
3887
3888 helper_libtestdriver1_make_drivers "$loc_accel_list"
3889
3890 helper_libtestdriver1_make_main "$loc_accel_list"
3891
3892 # Ensure that built-in support for HMAC is disabled.
3893 not grep mbedtls_md_hmac library/md.o
3894
3895 # Run the tests
3896 # -------------
3897
3898 msg "test: full with accelerated hmac"
3899 make test
3900}
3901
3902component_test_psa_crypto_config_reference_hmac() {
3903 msg "test: full without accelerated hmac"
3904
3905 config_psa_crypto_hmac_use_psa 0
3906
3907 make
3908
3909 msg "test: full without accelerated hmac"
3910 make test
3911}
3912
Valerio Setti9da01a72023-12-18 17:38:18 +01003913component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003914 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003915
Valerio Setti9da01a72023-12-18 17:38:18 +01003916 # Albeit this components aims at accelerating DES which should only support
3917 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3918 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003919 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3920 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3921 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003922
Valerio Setti9da01a72023-12-18 17:38:18 +01003923 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3924 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3925 # of this component. This limitation will be addressed by #8598.
3926
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003927 # Configure
3928 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003929
Valerio Setti9a427302023-10-17 11:40:42 +02003930 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003931 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003932
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003933 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003934 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3935 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3936 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3937 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3938 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3939 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3940 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003941 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003942
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003943 # Build
3944 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003945
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003946 helper_libtestdriver1_make_drivers "$loc_accel_list"
3947
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003948 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003949
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003950 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003951 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003952
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003953 # Run the tests
3954 # -------------
3955
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003956 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003957 make test
3958}
3959
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003960component_test_psa_crypto_config_accel_aead () {
3961 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3962
Valerio Setti3f02bb72023-10-02 15:57:33 +02003963 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3964 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003965
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003966 # Configure
3967 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003968
Valerio Setti3f02bb72023-10-02 15:57:33 +02003969 # Start from full config
3970 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003971
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003972 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003973 scripts/config.py unset MBEDTLS_GCM_C
3974 scripts/config.py unset MBEDTLS_CCM_C
3975 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003976
Valerio Settia50b89e2023-11-08 15:58:47 +01003977 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3978 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003979
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003980 # Build
3981 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003982
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003983 helper_libtestdriver1_make_drivers "$loc_accel_list"
3984
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003985 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003986
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003987 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003988 not grep mbedtls_ccm library/ccm.o
3989 not grep mbedtls_gcm library/gcm.o
3990 not grep mbedtls_chachapoly library/chachapoly.o
3991
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003992 # Run the tests
3993 # -------------
3994
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003995 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3996 make test
3997}
3998
Valerio Settib680fc42023-10-13 09:29:37 +02003999# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004000# - component_test_psa_crypto_config_accel_cipher_aead_cmac
4001# - component_test_psa_crypto_config_reference_cipher_aead_cmac
4002common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08004003 # Start from the full config
4004 helper_libtestdriver1_adjust_config "full"
4005
Valerio Settib680fc42023-10-13 09:29:37 +02004006 scripts/config.py unset MBEDTLS_NIST_KW_C
4007}
4008
Valerio Settib6b301f2023-10-04 12:05:05 +02004009# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004010# - component_test_psa_crypto_config_accel_cipher_aead_cmac
4011# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004012# are meant to be used together in analyze_outcomes.py script in order to test
4013# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004014component_test_psa_crypto_config_accel_cipher_aead_cmac () {
4015 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004016
Valerio Settiad8b7f02023-10-25 12:39:50 +02004017 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 +01004018 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02004019 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02004020 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
4021
4022 # Configure
4023 # ---------
4024
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004025 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004026
4027 # Disable the things that are being accelerated
4028 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4029 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
4030 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
4031 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
4032 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
4033 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4034 scripts/config.py unset MBEDTLS_GCM_C
4035 scripts/config.py unset MBEDTLS_CCM_C
4036 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02004037 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02004038 scripts/config.py unset MBEDTLS_DES_C
4039 scripts/config.py unset MBEDTLS_AES_C
4040 scripts/config.py unset MBEDTLS_ARIA_C
4041 scripts/config.py unset MBEDTLS_CHACHA20_C
4042 scripts/config.py unset MBEDTLS_CAMELLIA_C
4043
Valerio Settiec9b2582023-11-08 16:50:54 +01004044 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
4045 # does not depend on it.
4046 scripts/config.py unset MBEDTLS_CIPHER_C
4047
Valerio Settib6b301f2023-10-04 12:05:05 +02004048 # Build
4049 # -----
4050
4051 helper_libtestdriver1_make_drivers "$loc_accel_list"
4052
4053 helper_libtestdriver1_make_main "$loc_accel_list"
4054
4055 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01004056 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02004057 not grep mbedtls_des library/des.o
4058 not grep mbedtls_aes library/aes.o
4059 not grep mbedtls_aria library/aria.o
4060 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004061 not grep mbedtls_ccm library/ccm.o
4062 not grep mbedtls_gcm library/gcm.o
4063 not grep mbedtls_chachapoly library/chachapoly.o
4064 not grep mbedtls_cmac library/cmac.o
4065
4066 # Run the tests
4067 # -------------
4068
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004069 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004070 make test
Valerio Settif9414552023-11-09 10:43:20 +01004071
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004072 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004073 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004074
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004075 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004076 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004077}
4078
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004079component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4080 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4081 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004082
Gilles Peskine21570cf2023-12-22 11:49:50 +01004083 make
Valerio Settif9414552023-11-09 10:43:20 +01004084
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004085 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004086 make test
Valerio Settif9414552023-11-09 10:43:20 +01004087
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004088 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004089 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004090
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004091 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004092 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004093}
4094
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004095common_block_cipher_dispatch() {
4096 TEST_WITH_DRIVER="$1"
4097
4098 # Start from the full config
4099 helper_libtestdriver1_adjust_config "full"
4100
4101 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4102 # Disable key types that are accelerated (there is no legacy equivalent
4103 # symbol for ECB)
4104 scripts/config.py unset MBEDTLS_AES_C
4105 scripts/config.py unset MBEDTLS_ARIA_C
4106 scripts/config.py unset MBEDTLS_CAMELLIA_C
4107 fi
4108
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004109 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004110 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004111 # Keep this also in the reference component in order to skip the same tests
4112 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004113 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4114 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4115 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4116 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4117 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4118 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4119 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02004120 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004121
4122 # Disable direct dependency on AES_C
4123 scripts/config.py unset MBEDTLS_NIST_KW_C
4124
4125 # Prevent the cipher module from using deprecated PSA path. The reason is
4126 # that otherwise there will be tests relying on "aes_info" (defined in
4127 # "cipher_wrap.c") whose functions are not available when AES_C is
4128 # not defined. ARIA and Camellia are not a problem in this case because
4129 # the PSA path is not tested for these key types.
4130 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4131}
4132
Valerio Settif8e6cba2023-12-12 11:53:39 +01004133component_test_full_block_cipher_psa_dispatch () {
4134 msg "build: full + PSA dispatch in block_cipher"
4135
4136 loc_accel_list="ALG_ECB_NO_PADDING \
4137 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4138
4139 # Configure
4140 # ---------
4141
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004142 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004143
Valerio Settif8e6cba2023-12-12 11:53:39 +01004144 # Build
4145 # -----
4146
4147 helper_libtestdriver1_make_drivers "$loc_accel_list"
4148
4149 helper_libtestdriver1_make_main "$loc_accel_list"
4150
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004151 # Make sure disabled components were not re-enabled by accident (additive
4152 # config)
4153 not grep mbedtls_aes_ library/aes.o
4154 not grep mbedtls_aria_ library/aria.o
4155 not grep mbedtls_camellia_ library/camellia.o
4156
Valerio Settif8e6cba2023-12-12 11:53:39 +01004157 # Run the tests
4158 # -------------
4159
4160 msg "test: full + PSA dispatch in block_cipher"
4161 make test
4162}
4163
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004164# This is the reference component of component_test_full_block_cipher_psa_dispatch
4165component_test_full_block_cipher_legacy_dispatch () {
4166 msg "build: full + legacy dispatch in block_cipher"
4167
4168 common_block_cipher_dispatch 0
4169
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004170 make
4171
4172 msg "test: full + legacy dispatch in block_cipher"
4173 make test
4174}
4175
Gilles Peskine36dea152023-07-20 22:19:45 +02004176component_test_aead_chachapoly_disabled() {
4177 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004178 scripts/config.py full
4179 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004180 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004181 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004182
Gilles Peskine36dea152023-07-20 22:19:45 +02004183 msg "test: full minus CHACHAPOLY"
4184 make test
4185}
4186
4187component_test_aead_only_ccm() {
4188 msg "build: full minus CHACHAPOLY and GCM"
4189 scripts/config.py full
4190 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4191 scripts/config.py unset MBEDTLS_GCM_C
4192 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4193 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004194 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004195
4196 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004197 make test
4198}
4199
Ronald Crone501d0e2023-07-10 08:31:19 +02004200component_test_ccm_aes_sha256() {
4201 msg "build: CCM + AES + SHA256 configuration"
4202
Ronald Cron7612d8c2023-07-20 10:03:54 +02004203 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004204 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004205
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004206 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004207
4208 msg "test: CCM + AES + SHA256 configuration"
4209 make test
4210}
4211
Dave Rodgman904c5892023-06-28 17:36:02 +01004212support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004213 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004214}
4215
Dave Rodgman904c5892023-06-28 17:36:02 +01004216component_build_tfm_armcc() {
4217 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004218 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004219
Dave Rodgman88651c42023-06-29 12:35:51 +01004220 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004221 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 +01004222}
4223
4224component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004225 # Check that the TF-M configuration can build cleanly with various
4226 # warning flags enabled. We don't build or run tests, since the
4227 # TF-M configuration needs a TF-M platform. A tweaked version of
4228 # the configuration that works on mainstream platforms is in
4229 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004230 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004231
Dave Rodgman88651c42023-06-29 12:35:51 +01004232 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004233 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 +01004234
Dave Rodgman904c5892023-06-28 17:36:02 +01004235 msg "build: TF-M config, gcc native build"
4236 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004237 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 +01004238}
4239
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004240# Test that the given .o file builds with all (valid) combinations of the given options.
4241#
4242# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4243#
4244# The validator function is the name of a function to validate the combination of options.
4245# It may be "" if all combinations are valid.
4246# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004247# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004248build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004249 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004250 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004251 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004252 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004253 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004254
Dave Rodgman42436102023-10-03 15:47:05 +01004255 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004256 for opt in "${options[@]}"; do
4257 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004258 done
4259
4260 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004261 cd $(dirname ${file})
4262 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004263
Dave Rodgman920343a2023-10-01 18:41:09 +01004264 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004265 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 +01004266
Dave Rodgman42436102023-10-03 15:47:05 +01004267 # Extract the command generated by the Makefile to build the target file.
4268 # This ensures that we have any include paths, macro definitions, etc
4269 # that may be applied by make.
4270 # 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 +01004271 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004272
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004273 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004274 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004275
Dave Rodgman28e38d82023-10-04 11:50:30 +01004276 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004277 source_file=${file%.o}.c
4278
4279 targets=0
4280 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004281
Dave Rodgman28e38d82023-10-04 11:50:30 +01004282 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004283 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004284 # each bit of $i is used to determine if options[i] will be set or not
4285 target="t"
4286 clang_args=""
4287 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004288 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004289 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004290 clang_args="${clang_args} ${opt}"
4291 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004292 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004293 done
4294
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004295 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004296 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004297 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004298 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004299
Dave Rodgman28e38d82023-10-04 11:50:30 +01004300 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004301 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004302 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004303 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004304
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004305 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004306
Dave Rodgman920343a2023-10-01 18:41:09 +01004307 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004308 make -s -f ${makefile} build_test_config_combos
4309 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004310
4311 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004312 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004313}
4314
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004315validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004316 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4317 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004318 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004319 fi
4320 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4321 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004322 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004323 fi
4324 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004325 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004326}
4327
4328component_build_aes_variations() {
4329 # 18s - around 90ms per clang invocation on M1 Pro
4330 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004331 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004332 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004333
Yanray Wangbc29aef2023-11-06 11:08:17 +08004334 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004335 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004336
Dave Rodgman42436102023-10-03 15:47:05 +01004337 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004338 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4339 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4340 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4341 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004342
4343 cd "$MBEDTLS_ROOT_DIR"
4344 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4345
Yanray Wang42be1ba2023-11-23 14:28:47 +08004346 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004347 # manually set or unset those configurations to check
4348 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004349 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4350 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4351 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4352 scripts/config.py unset MBEDTLS_DES_C
4353 scripts/config.py unset MBEDTLS_NIST_KW_C
4354 build_test_config_combos library/aes.o validate_aes_config_variations \
4355 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4356 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4357 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4358 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004359}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004360
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004361component_test_no_platform () {
4362 # Full configuration build, without platform support, file IO and net sockets.
4363 # This should catch missing mbedtls_printf definitions, and by disabling file
4364 # IO, it should catch missing '#include <stdio.h>'
4365 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004366 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004367 scripts/config.py unset MBEDTLS_PLATFORM_C
4368 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004369 scripts/config.py unset MBEDTLS_FS_IO
4370 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004371 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004372 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004373 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004374 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004375 # to re-enable platform integration features otherwise disabled in C99 builds
4376 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004377 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004378}
Gilles Peskine7c652162017-12-11 00:01:40 +01004379
4380component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004381 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004382 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4383 scripts/config.py full
4384 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004385 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4386 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4387 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4388 make
4389}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004390
Gilles Peskine8f073122018-11-27 15:58:47 +01004391component_build_no_ssl_srv () {
4392 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004393 scripts/config.py full
4394 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004395 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004396}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004397
Gilles Peskine8f073122018-11-27 15:58:47 +01004398component_build_no_ssl_cli () {
4399 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004400 scripts/config.py full
4401 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004402 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004403}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004404
Gilles Peskine8f073122018-11-27 15:58:47 +01004405component_build_no_sockets () {
4406 # Note, C99 compliance can also be tested with the sockets support disabled,
4407 # as that requires a POSIX platform (which isn't the same as C99).
4408 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004409 scripts/config.py full
4410 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4411 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4412 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4413}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004414
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004415component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004416 msg "build: default config with memory buffer allocator and backtrace enabled"
4417 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4418 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4419 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004420 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004421 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004422 make
4423
4424 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4425 make test
4426}
4427
4428component_test_memory_buffer_allocator () {
4429 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004430 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4431 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004432 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004433 make
4434
4435 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4436 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004437
4438 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4439 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004440 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004441}
4442
Gilles Peskine8f073122018-11-27 15:58:47 +01004443component_test_no_max_fragment_length () {
4444 # Run max fragment length tests with MFL disabled
4445 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004446 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004447 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004448 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004449
Gilles Peskine8f073122018-11-27 15:58:47 +01004450 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004451 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004452}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004453
Hanno Becker545ced42019-02-19 11:10:48 +00004454component_test_asan_remove_peer_certificate () {
4455 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004456 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004457 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004458 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004459 make
4460
4461 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4462 make test
4463
4464 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004465 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004466
4467 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004468 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004469
4470 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004471 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004472}
4473
Gilles Peskine8f073122018-11-27 15:58:47 +01004474component_test_no_max_fragment_length_small_ssl_out_content_len () {
4475 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004476 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4477 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4478 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004479 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004480 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004481
Gilles Peskine8f073122018-11-27 15:58:47 +01004482 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004483 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004484
4485 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004486 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004487}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004488
Darryl Greenaad82f92019-12-02 10:53:11 +00004489component_test_variable_ssl_in_out_buffer_len () {
4490 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4491 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004492 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004493 make
4494
4495 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4496 make test
4497
4498 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004499 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004500
4501 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004502 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004503}
4504
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004505component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004506 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004507 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004508
Dave Rodgman17127e92023-12-14 16:42:48 +00004509 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004510 make
4511
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004512 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004513 make test
4514
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004515 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004516 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004517
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004518 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004519 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004520}
4521
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004522component_test_ssl_alloc_buffer_and_mfl () {
4523 msg "build: default config with memory buffer allocator and MFL extension"
4524 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4525 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4526 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4527 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4528 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004529 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004530 make
4531
4532 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4533 make test
4534
4535 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 +02004536 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004537}
4538
Gilles Peskine636c26a2020-03-04 20:46:15 +01004539component_test_when_no_ciphersuites_have_mac () {
4540 msg "build: when no ciphersuites have MAC"
4541 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004542 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004543 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004544 make
4545
4546 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4547 make test
4548
4549 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004550 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004551}
4552
Raoul Strackxa4e86142020-06-15 17:03:13 +02004553component_test_no_date_time () {
4554 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4555 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004556 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004557 make
4558
4559 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4560 make test
4561}
4562
Gilles Peskine8f073122018-11-27 15:58:47 +01004563component_test_platform_calloc_macro () {
4564 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004565 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4566 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4567 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004568 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004569 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004570
Gilles Peskine8f073122018-11-27 15:58:47 +01004571 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4572 make test
4573}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004574
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004575component_test_malloc_0_null () {
4576 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004577 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004578 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 +02004579
4580 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4581 make test
4582
4583 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4584 # Just the calloc selftest. "make test" ran the others as part of the
4585 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004586 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004587
4588 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4589 # Run a subset of the tests. The choice is a balance between coverage
4590 # and time (including time indirectly wasted due to flaky tests).
4591 # The current choice is to skip tests whose description includes
4592 # "proxy", which is an approximation of skipping tests that use the
4593 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004594 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004595}
4596
Dave Rodgman6a08b682023-06-19 11:51:33 +01004597support_test_aesni() {
4598 # Check that gcc targets x86_64 (we can build AESNI), and check for
4599 # AESNI support on the host (we can run AESNI).
4600 #
4601 # The name of this function is possibly slightly misleading, but needs to align
4602 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004603 #
4604 # In principle 32-bit x86 can support AESNI, but our implementation does not
4605 # support 32-bit x86, so we check for x86-64.
4606 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004607 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4608 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004609 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004610}
4611
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004612component_test_aesni () { # ~ 60s
4613 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4614 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4615 #
4616 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4617 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4618 # exercise the plain C impl).
4619
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004620 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004621 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004622 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004623 scripts/config.py set MBEDTLS_HAVE_ASM
4624
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004625 # test the intrinsics implementation
4626 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004627 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004628 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004629 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004630 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004631
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004632 # test the asm implementation
4633 msg "AES tests, test assembly"
4634 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004635 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004636 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004637 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004638
4639 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004640 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004641 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004642 msg "AES tests, plain C"
4643 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004644 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004645 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004646 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004647 not grep -q "AES note: using AESNI" ./programs/test/selftest
4648 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004649
4650 # test the intrinsics implementation
4651 scripts/config.py set MBEDTLS_AESNI_C
4652 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4653 msg "AES tests, test AESNI only"
4654 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004655 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004656 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4657 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004658 grep -q "AES note: using AESNI" ./programs/test/selftest
4659 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004660}
4661
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004662component_test_sha3_variations() {
4663 msg "sha3 loop unroll variations"
4664
4665 # define minimal config sufficient to test SHA3
4666 cat > include/mbedtls/mbedtls_config.h << END
4667 #define MBEDTLS_SELF_TEST
4668 #define MBEDTLS_SHA3_C
4669END
4670
4671 msg "all loops unrolled"
4672 make clean
4673 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"
4674 ./tests/test_suite_shax
4675
4676 msg "all loops rolled up"
4677 make clean
4678 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"
4679 ./tests/test_suite_shax
4680}
4681
Jerry Yub6d39c22023-08-16 15:11:48 +08004682support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004683 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004684}
4685
4686component_test_aesni_m32 () { # ~ 60s
4687 # This tests are duplicated from component_test_aesni for i386 target
4688 #
4689 # AESNI intrinsic code supports i386 and assembly code does not support it.
4690
4691 msg "build: default config with different AES implementations"
4692 scripts/config.py set MBEDTLS_AESNI_C
4693 scripts/config.py set MBEDTLS_PADLOCK_C
4694 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4695 scripts/config.py set MBEDTLS_HAVE_ASM
4696
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004697 # test the intrinsics implementation with gcc
4698 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004699 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004700 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004701 # check that we built intrinsics - this should be used by default when supported by the compiler
4702 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4703 grep -q "AES note: using AESNI" ./programs/test/selftest
4704 grep -q "AES note: built-in implementation." ./programs/test/selftest
4705 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4706 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4707
4708 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004709 scripts/config.py unset MBEDTLS_PADLOCK_C
4710 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4711 msg "AES tests, test AESNI only"
4712 make clean
4713 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4714 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4715 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4716 grep -q "AES note: using AESNI" ./programs/test/selftest
4717 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4718 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4719 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4720}
4721
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004722support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004723 # clang >= 4 is required to build with target attributes
4724 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004725}
4726
4727component_test_aesni_m32_clang() {
4728
4729 scripts/config.py set MBEDTLS_AESNI_C
4730 scripts/config.py set MBEDTLS_PADLOCK_C
4731 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4732 scripts/config.py set MBEDTLS_HAVE_ASM
4733
4734 # test the intrinsics implementation with clang
4735 msg "AES tests, test intrinsics (clang)"
4736 make clean
4737 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4738 # check that we built intrinsics - this should be used by default when supported by the compiler
4739 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4740 grep -q "AES note: using AESNI" ./programs/test/selftest
4741 grep -q "AES note: built-in implementation." ./programs/test/selftest
4742 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4743 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4744}
4745
Jerry Yu193cbc02023-08-03 17:06:29 +08004746# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4747component_build_aes_aesce_armcc () {
4748 msg "Build: AESCE test on arm64 platform without plain C."
4749 scripts/config.py baremetal
4750
4751 # armc[56] don't support SHA-512 intrinsics
4752 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4753
4754 # Stop armclang warning about feature detection for A64_CRYPTO.
4755 # With this enabled, the library does build correctly under armclang,
4756 # but in baremetal builds (as tested here), feature detection is
4757 # unavailable, and the user is notified via a #warning. So enabling
4758 # this feature would prevent us from building with -Werror on
4759 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004760 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004761 scripts/config.py set MBEDTLS_HAVE_ASM
4762
4763 msg "AESCE, build with default configuration."
4764 scripts/config.py set MBEDTLS_AESCE_C
4765 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4766 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4767
4768 msg "AESCE, build AESCE only"
4769 scripts/config.py set MBEDTLS_AESCE_C
4770 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4771 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4772}
4773
Dave Rodgman0c584032023-10-08 12:26:54 +01004774support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004775 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004776 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004777}
4778
4779component_build_aes_armce () {
4780 # Test variations of AES with Armv8 crypto extensions
4781 scripts/config.py set MBEDTLS_AESCE_C
4782 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4783
4784 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004785 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004786
4787 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4788 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4789
4790 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4791 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4792
Dave Rodgman5e419372023-10-23 15:30:20 +01004793 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004794
Dave Rodgman5e419372023-10-23 15:30:20 +01004795 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4796 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004797
Dave Rodgman5e419372023-10-23 15:30:20 +01004798 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4799 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004800
Dave Rodgman5e419372023-10-23 15:30:20 +01004801 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4802 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004803
4804 # test for presence of AES instructions
4805 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4806 msg "clang, test A32 crypto instructions built"
4807 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4808 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4809 msg "clang, test T32 crypto instructions built"
4810 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4811 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4812 msg "clang, test aarch64 crypto instructions built"
4813 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4814 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4815
4816 # test for absence of AES instructions
4817 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4818 scripts/config.py unset MBEDTLS_AESCE_C
4819 msg "clang, test A32 crypto instructions not built"
4820 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4821 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4822 msg "clang, test T32 crypto instructions not built"
4823 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4824 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4825 msg "clang, test aarch64 crypto instructions not built"
4826 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4827 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004828}
4829
Dave Rodgman9ed18532023-10-05 00:06:47 +01004830support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004831 # clang >= 4 is required to build with SHA extensions
4832 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004833}
4834
Dave Rodgmand9e80832023-10-04 17:17:46 +01004835component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004836 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004837
4838
4839 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004840 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004841 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4842 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4843 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4844 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4845 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004846
Dave Rodgmand9e80832023-10-04 17:17:46 +01004847
Dave Rodgman94a634d2023-10-10 12:59:29 +01004848 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004849 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004850 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4851 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4852 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004853
Dave Rodgman5b89c552023-10-10 14:59:02 +01004854 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004855 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4856 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4857 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004858
Dave Rodgmancd654002023-10-05 09:40:07 +01004859
Dave Rodgman94a634d2023-10-10 12:59:29 +01004860 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004861 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004862 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4863 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4864 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4865 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4866 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004867
Dave Rodgmancd654002023-10-05 09:40:07 +01004868
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004869 # examine the disassembly for presence of SHA instructions
4870 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4871 scripts/config.py set ${opt}
4872 msg "${opt} clang, test A32 crypto instructions built"
4873 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4874 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4875
4876 msg "${opt} clang, test T32 crypto instructions built"
4877 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4878 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4879
4880 msg "${opt} clang, test aarch64 crypto instructions built"
4881 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4882 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4883 scripts/config.py unset ${opt}
4884 done
4885
4886
4887 # examine the disassembly for absence of SHA instructions
4888 msg "clang, test A32 crypto instructions not built"
4889 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4890 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4891
4892 msg "clang, test T32 crypto instructions not built"
4893 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4894 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4895
4896 msg "clang, test aarch64 crypto instructions not built"
4897 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4898 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004899}
4900
Jerry Yuc935aa62023-08-03 17:08:27 +08004901# For timebeing, no VIA Padlock platform available.
4902component_build_aes_via_padlock () {
4903
4904 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004905 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004906 scripts/config.py set MBEDTLS_PADLOCK_C
4907 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00004908 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004909 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004910
4911}
4912
4913support_build_aes_via_padlock_only () {
4914 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4915 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4916 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4917}
4918
Jerry Yu193cbc02023-08-03 17:06:29 +08004919support_build_aes_aesce_armcc () {
4920 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004921}
4922
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004923component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004924 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004925 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004926 scripts/config.py unset MBEDTLS_PADLOCK_C
4927
Dave Rodgmand8d64512023-12-19 12:20:21 +00004928 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004929
4930 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4931 make test
4932}
4933
4934component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4935 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4936 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004937 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4938 scripts/config.py unset MBEDTLS_PADLOCK_C
4939
Hanno Becker83ebf782017-07-07 12:29:15 +01004940 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004941
4942 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004943 make test
4944}
Gilles Peskine8f073122018-11-27 15:58:47 +01004945
Hanno Becker83ebf782017-07-07 12:29:15 +01004946component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004947 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4948 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4949 scripts/config.py unset MBEDTLS_PADLOCK_C
4950 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004951 scripts/config.py unset MBEDTLS_AESCE_C
4952
Dave Rodgmand8d64512023-12-19 12:20:21 +00004953 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004954
4955 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004956 make test
4957
4958 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4959 programs/test/selftest
4960}
4961
Matthias Schulz0767fda2024-02-07 10:46:28 +01004962component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004963 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4964 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004965 scripts/config.py unset MBEDTLS_PADLOCK_C
4966 scripts/config.py unset MBEDTLS_AESNI_C
4967 scripts/config.py unset MBEDTLS_AESCE_C
4968
4969 make CFLAGS='-O2 -Werror -Wall -Wextra'
4970
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004971 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004972 make test
4973}
4974
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004975component_test_aes_fewer_tables () {
4976 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004977 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004978 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004979
Gilles Peskine7c652162017-12-11 00:01:40 +01004980 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004981 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004982}
4983
4984component_test_aes_rom_tables () {
4985 msg "build: default config with AES_ROM_TABLES enabled"
4986 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004987 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004988
4989 msg "test: AES_ROM_TABLES"
4990 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004991}
4992
Gilles Peskine14c3c062018-01-29 21:25:12 +01004993component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004994 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4995 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4996 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004997 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004998
Gilles Peskine8f073122018-11-27 15:58:47 +01004999 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
5000 make test
5001}
5002
Yanray Wang49cd4b52023-11-10 11:58:37 +08005003# helper for common_block_cipher_no_decrypt() which:
5004# - enable/disable the list of config options passed from -s/-u respectively.
5005# - build
5006# - test for tests_suite_xxx
5007# - selftest
5008#
5009# Usage: helper_block_cipher_no_decrypt_build_test
5010# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5011# Options: -s set_opts the list of config options to enable
5012# -u unset_opts the list of config options to disable
5013# -c cflags the list of options passed to CFLAGS
5014# -l ldflags the list of options passed to LDFLAGS
5015helper_block_cipher_no_decrypt_build_test () {
5016 while [ $# -gt 0 ]; do
5017 case "$1" in
5018 -s)
5019 shift; local set_opts="$1";;
5020 -u)
5021 shift; local unset_opts="$1";;
5022 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005023 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005024 -l)
5025 shift; local ldflags="$1";;
5026 esac
5027 shift
5028 done
5029 set_opts="${set_opts:-}"
5030 unset_opts="${unset_opts:-}"
5031 cflags="${cflags:-}"
5032 ldflags="${ldflags:-}"
5033
Yanray Wangb2d6e522023-11-13 16:57:47 +08005034 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5035 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005036
5037 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5038 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005039 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005040
5041 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5042 not grep mbedtls_aes_setkey_dec library/aes.o
5043 not grep mbedtls_aria_setkey_dec library/aria.o
5044 not grep mbedtls_camellia_setkey_dec library/camellia.o
5045 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5046 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005047 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5048 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005049
5050 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5051 make test
5052
5053 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5054 programs/test/selftest
5055}
5056
5057# This is a common configuration function used in:
5058# - component_test_block_cipher_no_decrypt_aesni_legacy()
5059# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5060# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5061# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5062# on x86.
5063common_block_cipher_no_decrypt () {
5064 # test AESNI intrinsics
5065 helper_block_cipher_no_decrypt_build_test \
5066 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005067 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005068
5069 # test AESNI assembly
5070 helper_block_cipher_no_decrypt_build_test \
5071 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005072 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005073
5074 # test AES C implementation
5075 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005076 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005077
5078 # test AESNI intrinsics for i386 target
5079 helper_block_cipher_no_decrypt_build_test \
5080 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005081 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005082 -l "-m32"
5083}
5084
Yanray Wang3ae11992023-11-13 17:32:09 +08005085# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5086# usage: 0: no PSA crypto configuration
5087# 1: use PSA crypto configuration
5088config_block_cipher_no_decrypt () {
5089 use_psa=$1
5090
Yanray Wang66111392023-10-31 18:54:54 +08005091 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005092 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5093 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005094 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005095 scripts/config.py unset MBEDTLS_NIST_KW_C
5096
Yanray Wang3ae11992023-11-13 17:32:09 +08005097 if [ "$use_psa" -eq 1 ]; then
5098 # Enable support for cryptographic mechanisms through the PSA API.
5099 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5100 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5101 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5102 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5103 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5104 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5105 fi
5106}
5107
5108component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005109 # This consistently causes an llvm crash on clang 3.8, so use gcc
5110 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005111 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005112 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005113}
5114
Yanray Wangf1496402023-11-01 18:55:13 +08005115component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005116 # This consistently causes an llvm crash on clang 3.8, so use gcc
5117 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005118 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005119 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005120}
5121
Yanray Wang66111392023-10-31 18:54:54 +08005122support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005123 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005124}
5125
Yanray Wang66111392023-10-31 18:54:54 +08005126component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005127 scripts/config.py baremetal
5128
5129 # armc[56] don't support SHA-512 intrinsics
5130 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5131
5132 # Stop armclang warning about feature detection for A64_CRYPTO.
5133 # With this enabled, the library does build correctly under armclang,
5134 # but in baremetal builds (as tested here), feature detection is
5135 # unavailable, and the user is notified via a #warning. So enabling
5136 # this feature would prevent us from building with -Werror on
5137 # armclang. Tracked in #7198.
5138 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5139 scripts/config.py set MBEDTLS_HAVE_ASM
5140
Yanray Wang3ae11992023-11-13 17:32:09 +08005141 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005142
5143 # test AESCE baremetal build
5144 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005145 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005146 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005147
Yanray Wangef1b04d2023-09-08 11:09:26 +08005148 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5149 not grep mbedtls_aes_setkey_dec library/aes.o
5150 not grep mbedtls_aria_setkey_dec library/aria.o
5151 not grep mbedtls_camellia_setkey_dec library/camellia.o
5152 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5153 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005154 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005155 not grep mbedtls_aesce_inverse_key library/aesce.o
5156 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005157}
5158
Gilles Peskine592f5912019-10-07 18:49:32 +02005159component_test_ctr_drbg_aes_256_sha_256 () {
5160 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5161 scripts/config.py full
5162 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5163 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005164 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005165 make
5166
5167 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5168 make test
5169}
5170
5171component_test_ctr_drbg_aes_128_sha_512 () {
5172 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005173 scripts/config.py full
5174 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5175 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005176 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005177 make
5178
5179 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5180 make test
5181}
5182
5183component_test_ctr_drbg_aes_128_sha_256 () {
5184 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005185 scripts/config.py full
5186 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5187 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5188 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005189 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005190 make
5191
5192 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5193 make test
5194}
5195
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005196component_test_se_default () {
5197 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005198 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005199 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005200
5201 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5202 make test
5203}
5204
Steven Cooremand57203d2020-07-16 20:28:59 +02005205component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005206 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005207 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005208 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005209 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5210 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005211 loc_cflags="${loc_cflags} -I../tests/include -O2"
5212
Gilles Peskine21570cf2023-12-22 11:49:50 +01005213 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005214
Gilles Peskine1997f302023-07-26 18:45:20 +02005215 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005216 make test
5217}
5218
Gilles Peskine8f073122018-11-27 15:58:47 +01005219component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005220 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005221 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005222 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005223 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005224}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005225
Gilles Peskinecf740502019-07-03 20:43:05 +02005226component_test_cmake_shared () {
5227 msg "build/test: cmake shared" # ~ 2min
5228 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5229 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005230 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005231 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005232 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005233}
5234
Gilles Peskineec10bf12019-09-20 19:56:06 +02005235test_build_opt () {
5236 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005237 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005238 for opt in "$@"; do
5239 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005240 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005241 # We're confident enough in compilers to not run _all_ the tests,
5242 # but at least run the unit tests. In particular, runs with
5243 # optimizations use inline assembly whereas runs with -O0
5244 # skip inline assembly.
5245 make test # ~30s
5246 make clean
5247 done
5248}
5249
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005250# For FreeBSD we invoke the function by name so this condition is added
5251# to disable the existing test_clang_opt function for linux.
5252if [[ $(uname) != "Linux" ]]; then
5253 component_test_clang_opt () {
5254 scripts/config.py full
5255 test_build_opt 'full config' clang -O0 -Os -O2
5256 }
5257fi
5258
5259component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005260 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005261 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005262}
5263support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005264 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005265}
5266
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005267component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005268 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005269 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005270}
5271support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005272 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005273}
5274
5275component_test_gcc_latest_opt () {
5276 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005277 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005278}
5279support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005280 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005281}
5282
5283component_test_gcc_earliest_opt () {
5284 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005285 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005286}
5287support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005288 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005289}
5290
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005291component_build_mbedtls_config_file () {
5292 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005293 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005294 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005295 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005296 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005297 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5298 make clean
5299
5300 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5301 # In the user config, disable one feature (for simplicity, pick a feature
5302 # that nothing else depends on).
5303 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005304 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005305 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5306
5307 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005308}
5309
Gilles Peskine7d904e72022-04-07 21:59:14 +02005310component_build_psa_config_file () {
5311 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5312 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5313 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5314 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5315 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005316 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005317 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5318 make clean
5319
5320 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005321 # In the user config, disable one feature and its dependencies, which will
5322 # reflect on the mbedtls configuration so we can query it with
5323 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005324 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005325 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005326 scripts/config.py unset MBEDTLS_CMAC_C
5327 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5328 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5329
5330 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005331}
5332
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005333component_build_psa_alt_headers () {
5334 msg "build: make with PSA alt headers" # ~20s
5335
5336 # Generate alternative versions of the substitutable headers with the
5337 # same content except different include guards.
5338 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5339
5340 # Build the library and some programs.
5341 # Don't build the fuzzers to avoid having to go through hoops to set
5342 # a correct include path for programs/fuzz/Makefile.
5343 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
5344 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\"'"
5345
5346 # Check that we're getting the alternative include guards and not the
5347 # original include guards.
5348 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5349 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5350 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5351 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5352}
5353
Dave Rodgman852de3c2023-12-14 14:46:45 +00005354component_test_m32_no_asm () {
5355 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005356 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005357 #
5358 # Note that we require gcc, because clang Asan builds fail to link for
5359 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005360 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005361 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005362 scripts/config.py unset MBEDTLS_HAVE_ASM
5363 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005364 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005365 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005366
Dave Rodgman852de3c2023-12-14 14:46:45 +00005367 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005368 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005369}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005370support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005371 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005372 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005373 *) false;;
5374 esac
5375}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005376
Gilles Peskineff0aee02021-10-05 09:36:03 +02005377component_test_m32_o2 () {
5378 # Build with optimization, to use the i386 specific inline assembly
5379 # and go faster for tests.
5380 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005381 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005382 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005383 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005384
Gilles Peskineff0aee02021-10-05 09:36:03 +02005385 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005386 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005387
Gilles Peskineff0aee02021-10-05 09:36:03 +02005388 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005389 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005390}
Gilles Peskinecf522222021-10-07 19:25:29 +02005391support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005392 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005393}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005394
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005395component_test_m32_everest () {
5396 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005397 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005398 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005399 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005400
5401 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5402 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005403
5404 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005405 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005406
5407 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5408 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005409 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005410}
5411support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005412 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005413}
5414
Gilles Peskine8f073122018-11-27 15:58:47 +01005415component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005416 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005417 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005418 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005419
5420 msg "test: 64-bit ILP32, make, gcc"
5421 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005422}
Gilles Peskine878cf602019-01-06 20:50:38 +00005423support_test_mx32 () {
5424 case $(uname -m) in
5425 amd64|x86_64) true;;
5426 *) false;;
5427 esac
5428}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005429
Peter Kolbus60c6da22018-12-27 06:59:04 -06005430component_test_min_mpi_window_size () {
5431 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005432 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005433 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005434 make
5435
5436 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5437 make test
5438}
5439
Gilles Peskine8f073122018-11-27 15:58:47 +01005440component_test_have_int32 () {
5441 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005442 scripts/config.py unset MBEDTLS_HAVE_ASM
5443 scripts/config.py unset MBEDTLS_AESNI_C
5444 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005445 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005446 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005447
Gilles Peskine8f073122018-11-27 15:58:47 +01005448 msg "test: gcc, force 32-bit bignum limbs"
5449 make test
5450}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005451
Gilles Peskine8f073122018-11-27 15:58:47 +01005452component_test_have_int64 () {
5453 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005454 scripts/config.py unset MBEDTLS_HAVE_ASM
5455 scripts/config.py unset MBEDTLS_AESNI_C
5456 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005457 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005458 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005459
Gilles Peskine8f073122018-11-27 15:58:47 +01005460 msg "test: gcc, force 64-bit bignum limbs"
5461 make test
5462}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005463
Gabor Mezeie256cc12023-07-26 17:28:48 +02005464component_test_have_int32_cmake_new_bignum () {
5465 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5466 scripts/config.py unset MBEDTLS_HAVE_ASM
5467 scripts/config.py unset MBEDTLS_AESNI_C
5468 scripts/config.py unset MBEDTLS_PADLOCK_C
5469 scripts/config.py unset MBEDTLS_AESCE_C
5470 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005471 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005472 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005473
5474 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5475 make test
5476}
5477
Gilles Peskine8f073122018-11-27 15:58:47 +01005478component_test_no_udbl_division () {
5479 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005480 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005481 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005482 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005483
Gilles Peskine8f073122018-11-27 15:58:47 +01005484 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5485 make test
5486}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005487
Gilles Peskine8f073122018-11-27 15:58:47 +01005488component_test_no_64bit_multiplication () {
5489 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005490 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005491 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005492 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005493
Gilles Peskine8f073122018-11-27 15:58:47 +01005494 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5495 make test
5496}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005497
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005498component_test_no_strings () {
5499 msg "build: no strings" # ~10s
5500 scripts/config.py full
5501 # Disable options that activate a large amount of string constants.
5502 scripts/config.py unset MBEDTLS_DEBUG_C
5503 scripts/config.py unset MBEDTLS_ERROR_C
5504 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5505 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005506 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005507
5508 msg "test: no strings" # ~ 10s
5509 make test
5510}
5511
Hanno Beckerc5722d12020-10-09 11:10:42 +01005512component_test_no_x509_info () {
5513 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5514 scripts/config.pl full
5515 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5516 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005517 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005518
5519 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5520 make test
5521
5522 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005523 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005524}
5525
Gilles Peskine8f073122018-11-27 15:58:47 +01005526component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005527 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005528 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005529 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 +02005530
Gilles Peskinee36fe812021-09-01 20:00:33 +02005531 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005532 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005533}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005534
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005535component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005536 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005537 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005538 # Build for a target platform that's close to what Debian uses
5539 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005540 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005541 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005542 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005543 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'
5544
Gilles Peskinee36fe812021-09-01 20:00:33 +02005545 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005546 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005547}
5548support_build_arm_linux_gnueabi_gcc_arm5vte () {
5549 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5550}
5551
5552component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005553 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005554 scripts/config.py baremetal
5555 # This is an imperfect substitute for
5556 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005557 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005558 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 +02005559
Gilles Peskinee36fe812021-09-01 20:00:33 +02005560 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005561 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005562}
5563
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005564component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005565 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5566 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005567 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 +02005568
Gilles Peskinee36fe812021-09-01 20:00:33 +02005569 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005570 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005571 for lib in library/*.a; do
5572 echo "$lib:"
5573 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5574 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005575}
5576
Gilles Peskine8f073122018-11-27 15:58:47 +01005577component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005578 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005579 scripts/config.py baremetal
5580 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005581 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 +01005582 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005583 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005584}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005585
Gilles Peskine8f073122018-11-27 15:58:47 +01005586component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005587 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005588 scripts/config.py baremetal
5589 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005590 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 +01005591 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005592 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005593}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005594
Dave Rodgman8c315f22023-06-02 10:26:24 -04005595component_build_arm_clang_thumb () {
5596 # ~ 30s
5597
5598 scripts/config.py baremetal
5599
5600 msg "build: clang thumb 2, make"
5601 make clean
5602 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5603
5604 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5605 msg "build: clang thumb 1 -O0, make"
5606 make clean
5607 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5608
5609 msg "build: clang thumb 1 -Os, make"
5610 make clean
5611 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5612}
5613
Gilles Peskine8f073122018-11-27 15:58:47 +01005614component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005615 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005616 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005617 # armc[56] don't support SHA-512 intrinsics
5618 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005619
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005620 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5621 scripts/config.py unset MBEDTLS_AESCE_C
5622
Dave Rodgman0fddf822023-03-02 15:32:12 +00005623 # Stop armclang warning about feature detection for A64_CRYPTO.
5624 # With this enabled, the library does build correctly under armclang,
5625 # but in baremetal builds (as tested here), feature detection is
5626 # unavailable, and the user is notified via a #warning. So enabling
5627 # this feature would prevent us from building with -Werror on
5628 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005629 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005630
Hanno Beckerf0762e92022-07-15 12:08:19 +01005631 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005632
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005633 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005634
5635 msg "size: ARM Compiler 5"
5636 "$ARMC5_FROMELF" -z library/*.o
5637
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005638 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005639
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005640 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005641 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005642
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005643 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005644 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5645
5646 # ARM Compiler 6 - Target ARMv7-M+DSP
5647 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005648
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005649 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005650 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005651
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005652 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005653 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005654
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005655 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5656 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5657
Dave Rodgman99318e62023-05-24 12:27:42 +01005658 # ARM Compiler 6 - Target Cortex-M0
5659 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005660
5661 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5662 #
5663 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5664 # that we have in our CI
5665 scripts/config.py set MBEDTLS_AESCE_C
5666 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005667}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005668
Pengyu Lvdf070032023-02-24 16:03:31 +08005669support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005670 armc5_cc="$ARMC5_BIN_DIR/armcc"
5671 armc6_cc="$ARMC6_BIN_DIR/armclang"
5672 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005673}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005674
Ronald Crond2cb7f42024-03-18 12:49:18 +01005675component_test_tls12_only () {
5676 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5677 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5678 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5679 make
5680
5681 msg "test: main suites (inc. selftests) (ASan build)"
5682 make test
5683
5684 msg "test: ssl-opt.sh (ASan build)"
5685 tests/ssl-opt.sh
5686
5687 msg "test: compat.sh (ASan build)"
5688 tests/compat.sh
5689}
5690
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005691component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005692 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005693 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005694 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005695 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5696
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005697 msg "test: TLS 1.3 only, all key exchange modes enabled"
5698 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005699
Ronald Cronc3f43b62022-10-17 17:35:32 +02005700 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5701 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005702}
5703
Ronald Cronc3f43b62022-10-17 17:35:32 +02005704component_test_tls13_only_psk () {
5705 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5706 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5707 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5708 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005709 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005710 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5711 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5712 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5713 scripts/config.py unset MBEDTLS_ECDSA_C
5714 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005715 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005716 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005717 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5718
Ronald Cronc3f43b62022-10-17 17:35:32 +02005719 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5720 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005721
Ronald Cronc3f43b62022-10-17 17:35:32 +02005722 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5723 tests/ssl-opt.sh
5724}
5725
5726component_test_tls13_only_ephemeral () {
5727 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5728 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5729 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005730 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005731 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5732
5733 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5734 cd tests; ./test_suite_ssl; cd ..
5735
5736 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5737 tests/ssl-opt.sh
5738}
5739
Przemek Stekiela01c2422023-06-13 10:46:48 +02005740component_test_tls13_only_ephemeral_ffdh () {
5741 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5742 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5743 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5744 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005745 scripts/config.py unset MBEDTLS_ECDH_C
5746
Przemek Stekiela01c2422023-06-13 10:46:48 +02005747 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5748
5749 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5750 cd tests; ./test_suite_ssl; cd ..
5751
5752 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5753 tests/ssl-opt.sh
5754}
5755
Ronald Cronc3f43b62022-10-17 17:35:32 +02005756component_test_tls13_only_psk_ephemeral () {
5757 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5758 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5759 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5760 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5761 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5762 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5763 scripts/config.py unset MBEDTLS_ECDSA_C
5764 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005765 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005766 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005767 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5768
5769 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5770 cd tests; ./test_suite_ssl; cd ..
5771
5772 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5773 tests/ssl-opt.sh
5774}
5775
Przemek Stekiela01c2422023-06-13 10:46:48 +02005776component_test_tls13_only_psk_ephemeral_ffdh () {
5777 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5778 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5779 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5780 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5781 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5782 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5783 scripts/config.py unset MBEDTLS_ECDSA_C
5784 scripts/config.py unset MBEDTLS_PKCS1_V21
5785 scripts/config.py unset MBEDTLS_PKCS7_C
5786 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005787 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005788 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5789
5790 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5791 cd tests; ./test_suite_ssl; cd ..
5792
5793 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5794 tests/ssl-opt.sh
5795}
5796
Ronald Cronc3f43b62022-10-17 17:35:32 +02005797component_test_tls13_only_psk_all () {
5798 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5799 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5800 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5801 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5802 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5803 scripts/config.py unset MBEDTLS_ECDSA_C
5804 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005805 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005806 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005807 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5808
5809 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5810 cd tests; ./test_suite_ssl; cd ..
5811
5812 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5813 tests/ssl-opt.sh
5814}
5815
5816component_test_tls13_only_ephemeral_all () {
5817 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5818 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005819 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005820 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5821
5822 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5823 cd tests; ./test_suite_ssl; cd ..
5824
5825 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5826 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005827}
5828
Ronald Cron46ac0652024-03-18 12:39:04 +01005829component_test_tls13_no_padding () {
5830 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005831 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005832 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005833 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005834 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005835 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005836 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005837 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005838 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005839}
5840
Ronald Cron6f135e12021-12-08 16:57:54 +01005841component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005842 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005843 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005844 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005845 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005846 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005847 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005848 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005849 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005850 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005851}
5852
Ronald Crondd96c0a2024-04-02 12:34:24 +02005853component_test_full_minus_session_tickets() {
5854 msg "build: full config without session tickets"
5855 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005856 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005857 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005858 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5859 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005860 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005861 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005862 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005863 tests/ssl-opt.sh
5864}
5865
Gilles Peskine8f073122018-11-27 15:58:47 +01005866component_build_mingw () {
5867 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005868 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 +00005869
Gilles Peskine8f073122018-11-27 15:58:47 +01005870 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005871 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -maes -msse2 -mpclmul' WINDOWS_BUILD=1 tests
Gilles Peskine8f073122018-11-27 15:58:47 +01005872 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005873
Gilles Peskine8f073122018-11-27 15:58:47 +01005874 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005875 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
5876 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 +01005877 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005878
Pengyu Lv158eead2023-10-19 11:27:05 +08005879 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005880 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005881 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 +01005882 make WINDOWS_BUILD=1 clean
5883}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005884support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005885 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5886 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005887 *) true;;
5888 esac
5889}
Simon Butcher91aef332016-11-17 09:20:50 +00005890
Gilles Peskine8f073122018-11-27 15:58:47 +01005891component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005892 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005893 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005894 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5895 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005896
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005897 msg "test: main suites (MSan)" # ~ 10s
5898 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005899
Gilles Peskine6848d172023-11-02 19:58:03 +01005900 msg "test: metatests (MSan)"
5901 tests/scripts/run-metatests.sh any msan
5902
Gilles Peskine82b27272019-06-14 18:27:03 +02005903 msg "program demos (MSan)" # ~20s
5904 tests/scripts/run_demos.py
5905
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005906 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005907 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005908
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005909 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005910
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005911 if [ "$MEMORY" -gt 0 ]; then
5912 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005913 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005914 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005915}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005916
Bence Szépkúti0354d042023-12-06 16:14:37 +01005917component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005918 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005919 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005920 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5921 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005922
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005923 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005924 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005925
Gilles Peskine636c26a2020-03-04 20:46:15 +01005926 # Optional parts (slow; currently broken on OS X because programs don't
5927 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005928 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005929 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005930 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005931 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005932 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005933
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005934 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005935 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005936 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005937 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005938
5939 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005940 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005941 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005942 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005943}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005944
Bence Szépkúti0354d042023-12-06 16:14:37 +01005945component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005946 msg "build: Release, full (clang)"
5947 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5948 scripts/config.py full
5949 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5950 make
5951
5952 msg "test: main suites, Valgrind (full config)"
5953 make memcheck
5954}
5955
Paul Elliott62dc3922021-11-25 17:29:40 +00005956support_test_cmake_out_of_source () {
5957 distrib_id=""
5958 distrib_ver=""
5959 distrib_ver_minor=""
5960 distrib_ver_major=""
5961
5962 # Attempt to parse lsb-release to find out distribution and version. If not
5963 # found this should fail safe (test is supported).
5964 if [[ -f /etc/lsb-release ]]; then
5965
5966 while read -r lsb_line; do
5967 case "$lsb_line" in
5968 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5969 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5970 esac
5971 done < /etc/lsb-release
5972
5973 distrib_ver_major="${distrib_ver%%.*}"
5974 distrib_ver="${distrib_ver#*.}"
5975 distrib_ver_minor="${distrib_ver%%.*}"
5976 fi
5977
5978 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5979 # processor (as the CI does) can create a race condition whereby the build
5980 # fails to see a generated file, despite that file actually having been
5981 # generated. This problem appears to go away with 18.04 or newer, so make
5982 # the out of source tests unsupported on Ubuntu 16.04.
5983 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5984}
5985
Gilles Peskine8f073122018-11-27 15:58:47 +01005986component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005987 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005988 # generates
5989 make neat
5990
Gilles Peskine8f073122018-11-27 15:58:47 +01005991 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005992 MBEDTLS_ROOT_DIR="$PWD"
5993 mkdir "$OUT_OF_SOURCE_DIR"
5994 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005995 # Note: Explicitly generate files as these are turned off in releases
5996 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005997 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005998
Gilles Peskine8f073122018-11-27 15:58:47 +01005999 msg "test: cmake 'out-of-source' build"
6000 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006001 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01006002 # Also ensure that there are no error messages such as
6003 # "No such file or directory", which would indicate that some required
6004 # file is missing (ssl-opt.sh tolerates the absence of some files so
6005 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006006 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006007 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006008 cat ssl-opt.err >&2
6009 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006010 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006011 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006012 cd "$MBEDTLS_ROOT_DIR"
6013 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006014}
Andres AGdc192212016-08-31 17:33:13 +01006015
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006016component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006017 # Remove existing generated files so that we use the ones CMake
6018 # generates
6019 make neat
6020
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006021 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006022 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006023 # Note: Explicitly generate files as these are turned off in releases
6024 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006025 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006026 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006027}
Gilles Peskinea3000992022-02-04 00:21:12 +01006028support_test_cmake_as_subdirectory () {
6029 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006030}
6031
Chris Kayd259e342021-03-25 16:03:25 +00006032component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006033 # Remove existing generated files so that we use the ones CMake
6034 # generates
6035 make neat
6036
Chris Kayd259e342021-03-25 16:03:25 +00006037 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006038 cd programs/test/cmake_package
6039 cmake .
6040 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006041 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006042}
Gilles Peskinea3000992022-02-04 00:21:12 +01006043support_test_cmake_as_package () {
6044 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006045}
6046
6047component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006048 # Remove existing generated files so that we use the ones CMake
6049 # generates
6050 make neat
6051
Chris Kayd259e342021-03-25 16:03:25 +00006052 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006053 cd programs/test/cmake_package_install
6054 cmake .
6055 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006056 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006057}
Gilles Peskinea3000992022-02-04 00:21:12 +01006058support_test_cmake_as_package_install () {
6059 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006060}
6061
David Horstmann20550e32023-01-12 14:17:01 +00006062component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006063 # Make a copy of config file to use for the in-tree test
6064 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006065
6066 MBEDTLS_ROOT_DIR="$PWD"
6067 mkdir "$OUT_OF_SOURCE_DIR"
6068 cd "$OUT_OF_SOURCE_DIR"
6069
David Horstmann969c1452023-01-31 10:34:44 +00006070 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006071 cmake "$MBEDTLS_ROOT_DIR"
6072 make
6073
6074 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6075 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006076 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006077 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6078 make
6079
6080 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6081 # In the user config, disable one feature (for simplicity, pick a feature
6082 # that nothing else depends on).
6083 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6084
6085 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6086 make
6087 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6088
6089 rm -f user_config.h full_config.h
6090
6091 cd "$MBEDTLS_ROOT_DIR"
6092 rm -rf "$OUT_OF_SOURCE_DIR"
6093
6094 # Now repeat the test for an in-tree build:
6095
David Horstmann969c1452023-01-31 10:34:44 +00006096 # Restore config for the in-tree test
6097 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006098
David Horstmann969c1452023-01-31 10:34:44 +00006099 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006100 cmake .
6101 make
6102
6103 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6104 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006105 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006106 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6107 make
6108
6109 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6110 # In the user config, disable one feature (for simplicity, pick a feature
6111 # that nothing else depends on).
6112 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6113
6114 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6115 make
6116 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6117
6118 rm -f user_config.h full_config.h
6119}
6120support_build_cmake_custom_config_file () {
6121 support_test_cmake_out_of_source
6122}
6123
David Horstmann041ed422024-05-10 14:37:48 +01006124component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01006125 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01006126 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
6127 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
6128 make
6129}
6130support_build_cmake_programs_no_testing () {
6131 support_test_cmake_out_of_source
6132}
David Horstmann20550e32023-01-12 14:17:01 +00006133
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006134component_build_zeroize_checks () {
6135 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6136
6137 scripts/config.py full
6138
6139 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006140 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 +01006141}
6142
6143
Gilles Peskine8f073122018-11-27 15:58:47 +01006144component_test_zeroize () {
6145 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6146 # different combinations of compilers and optimization flags by using an
6147 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6148 # system in all cases that the script fails, so we must manually search the
6149 # output to check whether the pass string is present and no failure strings
6150 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006151
Gilles Peskine4976e822019-01-06 19:52:22 +00006152 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6153 # about a spurious message if Gdb tries and fails, so suppress that.
6154 gdb_disable_aslr=
6155 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6156 gdb_disable_aslr='set disable-randomization off'
6157 fi
6158
Gilles Peskine8f073122018-11-27 15:58:47 +01006159 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006160 for compiler in clang gcc; do
6161 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6162 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006163 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6164 grep "The buffer was correctly zeroized" test_zeroize.log
6165 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006166 rm -f test_zeroize.log
6167 make clean
6168 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006169 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006170}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006171
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006172component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006173 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006174 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006175 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006176
6177 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006178 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006179}
6180
6181support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006182 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006183 ver="$(cmake --version)"
6184 ver="${ver#cmake version }"
6185 ver_major="${ver%%.*}"
6186
6187 ver="${ver#*.}"
6188 ver_minor="${ver%%.*}"
6189
6190 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006191}
6192
Gilles Peskinec848d222022-12-09 12:23:35 +01006193component_check_code_style () {
6194 msg "Check C code style"
6195 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006196}
6197
Gilles Peskinec848d222022-12-09 12:23:35 +01006198support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006199 case $(uncrustify --version) in
6200 *0.75.1*) true;;
6201 *) false;;
6202 esac
6203}
6204
Gilles Peskine8f073122018-11-27 15:58:47 +01006205component_check_python_files () {
6206 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006207 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006208}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006209
Joe Subbianid614c0b2021-07-29 11:18:29 +01006210component_check_test_helpers () {
6211 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006212 # unittest writes out mundane stuff like number or tests run on stderr.
6213 # Our convention is to reserve stderr for actual errors, and write
6214 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006215 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006216
Joe Subbiania25ffab2021-08-06 09:41:27 +01006217 msg "unit test: translate_ciphers.py"
6218 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006219}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006220
Valerio Settid9e42512024-05-06 15:59:51 +02006221component_test_psasim() {
Valerio Settid1b6ef12024-05-07 16:00:21 +02006222 msg "build library for client"
6223
6224 helper_crypto_client_build client
6225
6226 msg "build library for server"
6227
6228 scripts/config.py crypto
6229
6230 helper_crypto_client_build server
6231
Valerio Settid9e42512024-05-06 15:59:51 +02006232 msg "build psasim"
Valerio Setti4362aae2024-05-09 09:15:39 +02006233 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Settid9e42512024-05-06 15:59:51 +02006234
6235 msg "test psasim"
Valerio Setti655b9792024-05-09 12:20:40 +02006236 tests/psa-client-server/psasim/test/run_test.sh
Valerio Settid9e42512024-05-06 15:59:51 +02006237
6238 msg "clean psasim"
6239 make -C tests/psa-client-server/psasim clean
6240}
Jerry Yud767cc42023-03-31 15:03:55 +08006241
Gilles Peskine192c72f2017-12-21 15:59:21 +01006242################################################################
6243#### Termination
6244################################################################
6245
Gilles Peskine8f073122018-11-27 15:58:47 +01006246post_report () {
6247 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006248 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006249
Gilles Peskine8f073122018-11-27 15:58:47 +01006250 final_report
6251}
6252
6253
6254
6255################################################################
6256#### Run all the things
6257################################################################
6258
Gilles Peskine5d996822020-03-28 21:09:21 +01006259# Function invoked by --error-test to test error reporting.
6260pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006261 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006262 if [ $KEEP_GOING -ne 0 ]; then
6263 echo "Expect three failing commands."
6264 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006265 # If the component doesn't run in a subshell, changing error_test_i to an
6266 # invalid integer will cause an error in the loop that runs this function.
6267 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006268 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006269 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006270 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006271 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006272 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006273 make unknown_target
6274 false "this should not be executed"
6275}
6276
Gilles Peskinee48351a2018-11-27 16:06:30 +01006277# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006278run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006279 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006280 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006281
6282 # Unconditionally create a seedfile that's sufficiently long.
6283 # Do this before each component, because a previous component may
6284 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006285 local dd_cmd
6286 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6287 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006288 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006289 esac
6290 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006291
Gilles Peskineec135542021-08-02 23:14:03 +02006292 # Run the component in a subshell, with error trapping and output
6293 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006294 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006295 # We want to keep running if the subshell fails, so 'set -e' must
6296 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006297 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006298 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006299 (
6300 if [ $QUIET -eq 1 ]; then
6301 # msg() will be silenced, so just print the component name here.
6302 echo "${current_component#component_}"
6303 exec >/dev/null
6304 fi
6305 if [ $KEEP_GOING -eq 1 ]; then
6306 # Keep "set -e" off, and run an ERR trap instead to record failures.
6307 set -E
6308 trap err_trap ERR
6309 fi
6310 # The next line is what runs the component
6311 "$@"
6312 if [ $KEEP_GOING -eq 1 ]; then
6313 trap - ERR
6314 exit $last_failure_status
6315 fi
6316 )
6317 component_status=$?
6318 if [ $KEEP_GOING -eq 1 ]; then
6319 set -e
6320 if [ $component_status -ne 0 ]; then
6321 failure_count=$((failure_count + 1))
6322 fi
6323 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006324
6325 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006326 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006327 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006328}
6329
6330# Preliminary setup
6331pre_check_environment
6332pre_initialize_variables
6333pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006334
Dave Rodgman21900632024-02-26 11:41:19 +00006335setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006336pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006337pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006338pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006339
Gilles Peskine878cf602019-01-06 20:50:38 +00006340build_status=0
6341if [ $KEEP_GOING -eq 1 ]; then
6342 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006343fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006344pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006345pre_print_configuration
6346pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006347cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006348if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006349 pre_generate_files
6350fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006351
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006352# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006353for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006354 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006355done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006356unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006357for component in $RUN_COMPONENTS; do
6358 run_component "component_$component"
6359done
Gilles Peskine8f073122018-11-27 15:58:47 +01006360
6361# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006362post_report