blob: 88d051b0f5fef2d08d92260f8d82c48f0d4785b6 [file] [log] [blame]
Gilles Peskine62cf2e82020-03-27 16:35:23 +01001#! /usr/bin/env bash
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine192c72f2017-12-21 15:59:21 +01007
8
9
10################################################################
11#### Documentation
12################################################################
13
Simon Butcher3ea7f522016-03-07 23:22:10 +000014# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010015# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000016#
SimonB2e23c822016-04-16 21:54:39 +010017# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010018#
Gilles Peskine192c72f2017-12-21 15:59:21 +010019# Notes for users
20# ---------------
21#
SimonB2e23c822016-04-16 21:54:39 +010022# Warning: the test is destructive. It includes various build modes and
23# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010024# configuration. The following files must be committed into git:
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020025# * include/mbedtls/mbedtls_config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010026# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
27# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010028# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040038# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010039# * arm-gcc and mingw-gcc
40# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine7be571a2023-08-27 21:39:21 +020041# * OpenSSL and GnuTLS command line tools, in suitable versions for the
42# interoperability tests. The following are the official versions at the
43# time of writing:
44# * GNUTLS_{CLI,SERV} = 3.4.10
45# * GNUTLS_NEXT_{CLI,SERV} = 3.7.2
46# * OPENSSL = 1.0.2g (without Debian/Ubuntu patches)
Ronald Cronc5e81d22024-04-02 14:39:53 +020047# * OPENSSL_NEXT = 3.1.2
Gilles Peskine192c72f2017-12-21 15:59:21 +010048# See the invocation of check_tools below for details.
49#
50# This script must be invoked from the toplevel directory of a git
51# working copy of Mbed TLS.
52#
Gilles Peskinece266c42020-03-28 18:50:43 +010053# The behavior on an error depends on whether --keep-going (alias -k)
54# is in effect.
55# * Without --keep-going: the script stops on the first error without
56# cleaning up. This lets you work in the configuration of the failing
57# component.
58# * With --keep-going: the script runs all requested components and
59# reports failures at the end. In particular the script always cleans
60# up on exit.
61#
Gilles Peskine192c72f2017-12-21 15:59:21 +010062# Note that the output is not saved. You may want to run
63# script -c tests/scripts/all.sh
64# or
65# tests/scripts/all.sh >all.log 2>&1
66#
67# Notes for maintainers
68# ---------------------
69#
Gilles Peskine8f073122018-11-27 15:58:47 +010070# The bulk of the code is organized into functions that follow one of the
71# following naming conventions:
72# * pre_XXX: things to do before running the tests, in order.
73# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010074# * component_check_XXX: quick tests that aren't worth parallelizing.
75# * component_build_XXX: build things but don't run them.
76# * component_test_XXX: build and test.
Bence Szépkúti89dd5c02023-12-15 17:05:15 +010077# * component_release_XXX: tests that the CI should skip during PR testing.
Gilles Peskine878cf602019-01-06 20:50:38 +000078# * support_XXX: if support_XXX exists and returns false then
79# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010080# * post_XXX: things to do after running the tests.
81# * other: miscellaneous support functions.
82#
Gilles Peskinec70637a2019-01-09 22:29:17 +010083# Each component must start by invoking `msg` with a short informative message.
84#
Gilles Peskinea681c592020-03-28 21:27:40 +010085# Warning: due to the way bash detects errors, the failure of a command
86# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
87#
Gilles Peskinece266c42020-03-28 18:50:43 +010088# Each component is executed in a separate shell process. The component
89# fails if any command in it returns a non-zero status.
90#
Gilles Peskinec70637a2019-01-09 22:29:17 +010091# The framework performs some cleanup tasks after each component. This
92# means that components can assume that the working directory is in a
93# cleaned-up state, and don't need to perform the cleanup themselves.
94# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010095# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010096# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010097# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
98# `tests/Makefile` and `programs/fuzz/Makefile` from git.
99# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100100#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100101# The tests are roughly in order from fastest to slowest. This doesn't
102# have to be exact, but in general you should add slower tests towards
103# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100104
105
106
107################################################################
108#### Initialization and command line parsing
109################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100110
Gilles Peskine36647802020-03-28 18:50:49 +0100111# Abort on errors (even on the left-hand side of a pipe).
112# Treat uninitialised variables as errors.
113set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100114
Gilles Peskine076f7252022-08-30 21:02:44 +0200115# Enable ksh/bash extended file matching patterns
116shopt -s extglob
117
David Horstmann76a77382023-08-17 17:32:26 +0100118in_mbedtls_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100119 test -d include -a -d library -a -d programs -a -d tests
120}
121
Ronald Cron070e8652023-10-09 10:25:45 +0200122in_tf_psa_crypto_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100123 test -d include -a -d core -a -d drivers -a -d programs -a -d tests
David Horstmann9a6c45b2023-07-14 12:30:00 +0100124}
125
Gilles Peskine8f073122018-11-27 15:58:47 +0100126pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200127 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
128 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100129 exit 1
130 fi
131}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100132
Gilles Peskine8f073122018-11-27 15:58:47 +0100133pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100134 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100135 CONFIG_H='include/mbedtls/mbedtls_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100136 else
137 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100138 fi
John Durkopbd069d32020-10-31 22:14:03 -0700139 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100140 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200141
142 # Files that are clobbered by some jobs will be backed up. Use a different
143 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
144 # independently decide when to remove the backup file.
145 backup_suffix='.all.bak'
146 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100147 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100148 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100149 # Files clobbered by in-tree cmake
150 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
151 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200152
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200153 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100154 MEMORY=0
155 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200156 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100157 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100158
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200159 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200160 #
161 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
162 # both values are kept in sync. If you change the value here because it
163 # breaks some tests, you'll definitely want to change it in
164 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200165 RELEASE_SEED=1
166
Yanray Wang18040ed2023-11-23 21:29:56 +0800167 # Specify character collation for regular expressions and sorting with C locale
168 export LC_COLLATE=C
169
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200170 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200171 : ${MBEDTLS_TEST_PLATFORM="$(uname -s | tr -c \\n0-9A-Za-z _)-$(uname -m | tr -c \\n0-9A-Za-z _)"}
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200172 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200173 export MBEDTLS_TEST_PLATFORM
174
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000175 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100176 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100177 : ${OPENSSL_NEXT:="$OPENSSL"}
178 : ${GNUTLS_CLI:="gnutls-cli"}
179 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100180 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
181 : ${ARMC5_BIN_DIR:=/usr/bin}
182 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200183 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200184 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100185 : ${CLANG_LATEST:="clang-latest"}
186 : ${CLANG_EARLIEST:="clang-earliest"}
187 : ${GCC_LATEST:="gcc-latest"}
188 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100189 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000190 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200191 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100192 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000193 # if CC is not set, use clang by default (if present) to improve build times
194 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000195 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000196 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000197
Ronald Cronc5e81d22024-04-02 14:39:53 +0200198 if [ -n "${OPENSSL_3+set}" ]; then
199 export OPENSSL_NEXT="$OPENSSL_3"
200 fi
201
Gilles Peskine396853a2021-09-20 18:57:55 +0200202 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000203 export CTEST_OUTPUT_ON_FAILURE=1
204
Gilles Peskine8fd59422019-10-21 17:11:33 +0200205 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100206 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200207 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000208 # Normally, tests should use this compiler for ASAN testing
209 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200210
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400211 # Platform tests have an allocation that returns null
212 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400213 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400214
Gilles Peskine878cf602019-01-06 20:50:38 +0000215 # Gather the list of available components. These are the functions
216 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100217 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000218
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000219 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100220 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100221}
Andres AG38495a32016-07-12 16:54:33 +0100222
Dave Rodgman21900632024-02-26 11:41:19 +0000223setup_quiet_wrappers()
224{
225 # Pick up "quiet" wrappers for make and cmake, which don't output very much
226 # unless there is an error. This reduces logging overhead in the CI.
227 #
228 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000229 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
230 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000231 fi
232}
233
Gilles Peskinea28db922019-01-10 00:05:18 +0100234# Test whether the component $1 is included in the command line patterns.
235is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100236{
Gilles Peskine03af6782021-08-06 11:35:17 +0200237 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
238 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100239 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000240 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100241 set +f
242 case ${1#component_} in $pattern) return 0;; esac
243 done
244 set +f
245 return 1
246}
Andres AG7770ea82016-10-10 15:46:20 +0100247
Simon Butcher41eeccf2016-09-07 00:07:09 +0100248usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100249{
Gilles Peskine709346a2017-12-10 23:43:39 +0100250 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100251Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100252Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100253By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100254COMPONENT can be the name of a component or a shell wildcard pattern.
255
256Examples:
257 $0 "check_*"
258 Run all sanity checks.
259 $0 --no-armcc --except test_memsan
260 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100261
262Special options:
263 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000264 --list-all-components List all available test components and exit.
265 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100266
267General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200268 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100269 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100270 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100271 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200272 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200273 --arm-none-eabi-gcc-prefix=<string>
274 Prefix for a cross-compiler for arm-none-eabi
275 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200276 --arm-linux-gnueabi-gcc-prefix=<string>
277 Prefix for a cross-compiler for arm-linux-gnueabi
278 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100279 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200280 --restore First clean up the build tree, restoring backed up
281 files. Do not run any components unless they are
282 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100283 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200284 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100285 --except Exclude the COMPONENTs listed on the command line,
286 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200287 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100288 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100289 --no-force Refuse to overwrite modified files (default).
290 --no-keep-going Stop at the first error (default).
291 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800292 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100293 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200294 --outcome-file=<path> File where test outcomes are written (not done if
295 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100296 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200297 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100298 -s|--seed Integer seed value to use for this test run.
299
300Tool path options:
301 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
302 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100303 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
304 --clang-latest=<Clang_latest_path> Latest version of clang available
305 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
306 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100307 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
308 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100309 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100310 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100311EOF
SimonB2e23c822016-04-16 21:54:39 +0100312}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100313
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200314# Cleanup before/after running a component.
315# Remove built files as well as the cmake cache/config.
316# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100317cleanup()
318{
David Horstmann76a77382023-08-17 17:32:26 +0100319 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100320 command make clean
321 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200322
Gilles Peskine31b07e22018-03-21 12:15:06 +0100323 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000324 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100325 -iname CMakeFiles -exec rm -rf {} \+ -o \
326 \( -iname cmake_install.cmake -o \
327 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200328 -iname CMakeCache.txt -o \
329 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100330 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200331 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200332
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100333 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
334 rm -rf programs/test/cmake_subproject/build
335 rm -f programs/test/cmake_subproject/Makefile
336 rm -f programs/test/cmake_subproject/cmake_subproject
337
Chris Kayd259e342021-03-25 16:03:25 +0000338 # Remove any artifacts from the component_test_cmake_as_package test.
339 rm -rf programs/test/cmake_package/build
340 rm -f programs/test/cmake_package/Makefile
341 rm -f programs/test/cmake_package/cmake_package
342
343 # Remove any artifacts from the component_test_cmake_as_installed_package test.
344 rm -rf programs/test/cmake_package_install/build
345 rm -f programs/test/cmake_package_install/Makefile
346 rm -f programs/test/cmake_package_install/cmake_package_install
347
Gilles Peskinef83eb822020-03-30 20:11:39 +0200348 # Restore files that may have been clobbered by the job
349 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200350 if [[ -e "$x$backup_suffix" ]]; then
351 cp -p "$x$backup_suffix" "$x"
352 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200353 done
354}
John Durkopbd069d32020-10-31 22:14:03 -0700355
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200356# Final cleanup when this script exits (except when exiting on a failure
357# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200358final_cleanup () {
359 cleanup
360
361 for x in $files_to_back_up; do
362 rm -f "$x$backup_suffix"
363 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100364}
365
Gilles Peskine7c652162017-12-11 00:01:40 +0100366# Executed on exit. May be redefined depending on command line options.
367final_report () {
368 :
369}
370
371fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200372 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100373 final_report $1
374 trap - $1
375 kill -$1 $$
376}
377
378trap 'fatal_signal HUP' HUP
379trap 'fatal_signal INT' INT
380trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200381
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200382# Number of processors on this machine. Used as the default setting
383# for parallel make.
384all_sh_nproc ()
385{
386 {
387 nproc || # Linux
388 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
389 sysctl -n hw.ncpu || # FreeBSD
390 echo 1
391 } 2>/dev/null
392}
393
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100394msg()
395{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100396 if [ -n "${current_component:-}" ]; then
397 current_section="${current_component#component_}: $1"
398 else
399 current_section="$1"
400 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200401
402 if [ $QUIET -eq 1 ]; then
403 return
404 fi
405
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100406 echo ""
407 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100408 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000409 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100410 echo "******************************************************************"
411}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100412
Gilles Peskine8f073122018-11-27 15:58:47 +0100413armc6_build_test()
414{
415 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100416
Gilles Peskine18487f62020-04-30 23:11:54 +0200417 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800418 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100419 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000420 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200421
422 msg "size: ARM Compiler 6 ($FLAGS)"
423 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100424}
Andres AGa5cd9732016-10-17 15:23:10 +0100425
Andres AGd9eba4b2016-08-26 14:42:14 +0100426err_msg()
427{
428 echo "$1" >&2
429}
430
431check_tools()
432{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200433 for tool in "$@"; do
434 if ! `type "$tool" >/dev/null 2>&1`; then
435 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100436 exit 1
437 fi
438 done
439}
440
Gilles Peskine8f073122018-11-27 15:58:47 +0100441pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000442 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100443 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100444 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100445 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200446 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000447 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100448
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000449 # Note that legacy options are ignored instead of being omitted from this
450 # list of options, so invocations that worked with previous version of
451 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100452 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100453 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200454 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200455 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200456 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000457 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100458 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
459 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100460 --clang-earliest) shift; CLANG_EARLIEST="$1";;
461 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100462 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000463 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100464 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100465 --gcc-earliest) shift; GCC_EARLIEST="$1";;
466 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100467 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200468 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
469 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100470 --gnutls-serv) shift; GNUTLS_SERV="$1";;
471 --help|-h) usage; exit;;
472 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000473 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100474 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100475 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200476 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000477 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --no-force) FORCE=0;;
479 --no-keep-going) KEEP_GOING=0;;
480 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200481 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100482 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100483 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200484 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100485 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200486 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100487 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200488 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200489 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100490 --seed|-s) shift; SEED="$1";;
491 -*)
492 echo >&2 "Unknown option: $1"
493 echo >&2 "Run $0 --help for usage."
494 exit 120
495 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000496 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100497 esac
498 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100499 done
SimonB2e23c822016-04-16 21:54:39 +0100500
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100501 # Exclude components that are not supported on this platform.
502 SUPPORTED_COMPONENTS=
503 for component in $ALL_COMPONENTS; do
504 case $(type "support_$component" 2>&1) in
505 *' function'*)
506 if ! support_$component; then continue; fi;;
507 esac
508 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
509 done
510
511 if [ $list_components -eq 1 ]; then
512 printf '%s\n' $SUPPORTED_COMPONENTS
513 exit
514 fi
515
Gilles Peskinea28db922019-01-10 00:05:18 +0100516 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200517 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000518 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100519 fi
520
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000521 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
522 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100523 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000524 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100525 fi
SimonB2e23c822016-04-16 21:54:39 +0100526
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200527 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100528 if [ $all_except -eq 0 ]; then
529 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200530 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
531 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200532 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100533 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200534 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200535 # If the requested name includes a wildcard character, don't
536 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100537 case $component in
538 *[*?\[]*) continue;;
539 esac
540 case " $SUPPORTED_COMPONENTS " in
541 *" $component "*) :;;
542 *)
543 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
544 unsupported=$((unsupported + 1));;
545 esac
546 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200547 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100548 if [ $unsupported -ne 0 ]; then
549 exit 2
550 fi
551 fi
552
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000553 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100554 RUN_COMPONENTS=
555 for component in $SUPPORTED_COMPONENTS; do
556 if is_component_included "$component"; [ $? -eq $all_except ]; then
557 RUN_COMPONENTS="$RUN_COMPONENTS $component"
558 fi
559 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000560
561 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000562 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100563}
SimonB2e23c822016-04-16 21:54:39 +0100564
Gilles Peskine8f073122018-11-27 15:58:47 +0100565pre_check_git () {
566 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100567 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100568 git checkout-index -f -q $CONFIG_H
569 cleanup
570 else
SimonB2e23c822016-04-16 21:54:39 +0100571
Gilles Peskine8f073122018-11-27 15:58:47 +0100572 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
573 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
574 echo "You can either delete this directory manually, or force the test by rerunning"
575 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
576 exit 1
577 fi
578
Ronald Cron7a93ac52023-07-20 09:49:12 +0200579 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100580 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100581 echo "You can either delete or preserve your work, or force the test by rerunning the"
582 echo "script as: $0 --force"
583 exit 1
584 fi
SimonB2e23c822016-04-16 21:54:39 +0100585 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500586}
587
Gilles Peskine568f53a2021-07-12 18:16:01 +0200588pre_restore_files () {
589 # If the makefiles have been generated by a framework such as cmake,
590 # restore them from git. If the makefiles look like modifications from
591 # the ones checked into git, take care not to modify them. Whatever
592 # this function leaves behind is what the script will restore before
593 # each component.
594 case "$(head -n1 Makefile)" in
595 *[Gg]enerated*)
596 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
597 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
598 ;;
599 esac
600}
601
Gilles Peskinef83eb822020-03-30 20:11:39 +0200602pre_back_up () {
603 for x in $files_to_back_up; do
604 cp -p "$x" "$x$backup_suffix"
605 done
606}
607
Gilles Peskine8f073122018-11-27 15:58:47 +0100608pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100609 failure_count=0 # Number of failed components
610 last_failure_status=0 # Last failure status in this component
611
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100612 # See err_trap
613 previous_failure_status=0
614 previous_failed_command=
615 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100616 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100617
Gilles Peskine7c652162017-12-11 00:01:40 +0100618 start_red=
619 end_color=
620 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100621 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100622 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
623 start_red=$(printf '\033[31m')
624 end_color=$(printf '\033[0m')
625 ;;
626 esac
627 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100628
629 # Keep a summary of failures in a file. We'll print it out at the end.
630 failure_summary_file=$PWD/all-sh-failures-$$.log
631 : >"$failure_summary_file"
632
633 # Whether it makes sense to keep a component going after the specified
634 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200635 # This function normally receives the failing simple command
636 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
637 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100638 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200639 # False positives result in running things that can't be expected to
640 # work. False negatives result in things not running after something else
641 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100642 can_keep_going_after_failure () {
643 case "$1" in
644 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200645 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100646 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200647 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
648 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
649 *make*check*) true;;
650 "grep "*) true;;
651 "[ "*) true;;
652 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100653 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100654 esac
655 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100656
657 # This function runs if there is any error in a component.
658 # It must either exit with a nonzero status, or set
659 # last_failure_status to a nonzero value.
660 err_trap () {
661 # Save $? (status of the failing command). This must be the very
662 # first thing, before $? is overridden.
663 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100664 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100665
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100666 if [[ $last_failure_status -eq $previous_failure_status &&
667 "$failed_command" == "$previous_failed_command" &&
668 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
669 then
670 # The same command failed twice in a row, but this time one level
671 # less deep in the function call stack. This happens when the last
672 # command of a function returns a nonzero status, and the function
673 # returns that same status. Ignore the second failure.
674 previous_failure_funcall_depth=${#FUNCNAME[@]}
675 return
676 fi
677 previous_failure_status=$last_failure_status
678 previous_failed_command=$failed_command
679 previous_failure_funcall_depth=${#FUNCNAME[@]}
680
Gilles Peskinece266c42020-03-28 18:50:43 +0100681 text="$current_section: $failed_command -> $last_failure_status"
682 echo "${start_red}^^^^$text^^^^${end_color}" >&2
683 echo "$text" >>"$failure_summary_file"
684
685 # If the command is fatal (configure or build command), stop this
686 # component. Otherwise (test command) keep the component running
687 # (run more tests from the same build).
688 if ! can_keep_going_after_failure "$failed_command"; then
689 exit $last_failure_status
690 fi
691 }
692
Gilles Peskine7c652162017-12-11 00:01:40 +0100693 final_report () {
694 if [ $failure_count -gt 0 ]; then
695 echo
696 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100697 echo "${start_red}FAILED: $failure_count components${end_color}"
698 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100699 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
700 elif [ -z "${1-}" ]; then
701 echo "SUCCESS :)"
702 fi
703 if [ -n "${1-}" ]; then
704 echo "Killed by SIG$1."
705 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100706 rm -f "$failure_summary_file"
707 if [ $failure_count -gt 0 ]; then
708 exit 1
709 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100710 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100711}
712
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200713# record_status() and if_build_succeeded() are kept temporarily for backward
714# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100715record_status () {
716 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100717}
Gilles Peskine7c652162017-12-11 00:01:40 +0100718if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100719 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100720}
721
Gilles Peskinea681c592020-03-28 21:27:40 +0100722# '! true' does not trigger the ERR trap. Arrange to trigger it, with
723# a reasonably informative error message (not just "$@").
724not () {
725 if "$@"; then
726 report_failed_command="! $*"
727 false
728 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200729 fi
730}
731
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200732pre_prepare_outcome_file () {
733 case "$MBEDTLS_TEST_OUTCOME_FILE" in
734 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
735 esac
736 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
737 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
738 fi
739}
740
Gilles Peskine8f073122018-11-27 15:58:47 +0100741pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200742 if [ $QUIET -eq 1 ]; then
743 return
744 fi
745
Gilles Peskine8f073122018-11-27 15:58:47 +0100746 msg "info: $0 configuration"
747 echo "MEMORY: $MEMORY"
748 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200749 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100750 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100751 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100752 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100753 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
754 echo "GNUTLS_CLI: $GNUTLS_CLI"
755 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100756 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
757 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
758}
Andres AG7770ea82016-10-10 15:46:20 +0100759
Andres AGd9eba4b2016-08-26 14:42:14 +0100760# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100761pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000762 # Build the list of variables to pass to output_env.sh.
763 set env
SimonB2e23c822016-04-16 21:54:39 +0100764
Gilles Peskine87964262019-01-06 22:40:00 +0000765 case " $RUN_COMPONENTS " in
766 # Require OpenSSL and GnuTLS if running any tests (as opposed to
767 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
768 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100769 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000770 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
771 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100772 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000773 export GNUTLS_CLI="$GNUTLS_CLI"
774 export GNUTLS_SERV="$GNUTLS_SERV"
775 # Avoid passing --seed flag in every call to ssl-opt.sh
776 if [ -n "${SEED-}" ]; then
777 export SEED
778 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200779 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000780 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200781 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
782 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000783 ;;
784 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200785
Gilles Peskine87964262019-01-06 22:40:00 +0000786 case " $RUN_COMPONENTS " in
787 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
788 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100789
Gilles Peskine87964262019-01-06 22:40:00 +0000790 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200791 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000792 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100793
Gilles Peskine87964262019-01-06 22:40:00 +0000794 case " $RUN_COMPONENTS " in
795 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
796 esac
797
798 case " $RUN_COMPONENTS " in
799 *" test_zeroize "*) check_tools "gdb";;
800 esac
801
802 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000803 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000804 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
805 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200806 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000807 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
808 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200809 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
810 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
811 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000812 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000813
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200814 # past this point, no call to check_tool, only printing output
815 if [ $QUIET -eq 1 ]; then
816 return
817 fi
818
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000819 msg "info: output_env.sh"
820 case $RUN_COMPONENTS in
821 *_armcc*)
822 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
823 *) set "$@" RUN_ARMCC=0;;
824 esac
825 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100826}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100827
Gilles Peskine1570b592021-04-22 01:10:12 +0200828pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200829 # since make doesn't have proper dependencies, remove any possibly outdate
830 # file that might be around before generating fresh ones
831 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200832 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200833 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200834 else
835 make generated_files
836 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200837}
838
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000839clang_version() {
840 if command -v clang > /dev/null ; then
841 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
842 else
843 echo 0 # report version 0 for "no clang"
844 fi
845}
846
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200847################################################################
848#### Helpers for components using libtestdriver1
849################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100850
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200851# How to use libtestdriver1
852# -------------------------
853#
854# 1. Define the list algorithms and key types to accelerate,
855# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
856# Examples:
857# - loc_accel_list="ALG_JPAKE"
858# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200859# 2. Make configurations changes for the driver and/or main libraries.
860# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
861# can be either "default" to start with the default config, or a name
862# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200863# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200864# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
865# These changes affect both the driver and the main libraries.
866# (Note: they need to have the same set of PSA_WANT symbols, as that
867# determines the ABI between them.)
868# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
869# main libraries. Typically, you want to disable the module(s) that are
870# being accelerated. You may need to also disable modules that depend
871# on them or options that are not supported with drivers.
872# 2d. On top of psa/crypto_config.h, the driver library uses its own config
873# file: tests/include/test/drivers/config_test_driver.h. You usually
874# don't need to edit it: using loc_extra_list (see below) is preferred.
875# However, when there's no PSA symbol for what you want to enable,
876# calling scripts/config.py on this file remains the only option.
877# 3. Build the driver library, then the main libraries, test, and programs.
878# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
879# need to enable more algorithms here, typically hash algorithms when
880# accelerating some signature algorithms (ECDSA, RSAv2). This is done
881# by passing a 2nd argument listing the extra algorithms.
882# Example:
883# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
884# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800885# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200886# additional arguments will be passed to make: this can be useful if
887# you don't want to build everything when iterating during development.
888# Example:
889# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
890# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200891
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200892# Adjust the configuration - for both libtestdriver1 and main library,
893# as they should have the same PSA_WANT macros.
894helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200895 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200896 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200897 if [ "$base_config" != "default" ]; then
898 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200899 fi
900
901 # Enable PSA-based config (necessary to use drivers)
902 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
903
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200904 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
905 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
906 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000907
908 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
909 # otherwise we will end up running multithreaded tests without mutexes to protect them.
910 if scripts/config.py get MBEDTLS_THREADING_C; then
911 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
912 fi
913
914 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
915 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
916 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200917}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100918
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100919# Build the drivers library libtestdriver1.a (with ASan).
920#
921# Parameters:
922# 1. a space-separated list of things to accelerate;
923# 2. optional: a space-separate list of things to also support.
924# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
925helper_libtestdriver1_make_drivers() {
926 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
927 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
928}
929
930# Build the main libraries, programs and tests,
931# linking to the drivers library (with ASan).
932#
933# Parameters:
934# 1. a space-separated list of things to accelerate;
935# *. remaining arguments if any are passed directly to make
936# (examples: lib, -C tests test_suite_xxx, etc.)
937# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
938helper_libtestdriver1_make_main() {
939 loc_accel_list=$1
940 shift
941
942 # we need flags both with and without the LIBTESTDRIVER1_ prefix
943 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
944 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
945 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include -I../tests -I../../tests -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_TEST_LIBTESTDRIVER1 $loc_accel_flags" LDFLAGS="-ltestdriver1 $ASAN_CFLAGS" "$@"
946}
947
Valerio Settid1b6ef12024-05-07 16:00:21 +0200948# $1: target which can be "client" or "server"
949helper_crypto_client_build() {
950 TARGET=$1
Valerio Settic98f8ab2024-05-10 15:53:40 +0200951 shift
Valerio Settid1b6ef12024-05-07 16:00:21 +0200952 TARGET_LIB=libpsa$TARGET
953
Valerio Settid1b6ef12024-05-07 16:00:21 +0200954 if [ "$TARGET" == "client" ]; then
955 scripts/config.py full
956 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
957 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
958 # Dynamic secure element support is a deprecated feature and it is not
959 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
960 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
961 # Disable potentially problematic features
962 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
963 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
964 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
965 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
966 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
967 else
968 scripts/config.py crypto_full
969 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
970 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200971 fi
972
Valerio Settif57afd52024-05-14 10:39:20 +0200973 make -C tests/psa-client-server/psasim/ CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
Valerio Settid1b6ef12024-05-07 16:00:21 +0200974}
975
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100976################################################################
977#### Configuration helpers
978################################################################
979
Valerio Settib2fd6732023-08-15 17:10:47 +0200980# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200981# The function optionally accepts 1 parameter: a space-separated list of the
982# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200983helper_disable_builtin_curves() {
984 allowed_list="${1:-}"
985 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
986
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200987 for curve in $allowed_list; do
988 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200989 done
990}
991
992# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
993# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
994# in the following helpers.
995helper_get_psa_curve_list () {
996 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200997 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
998 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200999 done
1000
1001 echo "$loc_list"
1002}
1003
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001004# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1005# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1006# in the following helpers.
1007helper_get_psa_dh_group_list () {
1008 loc_list=""
1009 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1010 loc_list="$loc_list $item"
1011 done
1012
1013 echo "$loc_list"
1014}
1015
Valerio Settib2fd6732023-08-15 17:10:47 +02001016# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001017# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001018# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001019helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001020 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001021 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001022 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 +02001023 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1024 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001025 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1026 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001027 fi
1028 done
1029
1030 echo "$loc_list"
1031}
1032
Gilles Peskine192c72f2017-12-21 15:59:21 +01001033################################################################
1034#### Basic checks
1035################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001036
1037#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001038# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001039#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001040# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001041# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001042# 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 +02001043# time, so start with a GCC build).
1044# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001045#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001046# Indicative running times are given for reference.
1047
Gilles Peskine8f073122018-11-27 15:58:47 +01001048component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001049 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001050 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001051}
Janos Follathb72c6782016-07-19 14:54:17 +01001052
Gilles Peskine67debb62021-05-18 16:09:50 +02001053component_check_generated_files () {
1054 msg "Check: check-generated-files, files generated with make" # 2s
1055 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001056 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001057
1058 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001059 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001060 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001061 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001062
1063 msg "Check: check-generated-files -u, files absent" # 2s
1064 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001065 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001066 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001067 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001068
1069 # This component ends with the generated files present in the source tree.
1070 # This is necessary for subsequent components!
1071}
1072
Gilles Peskine8f073122018-11-27 15:58:47 +01001073component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001074 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001075 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001076}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001077
Gilles Peskine8f073122018-11-27 15:58:47 +01001078component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001079 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001080 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001081}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001082
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001083component_check_changelog () {
1084 msg "Check: changelog entries" # < 1s
1085 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001086 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001087 if [ -e ChangeLog.new ]; then
1088 # Show the diff for information. It isn't an error if the diff is
1089 # non-empty.
1090 diff -u ChangeLog ChangeLog.new || true
1091 rm ChangeLog.new
1092 fi
1093}
1094
Gilles Peskine8f073122018-11-27 15:58:47 +01001095component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001096 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001097 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001098}
Darryl Greena07039c2018-03-13 16:48:16 +00001099
Gilles Peskine895868b2019-09-19 21:30:05 +02001100component_check_test_cases () {
1101 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001102 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001103 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001104 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001105 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001106 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001107 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001108 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001109}
1110
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001111component_check_test_dependencies () {
1112 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001113 # The purpose of this component is to catch unjustified dependencies on
1114 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1115 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1116 # MBEDTLS_PSA_xxx).
1117 #
1118 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1119 # this component is meant to catch. However a few of them are justified,
1120 # mostly by the absence of a PSA equivalent, so this component includes a
1121 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001122
1123 found="check-test-deps-found-$$"
1124 expected="check-test-deps-expected-$$"
1125
1126 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001127 grep 'depends_on' \
1128 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001129 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001130 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001131 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001132
Yanray Wang18040ed2023-11-23 21:29:56 +08001133 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001134 rm -f $expected
1135 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1136 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001137 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1138 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001139 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1140 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001141 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1142 # the test code and that's probably the most convenient way of achieving
1143 # the test's goal.
1144 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1145 # No PSA equivalent - we should probably have one in the future.
1146 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1147 # No PSA equivalent - needed by some init tests
1148 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001149 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001150 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001151
1152 # Compare reality with expectation.
1153 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001154 #
1155 # The output should be empty. When it's not:
1156 # - Each '+' line is a macro that was found but not expected. You want to
1157 # find where that macro occurs, and either replace it with PSA macros, or
1158 # add it to the exceptions list above with a justification.
1159 # - Each '-' line is a macro that was expected but not found; it means the
1160 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001161 diff -U0 $expected $found
1162
1163 rm $found $expected
1164}
1165
Gilles Peskine8f073122018-11-27 15:58:47 +01001166component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001167 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001168 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001169}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001170
Gilles Peskine192c72f2017-12-21 15:59:21 +01001171
Gilles Peskine636c26a2020-03-04 20:46:15 +01001172
Gilles Peskine192c72f2017-12-21 15:59:21 +01001173################################################################
1174#### Build and test many configurations and targets
1175################################################################
1176
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001177component_test_default_out_of_box () {
1178 msg "build: make, default config (out-of-box)" # ~1min
1179 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001180 # Disable fancy stuff
1181 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001182
1183 msg "test: main suites make, default config (out-of-box)" # ~10s
1184 make test
1185
1186 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001187 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001188
1189 msg "program demos: make, default config (out-of-box)" # ~10s
1190 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001191}
1192
Gilles Peskine8f073122018-11-27 15:58:47 +01001193component_test_default_cmake_gcc_asan () {
1194 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001195 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1196 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001197
Gilles Peskine8f073122018-11-27 15:58:47 +01001198 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1199 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001200
Gilles Peskine82b27272019-06-14 18:27:03 +02001201 msg "program demos (ASan build)" # ~10s
1202 tests/scripts/run_demos.py
1203
Gilles Peskine97bea012020-04-23 23:37:45 +02001204 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001205 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001206
Gilles Peskine6848d172023-11-02 19:58:03 +01001207 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001208 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001209
Gilles Peskine8f073122018-11-27 15:58:47 +01001210 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001211 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001212
Gilles Peskine8f073122018-11-27 15:58:47 +01001213 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001214 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001215
1216 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001217 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001218}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001219
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001220component_test_default_cmake_gcc_asan_new_bignum () {
1221 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001222 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001223 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001224 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001225
1226 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1227 make test
1228
1229 msg "test: selftest (ASan build)" # ~ 10s
1230 programs/test/selftest
1231
1232 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1233 tests/ssl-opt.sh
1234
1235 msg "test: compat.sh (ASan build)" # ~ 6 min
1236 tests/compat.sh
1237
1238 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1239 tests/context-info.sh
1240}
1241
Hanno Becker01635512019-02-26 14:27:09 +00001242component_test_full_cmake_gcc_asan () {
1243 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001244 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001245 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1246 make
1247
1248 msg "test: main suites (inc. selftests) (full config, ASan build)"
1249 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001250
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001251 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001252 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001253
Gilles Peskine636c26a2020-03-04 20:46:15 +01001254 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001255 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001256
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001257 # Note: the next two invocations cover all compat.sh test cases.
1258 # We should use the same here and in basic-build-test.sh.
1259 msg "test: compat.sh: default version (full config, ASan build)"
1260 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001261
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001262 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1263 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001264
1265 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001266 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001267}
1268
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001269
1270component_test_full_cmake_gcc_asan_new_bignum () {
1271 msg "build: full config, cmake, gcc, ASan"
1272 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001273 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001274 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001275 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001276
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001277 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001278 make test
1279
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001280 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001281 programs/test/selftest
1282
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001283 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001284 tests/ssl-opt.sh
1285
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001286 # Note: the next two invocations cover all compat.sh test cases.
1287 # We should use the same here and in basic-build-test.sh.
1288 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1289 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001290
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001291 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1292 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001293
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001294 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001295 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001296}
1297
Ronald Cronc3623db2020-10-29 10:51:32 +01001298component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001299 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001300 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001301 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1302 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1303 make
1304
1305 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1306 make test
1307}
1308
David Horstmann4a48bec2024-03-13 15:42:31 +00001309component_test_psa_assume_exclusive_buffers () {
1310 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001311 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001312 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001313 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1314 make
1315
David Horstmann4a48bec2024-03-13 15:42:31 +00001316 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001317 make test
1318}
1319
Gilles Peskinea3548672021-06-17 11:37:52 +02001320# check_renamed_symbols HEADER LIB
1321# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1322# name is LIB.
1323check_renamed_symbols () {
1324 ! nm "$2" | sed 's/.* //' |
1325 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1326}
1327
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001328component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001329 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001330 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001331 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1332 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1333 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1334 # We can only compile, not link, since our test and sample programs
1335 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1336 # is active.
1337 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001338
1339 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1340 # version is not present.
1341 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001342 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001343}
1344
Valerio Setti63097752024-03-12 13:18:13 +01001345# Get a list of library-wise undefined symbols and ensure that they only
1346# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1347# This function is a common helper used by both:
1348# - component_test_default_psa_crypto_client_without_crypto_provider
1349# - component_build_full_psa_crypto_client_without_crypto_provider.
1350common_check_mbedtls_missing_symbols() {
1351 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1352 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1353 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1354 not grep mbedtls_ linking_errors.txt
1355
1356 rm sym_def.txt sym_undef.txt linking_errors.txt
1357}
1358
1359component_test_default_psa_crypto_client_without_crypto_provider () {
1360 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1361
Ronald Cron336678b2021-01-28 17:54:24 +01001362 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1363 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001364 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001365 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001366 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001367 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001368
Ronald Cron336678b2021-01-28 17:54:24 +01001369 make
1370
Valerio Setti63097752024-03-12 13:18:13 +01001371 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1372 common_check_mbedtls_missing_symbols
1373
1374 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001375 make test
1376}
1377
Valerio Setti63097752024-03-12 13:18:13 +01001378component_build_full_psa_crypto_client_without_crypto_provider () {
1379 msg "build: full config - PSA_CRYPTO_C"
1380
1381 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1382 scripts/config.py full
1383
1384 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1385 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1386 # Dynamic secure element support is a deprecated feature and it is not
1387 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1388 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1389
1390 # Since there is no crypto provider in this build it is not possible to
1391 # build all the test executables and progrems due to missing PSA functions
1392 # at link time. Therefore we will just build libraries and we'll check
1393 # that symbols of interest are there.
1394 make lib
1395
1396 msg "check missing symbols: full config - PSA_CRYPTO_C"
1397
1398 common_check_mbedtls_missing_symbols
1399
1400 # Ensure that desired functions are included into the build (extend the
1401 # following list as required).
1402 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1403 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1404 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1405}
1406
Ryan Everettdaa322a2024-04-18 16:48:55 +01001407component_test_no_rsa_key_pair_generation() {
1408 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001409 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001410 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001411 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001412 make
1413
Ryan Everettdaa322a2024-04-18 16:48:55 +01001414 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001415 make test
1416}
1417
Gilles Peskine782f4112018-11-27 16:11:09 +01001418component_test_ref_configs () {
1419 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001420 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1421 # want to re-generate generated files that depend on it, quite correctly.
1422 # However this doesn't work as the generation script expects a specific
1423 # format for mbedtls_config.h, which the other files don't follow. Also,
1424 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001425 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001426 # whether they're on or off. So, disable cmake's (over-sensitive here)
1427 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001428 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001429 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001430 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001431}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001432
Gilles Peskine8f073122018-11-27 15:58:47 +01001433component_test_no_renegotiation () {
1434 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001435 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001436 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001437 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001438
Gilles Peskine8f073122018-11-27 15:58:47 +01001439 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1440 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001441
Gilles Peskine8f073122018-11-27 15:58:47 +01001442 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001443 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001444}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001445
Gilles Peskine636c26a2020-03-04 20:46:15 +01001446component_test_no_pem_no_fs () {
1447 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1448 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1449 scripts/config.py unset MBEDTLS_FS_IO
1450 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1451 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001452 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001453 make
1454
1455 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1456 make test
1457
1458 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001459 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001460}
1461
Gilles Peskine8f073122018-11-27 15:58:47 +01001462component_test_rsa_no_crt () {
1463 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001464 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001465 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001466 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001467
Gilles Peskine8f073122018-11-27 15:58:47 +01001468 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1469 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001470
Gilles Peskine8f073122018-11-27 15:58:47 +01001471 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001472 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001473
Gilles Peskine8f073122018-11-27 15:58:47 +01001474 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001475 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001476
1477 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001478 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001479}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001480
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001481component_test_no_ctr_drbg_classic () {
1482 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001483 scripts/config.py full
1484 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001485 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001486 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001487
Dave Rodgman17127e92023-12-14 16:42:48 +00001488 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001489 make
1490
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001491 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001492 make test
1493
Gilles Peskineba749042021-01-13 20:02:03 +01001494 # In this configuration, the TLS test programs use HMAC_DRBG.
1495 # The SSL tests are slow, so run a small subset, just enough to get
1496 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001497 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001498 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001499
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001500 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001501 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001502}
1503
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001504component_test_no_ctr_drbg_use_psa () {
1505 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001506 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001507 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1508 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001509
Dave Rodgman17127e92023-12-14 16:42:48 +00001510 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001511 make
1512
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001513 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1514 make test
1515
1516 # In this configuration, the TLS test programs use HMAC_DRBG.
1517 # The SSL tests are slow, so run a small subset, just enough to get
1518 # confidence that the SSL code copes with HMAC_DRBG.
1519 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001520 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001521
1522 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001523 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001524}
1525
1526component_test_no_hmac_drbg_classic () {
1527 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1528 scripts/config.py full
1529 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1530 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1531 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001532 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001533
Dave Rodgman17127e92023-12-14 16:42:48 +00001534 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001535 make
1536
1537 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001538 make test
1539
Gilles Peskinea2224342020-11-19 22:14:34 +01001540 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1541 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1542 # instead.
1543 # Test SSL with non-deterministic ECDSA. Only test features that
1544 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001545 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001546 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001547
1548 # To save time, only test one protocol version, since this part of
1549 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001550 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001551 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001552}
1553
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001554component_test_no_hmac_drbg_use_psa () {
1555 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1556 scripts/config.py full
1557 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1558 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1559 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1560
Dave Rodgman17127e92023-12-14 16:42:48 +00001561 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001562 make
1563
1564 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1565 make test
1566
1567 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1568 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1569 # instead.
1570 # Test SSL with non-deterministic ECDSA. Only test features that
1571 # might be affected by how ECDSA signature is performed.
1572 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001573 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001574
1575 # To save time, only test one protocol version, since this part of
1576 # the protocol is identical in (D)TLS up to 1.2.
1577 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001578 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001579}
1580
1581component_test_psa_external_rng_no_drbg_classic () {
1582 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1583 scripts/config.py full
1584 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001585 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001586 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001587 scripts/config.py unset MBEDTLS_ENTROPY_C
1588 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1589 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001590 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1591 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1592 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001593 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1594 # the SSL test programs don't have an RNG and can't work. Explicitly
1595 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001596 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001597
1598 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1599 make test
1600
Gilles Peskine8eb29432021-02-03 20:07:11 +01001601 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001602 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001603}
1604
1605component_test_psa_external_rng_no_drbg_use_psa () {
1606 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001607 scripts/config.py full
1608 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001609 scripts/config.py unset MBEDTLS_ENTROPY_C
1610 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1611 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001612 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1613 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1614 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001615 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001616
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001617 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001618 make test
1619
Gilles Peskine8eb29432021-02-03 20:07:11 +01001620 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001621 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001622}
1623
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001624component_test_psa_external_rng_use_psa_crypto () {
1625 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1626 scripts/config.py full
1627 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1628 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1629 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001630 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001631
1632 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1633 make test
1634
1635 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1636 tests/ssl-opt.sh -f 'Default\|opaque'
1637}
1638
Gilles Peskine801c4332023-04-28 21:04:28 +02001639component_test_psa_inject_entropy () {
1640 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1641 scripts/config.py full
1642 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1643 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1644 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1645 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1646 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1647 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001648 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 +02001649
1650 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1651 make test
1652}
1653
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001654component_test_sw_inet_pton () {
1655 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1656
1657 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1658 scripts/config.py set MBEDTLS_TEST_HOOKS
1659 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1660
1661 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1662 make test
1663}
1664
Valerio Settia41654d2024-02-08 10:33:11 +01001665component_full_no_pkparse_pkwrite() {
1666 msg "build: full without pkparse and pkwrite"
1667
1668 scripts/config.py crypto_full
1669 scripts/config.py unset MBEDTLS_PK_PARSE_C
1670 scripts/config.py unset MBEDTLS_PK_WRITE_C
1671
Valerio Settia41654d2024-02-08 10:33:11 +01001672 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1673
1674 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1675 not grep mbedtls_pk_parse_key library/pkparse.o
1676 not grep mbedtls_pk_write_key_der library/pkwrite.o
1677
1678 msg "test: full without pkparse and pkwrite"
1679 make test
1680}
1681
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001682component_test_crypto_full_md_light_only () {
1683 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001684 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001685 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001686 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001687 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001688 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001689 scripts/config.py unset MBEDTLS_HKDF_C
1690 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001691 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001692 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001693 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001694 # Disable things that would auto-enable MD_C
1695 scripts/config.py unset MBEDTLS_PKCS5_C
1696
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001697 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1698 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001699 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001700
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001701 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001702 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001703 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001704
1705 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001706 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001707}
1708
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001709component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001710 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001711 scripts/config.py full
1712 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001713 # Don't pull in cipher via PSA mechanisms
1714 # (currently ignored anyway because we completely disable PSA)
1715 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001716 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001717 scripts/config.py unset MBEDTLS_CMAC_C
1718 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001719 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001720 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001721 scripts/config.py unset MBEDTLS_SSL_TLS_C
1722 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001723 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001724 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1725 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001726 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001727 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001728 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001729
Valerio Settidf17a102023-10-23 14:14:19 +02001730 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001731 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001732}
1733
Valerio Setti7e710e82023-08-25 09:14:15 +02001734# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001735# - component_test_full_no_cipher_with_psa_crypto
1736# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001737# It accepts 2 input parameters:
1738# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1739# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001740common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001741 USE_CRYPTO_CONFIG="$1"
1742 COMPONENT_DESCRIPTION="$2"
1743
1744 msg "build: $COMPONENT_DESCRIPTION"
1745
1746 scripts/config.py full
1747 scripts/config.py unset MBEDTLS_CIPHER_C
1748
1749 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001750 # The built-in implementation of the following algs/key-types depends
1751 # on CIPHER_C so we disable them.
1752 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1753 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001754 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001755 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1756 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1757 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1758 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1759 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1760 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1761 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
Ronald Crona33a8242024-05-15 18:31:17 +02001762 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti7e710e82023-08-25 09:14:15 +02001763 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001764 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001765 else
1766 # Don't pull in cipher via PSA mechanisms
1767 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001768 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1769 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1770 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001771 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001772 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001773 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001774 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001775
Gilles Peskine21570cf2023-12-22 11:49:50 +01001776 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001777
Valerio Setti7e710e82023-08-25 09:14:15 +02001778 # Ensure that CIPHER_C was not re-enabled
1779 not grep mbedtls_cipher_init library/cipher.o
1780
1781 msg "test: $COMPONENT_DESCRIPTION"
1782 make test
1783}
1784
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001785component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001786 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001787}
1788
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001789component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001790 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001791}
1792
Valerio Settibdfecb62023-11-07 15:37:20 +01001793component_test_full_no_ccm() {
1794 msg "build: full no PSA_WANT_ALG_CCM"
1795
1796 # Full config enables:
1797 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1798 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1799 scripts/config.py full
1800
1801 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1802 # enabled, but not used from TLS since USE_PSA is set.
1803 # This is helpful to ensure that TLS tests below have proper dependencies.
1804 #
1805 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1806 # PSA_WANT_ALG_CCM to be re-enabled.
1807 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1808
Gilles Peskine21570cf2023-12-22 11:49:50 +01001809 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001810
1811 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001812 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001813}
1814
1815component_test_full_no_ccm_star_no_tag() {
1816 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1817
1818 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1819 scripts/config.py full
1820
1821 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1822 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1823 # This basically disables all unauthenticated ciphers on the PSA side, while
1824 # keeping AEADs enabled.
1825 #
1826 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1827 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1828 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1829 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1830 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1831 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1832 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1833 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1834 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1835 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1836
Gilles Peskine21570cf2023-12-22 11:49:50 +01001837 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001838
1839 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001840 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001841
1842 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001843 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001844}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001845
Valerio Settie1655b82023-01-03 15:35:25 +01001846component_test_full_no_bignum () {
1847 msg "build: full minus bignum"
1848 scripts/config.py full
1849 scripts/config.py unset MBEDTLS_BIGNUM_C
1850 # Direct dependencies of bignum
1851 scripts/config.py unset MBEDTLS_ECP_C
1852 scripts/config.py unset MBEDTLS_RSA_C
1853 scripts/config.py unset MBEDTLS_DHM_C
1854 # Direct dependencies of ECP
1855 scripts/config.py unset MBEDTLS_ECDH_C
1856 scripts/config.py unset MBEDTLS_ECDSA_C
1857 scripts/config.py unset MBEDTLS_ECJPAKE_C
1858 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001859 # Disable what auto-enables ECP_LIGHT
1860 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1861 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001862 # Indirect dependencies of ECP
1863 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1864 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1865 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1866 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1867 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1868 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1869 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1870 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1871 # Direct dependencies of DHM
1872 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1873 # Direct dependencies of RSA
1874 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1875 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1876 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1877 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1878 # PK and its dependencies
1879 scripts/config.py unset MBEDTLS_PK_C
1880 scripts/config.py unset MBEDTLS_PK_PARSE_C
1881 scripts/config.py unset MBEDTLS_PK_WRITE_C
1882 scripts/config.py unset MBEDTLS_X509_USE_C
1883 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1884 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1885 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1886 scripts/config.py unset MBEDTLS_X509_CREATE_C
1887 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1888 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1889 scripts/config.py unset MBEDTLS_PKCS7_C
1890 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1891 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1892 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1893
Gilles Peskine21570cf2023-12-22 11:49:50 +01001894 make
Valerio Settie1655b82023-01-03 15:35:25 +01001895
1896 msg "test: full minus bignum"
1897 make test
1898}
1899
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001900component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001901 msg "build: default with only stream cipher"
1902
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001903 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001904 scripts/config.py unset MBEDTLS_GCM_C
1905 scripts/config.py unset MBEDTLS_CCM_C
1906 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001907 #Disable TLS 1.3 (as no AEAD)
1908 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001909 # 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 +02001910 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001911 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001912 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001913 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1914 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001915 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001916 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001917 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001918
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001919 make
1920
1921 msg "test: default with only stream cipher"
1922 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001923
1924 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001925}
1926
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001927component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001928 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001929
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001930 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001931 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001932 scripts/config.py unset MBEDTLS_GCM_C
1933 scripts/config.py unset MBEDTLS_CCM_C
1934 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001935 #Disable TLS 1.3 (as no AEAD)
1936 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001937 # 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 +02001938 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001939 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001940 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001941 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1942 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001943 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001944 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001945 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001946
Przemek Stekiel9550c052022-09-28 09:51:55 +02001947 make
1948
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001949 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001950 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001951
1952 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001953}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001954
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001955component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001956 msg "build: default with only CBC-legacy cipher"
1957
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001958 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001959 scripts/config.py unset MBEDTLS_GCM_C
1960 scripts/config.py unset MBEDTLS_CCM_C
1961 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001962 #Disable TLS 1.3 (as no AEAD)
1963 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001964 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1965 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1966 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001967 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001968 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001969 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001970 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001971 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001972 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001973
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001974 make
1975
1976 msg "test: default with only CBC-legacy cipher"
1977 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001978
1979 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1980 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001981}
1982
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001983component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001984 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001985
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001986 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001987 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001988 scripts/config.py unset MBEDTLS_GCM_C
1989 scripts/config.py unset MBEDTLS_CCM_C
1990 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001991 #Disable TLS 1.3 (as no AEAD)
1992 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001993 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1994 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1995 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001996 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001997 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001998 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001999 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002000 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002001 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002002
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002003 make
2004
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002005 msg "test: default with only CBC-legacy cipher use psa"
2006 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002007
2008 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
2009 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002010}
2011
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002012component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002013 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
2014
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002015 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002016 scripts/config.py unset MBEDTLS_GCM_C
2017 scripts/config.py unset MBEDTLS_CCM_C
2018 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002019 #Disable TLS 1.3 (as no AEAD)
2020 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002021 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2022 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2023 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2024 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2025 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002026 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002027 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002028 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002029 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002030
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002031 make
2032
2033 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
2034 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002035
2036 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
2037 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002038}
2039
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002040component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
2041 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002042
2043 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002044 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002045 scripts/config.py unset MBEDTLS_GCM_C
2046 scripts/config.py unset MBEDTLS_CCM_C
2047 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002048 #Disable TLS 1.3 (as no AEAD)
2049 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002050 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2051 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2052 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2053 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2054 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002055 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002056 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002057 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002058 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002059
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002060 make
2061
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002062 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002063 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002064
2065 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2066 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002067}
2068
Valerio Setti9f0ec532022-11-08 13:03:24 +01002069# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2070# that we could use for interop testing. However, we now have sort of two
2071# implementations ourselves: one using PSA, the other not. At least test that
2072# these two interoperate with each other.
2073component_test_tls1_2_ecjpake_compatibility() {
2074 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2075 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002076 # Explicitly make lib first to avoid a race condition:
2077 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2078 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002079 make -C programs ssl/ssl_server2 ssl/ssl_client2
2080 cp programs/ssl/ssl_server2 s2_no_use_psa
2081 cp programs/ssl/ssl_client2 c2_no_use_psa
2082
2083 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2084 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2085 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002086 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002087 make -C programs ssl/ssl_server2 ssl/ssl_client2
2088 make -C programs test/udp_proxy test/query_compile_time_config
2089
Valerio Setti70e02902022-12-02 16:21:56 +01002090 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2091 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2092 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2093 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2094 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2095 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2096 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2097 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 +01002098
2099 rm s2_no_use_psa c2_no_use_psa
2100}
2101
Gilles Peskine636c26a2020-03-04 20:46:15 +01002102component_test_everest () {
2103 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2104 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2105 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2106 make
2107
2108 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2109 make test
2110
Gilles Peskine6848d172023-11-02 19:58:03 +01002111 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002112 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002113
Gilles Peskine636c26a2020-03-04 20:46:15 +01002114 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2115 tests/ssl-opt.sh -f ECDH
2116
2117 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2118 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002119 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002120}
2121
Gilles Peskined3beca92020-07-03 00:15:37 +02002122component_test_everest_curve25519_only () {
2123 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002124 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2125 scripts/config.py unset MBEDTLS_ECDSA_C
2126 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2127 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002128 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002129 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002130 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002131 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2132
Dave Rodgman17127e92023-12-14 16:42:48 +00002133 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002134
2135 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2136 make test
2137}
2138
Gilles Peskine8f073122018-11-27 15:58:47 +01002139component_test_small_ssl_out_content_len () {
2140 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002141 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2142 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002143 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002144 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002145
Gilles Peskine8f073122018-11-27 15:58:47 +01002146 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002147 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002148}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002149
Gilles Peskine8f073122018-11-27 15:58:47 +01002150component_test_small_ssl_in_content_len () {
2151 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002152 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2153 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002154 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002155 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002156
Gilles Peskine8f073122018-11-27 15:58:47 +01002157 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002158 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002159}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002160
Gilles Peskine8f073122018-11-27 15:58:47 +01002161component_test_small_ssl_dtls_max_buffering () {
2162 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002163 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002164 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002165 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002166
Gilles Peskine8f073122018-11-27 15:58:47 +01002167 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002168 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 +01002169}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002170
Gilles Peskine8f073122018-11-27 15:58:47 +01002171component_test_small_mbedtls_ssl_dtls_max_buffering () {
2172 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002173 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002174 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002175 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002176
Gilles Peskine8f073122018-11-27 15:58:47 +01002177 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002178 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002179}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002180
Gilles Peskine75cc7712019-09-06 19:47:17 +02002181component_test_psa_collect_statuses () {
2182 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002183 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002184 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002185 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002186 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002187 rm -f tests/statuses.log
2188}
2189
Gilles Peskine8f073122018-11-27 15:58:47 +01002190component_test_full_cmake_clang () {
2191 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002192 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002193 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 +01002194 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002195
k-stachowiak0291cb72019-06-26 15:52:12 +02002196 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002197 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002198
Gilles Peskineda6017c2022-10-30 21:02:40 +01002199 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2200 programs/test/cpp_dummy_build
2201
Gilles Peskine6848d172023-11-02 19:58:03 +01002202 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002203 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002204
Gilles Peskine82b27272019-06-14 18:27:03 +02002205 msg "program demos (full config, clang)" # ~10s
2206 tests/scripts/run_demos.py
2207
k-stachowiak0291cb72019-06-26 15:52:12 +02002208 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002209 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002210
Gilles Peskine8f073122018-11-27 15:58:47 +01002211 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002212 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002213}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002214
Gilles Peskine0c671602022-11-29 16:01:41 +01002215skip_suites_without_constant_flow () {
2216 # Skip the test suites that don't have any constant-flow annotations.
2217 # This will need to be adjusted if we ever start declaring things as
2218 # secret from macros or functions inside tests/include or tests/src.
2219 SKIP_TEST_SUITES=$(
2220 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2221 sed 's/test_suite_//; s/\.function$//' |
2222 tr '\n' ,)
2223 export SKIP_TEST_SUITES
2224}
2225
Dave Rodgman246210e2023-07-31 18:07:44 +01002226skip_all_except_given_suite () {
2227 # Skip all but the given test suite
2228 SKIP_TEST_SUITES=$(
2229 ls -1 tests/suites/test_suite_*.function |
2230 grep -v $1.function |
2231 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2232 tr '\n' ,)
2233 export SKIP_TEST_SUITES
2234}
2235
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002236component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002237 # This tests both (1) accesses to undefined memory, and (2) branches or
2238 # memory access depending on secret values. To distinguish between those:
2239 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2240 # - or alternatively, change the build type to MemSanDbg, which enables
2241 # origin tracking and nicer stack traces (which are useful for debugging
2242 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002243 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2244 scripts/config.py full
2245 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2246 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2247 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2248 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2249 make
2250
2251 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2252 make test
2253}
2254
2255component_test_memsan_constant_flow_psa () {
2256 # This tests both (1) accesses to undefined memory, and (2) branches or
2257 # memory access depending on secret values. To distinguish between those:
2258 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2259 # - or alternatively, change the build type to MemSanDbg, which enables
2260 # origin tracking and nicer stack traces (which are useful for debugging
2261 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002262 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002263 scripts/config.py full
2264 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2265 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2266 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2267 make
2268
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002269 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002270 make test
2271}
2272
Bence Szépkúti0354d042023-12-06 16:14:37 +01002273component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002274 # This tests both (1) everything that valgrind's memcheck usually checks
2275 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2276 # etc.) and (2) branches or memory access depending on secret values,
2277 # which will be reported as uninitialized memory. To distinguish between
2278 # secret and actually uninitialized:
2279 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2280 # - or alternatively, build with debug info and manually run the offending
2281 # test suite with valgrind --track-origins=yes, then check if the origin
2282 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002283 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2284 scripts/config.py full
2285 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2286 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002287 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002288 cmake -D CMAKE_BUILD_TYPE:String=Release .
2289 make
2290
2291 # this only shows a summary of the results (how many of each type)
2292 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002293 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002294 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002295
2296 # Test asm path in constant time module - by default, it will test the plain C
2297 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2298 msg "test: valgrind asm constant_time"
2299 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2300 skip_all_except_given_suite test_suite_constant_time
2301 cmake -D CMAKE_BUILD_TYPE:String=Release .
2302 make clean
2303 make
2304 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002305}
2306
Bence Szépkúti0354d042023-12-06 16:14:37 +01002307component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002308 # This tests both (1) everything that valgrind's memcheck usually checks
2309 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2310 # etc.) and (2) branches or memory access depending on secret values,
2311 # which will be reported as uninitialized memory. To distinguish between
2312 # secret and actually uninitialized:
2313 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2314 # - or alternatively, build with debug info and manually run the offending
2315 # test suite with valgrind --track-origins=yes, then check if the origin
2316 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002317 msg "build: cmake release GCC, full config with constant flow testing"
2318 scripts/config.py full
2319 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002320 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002321 cmake -D CMAKE_BUILD_TYPE:String=Release .
2322 make
2323
2324 # this only shows a summary of the results (how many of each type)
2325 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002326 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002327 make memcheck
2328}
2329
Janos Follath9338cac2023-10-04 18:55:39 +01002330component_test_tsan () {
2331 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002332 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002333 scripts/config.py set MBEDTLS_THREADING_C
2334 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002335 # Self-tests do not currently use multiple threads.
2336 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002337
Ryan6caf84f2024-03-05 13:57:00 +00002338 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2339 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2340
Janos Follath9338cac2023-10-04 18:55:39 +01002341 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2342 make
2343
2344 msg "test: main suites (TSan)"
2345 make test
2346}
2347
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002348component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002349 # Test that removing the deprecated features from the default
2350 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002351 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2352 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002353 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002354
2355 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2356 make test
2357}
2358
2359component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002360 msg "build: make, full_no_deprecated config" # ~ 30s
2361 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002362 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002363
Gilles Peskine30de2e82020-04-20 21:39:22 +02002364 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002365 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002366
2367 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2368 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002369}
2370
Gilles Peskine8386ea22020-04-30 09:07:29 +02002371component_test_full_no_deprecated_deprecated_warning () {
2372 # Test that there is nothing deprecated in "full_no_deprecated".
2373 # A deprecated feature would trigger a warning (made fatal) from
2374 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002375 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2376 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002377 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2378 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002379 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002380
Gilles Peskine30de2e82020-04-20 21:39:22 +02002381 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002382 make test
2383}
2384
Gilles Peskine8386ea22020-04-30 09:07:29 +02002385component_test_full_deprecated_warning () {
2386 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2387 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002388 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002389 scripts/config.py full
2390 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002391 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002392 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2393 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002394 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002395
Gilles Peskine8386ea22020-04-30 09:07:29 +02002396 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2397 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2398 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002399 # Expect warnings from '#warning' directives in check_config.h and
2400 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002401 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 +01002402
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002403 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2404 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002405
2406 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2407 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002408}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002409
Gilles Peskineec541fe2020-01-31 14:24:14 +01002410# Check that the specified libraries exist and are empty.
2411are_empty_libraries () {
2412 nm "$@" >/dev/null 2>/dev/null
2413 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2414}
2415
2416component_build_crypto_default () {
2417 msg "build: make, crypto only"
2418 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002419 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002420 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002421}
2422
2423component_build_crypto_full () {
2424 msg "build: make, crypto only, full config"
2425 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002426 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002427 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002428}
2429
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002430component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002431 msg "build: make, config for PSA crypto service"
2432 scripts/config.py crypto
2433 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2434 # Disable things that are not needed for just cryptography, to
2435 # reach a configuration that would be typical for a PSA cryptography
2436 # service providing all implemented PSA algorithms.
2437 # System stuff
2438 scripts/config.py unset MBEDTLS_ERROR_C
2439 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002440 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002441 # Crypto stuff with no PSA interface
2442 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002443 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002444 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002445 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002446 scripts/config.py unset MBEDTLS_NIST_KW_C
2447 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2448 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2449 scripts/config.py unset MBEDTLS_PKCS12_C
2450 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002451 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2452 # in PSA code to work with RSA keys. We don't require users to set those:
2453 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002454 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002455 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002456 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002457 make CFLAGS='-O1 -Werror' all test
2458 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2459}
2460
Gilles Peskineec541fe2020-01-31 14:24:14 +01002461component_build_crypto_baremetal () {
2462 msg "build: make, crypto only, baremetal config"
2463 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002464 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002465 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002466}
Daniel Axtens446af202020-09-02 21:30:13 +10002467support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002468 support_build_baremetal "$@"
2469}
2470
2471component_build_baremetal () {
2472 msg "build: make, baremetal config"
2473 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002474 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002475}
2476support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002477 # Older Glibc versions include time.h from other headers such as stdlib.h,
2478 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2479 # problem, Ubuntu 18.04 is ok.
2480 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2481}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002482
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002483# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002484component_test_depends_py_cipher_id () {
2485 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002486 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002487}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002488
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002489component_test_depends_py_cipher_chaining () {
2490 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002491 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002492}
2493
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002494component_test_depends_py_cipher_padding () {
2495 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002496 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002497}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002498
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002499component_test_depends_py_curves () {
2500 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002501 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002502}
2503
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002504component_test_depends_py_hashes () {
2505 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002506 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002507}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002508
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002509component_test_depends_py_kex () {
2510 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002511 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002512}
2513
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002514component_test_depends_py_pkalgs () {
2515 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002516 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002517}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002518
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002519# PSA equivalents of the depends.py tests
2520component_test_depends_py_cipher_id_psa () {
2521 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002522 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002523}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002524
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002525component_test_depends_py_cipher_chaining_psa () {
2526 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002527 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002528}
2529
2530component_test_depends_py_cipher_padding_psa () {
2531 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002532 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002533}
2534
2535component_test_depends_py_curves_psa () {
2536 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002537 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002538}
2539
2540component_test_depends_py_hashes_psa () {
2541 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002542 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002543}
2544
2545component_test_depends_py_kex_psa () {
2546 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002547 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002548}
2549
2550component_test_depends_py_pkalgs_psa () {
2551 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002552 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002553}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002554
Valerio Setti6bed64e2024-01-17 15:21:44 +01002555component_test_psa_crypto_config_ffdh_2048_only () {
2556 msg "build: full config - only DH 2048"
2557
2558 scripts/config.py full
2559
2560 # Disable all DH groups other than 2048.
2561 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2562 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2563 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2564 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2565
2566 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2567
2568 msg "test: full config - only DH 2048"
2569 make test
2570
2571 msg "ssl-opt: full config - only DH 2048"
2572 tests/ssl-opt.sh -f "ffdh"
2573}
2574
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002575component_build_no_pk_rsa_alt_support () {
2576 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2577
2578 scripts/config.py full
2579 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2580 scripts/config.py set MBEDTLS_RSA_C
2581 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2582
2583 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002584 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002585}
2586
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002587component_build_module_alt () {
2588 msg "build: MBEDTLS_XXX_ALT" # ~30s
2589 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002590
2591 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002592 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2593 scripts/config.py unset MBEDTLS_AESNI_C
2594 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002595 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002596 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2597 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002598 # You can only have one threading implementation: alt or pthread, not both.
2599 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002600 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2601 # directly and assumes the implementation works with partial groups.
2602 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002603 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2604 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2605 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002606 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2607 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2608 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002609
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002610 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2611 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2612 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002613 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002614
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002615 # We can only compile, not link, since we don't have any implementations
2616 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002617 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002618}
2619
2620component_build_dhm_alt () {
2621 msg "build: MBEDTLS_DHM_ALT" # ~30s
2622 scripts/config.py full
2623 scripts/config.py set MBEDTLS_DHM_ALT
2624 # debug.c currently references mbedtls_dhm_context fields directly.
2625 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002626 # We can only compile, not link, since we don't have any implementations
2627 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002628 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002629}
2630
Gilles Peskine64996c32024-01-23 20:25:47 +01002631component_test_no_psa_crypto_full_cmake_asan() {
2632 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2633 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002634 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002635 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002636 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002637 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002638 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002639 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002640 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002641 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002642 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002643 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002644 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002645 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002646
Gilles Peskine64996c32024-01-23 20:25:47 +01002647 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002648 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002649
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002650 # Note: ssl-opt.sh has some test cases that depend on
2651 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2652 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002653 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002654 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002655
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002656 # Note: the next two invocations cover all compat.sh test cases.
2657 # We should use the same here and in basic-build-test.sh.
2658 msg "test: compat.sh: default version (full minus PSA crypto)"
2659 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002660
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002661 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002662 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002663}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002664
Ronald Cron403c15c2021-09-13 09:38:05 +02002665component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002666 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002667
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002668 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002669 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002670 $(helper_get_psa_key_type_list "ECC") \
2671 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002672
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002673 # Configure
2674 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002675
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002676 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002677 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002678
2679 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002680 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002681
2682 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002683 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2684 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2685
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002686 # Build
2687 # -----
2688
2689 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002690 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2691 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002692
2693 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2694
Valerio Setti3fe105b2023-10-30 11:08:12 +01002695 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002696
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002697 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002698 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002699
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002700 # Run the tests
2701 # -------------
2702
Ronald Cron403c15c2021-09-13 09:38:05 +02002703 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2704 make test
2705}
2706
Valerio Setti44b178c2023-03-22 14:02:57 +01002707component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002708 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002709
2710 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002711 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002712 $(helper_get_psa_key_type_list "ECC") \
2713 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002714
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002715 # Configure
2716 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002717
Ronald Cron46ac0652024-03-18 12:39:04 +01002718 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002719 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002720
Valerio Setti44b178c2023-03-22 14:02:57 +01002721 # Disable the module that's accelerated
2722 scripts/config.py unset MBEDTLS_ECDH_C
2723
2724 # Disable things that depend on it
2725 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2726 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2727 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2728 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2729 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2730
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002731 # Build
2732 # -----
2733
2734 helper_libtestdriver1_make_drivers "$loc_accel_list"
2735
Valerio Setti3fe105b2023-10-30 11:08:12 +01002736 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002737
Valerio Setti44b178c2023-03-22 14:02:57 +01002738 # Make sure this was not re-enabled by accident (additive config)
2739 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002740
2741 # Run the tests
2742 # -------------
2743
Valerio Setti44b178c2023-03-22 14:02:57 +01002744 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002745 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002746}
2747
Przemek Stekieldccb2022023-05-11 10:48:50 +02002748component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002749 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002750
2751 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002752 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002753 $(helper_get_psa_key_type_list "DH") \
2754 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002755
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002756 # Configure
2757 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002758
Przemek Stekiel565353e2023-07-05 11:07:07 +02002759 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002760 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002761
2762 # Disable the module that's accelerated
2763 scripts/config.py unset MBEDTLS_DHM_C
2764
2765 # Disable things that depend on it
2766 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2767 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2768
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002769 # Build
2770 # -----
2771
2772 helper_libtestdriver1_make_drivers "$loc_accel_list"
2773
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002774 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002775
2776 # Make sure this was not re-enabled by accident (additive config)
2777 not grep mbedtls_dhm_ library/dhm.o
2778
2779 # Run the tests
2780 # -------------
2781
Gilles Peskine14302ed2023-07-19 19:30:04 +02002782 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002783 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002784
Gilles Peskine14302ed2023-07-19 19:30:04 +02002785 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002786 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002787}
2788
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002789component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002790 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002791
2792 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002793 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002794
2795 # Disable things that are not supported
2796 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2797 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002798 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002799
Gilles Peskine14302ed2023-07-19 19:30:04 +02002800 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002801 make test
2802
Gilles Peskine14302ed2023-07-19 19:30:04 +02002803 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002804 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002805}
2806
Valerio Setti44b178c2023-03-22 14:02:57 +01002807component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002808 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002809
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002810 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002811 $(helper_get_psa_key_type_list "ECC") \
2812 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002813
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002814 # Configure
2815 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002816
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002817 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002818
2819 # Make built-in fallback not available
2820 scripts/config.py unset MBEDTLS_ECJPAKE_C
2821 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2822
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002823 # Build
2824 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002825
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002826 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002827
Valerio Setti3fe105b2023-10-30 11:08:12 +01002828 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002829
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002830 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002831 not grep mbedtls_ecjpake_init library/ecjpake.o
2832
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002833 # Run the tests
2834 # -------------
2835
Gilles Peskine14302ed2023-07-19 19:30:04 +02002836 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002837 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002838}
2839
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002840component_test_psa_crypto_config_accel_ecc_some_key_types () {
2841 msg "build: full with accelerated EC algs and some key types"
2842
2843 # Algorithms and key types to accelerate
2844 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2845 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2846 ALG_ECDH \
2847 ALG_JPAKE \
2848 KEY_TYPE_ECC_PUBLIC_KEY \
2849 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2850 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002851 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2852 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002853
2854 # Configure
2855 # ---------
2856
2857 # start with config full for maximum coverage (also enables USE_PSA)
2858 helper_libtestdriver1_adjust_config "full"
2859
2860 # Disable modules that are accelerated - some will be re-enabled
2861 scripts/config.py unset MBEDTLS_ECDSA_C
2862 scripts/config.py unset MBEDTLS_ECDH_C
2863 scripts/config.py unset MBEDTLS_ECJPAKE_C
2864 scripts/config.py unset MBEDTLS_ECP_C
2865
2866 # Disable all curves - those that aren't accelerated should be re-enabled
2867 helper_disable_builtin_curves
2868
2869 # Restartable feature is not yet supported by PSA. Once it will in
2870 # the future, the following line could be removed (see issues
2871 # 6061, 6332 and following ones)
2872 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2873
2874 # this is not supported by the driver API yet
2875 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2876
2877 # Build
2878 # -----
2879
2880 # These hashes are needed for some ECDSA signature tests.
2881 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2882 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2883 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2884
Valerio Setti3fe105b2023-10-30 11:08:12 +01002885 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002886
2887 # ECP should be re-enabled but not the others
2888 not grep mbedtls_ecdh_ library/ecdh.o
2889 not grep mbedtls_ecdsa library/ecdsa.o
2890 not grep mbedtls_ecjpake library/ecjpake.o
2891 grep mbedtls_ecp library/ecp.o
2892
2893 # Run the tests
2894 # -------------
2895
2896 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002897 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002898}
2899
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002900# Run tests with only (non-)Weierstrass accelerated
2901# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002902# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2903# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002904common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002905 weierstrass=$1
2906 if [ $weierstrass -eq 1 ]; then
2907 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002908 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002909 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002910 fi
2911
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002912 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002913
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002914 # Note: Curves are handled in a special way by the libtestdriver machinery,
2915 # so we only want to include them in the accel list when building the main
2916 # libraries, hence the use of a separate variable.
2917 # Note: the following loop is a modified version of
2918 # helper_get_psa_curve_list that only keeps Weierstrass families.
2919 loc_weierstrass_list=""
2920 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002921 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2922 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002923 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002924 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002925 ;;
2926 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002927 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002928 ;;
2929 esac
2930 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002931 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002932 loc_curve_list=$loc_weierstrass_list
2933 else
2934 loc_curve_list=$loc_non_weierstrass_list
2935 fi
2936
Valerio Setti3fe105b2023-10-30 11:08:12 +01002937 # Algorithms and key types to accelerate
2938 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2939 ALG_ECDH \
2940 ALG_JPAKE \
2941 $(helper_get_psa_key_type_list "ECC") \
2942 $loc_curve_list"
2943
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002944 # Configure
2945 # ---------
2946
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002947 # Start with config crypto_full and remove PK_C:
2948 # that's what's supported now, see docs/driver-only-builds.md.
2949 helper_libtestdriver1_adjust_config "crypto_full"
2950 scripts/config.py unset MBEDTLS_PK_C
2951 scripts/config.py unset MBEDTLS_PK_PARSE_C
2952 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002953
2954 # Disable modules that are accelerated - some will be re-enabled
2955 scripts/config.py unset MBEDTLS_ECDSA_C
2956 scripts/config.py unset MBEDTLS_ECDH_C
2957 scripts/config.py unset MBEDTLS_ECJPAKE_C
2958 scripts/config.py unset MBEDTLS_ECP_C
2959
2960 # Disable all curves - those that aren't accelerated should be re-enabled
2961 helper_disable_builtin_curves
2962
2963 # Restartable feature is not yet supported by PSA. Once it will in
2964 # the future, the following line could be removed (see issues
2965 # 6061, 6332 and following ones)
2966 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2967
2968 # this is not supported by the driver API yet
2969 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2970
2971 # Build
2972 # -----
2973
2974 # These hashes are needed for some ECDSA signature tests.
2975 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2976 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2977 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2978
Valerio Settiac7a8092023-10-31 12:23:44 +01002979 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002980
2981 # We expect ECDH to be re-enabled for the missing curves
2982 grep mbedtls_ecdh_ library/ecdh.o
2983 # We expect ECP to be re-enabled, however the parts specific to the
2984 # families of curves that are accelerated should be ommited.
2985 # - functions with mxz in the name are specific to Montgomery curves
2986 # - ecp_muladd is specific to Weierstrass curves
2987 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002988 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002989 not grep mbedtls_ecp_muladd library/ecp.o
2990 grep mxz library/ecp.o
2991 else
2992 grep mbedtls_ecp_muladd library/ecp.o
2993 not grep mxz library/ecp.o
2994 fi
2995 # We expect ECDSA and ECJPAKE to be re-enabled only when
2996 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002997 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002998 not grep mbedtls_ecdsa library/ecdsa.o
2999 not grep mbedtls_ecjpake library/ecjpake.o
3000 else
3001 grep mbedtls_ecdsa library/ecdsa.o
3002 grep mbedtls_ecjpake library/ecjpake.o
3003 fi
3004
3005 # Run the tests
3006 # -------------
3007
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02003008 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
3009 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003010}
3011
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02003012component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003013 common_test_psa_crypto_config_accel_ecc_some_curves 1
3014}
3015
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02003016component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003017 common_test_psa_crypto_config_accel_ecc_some_curves 0
3018}
3019
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01003020# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
3021# ECDH, ECDSA) with and without drivers.
3022# The input parameter is a boolean value which indicates:
3023# - 0 keep built-in EC algs,
3024# - 1 exclude built-in EC algs (driver only).
3025#
3026# This is used by the two following components to ensure they always use the
3027# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003028# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
3029# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01003030# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003031config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003032 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01003033 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003034 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003035 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01003036 # Disable modules that are accelerated
3037 scripts/config.py unset MBEDTLS_ECDSA_C
3038 scripts/config.py unset MBEDTLS_ECDH_C
3039 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02003040 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01003041 fi
3042
3043 # Restartable feature is not yet supported by PSA. Once it will in
3044 # the future, the following line could be removed (see issues
3045 # 6061, 6332 and following ones)
3046 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003047}
3048
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003049# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3050component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003051 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003052
3053 # Algorithms and key types to accelerate
3054 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3055 ALG_ECDH \
3056 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003057 $(helper_get_psa_key_type_list "ECC") \
3058 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003059
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003060 # Configure
3061 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003062
3063 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003064 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003065
Valerio Setti0a342c92023-09-01 09:12:31 +02003066 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003067 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3068 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003069
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003070 # Build
3071 # -----
3072
3073 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003074 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3075 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003076 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3077
Valerio Setti3fe105b2023-10-30 11:08:12 +01003078 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003079
3080 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3081 not grep mbedtls_ecdsa_ library/ecdsa.o
3082 not grep mbedtls_ecdh_ library/ecdh.o
3083 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003084 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003085
3086 # Run the tests
3087 # -------------
3088
Gilles Peskine14302ed2023-07-19 19:30:04 +02003089 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003090 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003091
Gilles Peskine14302ed2023-07-19 19:30:04 +02003092 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003093 tests/ssl-opt.sh
3094}
3095
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003096# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3097component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003098 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003099
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003100 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003101
Gilles Peskine21570cf2023-12-22 11:49:50 +01003102 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003103
Gilles Peskine14302ed2023-07-19 19:30:04 +02003104 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003105 make test
3106
Gilles Peskine14302ed2023-07-19 19:30:04 +02003107 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003108 tests/ssl-opt.sh
3109}
3110
Valerio Settie618cb02023-04-12 14:59:16 +02003111# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003112# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3113# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003114# to ensure that both tests use the same underlying configuration when testing
3115# driver's coverage with analyze_outcomes.py.
3116#
3117# This functions accepts 1 boolean parameter as follows:
3118# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3119# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3120# - 0: include built-in implementation of EC algorithms.
3121#
3122# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3123# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003124config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003125 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003126 # start with full config for maximum coverage (also enables USE_PSA)
3127 helper_libtestdriver1_adjust_config "full"
3128
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003129 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003130 # Disable modules that are accelerated
3131 scripts/config.py unset MBEDTLS_ECDSA_C
3132 scripts/config.py unset MBEDTLS_ECDH_C
3133 scripts/config.py unset MBEDTLS_ECJPAKE_C
3134 # Disable ECP module (entirely)
3135 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003136 fi
3137
Valerio Settiaecd32c2023-06-14 10:42:31 +02003138 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3139 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003140 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003141 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003142
Valerio Settie618cb02023-04-12 14:59:16 +02003143 # Restartable feature is not yet supported by PSA. Once it will in
3144 # the future, the following line could be removed (see issues
3145 # 6061, 6332 and following ones)
3146 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003147}
3148
3149# Build and test a configuration where driver accelerates all EC algs while
3150# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3151# side.
3152#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003153# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3154component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003155 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003156
3157 # Algorithms and key types to accelerate
3158 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3159 ALG_ECDH \
3160 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003161 $(helper_get_psa_key_type_list "ECC") \
3162 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003163
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003164 # Configure
3165 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003166
Valerio Settie618cb02023-04-12 14:59:16 +02003167 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003168 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003169 # Disable all the builtin curves. All the required algs are accelerated.
3170 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003171
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003172 # Build
3173 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003174
3175 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003176 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3177 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3178 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003179
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003180 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003181
Valerio Setti3fe105b2023-10-30 11:08:12 +01003182 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003183
3184 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3185 not grep mbedtls_ecdsa_ library/ecdsa.o
3186 not grep mbedtls_ecdh_ library/ecdh.o
3187 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003188 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003189 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003190
3191 # Run the tests
3192 # -------------
3193
Gilles Peskine14302ed2023-07-19 19:30:04 +02003194 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003195 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003196
Gilles Peskine14302ed2023-07-19 19:30:04 +02003197 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003198 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003199}
3200
3201# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003202# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003203# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003204component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003205 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003206
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003207 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003208
Gilles Peskine21570cf2023-12-22 11:49:50 +01003209 make
Valerio Settie618cb02023-04-12 14:59:16 +02003210
Gilles Peskine14302ed2023-07-19 19:30:04 +02003211 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003212 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003213
Gilles Peskine14302ed2023-07-19 19:30:04 +02003214 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003215 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003216}
3217
Valerio Setti4e2f2442023-08-15 10:10:26 +02003218# This is a common configuration helper used directly from:
3219# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3220# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3221# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003222# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003223# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003224# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003225# - this is the reference component of the above
3226# - it still disables RSA and FFDH, but it uses builtin EC algs
3227# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3228# - accelerate all EC and FFDH algs, disable only RSA
3229# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3230# - this is the reference component of the above
3231# - it still disables RSA, but it uses builtin EC and FFDH algs
3232#
3233# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003234# $1: a boolean value which states if we are testing an accelerated scenario
3235# or not.
3236# $2: a string value which states which components are tested. Allowed values
3237# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003238config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003239 driver_only="$1"
3240 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003241 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003242 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003243
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003244 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003245 # Disable modules that are accelerated
3246 scripts/config.py unset MBEDTLS_ECDSA_C
3247 scripts/config.py unset MBEDTLS_ECDH_C
3248 scripts/config.py unset MBEDTLS_ECJPAKE_C
3249 # Disable ECP module (entirely)
3250 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003251 # Also disable bignum
3252 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003253 fi
3254
3255 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3256 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3257 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3258 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3259
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003260 # RSA support is intentionally disabled on this test because RSA_C depends
3261 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003262 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3263 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 +02003264 scripts/config.py unset MBEDTLS_RSA_C
3265 scripts/config.py unset MBEDTLS_PKCS1_V15
3266 scripts/config.py unset MBEDTLS_PKCS1_V21
3267 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3268 # Also disable key exchanges that depend on RSA
3269 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3270 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3271 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3272 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3273 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3274
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003275 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003276 # When testing ECC only, we disable FFDH support, both from builtin and
3277 # PSA sides, and also disable the key exchanges that depend on DHM.
3278 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3279 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 +01003280 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003281 scripts/config.py unset MBEDTLS_DHM_C
3282 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3283 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3284 else
3285 # When testing ECC and DH instead, we disable DHM and depending key
3286 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003287 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003288 scripts/config.py unset MBEDTLS_DHM_C
3289 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3290 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3291 fi
3292 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003293
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003294 # Restartable feature is not yet supported by PSA. Once it will in
3295 # the future, the following line could be removed (see issues
3296 # 6061, 6332 and following ones)
3297 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3298}
3299
Valerio Setti4e2f2442023-08-15 10:10:26 +02003300# Common helper used by:
3301# - component_test_psa_crypto_config_accel_ecc_no_bignum
3302# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003303#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003304# The goal is to build and test accelerating either:
3305# - ECC only or
3306# - both ECC and FFDH
3307#
3308# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003309# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3310# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003311common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003312 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003313
Valerio Setti5dfaca42023-09-05 08:48:51 +02003314 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003315 if [ "$test_target" = "ECC_DH" ]; then
3316 accel_text="ECC/FFDH"
3317 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003318 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003319 accel_text="ECC"
3320 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003321 fi
3322
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003323 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003324
3325 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003326 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3327 ALG_ECDH \
3328 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003329 $(helper_get_psa_key_type_list "ECC") \
3330 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003331 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003332 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003333 loc_accel_list="$loc_accel_list \
3334 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003335 $(helper_get_psa_key_type_list "DH") \
3336 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003337 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003338
3339 # Configure
3340 # ---------
3341
3342 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003343 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003344 # Disable all the builtin curves. All the required algs are accelerated.
3345 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003346
3347 # Build
3348 # -----
3349
3350 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003351 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3352 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3353 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003354
3355 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3356
Valerio Setti3fe105b2023-10-30 11:08:12 +01003357 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003358
3359 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3360 not grep mbedtls_ecdsa_ library/ecdsa.o
3361 not grep mbedtls_ecdh_ library/ecdh.o
3362 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003363 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003364 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003365 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003366 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003367 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003368
3369 # Run the tests
3370 # -------------
3371
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003372 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003373
Gilles Peskine21570cf2023-12-22 11:49:50 +01003374 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003375
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003376 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003377 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003378}
3379
Valerio Setti4e2f2442023-08-15 10:10:26 +02003380# Common helper used by:
3381# - component_test_psa_crypto_config_reference_ecc_no_bignum
3382# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3383#
3384# The goal is to build and test a reference scenario (i.e. with builtin
3385# components) compared to the ones used in
3386# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3387#
3388# It is meant to be used in conjunction with
3389# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3390# coverage analysis in "analyze_outcomes.py" script.
3391common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003392 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003393
Valerio Setti5dfaca42023-09-05 08:48:51 +02003394 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003395 if [ "$test_target" = "ECC_DH" ]; then
3396 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003397 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003398 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003399 fi
3400
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003401 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003402
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003403 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003404
Gilles Peskine21570cf2023-12-22 11:49:50 +01003405 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003406
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003407 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003408 make test
3409
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003410 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003411 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003412}
3413
Valerio Setti4e2f2442023-08-15 10:10:26 +02003414component_test_psa_crypto_config_accel_ecc_no_bignum () {
3415 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3416}
3417
3418component_test_psa_crypto_config_reference_ecc_no_bignum () {
3419 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3420}
3421
3422component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3423 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3424}
3425
3426component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3427 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3428}
3429
Valerio Settiac6d35f2023-08-04 12:49:11 +02003430# Helper for setting common configurations between:
3431# - component_test_tfm_config_p256m_driver_accel_ec()
3432# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003433common_tfm_config () {
3434 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003435 cp configs/config-tfm.h "$CONFIG_H"
3436 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3437 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003438
Yanray Wang73bb2312023-09-25 11:21:15 +08003439 # Other config adjustment to make the tests pass.
3440 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003441 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003442 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3443 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003444
Yanray Wang73bb2312023-09-25 11:21:15 +08003445 # Config adjustment for better test coverage in our environment.
3446 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003447 #
3448 # Enable filesystem I/O for the benefit of PK parse/write tests.
3449 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3450}
3451
Valerio Settiac6d35f2023-08-04 12:49:11 +02003452# Keep this in sync with component_test_tfm_config() as they are both meant
3453# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003454component_test_tfm_config_p256m_driver_accel_ec () {
3455 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3456
3457 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003458
Dave Rodgman897bb772023-11-15 16:34:20 +00003459 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003460 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003461
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003462 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3463 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003464 not grep mbedtls_ecdh_ library/ecdh.o
3465 not grep mbedtls_ecjpake_ library/ecjpake.o
3466 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3467 not grep mbedtls_ecp_ library/ecp.o
3468 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003469 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003470 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003471 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003472 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003473
Valerio Setti5e18b902023-12-04 12:07:30 +01003474 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3475 # files, so we want to ensure that it has not be re-enabled accidentally.
3476 not grep mbedtls_cipher library/cipher.o
3477
Valerio Settib7e95442023-03-21 11:52:33 +01003478 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003479 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003480 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003481}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003482
Valerio Settiac6d35f2023-08-04 12:49:11 +02003483# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3484# they are both meant to be used in analyze_outcomes.py for driver's coverage
3485# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003486component_test_tfm_config() {
3487 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003488
Dave Rodgman897bb772023-11-15 16:34:20 +00003489 # Disable P256M driver, which is on by default, so that analyze_outcomes
3490 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3491 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3492
Valerio Setti52ba0e32023-08-04 12:43:03 +02003493 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003494 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003495
Dave Rodgman897bb772023-11-15 16:34:20 +00003496 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003497 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003498
Valerio Setti5e18b902023-12-04 12:07:30 +01003499 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3500 # files, so we want to ensure that it has not be re-enabled accidentally.
3501 not grep mbedtls_cipher library/cipher.o
3502
Valerio Setti52ba0e32023-08-04 12:43:03 +02003503 msg "test: TF-M config"
3504 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003505}
3506
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003507# Common helper for component_full_without_ecdhe_ecdsa() and
3508# component_full_without_ecdhe_ecdsa_and_tls13() which:
3509# - starts from the "full" configuration minus the list of symbols passed in
3510# as 1st parameter
3511# - build
3512# - test only TLS (i.e. test_suite_tls and ssl-opt)
3513build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003514 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003515
3516 msg "build: full minus something, test TLS"
3517
3518 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003519 for sym in $symbols_to_disable; do
3520 echo "Disabling $sym"
3521 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003522 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003523
Gilles Peskine21570cf2023-12-22 11:49:50 +01003524 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003525
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003526 msg "test: full minus something, test TLS"
3527 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003528
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003529 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003530 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003531}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003532
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003533component_full_without_ecdhe_ecdsa () {
3534 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003535}
3536
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003537component_full_without_ecdhe_ecdsa_and_tls13 () {
3538 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3539 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003540}
3541
Valerio Setti249b18a2023-06-20 12:08:30 +02003542# This is an helper used by:
3543# - component_test_psa_ecc_key_pair_no_derive
3544# - component_test_psa_ecc_key_pair_no_generate
3545# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3546# enabled, but one. Input arguments are as follows:
3547# - $1 is the key type under test, i.e. ECC/RSA/DH
3548# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003549build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003550 key_type=$1
3551 unset_option=$2
3552 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003553
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003554 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003555 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003556 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3557 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3558
3559 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3560 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003561 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003562
Gilles Peskine21570cf2023-12-22 11:49:50 +01003563 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003564
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003565 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003566 make test
3567}
3568
3569component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003570 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003571}
3572
3573component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003574 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003575}
3576
Pengyu Lve705f572023-12-06 16:38:15 +08003577config_psa_crypto_accel_rsa () {
3578 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003579
Pengyu Lve705f572023-12-06 16:38:15 +08003580 # Start from crypto_full config (no X.509, no TLS)
3581 helper_libtestdriver1_adjust_config "crypto_full"
3582
3583 if [ "$driver_only" -eq 1 ]; then
3584 # Remove RSA support and its dependencies
3585 scripts/config.py unset MBEDTLS_RSA_C
3586 scripts/config.py unset MBEDTLS_PKCS1_V15
3587 scripts/config.py unset MBEDTLS_PKCS1_V21
3588
3589 # We need PEM parsing in the test library as well to support the import
3590 # of PEM encoded RSA keys.
3591 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3592 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3593 fi
3594}
3595
3596component_test_psa_crypto_config_accel_rsa_crypto () {
3597 msg "build: crypto_full with accelerated RSA"
3598
3599 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3600 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3601 KEY_TYPE_RSA_PUBLIC_KEY \
3602 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3603 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3604 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3605 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003606
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003607 # Configure
3608 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003609
Pengyu Lve705f572023-12-06 16:38:15 +08003610 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003611
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003612 # Build
3613 # -----
3614
Pengyu Lve705f572023-12-06 16:38:15 +08003615 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003616 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 +08003617 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003618 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003619
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003620 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003621
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003622 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003623 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003624
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003625 # Run the tests
3626 # -------------
3627
Pengyu Lve705f572023-12-06 16:38:15 +08003628 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003629 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003630}
3631
3632component_test_psa_crypto_config_reference_rsa_crypto () {
3633 msg "build: crypto_full with non-accelerated RSA"
3634
3635 # Configure
3636 # ---------
3637 config_psa_crypto_accel_rsa 0
3638
3639 # Build
3640 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003641 make
Pengyu Lve705f572023-12-06 16:38:15 +08003642
3643 # Run the tests
3644 # -------------
3645 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003646 make test
3647}
3648
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003649# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003650# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003651component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003652 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003653
Valerio Setti4590bc22023-06-13 15:39:23 +02003654 # Create a temporary output file unless there is already one set
3655 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3656 REMOVE_OUTCOME_ON_EXIT="no"
3657 else
3658 REMOVE_OUTCOME_ON_EXIT="yes"
3659 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3660 export MBEDTLS_TEST_OUTCOME_FILE
3661 fi
3662
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003663 # Start from crypto configuration
3664 scripts/config.py crypto
3665
3666 # Remove RSA support and its dependencies
3667 scripts/config.py unset MBEDTLS_PKCS1_V15
3668 scripts/config.py unset MBEDTLS_PKCS1_V21
3669 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3670 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3671 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3672 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3673 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3674 scripts/config.py unset MBEDTLS_RSA_C
3675 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3676
3677 # Enable PSA support
3678 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3679
Valerio Setti01cc88a2023-06-15 11:53:08 +02003680 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003681 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003682 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3683 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3684 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003685
3686 make
3687
Valerio Setti01cc88a2023-06-15 11:53:08 +02003688 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003689 make test
3690
3691 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3692 # performing RSA signature.
3693 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3694 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3695
3696 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3697 rm $MBEDTLS_TEST_OUTCOME_FILE
3698 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003699}
3700
Ronald Cronb2312452021-05-08 14:32:59 +02003701component_test_psa_crypto_config_accel_hash () {
3702 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3703
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003704 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3705 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3706 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003707
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003708 # Configure
3709 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003710
Ronald Cron46ac0652024-03-18 12:39:04 +01003711 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003712 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003713
3714 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003715 scripts/config.py unset MBEDTLS_MD5_C
3716 scripts/config.py unset MBEDTLS_RIPEMD160_C
3717 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003718 scripts/config.py unset MBEDTLS_SHA224_C
3719 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003720 scripts/config.py unset MBEDTLS_SHA384_C
3721 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003722 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003723
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003724 # Build
3725 # -----
3726
3727 helper_libtestdriver1_make_drivers "$loc_accel_list"
3728
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003729 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003730
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003731 # There's a risk of something getting re-enabled via config_psa.h;
3732 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3733 not grep mbedtls_md5 library/md5.o
3734 not grep mbedtls_sha1 library/sha1.o
3735 not grep mbedtls_sha256 library/sha256.o
3736 not grep mbedtls_sha512 library/sha512.o
3737 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003738
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003739 # Run the tests
3740 # -------------
3741
Ronald Cronb2312452021-05-08 14:32:59 +02003742 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3743 make test
3744}
3745
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003746# Auxiliary function to build config for hashes with and without drivers
3747config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003748 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003749 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003750 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003751 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003752 # disable the built-in implementation of hashes
3753 scripts/config.py unset MBEDTLS_MD5_C
3754 scripts/config.py unset MBEDTLS_RIPEMD160_C
3755 scripts/config.py unset MBEDTLS_SHA1_C
3756 scripts/config.py unset MBEDTLS_SHA224_C
3757 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003758 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003759 scripts/config.py unset MBEDTLS_SHA384_C
3760 scripts/config.py unset MBEDTLS_SHA512_C
3761 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003762 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003763 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003764}
3765
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003766# Note that component_test_psa_crypto_config_reference_hash_use_psa
3767# is related to this component and both components need to be kept in sync.
3768# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003769component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003770 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003771
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003772 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3773 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3774 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003775
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003776 # Configure
3777 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003778
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003779 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003780
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003781 # Build
3782 # -----
3783
3784 helper_libtestdriver1_make_drivers "$loc_accel_list"
3785
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003786 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003787
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003788 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003789 # 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 +02003790 not grep mbedtls_md5 library/md5.o
3791 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003792 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003793 not grep mbedtls_sha512 library/sha512.o
3794 not grep mbedtls_ripemd160 library/ripemd160.o
3795
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003796 # Run the tests
3797 # -------------
3798
Gilles Peskine14302ed2023-07-19 19:30:04 +02003799 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003800 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003801
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003802 # This is mostly useful so that we can later compare outcome files with
3803 # the reference config in analyze_outcomes.py, to check that the
3804 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003805 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003806 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003807
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003808 # This is to make sure all ciphersuites are exercised, but we don't need
3809 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003810 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003811 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003812}
3813
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003814# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3815# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3816# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3817# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003818component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003819 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003820
3821 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003822
Gilles Peskine21570cf2023-12-22 11:49:50 +01003823 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003824
Gilles Peskine14302ed2023-07-19 19:30:04 +02003825 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003826 make test
3827
Gilles Peskine14302ed2023-07-19 19:30:04 +02003828 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003829 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003830}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003831
Valerio Setti8eb310c2024-01-22 16:22:57 +01003832# Auxiliary function to build config for hashes with and without drivers
3833config_psa_crypto_hmac_use_psa () {
3834 driver_only="$1"
3835 # start with config full for maximum coverage (also enables USE_PSA)
3836 helper_libtestdriver1_adjust_config "full"
3837
Valerio Setticd89b0b2024-01-24 14:24:55 +01003838 if [ "$driver_only" -eq 1 ]; then
3839 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3840 # is still enabled though (for ENTROPY_C among others).
3841 scripts/config.py unset MBEDTLS_MD_C
3842 # Disable also the builtin hashes since they are supported by the driver
3843 # and MD module is able to perform PSA dispathing.
3844 scripts/config.py unset-all MBEDTLS_SHA
3845 scripts/config.py unset MBEDTLS_MD5_C
3846 scripts/config.py unset MBEDTLS_RIPEMD160_C
3847 fi
3848
Valerio Setti8eb310c2024-01-22 16:22:57 +01003849 # Direct dependencies of MD_C. We disable them also in the reference
3850 # component to work with the same set of features.
3851 scripts/config.py unset MBEDTLS_PKCS7_C
3852 scripts/config.py unset MBEDTLS_PKCS5_C
3853 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3854 scripts/config.py unset MBEDTLS_HKDF_C
3855 # Dependencies of HMAC_DRBG
3856 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3857 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3858}
3859
3860component_test_psa_crypto_config_accel_hmac() {
3861 msg "test: full with accelerated hmac"
3862
3863 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3864 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3865 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3866 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3867
3868 # Configure
3869 # ---------
3870
3871 config_psa_crypto_hmac_use_psa 1
3872
Valerio Setti8eb310c2024-01-22 16:22:57 +01003873 # Build
3874 # -----
3875
3876 helper_libtestdriver1_make_drivers "$loc_accel_list"
3877
3878 helper_libtestdriver1_make_main "$loc_accel_list"
3879
3880 # Ensure that built-in support for HMAC is disabled.
3881 not grep mbedtls_md_hmac library/md.o
3882
3883 # Run the tests
3884 # -------------
3885
3886 msg "test: full with accelerated hmac"
3887 make test
3888}
3889
3890component_test_psa_crypto_config_reference_hmac() {
3891 msg "test: full without accelerated hmac"
3892
3893 config_psa_crypto_hmac_use_psa 0
3894
3895 make
3896
3897 msg "test: full without accelerated hmac"
3898 make test
3899}
3900
Valerio Setti9da01a72023-12-18 17:38:18 +01003901component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003902 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003903
Valerio Setti9da01a72023-12-18 17:38:18 +01003904 # Albeit this components aims at accelerating DES which should only support
3905 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3906 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003907 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3908 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3909 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003910
Valerio Setti9da01a72023-12-18 17:38:18 +01003911 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3912 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3913 # of this component. This limitation will be addressed by #8598.
3914
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003915 # Configure
3916 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003917
Valerio Setti9a427302023-10-17 11:40:42 +02003918 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003919 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003920
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003921 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003922 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3923 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3924 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3925 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3926 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3927 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3928 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003929 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003930
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003931 # Build
3932 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003933
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003934 helper_libtestdriver1_make_drivers "$loc_accel_list"
3935
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003936 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003937
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003938 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003939 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003940
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003941 # Run the tests
3942 # -------------
3943
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003944 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003945 make test
3946}
3947
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003948component_test_psa_crypto_config_accel_aead () {
3949 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3950
Valerio Setti3f02bb72023-10-02 15:57:33 +02003951 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3952 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003953
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003954 # Configure
3955 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003956
Valerio Setti3f02bb72023-10-02 15:57:33 +02003957 # Start from full config
3958 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003959
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003960 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003961 scripts/config.py unset MBEDTLS_GCM_C
3962 scripts/config.py unset MBEDTLS_CCM_C
3963 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003964
Valerio Settia50b89e2023-11-08 15:58:47 +01003965 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3966 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003967
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003968 # Build
3969 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003970
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003971 helper_libtestdriver1_make_drivers "$loc_accel_list"
3972
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003973 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003974
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003975 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003976 not grep mbedtls_ccm library/ccm.o
3977 not grep mbedtls_gcm library/gcm.o
3978 not grep mbedtls_chachapoly library/chachapoly.o
3979
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003980 # Run the tests
3981 # -------------
3982
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003983 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3984 make test
3985}
3986
Valerio Settib680fc42023-10-13 09:29:37 +02003987# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003988# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3989# - component_test_psa_crypto_config_reference_cipher_aead_cmac
3990common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003991 # Start from the full config
3992 helper_libtestdriver1_adjust_config "full"
3993
Valerio Settib680fc42023-10-13 09:29:37 +02003994 scripts/config.py unset MBEDTLS_NIST_KW_C
3995}
3996
Valerio Settib6b301f2023-10-04 12:05:05 +02003997# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01003998# - component_test_psa_crypto_config_accel_cipher_aead_cmac
3999# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004000# are meant to be used together in analyze_outcomes.py script in order to test
4001# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004002component_test_psa_crypto_config_accel_cipher_aead_cmac () {
4003 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004004
Valerio Settiad8b7f02023-10-25 12:39:50 +02004005 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 +01004006 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02004007 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02004008 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
4009
4010 # Configure
4011 # ---------
4012
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004013 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004014
4015 # Disable the things that are being accelerated
4016 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4017 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
4018 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
4019 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
4020 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
4021 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4022 scripts/config.py unset MBEDTLS_GCM_C
4023 scripts/config.py unset MBEDTLS_CCM_C
4024 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02004025 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02004026 scripts/config.py unset MBEDTLS_DES_C
4027 scripts/config.py unset MBEDTLS_AES_C
4028 scripts/config.py unset MBEDTLS_ARIA_C
4029 scripts/config.py unset MBEDTLS_CHACHA20_C
4030 scripts/config.py unset MBEDTLS_CAMELLIA_C
4031
Valerio Settiec9b2582023-11-08 16:50:54 +01004032 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
4033 # does not depend on it.
4034 scripts/config.py unset MBEDTLS_CIPHER_C
4035
Valerio Settib6b301f2023-10-04 12:05:05 +02004036 # Build
4037 # -----
4038
4039 helper_libtestdriver1_make_drivers "$loc_accel_list"
4040
4041 helper_libtestdriver1_make_main "$loc_accel_list"
4042
4043 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01004044 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02004045 not grep mbedtls_des library/des.o
4046 not grep mbedtls_aes library/aes.o
4047 not grep mbedtls_aria library/aria.o
4048 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004049 not grep mbedtls_ccm library/ccm.o
4050 not grep mbedtls_gcm library/gcm.o
4051 not grep mbedtls_chachapoly library/chachapoly.o
4052 not grep mbedtls_cmac library/cmac.o
4053
4054 # Run the tests
4055 # -------------
4056
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004057 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004058 make test
Valerio Settif9414552023-11-09 10:43:20 +01004059
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004060 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004061 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004062
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004063 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004064 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004065}
4066
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004067component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4068 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4069 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004070
Gilles Peskine21570cf2023-12-22 11:49:50 +01004071 make
Valerio Settif9414552023-11-09 10:43:20 +01004072
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004073 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004074 make test
Valerio Settif9414552023-11-09 10:43:20 +01004075
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004076 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004077 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004078
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004079 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004080 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004081}
4082
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004083common_block_cipher_dispatch() {
4084 TEST_WITH_DRIVER="$1"
4085
4086 # Start from the full config
4087 helper_libtestdriver1_adjust_config "full"
4088
4089 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4090 # Disable key types that are accelerated (there is no legacy equivalent
4091 # symbol for ECB)
4092 scripts/config.py unset MBEDTLS_AES_C
4093 scripts/config.py unset MBEDTLS_ARIA_C
4094 scripts/config.py unset MBEDTLS_CAMELLIA_C
4095 fi
4096
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004097 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004098 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004099 # Keep this also in the reference component in order to skip the same tests
4100 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004101 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4102 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4103 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4104 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4105 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4106 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4107 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02004108 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004109
4110 # Disable direct dependency on AES_C
4111 scripts/config.py unset MBEDTLS_NIST_KW_C
4112
4113 # Prevent the cipher module from using deprecated PSA path. The reason is
4114 # that otherwise there will be tests relying on "aes_info" (defined in
4115 # "cipher_wrap.c") whose functions are not available when AES_C is
4116 # not defined. ARIA and Camellia are not a problem in this case because
4117 # the PSA path is not tested for these key types.
4118 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4119}
4120
Valerio Settif8e6cba2023-12-12 11:53:39 +01004121component_test_full_block_cipher_psa_dispatch () {
4122 msg "build: full + PSA dispatch in block_cipher"
4123
4124 loc_accel_list="ALG_ECB_NO_PADDING \
4125 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4126
4127 # Configure
4128 # ---------
4129
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004130 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004131
Valerio Settif8e6cba2023-12-12 11:53:39 +01004132 # Build
4133 # -----
4134
4135 helper_libtestdriver1_make_drivers "$loc_accel_list"
4136
4137 helper_libtestdriver1_make_main "$loc_accel_list"
4138
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004139 # Make sure disabled components were not re-enabled by accident (additive
4140 # config)
4141 not grep mbedtls_aes_ library/aes.o
4142 not grep mbedtls_aria_ library/aria.o
4143 not grep mbedtls_camellia_ library/camellia.o
4144
Valerio Settif8e6cba2023-12-12 11:53:39 +01004145 # Run the tests
4146 # -------------
4147
4148 msg "test: full + PSA dispatch in block_cipher"
4149 make test
4150}
4151
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004152# This is the reference component of component_test_full_block_cipher_psa_dispatch
4153component_test_full_block_cipher_legacy_dispatch () {
4154 msg "build: full + legacy dispatch in block_cipher"
4155
4156 common_block_cipher_dispatch 0
4157
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004158 make
4159
4160 msg "test: full + legacy dispatch in block_cipher"
4161 make test
4162}
4163
Gilles Peskine36dea152023-07-20 22:19:45 +02004164component_test_aead_chachapoly_disabled() {
4165 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004166 scripts/config.py full
4167 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004168 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004169 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004170
Gilles Peskine36dea152023-07-20 22:19:45 +02004171 msg "test: full minus CHACHAPOLY"
4172 make test
4173}
4174
4175component_test_aead_only_ccm() {
4176 msg "build: full minus CHACHAPOLY and GCM"
4177 scripts/config.py full
4178 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4179 scripts/config.py unset MBEDTLS_GCM_C
4180 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4181 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004182 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004183
4184 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004185 make test
4186}
4187
Ronald Crone501d0e2023-07-10 08:31:19 +02004188component_test_ccm_aes_sha256() {
4189 msg "build: CCM + AES + SHA256 configuration"
4190
Ronald Cron7612d8c2023-07-20 10:03:54 +02004191 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004192 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004193
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004194 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004195
4196 msg "test: CCM + AES + SHA256 configuration"
4197 make test
4198}
4199
Dave Rodgman904c5892023-06-28 17:36:02 +01004200support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004201 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004202}
4203
Dave Rodgman904c5892023-06-28 17:36:02 +01004204component_build_tfm_armcc() {
4205 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004206 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004207
Dave Rodgman88651c42023-06-29 12:35:51 +01004208 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004209 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 +01004210}
4211
4212component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004213 # Check that the TF-M configuration can build cleanly with various
4214 # warning flags enabled. We don't build or run tests, since the
4215 # TF-M configuration needs a TF-M platform. A tweaked version of
4216 # the configuration that works on mainstream platforms is in
4217 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004218 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004219
Dave Rodgman88651c42023-06-29 12:35:51 +01004220 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004221 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 +01004222
Dave Rodgman904c5892023-06-28 17:36:02 +01004223 msg "build: TF-M config, gcc native build"
4224 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004225 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 +01004226}
4227
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004228# Test that the given .o file builds with all (valid) combinations of the given options.
4229#
4230# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4231#
4232# The validator function is the name of a function to validate the combination of options.
4233# It may be "" if all combinations are valid.
4234# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004235# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004236build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004237 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004238 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004239 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004240 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004241 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004242
Dave Rodgman42436102023-10-03 15:47:05 +01004243 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004244 for opt in "${options[@]}"; do
4245 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004246 done
4247
4248 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004249 cd $(dirname ${file})
4250 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004251
Dave Rodgman920343a2023-10-01 18:41:09 +01004252 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004253 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 +01004254
Dave Rodgman42436102023-10-03 15:47:05 +01004255 # Extract the command generated by the Makefile to build the target file.
4256 # This ensures that we have any include paths, macro definitions, etc
4257 # that may be applied by make.
4258 # 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 +01004259 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004260
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004261 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004262 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004263
Dave Rodgman28e38d82023-10-04 11:50:30 +01004264 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004265 source_file=${file%.o}.c
4266
4267 targets=0
4268 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004269
Dave Rodgman28e38d82023-10-04 11:50:30 +01004270 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004271 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004272 # each bit of $i is used to determine if options[i] will be set or not
4273 target="t"
4274 clang_args=""
4275 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004276 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004277 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004278 clang_args="${clang_args} ${opt}"
4279 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004280 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004281 done
4282
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004283 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004284 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004285 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004286 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004287
Dave Rodgman28e38d82023-10-04 11:50:30 +01004288 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004289 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004290 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004291 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004292
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004293 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004294
Dave Rodgman920343a2023-10-01 18:41:09 +01004295 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004296 make -s -f ${makefile} build_test_config_combos
4297 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004298
4299 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004300 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004301}
4302
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004303validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004304 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4305 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004306 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004307 fi
4308 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4309 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004310 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004311 fi
4312 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004313 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004314}
4315
4316component_build_aes_variations() {
4317 # 18s - around 90ms per clang invocation on M1 Pro
4318 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004319 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004320 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004321
Yanray Wangbc29aef2023-11-06 11:08:17 +08004322 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004323 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004324
Dave Rodgman42436102023-10-03 15:47:05 +01004325 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004326 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4327 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4328 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4329 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004330
4331 cd "$MBEDTLS_ROOT_DIR"
4332 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4333
Yanray Wang42be1ba2023-11-23 14:28:47 +08004334 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004335 # manually set or unset those configurations to check
4336 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004337 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4338 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4339 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4340 scripts/config.py unset MBEDTLS_DES_C
4341 scripts/config.py unset MBEDTLS_NIST_KW_C
4342 build_test_config_combos library/aes.o validate_aes_config_variations \
4343 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4344 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4345 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4346 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004347}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004348
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004349component_test_no_platform () {
4350 # Full configuration build, without platform support, file IO and net sockets.
4351 # This should catch missing mbedtls_printf definitions, and by disabling file
4352 # IO, it should catch missing '#include <stdio.h>'
4353 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004354 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004355 scripts/config.py unset MBEDTLS_PLATFORM_C
4356 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004357 scripts/config.py unset MBEDTLS_FS_IO
4358 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004359 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004360 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004361 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004362 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004363 # to re-enable platform integration features otherwise disabled in C99 builds
4364 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004365 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004366}
Gilles Peskine7c652162017-12-11 00:01:40 +01004367
4368component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004369 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004370 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4371 scripts/config.py full
4372 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004373 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4374 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4375 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4376 make
4377}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004378
Gilles Peskine8f073122018-11-27 15:58:47 +01004379component_build_no_ssl_srv () {
4380 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004381 scripts/config.py full
4382 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004383 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004384}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004385
Gilles Peskine8f073122018-11-27 15:58:47 +01004386component_build_no_ssl_cli () {
4387 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004388 scripts/config.py full
4389 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004390 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004391}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004392
Gilles Peskine8f073122018-11-27 15:58:47 +01004393component_build_no_sockets () {
4394 # Note, C99 compliance can also be tested with the sockets support disabled,
4395 # as that requires a POSIX platform (which isn't the same as C99).
4396 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004397 scripts/config.py full
4398 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4399 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4400 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4401}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004402
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004403component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004404 msg "build: default config with memory buffer allocator and backtrace enabled"
4405 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4406 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4407 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004408 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004409 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004410 make
4411
4412 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4413 make test
4414}
4415
4416component_test_memory_buffer_allocator () {
4417 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004418 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4419 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004420 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004421 make
4422
4423 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4424 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004425
4426 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4427 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004428 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004429}
4430
Gilles Peskine8f073122018-11-27 15:58:47 +01004431component_test_no_max_fragment_length () {
4432 # Run max fragment length tests with MFL disabled
4433 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004434 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004435 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004436 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004437
Gilles Peskine8f073122018-11-27 15:58:47 +01004438 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004439 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004440}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004441
Hanno Becker545ced42019-02-19 11:10:48 +00004442component_test_asan_remove_peer_certificate () {
4443 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004444 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004445 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004446 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004447 make
4448
4449 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4450 make test
4451
4452 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004453 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004454
4455 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004456 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004457
4458 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004459 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004460}
4461
Gilles Peskine8f073122018-11-27 15:58:47 +01004462component_test_no_max_fragment_length_small_ssl_out_content_len () {
4463 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004464 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4465 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4466 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004467 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004468 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004469
Gilles Peskine8f073122018-11-27 15:58:47 +01004470 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004471 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004472
4473 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004474 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004475}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004476
Darryl Greenaad82f92019-12-02 10:53:11 +00004477component_test_variable_ssl_in_out_buffer_len () {
4478 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4479 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004480 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004481 make
4482
4483 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4484 make test
4485
4486 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004487 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004488
4489 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004490 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004491}
4492
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004493component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004494 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004495 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004496
Dave Rodgman17127e92023-12-14 16:42:48 +00004497 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004498 make
4499
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004500 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004501 make test
4502
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004503 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004504 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004505
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004506 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004507 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004508}
4509
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004510component_test_ssl_alloc_buffer_and_mfl () {
4511 msg "build: default config with memory buffer allocator and MFL extension"
4512 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4513 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4514 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4515 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4516 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004517 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004518 make
4519
4520 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4521 make test
4522
4523 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 +02004524 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004525}
4526
Gilles Peskine636c26a2020-03-04 20:46:15 +01004527component_test_when_no_ciphersuites_have_mac () {
4528 msg "build: when no ciphersuites have MAC"
4529 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004530 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004531 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004532 make
4533
4534 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4535 make test
4536
4537 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004538 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004539}
4540
Raoul Strackxa4e86142020-06-15 17:03:13 +02004541component_test_no_date_time () {
4542 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4543 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004544 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004545 make
4546
4547 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4548 make test
4549}
4550
Gilles Peskine8f073122018-11-27 15:58:47 +01004551component_test_platform_calloc_macro () {
4552 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004553 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4554 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4555 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004556 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004557 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004558
Gilles Peskine8f073122018-11-27 15:58:47 +01004559 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4560 make test
4561}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004562
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004563component_test_malloc_0_null () {
4564 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004565 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004566 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 +02004567
4568 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4569 make test
4570
4571 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4572 # Just the calloc selftest. "make test" ran the others as part of the
4573 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004574 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004575
4576 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4577 # Run a subset of the tests. The choice is a balance between coverage
4578 # and time (including time indirectly wasted due to flaky tests).
4579 # The current choice is to skip tests whose description includes
4580 # "proxy", which is an approximation of skipping tests that use the
4581 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004582 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004583}
4584
Dave Rodgman6a08b682023-06-19 11:51:33 +01004585support_test_aesni() {
4586 # Check that gcc targets x86_64 (we can build AESNI), and check for
4587 # AESNI support on the host (we can run AESNI).
4588 #
4589 # The name of this function is possibly slightly misleading, but needs to align
4590 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004591 #
4592 # In principle 32-bit x86 can support AESNI, but our implementation does not
4593 # support 32-bit x86, so we check for x86-64.
4594 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004595 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4596 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004597 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004598}
4599
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004600component_test_aesni () { # ~ 60s
4601 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4602 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4603 #
4604 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4605 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4606 # exercise the plain C impl).
4607
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004608 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004609 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004610 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004611 scripts/config.py set MBEDTLS_HAVE_ASM
4612
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004613 # test the intrinsics implementation
4614 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004615 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004616 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004617 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004618 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004619
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004620 # test the asm implementation
4621 msg "AES tests, test assembly"
4622 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004623 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004624 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004625 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004626
4627 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004628 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004629 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004630 msg "AES tests, plain C"
4631 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004632 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004633 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004634 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004635 not grep -q "AES note: using AESNI" ./programs/test/selftest
4636 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004637
4638 # test the intrinsics implementation
4639 scripts/config.py set MBEDTLS_AESNI_C
4640 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4641 msg "AES tests, test AESNI only"
4642 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004643 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004644 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4645 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004646 grep -q "AES note: using AESNI" ./programs/test/selftest
4647 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004648}
4649
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004650component_test_sha3_variations() {
4651 msg "sha3 loop unroll variations"
4652
4653 # define minimal config sufficient to test SHA3
4654 cat > include/mbedtls/mbedtls_config.h << END
4655 #define MBEDTLS_SELF_TEST
4656 #define MBEDTLS_SHA3_C
4657END
4658
4659 msg "all loops unrolled"
4660 make clean
4661 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"
4662 ./tests/test_suite_shax
4663
4664 msg "all loops rolled up"
4665 make clean
4666 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"
4667 ./tests/test_suite_shax
4668}
4669
Jerry Yub6d39c22023-08-16 15:11:48 +08004670support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004671 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004672}
4673
4674component_test_aesni_m32 () { # ~ 60s
4675 # This tests are duplicated from component_test_aesni for i386 target
4676 #
4677 # AESNI intrinsic code supports i386 and assembly code does not support it.
4678
4679 msg "build: default config with different AES implementations"
4680 scripts/config.py set MBEDTLS_AESNI_C
4681 scripts/config.py set MBEDTLS_PADLOCK_C
4682 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4683 scripts/config.py set MBEDTLS_HAVE_ASM
4684
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004685 # test the intrinsics implementation with gcc
4686 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004687 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004688 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004689 # check that we built intrinsics - this should be used by default when supported by the compiler
4690 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4691 grep -q "AES note: using AESNI" ./programs/test/selftest
4692 grep -q "AES note: built-in implementation." ./programs/test/selftest
4693 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4694 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4695
4696 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004697 scripts/config.py unset MBEDTLS_PADLOCK_C
4698 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4699 msg "AES tests, test AESNI only"
4700 make clean
4701 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4702 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4703 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4704 grep -q "AES note: using AESNI" ./programs/test/selftest
4705 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4706 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4707 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4708}
4709
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004710support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004711 # clang >= 4 is required to build with target attributes
4712 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004713}
4714
4715component_test_aesni_m32_clang() {
4716
4717 scripts/config.py set MBEDTLS_AESNI_C
4718 scripts/config.py set MBEDTLS_PADLOCK_C
4719 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4720 scripts/config.py set MBEDTLS_HAVE_ASM
4721
4722 # test the intrinsics implementation with clang
4723 msg "AES tests, test intrinsics (clang)"
4724 make clean
4725 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4726 # check that we built intrinsics - this should be used by default when supported by the compiler
4727 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4728 grep -q "AES note: using AESNI" ./programs/test/selftest
4729 grep -q "AES note: built-in implementation." ./programs/test/selftest
4730 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4731 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4732}
4733
Jerry Yu193cbc02023-08-03 17:06:29 +08004734# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4735component_build_aes_aesce_armcc () {
4736 msg "Build: AESCE test on arm64 platform without plain C."
4737 scripts/config.py baremetal
4738
4739 # armc[56] don't support SHA-512 intrinsics
4740 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4741
4742 # Stop armclang warning about feature detection for A64_CRYPTO.
4743 # With this enabled, the library does build correctly under armclang,
4744 # but in baremetal builds (as tested here), feature detection is
4745 # unavailable, and the user is notified via a #warning. So enabling
4746 # this feature would prevent us from building with -Werror on
4747 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004748 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004749 scripts/config.py set MBEDTLS_HAVE_ASM
4750
4751 msg "AESCE, build with default configuration."
4752 scripts/config.py set MBEDTLS_AESCE_C
4753 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4754 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4755
4756 msg "AESCE, build AESCE only"
4757 scripts/config.py set MBEDTLS_AESCE_C
4758 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4759 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4760}
4761
Dave Rodgman0c584032023-10-08 12:26:54 +01004762support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004763 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004764 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004765}
4766
4767component_build_aes_armce () {
4768 # Test variations of AES with Armv8 crypto extensions
4769 scripts/config.py set MBEDTLS_AESCE_C
4770 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4771
4772 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004773 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004774
4775 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4776 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4777
4778 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4779 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4780
Dave Rodgman5e419372023-10-23 15:30:20 +01004781 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004782
Dave Rodgman5e419372023-10-23 15:30:20 +01004783 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4784 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004785
Dave Rodgman5e419372023-10-23 15:30:20 +01004786 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4787 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004788
Dave Rodgman5e419372023-10-23 15:30:20 +01004789 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4790 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004791
4792 # test for presence of AES instructions
4793 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4794 msg "clang, test A32 crypto instructions built"
4795 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4796 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4797 msg "clang, test T32 crypto instructions built"
4798 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4799 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4800 msg "clang, test aarch64 crypto instructions built"
4801 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4802 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4803
4804 # test for absence of AES instructions
4805 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4806 scripts/config.py unset MBEDTLS_AESCE_C
4807 msg "clang, test A32 crypto instructions not built"
4808 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4809 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4810 msg "clang, test T32 crypto instructions not built"
4811 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4812 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4813 msg "clang, test aarch64 crypto instructions not built"
4814 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4815 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004816}
4817
Dave Rodgman9ed18532023-10-05 00:06:47 +01004818support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004819 # clang >= 4 is required to build with SHA extensions
4820 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004821}
4822
Dave Rodgmand9e80832023-10-04 17:17:46 +01004823component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004824 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004825
4826
4827 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004828 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004829 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4830 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4831 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4832 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4833 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004834
Dave Rodgmand9e80832023-10-04 17:17:46 +01004835
Dave Rodgman94a634d2023-10-10 12:59:29 +01004836 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004837 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004838 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4839 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4840 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004841
Dave Rodgman5b89c552023-10-10 14:59:02 +01004842 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004843 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4844 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4845 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004846
Dave Rodgmancd654002023-10-05 09:40:07 +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_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004850 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4851 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4852 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4853 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4854 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004855
Dave Rodgmancd654002023-10-05 09:40:07 +01004856
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004857 # examine the disassembly for presence of SHA instructions
4858 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4859 scripts/config.py set ${opt}
4860 msg "${opt} clang, test A32 crypto instructions built"
4861 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4862 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4863
4864 msg "${opt} clang, test T32 crypto instructions built"
4865 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4866 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4867
4868 msg "${opt} clang, test aarch64 crypto instructions built"
4869 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4870 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4871 scripts/config.py unset ${opt}
4872 done
4873
4874
4875 # examine the disassembly for absence of SHA instructions
4876 msg "clang, test A32 crypto instructions not built"
4877 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4878 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4879
4880 msg "clang, test T32 crypto instructions not built"
4881 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4882 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4883
4884 msg "clang, test aarch64 crypto instructions not built"
4885 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4886 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004887}
4888
Jerry Yuc935aa62023-08-03 17:08:27 +08004889# For timebeing, no VIA Padlock platform available.
4890component_build_aes_via_padlock () {
4891
4892 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004893 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004894 scripts/config.py set MBEDTLS_PADLOCK_C
4895 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00004896 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004897 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004898
4899}
4900
4901support_build_aes_via_padlock_only () {
4902 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4903 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4904 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4905}
4906
Jerry Yu193cbc02023-08-03 17:06:29 +08004907support_build_aes_aesce_armcc () {
4908 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004909}
4910
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004911component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004912 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004913 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004914 scripts/config.py unset MBEDTLS_PADLOCK_C
4915
Dave Rodgmand8d64512023-12-19 12:20:21 +00004916 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004917
4918 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4919 make test
4920}
4921
4922component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4923 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4924 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004925 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4926 scripts/config.py unset MBEDTLS_PADLOCK_C
4927
Hanno Becker83ebf782017-07-07 12:29:15 +01004928 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004929
4930 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004931 make test
4932}
Gilles Peskine8f073122018-11-27 15:58:47 +01004933
Hanno Becker83ebf782017-07-07 12:29:15 +01004934component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004935 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4936 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4937 scripts/config.py unset MBEDTLS_PADLOCK_C
4938 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004939 scripts/config.py unset MBEDTLS_AESCE_C
4940
Dave Rodgmand8d64512023-12-19 12:20:21 +00004941 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004942
4943 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004944 make test
4945
4946 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4947 programs/test/selftest
4948}
4949
Matthias Schulz0767fda2024-02-07 10:46:28 +01004950component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004951 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4952 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004953 scripts/config.py unset MBEDTLS_PADLOCK_C
4954 scripts/config.py unset MBEDTLS_AESNI_C
4955 scripts/config.py unset MBEDTLS_AESCE_C
4956
4957 make CFLAGS='-O2 -Werror -Wall -Wextra'
4958
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004959 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004960 make test
4961}
4962
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004963component_test_aes_fewer_tables () {
4964 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004965 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004966 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004967
Gilles Peskine7c652162017-12-11 00:01:40 +01004968 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004969 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004970}
4971
4972component_test_aes_rom_tables () {
4973 msg "build: default config with AES_ROM_TABLES enabled"
4974 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004975 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004976
4977 msg "test: AES_ROM_TABLES"
4978 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004979}
4980
Gilles Peskine14c3c062018-01-29 21:25:12 +01004981component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004982 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4983 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4984 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004985 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004986
Gilles Peskine8f073122018-11-27 15:58:47 +01004987 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
4988 make test
4989}
4990
Yanray Wang49cd4b52023-11-10 11:58:37 +08004991# helper for common_block_cipher_no_decrypt() which:
4992# - enable/disable the list of config options passed from -s/-u respectively.
4993# - build
4994# - test for tests_suite_xxx
4995# - selftest
4996#
4997# Usage: helper_block_cipher_no_decrypt_build_test
4998# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4999# Options: -s set_opts the list of config options to enable
5000# -u unset_opts the list of config options to disable
5001# -c cflags the list of options passed to CFLAGS
5002# -l ldflags the list of options passed to LDFLAGS
5003helper_block_cipher_no_decrypt_build_test () {
5004 while [ $# -gt 0 ]; do
5005 case "$1" in
5006 -s)
5007 shift; local set_opts="$1";;
5008 -u)
5009 shift; local unset_opts="$1";;
5010 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005011 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005012 -l)
5013 shift; local ldflags="$1";;
5014 esac
5015 shift
5016 done
5017 set_opts="${set_opts:-}"
5018 unset_opts="${unset_opts:-}"
5019 cflags="${cflags:-}"
5020 ldflags="${ldflags:-}"
5021
Yanray Wangb2d6e522023-11-13 16:57:47 +08005022 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5023 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005024
5025 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5026 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005027 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005028
5029 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5030 not grep mbedtls_aes_setkey_dec library/aes.o
5031 not grep mbedtls_aria_setkey_dec library/aria.o
5032 not grep mbedtls_camellia_setkey_dec library/camellia.o
5033 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5034 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005035 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5036 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005037
5038 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5039 make test
5040
5041 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5042 programs/test/selftest
5043}
5044
5045# This is a common configuration function used in:
5046# - component_test_block_cipher_no_decrypt_aesni_legacy()
5047# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5048# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5049# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5050# on x86.
5051common_block_cipher_no_decrypt () {
5052 # test AESNI intrinsics
5053 helper_block_cipher_no_decrypt_build_test \
5054 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005055 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005056
5057 # test AESNI assembly
5058 helper_block_cipher_no_decrypt_build_test \
5059 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005060 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005061
5062 # test AES C implementation
5063 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005064 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005065
5066 # test AESNI intrinsics for i386 target
5067 helper_block_cipher_no_decrypt_build_test \
5068 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005069 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005070 -l "-m32"
5071}
5072
Yanray Wang3ae11992023-11-13 17:32:09 +08005073# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5074# usage: 0: no PSA crypto configuration
5075# 1: use PSA crypto configuration
5076config_block_cipher_no_decrypt () {
5077 use_psa=$1
5078
Yanray Wang66111392023-10-31 18:54:54 +08005079 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005080 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5081 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005082 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005083 scripts/config.py unset MBEDTLS_NIST_KW_C
5084
Yanray Wang3ae11992023-11-13 17:32:09 +08005085 if [ "$use_psa" -eq 1 ]; then
5086 # Enable support for cryptographic mechanisms through the PSA API.
5087 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5088 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5089 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5090 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5091 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5092 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5093 fi
5094}
5095
5096component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005097 # This consistently causes an llvm crash on clang 3.8, so use gcc
5098 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005099 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005100 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005101}
5102
Yanray Wangf1496402023-11-01 18:55:13 +08005103component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005104 # This consistently causes an llvm crash on clang 3.8, so use gcc
5105 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005106 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005107 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005108}
5109
Yanray Wang66111392023-10-31 18:54:54 +08005110support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005111 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005112}
5113
Yanray Wang66111392023-10-31 18:54:54 +08005114component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005115 scripts/config.py baremetal
5116
5117 # armc[56] don't support SHA-512 intrinsics
5118 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5119
5120 # Stop armclang warning about feature detection for A64_CRYPTO.
5121 # With this enabled, the library does build correctly under armclang,
5122 # but in baremetal builds (as tested here), feature detection is
5123 # unavailable, and the user is notified via a #warning. So enabling
5124 # this feature would prevent us from building with -Werror on
5125 # armclang. Tracked in #7198.
5126 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5127 scripts/config.py set MBEDTLS_HAVE_ASM
5128
Yanray Wang3ae11992023-11-13 17:32:09 +08005129 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005130
5131 # test AESCE baremetal build
5132 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005133 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005134 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005135
Yanray Wangef1b04d2023-09-08 11:09:26 +08005136 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5137 not grep mbedtls_aes_setkey_dec library/aes.o
5138 not grep mbedtls_aria_setkey_dec library/aria.o
5139 not grep mbedtls_camellia_setkey_dec library/camellia.o
5140 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5141 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005142 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005143 not grep mbedtls_aesce_inverse_key library/aesce.o
5144 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005145}
5146
Gilles Peskine592f5912019-10-07 18:49:32 +02005147component_test_ctr_drbg_aes_256_sha_256 () {
5148 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5149 scripts/config.py full
5150 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5151 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005152 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005153 make
5154
5155 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5156 make test
5157}
5158
5159component_test_ctr_drbg_aes_128_sha_512 () {
5160 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005161 scripts/config.py full
5162 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5163 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
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_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5168 make test
5169}
5170
5171component_test_ctr_drbg_aes_128_sha_256 () {
5172 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (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
5176 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005177 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005178 make
5179
5180 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5181 make test
5182}
5183
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005184component_test_se_default () {
5185 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005186 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005187 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005188
5189 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5190 make test
5191}
5192
Steven Cooremand57203d2020-07-16 20:28:59 +02005193component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005194 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005195 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005196 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005197 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5198 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005199 loc_cflags="${loc_cflags} -I../tests/include -O2"
5200
Gilles Peskine21570cf2023-12-22 11:49:50 +01005201 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005202
Gilles Peskine1997f302023-07-26 18:45:20 +02005203 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005204 make test
5205}
5206
Gilles Peskine8f073122018-11-27 15:58:47 +01005207component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005208 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005209 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005210 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005211 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005212}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005213
Gilles Peskinecf740502019-07-03 20:43:05 +02005214component_test_cmake_shared () {
5215 msg "build/test: cmake shared" # ~ 2min
5216 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5217 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005218 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005219 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005220 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005221}
5222
Gilles Peskineec10bf12019-09-20 19:56:06 +02005223test_build_opt () {
5224 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005225 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005226 for opt in "$@"; do
5227 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005228 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005229 # We're confident enough in compilers to not run _all_ the tests,
5230 # but at least run the unit tests. In particular, runs with
5231 # optimizations use inline assembly whereas runs with -O0
5232 # skip inline assembly.
5233 make test # ~30s
5234 make clean
5235 done
5236}
5237
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005238# For FreeBSD we invoke the function by name so this condition is added
5239# to disable the existing test_clang_opt function for linux.
5240if [[ $(uname) != "Linux" ]]; then
5241 component_test_clang_opt () {
5242 scripts/config.py full
5243 test_build_opt 'full config' clang -O0 -Os -O2
5244 }
5245fi
5246
5247component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005248 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005249 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005250}
5251support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005252 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005253}
5254
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005255component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005256 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005257 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005258}
5259support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005260 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005261}
5262
5263component_test_gcc_latest_opt () {
5264 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005265 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005266}
5267support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005268 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005269}
5270
5271component_test_gcc_earliest_opt () {
5272 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005273 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005274}
5275support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005276 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005277}
5278
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005279component_build_mbedtls_config_file () {
5280 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005281 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005282 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005283 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005284 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005285 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5286 make clean
5287
5288 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5289 # In the user config, disable one feature (for simplicity, pick a feature
5290 # that nothing else depends on).
5291 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005292 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005293 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5294
5295 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005296}
5297
Gilles Peskine7d904e72022-04-07 21:59:14 +02005298component_build_psa_config_file () {
5299 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5300 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5301 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5302 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5303 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005304 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005305 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5306 make clean
5307
5308 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005309 # In the user config, disable one feature and its dependencies, which will
5310 # reflect on the mbedtls configuration so we can query it with
5311 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005312 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005313 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005314 scripts/config.py unset MBEDTLS_CMAC_C
5315 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5316 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5317
5318 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005319}
5320
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005321component_build_psa_alt_headers () {
5322 msg "build: make with PSA alt headers" # ~20s
5323
5324 # Generate alternative versions of the substitutable headers with the
5325 # same content except different include guards.
5326 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5327
5328 # Build the library and some programs.
5329 # Don't build the fuzzers to avoid having to go through hoops to set
5330 # a correct include path for programs/fuzz/Makefile.
5331 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
5332 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\"'"
5333
5334 # Check that we're getting the alternative include guards and not the
5335 # original include guards.
5336 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5337 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5338 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5339 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5340}
5341
Dave Rodgman852de3c2023-12-14 14:46:45 +00005342component_test_m32_no_asm () {
5343 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005344 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005345 #
5346 # Note that we require gcc, because clang Asan builds fail to link for
5347 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005348 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005349 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005350 scripts/config.py unset MBEDTLS_HAVE_ASM
5351 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005352 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005353 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005354
Dave Rodgman852de3c2023-12-14 14:46:45 +00005355 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005356 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005357}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005358support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005359 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005360 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005361 *) false;;
5362 esac
5363}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005364
Gilles Peskineff0aee02021-10-05 09:36:03 +02005365component_test_m32_o2 () {
5366 # Build with optimization, to use the i386 specific inline assembly
5367 # and go faster for tests.
5368 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005369 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005370 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005371 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005372
Gilles Peskineff0aee02021-10-05 09:36:03 +02005373 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005374 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005375
Gilles Peskineff0aee02021-10-05 09:36:03 +02005376 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005377 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005378}
Gilles Peskinecf522222021-10-07 19:25:29 +02005379support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005380 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005381}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005382
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005383component_test_m32_everest () {
5384 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005385 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005386 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005387 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005388
5389 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5390 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005391
5392 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005393 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005394
5395 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5396 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005397 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005398}
5399support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005400 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005401}
5402
Gilles Peskine8f073122018-11-27 15:58:47 +01005403component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005404 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005405 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005406 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005407
5408 msg "test: 64-bit ILP32, make, gcc"
5409 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005410}
Gilles Peskine878cf602019-01-06 20:50:38 +00005411support_test_mx32 () {
5412 case $(uname -m) in
5413 amd64|x86_64) true;;
5414 *) false;;
5415 esac
5416}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005417
Peter Kolbus60c6da22018-12-27 06:59:04 -06005418component_test_min_mpi_window_size () {
5419 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005420 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005421 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005422 make
5423
5424 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5425 make test
5426}
5427
Gilles Peskine8f073122018-11-27 15:58:47 +01005428component_test_have_int32 () {
5429 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005430 scripts/config.py unset MBEDTLS_HAVE_ASM
5431 scripts/config.py unset MBEDTLS_AESNI_C
5432 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005433 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005434 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005435
Gilles Peskine8f073122018-11-27 15:58:47 +01005436 msg "test: gcc, force 32-bit bignum limbs"
5437 make test
5438}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005439
Gilles Peskine8f073122018-11-27 15:58:47 +01005440component_test_have_int64 () {
5441 msg "build: gcc, force 64-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_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005447
Gilles Peskine8f073122018-11-27 15:58:47 +01005448 msg "test: gcc, force 64-bit bignum limbs"
5449 make test
5450}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005451
Gabor Mezeie256cc12023-07-26 17:28:48 +02005452component_test_have_int32_cmake_new_bignum () {
5453 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5454 scripts/config.py unset MBEDTLS_HAVE_ASM
5455 scripts/config.py unset MBEDTLS_AESNI_C
5456 scripts/config.py unset MBEDTLS_PADLOCK_C
5457 scripts/config.py unset MBEDTLS_AESCE_C
5458 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005459 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005460 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005461
5462 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5463 make test
5464}
5465
Gilles Peskine8f073122018-11-27 15:58:47 +01005466component_test_no_udbl_division () {
5467 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005468 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005469 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005470 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005471
Gilles Peskine8f073122018-11-27 15:58:47 +01005472 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5473 make test
5474}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005475
Gilles Peskine8f073122018-11-27 15:58:47 +01005476component_test_no_64bit_multiplication () {
5477 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005478 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005479 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005480 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005481
Gilles Peskine8f073122018-11-27 15:58:47 +01005482 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5483 make test
5484}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005485
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005486component_test_no_strings () {
5487 msg "build: no strings" # ~10s
5488 scripts/config.py full
5489 # Disable options that activate a large amount of string constants.
5490 scripts/config.py unset MBEDTLS_DEBUG_C
5491 scripts/config.py unset MBEDTLS_ERROR_C
5492 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5493 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005494 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005495
5496 msg "test: no strings" # ~ 10s
5497 make test
5498}
5499
Hanno Beckerc5722d12020-10-09 11:10:42 +01005500component_test_no_x509_info () {
5501 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5502 scripts/config.pl full
5503 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5504 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005505 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005506
5507 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5508 make test
5509
5510 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005511 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005512}
5513
Gilles Peskine8f073122018-11-27 15:58:47 +01005514component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005515 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005516 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005517 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 +02005518
Gilles Peskinee36fe812021-09-01 20:00:33 +02005519 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005520 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005521}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005522
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005523component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005524 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005525 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005526 # Build for a target platform that's close to what Debian uses
5527 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005528 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005529 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005530 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005531 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'
5532
Gilles Peskinee36fe812021-09-01 20:00:33 +02005533 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005534 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005535}
5536support_build_arm_linux_gnueabi_gcc_arm5vte () {
5537 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5538}
5539
5540component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005541 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005542 scripts/config.py baremetal
5543 # This is an imperfect substitute for
5544 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005545 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005546 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 +02005547
Gilles Peskinee36fe812021-09-01 20:00:33 +02005548 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005549 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005550}
5551
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005552component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005553 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5554 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005555 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 +02005556
Gilles Peskinee36fe812021-09-01 20:00:33 +02005557 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005558 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005559 for lib in library/*.a; do
5560 echo "$lib:"
5561 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5562 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005563}
5564
Gilles Peskine8f073122018-11-27 15:58:47 +01005565component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005566 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005567 scripts/config.py baremetal
5568 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005569 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 +01005570 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005571 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005572}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005573
Gilles Peskine8f073122018-11-27 15:58:47 +01005574component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005575 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005576 scripts/config.py baremetal
5577 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005578 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 +01005579 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005580 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005581}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005582
Dave Rodgman8c315f22023-06-02 10:26:24 -04005583component_build_arm_clang_thumb () {
5584 # ~ 30s
5585
5586 scripts/config.py baremetal
5587
5588 msg "build: clang thumb 2, make"
5589 make clean
5590 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5591
5592 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5593 msg "build: clang thumb 1 -O0, make"
5594 make clean
5595 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5596
5597 msg "build: clang thumb 1 -Os, make"
5598 make clean
5599 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5600}
5601
Gilles Peskine8f073122018-11-27 15:58:47 +01005602component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005603 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005604 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005605 # armc[56] don't support SHA-512 intrinsics
5606 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005607
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005608 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5609 scripts/config.py unset MBEDTLS_AESCE_C
5610
Dave Rodgman0fddf822023-03-02 15:32:12 +00005611 # Stop armclang warning about feature detection for A64_CRYPTO.
5612 # With this enabled, the library does build correctly under armclang,
5613 # but in baremetal builds (as tested here), feature detection is
5614 # unavailable, and the user is notified via a #warning. So enabling
5615 # this feature would prevent us from building with -Werror on
5616 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005617 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005618
Hanno Beckerf0762e92022-07-15 12:08:19 +01005619 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005620
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005621 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005622
5623 msg "size: ARM Compiler 5"
5624 "$ARMC5_FROMELF" -z library/*.o
5625
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005626 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005627
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005628 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005629 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005630
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005631 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005632 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5633
5634 # ARM Compiler 6 - Target ARMv7-M+DSP
5635 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005636
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005637 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005638 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005639
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005640 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005641 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005642
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005643 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5644 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5645
Dave Rodgman99318e62023-05-24 12:27:42 +01005646 # ARM Compiler 6 - Target Cortex-M0
5647 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005648
5649 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5650 #
5651 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5652 # that we have in our CI
5653 scripts/config.py set MBEDTLS_AESCE_C
5654 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005655}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005656
Pengyu Lvdf070032023-02-24 16:03:31 +08005657support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005658 armc5_cc="$ARMC5_BIN_DIR/armcc"
5659 armc6_cc="$ARMC6_BIN_DIR/armclang"
5660 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005661}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005662
Ronald Crond2cb7f42024-03-18 12:49:18 +01005663component_test_tls12_only () {
5664 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5665 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5666 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5667 make
5668
5669 msg "test: main suites (inc. selftests) (ASan build)"
5670 make test
5671
5672 msg "test: ssl-opt.sh (ASan build)"
5673 tests/ssl-opt.sh
5674
5675 msg "test: compat.sh (ASan build)"
5676 tests/compat.sh
5677}
5678
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005679component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005680 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005681 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005682 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005683 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5684
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005685 msg "test: TLS 1.3 only, all key exchange modes enabled"
5686 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005687
Ronald Cronc3f43b62022-10-17 17:35:32 +02005688 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5689 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005690}
5691
Ronald Cronc3f43b62022-10-17 17:35:32 +02005692component_test_tls13_only_psk () {
5693 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5694 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5695 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5696 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005697 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005698 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5699 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5700 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5701 scripts/config.py unset MBEDTLS_ECDSA_C
5702 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005703 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005704 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005705 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5706
Ronald Cronc3f43b62022-10-17 17:35:32 +02005707 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5708 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005709
Ronald Cronc3f43b62022-10-17 17:35:32 +02005710 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5711 tests/ssl-opt.sh
5712}
5713
5714component_test_tls13_only_ephemeral () {
5715 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5716 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5717 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005718 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005719 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5720
5721 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5722 cd tests; ./test_suite_ssl; cd ..
5723
5724 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5725 tests/ssl-opt.sh
5726}
5727
Przemek Stekiela01c2422023-06-13 10:46:48 +02005728component_test_tls13_only_ephemeral_ffdh () {
5729 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5730 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5731 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5732 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005733 scripts/config.py unset MBEDTLS_ECDH_C
5734
Przemek Stekiela01c2422023-06-13 10:46:48 +02005735 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5736
5737 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5738 cd tests; ./test_suite_ssl; cd ..
5739
5740 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5741 tests/ssl-opt.sh
5742}
5743
Ronald Cronc3f43b62022-10-17 17:35:32 +02005744component_test_tls13_only_psk_ephemeral () {
5745 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5746 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5747 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5748 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5749 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5750 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5751 scripts/config.py unset MBEDTLS_ECDSA_C
5752 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005753 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005754 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005755 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5756
5757 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5758 cd tests; ./test_suite_ssl; cd ..
5759
5760 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5761 tests/ssl-opt.sh
5762}
5763
Przemek Stekiela01c2422023-06-13 10:46:48 +02005764component_test_tls13_only_psk_ephemeral_ffdh () {
5765 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5766 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5767 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5768 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5769 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5770 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5771 scripts/config.py unset MBEDTLS_ECDSA_C
5772 scripts/config.py unset MBEDTLS_PKCS1_V21
5773 scripts/config.py unset MBEDTLS_PKCS7_C
5774 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005775 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005776 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5777
5778 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5779 cd tests; ./test_suite_ssl; cd ..
5780
5781 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5782 tests/ssl-opt.sh
5783}
5784
Ronald Cronc3f43b62022-10-17 17:35:32 +02005785component_test_tls13_only_psk_all () {
5786 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5787 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5788 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5789 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5790 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5791 scripts/config.py unset MBEDTLS_ECDSA_C
5792 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005793 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005794 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005795 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5796
5797 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5798 cd tests; ./test_suite_ssl; cd ..
5799
5800 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5801 tests/ssl-opt.sh
5802}
5803
5804component_test_tls13_only_ephemeral_all () {
5805 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5806 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005807 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005808 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5809
5810 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5811 cd tests; ./test_suite_ssl; cd ..
5812
5813 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5814 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005815}
5816
Ronald Cron46ac0652024-03-18 12:39:04 +01005817component_test_tls13_no_padding () {
5818 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005819 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005820 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005821 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005822 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005823 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005824 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005825 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005826 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005827}
5828
Ronald Cron6f135e12021-12-08 16:57:54 +01005829component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005830 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005831 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
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 .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005834 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005835 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005836 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005837 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005838 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005839}
5840
Ronald Crondd96c0a2024-04-02 12:34:24 +02005841component_test_full_minus_session_tickets() {
5842 msg "build: full config without session tickets"
5843 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005844 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005845 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005846 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5847 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005848 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005849 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005850 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005851 tests/ssl-opt.sh
5852}
5853
Gilles Peskine8f073122018-11-27 15:58:47 +01005854component_build_mingw () {
5855 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005856 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 +00005857
Gilles Peskine8f073122018-11-27 15:58:47 +01005858 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005859 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 +01005860 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005861
Gilles Peskine8f073122018-11-27 15:58:47 +01005862 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005863 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
5864 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 +01005865 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005866
Pengyu Lv158eead2023-10-19 11:27:05 +08005867 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005868 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005869 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 +01005870 make WINDOWS_BUILD=1 clean
5871}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005872support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005873 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5874 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005875 *) true;;
5876 esac
5877}
Simon Butcher91aef332016-11-17 09:20:50 +00005878
Gilles Peskine8f073122018-11-27 15:58:47 +01005879component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005880 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005881 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005882 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5883 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005884
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005885 msg "test: main suites (MSan)" # ~ 10s
5886 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005887
Gilles Peskine6848d172023-11-02 19:58:03 +01005888 msg "test: metatests (MSan)"
5889 tests/scripts/run-metatests.sh any msan
5890
Gilles Peskine82b27272019-06-14 18:27:03 +02005891 msg "program demos (MSan)" # ~20s
5892 tests/scripts/run_demos.py
5893
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005894 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005895 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005896
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005897 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005898
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005899 if [ "$MEMORY" -gt 0 ]; then
5900 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005901 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005902 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005903}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005904
Bence Szépkúti0354d042023-12-06 16:14:37 +01005905component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005906 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005907 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005908 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5909 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005910
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005911 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005912 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005913
Gilles Peskine636c26a2020-03-04 20:46:15 +01005914 # Optional parts (slow; currently broken on OS X because programs don't
5915 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005916 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005917 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005918 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005919 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005920 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005921
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005922 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005923 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005924 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005925 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005926
5927 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005928 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005929 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005930 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005931}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005932
Bence Szépkúti0354d042023-12-06 16:14:37 +01005933component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005934 msg "build: Release, full (clang)"
5935 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5936 scripts/config.py full
5937 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5938 make
5939
5940 msg "test: main suites, Valgrind (full config)"
5941 make memcheck
5942}
5943
Paul Elliott62dc3922021-11-25 17:29:40 +00005944support_test_cmake_out_of_source () {
5945 distrib_id=""
5946 distrib_ver=""
5947 distrib_ver_minor=""
5948 distrib_ver_major=""
5949
5950 # Attempt to parse lsb-release to find out distribution and version. If not
5951 # found this should fail safe (test is supported).
5952 if [[ -f /etc/lsb-release ]]; then
5953
5954 while read -r lsb_line; do
5955 case "$lsb_line" in
5956 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5957 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5958 esac
5959 done < /etc/lsb-release
5960
5961 distrib_ver_major="${distrib_ver%%.*}"
5962 distrib_ver="${distrib_ver#*.}"
5963 distrib_ver_minor="${distrib_ver%%.*}"
5964 fi
5965
5966 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5967 # processor (as the CI does) can create a race condition whereby the build
5968 # fails to see a generated file, despite that file actually having been
5969 # generated. This problem appears to go away with 18.04 or newer, so make
5970 # the out of source tests unsupported on Ubuntu 16.04.
5971 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5972}
5973
Gilles Peskine8f073122018-11-27 15:58:47 +01005974component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005975 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005976 # generates
5977 make neat
5978
Gilles Peskine8f073122018-11-27 15:58:47 +01005979 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005980 MBEDTLS_ROOT_DIR="$PWD"
5981 mkdir "$OUT_OF_SOURCE_DIR"
5982 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005983 # Note: Explicitly generate files as these are turned off in releases
5984 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005985 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005986
Gilles Peskine8f073122018-11-27 15:58:47 +01005987 msg "test: cmake 'out-of-source' build"
5988 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005989 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005990 # Also ensure that there are no error messages such as
5991 # "No such file or directory", which would indicate that some required
5992 # file is missing (ssl-opt.sh tolerates the absence of some files so
5993 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005994 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005995 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005996 cat ssl-opt.err >&2
5997 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005998 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005999 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006000 cd "$MBEDTLS_ROOT_DIR"
6001 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006002}
Andres AGdc192212016-08-31 17:33:13 +01006003
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006004component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006005 # Remove existing generated files so that we use the ones CMake
6006 # generates
6007 make neat
6008
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006009 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006010 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006011 # Note: Explicitly generate files as these are turned off in releases
6012 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006013 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006014 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006015}
Gilles Peskinea3000992022-02-04 00:21:12 +01006016support_test_cmake_as_subdirectory () {
6017 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006018}
6019
Chris Kayd259e342021-03-25 16:03:25 +00006020component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006021 # Remove existing generated files so that we use the ones CMake
6022 # generates
6023 make neat
6024
Chris Kayd259e342021-03-25 16:03:25 +00006025 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006026 cd programs/test/cmake_package
6027 cmake .
6028 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006029 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006030}
Gilles Peskinea3000992022-02-04 00:21:12 +01006031support_test_cmake_as_package () {
6032 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006033}
6034
6035component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006036 # Remove existing generated files so that we use the ones CMake
6037 # generates
6038 make neat
6039
Chris Kayd259e342021-03-25 16:03:25 +00006040 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006041 cd programs/test/cmake_package_install
6042 cmake .
6043 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006044 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006045}
Gilles Peskinea3000992022-02-04 00:21:12 +01006046support_test_cmake_as_package_install () {
6047 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006048}
6049
David Horstmann20550e32023-01-12 14:17:01 +00006050component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006051 # Make a copy of config file to use for the in-tree test
6052 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006053
6054 MBEDTLS_ROOT_DIR="$PWD"
6055 mkdir "$OUT_OF_SOURCE_DIR"
6056 cd "$OUT_OF_SOURCE_DIR"
6057
David Horstmann969c1452023-01-31 10:34:44 +00006058 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006059 cmake "$MBEDTLS_ROOT_DIR"
6060 make
6061
6062 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6063 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006064 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006065 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6066 make
6067
6068 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6069 # In the user config, disable one feature (for simplicity, pick a feature
6070 # that nothing else depends on).
6071 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6072
6073 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6074 make
6075 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6076
6077 rm -f user_config.h full_config.h
6078
6079 cd "$MBEDTLS_ROOT_DIR"
6080 rm -rf "$OUT_OF_SOURCE_DIR"
6081
6082 # Now repeat the test for an in-tree build:
6083
David Horstmann969c1452023-01-31 10:34:44 +00006084 # Restore config for the in-tree test
6085 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006086
David Horstmann969c1452023-01-31 10:34:44 +00006087 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006088 cmake .
6089 make
6090
6091 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6092 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006093 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006094 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6095 make
6096
6097 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6098 # In the user config, disable one feature (for simplicity, pick a feature
6099 # that nothing else depends on).
6100 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6101
6102 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6103 make
6104 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6105
6106 rm -f user_config.h full_config.h
6107}
6108support_build_cmake_custom_config_file () {
6109 support_test_cmake_out_of_source
6110}
6111
David Horstmann041ed422024-05-10 14:37:48 +01006112component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01006113 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01006114 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
6115 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
6116 make
6117}
6118support_build_cmake_programs_no_testing () {
6119 support_test_cmake_out_of_source
6120}
David Horstmann20550e32023-01-12 14:17:01 +00006121
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006122component_build_zeroize_checks () {
6123 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6124
6125 scripts/config.py full
6126
6127 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006128 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 +01006129}
6130
6131
Gilles Peskine8f073122018-11-27 15:58:47 +01006132component_test_zeroize () {
6133 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6134 # different combinations of compilers and optimization flags by using an
6135 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6136 # system in all cases that the script fails, so we must manually search the
6137 # output to check whether the pass string is present and no failure strings
6138 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006139
Gilles Peskine4976e822019-01-06 19:52:22 +00006140 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6141 # about a spurious message if Gdb tries and fails, so suppress that.
6142 gdb_disable_aslr=
6143 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6144 gdb_disable_aslr='set disable-randomization off'
6145 fi
6146
Gilles Peskine8f073122018-11-27 15:58:47 +01006147 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006148 for compiler in clang gcc; do
6149 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6150 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006151 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6152 grep "The buffer was correctly zeroized" test_zeroize.log
6153 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006154 rm -f test_zeroize.log
6155 make clean
6156 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006157 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006158}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006159
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006160component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006161 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006162 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006163 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006164
6165 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006166 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006167}
6168
6169support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006170 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006171 ver="$(cmake --version)"
6172 ver="${ver#cmake version }"
6173 ver_major="${ver%%.*}"
6174
6175 ver="${ver#*.}"
6176 ver_minor="${ver%%.*}"
6177
6178 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006179}
6180
Gilles Peskinec848d222022-12-09 12:23:35 +01006181component_check_code_style () {
6182 msg "Check C code style"
6183 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006184}
6185
Gilles Peskinec848d222022-12-09 12:23:35 +01006186support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006187 case $(uncrustify --version) in
6188 *0.75.1*) true;;
6189 *) false;;
6190 esac
6191}
6192
Gilles Peskine8f073122018-11-27 15:58:47 +01006193component_check_python_files () {
6194 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006195 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006196}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006197
Joe Subbianid614c0b2021-07-29 11:18:29 +01006198component_check_test_helpers () {
6199 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006200 # unittest writes out mundane stuff like number or tests run on stderr.
6201 # Our convention is to reserve stderr for actual errors, and write
6202 # harmless info on stdout so it can be suppress with --quiet.
David Horstmannf6f3bca2024-05-29 17:57:08 +01006203 ./framework/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006204
Joe Subbiania25ffab2021-08-06 09:41:27 +01006205 msg "unit test: translate_ciphers.py"
6206 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006207}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006208
Valerio Settid9e42512024-05-06 15:59:51 +02006209component_test_psasim() {
Valerio Settid1b6ef12024-05-07 16:00:21 +02006210 msg "build library for server"
Valerio Settid1b6ef12024-05-07 16:00:21 +02006211 scripts/config.py crypto
Valerio Settid1b6ef12024-05-07 16:00:21 +02006212 helper_crypto_client_build server
6213
Valerio Settif98635c2024-06-10 20:13:13 +02006214 msg "build server"
6215 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_partition
6216
6217 # cleanup() will restore some backed-up files which include $CONFIG_H and
6218 # $CRYPTO_CONFIG_H. Built libraries were already copied to psasim at this
6219 # point.
6220 cleanup
6221
6222 msg "build library for client"
6223 helper_crypto_client_build client
6224
6225 msg "build psasim to test psa_client"
6226 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" test/psa_client
Valerio Settid9e42512024-05-06 15:59:51 +02006227
6228 msg "test psasim"
Valerio Setti655b9792024-05-09 12:20:40 +02006229 tests/psa-client-server/psasim/test/run_test.sh
Valerio Settid9e42512024-05-06 15:59:51 +02006230
Tom Cosgrove51b2c862024-06-11 13:38:15 +01006231
Tom Cosgrove3ebb8802024-05-29 10:29:39 +01006232 msg "build psasim to test psa_hash_compute"
6233 # Delete the executable to ensure we build using the right MAIN
6234 rm tests/psa-client-server/psasim/test/psa_client
6235 # API under test: psa_hash_compute()
Valerio Settif98635c2024-06-10 20:13:13 +02006236 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="src/aut_psa_hash_compute.c" test/psa_client
Tom Cosgrove3ebb8802024-05-29 10:29:39 +01006237
6238 msg "test psasim running psa_hash_compute"
6239 tests/psa-client-server/psasim/test/run_test.sh
6240
Tom Cosgrove51b2c862024-06-11 13:38:15 +01006241
Valerio Settif98635c2024-06-10 20:13:13 +02006242 # Next APIs under test: psa_hash_*(). Use our copy of the PSA hash example.
Tom Cosgrove51b2c862024-06-11 13:38:15 +01006243 msg "build psasim to test all psa_hash_* APIs"
6244 # Delete the executable to ensure we build using the right MAIN
6245 rm tests/psa-client-server/psasim/test/psa_client
Valerio Settif98635c2024-06-10 20:13:13 +02006246 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" MAIN="src/aut_psa_hash.c" test/psa_client
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006247
Tom Cosgrove51b2c862024-06-11 13:38:15 +01006248 msg "test psasim running psa_hash sample"
6249 tests/psa-client-server/psasim/test/run_test.sh
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006250
Tom Cosgrovee2f0e302024-05-29 12:36:09 +01006251
Valerio Settid9e42512024-05-06 15:59:51 +02006252 msg "clean psasim"
6253 make -C tests/psa-client-server/psasim clean
6254}
Jerry Yud767cc42023-03-31 15:03:55 +08006255
Gilles Peskine192c72f2017-12-21 15:59:21 +01006256################################################################
6257#### Termination
6258################################################################
6259
Gilles Peskine8f073122018-11-27 15:58:47 +01006260post_report () {
6261 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006262 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006263
Gilles Peskine8f073122018-11-27 15:58:47 +01006264 final_report
6265}
6266
6267
6268
6269################################################################
6270#### Run all the things
6271################################################################
6272
Gilles Peskine5d996822020-03-28 21:09:21 +01006273# Function invoked by --error-test to test error reporting.
6274pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006275 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006276 if [ $KEEP_GOING -ne 0 ]; then
6277 echo "Expect three failing commands."
6278 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006279 # If the component doesn't run in a subshell, changing error_test_i to an
6280 # invalid integer will cause an error in the loop that runs this function.
6281 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006282 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006283 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006284 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006285 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006286 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006287 make unknown_target
6288 false "this should not be executed"
6289}
6290
Gilles Peskinee48351a2018-11-27 16:06:30 +01006291# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006292run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006293 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006294 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006295
6296 # Unconditionally create a seedfile that's sufficiently long.
6297 # Do this before each component, because a previous component may
6298 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006299 local dd_cmd
6300 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6301 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006302 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006303 esac
6304 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006305
Gilles Peskineec135542021-08-02 23:14:03 +02006306 # Run the component in a subshell, with error trapping and output
6307 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006308 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006309 # We want to keep running if the subshell fails, so 'set -e' must
6310 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006311 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006312 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006313 (
6314 if [ $QUIET -eq 1 ]; then
6315 # msg() will be silenced, so just print the component name here.
6316 echo "${current_component#component_}"
6317 exec >/dev/null
6318 fi
6319 if [ $KEEP_GOING -eq 1 ]; then
6320 # Keep "set -e" off, and run an ERR trap instead to record failures.
6321 set -E
6322 trap err_trap ERR
6323 fi
6324 # The next line is what runs the component
6325 "$@"
6326 if [ $KEEP_GOING -eq 1 ]; then
6327 trap - ERR
6328 exit $last_failure_status
6329 fi
6330 )
6331 component_status=$?
6332 if [ $KEEP_GOING -eq 1 ]; then
6333 set -e
6334 if [ $component_status -ne 0 ]; then
6335 failure_count=$((failure_count + 1))
6336 fi
6337 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006338
6339 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006340 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006341 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006342}
6343
6344# Preliminary setup
6345pre_check_environment
6346pre_initialize_variables
6347pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006348
Dave Rodgman21900632024-02-26 11:41:19 +00006349setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006350pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006351pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006352pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006353
Gilles Peskine878cf602019-01-06 20:50:38 +00006354build_status=0
6355if [ $KEEP_GOING -eq 1 ]; then
6356 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006357fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006358pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006359pre_print_configuration
6360pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006361cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006362if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006363 pre_generate_files
6364fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006365
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006366# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006367for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006368 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006369done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006370unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006371for component in $RUN_COMPONENTS; do
6372 run_component "component_$component"
6373done
Gilles Peskine8f073122018-11-27 15:58:47 +01006374
6375# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006376post_report