blob: 50b61d7194f90d891afed40c05af8bbec66fd829 [file] [log] [blame]
Gilles Peskine62cf2e82020-03-27 16:35:23 +01001#! /usr/bin/env bash
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine192c72f2017-12-21 15:59:21 +01007
8
9
10################################################################
11#### Documentation
12################################################################
13
Simon Butcher3ea7f522016-03-07 23:22:10 +000014# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010015# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000016#
SimonB2e23c822016-04-16 21:54:39 +010017# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010018#
Gilles Peskine192c72f2017-12-21 15:59:21 +010019# Notes for users
20# ---------------
21#
SimonB2e23c822016-04-16 21:54:39 +010022# Warning: the test is destructive. It includes various build modes and
23# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010024# configuration. The following files must be committed into git:
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020025# * include/mbedtls/mbedtls_config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010026# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
27# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010028# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040038# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010039# * arm-gcc and mingw-gcc
40# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine7be571a2023-08-27 21:39:21 +020041# * OpenSSL and GnuTLS command line tools, in suitable versions for the
42# interoperability tests. The following are the official versions at the
43# time of writing:
44# * GNUTLS_{CLI,SERV} = 3.4.10
45# * GNUTLS_NEXT_{CLI,SERV} = 3.7.2
46# * OPENSSL = 1.0.2g (without Debian/Ubuntu patches)
47# * OPENSSL_NEXT = 1.1.1a
Gilles Peskine192c72f2017-12-21 15:59:21 +010048# See the invocation of check_tools below for details.
49#
50# This script must be invoked from the toplevel directory of a git
51# working copy of Mbed TLS.
52#
Gilles Peskinece266c42020-03-28 18:50:43 +010053# The behavior on an error depends on whether --keep-going (alias -k)
54# is in effect.
55# * Without --keep-going: the script stops on the first error without
56# cleaning up. This lets you work in the configuration of the failing
57# component.
58# * With --keep-going: the script runs all requested components and
59# reports failures at the end. In particular the script always cleans
60# up on exit.
61#
Gilles Peskine192c72f2017-12-21 15:59:21 +010062# Note that the output is not saved. You may want to run
63# script -c tests/scripts/all.sh
64# or
65# tests/scripts/all.sh >all.log 2>&1
66#
67# Notes for maintainers
68# ---------------------
69#
Gilles Peskine8f073122018-11-27 15:58:47 +010070# The bulk of the code is organized into functions that follow one of the
71# following naming conventions:
72# * pre_XXX: things to do before running the tests, in order.
73# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010074# * component_check_XXX: quick tests that aren't worth parallelizing.
75# * component_build_XXX: build things but don't run them.
76# * component_test_XXX: build and test.
Gilles Peskine878cf602019-01-06 20:50:38 +000077# * support_XXX: if support_XXX exists and returns false then
78# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010079# * post_XXX: things to do after running the tests.
80# * other: miscellaneous support functions.
81#
Gilles Peskinec70637a2019-01-09 22:29:17 +010082# Each component must start by invoking `msg` with a short informative message.
83#
Gilles Peskinea681c592020-03-28 21:27:40 +010084# Warning: due to the way bash detects errors, the failure of a command
85# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
86#
Gilles Peskinece266c42020-03-28 18:50:43 +010087# Each component is executed in a separate shell process. The component
88# fails if any command in it returns a non-zero status.
89#
Gilles Peskinec70637a2019-01-09 22:29:17 +010090# The framework performs some cleanup tasks after each component. This
91# means that components can assume that the working directory is in a
92# cleaned-up state, and don't need to perform the cleanup themselves.
93# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010094# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010095# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010096# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
97# `tests/Makefile` and `programs/fuzz/Makefile` from git.
98# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +010099#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100100# The tests are roughly in order from fastest to slowest. This doesn't
101# have to be exact, but in general you should add slower tests towards
102# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100103
104
105
106################################################################
107#### Initialization and command line parsing
108################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100109
Gilles Peskine36647802020-03-28 18:50:49 +0100110# Abort on errors (even on the left-hand side of a pipe).
111# Treat uninitialised variables as errors.
112set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100113
Gilles Peskine076f7252022-08-30 21:02:44 +0200114# Enable ksh/bash extended file matching patterns
115shopt -s extglob
116
David Horstmann76a77382023-08-17 17:32:26 +0100117in_mbedtls_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100118 test -d include -a -d library -a -d programs -a -d tests
119}
120
Ronald Cron070e8652023-10-09 10:25:45 +0200121in_tf_psa_crypto_repo () {
David Horstmannd02b5f82023-08-29 09:53:52 +0100122 test -d include -a -d core -a -d drivers -a -d programs -a -d tests
David Horstmann9a6c45b2023-07-14 12:30:00 +0100123}
124
Gilles Peskine8f073122018-11-27 15:58:47 +0100125pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200126 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
127 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100128 exit 1
129 fi
130}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100131
Gilles Peskine8f073122018-11-27 15:58:47 +0100132pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100133 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100134 CONFIG_H='include/mbedtls/mbedtls_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100135 else
136 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100137 fi
John Durkopbd069d32020-10-31 22:14:03 -0700138 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100139 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200140
141 # Files that are clobbered by some jobs will be backed up. Use a different
142 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
143 # independently decide when to remove the backup file.
144 backup_suffix='.all.bak'
145 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100146 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100147 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100148 # Files clobbered by in-tree cmake
149 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
150 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200151
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200152 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100153 MEMORY=0
154 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200155 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100156 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100157
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200158 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200159 #
160 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
161 # both values are kept in sync. If you change the value here because it
162 # breaks some tests, you'll definitely want to change it in
163 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200164 RELEASE_SEED=1
165
Yanray Wang18040ed2023-11-23 21:29:56 +0800166 # Specify character collation for regular expressions and sorting with C locale
167 export LC_COLLATE=C
168
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200169 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200170 : ${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 +0200171 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200172 export MBEDTLS_TEST_PLATFORM
173
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000174 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100175 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100176 : ${OPENSSL_NEXT:="$OPENSSL"}
177 : ${GNUTLS_CLI:="gnutls-cli"}
178 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100179 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
180 : ${ARMC5_BIN_DIR:=/usr/bin}
181 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200182 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200183 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100184 : ${CLANG_LATEST:="clang-latest"}
185 : ${CLANG_EARLIEST:="clang-earliest"}
186 : ${GCC_LATEST:="gcc-latest"}
187 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100188 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000189 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200190 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100191 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000192
Gilles Peskine396853a2021-09-20 18:57:55 +0200193 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000194 export CTEST_OUTPUT_ON_FAILURE=1
195
Gilles Peskine8fd59422019-10-21 17:11:33 +0200196 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100197 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200198 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000199 # Normally, tests should use this compiler for ASAN testing
200 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200201
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400202 # Platform tests have an allocation that returns null
203 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400204 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400205
Gilles Peskine878cf602019-01-06 20:50:38 +0000206 # Gather the list of available components. These are the functions
207 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100208 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000209
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100210 # Delay determinig SUPPORTED_COMPONENTS until the command line options have a chance to override
211 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100212}
Andres AG38495a32016-07-12 16:54:33 +0100213
Gilles Peskinea28db922019-01-10 00:05:18 +0100214# Test whether the component $1 is included in the command line patterns.
215is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100216{
Gilles Peskine03af6782021-08-06 11:35:17 +0200217 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
218 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100219 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000220 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100221 set +f
222 case ${1#component_} in $pattern) return 0;; esac
223 done
224 set +f
225 return 1
226}
Andres AG7770ea82016-10-10 15:46:20 +0100227
Simon Butcher41eeccf2016-09-07 00:07:09 +0100228usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100229{
Gilles Peskine709346a2017-12-10 23:43:39 +0100230 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100231Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100232Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100233By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100234COMPONENT can be the name of a component or a shell wildcard pattern.
235
236Examples:
237 $0 "check_*"
238 Run all sanity checks.
239 $0 --no-armcc --except test_memsan
240 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100241
242Special options:
243 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000244 --list-all-components List all available test components and exit.
245 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100246
247General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200248 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100249 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100250 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100251 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200252 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200253 --arm-none-eabi-gcc-prefix=<string>
254 Prefix for a cross-compiler for arm-none-eabi
255 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200256 --arm-linux-gnueabi-gcc-prefix=<string>
257 Prefix for a cross-compiler for arm-linux-gnueabi
258 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100259 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200260 --restore First clean up the build tree, restoring backed up
261 files. Do not run any components unless they are
262 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100263 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200264 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100265 --except Exclude the COMPONENTs listed on the command line,
266 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200267 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100268 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100269 --no-force Refuse to overwrite modified files (default).
270 --no-keep-going Stop at the first error (default).
271 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800272 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100273 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200274 --outcome-file=<path> File where test outcomes are written (not done if
275 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100276 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200277 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100278 -s|--seed Integer seed value to use for this test run.
279
280Tool path options:
281 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
282 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100283 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
284 --clang-latest=<Clang_latest_path> Latest version of clang available
285 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
286 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100287 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
288 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100289 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100290 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100291EOF
SimonB2e23c822016-04-16 21:54:39 +0100292}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100293
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200294# Cleanup before/after running a component.
295# Remove built files as well as the cmake cache/config.
296# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100297cleanup()
298{
David Horstmann76a77382023-08-17 17:32:26 +0100299 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100300 command make clean
301 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200302
Gilles Peskine31b07e22018-03-21 12:15:06 +0100303 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000304 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100305 -iname CMakeFiles -exec rm -rf {} \+ -o \
306 \( -iname cmake_install.cmake -o \
307 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200308 -iname CMakeCache.txt -o \
309 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100310 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200311 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200312
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100313 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
314 rm -rf programs/test/cmake_subproject/build
315 rm -f programs/test/cmake_subproject/Makefile
316 rm -f programs/test/cmake_subproject/cmake_subproject
317
Chris Kayd259e342021-03-25 16:03:25 +0000318 # Remove any artifacts from the component_test_cmake_as_package test.
319 rm -rf programs/test/cmake_package/build
320 rm -f programs/test/cmake_package/Makefile
321 rm -f programs/test/cmake_package/cmake_package
322
323 # Remove any artifacts from the component_test_cmake_as_installed_package test.
324 rm -rf programs/test/cmake_package_install/build
325 rm -f programs/test/cmake_package_install/Makefile
326 rm -f programs/test/cmake_package_install/cmake_package_install
327
Gilles Peskinef83eb822020-03-30 20:11:39 +0200328 # Restore files that may have been clobbered by the job
329 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200330 if [[ -e "$x$backup_suffix" ]]; then
331 cp -p "$x$backup_suffix" "$x"
332 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200333 done
334}
John Durkopbd069d32020-10-31 22:14:03 -0700335
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200336# Final cleanup when this script exits (except when exiting on a failure
337# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200338final_cleanup () {
339 cleanup
340
341 for x in $files_to_back_up; do
342 rm -f "$x$backup_suffix"
343 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100344}
345
Gilles Peskine7c652162017-12-11 00:01:40 +0100346# Executed on exit. May be redefined depending on command line options.
347final_report () {
348 :
349}
350
351fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200352 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100353 final_report $1
354 trap - $1
355 kill -$1 $$
356}
357
358trap 'fatal_signal HUP' HUP
359trap 'fatal_signal INT' INT
360trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200361
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200362# Number of processors on this machine. Used as the default setting
363# for parallel make.
364all_sh_nproc ()
365{
366 {
367 nproc || # Linux
368 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
369 sysctl -n hw.ncpu || # FreeBSD
370 echo 1
371 } 2>/dev/null
372}
373
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100374msg()
375{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100376 if [ -n "${current_component:-}" ]; then
377 current_section="${current_component#component_}: $1"
378 else
379 current_section="$1"
380 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200381
382 if [ $QUIET -eq 1 ]; then
383 return
384 fi
385
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100386 echo ""
387 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100388 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000389 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100390 echo "******************************************************************"
391}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100392
Gilles Peskine8f073122018-11-27 15:58:47 +0100393armc6_build_test()
394{
395 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100396
Gilles Peskine18487f62020-04-30 23:11:54 +0200397 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800398 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100399 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000400 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200401
402 msg "size: ARM Compiler 6 ($FLAGS)"
403 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100404}
Andres AGa5cd9732016-10-17 15:23:10 +0100405
Andres AGd9eba4b2016-08-26 14:42:14 +0100406err_msg()
407{
408 echo "$1" >&2
409}
410
411check_tools()
412{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200413 for tool in "$@"; do
414 if ! `type "$tool" >/dev/null 2>&1`; then
415 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100416 exit 1
417 fi
418 done
419}
420
Gilles Peskine8f073122018-11-27 15:58:47 +0100421pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000422 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100423 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100424 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100425 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200426 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000427 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100428
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000429 # Note that legacy options are ignored instead of being omitted from this
430 # list of options, so invocations that worked with previous version of
431 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100432 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100433 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200434 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200435 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200436 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000437 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100438 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
439 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100440 --clang-earliest) shift; CLANG_EARLIEST="$1";;
441 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100442 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000443 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100444 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100445 --gcc-earliest) shift; GCC_EARLIEST="$1";;
446 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100447 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200448 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
449 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100450 --gnutls-serv) shift; GNUTLS_SERV="$1";;
451 --help|-h) usage; exit;;
452 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000453 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100454 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100455 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200456 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000457 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100458 --no-force) FORCE=0;;
459 --no-keep-going) KEEP_GOING=0;;
460 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200461 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100462 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100463 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200464 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100465 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200466 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100467 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200468 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200469 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100470 --seed|-s) shift; SEED="$1";;
471 -*)
472 echo >&2 "Unknown option: $1"
473 echo >&2 "Run $0 --help for usage."
474 exit 120
475 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000476 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100477 esac
478 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100479 done
SimonB2e23c822016-04-16 21:54:39 +0100480
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100481 # Exclude components that are not supported on this platform.
482 SUPPORTED_COMPONENTS=
483 for component in $ALL_COMPONENTS; do
484 case $(type "support_$component" 2>&1) in
485 *' function'*)
486 if ! support_$component; then continue; fi;;
487 esac
488 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
489 done
490
491 if [ $list_components -eq 1 ]; then
492 printf '%s\n' $SUPPORTED_COMPONENTS
493 exit
494 fi
495
Gilles Peskinea28db922019-01-10 00:05:18 +0100496 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200497 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000498 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100499 fi
500
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000501 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
502 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100503 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000504 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100505 fi
SimonB2e23c822016-04-16 21:54:39 +0100506
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200507 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100508 if [ $all_except -eq 0 ]; then
509 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200510 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
511 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200512 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100513 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200514 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200515 # If the requested name includes a wildcard character, don't
516 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100517 case $component in
518 *[*?\[]*) continue;;
519 esac
520 case " $SUPPORTED_COMPONENTS " in
521 *" $component "*) :;;
522 *)
523 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
524 unsupported=$((unsupported + 1));;
525 esac
526 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200527 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100528 if [ $unsupported -ne 0 ]; then
529 exit 2
530 fi
531 fi
532
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000533 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100534 RUN_COMPONENTS=
535 for component in $SUPPORTED_COMPONENTS; do
536 if is_component_included "$component"; [ $? -eq $all_except ]; then
537 RUN_COMPONENTS="$RUN_COMPONENTS $component"
538 fi
539 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000540
541 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000542 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100543}
SimonB2e23c822016-04-16 21:54:39 +0100544
Gilles Peskine8f073122018-11-27 15:58:47 +0100545pre_check_git () {
546 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100547 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100548 git checkout-index -f -q $CONFIG_H
549 cleanup
550 else
SimonB2e23c822016-04-16 21:54:39 +0100551
Gilles Peskine8f073122018-11-27 15:58:47 +0100552 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
553 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
554 echo "You can either delete this directory manually, or force the test by rerunning"
555 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
556 exit 1
557 fi
558
Ronald Cron7a93ac52023-07-20 09:49:12 +0200559 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100560 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100561 echo "You can either delete or preserve your work, or force the test by rerunning the"
562 echo "script as: $0 --force"
563 exit 1
564 fi
SimonB2e23c822016-04-16 21:54:39 +0100565 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500566}
567
Gilles Peskine568f53a2021-07-12 18:16:01 +0200568pre_restore_files () {
569 # If the makefiles have been generated by a framework such as cmake,
570 # restore them from git. If the makefiles look like modifications from
571 # the ones checked into git, take care not to modify them. Whatever
572 # this function leaves behind is what the script will restore before
573 # each component.
574 case "$(head -n1 Makefile)" in
575 *[Gg]enerated*)
576 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
577 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
578 ;;
579 esac
580}
581
Gilles Peskinef83eb822020-03-30 20:11:39 +0200582pre_back_up () {
583 for x in $files_to_back_up; do
584 cp -p "$x" "$x$backup_suffix"
585 done
586}
587
Gilles Peskine8f073122018-11-27 15:58:47 +0100588pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100589 failure_count=0 # Number of failed components
590 last_failure_status=0 # Last failure status in this component
591
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100592 # See err_trap
593 previous_failure_status=0
594 previous_failed_command=
595 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100596 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100597
Gilles Peskine7c652162017-12-11 00:01:40 +0100598 start_red=
599 end_color=
600 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100601 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100602 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
603 start_red=$(printf '\033[31m')
604 end_color=$(printf '\033[0m')
605 ;;
606 esac
607 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100608
609 # Keep a summary of failures in a file. We'll print it out at the end.
610 failure_summary_file=$PWD/all-sh-failures-$$.log
611 : >"$failure_summary_file"
612
613 # Whether it makes sense to keep a component going after the specified
614 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200615 # This function normally receives the failing simple command
616 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
617 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100618 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200619 # False positives result in running things that can't be expected to
620 # work. False negatives result in things not running after something else
621 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100622 can_keep_going_after_failure () {
623 case "$1" in
624 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200625 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100626 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200627 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
628 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
629 *make*check*) true;;
630 "grep "*) true;;
631 "[ "*) true;;
632 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100633 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100634 esac
635 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100636
637 # This function runs if there is any error in a component.
638 # It must either exit with a nonzero status, or set
639 # last_failure_status to a nonzero value.
640 err_trap () {
641 # Save $? (status of the failing command). This must be the very
642 # first thing, before $? is overridden.
643 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100644 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100645
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100646 if [[ $last_failure_status -eq $previous_failure_status &&
647 "$failed_command" == "$previous_failed_command" &&
648 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
649 then
650 # The same command failed twice in a row, but this time one level
651 # less deep in the function call stack. This happens when the last
652 # command of a function returns a nonzero status, and the function
653 # returns that same status. Ignore the second failure.
654 previous_failure_funcall_depth=${#FUNCNAME[@]}
655 return
656 fi
657 previous_failure_status=$last_failure_status
658 previous_failed_command=$failed_command
659 previous_failure_funcall_depth=${#FUNCNAME[@]}
660
Gilles Peskinece266c42020-03-28 18:50:43 +0100661 text="$current_section: $failed_command -> $last_failure_status"
662 echo "${start_red}^^^^$text^^^^${end_color}" >&2
663 echo "$text" >>"$failure_summary_file"
664
665 # If the command is fatal (configure or build command), stop this
666 # component. Otherwise (test command) keep the component running
667 # (run more tests from the same build).
668 if ! can_keep_going_after_failure "$failed_command"; then
669 exit $last_failure_status
670 fi
671 }
672
Gilles Peskine7c652162017-12-11 00:01:40 +0100673 final_report () {
674 if [ $failure_count -gt 0 ]; then
675 echo
676 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100677 echo "${start_red}FAILED: $failure_count components${end_color}"
678 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100679 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
680 elif [ -z "${1-}" ]; then
681 echo "SUCCESS :)"
682 fi
683 if [ -n "${1-}" ]; then
684 echo "Killed by SIG$1."
685 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100686 rm -f "$failure_summary_file"
687 if [ $failure_count -gt 0 ]; then
688 exit 1
689 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100690 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100691}
692
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200693# record_status() and if_build_succeeded() are kept temporarily for backward
694# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100695record_status () {
696 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100697}
Gilles Peskine7c652162017-12-11 00:01:40 +0100698if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100699 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100700}
701
Gilles Peskinea681c592020-03-28 21:27:40 +0100702# '! true' does not trigger the ERR trap. Arrange to trigger it, with
703# a reasonably informative error message (not just "$@").
704not () {
705 if "$@"; then
706 report_failed_command="! $*"
707 false
708 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200709 fi
710}
711
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200712pre_prepare_outcome_file () {
713 case "$MBEDTLS_TEST_OUTCOME_FILE" in
714 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
715 esac
716 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
717 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
718 fi
719}
720
Gilles Peskine8f073122018-11-27 15:58:47 +0100721pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200722 if [ $QUIET -eq 1 ]; then
723 return
724 fi
725
Gilles Peskine8f073122018-11-27 15:58:47 +0100726 msg "info: $0 configuration"
727 echo "MEMORY: $MEMORY"
728 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200729 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100730 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100731 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100732 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100733 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
734 echo "GNUTLS_CLI: $GNUTLS_CLI"
735 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100736 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
737 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
738}
Andres AG7770ea82016-10-10 15:46:20 +0100739
Andres AGd9eba4b2016-08-26 14:42:14 +0100740# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100741pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000742 # Build the list of variables to pass to output_env.sh.
743 set env
SimonB2e23c822016-04-16 21:54:39 +0100744
Gilles Peskine87964262019-01-06 22:40:00 +0000745 case " $RUN_COMPONENTS " in
746 # Require OpenSSL and GnuTLS if running any tests (as opposed to
747 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
748 # is a good enough approximation in practice.
749 *" test_"*)
750 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
751 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100752 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000753 export GNUTLS_CLI="$GNUTLS_CLI"
754 export GNUTLS_SERV="$GNUTLS_SERV"
755 # Avoid passing --seed flag in every call to ssl-opt.sh
756 if [ -n "${SEED-}" ]; then
757 export SEED
758 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200759 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000760 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200761 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
762 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000763 ;;
764 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200765
Gilles Peskine87964262019-01-06 22:40:00 +0000766 case " $RUN_COMPONENTS " in
767 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
768 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100769
Gilles Peskine87964262019-01-06 22:40:00 +0000770 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200771 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000772 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100773
Gilles Peskine87964262019-01-06 22:40:00 +0000774 case " $RUN_COMPONENTS " in
775 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
776 esac
777
778 case " $RUN_COMPONENTS " in
779 *" test_zeroize "*) check_tools "gdb";;
780 esac
781
782 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000783 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000784 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
785 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200786 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000787 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
788 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200789 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
790 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
791 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000792 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000793
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200794 # past this point, no call to check_tool, only printing output
795 if [ $QUIET -eq 1 ]; then
796 return
797 fi
798
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000799 msg "info: output_env.sh"
800 case $RUN_COMPONENTS in
801 *_armcc*)
802 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
803 *) set "$@" RUN_ARMCC=0;;
804 esac
805 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100806}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100807
Gilles Peskine1570b592021-04-22 01:10:12 +0200808pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200809 # since make doesn't have proper dependencies, remove any possibly outdate
810 # file that might be around before generating fresh ones
811 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200812 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200813 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200814 else
815 make generated_files
816 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200817}
818
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200819################################################################
820#### Helpers for components using libtestdriver1
821################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100822
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200823# How to use libtestdriver1
824# -------------------------
825#
826# 1. Define the list algorithms and key types to accelerate,
827# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
828# Examples:
829# - loc_accel_list="ALG_JPAKE"
830# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200831# 2. Make configurations changes for the driver and/or main libraries.
832# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
833# can be either "default" to start with the default config, or a name
834# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200835# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200836# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
837# These changes affect both the driver and the main libraries.
838# (Note: they need to have the same set of PSA_WANT symbols, as that
839# determines the ABI between them.)
840# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
841# main libraries. Typically, you want to disable the module(s) that are
842# being accelerated. You may need to also disable modules that depend
843# on them or options that are not supported with drivers.
844# 2d. On top of psa/crypto_config.h, the driver library uses its own config
845# file: tests/include/test/drivers/config_test_driver.h. You usually
846# don't need to edit it: using loc_extra_list (see below) is preferred.
847# However, when there's no PSA symbol for what you want to enable,
848# calling scripts/config.py on this file remains the only option.
849# 3. Build the driver library, then the main libraries, test, and programs.
850# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
851# need to enable more algorithms here, typically hash algorithms when
852# accelerating some signature algorithms (ECDSA, RSAv2). This is done
853# by passing a 2nd argument listing the extra algorithms.
854# Example:
855# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
856# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800857# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200858# additional arguments will be passed to make: this can be useful if
859# you don't want to build everything when iterating during development.
860# Example:
861# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
862# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200863
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200864# Adjust the configuration - for both libtestdriver1 and main library,
865# as they should have the same PSA_WANT macros.
866helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200867 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200868 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200869 if [ "$base_config" != "default" ]; then
870 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200871 fi
872
873 # Enable PSA-based config (necessary to use drivers)
874 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
875
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200876 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
877 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
878 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200879}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100880
Valerio Settib2fd6732023-08-15 17:10:47 +0200881# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200882# The function optionally accepts 1 parameter: a space-separated list of the
883# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200884helper_disable_builtin_curves() {
885 allowed_list="${1:-}"
886 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
887
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200888 for curve in $allowed_list; do
889 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +0200890 done
891}
892
893# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
894# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
895# in the following helpers.
896helper_get_psa_curve_list () {
897 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200898 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
899 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200900 done
901
902 echo "$loc_list"
903}
904
905# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +0200906# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +0200907# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +0200908helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200909 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +0200910 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200911 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 +0200912 # Skip DERIVE for elliptic keys since there is no driver dispatch for
913 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200914 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
915 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +0200916 fi
917 done
918
919 echo "$loc_list"
920}
921
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200922# Build the drivers library libtestdriver1.a (with ASan).
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200923#
924# Parameters:
925# 1. a space-separated list of things to accelerate;
926# 2. optional: a space-separate list of things to also support.
927# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
928helper_libtestdriver1_make_drivers() {
929 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
Gilles Peskine21570cf2023-12-22 11:49:50 +0100930 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +0200931}
932
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200933# Build the main libraries, programs and tests,
934# linking to the drivers library (with ASan).
935#
936# Parameters:
937# 1. a space-separated list of things to accelerate;
938# *. remaining arguments if any are passed directly to make
939# (examples: lib, -C tests test_suite_xxx, etc.)
940# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
941helper_libtestdriver1_make_main() {
942 loc_accel_list=$1
943 shift
944
945 # we need flags both with and without the LIBTESTDRIVER1_ prefix
946 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
947 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
Gilles Peskine21570cf2023-12-22 11:49:50 +0100948 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include -I../tests -I../../tests -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_TEST_LIBTESTDRIVER1 $loc_accel_flags" LDFLAGS="-ltestdriver1 $ASAN_CFLAGS" "$@"
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +0200949}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100950
951################################################################
952#### Basic checks
953################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100954
955#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200956# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100957#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +0100958# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200959# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100960# 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 +0200961# time, so start with a GCC build).
962# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100963#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +0100964# Indicative running times are given for reference.
965
Gilles Peskine8f073122018-11-27 15:58:47 +0100966component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200967 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200968 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +0100969}
Janos Follathb72c6782016-07-19 14:54:17 +0100970
Gilles Peskine67debb62021-05-18 16:09:50 +0200971component_check_generated_files () {
972 msg "Check: check-generated-files, files generated with make" # 2s
973 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200974 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +0200975
976 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200977 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +0200978 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200979 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +0200980
981 msg "Check: check-generated-files -u, files absent" # 2s
982 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200983 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +0200984 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200985 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +0200986
987 # This component ends with the generated files present in the source tree.
988 # This is necessary for subsequent components!
989}
990
Gilles Peskine8f073122018-11-27 15:58:47 +0100991component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200992 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200993 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +0100994}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200995
Gilles Peskine8f073122018-11-27 15:58:47 +0100996component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200997 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200998 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +0100999}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001000
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001001component_check_changelog () {
1002 msg "Check: changelog entries" # < 1s
1003 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001004 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001005 if [ -e ChangeLog.new ]; then
1006 # Show the diff for information. It isn't an error if the diff is
1007 # non-empty.
1008 diff -u ChangeLog ChangeLog.new || true
1009 rm ChangeLog.new
1010 fi
1011}
1012
Gilles Peskine8f073122018-11-27 15:58:47 +01001013component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001014 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001015 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001016}
Darryl Greena07039c2018-03-13 16:48:16 +00001017
Gilles Peskine895868b2019-09-19 21:30:05 +02001018component_check_test_cases () {
1019 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001020 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001021 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001022 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001023 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001024 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001025 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001026 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001027}
1028
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001029component_check_test_dependencies () {
1030 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001031 # The purpose of this component is to catch unjustified dependencies on
1032 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1033 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1034 # MBEDTLS_PSA_xxx).
1035 #
1036 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1037 # this component is meant to catch. However a few of them are justified,
1038 # mostly by the absence of a PSA equivalent, so this component includes a
1039 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001040
1041 found="check-test-deps-found-$$"
1042 expected="check-test-deps-expected-$$"
1043
1044 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001045 grep 'depends_on' \
1046 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001047 grep -Eo '!?MBEDTLS_[^: ]*' |
1048 grep -v MBEDTLS_PSA_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001049 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001050
Yanray Wang18040ed2023-11-23 21:29:56 +08001051 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001052 rm -f $expected
1053 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1054 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001055 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1056 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001057 # This is used by import_rsa_made_up() in test_suite_psa_crypto in order
1058 # to build a fake RSA key of the wanted size based on
1059 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1060 # the test code and that's probably the most convenient way of achieving
1061 # the test's goal.
1062 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1063 # No PSA equivalent - we should probably have one in the future.
1064 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1065 # No PSA equivalent - needed by some init tests
1066 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
1067 # Used by two tests that are about an extension to the PSA standard;
1068 # as such, no PSA equivalent.
1069 echo "MBEDTLS_PEM_PARSE_C" >> $expected
1070
1071 # Compare reality with expectation.
1072 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001073 #
1074 # The output should be empty. When it's not:
1075 # - Each '+' line is a macro that was found but not expected. You want to
1076 # find where that macro occurs, and either replace it with PSA macros, or
1077 # add it to the exceptions list above with a justification.
1078 # - Each '-' line is a macro that was expected but not found; it means the
1079 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001080 diff -U0 $expected $found
1081
1082 rm $found $expected
1083}
1084
Gilles Peskine8f073122018-11-27 15:58:47 +01001085component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001086 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001087 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001088}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001089
Gilles Peskine192c72f2017-12-21 15:59:21 +01001090
Gilles Peskine636c26a2020-03-04 20:46:15 +01001091
Gilles Peskine192c72f2017-12-21 15:59:21 +01001092################################################################
1093#### Build and test many configurations and targets
1094################################################################
1095
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001096component_test_default_out_of_box () {
1097 msg "build: make, default config (out-of-box)" # ~1min
1098 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001099 # Disable fancy stuff
1100 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001101
1102 msg "test: main suites make, default config (out-of-box)" # ~10s
1103 make test
1104
1105 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001106 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001107
1108 msg "program demos: make, default config (out-of-box)" # ~10s
1109 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001110}
1111
Gilles Peskine8f073122018-11-27 15:58:47 +01001112component_test_default_cmake_gcc_asan () {
1113 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001114 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1115 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001116
Gilles Peskine8f073122018-11-27 15:58:47 +01001117 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1118 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001119
Gilles Peskine82b27272019-06-14 18:27:03 +02001120 msg "program demos (ASan build)" # ~10s
1121 tests/scripts/run_demos.py
1122
Gilles Peskine97bea012020-04-23 23:37:45 +02001123 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001124 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001125
Gilles Peskine6848d172023-11-02 19:58:03 +01001126 msg "test: metatests (GCC, ASan build)"
1127 tests/scripts/run-metatests.sh any asan
1128
Gilles Peskine8f073122018-11-27 15:58:47 +01001129 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001130 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001131
Gilles Peskine8f073122018-11-27 15:58:47 +01001132 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001133 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001134
1135 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001136 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001137}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001138
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001139component_test_default_cmake_gcc_asan_new_bignum () {
1140 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001141 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001142 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001143 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001144
1145 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1146 make test
1147
1148 msg "test: selftest (ASan build)" # ~ 10s
1149 programs/test/selftest
1150
1151 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1152 tests/ssl-opt.sh
1153
1154 msg "test: compat.sh (ASan build)" # ~ 6 min
1155 tests/compat.sh
1156
1157 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1158 tests/context-info.sh
1159}
1160
Hanno Becker01635512019-02-26 14:27:09 +00001161component_test_full_cmake_gcc_asan () {
1162 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001163 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001164 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1165 make
1166
1167 msg "test: main suites (inc. selftests) (full config, ASan build)"
1168 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001169
Gilles Peskine97bea012020-04-23 23:37:45 +02001170 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001171 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001172
Gilles Peskine636c26a2020-03-04 20:46:15 +01001173 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001174 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001175
1176 msg "test: compat.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001177 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001178
1179 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001180 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001181}
1182
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001183
1184component_test_full_cmake_gcc_asan_new_bignum () {
1185 msg "build: full config, cmake, gcc, ASan"
1186 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001187 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001188 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001189 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001190
1191 msg "test: main suites (inc. selftests) (full config, ASan build)"
1192 make test
1193
1194 msg "test: selftest (ASan build)" # ~ 10s
1195 programs/test/selftest
1196
1197 msg "test: ssl-opt.sh (full config, ASan build)"
1198 tests/ssl-opt.sh
1199
1200 msg "test: compat.sh (full config, ASan build)"
1201 tests/compat.sh
1202
1203 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
1204 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001205}
1206
Ronald Cronc3623db2020-10-29 10:51:32 +01001207component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001208 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001209 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001210 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1211 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1212 make
1213
1214 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1215 make test
1216}
1217
Gilles Peskinea3548672021-06-17 11:37:52 +02001218# check_renamed_symbols HEADER LIB
1219# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1220# name is LIB.
1221check_renamed_symbols () {
1222 ! nm "$2" | sed 's/.* //' |
1223 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1224}
1225
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001226component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001227 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001228 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001229 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1230 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1231 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1232 # We can only compile, not link, since our test and sample programs
1233 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1234 # is active.
1235 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001236
1237 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1238 # version is not present.
1239 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001240 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001241}
1242
Ronald Cron336678b2021-01-28 17:54:24 +01001243component_test_psa_crypto_client () {
1244 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1245 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1246 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1247 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001248 scripts/config.py unset MBEDTLS_LMS_C
1249 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Ronald Cron336678b2021-01-28 17:54:24 +01001250 make
1251
1252 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT, make"
1253 make test
1254}
1255
Jaeden Amero424fa932021-05-14 08:34:32 +01001256component_test_psa_crypto_rsa_no_genprime() {
1257 msg "build: default config minus MBEDTLS_GENPRIME"
1258 scripts/config.py unset MBEDTLS_GENPRIME
1259 make
1260
1261 msg "test: default config minus MBEDTLS_GENPRIME"
1262 make test
1263}
1264
Gilles Peskine782f4112018-11-27 16:11:09 +01001265component_test_ref_configs () {
1266 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001267 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1268 # want to re-generate generated files that depend on it, quite correctly.
1269 # However this doesn't work as the generation script expects a specific
1270 # format for mbedtls_config.h, which the other files don't follow. Also,
1271 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001272 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001273 # whether they're on or off. So, disable cmake's (over-sensitive here)
1274 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001275 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001276 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001277 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001278}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001279
Gilles Peskine8f073122018-11-27 15:58:47 +01001280component_test_no_renegotiation () {
1281 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001282 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001283 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001284 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001285
Gilles Peskine8f073122018-11-27 15:58:47 +01001286 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1287 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001288
Gilles Peskine8f073122018-11-27 15:58:47 +01001289 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001290 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001291}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001292
Gilles Peskine636c26a2020-03-04 20:46:15 +01001293component_test_no_pem_no_fs () {
1294 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1295 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1296 scripts/config.py unset MBEDTLS_FS_IO
1297 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1298 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001299 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001300 make
1301
1302 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1303 make test
1304
1305 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001306 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001307}
1308
Gilles Peskine8f073122018-11-27 15:58:47 +01001309component_test_rsa_no_crt () {
1310 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001311 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001312 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001313 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001314
Gilles Peskine8f073122018-11-27 15:58:47 +01001315 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1316 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001317
Gilles Peskine8f073122018-11-27 15:58:47 +01001318 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001319 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001320
Gilles Peskine8f073122018-11-27 15:58:47 +01001321 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001322 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001323
1324 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001325 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001326}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001327
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001328component_test_no_ctr_drbg_classic () {
1329 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001330 scripts/config.py full
1331 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001332 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001333 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001334
Dave Rodgman17127e92023-12-14 16:42:48 +00001335 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001336 make
1337
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001338 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001339 make test
1340
Gilles Peskineba749042021-01-13 20:02:03 +01001341 # In this configuration, the TLS test programs use HMAC_DRBG.
1342 # The SSL tests are slow, so run a small subset, just enough to get
1343 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001344 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001345 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001346
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001347 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001348 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001349}
1350
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001351component_test_no_ctr_drbg_use_psa () {
1352 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001353 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001354 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1355 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001356
Dave Rodgman17127e92023-12-14 16:42:48 +00001357 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001358 make
1359
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001360 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1361 make test
1362
1363 # In this configuration, the TLS test programs use HMAC_DRBG.
1364 # The SSL tests are slow, so run a small subset, just enough to get
1365 # confidence that the SSL code copes with HMAC_DRBG.
1366 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001367 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001368
1369 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001370 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001371}
1372
1373component_test_no_hmac_drbg_classic () {
1374 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1375 scripts/config.py full
1376 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1377 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1378 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001379 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001380
Dave Rodgman17127e92023-12-14 16:42:48 +00001381 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001382 make
1383
1384 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001385 make test
1386
Gilles Peskinea2224342020-11-19 22:14:34 +01001387 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1388 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1389 # instead.
1390 # Test SSL with non-deterministic ECDSA. Only test features that
1391 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001392 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001393 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001394
1395 # To save time, only test one protocol version, since this part of
1396 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001397 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001398 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001399}
1400
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001401component_test_no_hmac_drbg_use_psa () {
1402 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1403 scripts/config.py full
1404 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1405 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1406 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1407
Dave Rodgman17127e92023-12-14 16:42:48 +00001408 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001409 make
1410
1411 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1412 make test
1413
1414 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1415 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1416 # instead.
1417 # Test SSL with non-deterministic ECDSA. Only test features that
1418 # might be affected by how ECDSA signature is performed.
1419 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001420 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001421
1422 # To save time, only test one protocol version, since this part of
1423 # the protocol is identical in (D)TLS up to 1.2.
1424 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001425 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001426}
1427
1428component_test_psa_external_rng_no_drbg_classic () {
1429 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1430 scripts/config.py full
1431 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001432 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001433 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001434 scripts/config.py unset MBEDTLS_ENTROPY_C
1435 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1436 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001437 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1438 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1439 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001440 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1441 # the SSL test programs don't have an RNG and can't work. Explicitly
1442 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001443 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001444
1445 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1446 make test
1447
Gilles Peskine8eb29432021-02-03 20:07:11 +01001448 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001449 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001450}
1451
1452component_test_psa_external_rng_no_drbg_use_psa () {
1453 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001454 scripts/config.py full
1455 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001456 scripts/config.py unset MBEDTLS_ENTROPY_C
1457 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1458 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001459 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1460 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1461 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001462 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001463
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001464 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001465 make test
1466
Gilles Peskine8eb29432021-02-03 20:07:11 +01001467 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001468 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001469}
1470
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001471component_test_psa_external_rng_use_psa_crypto () {
1472 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1473 scripts/config.py full
1474 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1475 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1476 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001477 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001478
1479 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1480 make test
1481
1482 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1483 tests/ssl-opt.sh -f 'Default\|opaque'
1484}
1485
Gilles Peskine801c4332023-04-28 21:04:28 +02001486component_test_psa_inject_entropy () {
1487 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1488 scripts/config.py full
1489 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1490 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1491 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1492 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1493 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1494 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001495 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 +02001496
1497 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1498 make test
1499}
1500
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001501component_test_sw_inet_pton () {
1502 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1503
1504 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1505 scripts/config.py set MBEDTLS_TEST_HOOKS
1506 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1507
1508 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1509 make test
1510}
1511
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001512component_test_crypto_full_md_light_only () {
1513 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001514 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001515 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001516 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001517 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001518 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001519 scripts/config.py unset MBEDTLS_HKDF_C
1520 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001521 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001522 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001523 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001524 # Disable things that would auto-enable MD_C
1525 scripts/config.py unset MBEDTLS_PKCS5_C
1526
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001527 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1528 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001529 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001530
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001531 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001532 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001533 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001534
1535 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001536 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001537}
1538
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001539component_test_full_no_cipher () {
Valerio Settidf17a102023-10-23 14:14:19 +02001540 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001541 scripts/config.py full
1542 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001543 # Don't pull in cipher via PSA mechanisms
1544 # (currently ignored anyway because we completely disable PSA)
1545 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001546 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001547 scripts/config.py unset MBEDTLS_CMAC_C
1548 scripts/config.py unset MBEDTLS_NIST_KW_C
1549 scripts/config.py unset MBEDTLS_PKCS12_C
1550 scripts/config.py unset MBEDTLS_PKCS5_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001551 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1552 scripts/config.py unset MBEDTLS_SSL_TLS_C
1553 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001554 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001555 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1556 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001557 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001558 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001559 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001560
Valerio Settidf17a102023-10-23 14:14:19 +02001561 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001562 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001563}
1564
Valerio Setti7e710e82023-08-25 09:14:15 +02001565# This is a common configurator and test function that is used in:
1566# - component_test_full_no_cipher_with_crypto
1567# - component_test_full_no_cipher_with_crypto_config
1568# It accepts 2 input parameters:
1569# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1570# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001571common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001572 USE_CRYPTO_CONFIG="$1"
1573 COMPONENT_DESCRIPTION="$2"
1574
1575 msg "build: $COMPONENT_DESCRIPTION"
1576
1577 scripts/config.py full
1578 scripts/config.py unset MBEDTLS_CIPHER_C
1579
1580 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001581 # The built-in implementation of the following algs/key-types depends
1582 # on CIPHER_C so we disable them.
1583 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1584 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001585 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001586 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1587 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1588 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1589 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1590 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1591 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1592 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
1593 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001594 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001595 else
1596 # Don't pull in cipher via PSA mechanisms
1597 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001598 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1599 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1600 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti287f6d12023-10-24 14:12:59 +02001601 scripts/config.py unset MBEDTLS_DES_C
Valerio Setti287f6d12023-10-24 14:12:59 +02001602 # Dependencies on AES_C
1603 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001604 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001605 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001606 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001607 scripts/config.py unset MBEDTLS_NIST_KW_C
1608 scripts/config.py unset MBEDTLS_PKCS12_C
1609 scripts/config.py unset MBEDTLS_PKCS5_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001610
Gilles Peskine21570cf2023-12-22 11:49:50 +01001611 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001612
Valerio Setti7e710e82023-08-25 09:14:15 +02001613 # Ensure that CIPHER_C was not re-enabled
1614 not grep mbedtls_cipher_init library/cipher.o
1615
1616 msg "test: $COMPONENT_DESCRIPTION"
1617 make test
1618}
1619
1620component_test_full_no_cipher_with_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001621 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001622}
1623
1624component_test_full_no_cipher_with_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001625 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001626}
1627
Valerio Settibdfecb62023-11-07 15:37:20 +01001628component_test_full_no_ccm() {
1629 msg "build: full no PSA_WANT_ALG_CCM"
1630
1631 # Full config enables:
1632 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1633 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1634 scripts/config.py full
1635
1636 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1637 # enabled, but not used from TLS since USE_PSA is set.
1638 # This is helpful to ensure that TLS tests below have proper dependencies.
1639 #
1640 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1641 # PSA_WANT_ALG_CCM to be re-enabled.
1642 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1643
Gilles Peskine21570cf2023-12-22 11:49:50 +01001644 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001645
1646 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001647 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001648}
1649
1650component_test_full_no_ccm_star_no_tag() {
1651 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1652
1653 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1654 scripts/config.py full
1655
1656 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1657 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1658 # This basically disables all unauthenticated ciphers on the PSA side, while
1659 # keeping AEADs enabled.
1660 #
1661 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1662 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1663 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1664 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1665 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1666 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1667 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1668 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1669 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1670 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1671
Gilles Peskine21570cf2023-12-22 11:49:50 +01001672 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001673
1674 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001675 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001676
1677 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001678 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001679}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001680
Valerio Settie1655b82023-01-03 15:35:25 +01001681component_test_full_no_bignum () {
1682 msg "build: full minus bignum"
1683 scripts/config.py full
1684 scripts/config.py unset MBEDTLS_BIGNUM_C
1685 # Direct dependencies of bignum
1686 scripts/config.py unset MBEDTLS_ECP_C
1687 scripts/config.py unset MBEDTLS_RSA_C
1688 scripts/config.py unset MBEDTLS_DHM_C
1689 # Direct dependencies of ECP
1690 scripts/config.py unset MBEDTLS_ECDH_C
1691 scripts/config.py unset MBEDTLS_ECDSA_C
1692 scripts/config.py unset MBEDTLS_ECJPAKE_C
1693 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001694 # Disable what auto-enables ECP_LIGHT
1695 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1696 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001697 # Indirect dependencies of ECP
1698 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1699 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1700 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1701 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1702 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1703 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1704 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1705 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1706 # Direct dependencies of DHM
1707 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1708 # Direct dependencies of RSA
1709 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1710 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1711 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1712 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1713 # PK and its dependencies
1714 scripts/config.py unset MBEDTLS_PK_C
1715 scripts/config.py unset MBEDTLS_PK_PARSE_C
1716 scripts/config.py unset MBEDTLS_PK_WRITE_C
1717 scripts/config.py unset MBEDTLS_X509_USE_C
1718 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1719 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1720 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1721 scripts/config.py unset MBEDTLS_X509_CREATE_C
1722 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1723 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1724 scripts/config.py unset MBEDTLS_PKCS7_C
1725 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1726 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1727 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1728
Gilles Peskine21570cf2023-12-22 11:49:50 +01001729 make
Valerio Settie1655b82023-01-03 15:35:25 +01001730
1731 msg "test: full minus bignum"
1732 make test
1733}
1734
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001735component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001736 msg "build: default with only stream cipher"
1737
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001738 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001739 scripts/config.py unset MBEDTLS_GCM_C
1740 scripts/config.py unset MBEDTLS_CCM_C
1741 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001742 # 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 +02001743 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001744 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001745 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001746 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1747 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001748 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001749 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001750 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001751
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001752 make
1753
1754 msg "test: default with only stream cipher"
1755 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001756
1757 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001758}
1759
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001760component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001761 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001762
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001763 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001764 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001765 scripts/config.py unset MBEDTLS_GCM_C
1766 scripts/config.py unset MBEDTLS_CCM_C
1767 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001768 # 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 +02001769 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001770 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001771 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001772 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1773 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001774 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001775 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001776 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001777
Przemek Stekiel9550c052022-09-28 09:51:55 +02001778 make
1779
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001780 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001781 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001782
1783 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001784}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001785
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001786component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001787 msg "build: default with only CBC-legacy cipher"
1788
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001789 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001790 scripts/config.py unset MBEDTLS_GCM_C
1791 scripts/config.py unset MBEDTLS_CCM_C
1792 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001793 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1794 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1795 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001796 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001797 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001798 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001799 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001800 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001801 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001802
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001803 make
1804
1805 msg "test: default with only CBC-legacy cipher"
1806 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001807
1808 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1809 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001810}
1811
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001812component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001813 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001814
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001815 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001816 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001817 scripts/config.py unset MBEDTLS_GCM_C
1818 scripts/config.py unset MBEDTLS_CCM_C
1819 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001820 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1821 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1822 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001823 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001824 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001825 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001826 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001827 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001828 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001829
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001830 make
1831
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001832 msg "test: default with only CBC-legacy cipher use psa"
1833 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001834
1835 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
1836 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001837}
1838
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001839component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001840 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
1841
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001842 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001843 scripts/config.py unset MBEDTLS_GCM_C
1844 scripts/config.py unset MBEDTLS_CCM_C
1845 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001846 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1847 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1848 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1849 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1850 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001851 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001852 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001853 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001854 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001855
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001856 make
1857
1858 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
1859 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001860
1861 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
1862 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001863}
1864
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001865component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
1866 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001867
1868 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001869 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001870 scripts/config.py unset MBEDTLS_GCM_C
1871 scripts/config.py unset MBEDTLS_CCM_C
1872 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001873 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1874 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1875 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1876 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
1877 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001878 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001879 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001880 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001881 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001882
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001883 make
1884
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001885 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001886 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001887
1888 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
1889 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001890}
1891
Valerio Setti9f0ec532022-11-08 13:03:24 +01001892# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
1893# that we could use for interop testing. However, we now have sort of two
1894# implementations ourselves: one using PSA, the other not. At least test that
1895# these two interoperate with each other.
1896component_test_tls1_2_ecjpake_compatibility() {
1897 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
1898 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02001899 # Explicitly make lib first to avoid a race condition:
1900 # https://github.com/Mbed-TLS/mbedtls/issues/8229
1901 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001902 make -C programs ssl/ssl_server2 ssl/ssl_client2
1903 cp programs/ssl/ssl_server2 s2_no_use_psa
1904 cp programs/ssl/ssl_client2 c2_no_use_psa
1905
1906 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
1907 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1908 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02001909 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01001910 make -C programs ssl/ssl_server2 ssl/ssl_client2
1911 make -C programs test/udp_proxy test/query_compile_time_config
1912
Valerio Setti70e02902022-12-02 16:21:56 +01001913 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
1914 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1915 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
1916 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
1917 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
1918 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
1919 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
1920 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 +01001921
1922 rm s2_no_use_psa c2_no_use_psa
1923}
1924
Gilles Peskine636c26a2020-03-04 20:46:15 +01001925component_test_everest () {
1926 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
1927 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1928 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
1929 make
1930
1931 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1932 make test
1933
Gilles Peskine6848d172023-11-02 19:58:03 +01001934 msg "test: metatests (clang, ASan)"
1935 tests/scripts/run-metatests.sh any asan
1936
Gilles Peskine636c26a2020-03-04 20:46:15 +01001937 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
1938 tests/ssl-opt.sh -f ECDH
1939
1940 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1941 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02001942 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01001943}
1944
Gilles Peskined3beca92020-07-03 00:15:37 +02001945component_test_everest_curve25519_only () {
1946 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02001947 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
1948 scripts/config.py unset MBEDTLS_ECDSA_C
1949 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1950 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02001951 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02001952 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02001953 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02001954 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
1955
Dave Rodgman17127e92023-12-14 16:42:48 +00001956 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02001957
1958 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
1959 make test
1960}
1961
Gilles Peskine8f073122018-11-27 15:58:47 +01001962component_test_small_ssl_out_content_len () {
1963 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001964 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
1965 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00001966 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001967 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001968
Gilles Peskine8f073122018-11-27 15:58:47 +01001969 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001970 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01001971}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001972
Gilles Peskine8f073122018-11-27 15:58:47 +01001973component_test_small_ssl_in_content_len () {
1974 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001975 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
1976 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00001977 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001978 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10001979
Gilles Peskine8f073122018-11-27 15:58:47 +01001980 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001981 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01001982}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001983
Gilles Peskine8f073122018-11-27 15:58:47 +01001984component_test_small_ssl_dtls_max_buffering () {
1985 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001986 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00001987 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001988 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10001989
Gilles Peskine8f073122018-11-27 15:58:47 +01001990 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001991 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 +01001992}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01001993
Gilles Peskine8f073122018-11-27 15:58:47 +01001994component_test_small_mbedtls_ssl_dtls_max_buffering () {
1995 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001996 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00001997 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001998 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01001999
Gilles Peskine8f073122018-11-27 15:58:47 +01002000 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002001 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002002}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002003
Gilles Peskine75cc7712019-09-06 19:47:17 +02002004component_test_psa_collect_statuses () {
2005 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002006 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002007 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002008 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002009 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002010 rm -f tests/statuses.log
2011}
2012
Gilles Peskine8f073122018-11-27 15:58:47 +01002013component_test_full_cmake_clang () {
2014 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002015 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002016 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 +01002017 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002018
k-stachowiak0291cb72019-06-26 15:52:12 +02002019 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002020 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002021
Gilles Peskineda6017c2022-10-30 21:02:40 +01002022 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2023 programs/test/cpp_dummy_build
2024
Gilles Peskine6848d172023-11-02 19:58:03 +01002025 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002026 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002027
Gilles Peskine82b27272019-06-14 18:27:03 +02002028 msg "program demos (full config, clang)" # ~10s
2029 tests/scripts/run_demos.py
2030
k-stachowiak0291cb72019-06-26 15:52:12 +02002031 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002032 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002033
Gilles Peskine8f073122018-11-27 15:58:47 +01002034 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002035 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002036
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002037 msg "test: compat.sh NULL (full config)" # ~ 2 min
Gilles Peskinee29203b2023-08-27 21:43:00 +02002038 tests/compat.sh -e '^$' -f 'NULL'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002039
Gilles Peskine8f073122018-11-27 15:58:47 +01002040 msg "test: compat.sh ARIA + ChachaPoly"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002041 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gilles Peskine8f073122018-11-27 15:58:47 +01002042}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002043
Gilles Peskine0c671602022-11-29 16:01:41 +01002044skip_suites_without_constant_flow () {
2045 # Skip the test suites that don't have any constant-flow annotations.
2046 # This will need to be adjusted if we ever start declaring things as
2047 # secret from macros or functions inside tests/include or tests/src.
2048 SKIP_TEST_SUITES=$(
2049 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2050 sed 's/test_suite_//; s/\.function$//' |
2051 tr '\n' ,)
2052 export SKIP_TEST_SUITES
2053}
2054
Dave Rodgman246210e2023-07-31 18:07:44 +01002055skip_all_except_given_suite () {
2056 # Skip all but the given test suite
2057 SKIP_TEST_SUITES=$(
2058 ls -1 tests/suites/test_suite_*.function |
2059 grep -v $1.function |
2060 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2061 tr '\n' ,)
2062 export SKIP_TEST_SUITES
2063}
2064
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002065component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002066 # This tests both (1) accesses to undefined memory, and (2) branches or
2067 # memory access depending on secret values. To distinguish between those:
2068 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2069 # - or alternatively, change the build type to MemSanDbg, which enables
2070 # origin tracking and nicer stack traces (which are useful for debugging
2071 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002072 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2073 scripts/config.py full
2074 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2075 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2076 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2077 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2078 make
2079
2080 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2081 make test
2082}
2083
2084component_test_memsan_constant_flow_psa () {
2085 # This tests both (1) accesses to undefined memory, and (2) branches or
2086 # memory access depending on secret values. To distinguish between those:
2087 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2088 # - or alternatively, change the build type to MemSanDbg, which enables
2089 # origin tracking and nicer stack traces (which are useful for debugging
2090 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002091 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002092 scripts/config.py full
2093 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2094 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2095 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2096 make
2097
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002098 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002099 make test
2100}
2101
Bence Szépkúti0354d042023-12-06 16:14:37 +01002102component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002103 # This tests both (1) everything that valgrind's memcheck usually checks
2104 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2105 # etc.) and (2) branches or memory access depending on secret values,
2106 # which will be reported as uninitialized memory. To distinguish between
2107 # secret and actually uninitialized:
2108 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2109 # - or alternatively, build with debug info and manually run the offending
2110 # test suite with valgrind --track-origins=yes, then check if the origin
2111 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002112 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2113 scripts/config.py full
2114 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2115 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002116 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002117 cmake -D CMAKE_BUILD_TYPE:String=Release .
2118 make
2119
2120 # this only shows a summary of the results (how many of each type)
2121 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002122 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002123 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002124
2125 # Test asm path in constant time module - by default, it will test the plain C
2126 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2127 msg "test: valgrind asm constant_time"
2128 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2129 skip_all_except_given_suite test_suite_constant_time
2130 cmake -D CMAKE_BUILD_TYPE:String=Release .
2131 make clean
2132 make
2133 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002134}
2135
Bence Szépkúti0354d042023-12-06 16:14:37 +01002136component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002137 # This tests both (1) everything that valgrind's memcheck usually checks
2138 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2139 # etc.) and (2) branches or memory access depending on secret values,
2140 # which will be reported as uninitialized memory. To distinguish between
2141 # secret and actually uninitialized:
2142 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2143 # - or alternatively, build with debug info and manually run the offending
2144 # test suite with valgrind --track-origins=yes, then check if the origin
2145 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002146 msg "build: cmake release GCC, full config with constant flow testing"
2147 scripts/config.py full
2148 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002149 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002150 cmake -D CMAKE_BUILD_TYPE:String=Release .
2151 make
2152
2153 # this only shows a summary of the results (how many of each type)
2154 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002155 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002156 make memcheck
2157}
2158
Janos Follath9338cac2023-10-04 18:55:39 +01002159component_test_tsan () {
2160 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002161 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002162 scripts/config.py set MBEDTLS_THREADING_C
2163 scripts/config.py set MBEDTLS_THREADING_PTHREAD
2164
2165 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2166 make
2167
2168 msg "test: main suites (TSan)"
2169 make test
2170}
2171
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002172component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002173 # Test that removing the deprecated features from the default
2174 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002175 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2176 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
2177 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
2178
2179 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2180 make test
2181}
2182
2183component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002184 msg "build: make, full_no_deprecated config" # ~ 30s
2185 scripts/config.py full_no_deprecated
Gilles Peskine21570cf2023-12-22 11:49:50 +01002186 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002187
Gilles Peskine30de2e82020-04-20 21:39:22 +02002188 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002189 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002190
2191 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2192 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002193}
2194
Gilles Peskine8386ea22020-04-30 09:07:29 +02002195component_test_full_no_deprecated_deprecated_warning () {
2196 # Test that there is nothing deprecated in "full_no_deprecated".
2197 # A deprecated feature would trigger a warning (made fatal) from
2198 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002199 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2200 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002201 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2202 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine21570cf2023-12-22 11:49:50 +01002203 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002204
Gilles Peskine30de2e82020-04-20 21:39:22 +02002205 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002206 make test
2207}
2208
Gilles Peskine8386ea22020-04-30 09:07:29 +02002209component_test_full_deprecated_warning () {
2210 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2211 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002212 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002213 scripts/config.py full
2214 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002215 # Expect warnings from '#warning' directives in check_config.h.
2216 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002217
Gilles Peskine8386ea22020-04-30 09:07:29 +02002218 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2219 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2220 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002221 # Expect warnings from '#warning' directives in check_config.h and
2222 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002223 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 +01002224
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002225 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2226 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002227
2228 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2229 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002230}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002231
Gilles Peskineec541fe2020-01-31 14:24:14 +01002232# Check that the specified libraries exist and are empty.
2233are_empty_libraries () {
2234 nm "$@" >/dev/null 2>/dev/null
2235 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2236}
2237
2238component_build_crypto_default () {
2239 msg "build: make, crypto only"
2240 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002241 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002242 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002243}
2244
2245component_build_crypto_full () {
2246 msg "build: make, crypto only, full config"
2247 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002248 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002249 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002250}
2251
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002252component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002253 msg "build: make, config for PSA crypto service"
2254 scripts/config.py crypto
2255 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2256 # Disable things that are not needed for just cryptography, to
2257 # reach a configuration that would be typical for a PSA cryptography
2258 # service providing all implemented PSA algorithms.
2259 # System stuff
2260 scripts/config.py unset MBEDTLS_ERROR_C
2261 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002262 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002263 # Crypto stuff with no PSA interface
2264 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002265 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002266 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002267 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002268 scripts/config.py unset MBEDTLS_NIST_KW_C
2269 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2270 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2271 scripts/config.py unset MBEDTLS_PKCS12_C
2272 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002273 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2274 # in PSA code to work with RSA keys. We don't require users to set those:
2275 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002276 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002277 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002278 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002279 make CFLAGS='-O1 -Werror' all test
2280 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2281}
2282
Gilles Peskineec541fe2020-01-31 14:24:14 +01002283component_build_crypto_baremetal () {
2284 msg "build: make, crypto only, baremetal config"
2285 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002286 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002287 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002288}
Daniel Axtens446af202020-09-02 21:30:13 +10002289support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002290 support_build_baremetal "$@"
2291}
2292
2293component_build_baremetal () {
2294 msg "build: make, baremetal config"
2295 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002296 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002297}
2298support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002299 # Older Glibc versions include time.h from other headers such as stdlib.h,
2300 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2301 # problem, Ubuntu 18.04 is ok.
2302 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2303}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002304
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002305# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002306component_test_depends_py_cipher_id () {
2307 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002308 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002309}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002310
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002311component_test_depends_py_cipher_chaining () {
2312 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002313 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002314}
2315
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002316component_test_depends_py_cipher_padding () {
2317 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002318 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002319}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002320
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002321component_test_depends_py_curves () {
2322 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002323 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002324}
2325
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002326component_test_depends_py_hashes () {
2327 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002328 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002329}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002330
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002331component_test_depends_py_kex () {
2332 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002333 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002334}
2335
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002336component_test_depends_py_pkalgs () {
2337 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002338 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002339}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002340
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002341# PSA equivalents of the depends.py tests
2342component_test_depends_py_cipher_id_psa () {
2343 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002344 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002345}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002346
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002347component_test_depends_py_cipher_chaining_psa () {
2348 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002349 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002350}
2351
2352component_test_depends_py_cipher_padding_psa () {
2353 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002354 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002355}
2356
2357component_test_depends_py_curves_psa () {
2358 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002359 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002360}
2361
2362component_test_depends_py_hashes_psa () {
2363 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002364 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002365}
2366
2367component_test_depends_py_kex_psa () {
2368 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002369 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002370}
2371
2372component_test_depends_py_pkalgs_psa () {
2373 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002374 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002375}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002376
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002377component_build_no_pk_rsa_alt_support () {
2378 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2379
2380 scripts/config.py full
2381 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2382 scripts/config.py set MBEDTLS_RSA_C
2383 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2384
2385 # Only compile - this is primarily to test for compile issues
Gilles Peskine21570cf2023-12-22 11:49:50 +01002386 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002387}
2388
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002389component_build_module_alt () {
2390 msg "build: MBEDTLS_XXX_ALT" # ~30s
2391 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002392
2393 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002394 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2395 scripts/config.py unset MBEDTLS_AESNI_C
2396 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002397 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002398 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2399 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002400 # You can only have one threading implementation: alt or pthread, not both.
2401 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002402 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2403 # directly and assumes the implementation works with partial groups.
2404 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002405 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2406 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2407 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002408 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2409 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2410 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002411
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002412 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2413 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2414 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002415 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002416
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002417 # We can only compile, not link, since we don't have any implementations
2418 # suitable for testing with the dummy alt headers.
2419 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
2420}
2421
2422component_build_dhm_alt () {
2423 msg "build: MBEDTLS_DHM_ALT" # ~30s
2424 scripts/config.py full
2425 scripts/config.py set MBEDTLS_DHM_ALT
2426 # debug.c currently references mbedtls_dhm_context fields directly.
2427 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002428 # We can only compile, not link, since we don't have any implementations
2429 # suitable for testing with the dummy alt headers.
2430 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
2431}
2432
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002433component_test_no_use_psa_crypto_full_cmake_asan() {
2434 # full minus MBEDTLS_USE_PSA_CRYPTO: run the same set of tests as basic-build-test.sh
Gilles Peskinedc3a1792019-09-03 11:42:04 +02002435 msg "build: cmake, full config minus MBEDTLS_USE_PSA_CRYPTO, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002436 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002437 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
2438 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002439 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002440 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002441 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002442 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002443 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002444 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002445 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002446 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002447
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002448 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002449 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002450
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002451 # Note: ssl-opt.sh has some test cases that depend on
2452 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2453 # This is the only component where those tests are not skipped.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002454 msg "test: ssl-opt.sh (full minus MBEDTLS_USE_PSA_CRYPTO)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002455 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002456
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002457 msg "test: compat.sh default (full minus MBEDTLS_USE_PSA_CRYPTO)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002458 tests/compat.sh
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002459
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002460 msg "test: compat.sh NULL (full minus MBEDTLS_USE_PSA_CRYPTO)"
Gilles Peskinee29203b2023-08-27 21:43:00 +02002461 tests/compat.sh -f 'NULL'
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002462
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002463 msg "test: compat.sh ARIA + ChachaPoly (full minus MBEDTLS_USE_PSA_CRYPTO)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002464 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002465}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002466
Ronald Cron403c15c2021-09-13 09:38:05 +02002467component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002468 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002469
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002470 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002471 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002472 $(helper_get_psa_key_type_list "ECC") \
2473 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002474
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002475 # Configure
2476 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002477
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002478 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002479 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard6d7db932022-12-28 09:48:01 +01002480 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002481
2482 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002483 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002484
2485 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002486 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2487 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2488
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002489 # Build
2490 # -----
2491
2492 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002493 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2494 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002495
2496 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2497
Valerio Setti3fe105b2023-10-30 11:08:12 +01002498 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002499
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002500 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002501 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002502
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002503 # Run the tests
2504 # -------------
2505
Ronald Cron403c15c2021-09-13 09:38:05 +02002506 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2507 make test
2508}
2509
Valerio Setti44b178c2023-03-22 14:02:57 +01002510component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002511 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002512
2513 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002514 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002515 $(helper_get_psa_key_type_list "ECC") \
2516 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002517
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002518 # Configure
2519 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002520
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002521 # Start from default config (no TLS 1.3, no USE_PSA)
2522 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002523
Valerio Setti44b178c2023-03-22 14:02:57 +01002524 # Disable the module that's accelerated
2525 scripts/config.py unset MBEDTLS_ECDH_C
2526
2527 # Disable things that depend on it
2528 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2529 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2530 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2531 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2532 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2533
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002534 # Build
2535 # -----
2536
2537 helper_libtestdriver1_make_drivers "$loc_accel_list"
2538
Valerio Setti3fe105b2023-10-30 11:08:12 +01002539 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002540
Valerio Setti44b178c2023-03-22 14:02:57 +01002541 # Make sure this was not re-enabled by accident (additive config)
2542 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002543
2544 # Run the tests
2545 # -------------
2546
Valerio Setti44b178c2023-03-22 14:02:57 +01002547 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002548 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002549}
2550
Przemek Stekieldccb2022023-05-11 10:48:50 +02002551component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002552 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002553
2554 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002555 loc_accel_list="ALG_FFDH \
Valerio Setti0a342c92023-09-01 09:12:31 +02002556 $(helper_get_psa_key_type_list "DH")"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002557
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002558 # Configure
2559 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002560
Przemek Stekiel565353e2023-07-05 11:07:07 +02002561 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002562 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002563
2564 # Disable the module that's accelerated
2565 scripts/config.py unset MBEDTLS_DHM_C
2566
2567 # Disable things that depend on it
2568 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2569 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2570
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002571 # Build
2572 # -----
2573
2574 helper_libtestdriver1_make_drivers "$loc_accel_list"
2575
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002576 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002577
2578 # Make sure this was not re-enabled by accident (additive config)
2579 not grep mbedtls_dhm_ library/dhm.o
2580
2581 # Run the tests
2582 # -------------
2583
Gilles Peskine14302ed2023-07-19 19:30:04 +02002584 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002585 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002586
Gilles Peskine14302ed2023-07-19 19:30:04 +02002587 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002588 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002589}
2590
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002591component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002592 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002593
2594 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002595 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002596
2597 # Disable things that are not supported
2598 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2599 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002600 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002601
Gilles Peskine14302ed2023-07-19 19:30:04 +02002602 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002603 make test
2604
Gilles Peskine14302ed2023-07-19 19:30:04 +02002605 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002606 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002607}
2608
Valerio Setti44b178c2023-03-22 14:02:57 +01002609component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002610 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002611
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002612 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002613 $(helper_get_psa_key_type_list "ECC") \
2614 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002615
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002616 # Configure
2617 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002618
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002619 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002620
2621 # Make built-in fallback not available
2622 scripts/config.py unset MBEDTLS_ECJPAKE_C
2623 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2624
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002625 # Build
2626 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002627
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002628 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002629
Valerio Setti3fe105b2023-10-30 11:08:12 +01002630 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002631
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002632 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002633 not grep mbedtls_ecjpake_init library/ecjpake.o
2634
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002635 # Run the tests
2636 # -------------
2637
Gilles Peskine14302ed2023-07-19 19:30:04 +02002638 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002639 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002640}
2641
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002642component_test_psa_crypto_config_accel_ecc_some_key_types () {
2643 msg "build: full with accelerated EC algs and some key types"
2644
2645 # Algorithms and key types to accelerate
2646 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2647 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2648 ALG_ECDH \
2649 ALG_JPAKE \
2650 KEY_TYPE_ECC_PUBLIC_KEY \
2651 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2652 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002653 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2654 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002655
2656 # Configure
2657 # ---------
2658
2659 # start with config full for maximum coverage (also enables USE_PSA)
2660 helper_libtestdriver1_adjust_config "full"
2661
2662 # Disable modules that are accelerated - some will be re-enabled
2663 scripts/config.py unset MBEDTLS_ECDSA_C
2664 scripts/config.py unset MBEDTLS_ECDH_C
2665 scripts/config.py unset MBEDTLS_ECJPAKE_C
2666 scripts/config.py unset MBEDTLS_ECP_C
2667
2668 # Disable all curves - those that aren't accelerated should be re-enabled
2669 helper_disable_builtin_curves
2670
2671 # Restartable feature is not yet supported by PSA. Once it will in
2672 # the future, the following line could be removed (see issues
2673 # 6061, 6332 and following ones)
2674 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2675
2676 # this is not supported by the driver API yet
2677 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2678
2679 # Build
2680 # -----
2681
2682 # These hashes are needed for some ECDSA signature tests.
2683 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2684 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2685 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2686
Valerio Setti3fe105b2023-10-30 11:08:12 +01002687 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002688
2689 # ECP should be re-enabled but not the others
2690 not grep mbedtls_ecdh_ library/ecdh.o
2691 not grep mbedtls_ecdsa library/ecdsa.o
2692 not grep mbedtls_ecjpake library/ecjpake.o
2693 grep mbedtls_ecp library/ecp.o
2694
2695 # Run the tests
2696 # -------------
2697
2698 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002699 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002700}
2701
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002702# Run tests with only (non-)Weierstrass accelerated
2703# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002704# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2705# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002706common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002707 weierstrass=$1
2708 if [ $weierstrass -eq 1 ]; then
2709 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002710 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002711 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002712 fi
2713
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002714 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002715
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002716 # Note: Curves are handled in a special way by the libtestdriver machinery,
2717 # so we only want to include them in the accel list when building the main
2718 # libraries, hence the use of a separate variable.
2719 # Note: the following loop is a modified version of
2720 # helper_get_psa_curve_list that only keeps Weierstrass families.
2721 loc_weierstrass_list=""
2722 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002723 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2724 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002725 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002726 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002727 ;;
2728 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002729 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002730 ;;
2731 esac
2732 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002733 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002734 loc_curve_list=$loc_weierstrass_list
2735 else
2736 loc_curve_list=$loc_non_weierstrass_list
2737 fi
2738
Valerio Setti3fe105b2023-10-30 11:08:12 +01002739 # Algorithms and key types to accelerate
2740 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2741 ALG_ECDH \
2742 ALG_JPAKE \
2743 $(helper_get_psa_key_type_list "ECC") \
2744 $loc_curve_list"
2745
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002746 # Configure
2747 # ---------
2748
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002749 # Start with config crypto_full and remove PK_C:
2750 # that's what's supported now, see docs/driver-only-builds.md.
2751 helper_libtestdriver1_adjust_config "crypto_full"
2752 scripts/config.py unset MBEDTLS_PK_C
2753 scripts/config.py unset MBEDTLS_PK_PARSE_C
2754 scripts/config.py unset MBEDTLS_PK_WRITE_C
2755 # We need to disable RSA too or PK will be re-enabled.
2756 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
2757 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_ALG_RSA_[0-9A-Z_a-z]*"
2758 scripts/config.py unset MBEDTLS_RSA_C
2759 scripts/config.py unset MBEDTLS_PKCS1_V15
2760 scripts/config.py unset MBEDTLS_PKCS1_V21
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002761
2762 # Disable modules that are accelerated - some will be re-enabled
2763 scripts/config.py unset MBEDTLS_ECDSA_C
2764 scripts/config.py unset MBEDTLS_ECDH_C
2765 scripts/config.py unset MBEDTLS_ECJPAKE_C
2766 scripts/config.py unset MBEDTLS_ECP_C
2767
2768 # Disable all curves - those that aren't accelerated should be re-enabled
2769 helper_disable_builtin_curves
2770
2771 # Restartable feature is not yet supported by PSA. Once it will in
2772 # the future, the following line could be removed (see issues
2773 # 6061, 6332 and following ones)
2774 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2775
2776 # this is not supported by the driver API yet
2777 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2778
2779 # Build
2780 # -----
2781
2782 # These hashes are needed for some ECDSA signature tests.
2783 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2784 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2785 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2786
Valerio Settiac7a8092023-10-31 12:23:44 +01002787 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002788
2789 # We expect ECDH to be re-enabled for the missing curves
2790 grep mbedtls_ecdh_ library/ecdh.o
2791 # We expect ECP to be re-enabled, however the parts specific to the
2792 # families of curves that are accelerated should be ommited.
2793 # - functions with mxz in the name are specific to Montgomery curves
2794 # - ecp_muladd is specific to Weierstrass curves
2795 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002796 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002797 not grep mbedtls_ecp_muladd library/ecp.o
2798 grep mxz library/ecp.o
2799 else
2800 grep mbedtls_ecp_muladd library/ecp.o
2801 not grep mxz library/ecp.o
2802 fi
2803 # We expect ECDSA and ECJPAKE to be re-enabled only when
2804 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002805 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002806 not grep mbedtls_ecdsa library/ecdsa.o
2807 not grep mbedtls_ecjpake library/ecjpake.o
2808 else
2809 grep mbedtls_ecdsa library/ecdsa.o
2810 grep mbedtls_ecjpake library/ecjpake.o
2811 fi
2812
2813 # Run the tests
2814 # -------------
2815
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002816 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
2817 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002818}
2819
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002820component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002821 common_test_psa_crypto_config_accel_ecc_some_curves 1
2822}
2823
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002824component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002825 common_test_psa_crypto_config_accel_ecc_some_curves 0
2826}
2827
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002828# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
2829# ECDH, ECDSA) with and without drivers.
2830# The input parameter is a boolean value which indicates:
2831# - 0 keep built-in EC algs,
2832# - 1 exclude built-in EC algs (driver only).
2833#
2834# This is used by the two following components to ensure they always use the
2835# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002836# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
2837# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002838# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002839config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002840 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01002841 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002842 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002843 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01002844 # Disable modules that are accelerated
2845 scripts/config.py unset MBEDTLS_ECDSA_C
2846 scripts/config.py unset MBEDTLS_ECDH_C
2847 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02002848 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01002849 fi
2850
2851 # Restartable feature is not yet supported by PSA. Once it will in
2852 # the future, the following line could be removed (see issues
2853 # 6061, 6332 and following ones)
2854 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01002855}
2856
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002857# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
2858component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002859 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002860
2861 # Algorithms and key types to accelerate
2862 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2863 ALG_ECDH \
2864 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002865 $(helper_get_psa_key_type_list "ECC") \
2866 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01002867
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002868 # Configure
2869 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01002870
2871 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002872 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01002873
Valerio Setti0a342c92023-09-01 09:12:31 +02002874 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02002875 # - MBEDTLS_PK_PARSE_EC_EXTENDED
2876 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01002877
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002878 # Build
2879 # -----
2880
2881 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002882 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2883 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002884 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2885
Valerio Setti3fe105b2023-10-30 11:08:12 +01002886 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01002887
2888 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
2889 not grep mbedtls_ecdsa_ library/ecdsa.o
2890 not grep mbedtls_ecdh_ library/ecdh.o
2891 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02002892 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01002893
2894 # Run the tests
2895 # -------------
2896
Gilles Peskine14302ed2023-07-19 19:30:04 +02002897 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002898 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01002899
Gilles Peskine14302ed2023-07-19 19:30:04 +02002900 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002901 tests/ssl-opt.sh
2902}
2903
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002904# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
2905component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002906 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002907
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02002908 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01002909
Gilles Peskine21570cf2023-12-22 11:49:50 +01002910 make
Valerio Setti42d5f192023-03-20 13:54:41 +01002911
Gilles Peskine14302ed2023-07-19 19:30:04 +02002912 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002913 make test
2914
Gilles Peskine14302ed2023-07-19 19:30:04 +02002915 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01002916 tests/ssl-opt.sh
2917}
2918
Valerio Settie618cb02023-04-12 14:59:16 +02002919# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002920# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
2921# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02002922# to ensure that both tests use the same underlying configuration when testing
2923# driver's coverage with analyze_outcomes.py.
2924#
2925# This functions accepts 1 boolean parameter as follows:
2926# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
2927# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
2928# - 0: include built-in implementation of EC algorithms.
2929#
2930# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
2931# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002932config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002933 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02002934 # start with full config for maximum coverage (also enables USE_PSA)
2935 helper_libtestdriver1_adjust_config "full"
2936
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002937 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02002938 # Disable modules that are accelerated
2939 scripts/config.py unset MBEDTLS_ECDSA_C
2940 scripts/config.py unset MBEDTLS_ECDH_C
2941 scripts/config.py unset MBEDTLS_ECJPAKE_C
2942 # Disable ECP module (entirely)
2943 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02002944 fi
2945
Valerio Settiaecd32c2023-06-14 10:42:31 +02002946 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
2947 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02002948 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02002949 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02002950
Valerio Settie618cb02023-04-12 14:59:16 +02002951 # Restartable feature is not yet supported by PSA. Once it will in
2952 # the future, the following line could be removed (see issues
2953 # 6061, 6332 and following ones)
2954 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02002955}
2956
2957# Build and test a configuration where driver accelerates all EC algs while
2958# all support and dependencies from ECP and ECP_LIGHT are removed on the library
2959# side.
2960#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002961# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
2962component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002963 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02002964
2965 # Algorithms and key types to accelerate
2966 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2967 ALG_ECDH \
2968 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002969 $(helper_get_psa_key_type_list "ECC") \
2970 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02002971
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002972 # Configure
2973 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002974
Valerio Settie618cb02023-04-12 14:59:16 +02002975 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02002976 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02002977 # Disable all the builtin curves. All the required algs are accelerated.
2978 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02002979
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002980 # Build
2981 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02002982
2983 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002984 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
2985 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2986 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02002987
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02002988 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02002989
Valerio Setti3fe105b2023-10-30 11:08:12 +01002990 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02002991
2992 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
2993 not grep mbedtls_ecdsa_ library/ecdsa.o
2994 not grep mbedtls_ecdh_ library/ecdh.o
2995 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02002996 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02002997 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02002998
2999 # Run the tests
3000 # -------------
3001
Gilles Peskine14302ed2023-07-19 19:30:04 +02003002 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003003 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003004
Gilles Peskine14302ed2023-07-19 19:30:04 +02003005 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003006 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003007}
3008
3009# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003010# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003011# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003012component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003013 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003014
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003015 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003016
Gilles Peskine21570cf2023-12-22 11:49:50 +01003017 make
Valerio Settie618cb02023-04-12 14:59:16 +02003018
Gilles Peskine14302ed2023-07-19 19:30:04 +02003019 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003020 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003021
Gilles Peskine14302ed2023-07-19 19:30:04 +02003022 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003023 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003024}
3025
Valerio Setti4e2f2442023-08-15 10:10:26 +02003026# This is a common configuration helper used directly from:
3027# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3028# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3029# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003030# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003031# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003032# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003033# - this is the reference component of the above
3034# - it still disables RSA and FFDH, but it uses builtin EC algs
3035# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3036# - accelerate all EC and FFDH algs, disable only RSA
3037# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3038# - this is the reference component of the above
3039# - it still disables RSA, but it uses builtin EC and FFDH algs
3040#
3041# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003042# $1: a boolean value which states if we are testing an accelerated scenario
3043# or not.
3044# $2: a string value which states which components are tested. Allowed values
3045# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003046config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003047 driver_only="$1"
3048 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003049 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003050 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003051
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003052 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003053 # Disable modules that are accelerated
3054 scripts/config.py unset MBEDTLS_ECDSA_C
3055 scripts/config.py unset MBEDTLS_ECDH_C
3056 scripts/config.py unset MBEDTLS_ECJPAKE_C
3057 # Disable ECP module (entirely)
3058 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003059 # Also disable bignum
3060 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003061 fi
3062
3063 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3064 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3065 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3066 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3067
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003068 # RSA support is intentionally disabled on this test because RSA_C depends
3069 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003070 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3071 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 +02003072 scripts/config.py unset MBEDTLS_RSA_C
3073 scripts/config.py unset MBEDTLS_PKCS1_V15
3074 scripts/config.py unset MBEDTLS_PKCS1_V21
3075 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3076 # Also disable key exchanges that depend on RSA
3077 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3078 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3079 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3080 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3081 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3082
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003083 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003084 # When testing ECC only, we disable FFDH support, both from builtin and
3085 # PSA sides, and also disable the key exchanges that depend on DHM.
3086 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3087 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_DH_[0-9A-Z_a-z]*"
3088 scripts/config.py unset MBEDTLS_DHM_C
3089 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3090 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3091 else
3092 # When testing ECC and DH instead, we disable DHM and depending key
3093 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003094 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003095 scripts/config.py unset MBEDTLS_DHM_C
3096 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3097 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3098 fi
3099 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003100
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003101 # Restartable feature is not yet supported by PSA. Once it will in
3102 # the future, the following line could be removed (see issues
3103 # 6061, 6332 and following ones)
3104 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3105}
3106
Valerio Setti4e2f2442023-08-15 10:10:26 +02003107# Common helper used by:
3108# - component_test_psa_crypto_config_accel_ecc_no_bignum
3109# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003110#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003111# The goal is to build and test accelerating either:
3112# - ECC only or
3113# - both ECC and FFDH
3114#
3115# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003116# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3117# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003118common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003119 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003120
Valerio Setti5dfaca42023-09-05 08:48:51 +02003121 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003122 if [ "$test_target" = "ECC_DH" ]; then
3123 accel_text="ECC/FFDH"
3124 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003125 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003126 accel_text="ECC"
3127 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003128 fi
3129
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003130 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003131
3132 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003133 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3134 ALG_ECDH \
3135 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003136 $(helper_get_psa_key_type_list "ECC") \
3137 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003138 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003139 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003140 loc_accel_list="$loc_accel_list \
3141 ALG_FFDH \
Manuel Pégourié-Gonnard85ff5e62023-09-22 09:05:48 +02003142 $(helper_get_psa_key_type_list "DH")"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003143 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003144
3145 # Configure
3146 # ---------
3147
3148 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003149 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003150 # Disable all the builtin curves. All the required algs are accelerated.
3151 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003152
3153 # Build
3154 # -----
3155
3156 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003157 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3158 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3159 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003160
3161 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3162
Valerio Setti3fe105b2023-10-30 11:08:12 +01003163 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003164
3165 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3166 not grep mbedtls_ecdsa_ library/ecdsa.o
3167 not grep mbedtls_ecdh_ library/ecdh.o
3168 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003169 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003170 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003171 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003172 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003173 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003174
3175 # Run the tests
3176 # -------------
3177
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003178 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003179
Gilles Peskine21570cf2023-12-22 11:49:50 +01003180 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003181
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003182 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003183 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003184}
3185
Valerio Setti4e2f2442023-08-15 10:10:26 +02003186# Common helper used by:
3187# - component_test_psa_crypto_config_reference_ecc_no_bignum
3188# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3189#
3190# The goal is to build and test a reference scenario (i.e. with builtin
3191# components) compared to the ones used in
3192# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3193#
3194# It is meant to be used in conjunction with
3195# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3196# coverage analysis in "analyze_outcomes.py" script.
3197common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003198 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003199
Valerio Setti5dfaca42023-09-05 08:48:51 +02003200 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003201 if [ "$test_target" = "ECC_DH" ]; then
3202 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003203 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003204 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003205 fi
3206
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003207 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003208
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003209 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003210
Gilles Peskine21570cf2023-12-22 11:49:50 +01003211 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003212
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003213 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003214 make test
3215
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003216 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003217 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003218}
3219
Valerio Setti4e2f2442023-08-15 10:10:26 +02003220component_test_psa_crypto_config_accel_ecc_no_bignum () {
3221 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3222}
3223
3224component_test_psa_crypto_config_reference_ecc_no_bignum () {
3225 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3226}
3227
3228component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3229 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3230}
3231
3232component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3233 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3234}
3235
Valerio Settiac6d35f2023-08-04 12:49:11 +02003236# Helper for setting common configurations between:
3237# - component_test_tfm_config_p256m_driver_accel_ec()
3238# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003239common_tfm_config () {
3240 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003241 cp configs/config-tfm.h "$CONFIG_H"
3242 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3243 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003244
Yanray Wang73bb2312023-09-25 11:21:15 +08003245 # Other config adjustment to make the tests pass.
3246 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003247 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003248 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3249 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003250
Yanray Wang73bb2312023-09-25 11:21:15 +08003251 # Config adjustment for better test coverage in our environment.
3252 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003253 #
3254 # Enable filesystem I/O for the benefit of PK parse/write tests.
3255 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3256}
3257
Valerio Settiac6d35f2023-08-04 12:49:11 +02003258# Keep this in sync with component_test_tfm_config() as they are both meant
3259# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003260component_test_tfm_config_p256m_driver_accel_ec () {
3261 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3262
3263 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003264
Dave Rodgman897bb772023-11-15 16:34:20 +00003265 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003266 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003267
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003268 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3269 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003270 not grep mbedtls_ecdh_ library/ecdh.o
3271 not grep mbedtls_ecjpake_ library/ecjpake.o
3272 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3273 not grep mbedtls_ecp_ library/ecp.o
3274 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003275 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003276 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003277 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003278 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003279
Valerio Setti5e18b902023-12-04 12:07:30 +01003280 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3281 # files, so we want to ensure that it has not be re-enabled accidentally.
3282 not grep mbedtls_cipher library/cipher.o
3283
Valerio Settib7e95442023-03-21 11:52:33 +01003284 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003285 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003286 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003287}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003288
Valerio Settiac6d35f2023-08-04 12:49:11 +02003289# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3290# they are both meant to be used in analyze_outcomes.py for driver's coverage
3291# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003292component_test_tfm_config() {
3293 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003294
Dave Rodgman897bb772023-11-15 16:34:20 +00003295 # Disable P256M driver, which is on by default, so that analyze_outcomes
3296 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3297 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3298
Valerio Setti52ba0e32023-08-04 12:43:03 +02003299 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003300 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003301
Dave Rodgman897bb772023-11-15 16:34:20 +00003302 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003303 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003304
Valerio Setti5e18b902023-12-04 12:07:30 +01003305 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3306 # files, so we want to ensure that it has not be re-enabled accidentally.
3307 not grep mbedtls_cipher library/cipher.o
3308
Valerio Setti52ba0e32023-08-04 12:43:03 +02003309 msg "test: TF-M config"
3310 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003311}
3312
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003313# Common helper for component_full_without_ecdhe_ecdsa() and
3314# component_full_without_ecdhe_ecdsa_and_tls13() which:
3315# - starts from the "full" configuration minus the list of symbols passed in
3316# as 1st parameter
3317# - build
3318# - test only TLS (i.e. test_suite_tls and ssl-opt)
3319build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003320 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003321
3322 msg "build: full minus something, test TLS"
3323
3324 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003325 for sym in $symbols_to_disable; do
3326 echo "Disabling $sym"
3327 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003328 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003329
Gilles Peskine21570cf2023-12-22 11:49:50 +01003330 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003331
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003332 msg "test: full minus something, test TLS"
3333 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003334
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003335 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003336 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003337}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003338
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003339component_full_without_ecdhe_ecdsa () {
3340 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003341}
3342
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003343component_full_without_ecdhe_ecdsa_and_tls13 () {
3344 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3345 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003346}
3347
Valerio Setti249b18a2023-06-20 12:08:30 +02003348# This is an helper used by:
3349# - component_test_psa_ecc_key_pair_no_derive
3350# - component_test_psa_ecc_key_pair_no_generate
3351# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3352# enabled, but one. Input arguments are as follows:
3353# - $1 is the key type under test, i.e. ECC/RSA/DH
3354# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003355build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003356 key_type=$1
3357 unset_option=$2
3358 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003359
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003360 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003361 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003362 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3363 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3364
3365 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3366 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003367 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003368
Gilles Peskine21570cf2023-12-22 11:49:50 +01003369 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003370
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003371 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003372 make test
3373}
3374
3375component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003376 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003377}
3378
3379component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003380 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003381}
3382
Pengyu Lve705f572023-12-06 16:38:15 +08003383config_psa_crypto_accel_rsa () {
3384 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003385
Pengyu Lve705f572023-12-06 16:38:15 +08003386 # Start from crypto_full config (no X.509, no TLS)
3387 helper_libtestdriver1_adjust_config "crypto_full"
3388
3389 if [ "$driver_only" -eq 1 ]; then
3390 # Remove RSA support and its dependencies
3391 scripts/config.py unset MBEDTLS_RSA_C
3392 scripts/config.py unset MBEDTLS_PKCS1_V15
3393 scripts/config.py unset MBEDTLS_PKCS1_V21
3394
3395 # We need PEM parsing in the test library as well to support the import
3396 # of PEM encoded RSA keys.
3397 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3398 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3399 fi
3400}
3401
3402component_test_psa_crypto_config_accel_rsa_crypto () {
3403 msg "build: crypto_full with accelerated RSA"
3404
3405 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3406 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3407 KEY_TYPE_RSA_PUBLIC_KEY \
3408 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3409 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3410 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3411 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003412
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003413 # Configure
3414 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003415
Pengyu Lve705f572023-12-06 16:38:15 +08003416 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003417
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003418 # Build
3419 # -----
3420
Pengyu Lve705f572023-12-06 16:38:15 +08003421 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003422 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 +08003423 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003424 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003425
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003426 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003427
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003428 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003429 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003430
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003431 # Run the tests
3432 # -------------
3433
Pengyu Lve705f572023-12-06 16:38:15 +08003434 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003435 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003436}
3437
3438component_test_psa_crypto_config_reference_rsa_crypto () {
3439 msg "build: crypto_full with non-accelerated RSA"
3440
3441 # Configure
3442 # ---------
3443 config_psa_crypto_accel_rsa 0
3444
3445 # Build
3446 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003447 make
Pengyu Lve705f572023-12-06 16:38:15 +08003448
3449 # Run the tests
3450 # -------------
3451 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003452 make test
3453}
3454
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003455# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003456# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003457component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003458 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003459
Valerio Setti4590bc22023-06-13 15:39:23 +02003460 # Create a temporary output file unless there is already one set
3461 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3462 REMOVE_OUTCOME_ON_EXIT="no"
3463 else
3464 REMOVE_OUTCOME_ON_EXIT="yes"
3465 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3466 export MBEDTLS_TEST_OUTCOME_FILE
3467 fi
3468
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003469 # Start from crypto configuration
3470 scripts/config.py crypto
3471
3472 # Remove RSA support and its dependencies
3473 scripts/config.py unset MBEDTLS_PKCS1_V15
3474 scripts/config.py unset MBEDTLS_PKCS1_V21
3475 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3476 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3477 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3478 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3479 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3480 scripts/config.py unset MBEDTLS_RSA_C
3481 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3482
3483 # Enable PSA support
3484 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3485
Valerio Setti01cc88a2023-06-15 11:53:08 +02003486 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003487 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003488 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3489 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3490 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003491
3492 make
3493
Valerio Setti01cc88a2023-06-15 11:53:08 +02003494 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003495 make test
3496
3497 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3498 # performing RSA signature.
3499 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3500 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3501
3502 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3503 rm $MBEDTLS_TEST_OUTCOME_FILE
3504 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003505}
3506
Ronald Cronb2312452021-05-08 14:32:59 +02003507component_test_psa_crypto_config_accel_hash () {
3508 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3509
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003510 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3511 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3512 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003513
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003514 # Configure
3515 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003516
3517 # Start from default config (no TLS 1.3, no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003518 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003519
3520 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003521 scripts/config.py unset MBEDTLS_MD5_C
3522 scripts/config.py unset MBEDTLS_RIPEMD160_C
3523 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003524 scripts/config.py unset MBEDTLS_SHA224_C
3525 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003526 scripts/config.py unset MBEDTLS_SHA384_C
3527 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003528 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003529
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003530 # Build
3531 # -----
3532
3533 helper_libtestdriver1_make_drivers "$loc_accel_list"
3534
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003535 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003536
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003537 # There's a risk of something getting re-enabled via config_psa.h;
3538 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3539 not grep mbedtls_md5 library/md5.o
3540 not grep mbedtls_sha1 library/sha1.o
3541 not grep mbedtls_sha256 library/sha256.o
3542 not grep mbedtls_sha512 library/sha512.o
3543 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003544
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003545 # Run the tests
3546 # -------------
3547
Ronald Cronb2312452021-05-08 14:32:59 +02003548 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3549 make test
3550}
3551
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003552component_test_psa_crypto_config_accel_hash_keep_builtins () {
3553 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3554 # This component ensures that all the test cases for
3555 # md_psa_dynamic_dispatch with legacy+driver in test_suite_md are run.
3556
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003557 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3558 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3559 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003560
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003561 # Start from default config (no TLS 1.3, no USE_PSA)
3562 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003563
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003564 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003565
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003566 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard9b146392023-03-09 15:56:14 +01003567
3568 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated+builtin hash"
3569 make test
3570}
3571
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003572# Auxiliary function to build config for hashes with and without drivers
3573config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003574 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003575 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003576 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003577 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003578 # disable the built-in implementation of hashes
3579 scripts/config.py unset MBEDTLS_MD5_C
3580 scripts/config.py unset MBEDTLS_RIPEMD160_C
3581 scripts/config.py unset MBEDTLS_SHA1_C
3582 scripts/config.py unset MBEDTLS_SHA224_C
3583 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003584 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003585 scripts/config.py unset MBEDTLS_SHA384_C
3586 scripts/config.py unset MBEDTLS_SHA512_C
3587 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003588 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003589 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003590}
3591
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003592# Note that component_test_psa_crypto_config_reference_hash_use_psa
3593# is related to this component and both components need to be kept in sync.
3594# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003595component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003596 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003597
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003598 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3599 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3600 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003601
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003602 # Configure
3603 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003604
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003605 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003606
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003607 # Build
3608 # -----
3609
3610 helper_libtestdriver1_make_drivers "$loc_accel_list"
3611
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003612 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003613
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003614 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003615 # 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 +02003616 not grep mbedtls_md5 library/md5.o
3617 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003618 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003619 not grep mbedtls_sha512 library/sha512.o
3620 not grep mbedtls_ripemd160 library/ripemd160.o
3621
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003622 # Run the tests
3623 # -------------
3624
Gilles Peskine14302ed2023-07-19 19:30:04 +02003625 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003626 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003627
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003628 # This is mostly useful so that we can later compare outcome files with
3629 # the reference config in analyze_outcomes.py, to check that the
3630 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003631 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003632 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003633
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003634 # This is to make sure all ciphersuites are exercised, but we don't need
3635 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003636 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003637 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003638}
3639
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003640# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3641# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3642# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3643# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003644component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003645 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003646
3647 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003648
Gilles Peskine21570cf2023-12-22 11:49:50 +01003649 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003650
Gilles Peskine14302ed2023-07-19 19:30:04 +02003651 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003652 make test
3653
Gilles Peskine14302ed2023-07-19 19:30:04 +02003654 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003655 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003656}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003657
John Durkop4377bf72020-10-23 01:26:57 -07003658component_test_psa_crypto_config_accel_cipher () {
3659 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated cipher"
3660
Valerio Setti0244fbb2023-10-19 10:42:31 +02003661 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3662 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3663 KEY_TYPE_DES"
John Durkop1b7ee052020-11-27 08:51:22 -08003664
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003665 # Configure
3666 # ---------
John Durkop1b7ee052020-11-27 08:51:22 -08003667
Valerio Setti9a427302023-10-17 11:40:42 +02003668 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003669 helper_libtestdriver1_adjust_config "full"
John Durkop1b7ee052020-11-27 08:51:22 -08003670
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003671 # Disable the things that are being accelerated
John Durkop1b7ee052020-11-27 08:51:22 -08003672 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3673 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3674 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3675 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3676 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3677 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3678 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003679 scripts/config.py unset MBEDTLS_CMAC_C
John Durkop1b7ee052020-11-27 08:51:22 -08003680
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003681 # Build
3682 # -----
John Durkop1b7ee052020-11-27 08:51:22 -08003683
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003684 helper_libtestdriver1_make_drivers "$loc_accel_list"
3685
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003686 helper_libtestdriver1_make_main "$loc_accel_list"
John Durkop1b7ee052020-11-27 08:51:22 -08003687
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003688 # Make sure this was not re-enabled by accident (additive config)
John Durkop1b7ee052020-11-27 08:51:22 -08003689 not grep mbedtls_des* library/des.o
3690
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003691 # Run the tests
3692 # -------------
3693
John Durkop1b7ee052020-11-27 08:51:22 -08003694 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated cipher"
3695 make test
3696}
3697
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003698component_test_psa_crypto_config_accel_aead () {
3699 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3700
Valerio Setti3f02bb72023-10-02 15:57:33 +02003701 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3702 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003703
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003704 # Configure
3705 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003706
Valerio Setti3f02bb72023-10-02 15:57:33 +02003707 # Start from full config
3708 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003709
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003710 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003711 scripts/config.py unset MBEDTLS_GCM_C
3712 scripts/config.py unset MBEDTLS_CCM_C
3713 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003714
Valerio Settia50b89e2023-11-08 15:58:47 +01003715 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3716 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003717
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003718 # Build
3719 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003720
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003721 helper_libtestdriver1_make_drivers "$loc_accel_list"
3722
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003723 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003724
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003725 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003726 not grep mbedtls_ccm library/ccm.o
3727 not grep mbedtls_gcm library/gcm.o
3728 not grep mbedtls_chachapoly library/chachapoly.o
3729
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003730 # Run the tests
3731 # -------------
3732
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003733 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3734 make test
3735}
3736
Valerio Settib680fc42023-10-13 09:29:37 +02003737# This is a common configuration function used in:
3738# - component_test_psa_crypto_config_accel_cipher_aead
3739# - component_test_psa_crypto_config_reference_cipher_aead
3740common_psa_crypto_config_accel_cipher_aead() {
Pengyu Lv78657d02023-10-27 11:00:32 +08003741 # Start from the full config
3742 helper_libtestdriver1_adjust_config "full"
3743
Valerio Settiec9b2582023-11-08 16:50:54 +01003744 # CIPHER_C is disabled in the accelerated test component so we disable
3745 # all the features that depend on it both in the accelerated and in the
3746 # reference components.
3747 scripts/config.py unset MBEDTLS_PKCS5_C
3748 scripts/config.py unset MBEDTLS_PKCS12_C
3749
Valerio Settib680fc42023-10-13 09:29:37 +02003750 scripts/config.py unset MBEDTLS_NIST_KW_C
3751}
3752
Valerio Settib6b301f2023-10-04 12:05:05 +02003753# The 2 following test components, i.e.
3754# - component_test_psa_crypto_config_accel_cipher_aead
3755# - component_test_psa_crypto_config_reference_cipher_aead
3756# are meant to be used together in analyze_outcomes.py script in order to test
3757# driver's coverage for ciphers and AEADs.
3758component_test_psa_crypto_config_accel_cipher_aead () {
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003759 msg "build: full config with accelerated cipher and AEAD"
Valerio Settib6b301f2023-10-04 12:05:05 +02003760
Valerio Settiad8b7f02023-10-25 12:39:50 +02003761 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 +01003762 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02003763 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02003764 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
3765
3766 # Configure
3767 # ---------
3768
Valerio Settib680fc42023-10-13 09:29:37 +02003769 common_psa_crypto_config_accel_cipher_aead
Valerio Settib6b301f2023-10-04 12:05:05 +02003770
3771 # Disable the things that are being accelerated
3772 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3773 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3774 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3775 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3776 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3777 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3778 scripts/config.py unset MBEDTLS_GCM_C
3779 scripts/config.py unset MBEDTLS_CCM_C
3780 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02003781 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02003782 scripts/config.py unset MBEDTLS_DES_C
3783 scripts/config.py unset MBEDTLS_AES_C
3784 scripts/config.py unset MBEDTLS_ARIA_C
3785 scripts/config.py unset MBEDTLS_CHACHA20_C
3786 scripts/config.py unset MBEDTLS_CAMELLIA_C
3787
Valerio Settiec9b2582023-11-08 16:50:54 +01003788 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
3789 # does not depend on it.
3790 scripts/config.py unset MBEDTLS_CIPHER_C
3791
Valerio Settib6b301f2023-10-04 12:05:05 +02003792 # Build
3793 # -----
3794
3795 helper_libtestdriver1_make_drivers "$loc_accel_list"
3796
3797 helper_libtestdriver1_make_main "$loc_accel_list"
3798
3799 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01003800 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02003801 not grep mbedtls_des library/des.o
3802 not grep mbedtls_aes library/aes.o
3803 not grep mbedtls_aria library/aria.o
3804 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02003805 not grep mbedtls_ccm library/ccm.o
3806 not grep mbedtls_gcm library/gcm.o
3807 not grep mbedtls_chachapoly library/chachapoly.o
3808 not grep mbedtls_cmac library/cmac.o
3809
3810 # Run the tests
3811 # -------------
3812
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003813 msg "test: full config with accelerated cipher and AEAD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003814 make test
Valerio Settif9414552023-11-09 10:43:20 +01003815
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003816 msg "ssl-opt: full config with accelerated cipher and AEAD"
Valerio Settif9414552023-11-09 10:43:20 +01003817 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003818
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003819 msg "compat.sh: full config with accelerated cipher and AEAD"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003820 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003821}
3822
3823component_test_psa_crypto_config_reference_cipher_aead () {
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003824 msg "build: full config with non-accelerated cipher and AEAD"
Valerio Settib680fc42023-10-13 09:29:37 +02003825 common_psa_crypto_config_accel_cipher_aead
Valerio Settib6b301f2023-10-04 12:05:05 +02003826
Gilles Peskine21570cf2023-12-22 11:49:50 +01003827 make
Valerio Settif9414552023-11-09 10:43:20 +01003828
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003829 msg "test: full config with non-accelerated cipher and AEAD"
Valerio Settib6b301f2023-10-04 12:05:05 +02003830 make test
Valerio Settif9414552023-11-09 10:43:20 +01003831
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003832 msg "ssl-opt: full config with non-accelerated cipher and AEAD"
Valerio Settif9414552023-11-09 10:43:20 +01003833 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08003834
Pengyu Lv7afd9a42023-11-16 17:55:25 +08003835 msg "compat.sh: full config with non-accelerated cipher and AEAD"
Pengyu Lvf561ed82023-11-14 17:33:32 +08003836 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02003837}
3838
Gilles Peskine36dea152023-07-20 22:19:45 +02003839component_test_aead_chachapoly_disabled() {
3840 msg "build: full minus CHACHAPOLY"
John Durkopf4c4cb02020-10-28 20:09:55 -07003841 scripts/config.py full
John Durkop9814fa22020-11-04 12:28:15 -08003842 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02003843 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01003844 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
John Durkop6ba40d12020-11-10 08:50:04 -08003845
Gilles Peskine36dea152023-07-20 22:19:45 +02003846 msg "test: full minus CHACHAPOLY"
3847 make test
3848}
3849
3850component_test_aead_only_ccm() {
3851 msg "build: full minus CHACHAPOLY and GCM"
3852 scripts/config.py full
3853 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
3854 scripts/config.py unset MBEDTLS_GCM_C
3855 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
3856 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01003857 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02003858
3859 msg "test: full minus CHACHAPOLY and GCM"
John Durkop9814fa22020-11-04 12:28:15 -08003860 make test
John Durkopf4c4cb02020-10-28 20:09:55 -07003861}
3862
Ronald Crone501d0e2023-07-10 08:31:19 +02003863component_test_ccm_aes_sha256() {
3864 msg "build: CCM + AES + SHA256 configuration"
3865
Ronald Cron7612d8c2023-07-20 10:03:54 +02003866 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02003867 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02003868
3869 make CC=gcc
3870
3871 msg "test: CCM + AES + SHA256 configuration"
3872 make test
3873}
3874
John Durkop9814fa22020-11-04 12:28:15 -08003875# This should be renamed to test and updated once the accelerator ECDH code is in place and ready to test.
John Durkopf4c4cb02020-10-28 20:09:55 -07003876component_build_psa_accel_alg_ecdh() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003877 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_ECDH without MBEDTLS_ECDH_C"
John Durkopd0321952020-10-29 21:37:36 -07003878 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07003879 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003880 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkopd0321952020-10-29 21:37:36 -07003881 scripts/config.py unset MBEDTLS_ECDH_C
3882 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3883 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
3884 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3885 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3886 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
3887 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01003888 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_ECDH -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07003889}
3890
John Durkop1b7ee052020-11-27 08:51:22 -08003891# This should be renamed to test and updated once the accelerator HMAC code is in place and ready to test.
3892component_build_psa_accel_alg_hmac() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003893 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HMAC"
John Durkop1b7ee052020-11-27 08:51:22 -08003894 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003895 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003896 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkop1b7ee052020-11-27 08:51:22 -08003897 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01003898 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HMAC -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08003899}
3900
3901# This should be renamed to test and updated once the accelerator HKDF code is in place and ready to test.
3902component_build_psa_accel_alg_hkdf() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003903 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_HKDF without MBEDTLS_HKDF_C"
John Durkop1b7ee052020-11-27 08:51:22 -08003904 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003905 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003906 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkop1b7ee052020-11-27 08:51:22 -08003907 scripts/config.py unset MBEDTLS_HKDF_C
Ronald Cron6f135e12021-12-08 16:57:54 +01003908 # Make sure to unset TLS1_3 since it requires HKDF_C and will not build properly without it.
3909 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
John Durkop1b7ee052020-11-27 08:51:22 -08003910 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01003911 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_HKDF -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08003912}
3913
3914# This should be renamed to test and updated once the accelerator MD5 code is in place and ready to test.
3915component_build_psa_accel_alg_md5() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003916 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_MD5 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003917 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003918 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003919 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003920 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3921 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3922 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3923 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3924 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3925 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3926 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003927 scripts/config.py unset MBEDTLS_LMS_C
3928 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003929 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01003930 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_MD5 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08003931}
3932
3933# This should be renamed to test and updated once the accelerator RIPEMD160 code is in place and ready to test.
3934component_build_psa_accel_alg_ripemd160() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003935 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RIPEMD160 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003936 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003937 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003938 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003939 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3940 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3941 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3942 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3943 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3944 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3945 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003946 scripts/config.py unset MBEDTLS_LMS_C
3947 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003948 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01003949 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RIPEMD160 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08003950}
3951
3952# This should be renamed to test and updated once the accelerator SHA1 code is in place and ready to test.
3953component_build_psa_accel_alg_sha1() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003954 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_1 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003955 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003956 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003957 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003958 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3959 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3960 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3961 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
3962 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3963 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3964 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02003965 scripts/config.py unset MBEDTLS_LMS_C
3966 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08003967 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01003968 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_1 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08003969}
3970
3971# This should be renamed to test and updated once the accelerator SHA224 code is in place and ready to test.
3972component_build_psa_accel_alg_sha224() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003973 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_224 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003974 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003975 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003976 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003977 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3978 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3979 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3980 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3981 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
3982 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
John Durkop1b7ee052020-11-27 08:51:22 -08003983 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01003984 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_224 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08003985}
3986
3987# This should be renamed to test and updated once the accelerator SHA256 code is in place and ready to test.
3988component_build_psa_accel_alg_sha256() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02003989 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_256 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08003990 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08003991 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01003992 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02003993 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
3994 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
3995 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
3996 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
3997 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
3998 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_512
John Durkop1b7ee052020-11-27 08:51:22 -08003999 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004000 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_256 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004001}
4002
4003# This should be renamed to test and updated once the accelerator SHA384 code is in place and ready to test.
4004component_build_psa_accel_alg_sha384() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004005 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_384 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004006 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004007 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004008 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004009 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4010 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4011 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4012 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4013 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4014 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004015 scripts/config.py unset MBEDTLS_LMS_C
4016 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004017 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004018 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_384 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004019}
4020
4021# This should be renamed to test and updated once the accelerator SHA512 code is in place and ready to test.
4022component_build_psa_accel_alg_sha512() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004023 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_SHA_512 - other hashes"
John Durkop1b7ee052020-11-27 08:51:22 -08004024 scripts/config.py full
John Durkop1b7ee052020-11-27 08:51:22 -08004025 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004026 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004027 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_MD5
4028 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RIPEMD160
4029 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_1
4030 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_224
4031 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_256
4032 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_SHA_384
4033 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS
Gilles Peskinefa652372022-10-13 22:05:38 +02004034 scripts/config.py unset MBEDTLS_LMS_C
4035 scripts/config.py unset MBEDTLS_LMS_PRIVATE
John Durkop1b7ee052020-11-27 08:51:22 -08004036 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004037 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_SHA_512 -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkop1b7ee052020-11-27 08:51:22 -08004038}
4039
John Durkopd0321952020-10-29 21:37:36 -07004040# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004041component_build_psa_accel_alg_rsa_pkcs1v15_crypt() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004042 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_CRYPT + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopd0321952020-10-29 21:37:36 -07004043 scripts/config.py full
John Durkopd0321952020-10-29 21:37:36 -07004044 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004045 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004046 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_CRYPT 1
4047 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4048 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4049 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopd0321952020-10-29 21:37:36 -07004050 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004051 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_CRYPT -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004052}
4053
4054# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004055component_build_psa_accel_alg_rsa_pkcs1v15_sign() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004056 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PKCS1V15_SIGN + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004057 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004058 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004059 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004060 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PKCS1V15_SIGN 1
4061 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4062 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
4063 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004064 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004065 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PKCS1V15_SIGN -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004066}
4067
4068# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004069component_build_psa_accel_alg_rsa_oaep() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004070 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_OAEP + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004071 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004072 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004073 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004074 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_OAEP 1
4075 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4076 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4077 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PSS
John Durkopbd069d32020-10-31 22:14:03 -07004078 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004079 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_OAEP -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004080}
4081
4082# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004083component_build_psa_accel_alg_rsa_pss() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004084 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_ALG_RSA_PSS + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY"
John Durkopbd069d32020-10-31 22:14:03 -07004085 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004086 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004087 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004088 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4089 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_CRYPT
4090 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_PKCS1V15_SIGN
4091 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_RSA_OAEP
John Durkopbd069d32020-10-31 22:14:03 -07004092 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004093 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_ALG_RSA_PSS -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004094}
4095
4096# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004097component_build_psa_accel_key_type_rsa_key_pair() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004098 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_xxx + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004099 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004100 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004101 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004102 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4103 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC 1
4104 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT 1
4105 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT 1
4106 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE 1
John Durkopbd069d32020-10-31 22:14:03 -07004107 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004108 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_KEY_PAIR -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopbd069d32020-10-31 22:14:03 -07004109}
4110
4111# This should be renamed to test and updated once the accelerator RSA code is in place and ready to test.
John Durkop6ba40d12020-11-10 08:50:04 -08004112component_build_psa_accel_key_type_rsa_public_key() {
Gilles Peskineeb41e0d2023-07-19 19:36:55 +02004113 msg "build: full - MBEDTLS_USE_PSA_CRYPTO + PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY + PSA_WANT_ALG_RSA_PSS"
John Durkopbd069d32020-10-31 22:14:03 -07004114 scripts/config.py full
John Durkopbd069d32020-10-31 22:14:03 -07004115 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01004116 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron6b49b552023-07-20 09:57:54 +02004117 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_ALG_RSA_PSS 1
4118 scripts/config.py -f "$CRYPTO_CONFIG_H" set PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY 1
John Durkopbd069d32020-10-31 22:14:03 -07004119 # Need to define the correct symbol and include the test driver header path in order to build with the test driver
Gilles Peskine21570cf2023-12-22 11:49:50 +01004120 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST -DMBEDTLS_PSA_ACCEL_KEY_TYPE_RSA_PUBLIC_KEY -I../tests/include" LDFLAGS="$ASAN_CFLAGS"
John Durkopd0321952020-10-29 21:37:36 -07004121}
4122
Dave Rodgmanc164c072023-06-28 09:43:23 +01004123
Dave Rodgman904c5892023-06-28 17:36:02 +01004124support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004125 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004126}
4127
Dave Rodgman904c5892023-06-28 17:36:02 +01004128component_build_tfm_armcc() {
4129 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004130 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004131
Dave Rodgman88651c42023-06-29 12:35:51 +01004132 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004133 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 +01004134}
4135
4136component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004137 # Check that the TF-M configuration can build cleanly with various
4138 # warning flags enabled. We don't build or run tests, since the
4139 # TF-M configuration needs a TF-M platform. A tweaked version of
4140 # the configuration that works on mainstream platforms is in
4141 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004142 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004143
Dave Rodgman88651c42023-06-29 12:35:51 +01004144 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004145 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 +01004146
Dave Rodgman904c5892023-06-28 17:36:02 +01004147 msg "build: TF-M config, gcc native build"
4148 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004149 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 +01004150}
4151
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004152# Test that the given .o file builds with all (valid) combinations of the given options.
4153#
4154# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4155#
4156# The validator function is the name of a function to validate the combination of options.
4157# It may be "" if all combinations are valid.
4158# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004159# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004160build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004161 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004162 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004163 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004164 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004165 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004166
Dave Rodgman42436102023-10-03 15:47:05 +01004167 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004168 for opt in "${options[@]}"; do
4169 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004170 done
4171
4172 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004173 cd $(dirname ${file})
4174 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004175
Dave Rodgman920343a2023-10-01 18:41:09 +01004176 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004177 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 +01004178
Dave Rodgman42436102023-10-03 15:47:05 +01004179 # Extract the command generated by the Makefile to build the target file.
4180 # This ensures that we have any include paths, macro definitions, etc
4181 # that may be applied by make.
4182 # 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 +01004183 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004184
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004185 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004186 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004187
Dave Rodgman28e38d82023-10-04 11:50:30 +01004188 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004189 source_file=${file%.o}.c
4190
4191 targets=0
4192 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004193
Dave Rodgman28e38d82023-10-04 11:50:30 +01004194 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004195 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004196 # each bit of $i is used to determine if options[i] will be set or not
4197 target="t"
4198 clang_args=""
4199 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004200 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004201 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004202 clang_args="${clang_args} ${opt}"
4203 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004204 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004205 done
4206
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004207 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004208 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004209 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004210 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004211
Dave Rodgman28e38d82023-10-04 11:50:30 +01004212 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004213 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004214 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004215 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004216
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004217 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004218
Dave Rodgman920343a2023-10-01 18:41:09 +01004219 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004220 make -s -f ${makefile} build_test_config_combos
4221 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004222
4223 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004224 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004225}
4226
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004227validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004228 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4229 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004230 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004231 fi
4232 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4233 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004234 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004235 fi
4236 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004237 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004238}
4239
4240component_build_aes_variations() {
4241 # 18s - around 90ms per clang invocation on M1 Pro
4242 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004243 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004244 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004245
Yanray Wangbc29aef2023-11-06 11:08:17 +08004246 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004247 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004248
Dave Rodgman42436102023-10-03 15:47:05 +01004249 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004250 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4251 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4252 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4253 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004254
4255 cd "$MBEDTLS_ROOT_DIR"
4256 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4257
Yanray Wang42be1ba2023-11-23 14:28:47 +08004258 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004259 # manually set or unset those configurations to check
4260 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004261 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4262 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4263 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4264 scripts/config.py unset MBEDTLS_DES_C
4265 scripts/config.py unset MBEDTLS_NIST_KW_C
4266 build_test_config_combos library/aes.o validate_aes_config_variations \
4267 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4268 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4269 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4270 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004271}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004272
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004273component_test_no_platform () {
4274 # Full configuration build, without platform support, file IO and net sockets.
4275 # This should catch missing mbedtls_printf definitions, and by disabling file
4276 # IO, it should catch missing '#include <stdio.h>'
4277 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004278 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004279 scripts/config.py unset MBEDTLS_PLATFORM_C
4280 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004281 scripts/config.py unset MBEDTLS_FS_IO
4282 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004283 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004284 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004285 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004286 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004287 # to re-enable platform integration features otherwise disabled in C99 builds
4288 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004289 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004290}
Gilles Peskine7c652162017-12-11 00:01:40 +01004291
4292component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004293 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004294 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4295 scripts/config.py full
4296 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004297 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4298 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4299 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4300 make
4301}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004302
Gilles Peskine8f073122018-11-27 15:58:47 +01004303component_build_no_ssl_srv () {
4304 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004305 scripts/config.py full
4306 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004307 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004308}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004309
Gilles Peskine8f073122018-11-27 15:58:47 +01004310component_build_no_ssl_cli () {
4311 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004312 scripts/config.py full
4313 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004314 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004315}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004316
Gilles Peskine8f073122018-11-27 15:58:47 +01004317component_build_no_sockets () {
4318 # Note, C99 compliance can also be tested with the sockets support disabled,
4319 # as that requires a POSIX platform (which isn't the same as C99).
4320 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004321 scripts/config.py full
4322 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4323 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4324 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4325}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004326
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004327component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004328 msg "build: default config with memory buffer allocator and backtrace enabled"
4329 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4330 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4331 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004332 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4333 CC=gcc cmake -DCMAKE_BUILD_TYPE:String=Release .
4334 make
4335
4336 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4337 make test
4338}
4339
4340component_test_memory_buffer_allocator () {
4341 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004342 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4343 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004344 CC=gcc cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004345 make
4346
4347 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4348 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004349
4350 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4351 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004352 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004353}
4354
Gilles Peskine8f073122018-11-27 15:58:47 +01004355component_test_no_max_fragment_length () {
4356 # Run max fragment length tests with MFL disabled
4357 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004358 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004359 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004360 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004361
Gilles Peskine8f073122018-11-27 15:58:47 +01004362 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004363 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004364}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004365
Hanno Becker545ced42019-02-19 11:10:48 +00004366component_test_asan_remove_peer_certificate () {
4367 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004368 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Dave Rodgman17127e92023-12-14 16:42:48 +00004369 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004370 make
4371
4372 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4373 make test
4374
4375 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004376 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004377
4378 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004379 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004380
4381 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004382 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004383}
4384
Gilles Peskine8f073122018-11-27 15:58:47 +01004385component_test_no_max_fragment_length_small_ssl_out_content_len () {
4386 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004387 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4388 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4389 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004390 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004391 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004392
Gilles Peskine8f073122018-11-27 15:58:47 +01004393 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004394 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004395
4396 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004397 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004398}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004399
Darryl Greenaad82f92019-12-02 10:53:11 +00004400component_test_variable_ssl_in_out_buffer_len () {
4401 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4402 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004403 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004404 make
4405
4406 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4407 make test
4408
4409 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004410 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004411
4412 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004413 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004414}
4415
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004416component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004417 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004418 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004419
Dave Rodgman17127e92023-12-14 16:42:48 +00004420 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004421 make
4422
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004423 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004424 make test
4425
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004426 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004427 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004428
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004429 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004430 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004431}
4432
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004433component_test_ssl_alloc_buffer_and_mfl () {
4434 msg "build: default config with memory buffer allocator and MFL extension"
4435 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4436 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4437 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4438 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4439 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004440 CC=gcc cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004441 make
4442
4443 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4444 make test
4445
4446 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 +02004447 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004448}
4449
Gilles Peskine636c26a2020-03-04 20:46:15 +01004450component_test_when_no_ciphersuites_have_mac () {
4451 msg "build: when no ciphersuites have MAC"
4452 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004453 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004454 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004455 make
4456
4457 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4458 make test
4459
4460 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004461 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004462}
4463
Raoul Strackxa4e86142020-06-15 17:03:13 +02004464component_test_no_date_time () {
4465 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4466 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004467 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004468 make
4469
4470 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4471 make test
4472}
4473
Gilles Peskine8f073122018-11-27 15:58:47 +01004474component_test_platform_calloc_macro () {
4475 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004476 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4477 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4478 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004479 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004480 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004481
Gilles Peskine8f073122018-11-27 15:58:47 +01004482 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4483 make test
4484}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004485
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004486component_test_malloc_0_null () {
4487 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004488 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004489 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 +02004490
4491 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4492 make test
4493
4494 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4495 # Just the calloc selftest. "make test" ran the others as part of the
4496 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004497 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004498
4499 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4500 # Run a subset of the tests. The choice is a balance between coverage
4501 # and time (including time indirectly wasted due to flaky tests).
4502 # The current choice is to skip tests whose description includes
4503 # "proxy", which is an approximation of skipping tests that use the
4504 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004505 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004506}
4507
Dave Rodgman6a08b682023-06-19 11:51:33 +01004508support_test_aesni() {
4509 # Check that gcc targets x86_64 (we can build AESNI), and check for
4510 # AESNI support on the host (we can run AESNI).
4511 #
4512 # The name of this function is possibly slightly misleading, but needs to align
4513 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004514 #
4515 # In principle 32-bit x86 can support AESNI, but our implementation does not
4516 # support 32-bit x86, so we check for x86-64.
4517 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004518 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4519 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004520 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004521}
4522
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004523component_test_aesni () { # ~ 60s
4524 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4525 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4526 #
4527 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4528 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4529 # exercise the plain C impl).
4530
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004531 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004532 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004533 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004534 scripts/config.py set MBEDTLS_HAVE_ASM
4535
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004536 # test the intrinsics implementation
4537 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004538 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004539 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004540 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004541 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004542
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004543 # test the asm implementation
4544 msg "AES tests, test assembly"
4545 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004546 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004547 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004548 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004549
4550 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004551 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004552 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004553 msg "AES tests, plain C"
4554 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004555 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004556 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004557 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004558 not grep -q "AES note: using AESNI" ./programs/test/selftest
4559 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004560
4561 # test the intrinsics implementation
4562 scripts/config.py set MBEDTLS_AESNI_C
4563 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4564 msg "AES tests, test AESNI only"
4565 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004566 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004567 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4568 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004569 grep -q "AES note: using AESNI" ./programs/test/selftest
4570 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004571}
4572
Jerry Yub6d39c22023-08-16 15:11:48 +08004573support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004574 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004575}
4576
4577component_test_aesni_m32 () { # ~ 60s
4578 # This tests are duplicated from component_test_aesni for i386 target
4579 #
4580 # AESNI intrinsic code supports i386 and assembly code does not support it.
4581
4582 msg "build: default config with different AES implementations"
4583 scripts/config.py set MBEDTLS_AESNI_C
4584 scripts/config.py set MBEDTLS_PADLOCK_C
4585 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4586 scripts/config.py set MBEDTLS_HAVE_ASM
4587
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004588 # test the intrinsics implementation with gcc
4589 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004590 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004591 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004592 # check that we built intrinsics - this should be used by default when supported by the compiler
4593 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4594 grep -q "AES note: using AESNI" ./programs/test/selftest
4595 grep -q "AES note: built-in implementation." ./programs/test/selftest
4596 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4597 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4598
4599 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004600 scripts/config.py unset MBEDTLS_PADLOCK_C
4601 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4602 msg "AES tests, test AESNI only"
4603 make clean
4604 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4605 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4606 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4607 grep -q "AES note: using AESNI" ./programs/test/selftest
4608 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4609 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4610 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4611}
4612
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004613support_test_aesni_m32_clang() {
4614 support_test_aesni_m32 && if command -v clang > /dev/null ; then
4615 # clang >= 4 is required to build with target attributes
4616 clang_ver="$(clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#')"
4617 [[ "${clang_ver}" -ge 4 ]]
4618 else
4619 # clang not available
4620 false
4621 fi
4622}
4623
4624component_test_aesni_m32_clang() {
4625
4626 scripts/config.py set MBEDTLS_AESNI_C
4627 scripts/config.py set MBEDTLS_PADLOCK_C
4628 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4629 scripts/config.py set MBEDTLS_HAVE_ASM
4630
4631 # test the intrinsics implementation with clang
4632 msg "AES tests, test intrinsics (clang)"
4633 make clean
4634 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4635 # check that we built intrinsics - this should be used by default when supported by the compiler
4636 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4637 grep -q "AES note: using AESNI" ./programs/test/selftest
4638 grep -q "AES note: built-in implementation." ./programs/test/selftest
4639 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4640 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4641}
4642
Jerry Yu193cbc02023-08-03 17:06:29 +08004643# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4644component_build_aes_aesce_armcc () {
4645 msg "Build: AESCE test on arm64 platform without plain C."
4646 scripts/config.py baremetal
4647
4648 # armc[56] don't support SHA-512 intrinsics
4649 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4650
4651 # Stop armclang warning about feature detection for A64_CRYPTO.
4652 # With this enabled, the library does build correctly under armclang,
4653 # but in baremetal builds (as tested here), feature detection is
4654 # unavailable, and the user is notified via a #warning. So enabling
4655 # this feature would prevent us from building with -Werror on
4656 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004657 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004658 scripts/config.py set MBEDTLS_HAVE_ASM
4659
4660 msg "AESCE, build with default configuration."
4661 scripts/config.py set MBEDTLS_AESCE_C
4662 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4663 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4664
4665 msg "AESCE, build AESCE only"
4666 scripts/config.py set MBEDTLS_AESCE_C
4667 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4668 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4669}
4670
Dave Rodgman0c584032023-10-08 12:26:54 +01004671support_build_aes_armce() {
4672 # clang >= 4 is required to build with AES extensions
4673 ver="$(clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#')"
Dave Rodgman48b965d2023-10-09 12:19:44 +01004674 [ "${ver}" -ge 11 ]
Dave Rodgman0c584032023-10-08 12:26:54 +01004675}
4676
4677component_build_aes_armce () {
4678 # Test variations of AES with Armv8 crypto extensions
4679 scripts/config.py set MBEDTLS_AESCE_C
4680 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4681
4682 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004683 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004684
4685 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4686 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4687
4688 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4689 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4690
Dave Rodgman5e419372023-10-23 15:30:20 +01004691 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004692
Dave Rodgman5e419372023-10-23 15:30:20 +01004693 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4694 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004695
Dave Rodgman5e419372023-10-23 15:30:20 +01004696 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4697 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004698
Dave Rodgman5e419372023-10-23 15:30:20 +01004699 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4700 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004701
4702 # test for presence of AES instructions
4703 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4704 msg "clang, test A32 crypto instructions built"
4705 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4706 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4707 msg "clang, test T32 crypto instructions built"
4708 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4709 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4710 msg "clang, test aarch64 crypto instructions built"
4711 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4712 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4713
4714 # test for absence of AES instructions
4715 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4716 scripts/config.py unset MBEDTLS_AESCE_C
4717 msg "clang, test A32 crypto instructions not built"
4718 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4719 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4720 msg "clang, test T32 crypto instructions not built"
4721 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4722 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4723 msg "clang, test aarch64 crypto instructions not built"
4724 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4725 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004726}
4727
Dave Rodgman9ed18532023-10-05 00:06:47 +01004728support_build_sha_armce() {
Dave Rodgmanf2ea08a2023-10-16 11:37:28 +01004729 if command -v clang > /dev/null ; then
Dave Rodgmand35b1882023-10-16 10:25:30 +01004730 # clang >= 4 is required to build with SHA extensions
4731 clang_ver="$(clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#')"
Dave Rodgmanab0cff52023-10-13 09:32:04 +01004732
Dave Rodgman66d55122023-10-23 15:12:32 +01004733 [[ "${clang_ver}" -ge 4 ]]
Dave Rodgmand35b1882023-10-16 10:25:30 +01004734 else
4735 # clang not available
4736 false
4737 fi
Dave Rodgman9ed18532023-10-05 00:06:47 +01004738}
4739
Dave Rodgmand9e80832023-10-04 17:17:46 +01004740component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004741 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004742
4743
4744 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004745 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004746 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4747 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4748 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4749 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4750 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004751
Dave Rodgmand9e80832023-10-04 17:17:46 +01004752
Dave Rodgman94a634d2023-10-10 12:59:29 +01004753 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004754 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004755 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4756 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4757 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004758
Dave Rodgman5b89c552023-10-10 14:59:02 +01004759 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004760 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4761 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4762 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004763
Dave Rodgmancd654002023-10-05 09:40:07 +01004764
Dave Rodgman94a634d2023-10-10 12:59:29 +01004765 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004766 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004767 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4768 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4769 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4770 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4771 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004772
Dave Rodgmancd654002023-10-05 09:40:07 +01004773
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004774 # examine the disassembly for presence of SHA instructions
4775 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4776 scripts/config.py set ${opt}
4777 msg "${opt} clang, test A32 crypto instructions built"
4778 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4779 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4780
4781 msg "${opt} clang, test T32 crypto instructions built"
4782 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4783 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4784
4785 msg "${opt} clang, test aarch64 crypto instructions built"
4786 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4787 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4788 scripts/config.py unset ${opt}
4789 done
4790
4791
4792 # examine the disassembly for absence of SHA instructions
4793 msg "clang, test A32 crypto instructions not built"
4794 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4795 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4796
4797 msg "clang, test T32 crypto instructions not built"
4798 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4799 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4800
4801 msg "clang, test aarch64 crypto instructions not built"
4802 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4803 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004804}
4805
Jerry Yuc935aa62023-08-03 17:08:27 +08004806# For timebeing, no VIA Padlock platform available.
4807component_build_aes_via_padlock () {
4808
4809 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004810 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004811 scripts/config.py set MBEDTLS_PADLOCK_C
4812 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00004813 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004814 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004815
4816}
4817
4818support_build_aes_via_padlock_only () {
4819 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4820 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4821 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4822}
4823
Jerry Yu193cbc02023-08-03 17:06:29 +08004824support_build_aes_aesce_armcc () {
4825 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004826}
4827
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004828component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004829 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004830 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004831 scripts/config.py unset MBEDTLS_PADLOCK_C
4832
4833 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004834
Gilles Peskine8f073122018-11-27 15:58:47 +01004835 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4836 make test
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004837}
4838
Gilles Peskine8f073122018-11-27 15:58:47 +01004839component_test_no_ctr_drbg_aes_only_128_bit_keys () {
Hanno Becker83ebf782017-07-07 12:29:15 +01004840 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine8f073122018-11-27 15:58:47 +01004841 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4842 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4843 scripts/config.py unset MBEDTLS_PADLOCK_C
4844
Gilles Peskine592f5912019-10-07 18:49:32 +02004845 make CC=clang CFLAGS='-Werror -Wall -Wextra'
4846
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004847 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4848 make test
4849}
Gilles Peskine592f5912019-10-07 18:49:32 +02004850
4851component_test_aes_only_128_bit_keys_have_builtins () {
4852 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4853 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4854 scripts/config.py unset MBEDTLS_PADLOCK_C
4855 scripts/config.py unset MBEDTLS_AESNI_C
4856 scripts/config.py unset MBEDTLS_AESCE_C
4857
4858 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004859
4860 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4861 make test
Gilles Peskine592f5912019-10-07 18:49:32 +02004862
4863 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4864 programs/test/selftest
4865}
4866
4867component_test_aes_fewer_tables () {
4868 msg "build: default config with AES_FEWER_TABLES enabled"
4869 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4870 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004871
4872 msg "test: AES_FEWER_TABLES"
4873 make test
4874}
Gilles Peskine592f5912019-10-07 18:49:32 +02004875
4876component_test_aes_rom_tables () {
4877 msg "build: default config with AES_ROM_TABLES enabled"
4878 scripts/config.py set MBEDTLS_AES_ROM_TABLES
4879 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
4880
4881 msg "test: AES_ROM_TABLES"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02004882 make test
4883}
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004884
Gilles Peskine004206c2019-10-21 17:11:33 +02004885component_test_aes_fewer_tables_and_rom_tables () {
Gilles Peskinef96aefe2019-07-24 14:58:38 +02004886 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4887 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
4888 scripts/config.py set MBEDTLS_AES_ROM_TABLES
4889 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
4890
Steven Cooremand57203d2020-07-16 20:28:59 +02004891 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
Ronald Cron32a432a2023-03-28 09:19:04 +02004892 make test
Steven Cooreman753f9732021-03-15 11:38:44 +01004893}
Steven Cooreman6801f082021-02-19 17:21:22 +01004894
Yanray Wang49cd4b52023-11-10 11:58:37 +08004895# helper for common_block_cipher_no_decrypt() which:
4896# - enable/disable the list of config options passed from -s/-u respectively.
4897# - build
4898# - test for tests_suite_xxx
4899# - selftest
4900#
4901# Usage: helper_block_cipher_no_decrypt_build_test
4902# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
4903# Options: -s set_opts the list of config options to enable
4904# -u unset_opts the list of config options to disable
4905# -c cflags the list of options passed to CFLAGS
4906# -l ldflags the list of options passed to LDFLAGS
4907helper_block_cipher_no_decrypt_build_test () {
4908 while [ $# -gt 0 ]; do
4909 case "$1" in
4910 -s)
4911 shift; local set_opts="$1";;
4912 -u)
4913 shift; local unset_opts="$1";;
4914 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08004915 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08004916 -l)
4917 shift; local ldflags="$1";;
4918 esac
4919 shift
4920 done
4921 set_opts="${set_opts:-}"
4922 unset_opts="${unset_opts:-}"
4923 cflags="${cflags:-}"
4924 ldflags="${ldflags:-}"
4925
Yanray Wangb2d6e522023-11-13 16:57:47 +08004926 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
4927 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08004928
4929 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4930 make clean
4931 make CC=gcc CFLAGS="$cflags" LDFLAGS="$ldflags"
4932
4933 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
4934 not grep mbedtls_aes_setkey_dec library/aes.o
4935 not grep mbedtls_aria_setkey_dec library/aria.o
4936 not grep mbedtls_camellia_setkey_dec library/camellia.o
4937 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
4938 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08004939 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
4940 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08004941
4942 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4943 make test
4944
4945 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
4946 programs/test/selftest
4947}
4948
4949# This is a common configuration function used in:
4950# - component_test_block_cipher_no_decrypt_aesni_legacy()
4951# - component_test_block_cipher_no_decrypt_aesni_use_psa()
4952# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
4953# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
4954# on x86.
4955common_block_cipher_no_decrypt () {
4956 # test AESNI intrinsics
4957 helper_block_cipher_no_decrypt_build_test \
4958 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004959 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004960
4961 # test AESNI assembly
4962 helper_block_cipher_no_decrypt_build_test \
4963 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004964 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004965
4966 # test AES C implementation
4967 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08004968 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08004969
4970 # test AESNI intrinsics for i386 target
4971 helper_block_cipher_no_decrypt_build_test \
4972 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08004973 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08004974 -l "-m32"
4975}
4976
Yanray Wang3ae11992023-11-13 17:32:09 +08004977# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
4978# usage: 0: no PSA crypto configuration
4979# 1: use PSA crypto configuration
4980config_block_cipher_no_decrypt () {
4981 use_psa=$1
4982
Yanray Wang66111392023-10-31 18:54:54 +08004983 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004984 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4985 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08004986 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08004987 scripts/config.py unset MBEDTLS_NIST_KW_C
4988
Yanray Wang3ae11992023-11-13 17:32:09 +08004989 if [ "$use_psa" -eq 1 ]; then
4990 # Enable support for cryptographic mechanisms through the PSA API.
4991 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
4992 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
4993 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4994 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4995 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
4996 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
4997 fi
4998}
4999
5000component_test_block_cipher_no_decrypt_aesni () {
5001 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005002 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005003}
5004
Yanray Wangf1496402023-11-01 18:55:13 +08005005component_test_block_cipher_no_decrypt_aesni_use_psa () {
Yanray Wang3ae11992023-11-13 17:32:09 +08005006 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005007 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005008}
5009
Yanray Wang66111392023-10-31 18:54:54 +08005010support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005011 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005012}
5013
Yanray Wang66111392023-10-31 18:54:54 +08005014component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005015 scripts/config.py baremetal
5016
5017 # armc[56] don't support SHA-512 intrinsics
5018 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5019
5020 # Stop armclang warning about feature detection for A64_CRYPTO.
5021 # With this enabled, the library does build correctly under armclang,
5022 # but in baremetal builds (as tested here), feature detection is
5023 # unavailable, and the user is notified via a #warning. So enabling
5024 # this feature would prevent us from building with -Werror on
5025 # armclang. Tracked in #7198.
5026 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5027 scripts/config.py set MBEDTLS_HAVE_ASM
5028
Yanray Wang3ae11992023-11-13 17:32:09 +08005029 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005030
5031 # test AESCE baremetal build
5032 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005033 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005034 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005035
Yanray Wangef1b04d2023-09-08 11:09:26 +08005036 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5037 not grep mbedtls_aes_setkey_dec library/aes.o
5038 not grep mbedtls_aria_setkey_dec library/aria.o
5039 not grep mbedtls_camellia_setkey_dec library/camellia.o
5040 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5041 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005042 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005043 not grep mbedtls_aesce_inverse_key library/aesce.o
5044 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005045}
5046
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005047component_test_ctr_drbg_aes_256_sha_256 () {
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005048 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5049 scripts/config.py full
5050 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5051 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005052 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01005053 make
5054
5055 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5056 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005057}
5058
Gilles Peskine14c3c062018-01-29 21:25:12 +01005059component_test_ctr_drbg_aes_128_sha_512 () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005060 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5061 scripts/config.py full
5062 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5063 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005064 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005065 make
5066
5067 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5068 make test
5069}
5070
5071component_test_ctr_drbg_aes_128_sha_256 () {
5072 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005073 scripts/config.py full
5074 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5075 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5076 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005077 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005078 make
5079
Gilles Peskine8f073122018-11-27 15:58:47 +01005080 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5081 make test
5082}
5083
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005084component_test_se_default () {
5085 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5086 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
5087 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
5088
5089 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5090 make test
5091}
5092
Steven Cooremand57203d2020-07-16 20:28:59 +02005093component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005094 msg "build: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005095 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005096 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005097 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5098 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005099 loc_cflags="${loc_cflags} -I../tests/include -O2"
5100
Gilles Peskine21570cf2023-12-22 11:49:50 +01005101 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005102
Gilles Peskine1997f302023-07-26 18:45:20 +02005103 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005104 make test
5105}
5106
Gilles Peskine8f073122018-11-27 15:58:47 +01005107component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005108 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005109 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005110 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005111 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005112}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005113
Gilles Peskinecf740502019-07-03 20:43:05 +02005114component_test_cmake_shared () {
5115 msg "build/test: cmake shared" # ~ 2min
5116 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5117 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005118 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005119 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005120 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005121}
5122
Gilles Peskineec10bf12019-09-20 19:56:06 +02005123test_build_opt () {
5124 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005125 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005126 for opt in "$@"; do
5127 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005128 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005129 # We're confident enough in compilers to not run _all_ the tests,
5130 # but at least run the unit tests. In particular, runs with
5131 # optimizations use inline assembly whereas runs with -O0
5132 # skip inline assembly.
5133 make test # ~30s
5134 make clean
5135 done
5136}
5137
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005138# For FreeBSD we invoke the function by name so this condition is added
5139# to disable the existing test_clang_opt function for linux.
5140if [[ $(uname) != "Linux" ]]; then
5141 component_test_clang_opt () {
5142 scripts/config.py full
5143 test_build_opt 'full config' clang -O0 -Os -O2
5144 }
5145fi
5146
5147component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005148 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005149 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005150}
5151support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005152 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005153}
5154
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005155component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005156 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005157 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005158}
5159support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005160 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005161}
5162
5163component_test_gcc_latest_opt () {
5164 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005165 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005166}
5167support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005168 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005169}
5170
5171component_test_gcc_earliest_opt () {
5172 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005173 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005174}
5175support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005176 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005177}
5178
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005179component_build_mbedtls_config_file () {
5180 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005181 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005182 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005183 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005184 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005185 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5186 make clean
5187
5188 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5189 # In the user config, disable one feature (for simplicity, pick a feature
5190 # that nothing else depends on).
5191 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005192 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005193 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5194
5195 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005196}
5197
Gilles Peskine7d904e72022-04-07 21:59:14 +02005198component_build_psa_config_file () {
5199 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5200 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5201 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5202 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5203 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005204 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005205 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5206 make clean
5207
5208 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
5209 # In the user config, disable one feature, which will reflect on the
5210 # mbedtls configuration so we can query it with query_compile_time_config.
5211 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
5212 scripts/config.py unset MBEDTLS_CMAC_C
5213 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5214 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5215
5216 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005217}
5218
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005219component_build_psa_alt_headers () {
5220 msg "build: make with PSA alt headers" # ~20s
5221
5222 # Generate alternative versions of the substitutable headers with the
5223 # same content except different include guards.
5224 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5225
5226 # Build the library and some programs.
5227 # Don't build the fuzzers to avoid having to go through hoops to set
5228 # a correct include path for programs/fuzz/Makefile.
5229 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
5230 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\"'"
5231
5232 # Check that we're getting the alternative include guards and not the
5233 # original include guards.
5234 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5235 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5236 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5237 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5238}
5239
Dave Rodgman852de3c2023-12-14 14:46:45 +00005240component_test_m32_no_asm () {
5241 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005242 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005243 #
5244 # Note that we require gcc, because clang Asan builds fail to link for
5245 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005246 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005247 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005248 scripts/config.py unset MBEDTLS_HAVE_ASM
5249 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005250 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005251 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005252
Dave Rodgman852de3c2023-12-14 14:46:45 +00005253 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005254 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005255}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005256support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005257 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005258 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005259 *) false;;
5260 esac
5261}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005262
Gilles Peskineff0aee02021-10-05 09:36:03 +02005263component_test_m32_o2 () {
5264 # Build with optimization, to use the i386 specific inline assembly
5265 # and go faster for tests.
5266 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005267 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005268 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005269 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005270
Gilles Peskineff0aee02021-10-05 09:36:03 +02005271 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005272 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005273
Gilles Peskineff0aee02021-10-05 09:36:03 +02005274 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005275 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005276}
Gilles Peskinecf522222021-10-07 19:25:29 +02005277support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005278 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005279}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005280
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005281component_test_m32_everest () {
5282 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005283 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005284 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005285 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005286
5287 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5288 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005289
5290 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005291 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005292
5293 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5294 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005295 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005296}
5297support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005298 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005299}
5300
Gilles Peskine8f073122018-11-27 15:58:47 +01005301component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005302 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005303 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01005304 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005305
5306 msg "test: 64-bit ILP32, make, gcc"
5307 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005308}
Gilles Peskine878cf602019-01-06 20:50:38 +00005309support_test_mx32 () {
5310 case $(uname -m) in
5311 amd64|x86_64) true;;
5312 *) false;;
5313 esac
5314}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005315
Peter Kolbus60c6da22018-12-27 06:59:04 -06005316component_test_min_mpi_window_size () {
5317 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005318 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005319 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005320 make
5321
5322 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5323 make test
5324}
5325
Gilles Peskine8f073122018-11-27 15:58:47 +01005326component_test_have_int32 () {
5327 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005328 scripts/config.py unset MBEDTLS_HAVE_ASM
5329 scripts/config.py unset MBEDTLS_AESNI_C
5330 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005331 scripts/config.py unset MBEDTLS_AESCE_C
Gilles Peskine8f073122018-11-27 15:58:47 +01005332 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005333
Gilles Peskine8f073122018-11-27 15:58:47 +01005334 msg "test: gcc, force 32-bit bignum limbs"
5335 make test
5336}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005337
Gilles Peskine8f073122018-11-27 15:58:47 +01005338component_test_have_int64 () {
5339 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005340 scripts/config.py unset MBEDTLS_HAVE_ASM
5341 scripts/config.py unset MBEDTLS_AESNI_C
5342 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005343 scripts/config.py unset MBEDTLS_AESCE_C
Gilles Peskine8f073122018-11-27 15:58:47 +01005344 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005345
Gilles Peskine8f073122018-11-27 15:58:47 +01005346 msg "test: gcc, force 64-bit bignum limbs"
5347 make test
5348}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005349
Gabor Mezeie256cc12023-07-26 17:28:48 +02005350component_test_have_int32_cmake_new_bignum () {
5351 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5352 scripts/config.py unset MBEDTLS_HAVE_ASM
5353 scripts/config.py unset MBEDTLS_AESNI_C
5354 scripts/config.py unset MBEDTLS_PADLOCK_C
5355 scripts/config.py unset MBEDTLS_AESCE_C
5356 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005357 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005358 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005359
5360 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5361 make test
5362}
5363
Gilles Peskine8f073122018-11-27 15:58:47 +01005364component_test_no_udbl_division () {
5365 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005366 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005367 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005368 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005369
Gilles Peskine8f073122018-11-27 15:58:47 +01005370 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5371 make test
5372}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005373
Gilles Peskine8f073122018-11-27 15:58:47 +01005374component_test_no_64bit_multiplication () {
5375 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005376 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005377 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005378 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005379
Gilles Peskine8f073122018-11-27 15:58:47 +01005380 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5381 make test
5382}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005383
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005384component_test_no_strings () {
5385 msg "build: no strings" # ~10s
5386 scripts/config.py full
5387 # Disable options that activate a large amount of string constants.
5388 scripts/config.py unset MBEDTLS_DEBUG_C
5389 scripts/config.py unset MBEDTLS_ERROR_C
5390 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5391 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005392 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005393
5394 msg "test: no strings" # ~ 10s
5395 make test
5396}
5397
Hanno Beckerc5722d12020-10-09 11:10:42 +01005398component_test_no_x509_info () {
5399 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5400 scripts/config.pl full
5401 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5402 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005403 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005404
5405 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5406 make test
5407
5408 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005409 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005410}
5411
Gilles Peskine8f073122018-11-27 15:58:47 +01005412component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005413 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005414 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005415 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 +02005416
Gilles Peskinee36fe812021-09-01 20:00:33 +02005417 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005418 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005419}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005420
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005421component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005422 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005423 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005424 # Build for a target platform that's close to what Debian uses
5425 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005426 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005427 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005428 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005429 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'
5430
Gilles Peskinee36fe812021-09-01 20:00:33 +02005431 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005432 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005433}
5434support_build_arm_linux_gnueabi_gcc_arm5vte () {
5435 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5436}
5437
5438component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005439 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005440 scripts/config.py baremetal
5441 # This is an imperfect substitute for
5442 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005443 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005444 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 +02005445
Gilles Peskinee36fe812021-09-01 20:00:33 +02005446 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005447 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005448}
5449
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005450component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005451 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5452 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005453 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 +02005454
Gilles Peskinee36fe812021-09-01 20:00:33 +02005455 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005456 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005457 for lib in library/*.a; do
5458 echo "$lib:"
5459 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5460 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005461}
5462
Gilles Peskine8f073122018-11-27 15:58:47 +01005463component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005464 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005465 scripts/config.py baremetal
5466 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005467 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 +01005468 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005469 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005470}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005471
Gilles Peskine8f073122018-11-27 15:58:47 +01005472component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005473 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005474 scripts/config.py baremetal
5475 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005476 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 +01005477 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005478 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005479}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005480
Dave Rodgman8c315f22023-06-02 10:26:24 -04005481component_build_arm_clang_thumb () {
5482 # ~ 30s
5483
5484 scripts/config.py baremetal
5485
5486 msg "build: clang thumb 2, make"
5487 make clean
5488 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5489
5490 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5491 msg "build: clang thumb 1 -O0, make"
5492 make clean
5493 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5494
5495 msg "build: clang thumb 1 -Os, make"
5496 make clean
5497 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5498}
5499
Gilles Peskine8f073122018-11-27 15:58:47 +01005500component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005501 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005502 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005503 # armc[56] don't support SHA-512 intrinsics
5504 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005505
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005506 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5507 scripts/config.py unset MBEDTLS_AESCE_C
5508
Dave Rodgman0fddf822023-03-02 15:32:12 +00005509 # Stop armclang warning about feature detection for A64_CRYPTO.
5510 # With this enabled, the library does build correctly under armclang,
5511 # but in baremetal builds (as tested here), feature detection is
5512 # unavailable, and the user is notified via a #warning. So enabling
5513 # this feature would prevent us from building with -Werror on
5514 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005515 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005516
Hanno Beckerf0762e92022-07-15 12:08:19 +01005517 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005518
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005519 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005520
5521 msg "size: ARM Compiler 5"
5522 "$ARMC5_FROMELF" -z library/*.o
5523
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005524 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005525
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005526 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005527 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005528
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005529 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005530 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5531
5532 # ARM Compiler 6 - Target ARMv7-M+DSP
5533 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005534
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005535 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005536 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005537
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005538 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005539 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005540
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005541 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5542 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5543
Dave Rodgman99318e62023-05-24 12:27:42 +01005544 # ARM Compiler 6 - Target Cortex-M0
5545 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005546
5547 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5548 #
5549 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5550 # that we have in our CI
5551 scripts/config.py set MBEDTLS_AESCE_C
5552 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005553}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005554
Pengyu Lvdf070032023-02-24 16:03:31 +08005555support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005556 armc5_cc="$ARMC5_BIN_DIR/armcc"
5557 armc6_cc="$ARMC6_BIN_DIR/armclang"
5558 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005559}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005560
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005561component_test_tls13_only () {
5562 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3, without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005563 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Jerry Yuda5af222021-12-24 18:45:45 +08005564 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5565
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005566 msg "test: TLS 1.3 only, all key exchange modes enabled"
5567 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005568
Ronald Cronc3f43b62022-10-17 17:35:32 +02005569 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5570 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005571}
5572
Ronald Cronc3f43b62022-10-17 17:35:32 +02005573component_test_tls13_only_psk () {
5574 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5575 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5576 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5577 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005578 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005579 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5580 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5581 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5582 scripts/config.py unset MBEDTLS_ECDSA_C
5583 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005584 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005585 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005586 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5587
Ronald Cronc3f43b62022-10-17 17:35:32 +02005588 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5589 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005590
Ronald Cronc3f43b62022-10-17 17:35:32 +02005591 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5592 tests/ssl-opt.sh
5593}
5594
5595component_test_tls13_only_ephemeral () {
5596 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5597 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5598 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005599 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005600 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5601
5602 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5603 cd tests; ./test_suite_ssl; cd ..
5604
5605 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5606 tests/ssl-opt.sh
5607}
5608
Przemek Stekiela01c2422023-06-13 10:46:48 +02005609component_test_tls13_only_ephemeral_ffdh () {
5610 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5611 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5612 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5613 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005614 scripts/config.py unset MBEDTLS_ECDH_C
5615
Przemek Stekiela01c2422023-06-13 10:46:48 +02005616 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5617
5618 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5619 cd tests; ./test_suite_ssl; cd ..
5620
5621 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5622 tests/ssl-opt.sh
5623}
5624
Ronald Cronc3f43b62022-10-17 17:35:32 +02005625component_test_tls13_only_psk_ephemeral () {
5626 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5627 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5628 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5629 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5630 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5631 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5632 scripts/config.py unset MBEDTLS_ECDSA_C
5633 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005634 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005635 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005636 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5637
5638 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5639 cd tests; ./test_suite_ssl; cd ..
5640
5641 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5642 tests/ssl-opt.sh
5643}
5644
Przemek Stekiela01c2422023-06-13 10:46:48 +02005645component_test_tls13_only_psk_ephemeral_ffdh () {
5646 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5647 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5648 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5649 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5650 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5651 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5652 scripts/config.py unset MBEDTLS_ECDSA_C
5653 scripts/config.py unset MBEDTLS_PKCS1_V21
5654 scripts/config.py unset MBEDTLS_PKCS7_C
5655 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005656 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005657 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5658
5659 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5660 cd tests; ./test_suite_ssl; cd ..
5661
5662 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5663 tests/ssl-opt.sh
5664}
5665
Ronald Cronc3f43b62022-10-17 17:35:32 +02005666component_test_tls13_only_psk_all () {
5667 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5668 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5669 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5670 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5671 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5672 scripts/config.py unset MBEDTLS_ECDSA_C
5673 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005674 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005675 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005676 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5677
5678 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5679 cd tests; ./test_suite_ssl; cd ..
5680
5681 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5682 tests/ssl-opt.sh
5683}
5684
5685component_test_tls13_only_ephemeral_all () {
5686 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5687 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005688 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005689 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5690
5691 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5692 cd tests; ./test_suite_ssl; cd ..
5693
5694 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5695 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005696}
5697
Ronald Cron6f135e12021-12-08 16:57:54 +01005698component_test_tls13 () {
5699 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5700 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005701 scripts/config.py set MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5702 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005703 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005704 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005705 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005706 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005707 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005708 msg "ssl-opt.sh (TLS 1.3)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005709 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005710}
5711
Ronald Cron6f135e12021-12-08 16:57:54 +01005712component_test_tls13_no_compatibility_mode () {
5713 msg "build: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
5714 scripts/config.py set MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005715 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
5716 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005717 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005718 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005719 make
Ronald Cron6f135e12021-12-08 16:57:54 +01005720 msg "test: default config with MBEDTLS_SSL_PROTO_TLS1_3 enabled, without padding"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005721 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005722 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005723 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005724}
5725
Jan Bruckner151f6422023-02-10 12:45:19 +01005726component_test_tls13_only_record_size_limit () {
5727 msg "build: TLS 1.3 only from default, record size limit extension enabled"
5728 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
5729 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5730
5731 msg "test_suite_ssl: TLS 1.3 only, record size limit extension enabled"
5732 cd tests; ./test_suite_ssl; cd ..
5733
5734 msg "ssl-opt.sh: (TLS 1.3 only, record size limit extension tests only)"
5735 # Both the server and the client will currently abort the handshake when they encounter the
5736 # record size limit extension. There is no way to prevent gnutls-cli from sending the extension
5737 # which makes all G_NEXT_CLI + P_SRV tests fail. Thus, run only the tests for the this extension.
5738 tests/ssl-opt.sh -f "Record Size Limit"
5739}
5740
Gilles Peskine8f073122018-11-27 15:58:47 +01005741component_build_mingw () {
5742 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005743 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 +00005744
Gilles Peskine8f073122018-11-27 15:58:47 +01005745 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005746 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 +01005747 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005748
Gilles Peskine8f073122018-11-27 15:58:47 +01005749 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005750 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
5751 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 +01005752 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005753
Pengyu Lv158eead2023-10-19 11:27:05 +08005754 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005755 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005756 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 +01005757 make WINDOWS_BUILD=1 clean
5758}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005759support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005760 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5761 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005762 *) true;;
5763 esac
5764}
Simon Butcher91aef332016-11-17 09:20:50 +00005765
Gilles Peskine8f073122018-11-27 15:58:47 +01005766component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005767 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005768 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005769 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5770 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005771
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005772 msg "test: main suites (MSan)" # ~ 10s
5773 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005774
Gilles Peskine6848d172023-11-02 19:58:03 +01005775 msg "test: metatests (MSan)"
5776 tests/scripts/run-metatests.sh any msan
5777
Gilles Peskine82b27272019-06-14 18:27:03 +02005778 msg "program demos (MSan)" # ~20s
5779 tests/scripts/run_demos.py
5780
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005781 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005782 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005783
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005784 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005785
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005786 if [ "$MEMORY" -gt 0 ]; then
5787 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005788 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005789 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005790}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005791
Bence Szépkúti0354d042023-12-06 16:14:37 +01005792component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005793 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005794 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005795 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5796 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005797
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005798 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005799 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005800
Gilles Peskine636c26a2020-03-04 20:46:15 +01005801 # Optional parts (slow; currently broken on OS X because programs don't
5802 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005803 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005804 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005805 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005806 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005807 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005808
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005809 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005810 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005811 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005812 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005813
5814 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005815 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005816 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005817 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005818}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005819
Bence Szépkúti0354d042023-12-06 16:14:37 +01005820component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005821 msg "build: Release, full (clang)"
5822 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5823 scripts/config.py full
5824 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5825 make
5826
5827 msg "test: main suites, Valgrind (full config)"
5828 make memcheck
5829}
5830
Paul Elliott62dc3922021-11-25 17:29:40 +00005831support_test_cmake_out_of_source () {
5832 distrib_id=""
5833 distrib_ver=""
5834 distrib_ver_minor=""
5835 distrib_ver_major=""
5836
5837 # Attempt to parse lsb-release to find out distribution and version. If not
5838 # found this should fail safe (test is supported).
5839 if [[ -f /etc/lsb-release ]]; then
5840
5841 while read -r lsb_line; do
5842 case "$lsb_line" in
5843 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5844 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5845 esac
5846 done < /etc/lsb-release
5847
5848 distrib_ver_major="${distrib_ver%%.*}"
5849 distrib_ver="${distrib_ver#*.}"
5850 distrib_ver_minor="${distrib_ver%%.*}"
5851 fi
5852
5853 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5854 # processor (as the CI does) can create a race condition whereby the build
5855 # fails to see a generated file, despite that file actually having been
5856 # generated. This problem appears to go away with 18.04 or newer, so make
5857 # the out of source tests unsupported on Ubuntu 16.04.
5858 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5859}
5860
Gilles Peskine8f073122018-11-27 15:58:47 +01005861component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005862 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005863 # generates
5864 make neat
5865
Gilles Peskine8f073122018-11-27 15:58:47 +01005866 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005867 MBEDTLS_ROOT_DIR="$PWD"
5868 mkdir "$OUT_OF_SOURCE_DIR"
5869 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005870 # Note: Explicitly generate files as these are turned off in releases
5871 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005872 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005873
Gilles Peskine8f073122018-11-27 15:58:47 +01005874 msg "test: cmake 'out-of-source' build"
5875 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005876 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01005877 # Also ensure that there are no error messages such as
5878 # "No such file or directory", which would indicate that some required
5879 # file is missing (ssl-opt.sh tolerates the absence of some files so
5880 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02005881 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02005882 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01005883 cat ssl-opt.err >&2
5884 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005885 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02005886 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01005887 cd "$MBEDTLS_ROOT_DIR"
5888 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01005889}
Andres AGdc192212016-08-31 17:33:13 +01005890
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005891component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01005892 # Remove existing generated files so that we use the ones CMake
5893 # generates
5894 make neat
5895
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005896 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005897 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01005898 # Note: Explicitly generate files as these are turned off in releases
5899 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005900 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005901 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005902}
Gilles Peskinea3000992022-02-04 00:21:12 +01005903support_test_cmake_as_subdirectory () {
5904 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01005905}
5906
Chris Kayd259e342021-03-25 16:03:25 +00005907component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01005908 # Remove existing generated files so that we use the ones CMake
5909 # generates
5910 make neat
5911
Chris Kayd259e342021-03-25 16:03:25 +00005912 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005913 cd programs/test/cmake_package
5914 cmake .
5915 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005916 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00005917}
Gilles Peskinea3000992022-02-04 00:21:12 +01005918support_test_cmake_as_package () {
5919 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005920}
5921
5922component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01005923 # Remove existing generated files so that we use the ones CMake
5924 # generates
5925 make neat
5926
Chris Kayd259e342021-03-25 16:03:25 +00005927 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00005928 cd programs/test/cmake_package_install
5929 cmake .
5930 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005931 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00005932}
Gilles Peskinea3000992022-02-04 00:21:12 +01005933support_test_cmake_as_package_install () {
5934 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00005935}
5936
David Horstmann20550e32023-01-12 14:17:01 +00005937component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00005938 # Make a copy of config file to use for the in-tree test
5939 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00005940
5941 MBEDTLS_ROOT_DIR="$PWD"
5942 mkdir "$OUT_OF_SOURCE_DIR"
5943 cd "$OUT_OF_SOURCE_DIR"
5944
David Horstmann969c1452023-01-31 10:34:44 +00005945 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00005946 cmake "$MBEDTLS_ROOT_DIR"
5947 make
5948
5949 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
5950 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005951 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005952 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
5953 make
5954
5955 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5956 # In the user config, disable one feature (for simplicity, pick a feature
5957 # that nothing else depends on).
5958 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5959
5960 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
5961 make
5962 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5963
5964 rm -f user_config.h full_config.h
5965
5966 cd "$MBEDTLS_ROOT_DIR"
5967 rm -rf "$OUT_OF_SOURCE_DIR"
5968
5969 # Now repeat the test for an in-tree build:
5970
David Horstmann969c1452023-01-31 10:34:44 +00005971 # Restore config for the in-tree test
5972 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005973
David Horstmann969c1452023-01-31 10:34:44 +00005974 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00005975 cmake .
5976 make
5977
5978 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
5979 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00005980 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00005981 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
5982 make
5983
5984 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
5985 # In the user config, disable one feature (for simplicity, pick a feature
5986 # that nothing else depends on).
5987 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
5988
5989 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
5990 make
5991 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5992
5993 rm -f user_config.h full_config.h
5994}
5995support_build_cmake_custom_config_file () {
5996 support_test_cmake_out_of_source
5997}
5998
5999
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006000component_build_zeroize_checks () {
6001 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6002
6003 scripts/config.py full
6004
6005 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Gilles Peskine21570cf2023-12-22 11:49:50 +01006006 make CC=gcc CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-zeroize-memset.h\"' -DMBEDTLS_TEST_DEFINES_ZEROIZE -Werror -Wsizeof-pointer-memaccess"
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006007}
6008
6009
Gilles Peskine8f073122018-11-27 15:58:47 +01006010component_test_zeroize () {
6011 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6012 # different combinations of compilers and optimization flags by using an
6013 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6014 # system in all cases that the script fails, so we must manually search the
6015 # output to check whether the pass string is present and no failure strings
6016 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006017
Gilles Peskine4976e822019-01-06 19:52:22 +00006018 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6019 # about a spurious message if Gdb tries and fails, so suppress that.
6020 gdb_disable_aslr=
6021 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6022 gdb_disable_aslr='set disable-randomization off'
6023 fi
6024
Gilles Peskine8f073122018-11-27 15:58:47 +01006025 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006026 for compiler in clang gcc; do
6027 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6028 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006029 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6030 grep "The buffer was correctly zeroized" test_zeroize.log
6031 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006032 rm -f test_zeroize.log
6033 make clean
6034 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006035 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006036}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006037
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006038component_test_psa_compliance () {
6039 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Bence Szépkútica9236b2021-10-25 19:29:07 +02006040 make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006041
6042 msg "unit test: test_psa_compliance.py"
6043 ./tests/scripts/test_psa_compliance.py
6044}
6045
6046support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006047 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006048 ver="$(cmake --version)"
6049 ver="${ver#cmake version }"
6050 ver_major="${ver%%.*}"
6051
6052 ver="${ver#*.}"
6053 ver_minor="${ver%%.*}"
6054
6055 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006056}
6057
Gilles Peskinec848d222022-12-09 12:23:35 +01006058component_check_code_style () {
6059 msg "Check C code style"
6060 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006061}
6062
Gilles Peskinec848d222022-12-09 12:23:35 +01006063support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006064 case $(uncrustify --version) in
6065 *0.75.1*) true;;
6066 *) false;;
6067 esac
6068}
6069
Gilles Peskine8f073122018-11-27 15:58:47 +01006070component_check_python_files () {
6071 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006072 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006073}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006074
Joe Subbianid614c0b2021-07-29 11:18:29 +01006075component_check_test_helpers () {
6076 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006077 # unittest writes out mundane stuff like number or tests run on stderr.
6078 # Our convention is to reserve stderr for actual errors, and write
6079 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006080 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006081
Joe Subbiania25ffab2021-08-06 09:41:27 +01006082 msg "unit test: translate_ciphers.py"
6083 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006084}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006085
Jerry Yud767cc42023-03-31 15:03:55 +08006086
Gilles Peskine192c72f2017-12-21 15:59:21 +01006087################################################################
6088#### Termination
6089################################################################
6090
Gilles Peskine8f073122018-11-27 15:58:47 +01006091post_report () {
6092 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006093 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006094
Gilles Peskine8f073122018-11-27 15:58:47 +01006095 final_report
6096}
6097
6098
6099
6100################################################################
6101#### Run all the things
6102################################################################
6103
Gilles Peskine5d996822020-03-28 21:09:21 +01006104# Function invoked by --error-test to test error reporting.
6105pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006106 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006107 if [ $KEEP_GOING -ne 0 ]; then
6108 echo "Expect three failing commands."
6109 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006110 # If the component doesn't run in a subshell, changing error_test_i to an
6111 # invalid integer will cause an error in the loop that runs this function.
6112 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006113 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006114 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006115 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006116 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006117 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006118 make unknown_target
6119 false "this should not be executed"
6120}
6121
Gilles Peskinee48351a2018-11-27 16:06:30 +01006122# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006123run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006124 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006125 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006126
6127 # Unconditionally create a seedfile that's sufficiently long.
6128 # Do this before each component, because a previous component may
6129 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006130 local dd_cmd
6131 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6132 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006133 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006134 esac
6135 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006136
Gilles Peskineec135542021-08-02 23:14:03 +02006137 # Run the component in a subshell, with error trapping and output
6138 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006139 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006140 # We want to keep running if the subshell fails, so 'set -e' must
6141 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006142 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006143 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006144 (
6145 if [ $QUIET -eq 1 ]; then
6146 # msg() will be silenced, so just print the component name here.
6147 echo "${current_component#component_}"
6148 exec >/dev/null
6149 fi
6150 if [ $KEEP_GOING -eq 1 ]; then
6151 # Keep "set -e" off, and run an ERR trap instead to record failures.
6152 set -E
6153 trap err_trap ERR
6154 fi
6155 # The next line is what runs the component
6156 "$@"
6157 if [ $KEEP_GOING -eq 1 ]; then
6158 trap - ERR
6159 exit $last_failure_status
6160 fi
6161 )
6162 component_status=$?
6163 if [ $KEEP_GOING -eq 1 ]; then
6164 set -e
6165 if [ $component_status -ne 0 ]; then
6166 failure_count=$((failure_count + 1))
6167 fi
6168 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006169
6170 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006171 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006172 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006173}
6174
6175# Preliminary setup
6176pre_check_environment
6177pre_initialize_variables
6178pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006179
Gilles Peskine878cf602019-01-06 20:50:38 +00006180pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006181pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006182pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006183
Gilles Peskine878cf602019-01-06 20:50:38 +00006184build_status=0
6185if [ $KEEP_GOING -eq 1 ]; then
6186 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006187fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006188pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006189pre_print_configuration
6190pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006191cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006192if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006193 pre_generate_files
6194fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006195
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006196# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006197for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006198 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006199done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006200unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006201for component in $RUN_COMPONENTS; do
6202 run_component "component_$component"
6203done
Gilles Peskine8f073122018-11-27 15:58:47 +01006204
6205# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006206post_report