blob: fdd7b946e250d20a74026257cd3137e51252e5f9 [file] [log] [blame]
Gilles Peskine62cf2e82020-03-27 16:35:23 +01001#! /usr/bin/env bash
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
Bence Szépkúti1e148272020-08-07 13:07:28 +02005# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskine192c72f2017-12-21 15:59:21 +01007
8
9
10################################################################
11#### Documentation
12################################################################
13
Simon Butcher3ea7f522016-03-07 23:22:10 +000014# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010015# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000016#
SimonB2e23c822016-04-16 21:54:39 +010017# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010018#
Gilles Peskine192c72f2017-12-21 15:59:21 +010019# Notes for users
20# ---------------
21#
SimonB2e23c822016-04-16 21:54:39 +010022# Warning: the test is destructive. It includes various build modes and
23# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010024# configuration. The following files must be committed into git:
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +020025# * include/mbedtls/mbedtls_config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010026# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
27# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010028# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040038# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010039# * arm-gcc and mingw-gcc
40# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine7be571a2023-08-27 21:39:21 +020041# * OpenSSL and GnuTLS command line tools, in suitable versions for the
42# interoperability tests. The following are the official versions at the
43# time of writing:
44# * GNUTLS_{CLI,SERV} = 3.4.10
45# * GNUTLS_NEXT_{CLI,SERV} = 3.7.2
46# * OPENSSL = 1.0.2g (without Debian/Ubuntu patches)
Ronald Cronc5e81d22024-04-02 14:39:53 +020047# * OPENSSL_NEXT = 3.1.2
Gilles Peskine192c72f2017-12-21 15:59:21 +010048# See the invocation of check_tools below for details.
49#
50# This script must be invoked from the toplevel directory of a git
51# working copy of Mbed TLS.
52#
Gilles Peskinece266c42020-03-28 18:50:43 +010053# The behavior on an error depends on whether --keep-going (alias -k)
54# is in effect.
55# * Without --keep-going: the script stops on the first error without
56# cleaning up. This lets you work in the configuration of the failing
57# component.
58# * With --keep-going: the script runs all requested components and
59# reports failures at the end. In particular the script always cleans
60# up on exit.
61#
Gilles Peskine192c72f2017-12-21 15:59:21 +010062# Note that the output is not saved. You may want to run
63# script -c tests/scripts/all.sh
64# or
65# tests/scripts/all.sh >all.log 2>&1
66#
67# Notes for maintainers
68# ---------------------
69#
Gilles Peskine8f073122018-11-27 15:58:47 +010070# The bulk of the code is organized into functions that follow one of the
71# following naming conventions:
72# * pre_XXX: things to do before running the tests, in order.
73# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010074# * component_check_XXX: quick tests that aren't worth parallelizing.
75# * component_build_XXX: build things but don't run them.
76# * component_test_XXX: build and test.
Bence Szépkúti89dd5c02023-12-15 17:05:15 +010077# * component_release_XXX: tests that the CI should skip during PR testing.
Gilles Peskine878cf602019-01-06 20:50:38 +000078# * support_XXX: if support_XXX exists and returns false then
79# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010080# * post_XXX: things to do after running the tests.
81# * other: miscellaneous support functions.
82#
Gilles Peskinec70637a2019-01-09 22:29:17 +010083# Each component must start by invoking `msg` with a short informative message.
84#
Gilles Peskinea681c592020-03-28 21:27:40 +010085# Warning: due to the way bash detects errors, the failure of a command
86# inside 'if' or '!' is not detected. Use the 'not' function instead of '!'.
87#
Gilles Peskinece266c42020-03-28 18:50:43 +010088# Each component is executed in a separate shell process. The component
89# fails if any command in it returns a non-zero status.
90#
Gilles Peskinec70637a2019-01-09 22:29:17 +010091# The framework performs some cleanup tasks after each component. This
92# means that components can assume that the working directory is in a
93# cleaned-up state, and don't need to perform the cleanup themselves.
94# * Run `make clean`.
Bence Szépkúti414d6bd2021-06-28 14:11:11 +010095# * Restore `include/mbedtls/mbedtls_config.h` from a backup made before running
Gilles Peskinec70637a2019-01-09 22:29:17 +010096# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010097# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
98# `tests/Makefile` and `programs/fuzz/Makefile` from git.
99# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100100#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100101# The tests are roughly in order from fastest to slowest. This doesn't
102# have to be exact, but in general you should add slower tests towards
103# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100104
105
106
107################################################################
108#### Initialization and command line parsing
109################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100110
Gilles Peskine36647802020-03-28 18:50:49 +0100111# Abort on errors (even on the left-hand side of a pipe).
112# Treat uninitialised variables as errors.
113set -e -o pipefail -u
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100114
Gilles Peskine076f7252022-08-30 21:02:44 +0200115# Enable ksh/bash extended file matching patterns
116shopt -s extglob
117
Thomas Daubneyd9312ea2023-12-05 11:24:06 +0000118# For project detection
119PROJECT_NAME_FILE='./scripts/project_name.txt'
120
David Horstmann76a77382023-08-17 17:32:26 +0100121in_mbedtls_repo () {
Thomas Daubney6a864dc2024-07-26 17:31:46 +0100122 if [ ! -f $PROJECT_NAME_FILE ]; then
123 echo "$PROJECT_NAME_FILE does not exist... Exiting..."
124 exit 1
125 fi
Thomas Daubneyd9312ea2023-12-05 11:24:06 +0000126 grep -Fxq "Mbed TLS" "$PROJECT_NAME_FILE"
Thomas Daubney6a864dc2024-07-26 17:31:46 +0100127 }
David Horstmannd02b5f82023-08-29 09:53:52 +0100128
Ronald Cron070e8652023-10-09 10:25:45 +0200129in_tf_psa_crypto_repo () {
Thomas Daubney6a864dc2024-07-26 17:31:46 +0100130 if [ ! -f $PROJECT_NAME_FILE ]; then
131 echo "$PROJECT_NAME_FILE does not exist... Exiting..."
132 exit 1
133 fi
Thomas Daubneyd9312ea2023-12-05 11:24:06 +0000134 grep -Fxq "TF-PSA-Crypto" "$PROJECT_NAME_FILE"
David Horstmann9a6c45b2023-07-14 12:30:00 +0100135}
136
Gilles Peskine8f073122018-11-27 15:58:47 +0100137pre_check_environment () {
Ronald Cron070e8652023-10-09 10:25:45 +0200138 if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else
139 echo "Must be run from Mbed TLS / TF-PSA-Crypto root" >&2
Gilles Peskine8f073122018-11-27 15:58:47 +0100140 exit 1
141 fi
142}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100143
Gilles Peskine8f073122018-11-27 15:58:47 +0100144pre_initialize_variables () {
David Horstmann76a77382023-08-17 17:32:26 +0100145 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100146 CONFIG_H='include/mbedtls/mbedtls_config.h'
David Horstmann76a77382023-08-17 17:32:26 +0100147 else
148 CONFIG_H='drivers/builtin/include/mbedtls/mbedtls_config.h'
David Horstmann9a6c45b2023-07-14 12:30:00 +0100149 fi
John Durkopbd069d32020-10-31 22:14:03 -0700150 CRYPTO_CONFIG_H='include/psa/crypto_config.h'
Manuel Pégourié-Gonnard462e3a92022-12-27 12:35:11 +0100151 CONFIG_TEST_DRIVER_H='tests/include/test/drivers/config_test_driver.h'
Gilles Peskinef83eb822020-03-30 20:11:39 +0200152
153 # Files that are clobbered by some jobs will be backed up. Use a different
154 # suffix from auxiliary scripts so that all.sh and auxiliary scripts can
155 # independently decide when to remove the backup file.
156 backup_suffix='.all.bak'
157 # Files clobbered by config.py
Janos Follath2f045822023-07-31 10:57:16 +0100158 files_to_back_up="$CONFIG_H $CRYPTO_CONFIG_H $CONFIG_TEST_DRIVER_H"
David Horstmann76a77382023-08-17 17:32:26 +0100159 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100160 # Files clobbered by in-tree cmake
161 files_to_back_up="$files_to_back_up Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile"
162 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200163
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200164 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100165 MEMORY=0
166 FORCE=0
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200167 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100168 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100169
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200170 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard54304472020-06-22 10:11:47 +0200171 #
172 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
173 # both values are kept in sync. If you change the value here because it
174 # breaks some tests, you'll definitely want to change it in
175 # basic-build-test.sh as well.
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200176 RELEASE_SEED=1
177
Yanray Wang18040ed2023-11-23 21:29:56 +0800178 # Specify character collation for regular expressions and sorting with C locale
179 export LC_COLLATE=C
180
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200181 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200182 : ${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 +0200183 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200184 export MBEDTLS_TEST_PLATFORM
185
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000186 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100187 : ${OPENSSL:="openssl"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100188 : ${OPENSSL_NEXT:="$OPENSSL"}
189 : ${GNUTLS_CLI:="gnutls-cli"}
190 : ${GNUTLS_SERV:="gnutls-serv"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100191 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
192 : ${ARMC5_BIN_DIR:=/usr/bin}
193 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200194 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200195 : ${ARM_LINUX_GNUEABI_GCC_PREFIX:=arm-linux-gnueabi-}
Gowtham Suresh Kumar9da40b82023-07-31 16:38:10 +0100196 : ${CLANG_LATEST:="clang-latest"}
197 : ${CLANG_EARLIEST:="clang-earliest"}
198 : ${GCC_LATEST:="gcc-latest"}
199 : ${GCC_EARLIEST:="gcc-earliest"}
Gilles Peskine8f073122018-11-27 15:58:47 +0100200 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000201 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200202 export MAKEFLAGS="-j$(all_sh_nproc)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100203 fi
Dave Rodgman0c5bfe82023-12-18 19:53:25 +0000204 # if CC is not set, use clang by default (if present) to improve build times
205 if [ -z "${CC+set}" ] && (type clang > /dev/null 2>&1); then
Dave Rodgmanfc5b9552023-12-19 16:08:19 +0000206 export CC="clang"
Dave Rodgman66cbc832023-12-18 18:34:50 +0000207 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000208
Ronald Cronc5e81d22024-04-02 14:39:53 +0200209 if [ -n "${OPENSSL_3+set}" ]; then
210 export OPENSSL_NEXT="$OPENSSL_3"
211 fi
212
Gilles Peskine396853a2021-09-20 18:57:55 +0200213 # Include more verbose output for failing tests run by CMake or make
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000214 export CTEST_OUTPUT_ON_FAILURE=1
215
Gilles Peskine8fd59422019-10-21 17:11:33 +0200216 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Manuel Pégourié-Gonnardfe549a72022-11-30 10:42:03 +0100217 # default to -O2, use -Ox _after_ this if you want another level
Przemek Stekiel6efa6082023-05-31 09:38:21 +0200218 ASAN_CFLAGS='-O2 -Werror -fsanitize=address,undefined -fno-sanitize-recover=all'
Dave Rodgman17127e92023-12-14 16:42:48 +0000219 # Normally, tests should use this compiler for ASAN testing
220 ASAN_CC=clang
Gilles Peskine8fd59422019-10-21 17:11:33 +0200221
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400222 # Platform tests have an allocation that returns null
223 export ASAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek026235c2023-07-05 08:32:43 -0400224 export MSAN_OPTIONS="allocator_may_return_null=1"
Andrzej Kurek04bfe572023-06-27 10:02:09 -0400225
Gilles Peskine878cf602019-01-06 20:50:38 +0000226 # Gather the list of available components. These are the functions
227 # defined in this script whose name starts with "component_".
Gowtham Suresh Kumar1e829a42023-07-28 16:41:21 +0100228 ALL_COMPONENTS=$(compgen -A function component_ | sed 's/component_//')
Gilles Peskine878cf602019-01-06 20:50:38 +0000229
Dave Rodgman5f8e2a22024-01-16 17:33:34 +0000230 # Delay determining SUPPORTED_COMPONENTS until the command line options have a chance to override
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100231 # the commands set by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100232}
Andres AG38495a32016-07-12 16:54:33 +0100233
Dave Rodgman21900632024-02-26 11:41:19 +0000234setup_quiet_wrappers()
235{
236 # Pick up "quiet" wrappers for make and cmake, which don't output very much
237 # unless there is an error. This reduces logging overhead in the CI.
238 #
239 # Note that the cmake wrapper breaks unless we use an absolute path here.
Dave Rodgmana9e8dbe2024-02-26 17:27:18 +0000240 if [[ -e ${PWD}/tests/scripts/quiet ]]; then
241 export PATH=${PWD}/tests/scripts/quiet:$PATH
Dave Rodgman21900632024-02-26 11:41:19 +0000242 fi
243}
244
Gilles Peskinea28db922019-01-10 00:05:18 +0100245# Test whether the component $1 is included in the command line patterns.
246is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100247{
Gilles Peskine03af6782021-08-06 11:35:17 +0200248 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
249 # only does word splitting.
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100250 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000251 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100252 set +f
253 case ${1#component_} in $pattern) return 0;; esac
254 done
255 set +f
256 return 1
257}
Andres AG7770ea82016-10-10 15:46:20 +0100258
Simon Butcher41eeccf2016-09-07 00:07:09 +0100259usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100260{
Gilles Peskine709346a2017-12-10 23:43:39 +0100261 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100262Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100263Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100264By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100265COMPONENT can be the name of a component or a shell wildcard pattern.
266
267Examples:
268 $0 "check_*"
269 Run all sanity checks.
270 $0 --no-armcc --except test_memsan
271 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100272
273Special options:
274 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000275 --list-all-components List all available test components and exit.
276 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100277
278General options:
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200279 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100280 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100281 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100282 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200283 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200284 --arm-none-eabi-gcc-prefix=<string>
285 Prefix for a cross-compiler for arm-none-eabi
286 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200287 --arm-linux-gnueabi-gcc-prefix=<string>
288 Prefix for a cross-compiler for arm-linux-gnueabi
289 (default: "${ARM_LINUX_GNUEABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100290 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine80ddb992021-08-06 11:51:59 +0200291 --restore First clean up the build tree, restoring backed up
292 files. Do not run any components unless they are
293 explicitly specified.
Gilles Peskine5d996822020-03-28 21:09:21 +0100294 --error-test Error test mode: run a failing function in addition
Gilles Peskine86f61292021-08-05 15:11:33 +0200295 to any specified component. May be repeated.
Gilles Peskinea28db922019-01-10 00:05:18 +0100296 --except Exclude the COMPONENTs listed on the command line,
297 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200298 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100299 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100300 --no-force Refuse to overwrite modified files (default).
301 --no-keep-going Stop at the first error (default).
302 --no-memory No additional memory tests (default).
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800303 --no-quiet Print full output from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100304 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200305 --outcome-file=<path> File where test outcomes are written (not done if
306 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100307 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200308 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100309 -s|--seed Integer seed value to use for this test run.
310
311Tool path options:
312 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
313 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100314 --clang-earliest=<Clang_earliest_path> Earliest version of clang available
315 --clang-latest=<Clang_latest_path> Latest version of clang available
316 --gcc-earliest=<GCC_earliest_path> Earliest version of GCC available
317 --gcc-latest=<GCC_latest_path> Latest version of GCC available
Gilles Peskine709346a2017-12-10 23:43:39 +0100318 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
319 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
Gilles Peskine709346a2017-12-10 23:43:39 +0100320 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100321 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100322EOF
SimonB2e23c822016-04-16 21:54:39 +0100323}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100324
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200325# Cleanup before/after running a component.
326# Remove built files as well as the cmake cache/config.
327# Does not remove generated source files.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100328cleanup()
329{
David Horstmann76a77382023-08-17 17:32:26 +0100330 if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100331 command make clean
332 fi
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200333
Gilles Peskine31b07e22018-03-21 12:15:06 +0100334 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000335 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100336 -iname CMakeFiles -exec rm -rf {} \+ -o \
337 \( -iname cmake_install.cmake -o \
338 -iname CTestTestfile.cmake -o \
Manuel Pégourié-Gonnardbfe54d72021-09-09 11:11:44 +0200339 -iname CMakeCache.txt -o \
340 -path './cmake/*.cmake' \) -exec rm -f {} \+
Gilles Peskine31b07e22018-03-21 12:15:06 +0100341 # Recover files overwritten by in-tree CMake builds
Gilles Peskine076f7252022-08-30 21:02:44 +0200342 rm -f include/Makefile include/mbedtls/Makefile programs/!(fuzz)/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200343
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100344 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
345 rm -rf programs/test/cmake_subproject/build
346 rm -f programs/test/cmake_subproject/Makefile
347 rm -f programs/test/cmake_subproject/cmake_subproject
348
Chris Kayd259e342021-03-25 16:03:25 +0000349 # Remove any artifacts from the component_test_cmake_as_package test.
350 rm -rf programs/test/cmake_package/build
351 rm -f programs/test/cmake_package/Makefile
352 rm -f programs/test/cmake_package/cmake_package
353
354 # Remove any artifacts from the component_test_cmake_as_installed_package test.
355 rm -rf programs/test/cmake_package_install/build
356 rm -f programs/test/cmake_package_install/Makefile
357 rm -f programs/test/cmake_package_install/cmake_package_install
358
Gilles Peskinef83eb822020-03-30 20:11:39 +0200359 # Restore files that may have been clobbered by the job
360 for x in $files_to_back_up; do
Gilles Peskinedd06efb2022-08-30 21:02:00 +0200361 if [[ -e "$x$backup_suffix" ]]; then
362 cp -p "$x$backup_suffix" "$x"
363 fi
Gilles Peskinef83eb822020-03-30 20:11:39 +0200364 done
365}
John Durkopbd069d32020-10-31 22:14:03 -0700366
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200367# Final cleanup when this script exits (except when exiting on a failure
368# in non-keep-going mode).
Gilles Peskinef83eb822020-03-30 20:11:39 +0200369final_cleanup () {
370 cleanup
371
372 for x in $files_to_back_up; do
373 rm -f "$x$backup_suffix"
374 done
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100375}
376
Gilles Peskine7c652162017-12-11 00:01:40 +0100377# Executed on exit. May be redefined depending on command line options.
378final_report () {
379 :
380}
381
382fatal_signal () {
Gilles Peskinef83eb822020-03-30 20:11:39 +0200383 final_cleanup
Gilles Peskine7c652162017-12-11 00:01:40 +0100384 final_report $1
385 trap - $1
386 kill -$1 $$
387}
388
389trap 'fatal_signal HUP' HUP
390trap 'fatal_signal INT' INT
391trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200392
Gilles Peskine050d2fc2021-09-30 18:24:21 +0200393# Number of processors on this machine. Used as the default setting
394# for parallel make.
395all_sh_nproc ()
396{
397 {
398 nproc || # Linux
399 sysctl -n hw.ncpuonline || # NetBSD, OpenBSD
400 sysctl -n hw.ncpu || # FreeBSD
401 echo 1
402 } 2>/dev/null
403}
404
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100405msg()
406{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100407 if [ -n "${current_component:-}" ]; then
408 current_section="${current_component#component_}: $1"
409 else
410 current_section="$1"
411 fi
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200412
413 if [ $QUIET -eq 1 ]; then
414 return
415 fi
416
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100417 echo ""
418 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100419 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000420 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100421 echo "******************************************************************"
422}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100423
Gilles Peskine8f073122018-11-27 15:58:47 +0100424armc6_build_test()
425{
426 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100427
Gilles Peskine18487f62020-04-30 23:11:54 +0200428 msg "build: ARM Compiler 6 ($FLAGS)"
Yanray Wangbc7716c2023-09-08 11:20:59 +0800429 make clean
Gilles Peskine8f073122018-11-27 15:58:47 +0100430 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
Dave Rodgman1c232a82023-03-02 13:39:04 +0000431 WARNING_CFLAGS='-Werror -xc -std=c99' make lib
Gilles Peskine18487f62020-04-30 23:11:54 +0200432
433 msg "size: ARM Compiler 6 ($FLAGS)"
434 "$ARMC6_FROMELF" -z library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +0100435}
Andres AGa5cd9732016-10-17 15:23:10 +0100436
Andres AGd9eba4b2016-08-26 14:42:14 +0100437err_msg()
438{
439 echo "$1" >&2
440}
441
442check_tools()
443{
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200444 for tool in "$@"; do
445 if ! `type "$tool" >/dev/null 2>&1`; then
446 err_msg "$tool not found!"
Andres AGd9eba4b2016-08-26 14:42:14 +0100447 exit 1
448 fi
449 done
450}
451
Gilles Peskine8f073122018-11-27 15:58:47 +0100452pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000453 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100454 all_except=0
Gilles Peskine5d996822020-03-28 21:09:21 +0100455 error_test=0
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100456 list_components=0
Gilles Peskine80ddb992021-08-06 11:51:59 +0200457 restore_first=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000458 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100459
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000460 # Note that legacy options are ignored instead of being omitted from this
461 # list of options, so invocations that worked with previous version of
462 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100463 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100464 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200465 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200466 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +0200467 --arm-linux-gnueabi-gcc-prefix) shift; ARM_LINUX_GNUEABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000468 --armcc) no_armcc=;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100469 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
470 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100471 --clang-earliest) shift; CLANG_EARLIEST="$1";;
472 --clang-latest) shift; CLANG_LATEST="$1";;
Gilles Peskine5d996822020-03-28 21:09:21 +0100473 --error-test) error_test=$((error_test + 1));;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000474 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100475 --force|-f) FORCE=1;;
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +0100476 --gcc-earliest) shift; GCC_EARLIEST="$1";;
477 --gcc-latest) shift; GCC_LATEST="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100478 --gnutls-cli) shift; GNUTLS_CLI="$1";;
Gilles Peskine7be571a2023-08-27 21:39:21 +0200479 --gnutls-legacy-cli) shift;; # ignored for backward compatibility
480 --gnutls-legacy-serv) shift;; # ignored for backward compatibility
Gilles Peskine55f7c942019-01-09 22:28:21 +0100481 --gnutls-serv) shift; GNUTLS_SERV="$1";;
482 --help|-h) usage; exit;;
483 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000484 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100485 --list-components) list_components=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100486 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200487 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000488 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100489 --no-force) FORCE=0;;
490 --no-keep-going) KEEP_GOING=0;;
491 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200492 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100493 --openssl) shift; OPENSSL="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100494 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200495 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100496 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200497 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100498 --random-seed) unset SEED;;
Manuel Pégourié-Gonnarde0501912020-06-08 12:59:27 +0200499 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine80ddb992021-08-06 11:51:59 +0200500 --restore) restore_first=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100501 --seed|-s) shift; SEED="$1";;
502 -*)
503 echo >&2 "Unknown option: $1"
504 echo >&2 "Run $0 --help for usage."
505 exit 120
506 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000507 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100508 esac
509 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100510 done
SimonB2e23c822016-04-16 21:54:39 +0100511
Bence Szépkúti71c71eb2023-12-15 19:20:31 +0100512 # Exclude components that are not supported on this platform.
513 SUPPORTED_COMPONENTS=
514 for component in $ALL_COMPONENTS; do
515 case $(type "support_$component" 2>&1) in
516 *' function'*)
517 if ! support_$component; then continue; fi;;
518 esac
519 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
520 done
521
522 if [ $list_components -eq 1 ]; then
523 printf '%s\n' $SUPPORTED_COMPONENTS
524 exit
525 fi
526
Gilles Peskinea28db922019-01-10 00:05:18 +0100527 # With no list of components, run everything.
Gilles Peskine80ddb992021-08-06 11:51:59 +0200528 if [ -z "$COMMAND_LINE_COMPONENTS" ] && [ $restore_first -eq 0 ]; then
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000529 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100530 fi
531
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000532 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
533 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100534 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000535 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100536 fi
SimonB2e23c822016-04-16 21:54:39 +0100537
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200538 # Error out if an explicitly requested component doesn't exist.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100539 if [ $all_except -eq 0 ]; then
540 unsupported=0
Gilles Peskine03af6782021-08-06 11:35:17 +0200541 # Temporarily disable wildcard expansion so that $COMMAND_LINE_COMPONENTS
542 # only does word splitting.
Gilles Peskine1d475b62021-08-03 13:43:36 +0200543 set -f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100544 for component in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine1d475b62021-08-03 13:43:36 +0200545 set +f
Gilles Peskinebf66e2c2021-08-03 13:44:28 +0200546 # If the requested name includes a wildcard character, don't
547 # check it. Accept wildcard patterns that don't match anything.
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100548 case $component in
549 *[*?\[]*) continue;;
550 esac
551 case " $SUPPORTED_COMPONENTS " in
552 *" $component "*) :;;
553 *)
554 echo >&2 "Component $component was explicitly requested, but is not known or not supported."
555 unsupported=$((unsupported + 1));;
556 esac
557 done
Gilles Peskine1d475b62021-08-03 13:43:36 +0200558 set +f
Gilles Peskineb80f0d22020-03-28 21:37:59 +0100559 if [ $unsupported -ne 0 ]; then
560 exit 2
561 fi
562 fi
563
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000564 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100565 RUN_COMPONENTS=
566 for component in $SUPPORTED_COMPONENTS; do
567 if is_component_included "$component"; [ $? -eq $all_except ]; then
568 RUN_COMPONENTS="$RUN_COMPONENTS $component"
569 fi
570 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000571
572 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000573 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100574}
SimonB2e23c822016-04-16 21:54:39 +0100575
Gilles Peskine8f073122018-11-27 15:58:47 +0100576pre_check_git () {
577 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100578 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100579 git checkout-index -f -q $CONFIG_H
580 cleanup
581 else
SimonB2e23c822016-04-16 21:54:39 +0100582
Gilles Peskine8f073122018-11-27 15:58:47 +0100583 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
584 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
585 echo "You can either delete this directory manually, or force the test by rerunning"
586 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
587 exit 1
588 fi
589
Ronald Cron7a93ac52023-07-20 09:49:12 +0200590 if ! git diff --quiet "$CONFIG_H"; then
David Horstmann9a6c45b2023-07-14 12:30:00 +0100591 err_msg "Warning - the configuration file '$CONFIG_H' has been edited. "
Gilles Peskine8f073122018-11-27 15:58:47 +0100592 echo "You can either delete or preserve your work, or force the test by rerunning the"
593 echo "script as: $0 --force"
594 exit 1
595 fi
SimonB2e23c822016-04-16 21:54:39 +0100596 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500597}
598
Gilles Peskine568f53a2021-07-12 18:16:01 +0200599pre_restore_files () {
600 # If the makefiles have been generated by a framework such as cmake,
601 # restore them from git. If the makefiles look like modifications from
602 # the ones checked into git, take care not to modify them. Whatever
603 # this function leaves behind is what the script will restore before
604 # each component.
605 case "$(head -n1 Makefile)" in
606 *[Gg]enerated*)
607 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
608 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
609 ;;
610 esac
611}
612
Gilles Peskinef83eb822020-03-30 20:11:39 +0200613pre_back_up () {
614 for x in $files_to_back_up; do
615 cp -p "$x" "$x$backup_suffix"
616 done
617}
618
Gilles Peskine8f073122018-11-27 15:58:47 +0100619pre_setup_keep_going () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100620 failure_count=0 # Number of failed components
621 last_failure_status=0 # Last failure status in this component
622
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100623 # See err_trap
624 previous_failure_status=0
625 previous_failed_command=
626 previous_failure_funcall_depth=0
Gilles Peskinea681c592020-03-28 21:27:40 +0100627 unset report_failed_command
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100628
Gilles Peskine7c652162017-12-11 00:01:40 +0100629 start_red=
630 end_color=
631 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100632 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100633 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
634 start_red=$(printf '\033[31m')
635 end_color=$(printf '\033[0m')
636 ;;
637 esac
638 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100639
640 # Keep a summary of failures in a file. We'll print it out at the end.
641 failure_summary_file=$PWD/all-sh-failures-$$.log
642 : >"$failure_summary_file"
643
644 # Whether it makes sense to keep a component going after the specified
645 # command fails (test command) or not (configure or build).
Gilles Peskine03af6782021-08-06 11:35:17 +0200646 # This function normally receives the failing simple command
647 # ($BASH_COMMAND) as an argument, but if $report_failed_command is set,
648 # this is passed instead.
Gilles Peskinece266c42020-03-28 18:50:43 +0100649 # This doesn't have to be 100% accurate: all failures are recorded anyway.
Gilles Peskinec111e242021-08-02 23:29:53 +0200650 # False positives result in running things that can't be expected to
651 # work. False negatives result in things not running after something else
652 # failed even though they might have given useful feedback.
Gilles Peskinece266c42020-03-28 18:50:43 +0100653 can_keep_going_after_failure () {
654 case "$1" in
655 "msg "*) false;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200656 "cd "*) false;;
Manuel Pégourié-Gonnarda7423372023-11-10 09:58:31 +0100657 "diff "*) true;;
Gilles Peskinec111e242021-08-02 23:29:53 +0200658 *make*[\ /]tests*) false;; # make tests, make CFLAGS=-I../tests, ...
659 *test*) true;; # make test, tests/stuff, env V=v tests/stuff, ...
660 *make*check*) true;;
661 "grep "*) true;;
662 "[ "*) true;;
663 "! "*) true;;
Gilles Peskinece266c42020-03-28 18:50:43 +0100664 *) false;;
Gilles Peskine7c652162017-12-11 00:01:40 +0100665 esac
666 }
Gilles Peskinece266c42020-03-28 18:50:43 +0100667
668 # This function runs if there is any error in a component.
669 # It must either exit with a nonzero status, or set
670 # last_failure_status to a nonzero value.
671 err_trap () {
672 # Save $? (status of the failing command). This must be the very
673 # first thing, before $? is overridden.
674 last_failure_status=$?
Gilles Peskinea681c592020-03-28 21:27:40 +0100675 failed_command=${report_failed_command-$BASH_COMMAND}
Gilles Peskinece266c42020-03-28 18:50:43 +0100676
Gilles Peskinefec30cb2020-03-28 19:34:23 +0100677 if [[ $last_failure_status -eq $previous_failure_status &&
678 "$failed_command" == "$previous_failed_command" &&
679 ${#FUNCNAME[@]} == $((previous_failure_funcall_depth - 1)) ]]
680 then
681 # The same command failed twice in a row, but this time one level
682 # less deep in the function call stack. This happens when the last
683 # command of a function returns a nonzero status, and the function
684 # returns that same status. Ignore the second failure.
685 previous_failure_funcall_depth=${#FUNCNAME[@]}
686 return
687 fi
688 previous_failure_status=$last_failure_status
689 previous_failed_command=$failed_command
690 previous_failure_funcall_depth=${#FUNCNAME[@]}
691
Gilles Peskinece266c42020-03-28 18:50:43 +0100692 text="$current_section: $failed_command -> $last_failure_status"
693 echo "${start_red}^^^^$text^^^^${end_color}" >&2
694 echo "$text" >>"$failure_summary_file"
695
696 # If the command is fatal (configure or build command), stop this
697 # component. Otherwise (test command) keep the component running
698 # (run more tests from the same build).
699 if ! can_keep_going_after_failure "$failed_command"; then
700 exit $last_failure_status
701 fi
702 }
703
Gilles Peskine7c652162017-12-11 00:01:40 +0100704 final_report () {
705 if [ $failure_count -gt 0 ]; then
706 echo
707 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Gilles Peskinece266c42020-03-28 18:50:43 +0100708 echo "${start_red}FAILED: $failure_count components${end_color}"
709 cat "$failure_summary_file"
Gilles Peskine7c652162017-12-11 00:01:40 +0100710 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
711 elif [ -z "${1-}" ]; then
712 echo "SUCCESS :)"
713 fi
714 if [ -n "${1-}" ]; then
715 echo "Killed by SIG$1."
716 fi
Gilles Peskinece266c42020-03-28 18:50:43 +0100717 rm -f "$failure_summary_file"
718 if [ $failure_count -gt 0 ]; then
719 exit 1
720 fi
Gilles Peskine7c652162017-12-11 00:01:40 +0100721 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100722}
723
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +0200724# record_status() and if_build_succeeded() are kept temporarily for backward
725# compatibility. Don't use them in new components.
Gilles Peskinece266c42020-03-28 18:50:43 +0100726record_status () {
727 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100728}
Gilles Peskine7c652162017-12-11 00:01:40 +0100729if_build_succeeded () {
Gilles Peskinece266c42020-03-28 18:50:43 +0100730 "$@"
Gilles Peskine7c652162017-12-11 00:01:40 +0100731}
732
Gilles Peskinea681c592020-03-28 21:27:40 +0100733# '! true' does not trigger the ERR trap. Arrange to trigger it, with
734# a reasonably informative error message (not just "$@").
735not () {
736 if "$@"; then
737 report_failed_command="! $*"
738 false
739 unset report_failed_command
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200740 fi
741}
742
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200743pre_prepare_outcome_file () {
744 case "$MBEDTLS_TEST_OUTCOME_FILE" in
745 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
746 esac
747 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
748 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
749 fi
750}
751
Gilles Peskine8f073122018-11-27 15:58:47 +0100752pre_print_configuration () {
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200753 if [ $QUIET -eq 1 ]; then
754 return
755 fi
756
Gilles Peskine8f073122018-11-27 15:58:47 +0100757 msg "info: $0 configuration"
758 echo "MEMORY: $MEMORY"
759 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200760 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100761 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100762 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100763 echo "OPENSSL: $OPENSSL"
Gilles Peskine8f073122018-11-27 15:58:47 +0100764 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
765 echo "GNUTLS_CLI: $GNUTLS_CLI"
766 echo "GNUTLS_SERV: $GNUTLS_SERV"
Gilles Peskine8f073122018-11-27 15:58:47 +0100767 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
768 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
769}
Andres AG7770ea82016-10-10 15:46:20 +0100770
Andres AGd9eba4b2016-08-26 14:42:14 +0100771# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100772pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000773 # Build the list of variables to pass to output_env.sh.
774 set env
SimonB2e23c822016-04-16 21:54:39 +0100775
Gilles Peskine87964262019-01-06 22:40:00 +0000776 case " $RUN_COMPONENTS " in
777 # Require OpenSSL and GnuTLS if running any tests (as opposed to
778 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
779 # is a good enough approximation in practice.
Bence Szépkútibbb5af92023-12-15 20:58:15 +0100780 *" test_"* | *" release_test_"*)
Gilles Peskine87964262019-01-06 22:40:00 +0000781 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
782 # and ssl-opt.sh, we just export the variables they require.
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +0100783 export OPENSSL="$OPENSSL"
Gilles Peskine87964262019-01-06 22:40:00 +0000784 export GNUTLS_CLI="$GNUTLS_CLI"
785 export GNUTLS_SERV="$GNUTLS_SERV"
786 # Avoid passing --seed flag in every call to ssl-opt.sh
787 if [ -n "${SEED-}" ]; then
788 export SEED
789 fi
Gilles Peskine7be571a2023-08-27 21:39:21 +0200790 set "$@" OPENSSL="$OPENSSL"
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000791 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
Gilles Peskine7be571a2023-08-27 21:39:21 +0200792 check_tools "$OPENSSL" "$OPENSSL_NEXT" \
793 "$GNUTLS_CLI" "$GNUTLS_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000794 ;;
795 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200796
Gilles Peskine87964262019-01-06 22:40:00 +0000797 case " $RUN_COMPONENTS " in
798 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
799 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100800
Gilles Peskine87964262019-01-06 22:40:00 +0000801 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200802 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000803 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100804
Gilles Peskine87964262019-01-06 22:40:00 +0000805 case " $RUN_COMPONENTS " in
806 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
807 esac
808
809 case " $RUN_COMPONENTS " in
810 *" test_zeroize "*) check_tools "gdb";;
811 esac
812
813 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000814 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000815 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
816 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200817 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000818 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
819 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine18487f62020-04-30 23:11:54 +0200820 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
821 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
822 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000823 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000824
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +0200825 # past this point, no call to check_tool, only printing output
826 if [ $QUIET -eq 1 ]; then
827 return
828 fi
829
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000830 msg "info: output_env.sh"
831 case $RUN_COMPONENTS in
832 *_armcc*)
833 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
834 *) set "$@" RUN_ARMCC=0;;
835 esac
836 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100837}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100838
Gilles Peskine1570b592021-04-22 01:10:12 +0200839pre_generate_files() {
Manuel Pégourié-Gonnard87db8a22021-06-18 13:30:14 +0200840 # since make doesn't have proper dependencies, remove any possibly outdate
841 # file that might be around before generating fresh ones
842 make neat
Gilles Peskine72385032021-07-08 19:07:07 +0200843 if [ $QUIET -eq 1 ]; then
Gilles Peskine75301632021-08-05 15:10:47 +0200844 make generated_files >/dev/null
Gilles Peskine72385032021-07-08 19:07:07 +0200845 else
846 make generated_files
847 fi
Gilles Peskine1570b592021-04-22 01:10:12 +0200848}
849
Tom Cosgroved4c373a2024-01-30 13:56:38 +0000850clang_version() {
851 if command -v clang > /dev/null ; then
852 clang --version|grep version|sed -E 's#.*version ([0-9]+).*#\1#'
853 else
854 echo 0 # report version 0 for "no clang"
855 fi
856}
857
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200858################################################################
859#### Helpers for components using libtestdriver1
860################################################################
Gilles Peskine192c72f2017-12-21 15:59:21 +0100861
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200862# How to use libtestdriver1
863# -------------------------
864#
865# 1. Define the list algorithms and key types to accelerate,
866# designated the same way as PSA_WANT_ macros but without PSA_WANT_.
867# Examples:
868# - loc_accel_list="ALG_JPAKE"
869# - loc_accel_list="ALG_FFDH KEY_TYPE_DH_KEY_PAIR KEY_TYPE_DH_PUBLIC_KEY"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200870# 2. Make configurations changes for the driver and/or main libraries.
871# 2a. Call helper_libtestdriver1_adjust_config <base>, where the argument
872# can be either "default" to start with the default config, or a name
873# supported by scripts/config.py (for example, "full"). This selects
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200874# the base to use, and makes common adjustments.
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200875# 2b. If desired, adjust the PSA_WANT symbols in psa/crypto_config.h.
876# These changes affect both the driver and the main libraries.
877# (Note: they need to have the same set of PSA_WANT symbols, as that
878# determines the ABI between them.)
879# 2c. Adjust MBEDTLS_ symbols in mbedtls_config.h. This only affects the
880# main libraries. Typically, you want to disable the module(s) that are
881# being accelerated. You may need to also disable modules that depend
882# on them or options that are not supported with drivers.
883# 2d. On top of psa/crypto_config.h, the driver library uses its own config
884# file: tests/include/test/drivers/config_test_driver.h. You usually
885# don't need to edit it: using loc_extra_list (see below) is preferred.
886# However, when there's no PSA symbol for what you want to enable,
887# calling scripts/config.py on this file remains the only option.
888# 3. Build the driver library, then the main libraries, test, and programs.
889# 3a. Call helper_libtestdriver1_make_drivers "$loc_accel_list". You may
890# need to enable more algorithms here, typically hash algorithms when
891# accelerating some signature algorithms (ECDSA, RSAv2). This is done
892# by passing a 2nd argument listing the extra algorithms.
893# Example:
894# loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512"
895# helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Yanray Wang0df6d962023-10-11 13:27:25 +0800896# 3b. Call helper_libtestdriver1_make_main "$loc_accel_list". Any
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200897# additional arguments will be passed to make: this can be useful if
898# you don't want to build everything when iterating during development.
899# Example:
900# helper_libtestdriver1_make_main "$loc_accel_list" -C tests test_suite_foo
901# 4. Run the tests you want.
Manuel Pégourié-Gonnardf5c5d972023-06-06 11:14:57 +0200902
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200903# Adjust the configuration - for both libtestdriver1 and main library,
904# as they should have the same PSA_WANT macros.
905helper_libtestdriver1_adjust_config() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200906 base_config=$1
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200907 # Select the base configuration
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +0200908 if [ "$base_config" != "default" ]; then
909 scripts/config.py "$base_config"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +0200910 fi
911
912 # Enable PSA-based config (necessary to use drivers)
913 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
914
Manuel Pégourié-Gonnard2336c8e2023-06-12 17:17:54 +0200915 # Dynamic secure element support is a deprecated feature and needs to be disabled here.
916 # This is done to have the same form of psa_key_attributes_s for libdriver and library.
917 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Paul Elliott053b7882024-03-05 11:46:32 +0000918
919 # If threading is enabled on the normal build, then we need to enable it in the drivers as well,
920 # otherwise we will end up running multithreaded tests without mutexes to protect them.
921 if scripts/config.py get MBEDTLS_THREADING_C; then
922 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_C
923 fi
924
925 if scripts/config.py get MBEDTLS_THREADING_PTHREAD; then
926 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_THREADING_PTHREAD
927 fi
Manuel Pégourié-Gonnard27e17672023-05-25 09:39:08 +0200928}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100929
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100930# Build the drivers library libtestdriver1.a (with ASan).
931#
932# Parameters:
933# 1. a space-separated list of things to accelerate;
934# 2. optional: a space-separate list of things to also support.
935# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
936helper_libtestdriver1_make_drivers() {
937 loc_accel_flags=$( echo "$1 ${2-}" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
938 make CC=$ASAN_CC -C tests libtestdriver1.a CFLAGS=" $ASAN_CFLAGS $loc_accel_flags" LDFLAGS="$ASAN_CFLAGS"
939}
940
941# Build the main libraries, programs and tests,
942# linking to the drivers library (with ASan).
943#
944# Parameters:
945# 1. a space-separated list of things to accelerate;
946# *. remaining arguments if any are passed directly to make
947# (examples: lib, -C tests test_suite_xxx, etc.)
948# Here "things" are PSA_WANT_ symbols but with PSA_WANT_ removed.
949helper_libtestdriver1_make_main() {
950 loc_accel_list=$1
951 shift
952
953 # we need flags both with and without the LIBTESTDRIVER1_ prefix
954 loc_accel_flags=$( echo "$loc_accel_list" | sed 's/[^ ]* */-DLIBTESTDRIVER1_MBEDTLS_PSA_ACCEL_&/g' )
955 loc_accel_flags="$loc_accel_flags $( echo "$loc_accel_list" | sed 's/[^ ]* */-DMBEDTLS_PSA_ACCEL_&/g' )"
956 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" "$@"
957}
958
Valerio Settid1b6ef12024-05-07 16:00:21 +0200959# $1: target which can be "client" or "server"
960helper_crypto_client_build() {
961 TARGET=$1
Valerio Settic98f8ab2024-05-10 15:53:40 +0200962 shift
Valerio Settid1b6ef12024-05-07 16:00:21 +0200963 TARGET_LIB=libpsa$TARGET
964
Valerio Settid1b6ef12024-05-07 16:00:21 +0200965 if [ "$TARGET" == "client" ]; then
966 scripts/config.py full
967 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
968 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
969 # Dynamic secure element support is a deprecated feature and it is not
970 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
971 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
972 # Disable potentially problematic features
973 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
974 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
975 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
976 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
977 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
978 else
979 scripts/config.py crypto_full
980 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
981 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Valerio Settid1b6ef12024-05-07 16:00:21 +0200982 fi
983
Valerio Settif57afd52024-05-14 10:39:20 +0200984 make -C tests/psa-client-server/psasim/ CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS" $TARGET_LIB "$@"
Valerio Settid1b6ef12024-05-07 16:00:21 +0200985
Valerio Settif57afd52024-05-14 10:39:20 +0200986 # cleanup() will restore some backed-up files which include $CONFIG_H and
987 # $CRYPTO_CONFIG_H. Built libraries were already copied to psasim at this
988 # point.
989 cleanup
Valerio Settid1b6ef12024-05-07 16:00:21 +0200990}
991
Manuel Pégourié-Gonnard733a67b2023-11-15 12:32:17 +0100992################################################################
993#### Configuration helpers
994################################################################
995
Valerio Settib2fd6732023-08-15 17:10:47 +0200996# When called with no parameter this function disables all builtin curves.
Valerio Setti4ca250b2023-09-04 14:01:41 +0200997# The function optionally accepts 1 parameter: a space-separated list of the
998# curves that should be kept enabled.
Valerio Settib2fd6732023-08-15 17:10:47 +0200999helper_disable_builtin_curves() {
1000 allowed_list="${1:-}"
1001 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
1002
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001003 for curve in $allowed_list; do
1004 scripts/config.py set $curve
Valerio Settib2fd6732023-08-15 17:10:47 +02001005 done
1006}
1007
1008# Helper returning the list of supported elliptic curves from CRYPTO_CONFIG_H,
1009# without the "PSA_WANT_" prefix. This becomes handy for accelerating curves
1010# in the following helpers.
1011helper_get_psa_curve_list () {
1012 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001013 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1014 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001015 done
1016
1017 echo "$loc_list"
1018}
1019
Valerio Setti78aa0bc2024-01-17 15:53:46 +01001020# Helper returning the list of supported DH groups from CRYPTO_CONFIG_H,
1021# without the "PSA_WANT_" prefix. This becomes handy for accelerating DH groups
1022# in the following helpers.
1023helper_get_psa_dh_group_list () {
1024 loc_list=""
1025 for item in $(sed -n 's/^#define PSA_WANT_\(DH_RFC7919_[0-9]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
1026 loc_list="$loc_list $item"
1027 done
1028
1029 echo "$loc_list"
1030}
1031
Valerio Settib2fd6732023-08-15 17:10:47 +02001032# Get the list of uncommented PSA_WANT_KEY_TYPE_xxx_ from CRYPTO_CONFIG_H. This
Valerio Setti0a342c92023-09-01 09:12:31 +02001033# is useful to easily get a list of key type symbols to accelerate.
Valerio Settib2fd6732023-08-15 17:10:47 +02001034# The function accepts a single argument which is the key type: ECC, DH, RSA.
Valerio Setti0a342c92023-09-01 09:12:31 +02001035helper_get_psa_key_type_list() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001036 key_type="$1"
Valerio Settib2fd6732023-08-15 17:10:47 +02001037 loc_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001038 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 +02001039 # Skip DERIVE for elliptic keys since there is no driver dispatch for
1040 # it so it cannot be accelerated.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02001041 if [ "$item" != "KEY_TYPE_ECC_KEY_PAIR_DERIVE" ]; then
1042 loc_list="$loc_list $item"
Valerio Settib2fd6732023-08-15 17:10:47 +02001043 fi
1044 done
1045
1046 echo "$loc_list"
1047}
1048
Gilles Peskine192c72f2017-12-21 15:59:21 +01001049################################################################
1050#### Basic checks
1051################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001052
1053#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001054# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001055#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +01001056# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001057# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001058# 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 +02001059# time, so start with a GCC build).
1060# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +01001061#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +01001062# Indicative running times are given for reference.
1063
Gilles Peskine8f073122018-11-27 15:58:47 +01001064component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001065 msg "Check: recursion.pl" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001066 tests/scripts/recursion.pl library/*.c
Gilles Peskine8f073122018-11-27 15:58:47 +01001067}
Janos Follathb72c6782016-07-19 14:54:17 +01001068
Gilles Peskine67debb62021-05-18 16:09:50 +02001069component_check_generated_files () {
1070 msg "Check: check-generated-files, files generated with make" # 2s
1071 make generated_files
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001072 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001073
1074 msg "Check: check-generated-files -u, files present" # 2s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001075 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001076 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001077 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001078
1079 msg "Check: check-generated-files -u, files absent" # 2s
1080 command make neat
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001081 tests/scripts/check-generated-files.sh -u
Gilles Peskine67debb62021-05-18 16:09:50 +02001082 # Check that the generated files are considered up to date.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001083 tests/scripts/check-generated-files.sh
Gilles Peskine67debb62021-05-18 16:09:50 +02001084
1085 # This component ends with the generated files present in the source tree.
1086 # This is necessary for subsequent components!
1087}
1088
Gilles Peskine8f073122018-11-27 15:58:47 +01001089component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001090 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001091 tests/scripts/check-doxy-blocks.pl
Gilles Peskine8f073122018-11-27 15:58:47 +01001092}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001093
Gilles Peskine8f073122018-11-27 15:58:47 +01001094component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001095 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001096 tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +01001097}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001098
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001099component_check_changelog () {
1100 msg "Check: changelog entries" # < 1s
1101 rm -f ChangeLog.new
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001102 scripts/assemble_changelog.py -o ChangeLog.new
Gilles Peskine30e0bb42020-05-10 17:40:49 +02001103 if [ -e ChangeLog.new ]; then
1104 # Show the diff for information. It isn't an error if the diff is
1105 # non-empty.
1106 diff -u ChangeLog ChangeLog.new || true
1107 rm ChangeLog.new
1108 fi
1109}
1110
Gilles Peskine8f073122018-11-27 15:58:47 +01001111component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001112 msg "Check: declared and exported names (builds the library)" # < 3s
Yuto Takanoc3a6f632021-09-24 18:02:56 +01001113 tests/scripts/check_names.py -v
Gilles Peskine8f073122018-11-27 15:58:47 +01001114}
Darryl Greena07039c2018-03-13 16:48:16 +00001115
Gilles Peskine895868b2019-09-19 21:30:05 +02001116component_check_test_cases () {
1117 msg "Check: test case descriptions" # < 1s
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001118 if [ $QUIET -eq 1 ]; then
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001119 opt='--quiet'
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001120 else
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001121 opt=''
Manuel Pégourié-Gonnarda9119162020-06-02 11:51:40 +02001122 fi
Gilles Peskine031114d2022-12-15 14:46:31 +01001123 tests/scripts/check_test_cases.py -q $opt
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02001124 unset opt
Gilles Peskine895868b2019-09-19 21:30:05 +02001125}
1126
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001127component_check_test_dependencies () {
1128 msg "Check: test case dependencies: legacy vs PSA" # < 1s
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001129 # The purpose of this component is to catch unjustified dependencies on
1130 # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
1131 # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
1132 # MBEDTLS_PSA_xxx).
1133 #
1134 # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
1135 # this component is meant to catch. However a few of them are justified,
1136 # mostly by the absence of a PSA equivalent, so this component includes a
1137 # list of expected exceptions.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001138
1139 found="check-test-deps-found-$$"
1140 expected="check-test-deps-expected-$$"
1141
1142 # Find legacy dependencies in PSA tests
Manuel Pégourié-Gonnard5c6f7872023-11-10 10:04:22 +01001143 grep 'depends_on' \
1144 tests/suites/test_suite_psa*.data tests/suites/test_suite_psa*.function |
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001145 grep -Eo '!?MBEDTLS_[^: ]*' |
Gilles Peskinea7d56622023-11-29 20:49:04 +01001146 grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
Yanray Wang18040ed2023-11-23 21:29:56 +08001147 sort -u > $found
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001148
Yanray Wang18040ed2023-11-23 21:29:56 +08001149 # Expected ones with justification - keep in sorted order by ASCII table!
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001150 rm -f $expected
1151 # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
1152 echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
Yanray Wang18040ed2023-11-23 21:29:56 +08001153 # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
1154 echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
Valerio Setti3ccb2b52024-01-10 10:51:24 +01001155 # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
1156 # in order to build a fake RSA key of the wanted size based on
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001157 # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
1158 # the test code and that's probably the most convenient way of achieving
1159 # the test's goal.
1160 echo "MBEDTLS_ASN1_WRITE_C" >> $expected
1161 # No PSA equivalent - we should probably have one in the future.
1162 echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
1163 # No PSA equivalent - needed by some init tests
1164 echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
Paul Elliott16d51602024-03-05 14:54:28 +00001165 # No PSA equivalent - required to run threaded tests.
Paul Elliott16d51602024-03-05 14:54:28 +00001166 echo "MBEDTLS_THREADING_PTHREAD" >> $expected
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001167
1168 # Compare reality with expectation.
1169 # We want an exact match, to ensure the above list remains up-to-date.
Manuel Pégourié-Gonnard9f164f02023-11-10 10:16:06 +01001170 #
1171 # The output should be empty. When it's not:
1172 # - Each '+' line is a macro that was found but not expected. You want to
1173 # find where that macro occurs, and either replace it with PSA macros, or
1174 # add it to the exceptions list above with a justification.
1175 # - Each '-' line is a macro that was expected but not found; it means the
1176 # exceptions list above should be updated by removing that macro.
Manuel Pégourié-Gonnard3e1d39b2023-11-08 12:54:02 +01001177 diff -U0 $expected $found
1178
1179 rm $found $expected
1180}
1181
Gilles Peskine8f073122018-11-27 15:58:47 +01001182component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +02001183 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001184 tests/scripts/doxygen.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001185}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001186
Gilles Peskine192c72f2017-12-21 15:59:21 +01001187
Gilles Peskine636c26a2020-03-04 20:46:15 +01001188
Gilles Peskine192c72f2017-12-21 15:59:21 +01001189################################################################
1190#### Build and test many configurations and targets
1191################################################################
1192
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001193component_test_default_out_of_box () {
1194 msg "build: make, default config (out-of-box)" # ~1min
1195 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001196 # Disable fancy stuff
1197 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001198
1199 msg "test: main suites make, default config (out-of-box)" # ~10s
1200 make test
1201
1202 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001203 programs/test/selftest
Gilles Peskine82b27272019-06-14 18:27:03 +02001204
1205 msg "program demos: make, default config (out-of-box)" # ~10s
1206 tests/scripts/run_demos.py
Gilles Peskine7832c9f2019-04-08 17:00:15 +02001207}
1208
Gilles Peskine8f073122018-11-27 15:58:47 +01001209component_test_default_cmake_gcc_asan () {
1210 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001211 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1212 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001213
Gilles Peskine8f073122018-11-27 15:58:47 +01001214 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1215 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001216
Gilles Peskine82b27272019-06-14 18:27:03 +02001217 msg "program demos (ASan build)" # ~10s
1218 tests/scripts/run_demos.py
1219
Gilles Peskine97bea012020-04-23 23:37:45 +02001220 msg "test: selftest (ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001221 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001222
Gilles Peskine6848d172023-11-02 19:58:03 +01001223 msg "test: metatests (GCC, ASan build)"
David Horstmann9de6edd2024-01-17 14:53:08 +00001224 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01001225
Gilles Peskine8f073122018-11-27 15:58:47 +01001226 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001227 tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001228
Gilles Peskine8f073122018-11-27 15:58:47 +01001229 msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001230 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001231
1232 msg "test: context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001233 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001234}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001235
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001236component_test_default_cmake_gcc_asan_new_bignum () {
1237 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Janos Follath2f045822023-07-31 10:57:16 +01001238 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001239 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001240 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001241
1242 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
1243 make test
1244
1245 msg "test: selftest (ASan build)" # ~ 10s
1246 programs/test/selftest
1247
1248 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
1249 tests/ssl-opt.sh
1250
1251 msg "test: compat.sh (ASan build)" # ~ 6 min
1252 tests/compat.sh
1253
1254 msg "test: context-info.sh (ASan build)" # ~ 15 sec
1255 tests/context-info.sh
1256}
1257
Hanno Becker01635512019-02-26 14:27:09 +00001258component_test_full_cmake_gcc_asan () {
1259 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001260 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +00001261 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1262 make
1263
1264 msg "test: main suites (inc. selftests) (full config, ASan build)"
1265 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001266
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001267 msg "test: selftest (full config, ASan build)" # ~ 10s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001268 programs/test/selftest
Gilles Peskine97bea012020-04-23 23:37:45 +02001269
Gilles Peskine636c26a2020-03-04 20:46:15 +01001270 msg "test: ssl-opt.sh (full config, ASan build)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001271 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001272
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001273 # Note: the next two invocations cover all compat.sh test cases.
1274 # We should use the same here and in basic-build-test.sh.
1275 msg "test: compat.sh: default version (full config, ASan build)"
1276 tests/compat.sh -e 'ARIA\|CHACHA'
Manuel Pégourié-Gonnard62d0bb82024-04-17 12:30:05 +02001277
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001278 msg "test: compat.sh: next: ARIA, Chacha (full config, ASan build)"
1279 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001280
1281 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001282 tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001283}
1284
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001285
1286component_test_full_cmake_gcc_asan_new_bignum () {
1287 msg "build: full config, cmake, gcc, ASan"
1288 scripts/config.py full
Janos Follath2f045822023-07-31 10:57:16 +01001289 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001290 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Janos Follath82823b22023-07-27 12:25:05 +01001291 make
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001292
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001293 msg "test: main suites (inc. selftests) (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001294 make test
1295
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001296 msg "test: selftest (full config, new bignum, ASan)" # ~ 10s
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001297 programs/test/selftest
1298
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001299 msg "test: ssl-opt.sh (full config, new bignum, ASan)"
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001300 tests/ssl-opt.sh
1301
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001302 # Note: the next two invocations cover all compat.sh test cases.
1303 # We should use the same here and in basic-build-test.sh.
1304 msg "test: compat.sh: default version (full config, new bignum, ASan)"
1305 tests/compat.sh -e 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001306
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001307 msg "test: compat.sh: next: ARIA, Chacha (full config, new bignum, ASan)"
1308 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001309
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02001310 msg "test: context-info.sh (full config, new bignum, ASan)" # ~ 15 sec
Gabor Mezei9b6b5a02023-06-06 17:22:25 +02001311 tests/context-info.sh
Gabor Mezei6db60472023-07-05 16:38:42 +02001312}
1313
Ronald Cronc3623db2020-10-29 10:51:32 +01001314component_test_psa_crypto_key_id_encodes_owner () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001315 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
Ronald Cronc3623db2020-10-29 10:51:32 +01001316 scripts/config.py full
Ronald Cronc3623db2020-10-29 10:51:32 +01001317 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1318 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1319 make
1320
1321 msg "test: full config - USE_PSA_CRYPTO + PSA_CRYPTO_KEY_ID_ENCODES_OWNER, cmake, gcc, ASan"
1322 make test
1323}
1324
David Horstmann4a48bec2024-03-13 15:42:31 +00001325component_test_psa_assume_exclusive_buffers () {
1326 msg "build: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001327 scripts/config.py full
David Horstmann4a48bec2024-03-13 15:42:31 +00001328 scripts/config.py set MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann0f06bde2023-12-20 11:10:16 +00001329 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1330 make
1331
David Horstmann4a48bec2024-03-13 15:42:31 +00001332 msg "test: full config + MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS, cmake, gcc, ASan"
David Horstmann0f06bde2023-12-20 11:10:16 +00001333 make test
1334}
1335
Gilles Peskinea3548672021-06-17 11:37:52 +02001336# check_renamed_symbols HEADER LIB
1337# Check that if HEADER contains '#define MACRO ...' then MACRO is not a symbol
1338# name is LIB.
1339check_renamed_symbols () {
1340 ! nm "$2" | sed 's/.* //' |
1341 grep -x -F "$(sed -n 's/^ *# *define *\([A-Z_a-z][0-9A-Z_a-z]*\)..*/\1/p' "$1")"
1342}
1343
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001344component_build_psa_crypto_spm () {
Andrzej Kurek03e01462022-01-03 12:53:24 +01001345 msg "build: full config + PSA_CRYPTO_KEY_ID_ENCODES_OWNER + PSA_CRYPTO_SPM, make, gcc"
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001346 scripts/config.py full
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001347 scripts/config.py unset MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1348 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
1349 scripts/config.py set MBEDTLS_PSA_CRYPTO_SPM
1350 # We can only compile, not link, since our test and sample programs
1351 # aren't equipped for the modified names used when MBEDTLS_PSA_CRYPTO_SPM
1352 # is active.
1353 make CC=gcc CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' lib
Gilles Peskinea3548672021-06-17 11:37:52 +02001354
1355 # Check that if a symbol is renamed by crypto_spe.h, the non-renamed
1356 # version is not present.
1357 echo "Checking for renamed symbols in the library"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001358 check_renamed_symbols tests/include/spe/crypto_spe.h library/libmbedcrypto.a
Gilles Peskined1dcfd52021-06-15 18:37:38 +02001359}
1360
Valerio Setti63097752024-03-12 13:18:13 +01001361# Get a list of library-wise undefined symbols and ensure that they only
1362# belong to psa_xxx() functions and not to mbedtls_yyy() ones.
1363# This function is a common helper used by both:
1364# - component_test_default_psa_crypto_client_without_crypto_provider
1365# - component_build_full_psa_crypto_client_without_crypto_provider.
1366common_check_mbedtls_missing_symbols() {
1367 nm library/libmbedcrypto.a | grep ' [TRrDC] ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_def.txt
1368 nm library/libmbedcrypto.a | grep ' U ' | grep -Eo '(mbedtls_|psa_).*' | sort -u > sym_undef.txt
1369 comm sym_def.txt sym_undef.txt -13 > linking_errors.txt
1370 not grep mbedtls_ linking_errors.txt
1371
1372 rm sym_def.txt sym_undef.txt linking_errors.txt
1373}
1374
1375component_test_default_psa_crypto_client_without_crypto_provider () {
1376 msg "build: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1377
Ronald Cron336678b2021-01-28 17:54:24 +01001378 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1379 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Valerio Setti63097752024-03-12 13:18:13 +01001380 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001381 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron336678b2021-01-28 17:54:24 +01001382 scripts/config.py set MBEDTLS_PSA_CRYPTO_CLIENT
Raef Colesb4568c52022-09-28 17:11:42 +01001383 scripts/config.py unset MBEDTLS_LMS_C
Valerio Setti63097752024-03-12 13:18:13 +01001384
Ronald Cron336678b2021-01-28 17:54:24 +01001385 make
1386
Valerio Setti63097752024-03-12 13:18:13 +01001387 msg "check missing symbols: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
1388 common_check_mbedtls_missing_symbols
1389
1390 msg "test: default config - PSA_CRYPTO_C + PSA_CRYPTO_CLIENT"
Ronald Cron336678b2021-01-28 17:54:24 +01001391 make test
1392}
1393
Valerio Setti63097752024-03-12 13:18:13 +01001394component_build_full_psa_crypto_client_without_crypto_provider () {
1395 msg "build: full config - PSA_CRYPTO_C"
1396
1397 # Use full config which includes USE_PSA and CRYPTO_CLIENT.
1398 scripts/config.py full
1399
1400 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1401 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1402 # Dynamic secure element support is a deprecated feature and it is not
1403 # available when CRYPTO_C and PSA_CRYPTO_STORAGE_C are disabled.
1404 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1405
1406 # Since there is no crypto provider in this build it is not possible to
1407 # build all the test executables and progrems due to missing PSA functions
1408 # at link time. Therefore we will just build libraries and we'll check
1409 # that symbols of interest are there.
1410 make lib
1411
1412 msg "check missing symbols: full config - PSA_CRYPTO_C"
1413
1414 common_check_mbedtls_missing_symbols
1415
1416 # Ensure that desired functions are included into the build (extend the
1417 # following list as required).
1418 grep mbedtls_pk_get_psa_attributes library/libmbedcrypto.a
1419 grep mbedtls_pk_import_into_psa library/libmbedcrypto.a
1420 grep mbedtls_pk_copy_from_psa library/libmbedcrypto.a
1421}
1422
Ryan Everettdaa322a2024-04-18 16:48:55 +01001423component_test_no_rsa_key_pair_generation() {
1424 msg "build: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Ryan Everettfcd744f2024-04-22 10:44:24 +01001425 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
Jaeden Amero424fa932021-05-14 08:34:32 +01001426 scripts/config.py unset MBEDTLS_GENPRIME
Ryan Everettdaa322a2024-04-18 16:48:55 +01001427 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Jaeden Amero424fa932021-05-14 08:34:32 +01001428 make
1429
Ryan Everettdaa322a2024-04-18 16:48:55 +01001430 msg "test: default config minus PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE"
Jaeden Amero424fa932021-05-14 08:34:32 +01001431 make test
1432}
1433
Gilles Peskine782f4112018-11-27 16:11:09 +01001434component_test_ref_configs () {
1435 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001436 # test-ref-configs works by overwriting mbedtls_config.h; this makes cmake
1437 # want to re-generate generated files that depend on it, quite correctly.
1438 # However this doesn't work as the generation script expects a specific
1439 # format for mbedtls_config.h, which the other files don't follow. Also,
1440 # cmake can't know this, but re-generation is actually not necessary as
David Horstmannd64f4b22021-10-20 12:29:47 +01001441 # the generated files only depend on the list of available options, not
Manuel Pégourié-Gonnard9327fb32021-09-09 11:46:25 +02001442 # whether they're on or off. So, disable cmake's (over-sensitive here)
1443 # dependency resolution for generated files and just rely on them being
David Horstmanna8d14062021-10-20 17:14:23 +01001444 # present (thanks to pre_generate_files) by turning GEN_FILES off.
Dave Rodgman17127e92023-12-14 16:42:48 +00001445 CC=$ASAN_CC cmake -D GEN_FILES=Off -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001446 tests/scripts/test-ref-configs.pl
Gilles Peskine782f4112018-11-27 16:11:09 +01001447}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +02001448
Gilles Peskine8f073122018-11-27 15:58:47 +01001449component_test_no_renegotiation () {
1450 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001451 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Dave Rodgman17127e92023-12-14 16:42:48 +00001452 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001453 make
Simon Butcher3ea7f522016-03-07 23:22:10 +00001454
Gilles Peskine8f073122018-11-27 15:58:47 +01001455 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
1456 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +01001457
Gilles Peskine8f073122018-11-27 15:58:47 +01001458 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001459 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001460}
Hanno Becker134c2ab2017-10-12 15:29:50 +01001461
Gilles Peskine636c26a2020-03-04 20:46:15 +01001462component_test_no_pem_no_fs () {
1463 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
1464 scripts/config.py unset MBEDTLS_PEM_PARSE_C
1465 scripts/config.py unset MBEDTLS_FS_IO
1466 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
1467 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
Dave Rodgman17127e92023-12-14 16:42:48 +00001468 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine636c26a2020-03-04 20:46:15 +01001469 make
1470
1471 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
1472 make test
1473
1474 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001475 tests/ssl-opt.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +01001476}
1477
Gilles Peskine8f073122018-11-27 15:58:47 +01001478component_test_rsa_no_crt () {
1479 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001480 scripts/config.py set MBEDTLS_RSA_NO_CRT
Dave Rodgman17127e92023-12-14 16:42:48 +00001481 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01001482 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +01001483
Gilles Peskine8f073122018-11-27 15:58:47 +01001484 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
1485 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001486
Gilles Peskine8f073122018-11-27 15:58:47 +01001487 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001488 tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001489
Gilles Peskine8f073122018-11-27 15:58:47 +01001490 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001491 tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001492
1493 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001494 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001495}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01001496
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001497component_test_no_ctr_drbg_classic () {
1498 msg "build: Full minus CTR_DRBG, classic crypto in TLS"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001499 scripts/config.py full
1500 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001501 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001502 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001503
Dave Rodgman17127e92023-12-14 16:42:48 +00001504 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001505 make
1506
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001507 msg "test: Full minus CTR_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001508 make test
1509
Gilles Peskineba749042021-01-13 20:02:03 +01001510 # In this configuration, the TLS test programs use HMAC_DRBG.
1511 # The SSL tests are slow, so run a small subset, just enough to get
1512 # confidence that the SSL code copes with HMAC_DRBG.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001513 msg "test: Full minus CTR_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001514 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskineba749042021-01-13 20:02:03 +01001515
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001516 msg "test: Full minus CTR_DRBG, classic crypto - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001517 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001518}
1519
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001520component_test_no_ctr_drbg_use_psa () {
1521 msg "build: Full minus CTR_DRBG, PSA crypto in TLS"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001522 scripts/config.py full
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001523 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1524 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001525
Dave Rodgman17127e92023-12-14 16:42:48 +00001526 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001527 make
1528
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001529 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - main suites"
1530 make test
1531
1532 # In this configuration, the TLS test programs use HMAC_DRBG.
1533 # The SSL tests are slow, so run a small subset, just enough to get
1534 # confidence that the SSL code copes with HMAC_DRBG.
1535 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001536 tests/ssl-opt.sh -f 'Default\|SSL async private.*delay=\|tickets enabled on server'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001537
1538 msg "test: Full minus CTR_DRBG, USE_PSA_CRYPTO - compat.sh (subset)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001539 tests/compat.sh -m tls12 -t 'ECDSA PSK' -V NO -p OpenSSL
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001540}
1541
1542component_test_no_hmac_drbg_classic () {
1543 msg "build: Full minus HMAC_DRBG, classic crypto in TLS"
1544 scripts/config.py full
1545 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1546 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1547 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001548 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001549
Dave Rodgman17127e92023-12-14 16:42:48 +00001550 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001551 make
1552
1553 msg "test: Full minus HMAC_DRBG, classic crypto - main suites"
Manuel Pégourié-Gonnard5b942dc2020-06-05 09:29:51 +02001554 make test
1555
Gilles Peskinea2224342020-11-19 22:14:34 +01001556 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1557 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1558 # instead.
1559 # Test SSL with non-deterministic ECDSA. Only test features that
1560 # might be affected by how ECDSA signature is performed.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001561 msg "test: Full minus HMAC_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001562 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskinea2224342020-11-19 22:14:34 +01001563
1564 # To save time, only test one protocol version, since this part of
1565 # the protocol is identical in (D)TLS up to 1.2.
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001566 msg "test: Full minus HMAC_DRBG, classic crypto - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001567 tests/compat.sh -m tls12 -t 'ECDSA'
Manuel Pégourié-Gonnard817e3682020-05-28 12:55:10 +02001568}
1569
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001570component_test_no_hmac_drbg_use_psa () {
1571 msg "build: Full minus HMAC_DRBG, PSA crypto in TLS"
1572 scripts/config.py full
1573 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1574 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
1575 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1576
Dave Rodgman17127e92023-12-14 16:42:48 +00001577 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001578 make
1579
1580 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - main suites"
1581 make test
1582
1583 # Normally our ECDSA implementation uses deterministic ECDSA. But since
1584 # HMAC_DRBG is disabled in this configuration, randomized ECDSA is used
1585 # instead.
1586 # Test SSL with non-deterministic ECDSA. Only test features that
1587 # might be affected by how ECDSA signature is performed.
1588 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001589 tests/ssl-opt.sh -f 'Default\|SSL async private: sign'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001590
1591 # To save time, only test one protocol version, since this part of
1592 # the protocol is identical in (D)TLS up to 1.2.
1593 msg "test: Full minus HMAC_DRBG, USE_PSA_CRYPTO - compat.sh (ECDSA)"
Xiaofei Bai8b5c3822021-12-02 08:43:35 +00001594 tests/compat.sh -m tls12 -t 'ECDSA'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001595}
1596
1597component_test_psa_external_rng_no_drbg_classic () {
1598 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto in TLS"
1599 scripts/config.py full
1600 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf6606552022-03-15 11:23:25 +01001601 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001602 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001603 scripts/config.py unset MBEDTLS_ENTROPY_C
1604 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1605 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001606 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1607 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1608 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine8eb29432021-02-03 20:07:11 +01001609 # When MBEDTLS_USE_PSA_CRYPTO is disabled and there is no DRBG,
1610 # the SSL test programs don't have an RNG and can't work. Explicitly
1611 # make them use the PSA RNG with -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001612 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -DMBEDTLS_TEST_USE_PSA_CRYPTO_RNG" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001613
1614 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - main suites"
1615 make test
1616
Gilles Peskine8eb29432021-02-03 20:07:11 +01001617 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, classic crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001618 tests/ssl-opt.sh -f 'Default'
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001619}
1620
1621component_test_psa_external_rng_no_drbg_use_psa () {
1622 msg "build: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto in TLS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001623 scripts/config.py full
1624 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Gilles Peskine38c12fd2021-02-08 21:02:53 +01001625 scripts/config.py unset MBEDTLS_ENTROPY_C
1626 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1627 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskinec109b372020-11-23 17:39:04 +01001628 scripts/config.py unset MBEDTLS_CTR_DRBG_C
1629 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
1630 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
Gilles Peskine21570cf2023-12-22 11:49:50 +01001631 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec109b372020-11-23 17:39:04 +01001632
Gilles Peskine2747d7d2021-02-03 14:56:51 +01001633 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - main suites"
Gilles Peskinec109b372020-11-23 17:39:04 +01001634 make test
1635
Gilles Peskine8eb29432021-02-03 20:07:11 +01001636 msg "test: PSA_CRYPTO_EXTERNAL_RNG minus *_DRBG, PSA crypto - ssl-opt.sh (subset)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001637 tests/ssl-opt.sh -f 'Default\|opaque'
Gilles Peskinec109b372020-11-23 17:39:04 +01001638}
1639
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001640component_test_psa_external_rng_use_psa_crypto () {
1641 msg "build: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1642 scripts/config.py full
1643 scripts/config.py set MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1644 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
1645 scripts/config.py unset MBEDTLS_CTR_DRBG_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01001646 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine4bdb2542023-04-28 19:25:25 +02001647
1648 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1649 make test
1650
1651 msg "test: full + PSA_CRYPTO_EXTERNAL_RNG + USE_PSA_CRYPTO minus CTR_DRBG"
1652 tests/ssl-opt.sh -f 'Default\|opaque'
1653}
1654
Gilles Peskine801c4332023-04-28 21:04:28 +02001655component_test_psa_inject_entropy () {
1656 msg "build: full + MBEDTLS_PSA_INJECT_ENTROPY"
1657 scripts/config.py full
1658 scripts/config.py set MBEDTLS_PSA_INJECT_ENTROPY
1659 scripts/config.py set MBEDTLS_ENTROPY_NV_SEED
1660 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1661 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
1662 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_READ
1663 scripts/config.py unset MBEDTLS_PLATFORM_STD_NV_SEED_WRITE
Gilles Peskine21570cf2023-12-22 11:49:50 +01001664 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 +02001665
1666 msg "test: full + MBEDTLS_PSA_INJECT_ENTROPY"
1667 make test
1668}
1669
Andrzej Kurek06969fc2023-04-12 10:34:50 -04001670component_test_sw_inet_pton () {
1671 msg "build: default plus MBEDTLS_TEST_SW_INET_PTON"
1672
1673 # MBEDTLS_TEST_HOOKS required for x509_crt_parse_cn_inet_pton
1674 scripts/config.py set MBEDTLS_TEST_HOOKS
1675 make CFLAGS="-DMBEDTLS_TEST_SW_INET_PTON"
1676
1677 msg "test: default plus MBEDTLS_TEST_SW_INET_PTON"
1678 make test
1679}
1680
Valerio Settia41654d2024-02-08 10:33:11 +01001681component_full_no_pkparse_pkwrite() {
1682 msg "build: full without pkparse and pkwrite"
1683
1684 scripts/config.py crypto_full
1685 scripts/config.py unset MBEDTLS_PK_PARSE_C
1686 scripts/config.py unset MBEDTLS_PK_WRITE_C
1687
Valerio Settia41654d2024-02-08 10:33:11 +01001688 make CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
1689
1690 # Ensure that PK_[PARSE|WRITE]_C were not re-enabled accidentally (additive config).
1691 not grep mbedtls_pk_parse_key library/pkparse.o
1692 not grep mbedtls_pk_write_key_der library/pkwrite.o
1693
1694 msg "test: full without pkparse and pkwrite"
1695 make test
1696}
1697
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001698component_test_crypto_full_md_light_only () {
1699 msg "build: crypto_full with only the light subset of MD"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001700 scripts/config.py crypto_full
Gilles Peskine884b4622023-07-20 20:11:51 +02001701 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001702 # Disable MD
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001703 scripts/config.py unset MBEDTLS_MD_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001704 # Disable direct dependencies of MD_C
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001705 scripts/config.py unset MBEDTLS_HKDF_C
1706 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
Nick Child89e82e12022-11-09 10:36:10 -06001707 scripts/config.py unset MBEDTLS_PKCS7_C
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001708 # Disable indirect dependencies of MD_C
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001709 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC # needs HMAC_DRBG
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01001710 # Disable things that would auto-enable MD_C
1711 scripts/config.py unset MBEDTLS_PKCS5_C
1712
Manuel Pégourié-Gonnard1b5ffc62023-03-14 10:11:20 +01001713 # Note: MD-light is auto-enabled in build_info.h by modules that need it,
1714 # which we haven't disabled, so no need to explicitly enable it.
Gilles Peskine21570cf2023-12-22 11:49:50 +01001715 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001716
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001717 # Make sure we don't have the HMAC functions, but the hashing functions
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001718 not grep mbedtls_md_hmac library/md.o
Manuel Pégourié-Gonnard0d415212023-02-23 13:02:13 +01001719 grep mbedtls_md library/md.o
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01001720
1721 msg "test: crypto_full with only the light subset of MD"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001722 make test
Przemek Stekielfe2367a2022-04-28 15:44:18 +02001723}
1724
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001725component_test_full_no_cipher_no_psa_crypto () {
Valerio Settidf17a102023-10-23 14:14:19 +02001726 msg "build: full no CIPHER no PSA_CRYPTO_C"
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001727 scripts/config.py full
1728 scripts/config.py unset MBEDTLS_CIPHER_C
Gilles Peskine9b8dead2023-08-09 19:48:42 +02001729 # Don't pull in cipher via PSA mechanisms
1730 # (currently ignored anyway because we completely disable PSA)
1731 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti4529d652023-10-24 11:51:58 +02001732 # Disable features that depend on CIPHER_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001733 scripts/config.py unset MBEDTLS_CMAC_C
1734 scripts/config.py unset MBEDTLS_NIST_KW_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001735 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01001736 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001737 scripts/config.py unset MBEDTLS_SSL_TLS_C
1738 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Valerio Setti4529d652023-10-24 11:51:58 +02001739 # Disable features that depend on PSA_CRYPTO_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001740 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
1741 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001742 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Raef Colesa7e03ad2022-09-28 09:32:48 +01001743 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01001744 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001745
Valerio Settidf17a102023-10-23 14:14:19 +02001746 msg "test: full no CIPHER no PSA_CRYPTO_C"
Gilles Peskine21570cf2023-12-22 11:49:50 +01001747 make test
Przemek Stekiel10f3a602022-05-02 10:55:33 +02001748}
1749
Valerio Setti7e710e82023-08-25 09:14:15 +02001750# This is a common configurator and test function that is used in:
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001751# - component_test_full_no_cipher_with_psa_crypto
1752# - component_test_full_no_cipher_with_psa_crypto_config
Valerio Setti7e710e82023-08-25 09:14:15 +02001753# It accepts 2 input parameters:
1754# - $1: boolean value which basically reflects status of MBEDTLS_PSA_CRYPTO_CONFIG
1755# - $2: a text string which describes the test component
Valerio Setti5b4039f2023-10-24 13:41:44 +02001756common_test_full_no_cipher_with_psa_crypto () {
Valerio Setti7e710e82023-08-25 09:14:15 +02001757 USE_CRYPTO_CONFIG="$1"
1758 COMPONENT_DESCRIPTION="$2"
1759
1760 msg "build: $COMPONENT_DESCRIPTION"
1761
1762 scripts/config.py full
1763 scripts/config.py unset MBEDTLS_CIPHER_C
1764
1765 if [ "$USE_CRYPTO_CONFIG" -eq 1 ]; then
Valerio Setti862021a2023-10-24 13:52:06 +02001766 # The built-in implementation of the following algs/key-types depends
1767 # on CIPHER_C so we disable them.
1768 # This does not hold for KEY_TYPE_CHACHA20 and ALG_CHACHA20_POLY1305
1769 # so we keep them enabled.
Valerio Setti7e710e82023-08-25 09:14:15 +02001770 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Valerio Setti7e710e82023-08-25 09:14:15 +02001771 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CMAC
1772 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_NO_PADDING
1773 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CBC_PKCS7
1774 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CFB
1775 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_CTR
1776 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_ECB_NO_PADDING
1777 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_OFB
Ronald Crona33a8242024-05-15 18:31:17 +02001778 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti7e710e82023-08-25 09:14:15 +02001779 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_ALG_STREAM_CIPHER
Valerio Setti7e710e82023-08-25 09:14:15 +02001780 scripts/config.py -f $CRYPTO_CONFIG_H unset PSA_WANT_KEY_TYPE_DES
Valerio Setti7e710e82023-08-25 09:14:15 +02001781 else
1782 # Don't pull in cipher via PSA mechanisms
1783 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Valerio Setti287f6d12023-10-24 14:12:59 +02001784 # Disable cipher modes/keys that make PSA depend on CIPHER_C.
1785 # Keep CHACHA20 and CHACHAPOLY enabled since they do not depend on CIPHER_C.
1786 scripts/config.py unset-all MBEDTLS_CIPHER_MODE
Valerio Setti7e710e82023-08-25 09:14:15 +02001787 fi
Valerio Settic84d9402023-10-23 14:58:25 +02001788 # The following modules directly depends on CIPHER_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001789 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Setti7e710e82023-08-25 09:14:15 +02001790 scripts/config.py unset MBEDTLS_NIST_KW_C
Valerio Settifb0b0ff2023-10-23 14:58:55 +02001791
Gilles Peskine21570cf2023-12-22 11:49:50 +01001792 make
Gilles Peskine636c26a2020-03-04 20:46:15 +01001793
Valerio Setti7e710e82023-08-25 09:14:15 +02001794 # Ensure that CIPHER_C was not re-enabled
1795 not grep mbedtls_cipher_init library/cipher.o
1796
1797 msg "test: $COMPONENT_DESCRIPTION"
1798 make test
1799}
1800
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001801component_test_full_no_cipher_with_psa_crypto() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001802 common_test_full_no_cipher_with_psa_crypto 0 "full no CIPHER no CRYPTO_CONFIG"
Valerio Setti7e710e82023-08-25 09:14:15 +02001803}
1804
Manuel Pégourié-Gonnard88bae8b2024-01-08 10:56:35 +01001805component_test_full_no_cipher_with_psa_crypto_config() {
Valerio Setti5b4039f2023-10-24 13:41:44 +02001806 common_test_full_no_cipher_with_psa_crypto 1 "full no CIPHER"
Valerio Setti7e710e82023-08-25 09:14:15 +02001807}
1808
Valerio Settibdfecb62023-11-07 15:37:20 +01001809component_test_full_no_ccm() {
1810 msg "build: full no PSA_WANT_ALG_CCM"
1811
1812 # Full config enables:
1813 # - USE_PSA_CRYPTO so that TLS code dispatches cipher/AEAD to PSA
1814 # - CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1815 scripts/config.py full
1816
1817 # Disable PSA_WANT_ALG_CCM so that CCM is not supported in PSA. CCM_C is still
1818 # enabled, but not used from TLS since USE_PSA is set.
1819 # This is helpful to ensure that TLS tests below have proper dependencies.
1820 #
1821 # Note: also PSA_WANT_ALG_CCM_STAR_NO_TAG is enabled, but it does not cause
1822 # PSA_WANT_ALG_CCM to be re-enabled.
1823 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM
1824
Gilles Peskine21570cf2023-12-22 11:49:50 +01001825 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001826
1827 msg "test: full no PSA_WANT_ALG_CCM"
Valerio Settiff2b06a2023-11-08 12:35:36 +01001828 make test
Valerio Settibdfecb62023-11-07 15:37:20 +01001829}
1830
1831component_test_full_no_ccm_star_no_tag() {
1832 msg "build: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
1833
1834 # Full config enables CRYPTO_CONFIG so that PSA_WANT config symbols are evaluated
1835 scripts/config.py full
1836
1837 # Disable CCM_STAR_NO_TAG, which is the target of this test, as well as all
1838 # other components that enable MBEDTLS_PSA_BUILTIN_CIPHER internal symbol.
1839 # This basically disables all unauthenticated ciphers on the PSA side, while
1840 # keeping AEADs enabled.
1841 #
1842 # Note: PSA_WANT_ALG_CCM is enabled, but it does not cause
1843 # PSA_WANT_ALG_CCM_STAR_NO_TAG to be re-enabled.
1844 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
1845 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_STREAM_CIPHER
1846 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
1847 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
1848 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
1849 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
1850 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
1851 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
1852
Gilles Peskine21570cf2023-12-22 11:49:50 +01001853 make
Valerio Settibdfecb62023-11-07 15:37:20 +01001854
1855 # Ensure MBEDTLS_PSA_BUILTIN_CIPHER was not enabled
Valerio Settibdfecb62023-11-07 15:37:20 +01001856 not grep mbedtls_psa_cipher library/psa_crypto_cipher.o
Valerio Settiff2b06a2023-11-08 12:35:36 +01001857
1858 msg "test: full no PSA_WANT_ALG_CCM_STAR_NO_TAG"
Gilles Peskine636c26a2020-03-04 20:46:15 +01001859 make test
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02001860}
Gilles Peskine636c26a2020-03-04 20:46:15 +01001861
Valerio Settie1655b82023-01-03 15:35:25 +01001862component_test_full_no_bignum () {
1863 msg "build: full minus bignum"
1864 scripts/config.py full
1865 scripts/config.py unset MBEDTLS_BIGNUM_C
1866 # Direct dependencies of bignum
1867 scripts/config.py unset MBEDTLS_ECP_C
1868 scripts/config.py unset MBEDTLS_RSA_C
1869 scripts/config.py unset MBEDTLS_DHM_C
1870 # Direct dependencies of ECP
1871 scripts/config.py unset MBEDTLS_ECDH_C
1872 scripts/config.py unset MBEDTLS_ECDSA_C
1873 scripts/config.py unset MBEDTLS_ECJPAKE_C
1874 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti22d0a792023-06-14 17:23:19 +02001875 # Disable what auto-enables ECP_LIGHT
1876 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
1877 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Settie1655b82023-01-03 15:35:25 +01001878 # Indirect dependencies of ECP
1879 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
1880 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
1881 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
1882 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
1883 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
1884 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1885 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1886 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1887 # Direct dependencies of DHM
1888 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
1889 # Direct dependencies of RSA
1890 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
1891 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
1892 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
1893 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
1894 # PK and its dependencies
1895 scripts/config.py unset MBEDTLS_PK_C
1896 scripts/config.py unset MBEDTLS_PK_PARSE_C
1897 scripts/config.py unset MBEDTLS_PK_WRITE_C
1898 scripts/config.py unset MBEDTLS_X509_USE_C
1899 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
1900 scripts/config.py unset MBEDTLS_X509_CRL_PARSE_C
1901 scripts/config.py unset MBEDTLS_X509_CSR_PARSE_C
1902 scripts/config.py unset MBEDTLS_X509_CREATE_C
1903 scripts/config.py unset MBEDTLS_X509_CRT_WRITE_C
1904 scripts/config.py unset MBEDTLS_X509_CSR_WRITE_C
1905 scripts/config.py unset MBEDTLS_PKCS7_C
1906 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
1907 scripts/config.py unset MBEDTLS_SSL_ASYNC_PRIVATE
1908 scripts/config.py unset MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1909
Gilles Peskine21570cf2023-12-22 11:49:50 +01001910 make
Valerio Settie1655b82023-01-03 15:35:25 +01001911
1912 msg "test: full minus bignum"
1913 make test
1914}
1915
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001916component_test_tls1_2_default_stream_cipher_only () {
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001917 msg "build: default with only stream cipher"
1918
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001919 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001920 scripts/config.py unset MBEDTLS_GCM_C
1921 scripts/config.py unset MBEDTLS_CCM_C
1922 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001923 #Disable TLS 1.3 (as no AEAD)
1924 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001925 # 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 +02001926 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001927 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001928 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001929 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1930 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001931 # Modules that depend on AEAD
Przemek Stekield582a012022-09-28 07:59:01 +02001932 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001933 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001934
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001935 make
1936
1937 msg "test: default with only stream cipher"
1938 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001939
1940 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001941}
1942
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001943component_test_tls1_2_default_stream_cipher_only_use_psa () {
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001944 msg "build: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001945
Przemek Stekiel0cc34662022-09-28 12:06:57 +02001946 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001947 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001948 scripts/config.py unset MBEDTLS_GCM_C
1949 scripts/config.py unset MBEDTLS_CCM_C
1950 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001951 #Disable TLS 1.3 (as no AEAD)
1952 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001953 # 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 +02001954 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001955 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekiel9550c052022-09-28 09:51:55 +02001956 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001957 # Enable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
1958 scripts/config.py set MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001959 # Modules that depend on AEAD
Przemek Stekiel9550c052022-09-28 09:51:55 +02001960 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001961 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel9550c052022-09-28 09:51:55 +02001962
Przemek Stekiel9550c052022-09-28 09:51:55 +02001963 make
1964
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001965 msg "test: default with only stream cipher use psa"
Przemek Stekiel9550c052022-09-28 09:51:55 +02001966 make test
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001967
1968 # Not running ssl-opt.sh because most tests require a non-NULL ciphersuite.
Przemek Stekiel9550c052022-09-28 09:51:55 +02001969}
Przemek Stekiel11c362a2022-09-27 13:34:31 +02001970
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001971component_test_tls1_2_default_cbc_legacy_cipher_only () {
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001972 msg "build: default with only CBC-legacy cipher"
1973
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001974 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001975 scripts/config.py unset MBEDTLS_GCM_C
1976 scripts/config.py unset MBEDTLS_CCM_C
1977 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01001978 #Disable TLS 1.3 (as no AEAD)
1979 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001980 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
1981 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
1982 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001983 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001984 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001985 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02001986 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001987 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02001988 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001989
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001990 make
1991
1992 msg "test: default with only CBC-legacy cipher"
1993 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02001994
1995 msg "test: default with only CBC-legacy cipher - ssl-opt.sh (subset)"
1996 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02001997}
1998
Przemek Stekiel68db0d22022-09-29 08:32:25 +02001999component_test_tls1_2_deafult_cbc_legacy_cipher_only_use_psa () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002000 msg "build: default with only CBC-legacy cipher use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002001
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002002 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002003 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002004 scripts/config.py unset MBEDTLS_GCM_C
2005 scripts/config.py unset MBEDTLS_CCM_C
2006 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002007 #Disable TLS 1.3 (as no AEAD)
2008 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002009 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2010 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2011 # Disable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002012 scripts/config.py unset MBEDTLS_SSL_ENCRYPT_THEN_MAC
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002013 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002014 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002015 # Modules that depend on AEAD
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002016 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002017 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002018
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002019 make
2020
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002021 msg "test: default with only CBC-legacy cipher use psa"
2022 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002023
2024 msg "test: default with only CBC-legacy cipher use psa - ssl-opt.sh (subset)"
2025 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002026}
2027
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002028component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only () {
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002029 msg "build: default with only CBC-legacy and CBC-EtM ciphers"
2030
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002031 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002032 scripts/config.py unset MBEDTLS_GCM_C
2033 scripts/config.py unset MBEDTLS_CCM_C
2034 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002035 #Disable TLS 1.3 (as no AEAD)
2036 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002037 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2038 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2039 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2040 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2041 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002042 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002043 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002044 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002045 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002046
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002047 make
2048
2049 msg "test: default with only CBC-legacy and CBC-EtM ciphers"
2050 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002051
2052 msg "test: default with only CBC-legacy and CBC-EtM ciphers - ssl-opt.sh (subset)"
2053 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002054}
2055
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002056component_test_tls1_2_default_cbc_legacy_cbc_etm_cipher_only_use_psa () {
2057 msg "build: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002058
2059 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002060 # Disable AEAD (controlled by the presence of one of GCM_C, CCM_C, CHACHAPOLY_C)
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002061 scripts/config.py unset MBEDTLS_GCM_C
2062 scripts/config.py unset MBEDTLS_CCM_C
2063 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Crona3f385d2024-03-18 10:25:37 +01002064 #Disable TLS 1.3 (as no AEAD)
2065 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Przemek Stekiel68db0d22022-09-29 08:32:25 +02002066 # Enable CBC-legacy (controlled by MBEDTLS_CIPHER_MODE_CBC plus at least one block cipher (AES, ARIA, Camellia, DES))
2067 scripts/config.py set MBEDTLS_CIPHER_MODE_CBC
2068 # Enable CBC-EtM (controlled by the same as CBC-legacy plus MBEDTLS_SSL_ENCRYPT_THEN_MAC)
2069 scripts/config.py set MBEDTLS_SSL_ENCRYPT_THEN_MAC
2070 # Disable stream (currently that's just the NULL pseudo-cipher (controlled by MBEDTLS_CIPHER_NULL_CIPHER))
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002071 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Przemek Stekiel6a5cc742022-10-03 09:04:16 +02002072 # Modules that depend on AEAD
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002073 scripts/config.py unset MBEDTLS_SSL_CONTEXT_SERIALIZATION
Przemek Stekiel52a428b2022-10-10 08:47:13 +02002074 scripts/config.py unset MBEDTLS_SSL_TICKET_C
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002075
Przemek Stekiel0cc34662022-09-28 12:06:57 +02002076 make
2077
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002078 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002079 make test
Przemek Stekiel48a6a662022-09-29 15:22:01 +02002080
2081 msg "test: default with only CBC-legacy and CBC-EtM ciphers use psa - ssl-opt.sh (subset)"
2082 tests/ssl-opt.sh -f "TLS 1.2"
Przemek Stekielb0de1c02022-09-28 10:23:22 +02002083}
2084
Valerio Setti9f0ec532022-11-08 13:03:24 +01002085# We're not aware of any other (open source) implementation of EC J-PAKE in TLS
2086# that we could use for interop testing. However, we now have sort of two
2087# implementations ourselves: one using PSA, the other not. At least test that
2088# these two interoperate with each other.
2089component_test_tls1_2_ecjpake_compatibility() {
2090 msg "build: TLS1.2 server+client w/ EC-JPAKE w/o USE_PSA"
2091 scripts/config.py set MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Gilles Peskineedc84562023-09-20 15:03:18 +02002092 # Explicitly make lib first to avoid a race condition:
2093 # https://github.com/Mbed-TLS/mbedtls/issues/8229
2094 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002095 make -C programs ssl/ssl_server2 ssl/ssl_client2
2096 cp programs/ssl/ssl_server2 s2_no_use_psa
2097 cp programs/ssl/ssl_client2 c2_no_use_psa
2098
2099 msg "build: TLS1.2 server+client w/ EC-JPAKE w/ USE_PSA"
2100 scripts/config.py set MBEDTLS_USE_PSA_CRYPTO
2101 make clean
Gilles Peskineedc84562023-09-20 15:03:18 +02002102 make lib
Valerio Setti9f0ec532022-11-08 13:03:24 +01002103 make -C programs ssl/ssl_server2 ssl/ssl_client2
2104 make -C programs test/udp_proxy test/query_compile_time_config
2105
Valerio Setti70e02902022-12-02 16:21:56 +01002106 msg "test: server w/o USE_PSA - client w/ USE_PSA, text password"
2107 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2108 msg "test: server w/o USE_PSA - client w/ USE_PSA, opaque password"
2109 P_SRV=../s2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: opaque password client only, working, TLS"
2110 msg "test: client w/o USE_PSA - server w/ USE_PSA, text password"
2111 P_CLI=../c2_no_use_psa tests/ssl-opt.sh -f "ECJPAKE: working, TLS"
2112 msg "test: client w/o USE_PSA - server w/ USE_PSA, opaque password"
2113 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 +01002114
2115 rm s2_no_use_psa c2_no_use_psa
2116}
2117
Gilles Peskine636c26a2020-03-04 20:46:15 +01002118component_test_everest () {
2119 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
2120 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2121 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
2122 make
2123
2124 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
2125 make test
2126
Gilles Peskine6848d172023-11-02 19:58:03 +01002127 msg "test: metatests (clang, ASan)"
David Horstmann9de6edd2024-01-17 14:53:08 +00002128 tests/scripts/run-metatests.sh any asan poison
Gilles Peskine6848d172023-11-02 19:58:03 +01002129
Gilles Peskine636c26a2020-03-04 20:46:15 +01002130 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
2131 tests/ssl-opt.sh -f ECDH
2132
2133 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
2134 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02002135 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine636c26a2020-03-04 20:46:15 +01002136}
2137
Gilles Peskined3beca92020-07-03 00:15:37 +02002138component_test_everest_curve25519_only () {
2139 msg "build: Everest ECDH context, only Curve25519" # ~ 6 min
Gilles Peskined3beca92020-07-03 00:15:37 +02002140 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
2141 scripts/config.py unset MBEDTLS_ECDSA_C
2142 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2143 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
TRodziewicz7c1d41d2021-04-23 13:33:44 +02002144 scripts/config.py unset MBEDTLS_ECJPAKE_C
Gilles Peskined3beca92020-07-03 00:15:37 +02002145 # Disable all curves
Valerio Setti2e0275d2023-07-28 16:33:13 +02002146 scripts/config.py unset-all "MBEDTLS_ECP_DP_[0-9A-Z_a-z]*_ENABLED"
Gilles Peskined3beca92020-07-03 00:15:37 +02002147 scripts/config.py set MBEDTLS_ECP_DP_CURVE25519_ENABLED
2148
Dave Rodgman17127e92023-12-14 16:42:48 +00002149 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskined3beca92020-07-03 00:15:37 +02002150
2151 msg "test: Everest ECDH context, only Curve25519" # ~ 50s
2152 make test
2153}
2154
Gilles Peskine8f073122018-11-27 15:58:47 +01002155component_test_small_ssl_out_content_len () {
2156 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002157 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
2158 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00002159 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002160 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +01002161
Gilles Peskine8f073122018-11-27 15:58:47 +01002162 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002163 tests/ssl-opt.sh -f "Max fragment\|Large packet"
Gilles Peskine8f073122018-11-27 15:58:47 +01002164}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002165
Gilles Peskine8f073122018-11-27 15:58:47 +01002166component_test_small_ssl_in_content_len () {
2167 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002168 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
2169 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Dave Rodgman17127e92023-12-14 16:42:48 +00002170 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002171 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002172
Gilles Peskine8f073122018-11-27 15:58:47 +01002173 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002174 tests/ssl-opt.sh -f "Max fragment"
Gilles Peskine8f073122018-11-27 15:58:47 +01002175}
Angus Grattonc4dd0732018-04-11 16:28:39 +10002176
Gilles Peskine8f073122018-11-27 15:58:47 +01002177component_test_small_ssl_dtls_max_buffering () {
2178 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002179 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Dave Rodgman17127e92023-12-14 16:42:48 +00002180 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002181 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10002182
Gilles Peskine8f073122018-11-27 15:58:47 +01002183 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002184 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 +01002185}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002186
Gilles Peskine8f073122018-11-27 15:58:47 +01002187component_test_small_mbedtls_ssl_dtls_max_buffering () {
2188 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +01002189 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Dave Rodgman17127e92023-12-14 16:42:48 +00002190 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01002191 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002192
Gilles Peskine8f073122018-11-27 15:58:47 +01002193 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002194 tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
Gilles Peskine8f073122018-11-27 15:58:47 +01002195}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002196
Gilles Peskine75cc7712019-09-06 19:47:17 +02002197component_test_psa_collect_statuses () {
2198 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02002199 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002200 tests/scripts/psa_collect_statuses.py
Gilles Peskine75cc7712019-09-06 19:47:17 +02002201 # Check that psa_crypto_init() succeeded at least once
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002202 grep -q '^0:psa_crypto_init:' tests/statuses.log
Gilles Peskine75cc7712019-09-06 19:47:17 +02002203 rm -f tests/statuses.log
2204}
2205
Gilles Peskine8f073122018-11-27 15:58:47 +01002206component_test_full_cmake_clang () {
2207 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002208 scripts/config.py full
Gilles Peskineda6017c2022-10-30 21:02:40 +01002209 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 +01002210 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01002211
k-stachowiak0291cb72019-06-26 15:52:12 +02002212 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +01002213 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01002214
Gilles Peskineda6017c2022-10-30 21:02:40 +01002215 msg "test: cpp_dummy_build (full config, clang)" # ~ 1s
2216 programs/test/cpp_dummy_build
2217
Gilles Peskine6848d172023-11-02 19:58:03 +01002218 msg "test: metatests (clang)"
Gilles Peskine102aea22023-11-03 18:05:38 +01002219 tests/scripts/run-metatests.sh any pthread
Gilles Peskine6848d172023-11-02 19:58:03 +01002220
Gilles Peskine82b27272019-06-14 18:27:03 +02002221 msg "program demos (full config, clang)" # ~10s
2222 tests/scripts/run_demos.py
2223
k-stachowiak0291cb72019-06-26 15:52:12 +02002224 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002225 tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +01002226
Gilles Peskine8f073122018-11-27 15:58:47 +01002227 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002228 tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Gilles Peskine8f073122018-11-27 15:58:47 +01002229}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02002230
Gilles Peskine0c671602022-11-29 16:01:41 +01002231skip_suites_without_constant_flow () {
2232 # Skip the test suites that don't have any constant-flow annotations.
2233 # This will need to be adjusted if we ever start declaring things as
2234 # secret from macros or functions inside tests/include or tests/src.
2235 SKIP_TEST_SUITES=$(
2236 git -C tests/suites grep -L TEST_CF_ 'test_suite_*.function' |
2237 sed 's/test_suite_//; s/\.function$//' |
2238 tr '\n' ,)
2239 export SKIP_TEST_SUITES
2240}
2241
Dave Rodgman246210e2023-07-31 18:07:44 +01002242skip_all_except_given_suite () {
2243 # Skip all but the given test suite
2244 SKIP_TEST_SUITES=$(
2245 ls -1 tests/suites/test_suite_*.function |
2246 grep -v $1.function |
2247 sed 's/tests.suites.test_suite_//; s/\.function$//' |
2248 tr '\n' ,)
2249 export SKIP_TEST_SUITES
2250}
2251
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002252component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002253 # This tests both (1) accesses to undefined memory, and (2) branches or
2254 # memory access depending on secret values. To distinguish between those:
2255 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2256 # - or alternatively, change the build type to MemSanDbg, which enables
2257 # origin tracking and nicer stack traces (which are useful for debugging
2258 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002259 msg "build: cmake MSan (clang), full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2260 scripts/config.py full
2261 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2262 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
2263 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2264 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2265 make
2266
2267 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO, Msan + constant flow)"
2268 make test
2269}
2270
2271component_test_memsan_constant_flow_psa () {
2272 # This tests both (1) accesses to undefined memory, and (2) branches or
2273 # memory access depending on secret values. To distinguish between those:
2274 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
2275 # - or alternatively, change the build type to MemSanDbg, which enables
2276 # origin tracking and nicer stack traces (which are useful for debugging
2277 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002278 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002279 scripts/config.py full
2280 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2281 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
2282 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
2283 make
2284
Manuel Pégourié-Gonnard0b2112d2020-07-22 11:09:28 +02002285 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002286 make test
2287}
2288
Bence Szépkúti0354d042023-12-06 16:14:37 +01002289component_release_test_valgrind_constant_flow () {
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002290 # This tests both (1) everything that valgrind's memcheck usually checks
2291 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2292 # etc.) and (2) branches or memory access depending on secret values,
2293 # which will be reported as uninitialized memory. To distinguish between
2294 # secret and actually uninitialized:
2295 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2296 # - or alternatively, build with debug info and manually run the offending
2297 # test suite with valgrind --track-origins=yes, then check if the origin
2298 # was TEST_CF_SECRET() or something else.
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002299 msg "build: cmake release GCC, full config minus MBEDTLS_USE_PSA_CRYPTO with constant flow testing"
2300 scripts/config.py full
2301 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2302 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine0c671602022-11-29 16:01:41 +01002303 skip_suites_without_constant_flow
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002304 cmake -D CMAKE_BUILD_TYPE:String=Release .
2305 make
2306
2307 # this only shows a summary of the results (how many of each type)
2308 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002309 msg "test: some suites (full minus MBEDTLS_USE_PSA_CRYPTO, valgrind + constant flow)"
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002310 make memcheck
Dave Rodgman246210e2023-07-31 18:07:44 +01002311
2312 # Test asm path in constant time module - by default, it will test the plain C
2313 # path under Valgrind or Memsan. Running only the constant_time tests is fast (<1s)
2314 msg "test: valgrind asm constant_time"
2315 scripts/config.py --force set MBEDTLS_TEST_CONSTANT_FLOW_ASM
2316 skip_all_except_given_suite test_suite_constant_time
2317 cmake -D CMAKE_BUILD_TYPE:String=Release .
2318 make clean
2319 make
2320 make memcheck
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002321}
2322
Bence Szépkúti0354d042023-12-06 16:14:37 +01002323component_release_test_valgrind_constant_flow_psa () {
Neil Armstrong0ab7a232022-03-18 09:57:32 +01002324 # This tests both (1) everything that valgrind's memcheck usually checks
2325 # (heap buffer overflows, use of uninitialized memory, use-after-free,
2326 # etc.) and (2) branches or memory access depending on secret values,
2327 # which will be reported as uninitialized memory. To distinguish between
2328 # secret and actually uninitialized:
2329 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
2330 # - or alternatively, build with debug info and manually run the offending
2331 # test suite with valgrind --track-origins=yes, then check if the origin
2332 # was TEST_CF_SECRET() or something else.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002333 msg "build: cmake release GCC, full config with constant flow testing"
2334 scripts/config.py full
2335 scripts/config.py set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
Gilles Peskine0c671602022-11-29 16:01:41 +01002336 skip_suites_without_constant_flow
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002337 cmake -D CMAKE_BUILD_TYPE:String=Release .
2338 make
2339
2340 # this only shows a summary of the results (how many of each type)
2341 # details are left in Testing/<date>/DynamicAnalysis.xml
Gilles Peskine0c671602022-11-29 16:01:41 +01002342 msg "test: some suites (valgrind + constant flow)"
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002343 make memcheck
2344}
2345
Janos Follath9338cac2023-10-04 18:55:39 +01002346component_test_tsan () {
2347 msg "build: TSan (clang)"
Paul Elliott356597f2023-12-01 18:09:41 +00002348 scripts/config.py full
Janos Follath9338cac2023-10-04 18:55:39 +01002349 scripts/config.py set MBEDTLS_THREADING_C
2350 scripts/config.py set MBEDTLS_THREADING_PTHREAD
Ryanb0b3c0d2024-03-01 17:30:12 +00002351 # Self-tests do not currently use multiple threads.
2352 scripts/config.py unset MBEDTLS_SELF_TEST
Janos Follath9338cac2023-10-04 18:55:39 +01002353
Ryan6caf84f2024-03-05 13:57:00 +00002354 # The deprecated MBEDTLS_PSA_CRYPTO_SE_C interface is not thread safe.
2355 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
2356
Janos Follath9338cac2023-10-04 18:55:39 +01002357 CC=clang cmake -D CMAKE_BUILD_TYPE:String=TSan .
2358 make
2359
2360 msg "test: main suites (TSan)"
2361 make test
2362}
2363
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002364component_test_default_no_deprecated () {
Gilles Peskine8386ea22020-04-30 09:07:29 +02002365 # Test that removing the deprecated features from the default
2366 # configuration leaves something consistent.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002367 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
2368 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002369 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002370
2371 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
2372 make test
2373}
2374
2375component_test_full_no_deprecated () {
Gilles Peskine30de2e82020-04-20 21:39:22 +02002376 msg "build: make, full_no_deprecated config" # ~ 30s
2377 scripts/config.py full_no_deprecated
Dave Rodgman84125a12024-01-02 11:42:38 +00002378 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002379
Gilles Peskine30de2e82020-04-20 21:39:22 +02002380 msg "test: make, full_no_deprecated config" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002381 make test
Valerio Setti41b5fb62023-01-09 12:20:45 +01002382
2383 msg "test: ensure that X509 has no direct dependency on BIGNUM_C"
2384 not grep mbedtls_mpi library/libmbedx509.a
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002385}
2386
Gilles Peskine8386ea22020-04-30 09:07:29 +02002387component_test_full_no_deprecated_deprecated_warning () {
2388 # Test that there is nothing deprecated in "full_no_deprecated".
2389 # A deprecated feature would trigger a warning (made fatal) from
2390 # MBEDTLS_DEPRECATED_WARNING.
Gilles Peskine30de2e82020-04-20 21:39:22 +02002391 msg "build: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 30s
2392 scripts/config.py full_no_deprecated
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002393 scripts/config.py unset MBEDTLS_DEPRECATED_REMOVED
2394 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Dave Rodgman84125a12024-01-02 11:42:38 +00002395 make CFLAGS='-O -Werror -Wall -Wextra'
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002396
Gilles Peskine30de2e82020-04-20 21:39:22 +02002397 msg "test: make, full_no_deprecated config, MBEDTLS_DEPRECATED_WARNING" # ~ 5s
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002398 make test
2399}
2400
Gilles Peskine8386ea22020-04-30 09:07:29 +02002401component_test_full_deprecated_warning () {
2402 # Test that when MBEDTLS_DEPRECATED_WARNING is enabled, the build passes
2403 # with only certain whitelisted types of warnings.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002404 msg "build: make, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002405 scripts/config.py full
2406 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002407 # Expect warnings from '#warning' directives in check_config.h.
Dave Rodgmanbc8e61d2023-12-19 14:07:15 +00002408 # Note that gcc is required to allow the use of -Wno-error=cpp, which allows us to
2409 # display #warning messages without them being treated as errors.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002410 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=cpp' lib programs
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01002411
Gilles Peskine8386ea22020-04-30 09:07:29 +02002412 msg "build: make tests, full config + MBEDTLS_DEPRECATED_WARNING, expect warnings" # ~ 30s
2413 # Set MBEDTLS_TEST_DEPRECATED to enable tests for deprecated features.
2414 # By default those are disabled when MBEDTLS_DEPRECATED_WARNING is set.
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002415 # Expect warnings from '#warning' directives in check_config.h and
2416 # from the use of deprecated functions in test suites.
Gilles Peskine21570cf2023-12-22 11:49:50 +01002417 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 +01002418
Gilles Peskine1093d9f2020-04-13 01:03:21 +02002419 msg "test: full config + MBEDTLS_TEST_DEPRECATED" # ~ 30s
2420 make test
Gilles Peskine82b27272019-06-14 18:27:03 +02002421
2422 msg "program demos: full config + MBEDTLS_TEST_DEPRECATED" # ~10s
2423 tests/scripts/run_demos.py
Gilles Peskine8f073122018-11-27 15:58:47 +01002424}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +00002425
Gilles Peskineec541fe2020-01-31 14:24:14 +01002426# Check that the specified libraries exist and are empty.
2427are_empty_libraries () {
2428 nm "$@" >/dev/null 2>/dev/null
2429 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
2430}
2431
2432component_build_crypto_default () {
2433 msg "build: make, crypto only"
2434 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +01002435 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002436 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002437}
2438
2439component_build_crypto_full () {
2440 msg "build: make, crypto only, full config"
2441 scripts/config.py crypto_full
Gilles Peskine21570cf2023-12-22 11:49:50 +01002442 make CFLAGS='-O1 -Werror'
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002443 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002444}
2445
Gilles Peskinefc4f11b2022-10-21 19:34:54 +02002446component_test_crypto_for_psa_service () {
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002447 msg "build: make, config for PSA crypto service"
2448 scripts/config.py crypto
2449 scripts/config.py set MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
2450 # Disable things that are not needed for just cryptography, to
2451 # reach a configuration that would be typical for a PSA cryptography
2452 # service providing all implemented PSA algorithms.
2453 # System stuff
2454 scripts/config.py unset MBEDTLS_ERROR_C
2455 scripts/config.py unset MBEDTLS_TIMING_C
Gilles Peskine78bffd12022-10-25 21:02:33 +02002456 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002457 # Crypto stuff with no PSA interface
2458 scripts/config.py unset MBEDTLS_BASE64_C
Gilles Peskine649e04e2022-10-25 21:05:57 +02002459 # Keep MBEDTLS_CIPHER_C because psa_crypto_cipher, CCM and GCM need it.
Gilles Peskineb06f0712022-10-25 21:06:11 +02002460 scripts/config.py unset MBEDTLS_HKDF_C # PSA's HKDF is independent
Gilles Peskine649e04e2022-10-25 21:05:57 +02002461 # Keep MBEDTLS_MD_C because deterministic ECDSA needs it for HMAC_DRBG.
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002462 scripts/config.py unset MBEDTLS_NIST_KW_C
2463 scripts/config.py unset MBEDTLS_PEM_PARSE_C
2464 scripts/config.py unset MBEDTLS_PEM_WRITE_C
2465 scripts/config.py unset MBEDTLS_PKCS12_C
2466 scripts/config.py unset MBEDTLS_PKCS5_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002467 # MBEDTLS_PK_PARSE_C and MBEDTLS_PK_WRITE_C are actually currently needed
2468 # in PSA code to work with RSA keys. We don't require users to set those:
2469 # they will be reenabled in build_info.h.
Gilles Peskine1f108072022-10-25 21:02:56 +02002470 scripts/config.py unset MBEDTLS_PK_C
Gilles Peskinefcee7402022-10-11 21:15:24 +02002471 scripts/config.py unset MBEDTLS_PK_PARSE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002472 scripts/config.py unset MBEDTLS_PK_WRITE_C
Gilles Peskineaef1ba62022-10-11 21:05:06 +02002473 make CFLAGS='-O1 -Werror' all test
2474 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
2475}
2476
Gilles Peskineec541fe2020-01-31 14:24:14 +01002477component_build_crypto_baremetal () {
2478 msg "build: make, crypto only, baremetal config"
2479 scripts/config.py crypto_baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002480 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002481 are_empty_libraries library/libmbedx509.* library/libmbedtls.*
Gilles Peskineec541fe2020-01-31 14:24:14 +01002482}
Daniel Axtens446af202020-09-02 21:30:13 +10002483support_build_crypto_baremetal () {
Daniel Axtens814c8132020-08-31 14:22:58 +10002484 support_build_baremetal "$@"
2485}
2486
2487component_build_baremetal () {
2488 msg "build: make, baremetal config"
2489 scripts/config.py baremetal
David Horstmann61faf662021-11-30 11:40:54 +00002490 make CFLAGS="-O1 -Werror -I$PWD/tests/include/baremetal-override/"
Daniel Axtens814c8132020-08-31 14:22:58 +10002491}
2492support_build_baremetal () {
Daniel Axtens446af202020-09-02 21:30:13 +10002493 # Older Glibc versions include time.h from other headers such as stdlib.h,
2494 # which makes the no-time.h-in-baremetal check fail. Ubuntu 16.04 has this
2495 # problem, Ubuntu 18.04 is ok.
2496 ! grep -q -F time.h /usr/include/x86_64-linux-gnu/sys/types.h
2497}
Gilles Peskineec541fe2020-01-31 14:24:14 +01002498
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002499# depends.py family of tests
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002500component_test_depends_py_cipher_id () {
2501 msg "test/build: depends.py cipher_id (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002502 tests/scripts/depends.py cipher_id --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002503}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002504
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002505component_test_depends_py_cipher_chaining () {
2506 msg "test/build: depends.py cipher_chaining (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002507 tests/scripts/depends.py cipher_chaining --unset-use-psa
John Durkopc14be902020-08-20 06:16:41 -07002508}
2509
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002510component_test_depends_py_cipher_padding () {
2511 msg "test/build: depends.py cipher_padding (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002512 tests/scripts/depends.py cipher_padding --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002513}
Jaeden Ameroacaabe72018-11-07 11:52:52 +00002514
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002515component_test_depends_py_curves () {
2516 msg "test/build: depends.py curves (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002517 tests/scripts/depends.py curves --unset-use-psa
John Durkop2ec2eaa2020-08-24 18:29:15 -07002518}
2519
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002520component_test_depends_py_hashes () {
2521 msg "test/build: depends.py hashes (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002522 tests/scripts/depends.py hashes --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002523}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002524
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002525component_test_depends_py_kex () {
2526 msg "test/build: depends.py kex (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002527 tests/scripts/depends.py kex --unset-use-psa
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002528}
2529
Andrzej Kurekfcbd2ac2022-10-05 09:14:07 -04002530component_test_depends_py_pkalgs () {
2531 msg "test/build: depends.py pkalgs (gcc)"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002532 tests/scripts/depends.py pkalgs --unset-use-psa
Gilles Peskine8f073122018-11-27 15:58:47 +01002533}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002534
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002535# PSA equivalents of the depends.py tests
2536component_test_depends_py_cipher_id_psa () {
2537 msg "test/build: depends.py cipher_id (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002538 tests/scripts/depends.py cipher_id
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002539}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002540
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002541component_test_depends_py_cipher_chaining_psa () {
2542 msg "test/build: depends.py cipher_chaining (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002543 tests/scripts/depends.py cipher_chaining
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002544}
2545
2546component_test_depends_py_cipher_padding_psa () {
2547 msg "test/build: depends.py cipher_padding (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002548 tests/scripts/depends.py cipher_padding
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002549}
2550
2551component_test_depends_py_curves_psa () {
2552 msg "test/build: depends.py curves (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002553 tests/scripts/depends.py curves
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002554}
2555
2556component_test_depends_py_hashes_psa () {
2557 msg "test/build: depends.py hashes (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002558 tests/scripts/depends.py hashes
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002559}
2560
2561component_test_depends_py_kex_psa () {
2562 msg "test/build: depends.py kex (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002563 tests/scripts/depends.py kex
Andrzej Kurek7cb00772022-10-24 10:49:22 -04002564}
2565
2566component_test_depends_py_pkalgs_psa () {
2567 msg "test/build: depends.py pkalgs (gcc) with MBEDTLS_USE_PSA_CRYPTO defined"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002568 tests/scripts/depends.py pkalgs
Gilles Peskine8f073122018-11-27 15:58:47 +01002569}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01002570
Valerio Setti6bed64e2024-01-17 15:21:44 +01002571component_test_psa_crypto_config_ffdh_2048_only () {
2572 msg "build: full config - only DH 2048"
2573
2574 scripts/config.py full
2575
2576 # Disable all DH groups other than 2048.
2577 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_3072
2578 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_4096
2579 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_6144
2580 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_DH_RFC7919_8192
2581
2582 make CFLAGS="$ASAN_CFLAGS -Werror" LDFLAGS="$ASAN_CFLAGS"
2583
2584 msg "test: full config - only DH 2048"
2585 make test
2586
2587 msg "ssl-opt: full config - only DH 2048"
2588 tests/ssl-opt.sh -f "ffdh"
2589}
2590
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002591component_build_no_pk_rsa_alt_support () {
2592 msg "build: !MBEDTLS_PK_RSA_ALT_SUPPORT" # ~30s
2593
2594 scripts/config.py full
2595 scripts/config.py unset MBEDTLS_PK_RSA_ALT_SUPPORT
2596 scripts/config.py set MBEDTLS_RSA_C
2597 scripts/config.py set MBEDTLS_X509_CRT_WRITE_C
2598
2599 # Only compile - this is primarily to test for compile issues
Dave Rodgman84125a12024-01-02 11:42:38 +00002600 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy'
Dave Rodgman1a034dc2023-01-20 13:18:05 +00002601}
2602
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002603component_build_module_alt () {
2604 msg "build: MBEDTLS_XXX_ALT" # ~30s
2605 scripts/config.py full
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002606
2607 # Disable options that are incompatible with some ALT implementations:
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002608 # aesni.c and padlock.c reference mbedtls_aes_context fields directly.
2609 scripts/config.py unset MBEDTLS_AESNI_C
2610 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08002611 scripts/config.py unset MBEDTLS_AESCE_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002612 # MBEDTLS_ECP_RESTARTABLE is documented as incompatible.
2613 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002614 # You can only have one threading implementation: alt or pthread, not both.
2615 scripts/config.py unset MBEDTLS_THREADING_PTHREAD
Gilles Peskine5c3f18d2021-05-31 21:21:12 +02002616 # The SpecifiedECDomain parsing code accesses mbedtls_ecp_group fields
2617 # directly and assumes the implementation works with partial groups.
2618 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Dave Rodgman5b89c552023-10-10 14:59:02 +01002619 # MBEDTLS_SHA256_*ALT can't be used with MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_*
2620 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
2621 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002622 # MBEDTLS_SHA512_*ALT can't be used with MBEDTLS_SHA512_USE_A64_CRYPTO_*
2623 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2624 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002625
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002626 # Enable all MBEDTLS_XXX_ALT for whole modules. Do not enable
2627 # MBEDTLS_XXX_YYY_ALT which are for single functions.
2628 scripts/config.py set-all 'MBEDTLS_([A-Z0-9]*|NIST_KW)_ALT'
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002629 scripts/config.py unset MBEDTLS_DHM_ALT #incompatible with MBEDTLS_DEBUG_C
Manuel Pégourié-Gonnarda6e3d3e2022-12-06 12:10:33 +01002630
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002631 # We can only compile, not link, since we don't have any implementations
2632 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002633 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskine1628a9c2021-05-31 22:09:58 +02002634}
2635
2636component_build_dhm_alt () {
2637 msg "build: MBEDTLS_DHM_ALT" # ~30s
2638 scripts/config.py full
2639 scripts/config.py set MBEDTLS_DHM_ALT
2640 # debug.c currently references mbedtls_dhm_context fields directly.
2641 scripts/config.py unset MBEDTLS_DEBUG_C
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002642 # We can only compile, not link, since we don't have any implementations
2643 # suitable for testing with the dummy alt headers.
Dave Rodgmanea03ef92023-12-19 12:19:59 +00002644 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/alt-dummy' lib
Gilles Peskinecc73cc52021-05-25 09:04:46 +02002645}
2646
Gilles Peskine64996c32024-01-23 20:25:47 +01002647component_test_no_psa_crypto_full_cmake_asan() {
2648 # full minus MBEDTLS_PSA_CRYPTO_C: run the same set of tests as basic-build-test.sh
2649 msg "build: cmake, full config minus PSA crypto, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002650 scripts/config.py full
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002651 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
Gilles Peskine64996c32024-01-23 20:25:47 +01002652 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CLIENT
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002653 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
Ronald Cron6f135e12021-12-08 16:57:54 +01002654 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002655 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskinedc6d8382020-04-12 14:21:55 +02002656 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02002657 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Raef Colesa7e03ad2022-09-28 09:32:48 +01002658 scripts/config.py unset MBEDTLS_LMS_C
Raef Coles47bccb72022-09-28 12:00:20 +01002659 scripts/config.py unset MBEDTLS_LMS_PRIVATE
Dave Rodgman17127e92023-12-14 16:42:48 +00002660 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002661 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02002662
Gilles Peskine64996c32024-01-23 20:25:47 +01002663 msg "test: main suites (full minus PSA crypto)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002664 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02002665
Manuel Pégourié-Gonnard182a23b2022-12-07 10:38:43 +01002666 # Note: ssl-opt.sh has some test cases that depend on
2667 # MBEDTLS_ECP_RESTARTABLE && !MBEDTLS_USE_PSA_CRYPTO
2668 # This is the only component where those tests are not skipped.
Gilles Peskinee0c13cf2024-01-30 10:17:49 +01002669 msg "test: ssl-opt.sh (full minus PSA crypto)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02002670 tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002671
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002672 # Note: the next two invocations cover all compat.sh test cases.
2673 # We should use the same here and in basic-build-test.sh.
2674 msg "test: compat.sh: default version (full minus PSA crypto)"
2675 tests/compat.sh -e 'ARIA\|CHACHA'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04002676
Manuel Pégourié-Gonnardeb86b902024-04-22 10:25:09 +02002677 msg "test: compat.sh: next: ARIA, Chacha (full minus PSA crypto)"
Manuel Pégourié-Gonnardc5722462022-12-19 11:42:12 +01002678 env OPENSSL="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
Andrzej Kurekde5a0072019-02-01 07:03:03 -05002679}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002680
Ronald Cron403c15c2021-09-13 09:38:05 +02002681component_test_psa_crypto_config_accel_ecdsa () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002682 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02002683
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002684 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002685 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002686 $(helper_get_psa_key_type_list "ECC") \
2687 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002688
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002689 # Configure
2690 # ---------
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002691
Manuel Pégourié-Gonnard8d645dc2023-06-15 09:07:10 +02002692 # Start from default config (no USE_PSA) + TLS 1.3
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002693 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002694
2695 # Disable the module that's accelerated
Ronald Cron403c15c2021-09-13 09:38:05 +02002696 scripts/config.py unset MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002697
2698 # Disable things that depend on it
Ronald Cron403c15c2021-09-13 09:38:05 +02002699 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2700 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2701
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002702 # Build
2703 # -----
2704
2705 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02002706 loc_extra_list="ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2707 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002708
2709 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2710
Valerio Setti3fe105b2023-10-30 11:08:12 +01002711 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02002712
Manuel Pégourié-Gonnarde3095e72022-12-28 10:09:53 +01002713 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine827dbd92022-02-04 00:30:54 +01002714 not grep mbedtls_ecdsa_ library/ecdsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02002715
Manuel Pégourié-Gonnard200fd0f2022-12-27 13:03:10 +01002716 # Run the tests
2717 # -------------
2718
Ronald Cron403c15c2021-09-13 09:38:05 +02002719 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDSA"
2720 make test
2721}
2722
Valerio Setti44b178c2023-03-22 14:02:57 +01002723component_test_psa_crypto_config_accel_ecdh () {
Valerio Setti5aab43f2023-03-29 10:42:07 +02002724 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002725
2726 # Algorithms and key types to accelerate
Valerio Settic0d2f842023-06-28 10:48:08 +02002727 loc_accel_list="ALG_ECDH \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002728 $(helper_get_psa_key_type_list "ECC") \
2729 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002730
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002731 # Configure
2732 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002733
Ronald Cron46ac0652024-03-18 12:39:04 +01002734 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002735 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002736
Valerio Setti44b178c2023-03-22 14:02:57 +01002737 # Disable the module that's accelerated
2738 scripts/config.py unset MBEDTLS_ECDH_C
2739
2740 # Disable things that depend on it
2741 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
2742 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
2743 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
2744 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
2745 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
2746
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002747 # Build
2748 # -----
2749
2750 helper_libtestdriver1_make_drivers "$loc_accel_list"
2751
Valerio Setti3fe105b2023-10-30 11:08:12 +01002752 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002753
Valerio Setti44b178c2023-03-22 14:02:57 +01002754 # Make sure this was not re-enabled by accident (additive config)
2755 not grep mbedtls_ecdh_ library/ecdh.o
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002756
2757 # Run the tests
2758 # -------------
2759
Valerio Setti44b178c2023-03-22 14:02:57 +01002760 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated ECDH"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002761 make test
Manuel Pégourié-Gonnard10e39632022-12-29 12:29:09 +01002762}
2763
Przemek Stekieldccb2022023-05-11 10:48:50 +02002764component_test_psa_crypto_config_accel_ffdh () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002765 msg "build: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002766
2767 # Algorithms and key types to accelerate
Valerio Setti27602c32023-07-10 16:38:59 +02002768 loc_accel_list="ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01002769 $(helper_get_psa_key_type_list "DH") \
2770 $(helper_get_psa_dh_group_list)"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002771
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002772 # Configure
2773 # ---------
Przemek Stekieldccb2022023-05-11 10:48:50 +02002774
Przemek Stekiel565353e2023-07-05 11:07:07 +02002775 # start with full (USE_PSA and TLS 1.3)
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002776 helper_libtestdriver1_adjust_config "full"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002777
2778 # Disable the module that's accelerated
2779 scripts/config.py unset MBEDTLS_DHM_C
2780
2781 # Disable things that depend on it
2782 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2783 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
2784
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002785 # Build
2786 # -----
2787
2788 helper_libtestdriver1_make_drivers "$loc_accel_list"
2789
Manuel Pégourié-Gonnard981732e2023-06-08 09:15:59 +02002790 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002791
2792 # Make sure this was not re-enabled by accident (additive config)
2793 not grep mbedtls_dhm_ library/dhm.o
2794
2795 # Run the tests
2796 # -------------
2797
Gilles Peskine14302ed2023-07-19 19:30:04 +02002798 msg "test: full with accelerated FFDH"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002799 make test
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002800
Gilles Peskine14302ed2023-07-19 19:30:04 +02002801 msg "ssl-opt: full with accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002802 tests/ssl-opt.sh -f "ffdh"
Przemek Stekieldccb2022023-05-11 10:48:50 +02002803}
2804
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002805component_test_psa_crypto_config_reference_ffdh () {
Gilles Peskineb7d577e2023-08-09 19:48:58 +02002806 msg "build: full with non-accelerated FFDH"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002807
2808 # Start with full (USE_PSA and TLS 1.3)
Przemek Stekiel565353e2023-07-05 11:07:07 +02002809 helper_libtestdriver1_adjust_config "full"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002810
2811 # Disable things that are not supported
2812 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
2813 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Gilles Peskine21570cf2023-12-22 11:49:50 +01002814 make
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002815
Gilles Peskine14302ed2023-07-19 19:30:04 +02002816 msg "test suites: full with non-accelerated FFDH alg"
Przemek Stekiel01c248c2023-05-26 10:19:49 +02002817 make test
2818
Gilles Peskine14302ed2023-07-19 19:30:04 +02002819 msg "ssl-opt: full with non-accelerated FFDH alg"
Przemek Stekiel84f4ff12023-07-04 12:35:31 +02002820 tests/ssl-opt.sh -f "ffdh"
Valerio Setti42d5f192023-03-20 13:54:41 +01002821}
2822
Valerio Setti44b178c2023-03-22 14:02:57 +01002823component_test_psa_crypto_config_accel_pake() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02002824 msg "build: full with accelerated PAKE"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002825
Manuel Pégourié-Gonnard5a7523e2023-09-20 12:45:01 +02002826 loc_accel_list="ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002827 $(helper_get_psa_key_type_list "ECC") \
2828 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002829
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002830 # Configure
2831 # ---------
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002832
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002833 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002834
2835 # Make built-in fallback not available
2836 scripts/config.py unset MBEDTLS_ECJPAKE_C
2837 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
2838
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002839 # Build
2840 # -----
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002841
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02002842 helper_libtestdriver1_make_drivers "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002843
Valerio Setti3fe105b2023-10-30 11:08:12 +01002844 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002845
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002846 # Make sure this was not re-enabled by accident (additive config)
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002847 not grep mbedtls_ecjpake_init library/ecjpake.o
2848
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02002849 # Run the tests
2850 # -------------
2851
Gilles Peskine14302ed2023-07-19 19:30:04 +02002852 msg "test: full with accelerated PAKE"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002853 make test
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01002854}
2855
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002856component_test_psa_crypto_config_accel_ecc_some_key_types () {
2857 msg "build: full with accelerated EC algs and some key types"
2858
2859 # Algorithms and key types to accelerate
2860 # For key types, use an explicitly list to omit GENERATE (and DERIVE)
2861 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2862 ALG_ECDH \
2863 ALG_JPAKE \
2864 KEY_TYPE_ECC_PUBLIC_KEY \
2865 KEY_TYPE_ECC_KEY_PAIR_BASIC \
2866 KEY_TYPE_ECC_KEY_PAIR_IMPORT \
Valerio Setti3fe105b2023-10-30 11:08:12 +01002867 KEY_TYPE_ECC_KEY_PAIR_EXPORT \
2868 $(helper_get_psa_curve_list)"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002869
2870 # Configure
2871 # ---------
2872
2873 # start with config full for maximum coverage (also enables USE_PSA)
2874 helper_libtestdriver1_adjust_config "full"
2875
2876 # Disable modules that are accelerated - some will be re-enabled
2877 scripts/config.py unset MBEDTLS_ECDSA_C
2878 scripts/config.py unset MBEDTLS_ECDH_C
2879 scripts/config.py unset MBEDTLS_ECJPAKE_C
2880 scripts/config.py unset MBEDTLS_ECP_C
2881
2882 # Disable all curves - those that aren't accelerated should be re-enabled
2883 helper_disable_builtin_curves
2884
2885 # Restartable feature is not yet supported by PSA. Once it will in
2886 # the future, the following line could be removed (see issues
2887 # 6061, 6332 and following ones)
2888 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2889
2890 # this is not supported by the driver API yet
2891 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2892
2893 # Build
2894 # -----
2895
2896 # These hashes are needed for some ECDSA signature tests.
2897 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2898 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2899 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2900
Valerio Setti3fe105b2023-10-30 11:08:12 +01002901 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002902
2903 # ECP should be re-enabled but not the others
2904 not grep mbedtls_ecdh_ library/ecdh.o
2905 not grep mbedtls_ecdsa library/ecdsa.o
2906 not grep mbedtls_ecjpake library/ecjpake.o
2907 grep mbedtls_ecp library/ecp.o
2908
2909 # Run the tests
2910 # -------------
2911
2912 msg "test suites: full with accelerated EC algs and some key types"
Gilles Peskine21570cf2023-12-22 11:49:50 +01002913 make test
Manuel Pégourié-Gonnard5c210362023-09-26 12:03:10 +02002914}
2915
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002916# Run tests with only (non-)Weierstrass accelerated
2917# Common code used in:
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02002918# - component_test_psa_crypto_config_accel_ecc_weierstrass_curves
2919# - component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002920common_test_psa_crypto_config_accel_ecc_some_curves () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002921 weierstrass=$1
2922 if [ $weierstrass -eq 1 ]; then
2923 desc="Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002924 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002925 desc="non-Weierstrass"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002926 fi
2927
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002928 msg "build: crypto_full minus PK with accelerated EC algs and $desc curves"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002929
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002930 # Note: Curves are handled in a special way by the libtestdriver machinery,
2931 # so we only want to include them in the accel list when building the main
2932 # libraries, hence the use of a separate variable.
2933 # Note: the following loop is a modified version of
2934 # helper_get_psa_curve_list that only keeps Weierstrass families.
2935 loc_weierstrass_list=""
2936 loc_non_weierstrass_list=""
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002937 for item in $(sed -n 's/^#define PSA_WANT_\(ECC_[0-9A-Z_a-z]*\).*/\1/p' <"$CRYPTO_CONFIG_H"); do
2938 case $item in
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002939 ECC_BRAINPOOL*|ECC_SECP*)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002940 loc_weierstrass_list="$loc_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002941 ;;
2942 *)
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002943 loc_non_weierstrass_list="$loc_non_weierstrass_list $item"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002944 ;;
2945 esac
2946 done
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02002947 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002948 loc_curve_list=$loc_weierstrass_list
2949 else
2950 loc_curve_list=$loc_non_weierstrass_list
2951 fi
2952
Valerio Setti3fe105b2023-10-30 11:08:12 +01002953 # Algorithms and key types to accelerate
2954 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
2955 ALG_ECDH \
2956 ALG_JPAKE \
2957 $(helper_get_psa_key_type_list "ECC") \
2958 $loc_curve_list"
2959
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002960 # Configure
2961 # ---------
2962
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02002963 # Start with config crypto_full and remove PK_C:
2964 # that's what's supported now, see docs/driver-only-builds.md.
2965 helper_libtestdriver1_adjust_config "crypto_full"
2966 scripts/config.py unset MBEDTLS_PK_C
2967 scripts/config.py unset MBEDTLS_PK_PARSE_C
2968 scripts/config.py unset MBEDTLS_PK_WRITE_C
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002969
2970 # Disable modules that are accelerated - some will be re-enabled
2971 scripts/config.py unset MBEDTLS_ECDSA_C
2972 scripts/config.py unset MBEDTLS_ECDH_C
2973 scripts/config.py unset MBEDTLS_ECJPAKE_C
2974 scripts/config.py unset MBEDTLS_ECP_C
2975
2976 # Disable all curves - those that aren't accelerated should be re-enabled
2977 helper_disable_builtin_curves
2978
2979 # Restartable feature is not yet supported by PSA. Once it will in
2980 # the future, the following line could be removed (see issues
2981 # 6061, 6332 and following ones)
2982 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
2983
2984 # this is not supported by the driver API yet
2985 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
2986
2987 # Build
2988 # -----
2989
2990 # These hashes are needed for some ECDSA signature tests.
2991 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
2992 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
2993 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
2994
Valerio Settiac7a8092023-10-31 12:23:44 +01002995 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02002996
2997 # We expect ECDH to be re-enabled for the missing curves
2998 grep mbedtls_ecdh_ library/ecdh.o
2999 # We expect ECP to be re-enabled, however the parts specific to the
3000 # families of curves that are accelerated should be ommited.
3001 # - functions with mxz in the name are specific to Montgomery curves
3002 # - ecp_muladd is specific to Weierstrass curves
3003 ##nm library/ecp.o | tee ecp.syms
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003004 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003005 not grep mbedtls_ecp_muladd library/ecp.o
3006 grep mxz library/ecp.o
3007 else
3008 grep mbedtls_ecp_muladd library/ecp.o
3009 not grep mxz library/ecp.o
3010 fi
3011 # We expect ECDSA and ECJPAKE to be re-enabled only when
3012 # Weierstrass curves are not accelerated
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003013 if [ $weierstrass -eq 1 ]; then
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003014 not grep mbedtls_ecdsa library/ecdsa.o
3015 not grep mbedtls_ecjpake library/ecjpake.o
3016 else
3017 grep mbedtls_ecdsa library/ecdsa.o
3018 grep mbedtls_ecjpake library/ecjpake.o
3019 fi
3020
3021 # Run the tests
3022 # -------------
3023
Manuel Pégourié-Gonnardc0c9b232023-09-28 10:05:57 +02003024 msg "test suites: crypto_full minus PK with accelerated EC algs and $desc curves"
3025 make test
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003026}
3027
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02003028component_test_psa_crypto_config_accel_ecc_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003029 common_test_psa_crypto_config_accel_ecc_some_curves 1
3030}
3031
Manuel Pégourié-Gonnardfaea9192023-09-28 09:10:01 +02003032component_test_psa_crypto_config_accel_ecc_non_weierstrass_curves () {
Manuel Pégourié-Gonnard561bce62023-09-25 12:35:15 +02003033 common_test_psa_crypto_config_accel_ecc_some_curves 0
3034}
3035
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01003036# Auxiliary function to build config for all EC based algorithms (EC-JPAKE,
3037# ECDH, ECDSA) with and without drivers.
3038# The input parameter is a boolean value which indicates:
3039# - 0 keep built-in EC algs,
3040# - 1 exclude built-in EC algs (driver only).
3041#
3042# This is used by the two following components to ensure they always use the
3043# same config, except for the use of driver or built-in EC algorithms:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003044# - component_test_psa_crypto_config_accel_ecc_ecp_light_only;
3045# - component_test_psa_crypto_config_reference_ecc_ecp_light_only.
Manuel Pégourié-Gonnard171c45f2022-12-29 11:31:35 +01003046# This supports comparing their test coverage with analyze_outcomes.py.
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003047config_psa_crypto_config_ecp_light_only () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003048 driver_only="$1"
Valerio Setti42d5f192023-03-20 13:54:41 +01003049 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003050 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003051 if [ "$driver_only" -eq 1 ]; then
Valerio Setti42d5f192023-03-20 13:54:41 +01003052 # Disable modules that are accelerated
3053 scripts/config.py unset MBEDTLS_ECDSA_C
3054 scripts/config.py unset MBEDTLS_ECDH_C
3055 scripts/config.py unset MBEDTLS_ECJPAKE_C
Valerio Setti29b395c2023-04-05 18:20:30 +02003056 scripts/config.py unset MBEDTLS_ECP_C
Valerio Setti42d5f192023-03-20 13:54:41 +01003057 fi
3058
3059 # Restartable feature is not yet supported by PSA. Once it will in
3060 # the future, the following line could be removed (see issues
3061 # 6061, 6332 and following ones)
3062 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Setti42d5f192023-03-20 13:54:41 +01003063}
3064
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003065# Keep in sync with component_test_psa_crypto_config_reference_ecc_ecp_light_only
3066component_test_psa_crypto_config_accel_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003067 msg "build: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003068
3069 # Algorithms and key types to accelerate
3070 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3071 ALG_ECDH \
3072 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003073 $(helper_get_psa_key_type_list "ECC") \
3074 $(helper_get_psa_curve_list)"
Valerio Setti42d5f192023-03-20 13:54:41 +01003075
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003076 # Configure
3077 # ---------
Valerio Setti42d5f192023-03-20 13:54:41 +01003078
3079 # Use the same config as reference, only without built-in EC algs
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003080 config_psa_crypto_config_ecp_light_only 1
Valerio Setti42d5f192023-03-20 13:54:41 +01003081
Valerio Setti0a342c92023-09-01 09:12:31 +02003082 # Do not disable builtin curves because that support is required for:
Valerio Settib2fd6732023-08-15 17:10:47 +02003083 # - MBEDTLS_PK_PARSE_EC_EXTENDED
3084 # - MBEDTLS_PK_PARSE_EC_COMPRESSED
Valerio Setti42d5f192023-03-20 13:54:41 +01003085
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003086 # Build
3087 # -----
3088
3089 # These hashes are needed for some ECDSA signature tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003090 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3091 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003092 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3093
Valerio Setti3fe105b2023-10-30 11:08:12 +01003094 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Setti42d5f192023-03-20 13:54:41 +01003095
3096 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3097 not grep mbedtls_ecdsa_ library/ecdsa.o
3098 not grep mbedtls_ecdh_ library/ecdh.o
3099 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti29b395c2023-04-05 18:20:30 +02003100 not grep mbedtls_ecp_mul library/ecp.o
Valerio Setti42d5f192023-03-20 13:54:41 +01003101
3102 # Run the tests
3103 # -------------
3104
Gilles Peskine14302ed2023-07-19 19:30:04 +02003105 msg "test suites: full with accelerated EC algs"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003106 make test
Valerio Setti42d5f192023-03-20 13:54:41 +01003107
Gilles Peskine14302ed2023-07-19 19:30:04 +02003108 msg "ssl-opt: full with accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003109 tests/ssl-opt.sh
3110}
3111
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003112# Keep in sync with component_test_psa_crypto_config_accel_ecc_ecp_light_only
3113component_test_psa_crypto_config_reference_ecc_ecp_light_only () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003114 msg "build: MBEDTLS_PSA_CRYPTO_CONFIG with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003115
Gilles Peskine8dbdf2f2023-07-19 19:16:37 +02003116 config_psa_crypto_config_ecp_light_only 0
Valerio Setti42d5f192023-03-20 13:54:41 +01003117
Gilles Peskine21570cf2023-12-22 11:49:50 +01003118 make
Valerio Setti42d5f192023-03-20 13:54:41 +01003119
Gilles Peskine14302ed2023-07-19 19:30:04 +02003120 msg "test suites: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003121 make test
3122
Gilles Peskine14302ed2023-07-19 19:30:04 +02003123 msg "ssl-opt: full with non-accelerated EC algs"
Valerio Setti42d5f192023-03-20 13:54:41 +01003124 tests/ssl-opt.sh
3125}
3126
Valerio Settie618cb02023-04-12 14:59:16 +02003127# This helper function is used by:
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003128# - component_test_psa_crypto_config_accel_ecc_no_ecp_at_all()
3129# - component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
Valerio Settie618cb02023-04-12 14:59:16 +02003130# to ensure that both tests use the same underlying configuration when testing
3131# driver's coverage with analyze_outcomes.py.
3132#
3133# This functions accepts 1 boolean parameter as follows:
3134# - 1: building with accelerated EC algorithms (ECDSA, ECDH, ECJPAKE), therefore
3135# excluding their built-in implementation as well as ECP_C & ECP_LIGHT
3136# - 0: include built-in implementation of EC algorithms.
3137#
3138# PK_C and RSA_C are always disabled to ensure there is no remaining dependency
3139# on the ECP module.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003140config_psa_crypto_no_ecp_at_all () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003141 driver_only="$1"
Valerio Settiaafe9002023-06-26 15:23:44 +02003142 # start with full config for maximum coverage (also enables USE_PSA)
3143 helper_libtestdriver1_adjust_config "full"
3144
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003145 if [ "$driver_only" -eq 1 ]; then
Valerio Settie618cb02023-04-12 14:59:16 +02003146 # Disable modules that are accelerated
3147 scripts/config.py unset MBEDTLS_ECDSA_C
3148 scripts/config.py unset MBEDTLS_ECDH_C
3149 scripts/config.py unset MBEDTLS_ECJPAKE_C
3150 # Disable ECP module (entirely)
3151 scripts/config.py unset MBEDTLS_ECP_C
Valerio Settie618cb02023-04-12 14:59:16 +02003152 fi
3153
Valerio Settiaecd32c2023-06-14 10:42:31 +02003154 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3155 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
Valerio Settiaddeee42023-06-14 10:46:55 +02003156 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron6b49b552023-07-20 09:57:54 +02003157 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
Valerio Settiaecd32c2023-06-14 10:42:31 +02003158
Valerio Settie618cb02023-04-12 14:59:16 +02003159 # Restartable feature is not yet supported by PSA. Once it will in
3160 # the future, the following line could be removed (see issues
3161 # 6061, 6332 and following ones)
3162 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
Valerio Settie618cb02023-04-12 14:59:16 +02003163}
3164
3165# Build and test a configuration where driver accelerates all EC algs while
3166# all support and dependencies from ECP and ECP_LIGHT are removed on the library
3167# side.
3168#
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003169# Keep in sync with component_test_psa_crypto_config_reference_ecc_no_ecp_at_all()
3170component_test_psa_crypto_config_accel_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003171 msg "build: full + accelerated EC algs - ECP"
Valerio Settie618cb02023-04-12 14:59:16 +02003172
3173 # Algorithms and key types to accelerate
3174 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3175 ALG_ECDH \
3176 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003177 $(helper_get_psa_key_type_list "ECC") \
3178 $(helper_get_psa_curve_list)"
Valerio Settie618cb02023-04-12 14:59:16 +02003179
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003180 # Configure
3181 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003182
Valerio Settie618cb02023-04-12 14:59:16 +02003183 # Set common configurations between library's and driver's builds
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003184 config_psa_crypto_no_ecp_at_all 1
Valerio Settib2fd6732023-08-15 17:10:47 +02003185 # Disable all the builtin curves. All the required algs are accelerated.
3186 helper_disable_builtin_curves
Valerio Settie618cb02023-04-12 14:59:16 +02003187
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003188 # Build
3189 # -----
Valerio Settie618cb02023-04-12 14:59:16 +02003190
3191 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003192 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3193 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3194 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Valerio Settie618cb02023-04-12 14:59:16 +02003195
Manuel Pégourié-Gonnard31639e42023-05-25 10:07:31 +02003196 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003197
Valerio Setti3fe105b2023-10-30 11:08:12 +01003198 helper_libtestdriver1_make_main "$loc_accel_list"
Valerio Settie618cb02023-04-12 14:59:16 +02003199
3200 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3201 not grep mbedtls_ecdsa_ library/ecdsa.o
3202 not grep mbedtls_ecdh_ library/ecdh.o
3203 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Settib2fd6732023-08-15 17:10:47 +02003204 # Also ensure that ECP module was not re-enabled
Valerio Settie618cb02023-04-12 14:59:16 +02003205 not grep mbedtls_ecp_ library/ecp.o
Valerio Settie618cb02023-04-12 14:59:16 +02003206
3207 # Run the tests
3208 # -------------
3209
Gilles Peskine14302ed2023-07-19 19:30:04 +02003210 msg "test: full + accelerated EC algs - ECP"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003211 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003212
Gilles Peskine14302ed2023-07-19 19:30:04 +02003213 msg "ssl-opt: full + accelerated EC algs - ECP"
Valerio Setti16b70f22023-06-27 17:45:49 +02003214 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003215}
3216
3217# Reference function used for driver's coverage analysis in analyze_outcomes.py
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003218# in conjunction with component_test_psa_crypto_config_accel_ecc_no_ecp_at_all().
Valerio Settie618cb02023-04-12 14:59:16 +02003219# Keep in sync with its accelerated counterpart.
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003220component_test_psa_crypto_config_reference_ecc_no_ecp_at_all () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003221 msg "build: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003222
Valerio Setti4d25a8d2023-06-14 10:33:10 +02003223 config_psa_crypto_no_ecp_at_all 0
Valerio Settie618cb02023-04-12 14:59:16 +02003224
Gilles Peskine21570cf2023-12-22 11:49:50 +01003225 make
Valerio Settie618cb02023-04-12 14:59:16 +02003226
Gilles Peskine14302ed2023-07-19 19:30:04 +02003227 msg "test: full + non accelerated EC algs"
Valerio Settie618cb02023-04-12 14:59:16 +02003228 make test
Valerio Setti16b70f22023-06-27 17:45:49 +02003229
Gilles Peskine14302ed2023-07-19 19:30:04 +02003230 msg "ssl-opt: full + non accelerated EC algs"
Valerio Setti16b70f22023-06-27 17:45:49 +02003231 tests/ssl-opt.sh
Valerio Settie618cb02023-04-12 14:59:16 +02003232}
3233
Valerio Setti4e2f2442023-08-15 10:10:26 +02003234# This is a common configuration helper used directly from:
3235# - common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3236# - common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3237# and indirectly from:
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003238# - component_test_psa_crypto_config_accel_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003239# - accelerate all EC algs, disable RSA and FFDH
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003240# - component_test_psa_crypto_config_reference_ecc_no_bignum
Valerio Setti4e2f2442023-08-15 10:10:26 +02003241# - this is the reference component of the above
3242# - it still disables RSA and FFDH, but it uses builtin EC algs
3243# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
3244# - accelerate all EC and FFDH algs, disable only RSA
3245# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3246# - this is the reference component of the above
3247# - it still disables RSA, but it uses builtin EC and FFDH algs
3248#
3249# This function accepts 2 parameters:
Valerio Setti5dfaca42023-09-05 08:48:51 +02003250# $1: a boolean value which states if we are testing an accelerated scenario
3251# or not.
3252# $2: a string value which states which components are tested. Allowed values
3253# are "ECC" or "ECC_DH".
Valerio Setti4e2f2442023-08-15 10:10:26 +02003254config_psa_crypto_config_accel_ecc_ffdh_no_bignum() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003255 driver_only="$1"
3256 test_target="$2"
Valerio Setti18535c32023-07-31 11:27:17 +02003257 # start with full config for maximum coverage (also enables USE_PSA)
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003258 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003259
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003260 if [ "$driver_only" -eq 1 ]; then
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003261 # Disable modules that are accelerated
3262 scripts/config.py unset MBEDTLS_ECDSA_C
3263 scripts/config.py unset MBEDTLS_ECDH_C
3264 scripts/config.py unset MBEDTLS_ECJPAKE_C
3265 # Disable ECP module (entirely)
3266 scripts/config.py unset MBEDTLS_ECP_C
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003267 # Also disable bignum
3268 scripts/config.py unset MBEDTLS_BIGNUM_C
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003269 fi
3270
3271 # Disable all the features that auto-enable ECP_LIGHT (see build_info.h)
3272 scripts/config.py unset MBEDTLS_PK_PARSE_EC_EXTENDED
3273 scripts/config.py unset MBEDTLS_PK_PARSE_EC_COMPRESSED
3274 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE
3275
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003276 # RSA support is intentionally disabled on this test because RSA_C depends
3277 # on BIGNUM_C.
Valerio Setti2e0275d2023-07-28 16:33:13 +02003278 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_RSA_[0-9A-Z_a-z]*"
3279 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 +02003280 scripts/config.py unset MBEDTLS_RSA_C
3281 scripts/config.py unset MBEDTLS_PKCS1_V15
3282 scripts/config.py unset MBEDTLS_PKCS1_V21
3283 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3284 # Also disable key exchanges that depend on RSA
3285 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3286 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3287 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3288 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3289 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3290
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003291 if [ "$test_target" = "ECC" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003292 # When testing ECC only, we disable FFDH support, both from builtin and
3293 # PSA sides, and also disable the key exchanges that depend on DHM.
3294 scripts/config.py -f include/psa/crypto_config.h unset PSA_WANT_ALG_FFDH
3295 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_KEY_TYPE_DH_[0-9A-Z_a-z]*"
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003296 scripts/config.py -f "$CRYPTO_CONFIG_H" unset-all "PSA_WANT_DH_RFC7919_[0-9]*"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003297 scripts/config.py unset MBEDTLS_DHM_C
3298 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3299 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3300 else
3301 # When testing ECC and DH instead, we disable DHM and depending key
3302 # exchanges only in the accelerated build
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003303 if [ "$driver_only" -eq 1 ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003304 scripts/config.py unset MBEDTLS_DHM_C
3305 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
3306 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3307 fi
3308 fi
Manuel Pégourié-Gonnard7dccb662023-06-12 18:28:42 +02003309
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003310 # Restartable feature is not yet supported by PSA. Once it will in
3311 # the future, the following line could be removed (see issues
3312 # 6061, 6332 and following ones)
3313 scripts/config.py unset MBEDTLS_ECP_RESTARTABLE
3314}
3315
Valerio Setti4e2f2442023-08-15 10:10:26 +02003316# Common helper used by:
3317# - component_test_psa_crypto_config_accel_ecc_no_bignum
3318# - component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003319#
Valerio Setti4e2f2442023-08-15 10:10:26 +02003320# The goal is to build and test accelerating either:
3321# - ECC only or
3322# - both ECC and FFDH
3323#
3324# It is meant to be used in conjunction with
Valerio Setti5dfaca42023-09-05 08:48:51 +02003325# common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum() for drivers
3326# coverage analysis in the "analyze_outcomes.py" script.
Valerio Setti4e2f2442023-08-15 10:10:26 +02003327common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003328 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003329
Valerio Setti5dfaca42023-09-05 08:48:51 +02003330 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003331 if [ "$test_target" = "ECC_DH" ]; then
3332 accel_text="ECC/FFDH"
3333 removed_text="ECP - DH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003334 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003335 accel_text="ECC"
3336 removed_text="ECP"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003337 fi
3338
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003339 msg "build: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003340
3341 # By default we accelerate all EC keys/algs
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003342 loc_accel_list="ALG_ECDSA ALG_DETERMINISTIC_ECDSA \
3343 ALG_ECDH \
3344 ALG_JPAKE \
Valerio Setti3fe105b2023-10-30 11:08:12 +01003345 $(helper_get_psa_key_type_list "ECC") \
3346 $(helper_get_psa_curve_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003347 # Optionally we can also add DH to the list of accelerated items
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003348 if [ "$test_target" = "ECC_DH" ]; then
Valerio Setti4e2f2442023-08-15 10:10:26 +02003349 loc_accel_list="$loc_accel_list \
3350 ALG_FFDH \
Valerio Setti78aa0bc2024-01-17 15:53:46 +01003351 $(helper_get_psa_key_type_list "DH") \
3352 $(helper_get_psa_dh_group_list)"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003353 fi
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003354
3355 # Configure
3356 # ---------
3357
3358 # Set common configurations between library's and driver's builds
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003359 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 1 "$test_target"
Valerio Settib2fd6732023-08-15 17:10:47 +02003360 # Disable all the builtin curves. All the required algs are accelerated.
3361 helper_disable_builtin_curves
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003362
3363 # Build
3364 # -----
3365
3366 # Things we wanted supported in libtestdriver1, but not accelerated in the main library:
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003367 # SHA-1 and all SHA-2/3 variants, as they are used by ECDSA deterministic.
3368 loc_extra_list="ALG_SHA_1 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3369 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003370
3371 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
3372
Valerio Setti3fe105b2023-10-30 11:08:12 +01003373 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003374
3375 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3376 not grep mbedtls_ecdsa_ library/ecdsa.o
3377 not grep mbedtls_ecdh_ library/ecdh.o
3378 not grep mbedtls_ecjpake_ library/ecjpake.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003379 # Also ensure that ECP, RSA, [DHM] or BIGNUM modules were not re-enabled
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003380 not grep mbedtls_ecp_ library/ecp.o
Manuel Pégourié-Gonnard06aebe42023-06-12 18:33:34 +02003381 not grep mbedtls_rsa_ library/rsa.o
Manuel Pégourié-Gonnard660bbf22023-06-12 18:42:40 +02003382 not grep mbedtls_mpi_ library/bignum.o
Valerio Setti4e2f2442023-08-15 10:10:26 +02003383 not grep mbedtls_dhm_ library/dhm.o
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003384
3385 # Run the tests
3386 # -------------
3387
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003388 msg "test suites: full + accelerated $accel_text algs + USE_PSA - $removed_text - DHM - BIGNUM"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003389
Gilles Peskine21570cf2023-12-22 11:49:50 +01003390 make test
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003391
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003392 msg "ssl-opt: full + accelerated $accel_text algs + USE_PSA - $removed_text - BIGNUM"
Valerio Setti18535c32023-07-31 11:27:17 +02003393 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003394}
3395
Valerio Setti4e2f2442023-08-15 10:10:26 +02003396# Common helper used by:
3397# - component_test_psa_crypto_config_reference_ecc_no_bignum
3398# - component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum
3399#
3400# The goal is to build and test a reference scenario (i.e. with builtin
3401# components) compared to the ones used in
3402# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() above.
3403#
3404# It is meant to be used in conjunction with
3405# common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum() for drivers'
3406# coverage analysis in "analyze_outcomes.py" script.
3407common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003408 test_target="$1"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003409
Valerio Setti5dfaca42023-09-05 08:48:51 +02003410 # This is an internal helper to simplify text message handling
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003411 if [ "$test_target" = "ECC_DH" ]; then
3412 accel_text="ECC/FFDH"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003413 else
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003414 accel_text="ECC"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003415 fi
3416
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003417 msg "build: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti4e2f2442023-08-15 10:10:26 +02003418
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003419 config_psa_crypto_config_accel_ecc_ffdh_no_bignum 0 "$test_target"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003420
Gilles Peskine21570cf2023-12-22 11:49:50 +01003421 make
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003422
Valerio Setti29c1b4d2023-07-27 10:08:45 +02003423 msg "test suites: full + non accelerated EC algs + USE_PSA"
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003424 make test
3425
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003426 msg "ssl-opt: full + non accelerated $accel_text algs + USE_PSA"
Valerio Setti18535c32023-07-31 11:27:17 +02003427 tests/ssl-opt.sh
Manuel Pégourié-Gonnardabd00d02023-06-12 17:51:33 +02003428}
3429
Valerio Setti4e2f2442023-08-15 10:10:26 +02003430component_test_psa_crypto_config_accel_ecc_no_bignum () {
3431 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC"
3432}
3433
3434component_test_psa_crypto_config_reference_ecc_no_bignum () {
3435 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC"
3436}
3437
3438component_test_psa_crypto_config_accel_ecc_ffdh_no_bignum () {
3439 common_test_psa_crypto_config_accel_ecc_ffdh_no_bignum "ECC_DH"
3440}
3441
3442component_test_psa_crypto_config_reference_ecc_ffdh_no_bignum () {
3443 common_test_psa_crypto_config_reference_ecc_ffdh_no_bignum "ECC_DH"
3444}
3445
Valerio Settiac6d35f2023-08-04 12:49:11 +02003446# Helper for setting common configurations between:
3447# - component_test_tfm_config_p256m_driver_accel_ec()
3448# - component_test_tfm_config()
Valerio Setti52ba0e32023-08-04 12:43:03 +02003449common_tfm_config () {
3450 # Enable TF-M config
Yanray Wang70505042023-09-21 17:11:40 +08003451 cp configs/config-tfm.h "$CONFIG_H"
3452 echo "#undef MBEDTLS_PSA_CRYPTO_CONFIG_FILE" >> "$CONFIG_H"
3453 cp configs/ext/crypto_config_profile_medium.h "$CRYPTO_CONFIG_H"
Valerio Settic5c4bd22023-08-03 14:28:20 +02003454
Yanray Wang73bb2312023-09-25 11:21:15 +08003455 # Other config adjustment to make the tests pass.
3456 # This should probably be adopted upstream.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003457 #
Manuel Pégourié-Gonnard96839e72023-08-08 13:01:29 +02003458 # - USE_PSA_CRYPTO for PK_HAVE_ECC_KEYS
3459 echo "#define MBEDTLS_USE_PSA_CRYPTO" >> "$CONFIG_H"
Valerio Setti52ba0e32023-08-04 12:43:03 +02003460
Yanray Wang73bb2312023-09-25 11:21:15 +08003461 # Config adjustment for better test coverage in our environment.
3462 # This is not needed just to build and pass tests.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003463 #
3464 # Enable filesystem I/O for the benefit of PK parse/write tests.
3465 echo "#define MBEDTLS_FS_IO" >> "$CONFIG_H"
3466}
3467
Valerio Settiac6d35f2023-08-04 12:49:11 +02003468# Keep this in sync with component_test_tfm_config() as they are both meant
3469# to be used in analyze_outcomes.py for driver's coverage analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003470component_test_tfm_config_p256m_driver_accel_ec () {
3471 msg "build: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
3472
3473 common_tfm_config
Valerio Settic5c4bd22023-08-03 14:28:20 +02003474
Dave Rodgman897bb772023-11-15 16:34:20 +00003475 # Build crypto library
Dave Rodgman17127e92023-12-14 16:42:48 +00003476 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS -I../tests/include/spe" LDFLAGS="$ASAN_CFLAGS"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003477
Manuel Pégourié-Gonnardf8930e22023-06-13 09:51:32 +02003478 # Make sure any built-in EC alg was not re-enabled by accident (additive config)
3479 not grep mbedtls_ecdsa_ library/ecdsa.o
Valerio Settib7e95442023-03-21 11:52:33 +01003480 not grep mbedtls_ecdh_ library/ecdh.o
3481 not grep mbedtls_ecjpake_ library/ecjpake.o
3482 # Also ensure that ECP, RSA, DHM or BIGNUM modules were not re-enabled
3483 not grep mbedtls_ecp_ library/ecp.o
3484 not grep mbedtls_rsa_ library/rsa.o
Valerio Settie4758aa2023-03-24 16:51:17 +01003485 not grep mbedtls_dhm_ library/dhm.o
Valerio Settiee97a1e2023-03-27 12:44:15 +02003486 not grep mbedtls_mpi_ library/bignum.o
Dave Rodgman897bb772023-11-15 16:34:20 +00003487 # Check that p256m was built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003488 grep -q p256_ecdsa_ library/libmbedcrypto.a
Valerio Settib7e95442023-03-21 11:52:33 +01003489
Valerio Setti5e18b902023-12-04 12:07:30 +01003490 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3491 # files, so we want to ensure that it has not be re-enabled accidentally.
3492 not grep mbedtls_cipher library/cipher.o
3493
Valerio Settib7e95442023-03-21 11:52:33 +01003494 # Run the tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003495 msg "test: TF-M config + p256m driver + accel ECDH(E)/ECDSA"
Valerio Settib7e95442023-03-21 11:52:33 +01003496 make test
Valerio Settie4758aa2023-03-24 16:51:17 +01003497}
Valerio Settiee97a1e2023-03-27 12:44:15 +02003498
Valerio Settiac6d35f2023-08-04 12:49:11 +02003499# Keep this in sync with component_test_tfm_config_p256m_driver_accel_ec() as
3500# they are both meant to be used in analyze_outcomes.py for driver's coverage
3501# analysis.
Valerio Setti52ba0e32023-08-04 12:43:03 +02003502component_test_tfm_config() {
3503 common_tfm_config
Valerio Settiee97a1e2023-03-27 12:44:15 +02003504
Dave Rodgman897bb772023-11-15 16:34:20 +00003505 # Disable P256M driver, which is on by default, so that analyze_outcomes
3506 # can compare this test with test_tfm_config_p256m_driver_accel_ec
3507 echo "#undef MBEDTLS_PSA_P256M_DRIVER_ENABLED" >> "$CONFIG_H"
3508
Valerio Setti52ba0e32023-08-04 12:43:03 +02003509 msg "build: TF-M config"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02003510 make CFLAGS='-Werror -Wall -Wextra -I../tests/include/spe' tests
Valerio Setti52ba0e32023-08-04 12:43:03 +02003511
Dave Rodgman897bb772023-11-15 16:34:20 +00003512 # Check that p256m was not built
Dave Rodgmanbe5489a2023-11-27 10:30:03 +00003513 not grep p256_ecdsa_ library/libmbedcrypto.a
Dave Rodgman897bb772023-11-15 16:34:20 +00003514
Valerio Setti5e18b902023-12-04 12:07:30 +01003515 # In "config-tfm.h" we disabled CIPHER_C tweaking TF-M's configuration
3516 # files, so we want to ensure that it has not be re-enabled accidentally.
3517 not grep mbedtls_cipher library/cipher.o
3518
Valerio Setti52ba0e32023-08-04 12:43:03 +02003519 msg "test: TF-M config"
3520 make test
Valerio Settic5c4bd22023-08-03 14:28:20 +02003521}
3522
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003523# Common helper for component_full_without_ecdhe_ecdsa() and
3524# component_full_without_ecdhe_ecdsa_and_tls13() which:
3525# - starts from the "full" configuration minus the list of symbols passed in
3526# as 1st parameter
3527# - build
3528# - test only TLS (i.e. test_suite_tls and ssl-opt)
3529build_full_minus_something_and_test_tls () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003530 symbols_to_disable="$1"
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003531
3532 msg "build: full minus something, test TLS"
3533
3534 scripts/config.py full
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003535 for sym in $symbols_to_disable; do
3536 echo "Disabling $sym"
3537 scripts/config.py unset $sym
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003538 done
Valerio Settie4758aa2023-03-24 16:51:17 +01003539
Gilles Peskine21570cf2023-12-22 11:49:50 +01003540 make
Valerio Settiee97a1e2023-03-27 12:44:15 +02003541
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003542 msg "test: full minus something, test TLS"
3543 ( cd tests; ./test_suite_ssl )
Valerio Settib7e95442023-03-21 11:52:33 +01003544
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003545 msg "ssl-opt: full minus something, test TLS"
Valerio Settib7e95442023-03-21 11:52:33 +01003546 tests/ssl-opt.sh
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003547}
Valerio Setti1f1420d2023-03-28 10:35:45 +02003548
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003549component_full_without_ecdhe_ecdsa () {
3550 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED"
Valerio Settib7e95442023-03-21 11:52:33 +01003551}
3552
Valerio Setti5a57e2a2023-08-02 11:30:50 +02003553component_full_without_ecdhe_ecdsa_and_tls13 () {
3554 build_full_minus_something_and_test_tls "MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
3555 MBEDTLS_SSL_PROTO_TLS1_3"
Valerio Settie4758aa2023-03-24 16:51:17 +01003556}
3557
Valerio Setti249b18a2023-06-20 12:08:30 +02003558# This is an helper used by:
3559# - component_test_psa_ecc_key_pair_no_derive
3560# - component_test_psa_ecc_key_pair_no_generate
3561# The goal is to test with all PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy symbols
3562# enabled, but one. Input arguments are as follows:
3563# - $1 is the key type under test, i.e. ECC/RSA/DH
3564# - $2 is the key option to be unset (i.e. generate, derive, etc)
Valerio Settia9836552023-06-22 11:22:23 +02003565build_and_test_psa_want_key_pair_partial() {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003566 key_type=$1
3567 unset_option=$2
3568 disabled_psa_want="PSA_WANT_KEY_TYPE_${key_type}_KEY_PAIR_${unset_option}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003569
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003570 msg "build: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003571 scripts/config.py full
Valerio Setti249b18a2023-06-20 12:08:30 +02003572 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
3573 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
3574
3575 # All the PSA_WANT_KEY_TYPE_xxx_KEY_PAIR_yyy are enabled by default in
3576 # crypto_config.h so we just disable the one we don't want.
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003577 scripts/config.py -f "$CRYPTO_CONFIG_H" unset "$disabled_psa_want"
Valerio Setti249b18a2023-06-20 12:08:30 +02003578
Gilles Peskine21570cf2023-12-22 11:49:50 +01003579 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Setti249b18a2023-06-20 12:08:30 +02003580
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003581 msg "test: full - MBEDTLS_USE_PSA_CRYPTO - ${disabled_psa_want}"
Valerio Setti249b18a2023-06-20 12:08:30 +02003582 make test
3583}
3584
3585component_test_psa_ecc_key_pair_no_derive() {
Valerio Settia9836552023-06-22 11:22:23 +02003586 build_and_test_psa_want_key_pair_partial "ECC" "DERIVE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003587}
3588
3589component_test_psa_ecc_key_pair_no_generate() {
Valerio Settia9836552023-06-22 11:22:23 +02003590 build_and_test_psa_want_key_pair_partial "ECC" "GENERATE"
Valerio Setti249b18a2023-06-20 12:08:30 +02003591}
3592
Pengyu Lve705f572023-12-06 16:38:15 +08003593config_psa_crypto_accel_rsa () {
3594 driver_only=$1
Ronald Cron403c15c2021-09-13 09:38:05 +02003595
Pengyu Lve705f572023-12-06 16:38:15 +08003596 # Start from crypto_full config (no X.509, no TLS)
3597 helper_libtestdriver1_adjust_config "crypto_full"
3598
3599 if [ "$driver_only" -eq 1 ]; then
3600 # Remove RSA support and its dependencies
3601 scripts/config.py unset MBEDTLS_RSA_C
3602 scripts/config.py unset MBEDTLS_PKCS1_V15
3603 scripts/config.py unset MBEDTLS_PKCS1_V21
3604
3605 # We need PEM parsing in the test library as well to support the import
3606 # of PEM encoded RSA keys.
3607 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_PEM_PARSE_C
3608 scripts/config.py -f "$CONFIG_TEST_DRIVER_H" set MBEDTLS_BASE64_C
3609 fi
3610}
3611
3612component_test_psa_crypto_config_accel_rsa_crypto () {
3613 msg "build: crypto_full with accelerated RSA"
3614
3615 loc_accel_list="ALG_RSA_OAEP ALG_RSA_PSS \
3616 ALG_RSA_PKCS1V15_CRYPT ALG_RSA_PKCS1V15_SIGN \
3617 KEY_TYPE_RSA_PUBLIC_KEY \
3618 KEY_TYPE_RSA_KEY_PAIR_BASIC \
3619 KEY_TYPE_RSA_KEY_PAIR_GENERATE \
3620 KEY_TYPE_RSA_KEY_PAIR_IMPORT \
3621 KEY_TYPE_RSA_KEY_PAIR_EXPORT"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003622
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003623 # Configure
3624 # ---------
Ronald Cron403c15c2021-09-13 09:38:05 +02003625
Pengyu Lve705f572023-12-06 16:38:15 +08003626 config_psa_crypto_accel_rsa 1
Ronald Cron403c15c2021-09-13 09:38:05 +02003627
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003628 # Build
3629 # -----
3630
Pengyu Lve705f572023-12-06 16:38:15 +08003631 # These hashes are needed for unit tests.
Manuel Pégourié-Gonnarde47c53e2023-09-23 08:54:30 +02003632 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 +08003633 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512 ALG_MD5"
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003634 helper_libtestdriver1_make_drivers "$loc_accel_list" "$loc_extra_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003635
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003636 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cron403c15c2021-09-13 09:38:05 +02003637
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003638 # Make sure this was not re-enabled by accident (additive config)
Pengyu Lv98a90c62023-12-07 17:23:25 +08003639 not grep mbedtls_rsa library/rsa.o
Ronald Cron403c15c2021-09-13 09:38:05 +02003640
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003641 # Run the tests
3642 # -------------
3643
Pengyu Lve705f572023-12-06 16:38:15 +08003644 msg "test: crypto_full with accelerated RSA"
Gilles Peskine21570cf2023-12-22 11:49:50 +01003645 make test
Pengyu Lve705f572023-12-06 16:38:15 +08003646}
3647
3648component_test_psa_crypto_config_reference_rsa_crypto () {
3649 msg "build: crypto_full with non-accelerated RSA"
3650
3651 # Configure
3652 # ---------
3653 config_psa_crypto_accel_rsa 0
3654
3655 # Build
3656 # -----
Gilles Peskine21570cf2023-12-22 11:49:50 +01003657 make
Pengyu Lve705f572023-12-06 16:38:15 +08003658
3659 # Run the tests
3660 # -------------
3661 msg "test: crypto_full with non-accelerated RSA"
Ronald Cron403c15c2021-09-13 09:38:05 +02003662 make test
3663}
3664
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003665# This is a temporary test to verify that full RSA support is present even when
Valerio Setti01cc88a2023-06-15 11:53:08 +02003666# only one single new symbols (PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC) is defined.
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003667component_test_new_psa_want_key_pair_symbol() {
Valerio Setti01cc88a2023-06-15 11:53:08 +02003668 msg "Build: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003669
Valerio Setti4590bc22023-06-13 15:39:23 +02003670 # Create a temporary output file unless there is already one set
3671 if [ "$MBEDTLS_TEST_OUTCOME_FILE" ]; then
3672 REMOVE_OUTCOME_ON_EXIT="no"
3673 else
3674 REMOVE_OUTCOME_ON_EXIT="yes"
3675 MBEDTLS_TEST_OUTCOME_FILE="$PWD/out.csv"
3676 export MBEDTLS_TEST_OUTCOME_FILE
3677 fi
3678
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003679 # Start from crypto configuration
3680 scripts/config.py crypto
3681
3682 # Remove RSA support and its dependencies
3683 scripts/config.py unset MBEDTLS_PKCS1_V15
3684 scripts/config.py unset MBEDTLS_PKCS1_V21
3685 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
3686 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
3687 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
3688 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
3689 scripts/config.py unset MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
3690 scripts/config.py unset MBEDTLS_RSA_C
3691 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
3692
3693 # Enable PSA support
3694 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
3695
Valerio Setti01cc88a2023-06-15 11:53:08 +02003696 # Keep only PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC enabled in order to ensure
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003697 # that proper translations is done in crypto_legacy.h.
Ronald Cron6b49b552023-07-20 09:57:54 +02003698 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT
3699 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT
3700 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003701
3702 make
3703
Valerio Setti01cc88a2023-06-15 11:53:08 +02003704 msg "Test: crypto config - MBEDTLS_RSA_C + PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC"
Valerio Setti4590bc22023-06-13 15:39:23 +02003705 make test
3706
3707 # Parse only 1 relevant line from the outcome file, i.e. a test which is
3708 # performing RSA signature.
3709 msg "Verify that 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' is PASS"
3710 cat $MBEDTLS_TEST_OUTCOME_FILE | grep 'RSA PKCS1 Sign #1 (SHA512, 1536 bits RSA)' | grep -q "PASS"
3711
3712 if [ "$REMOVE_OUTCOME_ON_EXIT" == "yes" ]; then
3713 rm $MBEDTLS_TEST_OUTCOME_FILE
3714 fi
Valerio Settia1a0b1b2023-06-13 14:19:03 +02003715}
3716
Ronald Cronb2312452021-05-08 14:32:59 +02003717component_test_psa_crypto_config_accel_hash () {
3718 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3719
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003720 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3721 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3722 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Ronald Cronb2312452021-05-08 14:32:59 +02003723
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003724 # Configure
3725 # ---------
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003726
Ronald Cron46ac0652024-03-18 12:39:04 +01003727 # Start from default config (no USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003728 helper_libtestdriver1_adjust_config "default"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003729
3730 # Disable the things that are being accelerated
Ronald Cronb2312452021-05-08 14:32:59 +02003731 scripts/config.py unset MBEDTLS_MD5_C
3732 scripts/config.py unset MBEDTLS_RIPEMD160_C
3733 scripts/config.py unset MBEDTLS_SHA1_C
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003734 scripts/config.py unset MBEDTLS_SHA224_C
3735 scripts/config.py unset MBEDTLS_SHA256_C
Ronald Cronb2312452021-05-08 14:32:59 +02003736 scripts/config.py unset MBEDTLS_SHA384_C
3737 scripts/config.py unset MBEDTLS_SHA512_C
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003738 scripts/config.py unset MBEDTLS_SHA3_C
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003739
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003740 # Build
3741 # -----
3742
3743 helper_libtestdriver1_make_drivers "$loc_accel_list"
3744
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003745 helper_libtestdriver1_make_main "$loc_accel_list"
Ronald Cronb2312452021-05-08 14:32:59 +02003746
Manuel Pégourié-Gonnardc584c272023-03-22 00:32:04 +01003747 # There's a risk of something getting re-enabled via config_psa.h;
3748 # make sure it did not happen. Note: it's OK for MD_C to be enabled.
3749 not grep mbedtls_md5 library/md5.o
3750 not grep mbedtls_sha1 library/sha1.o
3751 not grep mbedtls_sha256 library/sha256.o
3752 not grep mbedtls_sha512 library/sha512.o
3753 not grep mbedtls_ripemd160 library/ripemd160.o
Ronald Cronb2312452021-05-08 14:32:59 +02003754
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003755 # Run the tests
3756 # -------------
3757
Ronald Cronb2312452021-05-08 14:32:59 +02003758 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated hash"
3759 make test
3760}
3761
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003762# Auxiliary function to build config for hashes with and without drivers
3763config_psa_crypto_hash_use_psa () {
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003764 driver_only="$1"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003765 # start with config full for maximum coverage (also enables USE_PSA)
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003766 helper_libtestdriver1_adjust_config "full"
Manuel Pégourié-Gonnard6be64f72023-09-28 09:08:04 +02003767 if [ "$driver_only" -eq 1 ]; then
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003768 # disable the built-in implementation of hashes
3769 scripts/config.py unset MBEDTLS_MD5_C
3770 scripts/config.py unset MBEDTLS_RIPEMD160_C
3771 scripts/config.py unset MBEDTLS_SHA1_C
3772 scripts/config.py unset MBEDTLS_SHA224_C
3773 scripts/config.py unset MBEDTLS_SHA256_C # see external RNG below
Dave Rodgman5b89c552023-10-10 14:59:02 +01003774 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003775 scripts/config.py unset MBEDTLS_SHA384_C
3776 scripts/config.py unset MBEDTLS_SHA512_C
3777 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003778 scripts/config.py unset MBEDTLS_SHA3_C
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003779 fi
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003780}
3781
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003782# Note that component_test_psa_crypto_config_reference_hash_use_psa
3783# is related to this component and both components need to be kept in sync.
3784# For details please see comments for component_test_psa_crypto_config_reference_hash_use_psa.
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003785component_test_psa_crypto_config_accel_hash_use_psa () {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003786 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003787
Manuel Pégourié-Gonnardcc21ad42023-09-22 09:46:14 +02003788 loc_accel_list="ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3789 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3790 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003791
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003792 # Configure
3793 # ---------
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003794
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003795 config_psa_crypto_hash_use_psa 1
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003796
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003797 # Build
3798 # -----
3799
3800 helper_libtestdriver1_make_drivers "$loc_accel_list"
3801
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003802 helper_libtestdriver1_make_main "$loc_accel_list"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003803
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003804 # There's a risk of something getting re-enabled via config_psa.h;
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003805 # 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 +02003806 not grep mbedtls_md5 library/md5.o
3807 not grep mbedtls_sha1 library/sha1.o
Manuel Pégourié-Gonnard7b0825d2022-07-11 11:06:09 +02003808 not grep mbedtls_sha256 library/sha256.o
Manuel Pégourié-Gonnardf0f63bc2022-07-08 19:12:33 +02003809 not grep mbedtls_sha512 library/sha512.o
3810 not grep mbedtls_ripemd160 library/ripemd160.o
3811
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003812 # Run the tests
3813 # -------------
3814
Gilles Peskine14302ed2023-07-19 19:30:04 +02003815 msg "test: full with accelerated hashes"
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003816 make test
Andrzej Kurek07e35702022-09-05 15:39:23 -04003817
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003818 # This is mostly useful so that we can later compare outcome files with
3819 # the reference config in analyze_outcomes.py, to check that the
3820 # dependency declarations in ssl-opt.sh and in TLS code are correct.
Gilles Peskine14302ed2023-07-19 19:30:04 +02003821 msg "test: ssl-opt.sh, full with accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003822 tests/ssl-opt.sh
Andrzej Kurek07e35702022-09-05 15:39:23 -04003823
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003824 # This is to make sure all ciphersuites are exercised, but we don't need
3825 # interop testing (besides, we already got some from ssl-opt.sh).
Gilles Peskine14302ed2023-07-19 19:30:04 +02003826 msg "test: compat.sh, full with accelerated hashes"
Manuel Pégourié-Gonnard30d94662022-11-29 12:37:53 +01003827 tests/compat.sh -p mbedTLS -V YES
Manuel Pégourié-Gonnard525add62022-07-06 13:06:57 +02003828}
3829
Przemek Stekiel120ed8f2022-10-27 10:29:15 +02003830# This component provides reference configuration for test_psa_crypto_config_accel_hash_use_psa
3831# without accelerated hash. The outcome from both components are used by the analyze_outcomes.py
3832# script to find regression in test coverage when accelerated hash is used (tests and ssl-opt).
3833# Both components need to be kept in sync.
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003834component_test_psa_crypto_config_reference_hash_use_psa() {
Gilles Peskine14302ed2023-07-19 19:30:04 +02003835 msg "test: full without accelerated hashes"
Przemek Stekielaa88e0b2022-11-15 13:21:14 +01003836
3837 config_psa_crypto_hash_use_psa 0
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003838
Gilles Peskine21570cf2023-12-22 11:49:50 +01003839 make
Przemek Stekielab0451b2022-10-24 11:29:35 +02003840
Gilles Peskine14302ed2023-07-19 19:30:04 +02003841 msg "test: full without accelerated hashes"
Przemek Stekiel01df9dd2022-10-20 14:21:21 +02003842 make test
3843
Gilles Peskine14302ed2023-07-19 19:30:04 +02003844 msg "test: ssl-opt.sh, full without accelerated hashes"
Przemek Stekiel5f6f32a2022-10-27 08:24:43 +02003845 tests/ssl-opt.sh
Ronald Cron3a8714d2021-10-18 11:26:01 +02003846}
Manuel Pégourié-Gonnard97ab2a32022-07-06 10:46:57 +02003847
Valerio Setti8eb310c2024-01-22 16:22:57 +01003848# Auxiliary function to build config for hashes with and without drivers
3849config_psa_crypto_hmac_use_psa () {
3850 driver_only="$1"
3851 # start with config full for maximum coverage (also enables USE_PSA)
3852 helper_libtestdriver1_adjust_config "full"
3853
Valerio Setticd89b0b2024-01-24 14:24:55 +01003854 if [ "$driver_only" -eq 1 ]; then
3855 # Disable MD_C in order to disable the builtin support for HMAC. MD_LIGHT
3856 # is still enabled though (for ENTROPY_C among others).
3857 scripts/config.py unset MBEDTLS_MD_C
3858 # Disable also the builtin hashes since they are supported by the driver
3859 # and MD module is able to perform PSA dispathing.
3860 scripts/config.py unset-all MBEDTLS_SHA
3861 scripts/config.py unset MBEDTLS_MD5_C
3862 scripts/config.py unset MBEDTLS_RIPEMD160_C
3863 fi
3864
Valerio Setti8eb310c2024-01-22 16:22:57 +01003865 # Direct dependencies of MD_C. We disable them also in the reference
3866 # component to work with the same set of features.
3867 scripts/config.py unset MBEDTLS_PKCS7_C
3868 scripts/config.py unset MBEDTLS_PKCS5_C
3869 scripts/config.py unset MBEDTLS_HMAC_DRBG_C
3870 scripts/config.py unset MBEDTLS_HKDF_C
3871 # Dependencies of HMAC_DRBG
3872 scripts/config.py unset MBEDTLS_ECDSA_DETERMINISTIC
3873 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_DETERMINISTIC_ECDSA
3874}
3875
3876component_test_psa_crypto_config_accel_hmac() {
3877 msg "test: full with accelerated hmac"
3878
3879 loc_accel_list="ALG_HMAC KEY_TYPE_HMAC \
3880 ALG_MD5 ALG_RIPEMD160 ALG_SHA_1 \
3881 ALG_SHA_224 ALG_SHA_256 ALG_SHA_384 ALG_SHA_512 \
3882 ALG_SHA3_224 ALG_SHA3_256 ALG_SHA3_384 ALG_SHA3_512"
3883
3884 # Configure
3885 # ---------
3886
3887 config_psa_crypto_hmac_use_psa 1
3888
Valerio Setti8eb310c2024-01-22 16:22:57 +01003889 # Build
3890 # -----
3891
3892 helper_libtestdriver1_make_drivers "$loc_accel_list"
3893
3894 helper_libtestdriver1_make_main "$loc_accel_list"
3895
3896 # Ensure that built-in support for HMAC is disabled.
3897 not grep mbedtls_md_hmac library/md.o
3898
3899 # Run the tests
3900 # -------------
3901
3902 msg "test: full with accelerated hmac"
3903 make test
3904}
3905
3906component_test_psa_crypto_config_reference_hmac() {
3907 msg "test: full without accelerated hmac"
3908
3909 config_psa_crypto_hmac_use_psa 0
3910
3911 make
3912
3913 msg "test: full without accelerated hmac"
3914 make test
3915}
3916
Valerio Setti9da01a72023-12-18 17:38:18 +01003917component_test_psa_crypto_config_accel_des () {
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003918 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
Ronald Cron067de3b2021-03-11 11:49:03 +01003919
Valerio Setti9da01a72023-12-18 17:38:18 +01003920 # Albeit this components aims at accelerating DES which should only support
3921 # CBC and ECB modes, we need to accelerate more than that otherwise DES_C
3922 # would automatically be re-enabled by "config_adjust_legacy_from_psa.c"
Valerio Setti0244fbb2023-10-19 10:42:31 +02003923 loc_accel_list="ALG_ECB_NO_PADDING ALG_CBC_NO_PADDING ALG_CBC_PKCS7 \
3924 ALG_CTR ALG_CFB ALG_OFB ALG_XTS ALG_CMAC \
3925 KEY_TYPE_DES"
John Durkopd8959392020-09-20 23:09:17 -07003926
Valerio Setti9da01a72023-12-18 17:38:18 +01003927 # Note: we cannot accelerate all ciphers' key types otherwise we would also
3928 # have to either disable CCM/GCM or accelerate them, but that's out of scope
3929 # of this component. This limitation will be addressed by #8598.
3930
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003931 # Configure
3932 # ---------
Ronald Cron067de3b2021-03-11 11:49:03 +01003933
Valerio Setti9a427302023-10-17 11:40:42 +02003934 # Start from the full config
Valerio Settia797ce32023-10-03 15:16:38 +02003935 helper_libtestdriver1_adjust_config "full"
Ronald Cron067de3b2021-03-11 11:49:03 +01003936
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003937 # Disable the things that are being accelerated
Ronald Cron067de3b2021-03-11 11:49:03 +01003938 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
3939 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
3940 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
3941 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
3942 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
3943 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
3944 scripts/config.py unset MBEDTLS_DES_C
Yanray Wangaf5003a2023-10-11 11:57:10 +08003945 scripts/config.py unset MBEDTLS_CMAC_C
Ronald Cron067de3b2021-03-11 11:49:03 +01003946
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003947 # Build
3948 # -----
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003949
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003950 helper_libtestdriver1_make_drivers "$loc_accel_list"
3951
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003952 helper_libtestdriver1_make_main "$loc_accel_list"
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003953
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003954 # Make sure this was not re-enabled by accident (additive config)
Gilles Peskine3587dfd2021-09-20 19:20:04 +02003955 not grep mbedtls_des* library/des.o
Ronald Cron17b3afc2020-12-10 18:17:09 +01003956
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003957 # Run the tests
3958 # -------------
3959
Valerio Settib9f4bfc2023-12-28 11:07:48 +01003960 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated DES"
John Durkop4377bf72020-10-23 01:26:57 -07003961 make test
3962}
3963
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003964component_test_psa_crypto_config_accel_aead () {
3965 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
3966
Valerio Setti3f02bb72023-10-02 15:57:33 +02003967 loc_accel_list="ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 \
3968 KEY_TYPE_AES KEY_TYPE_CHACHA20 KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003969
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003970 # Configure
3971 # ---------
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003972
Valerio Setti3f02bb72023-10-02 15:57:33 +02003973 # Start from full config
3974 helper_libtestdriver1_adjust_config "full"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003975
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003976 # Disable things that are being accelerated
Przemek Stekielee1bb412022-10-11 11:52:25 +02003977 scripts/config.py unset MBEDTLS_GCM_C
3978 scripts/config.py unset MBEDTLS_CCM_C
3979 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003980
Valerio Settia50b89e2023-11-08 15:58:47 +01003981 # Disable CCM_STAR_NO_TAG because this re-enables CCM_C.
3982 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003983
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003984 # Build
3985 # -----
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003986
Manuel Pégourié-Gonnard8df87bf2023-06-12 17:09:38 +02003987 helper_libtestdriver1_make_drivers "$loc_accel_list"
3988
Manuel Pégourié-Gonnard27dd73f2023-05-25 10:39:23 +02003989 helper_libtestdriver1_make_main "$loc_accel_list"
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003990
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003991 # Make sure this was not re-enabled by accident (additive config)
Przemek Stekielee1bb412022-10-11 11:52:25 +02003992 not grep mbedtls_ccm library/ccm.o
3993 not grep mbedtls_gcm library/gcm.o
3994 not grep mbedtls_chachapoly library/chachapoly.o
3995
Manuel Pégourié-Gonnard239094d2023-05-31 12:51:50 +02003996 # Run the tests
3997 # -------------
3998
Przemek Stekiele290f2e2022-10-02 20:58:39 +02003999 msg "test: MBEDTLS_PSA_CRYPTO_CONFIG with accelerated AEAD"
4000 make test
4001}
4002
Valerio Settib680fc42023-10-13 09:29:37 +02004003# This is a common configuration function used in:
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004004# - component_test_psa_crypto_config_accel_cipher_aead_cmac
4005# - component_test_psa_crypto_config_reference_cipher_aead_cmac
4006common_psa_crypto_config_accel_cipher_aead_cmac() {
Pengyu Lv78657d02023-10-27 11:00:32 +08004007 # Start from the full config
4008 helper_libtestdriver1_adjust_config "full"
4009
Valerio Settib680fc42023-10-13 09:29:37 +02004010 scripts/config.py unset MBEDTLS_NIST_KW_C
4011}
4012
Valerio Settib6b301f2023-10-04 12:05:05 +02004013# The 2 following test components, i.e.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004014# - component_test_psa_crypto_config_accel_cipher_aead_cmac
4015# - component_test_psa_crypto_config_reference_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004016# are meant to be used together in analyze_outcomes.py script in order to test
4017# driver's coverage for ciphers and AEADs.
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004018component_test_psa_crypto_config_accel_cipher_aead_cmac () {
4019 msg "build: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004020
Valerio Settiad8b7f02023-10-25 12:39:50 +02004021 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 +01004022 ALG_OFB ALG_XTS ALG_STREAM_CIPHER ALG_CCM_STAR_NO_TAG \
Valerio Setti97454fd2023-10-25 12:27:12 +02004023 ALG_GCM ALG_CCM ALG_CHACHA20_POLY1305 ALG_CMAC \
Valerio Settib6b301f2023-10-04 12:05:05 +02004024 KEY_TYPE_DES KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CHACHA20 KEY_TYPE_CAMELLIA"
4025
4026 # Configure
4027 # ---------
4028
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004029 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004030
4031 # Disable the things that are being accelerated
4032 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4033 scripts/config.py unset MBEDTLS_CIPHER_PADDING_PKCS7
4034 scripts/config.py unset MBEDTLS_CIPHER_MODE_CTR
4035 scripts/config.py unset MBEDTLS_CIPHER_MODE_CFB
4036 scripts/config.py unset MBEDTLS_CIPHER_MODE_OFB
4037 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4038 scripts/config.py unset MBEDTLS_GCM_C
4039 scripts/config.py unset MBEDTLS_CCM_C
4040 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Valerio Setti97454fd2023-10-25 12:27:12 +02004041 scripts/config.py unset MBEDTLS_CMAC_C
Valerio Settib6b301f2023-10-04 12:05:05 +02004042 scripts/config.py unset MBEDTLS_DES_C
4043 scripts/config.py unset MBEDTLS_AES_C
4044 scripts/config.py unset MBEDTLS_ARIA_C
4045 scripts/config.py unset MBEDTLS_CHACHA20_C
4046 scripts/config.py unset MBEDTLS_CAMELLIA_C
4047
Valerio Settiec9b2582023-11-08 16:50:54 +01004048 # Disable CIPHER_C entirely as all ciphers/AEADs are accelerated and PSA
4049 # does not depend on it.
4050 scripts/config.py unset MBEDTLS_CIPHER_C
4051
Valerio Settib6b301f2023-10-04 12:05:05 +02004052 # Build
4053 # -----
4054
4055 helper_libtestdriver1_make_drivers "$loc_accel_list"
4056
4057 helper_libtestdriver1_make_main "$loc_accel_list"
4058
4059 # Make sure this was not re-enabled by accident (additive config)
Valerio Settiec9b2582023-11-08 16:50:54 +01004060 not grep mbedtls_cipher library/cipher.o
Valerio Setti58d2b1a2023-10-12 15:24:12 +02004061 not grep mbedtls_des library/des.o
4062 not grep mbedtls_aes library/aes.o
4063 not grep mbedtls_aria library/aria.o
4064 not grep mbedtls_camellia library/camellia.o
Valerio Settib6b301f2023-10-04 12:05:05 +02004065 not grep mbedtls_ccm library/ccm.o
4066 not grep mbedtls_gcm library/gcm.o
4067 not grep mbedtls_chachapoly library/chachapoly.o
4068 not grep mbedtls_cmac library/cmac.o
4069
4070 # Run the tests
4071 # -------------
4072
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004073 msg "test: full config with accelerated cipher inc. AEAD and CMAC"
Gilles Peskine21570cf2023-12-22 11:49:50 +01004074 make test
Valerio Settif9414552023-11-09 10:43:20 +01004075
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004076 msg "ssl-opt: full config with accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004077 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004078
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004079 msg "compat.sh: full config with accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004080 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004081}
4082
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004083component_test_psa_crypto_config_reference_cipher_aead_cmac () {
4084 msg "build: full config with non-accelerated cipher inc. AEAD and CMAC"
4085 common_psa_crypto_config_accel_cipher_aead_cmac
Valerio Settib6b301f2023-10-04 12:05:05 +02004086
Gilles Peskine21570cf2023-12-22 11:49:50 +01004087 make
Valerio Settif9414552023-11-09 10:43:20 +01004088
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004089 msg "test: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settib6b301f2023-10-04 12:05:05 +02004090 make test
Valerio Settif9414552023-11-09 10:43:20 +01004091
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004092 msg "ssl-opt: full config with non-accelerated cipher inc. AEAD and CMAC"
Valerio Settif9414552023-11-09 10:43:20 +01004093 tests/ssl-opt.sh
Pengyu Lvf561ed82023-11-14 17:33:32 +08004094
Manuel Pégourié-Gonnard7f48d5e2024-01-08 10:55:09 +01004095 msg "compat.sh: full config with non-accelerated cipher inc. AEAD and CMAC"
Pengyu Lvf561ed82023-11-14 17:33:32 +08004096 tests/compat.sh -V NO -p mbedTLS
Valerio Settib6b301f2023-10-04 12:05:05 +02004097}
4098
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004099common_block_cipher_dispatch() {
4100 TEST_WITH_DRIVER="$1"
4101
4102 # Start from the full config
4103 helper_libtestdriver1_adjust_config "full"
4104
4105 if [ "$TEST_WITH_DRIVER" -eq 1 ]; then
4106 # Disable key types that are accelerated (there is no legacy equivalent
4107 # symbol for ECB)
4108 scripts/config.py unset MBEDTLS_AES_C
4109 scripts/config.py unset MBEDTLS_ARIA_C
4110 scripts/config.py unset MBEDTLS_CAMELLIA_C
4111 fi
4112
Valerio Setti8c8b4da2024-01-02 11:44:30 +01004113 # Disable cipher's modes that, when not accelerated, cause
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004114 # legacy key types to be re-enabled in "config_adjust_legacy_from_psa.h".
Valerio Setticd21d4e2023-12-28 16:00:55 +01004115 # Keep this also in the reference component in order to skip the same tests
4116 # that were skipped in the accelerated one.
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004117 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CTR
4118 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CFB
4119 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_OFB
4120 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
4121 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
4122 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CMAC
4123 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CCM_STAR_NO_TAG
Ronald Crona33a8242024-05-15 18:31:17 +02004124 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004125
4126 # Disable direct dependency on AES_C
4127 scripts/config.py unset MBEDTLS_NIST_KW_C
4128
4129 # Prevent the cipher module from using deprecated PSA path. The reason is
4130 # that otherwise there will be tests relying on "aes_info" (defined in
4131 # "cipher_wrap.c") whose functions are not available when AES_C is
4132 # not defined. ARIA and Camellia are not a problem in this case because
4133 # the PSA path is not tested for these key types.
4134 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
4135}
4136
Valerio Settif8e6cba2023-12-12 11:53:39 +01004137component_test_full_block_cipher_psa_dispatch () {
4138 msg "build: full + PSA dispatch in block_cipher"
4139
4140 loc_accel_list="ALG_ECB_NO_PADDING \
4141 KEY_TYPE_AES KEY_TYPE_ARIA KEY_TYPE_CAMELLIA"
4142
4143 # Configure
4144 # ---------
4145
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004146 common_block_cipher_dispatch 1
Valerio Settif8e6cba2023-12-12 11:53:39 +01004147
Valerio Settif8e6cba2023-12-12 11:53:39 +01004148 # Build
4149 # -----
4150
4151 helper_libtestdriver1_make_drivers "$loc_accel_list"
4152
4153 helper_libtestdriver1_make_main "$loc_accel_list"
4154
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004155 # Make sure disabled components were not re-enabled by accident (additive
4156 # config)
4157 not grep mbedtls_aes_ library/aes.o
4158 not grep mbedtls_aria_ library/aria.o
4159 not grep mbedtls_camellia_ library/camellia.o
4160
Valerio Settif8e6cba2023-12-12 11:53:39 +01004161 # Run the tests
4162 # -------------
4163
4164 msg "test: full + PSA dispatch in block_cipher"
4165 make test
4166}
4167
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004168# This is the reference component of component_test_full_block_cipher_psa_dispatch
4169component_test_full_block_cipher_legacy_dispatch () {
4170 msg "build: full + legacy dispatch in block_cipher"
4171
4172 common_block_cipher_dispatch 0
4173
Valerio Setti4a8ef7c2023-12-19 11:16:27 +01004174 make
4175
4176 msg "test: full + legacy dispatch in block_cipher"
4177 make test
4178}
4179
Gilles Peskine36dea152023-07-20 22:19:45 +02004180component_test_aead_chachapoly_disabled() {
4181 msg "build: full minus CHACHAPOLY"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004182 scripts/config.py full
4183 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
Ronald Cron6b49b552023-07-20 09:57:54 +02004184 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
Gilles Peskine21570cf2023-12-22 11:49:50 +01004185 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004186
Gilles Peskine36dea152023-07-20 22:19:45 +02004187 msg "test: full minus CHACHAPOLY"
4188 make test
4189}
4190
4191component_test_aead_only_ccm() {
4192 msg "build: full minus CHACHAPOLY and GCM"
4193 scripts/config.py full
4194 scripts/config.py unset MBEDTLS_CHACHAPOLY_C
4195 scripts/config.py unset MBEDTLS_GCM_C
4196 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CHACHA20_POLY1305
4197 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_GCM
Gilles Peskine21570cf2023-12-22 11:49:50 +01004198 make CC=$ASAN_CC CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskine36dea152023-07-20 22:19:45 +02004199
4200 msg "test: full minus CHACHAPOLY and GCM"
Przemyslaw Stekiel1ecfdea2021-10-13 11:09:44 +02004201 make test
4202}
4203
Ronald Crone501d0e2023-07-10 08:31:19 +02004204component_test_ccm_aes_sha256() {
4205 msg "build: CCM + AES + SHA256 configuration"
4206
Ronald Cron7612d8c2023-07-20 10:03:54 +02004207 cp "$CONFIG_TEST_DRIVER_H" "$CONFIG_H"
Ronald Cron6b49b552023-07-20 09:57:54 +02004208 cp configs/crypto-config-ccm-aes-sha256.h "$CRYPTO_CONFIG_H"
Ronald Crone501d0e2023-07-10 08:31:19 +02004209
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004210 make
Ronald Crone501d0e2023-07-10 08:31:19 +02004211
4212 msg "test: CCM + AES + SHA256 configuration"
4213 make test
4214}
4215
Dave Rodgman904c5892023-06-28 17:36:02 +01004216support_build_tfm_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08004217 support_build_armcc
Dave Rodgmanc164c072023-06-28 09:43:23 +01004218}
4219
Dave Rodgman904c5892023-06-28 17:36:02 +01004220component_build_tfm_armcc() {
4221 # test the TF-M configuration can build cleanly with various warning flags enabled
Dave Rodgman82d7a872023-11-28 10:06:33 +00004222 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanc164c072023-06-28 09:43:23 +01004223
Dave Rodgman88651c42023-06-29 12:35:51 +01004224 msg "build: TF-M config, armclang armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004225 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 +01004226}
4227
4228component_build_tfm() {
Gilles Peskineeaa1c562023-09-06 16:23:13 +02004229 # Check that the TF-M configuration can build cleanly with various
4230 # warning flags enabled. We don't build or run tests, since the
4231 # TF-M configuration needs a TF-M platform. A tweaked version of
4232 # the configuration that works on mainstream platforms is in
4233 # configs/config-tfm.h, tested via test-ref-configs.pl.
Dave Rodgman82d7a872023-11-28 10:06:33 +00004234 cp configs/config-tfm.h "$CONFIG_H"
Dave Rodgmanfb374e62023-06-29 11:58:16 +01004235
Dave Rodgman88651c42023-06-29 12:35:51 +01004236 msg "build: TF-M config, clang, armv7-m thumb2"
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004237 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 +01004238
Dave Rodgman904c5892023-06-28 17:36:02 +01004239 msg "build: TF-M config, gcc native build"
4240 make clean
Gilles Peskinec1bedfe2023-09-27 15:53:08 +02004241 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 +01004242}
4243
Dave Rodgman54ada8b2023-10-04 11:55:25 +01004244# Test that the given .o file builds with all (valid) combinations of the given options.
4245#
4246# Syntax: build_test_config_combos FILE VALIDATOR_FUNCTION OPT1 OPT2 ...
4247#
4248# The validator function is the name of a function to validate the combination of options.
4249# It may be "" if all combinations are valid.
4250# It receives a string containing a combination of options, as passed to the compiler,
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004251# e.g. "-DOPT1 -DOPT2 ...". It must return 0 iff the combination is valid, non-zero if invalid.
Dave Rodgman920343a2023-10-01 18:41:09 +01004252build_test_config_combos() {
Dave Rodgman28e38d82023-10-04 11:50:30 +01004253 file=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004254 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004255 validate_options=$1
Dave Rodgman920343a2023-10-01 18:41:09 +01004256 shift
Dave Rodgman28e38d82023-10-04 11:50:30 +01004257 options=("$@")
Dave Rodgman0f0f7692023-06-29 12:10:45 +01004258
Dave Rodgman42436102023-10-03 15:47:05 +01004259 # clear all of the options so that they can be overridden on the clang commandline
Dave Rodgman28e38d82023-10-04 11:50:30 +01004260 for opt in "${options[@]}"; do
4261 ./scripts/config.py unset ${opt}
Dave Rodgman42436102023-10-03 15:47:05 +01004262 done
4263
4264 # enter the directory containing the target file & strip the dir from the filename
Dave Rodgman28e38d82023-10-04 11:50:30 +01004265 cd $(dirname ${file})
4266 file=$(basename ${file})
Dave Rodgman42436102023-10-03 15:47:05 +01004267
Dave Rodgman920343a2023-10-01 18:41:09 +01004268 # The most common issue is unused variables/functions, so ensure -Wunused is set.
Dave Rodgman28e38d82023-10-04 11:50:30 +01004269 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 +01004270
Dave Rodgman42436102023-10-03 15:47:05 +01004271 # Extract the command generated by the Makefile to build the target file.
4272 # This ensures that we have any include paths, macro definitions, etc
4273 # that may be applied by make.
4274 # 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 +01004275 compile_cmd="clang \$(LOCAL_CFLAGS) ${warning_flags} -fsyntax-only -c"
Dave Rodgman42436102023-10-03 15:47:05 +01004276
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004277 makefile=$(TMPDIR=. mktemp)
Dave Rodgman28e38d82023-10-04 11:50:30 +01004278 deps=""
Dave Rodgman97285622023-09-29 17:32:06 +01004279
Dave Rodgman28e38d82023-10-04 11:50:30 +01004280 len=${#options[@]}
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004281 source_file=${file%.o}.c
4282
4283 targets=0
4284 echo 'include Makefile' >${makefile}
Dave Rodgman97285622023-09-29 17:32:06 +01004285
Dave Rodgman28e38d82023-10-04 11:50:30 +01004286 for ((i = 0; i < $((2**${len})); i++)); do
Dave Rodgman920343a2023-10-01 18:41:09 +01004287 # generate each of 2^n combinations of options
Dave Rodgman28e38d82023-10-04 11:50:30 +01004288 # each bit of $i is used to determine if options[i] will be set or not
4289 target="t"
4290 clang_args=""
4291 for ((j = 0; j < ${len}; j++)); do
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004292 if (((i >> j) & 1)); then
Dave Rodgmana7127eb2023-10-04 13:38:41 +01004293 opt=-D${options[$j]}
Dave Rodgman7a8a2492023-10-04 13:14:20 +01004294 clang_args="${clang_args} ${opt}"
4295 target="${target}${opt}"
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004296 fi
Dave Rodgman920343a2023-10-01 18:41:09 +01004297 done
4298
Dave Rodgmanb1107ae2023-10-04 12:30:23 +01004299 # if combination is not known to be invalid, add it to the makefile
Dave Rodgmanf3803a12023-10-16 13:47:15 +01004300 if [[ -z $validate_options ]] || $validate_options "${clang_args}"; then
Dave Rodgman28e38d82023-10-04 11:50:30 +01004301 cmd="${compile_cmd} ${clang_args}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004302 echo "${target}: ${source_file}; $cmd ${source_file}" >> ${makefile}
Dave Rodgman920343a2023-10-01 18:41:09 +01004303
Dave Rodgman28e38d82023-10-04 11:50:30 +01004304 deps="${deps} ${target}"
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004305 ((++targets))
Dave Rodgman745af9f2023-09-29 15:47:07 +01004306 fi
Dave Rodgman97285622023-09-29 17:32:06 +01004307 done
Dave Rodgman6001fb22023-06-29 09:29:00 +01004308
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004309 echo "build_test_config_combos: ${deps}" >> ${makefile}
Dave Rodgmanaea01c92023-09-29 18:54:49 +01004310
Dave Rodgman920343a2023-10-01 18:41:09 +01004311 # execute all of the commands via Make (probably in parallel)
Dave Rodgmancc88ccd2023-10-13 10:33:15 +01004312 make -s -f ${makefile} build_test_config_combos
4313 echo "$targets targets checked"
Dave Rodgman920343a2023-10-01 18:41:09 +01004314
4315 # clean up the temporary makefile
Dave Rodgman28e38d82023-10-04 11:50:30 +01004316 rm ${makefile}
Dave Rodgman6001fb22023-06-29 09:29:00 +01004317}
4318
Dave Rodgman43a5ce82023-10-02 17:09:37 +01004319validate_aes_config_variations() {
Dave Rodgman920343a2023-10-01 18:41:09 +01004320 if [[ "$1" == *"MBEDTLS_AES_USE_HARDWARE_ONLY"* ]]; then
4321 if [[ "$1" == *"MBEDTLS_PADLOCK_C"* ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004322 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004323 fi
4324 if [[ !(("$HOSTTYPE" == "aarch64" && "$1" != *"MBEDTLS_AESCE_C"*) || \
4325 ("$HOSTTYPE" == "x86_64" && "$1" != *"MBEDTLS_AESNI_C"*)) ]]; then
Dave Rodgman41bc7982023-10-16 14:04:21 +01004326 return 1
Dave Rodgman920343a2023-10-01 18:41:09 +01004327 fi
4328 fi
Dave Rodgman41bc7982023-10-16 14:04:21 +01004329 return 0
Dave Rodgman920343a2023-10-01 18:41:09 +01004330}
4331
4332component_build_aes_variations() {
4333 # 18s - around 90ms per clang invocation on M1 Pro
4334 #
Gilles Peskine8f073122018-11-27 15:58:47 +01004335 # aes.o has many #if defined(...) guards that intersect in complex ways.
Dave Rodgman920343a2023-10-01 18:41:09 +01004336 # Test that all the combinations build cleanly.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004337
Yanray Wangbc29aef2023-11-06 11:08:17 +08004338 MBEDTLS_ROOT_DIR="$PWD"
Gilles Peskine32e889d2020-04-12 23:43:28 +02004339 msg "build: aes.o for all combinations of relevant config options"
Gilles Peskinef4d2fd42021-10-08 11:45:47 +02004340
Dave Rodgman42436102023-10-03 15:47:05 +01004341 build_test_config_combos library/aes.o validate_aes_config_variations \
Dave Rodgman920343a2023-10-01 18:41:09 +01004342 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4343 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4344 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4345 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Yanray Wangbc29aef2023-11-06 11:08:17 +08004346
4347 cd "$MBEDTLS_ROOT_DIR"
4348 msg "build: aes.o for all combinations of relevant config options + BLOCK_CIPHER_NO_DECRYPT"
4349
Yanray Wang42be1ba2023-11-23 14:28:47 +08004350 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT is incompatible with ECB in PSA, CBC/XTS/NIST_KW/DES,
Yanray Wangbc29aef2023-11-06 11:08:17 +08004351 # manually set or unset those configurations to check
4352 # MBEDTLS_BLOCK_CIPHER_NO_DECRYPT with various combinations in aes.o.
Yanray Wangbc29aef2023-11-06 11:08:17 +08004353 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
4354 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
4355 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
4356 scripts/config.py unset MBEDTLS_DES_C
4357 scripts/config.py unset MBEDTLS_NIST_KW_C
4358 build_test_config_combos library/aes.o validate_aes_config_variations \
4359 "MBEDTLS_AES_SETKEY_ENC_ALT" "MBEDTLS_AES_DECRYPT_ALT" \
4360 "MBEDTLS_AES_ROM_TABLES" "MBEDTLS_AES_ENCRYPT_ALT" "MBEDTLS_AES_SETKEY_DEC_ALT" \
4361 "MBEDTLS_AES_FEWER_TABLES" "MBEDTLS_PADLOCK_C" "MBEDTLS_AES_USE_HARDWARE_ONLY" \
4362 "MBEDTLS_AESNI_C" "MBEDTLS_AESCE_C" "MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004363}
Gilles Peskinee7fc7ef2021-10-19 21:33:32 +02004364
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004365component_test_no_platform () {
4366 # Full configuration build, without platform support, file IO and net sockets.
4367 # This should catch missing mbedtls_printf definitions, and by disabling file
4368 # IO, it should catch missing '#include <stdio.h>'
4369 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Paul Elliottfb81f772023-10-18 17:44:59 +01004370 scripts/config.py full_no_platform
Simon Butcherf95c1762016-11-10 17:25:58 +00004371 scripts/config.py unset MBEDTLS_PLATFORM_C
4372 scripts/config.py unset MBEDTLS_NET_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004373 scripts/config.py unset MBEDTLS_FS_IO
4374 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Simon Butcherb9283432016-07-13 11:02:41 +01004375 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +01004376 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Paul Elliottfb81f772023-10-18 17:44:59 +01004377 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Simon Butcher284b4c92016-06-26 13:10:00 +01004378 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004379 # to re-enable platform integration features otherwise disabled in C99 builds
4380 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
Gilles Peskine21570cf2023-12-22 11:49:50 +01004381 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Simon Butchercb587002017-01-06 16:14:44 +00004382}
Gilles Peskine7c652162017-12-11 00:01:40 +01004383
4384component_build_no_std_function () {
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00004385 # catch compile bugs in _uninit functions
Gilles Peskine8f073122018-11-27 15:58:47 +01004386 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
4387 scripts/config.py full
4388 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskine8f073122018-11-27 15:58:47 +01004389 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
4390 scripts/config.py unset MBEDTLS_PLATFORM_NV_SEED_ALT
4391 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Check .
4392 make
4393}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01004394
Gilles Peskine8f073122018-11-27 15:58:47 +01004395component_build_no_ssl_srv () {
4396 msg "build: full config except SSL server, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004397 scripts/config.py full
4398 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004399 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004400}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004401
Gilles Peskine8f073122018-11-27 15:58:47 +01004402component_build_no_ssl_cli () {
4403 msg "build: full config except SSL client, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004404 scripts/config.py full
4405 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine21570cf2023-12-22 11:49:50 +01004406 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01004407}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02004408
Gilles Peskine8f073122018-11-27 15:58:47 +01004409component_build_no_sockets () {
4410 # Note, C99 compliance can also be tested with the sockets support disabled,
4411 # as that requires a POSIX platform (which isn't the same as C99).
4412 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01004413 scripts/config.py full
4414 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
4415 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
4416 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
4417}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02004418
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004419component_test_memory_buffer_allocator_backtrace () {
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004420 msg "build: default config with memory buffer allocator and backtrace enabled"
4421 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4422 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4423 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004424 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004425 cmake -DCMAKE_BUILD_TYPE:String=Release .
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04004426 make
4427
4428 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
4429 make test
4430}
4431
4432component_test_memory_buffer_allocator () {
4433 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004434 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4435 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004436 cmake -DCMAKE_BUILD_TYPE:String=Release .
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004437 make
4438
4439 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4440 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01004441
4442 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
4443 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004444 tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00004445}
4446
Gilles Peskine8f073122018-11-27 15:58:47 +01004447component_test_no_max_fragment_length () {
4448 # Run max fragment length tests with MFL disabled
4449 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004450 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004451 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004452 make
Hanno Becker5175ac62017-09-18 15:36:25 +01004453
Gilles Peskine8f073122018-11-27 15:58:47 +01004454 msg "test: ssl-opt.sh, MFL-related tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004455 tests/ssl-opt.sh -f "Max fragment length"
Gilles Peskine8f073122018-11-27 15:58:47 +01004456}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004457
Hanno Becker545ced42019-02-19 11:10:48 +00004458component_test_asan_remove_peer_certificate () {
4459 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004460 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f385d2024-03-18 10:25:37 +01004461 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
Dave Rodgman17127e92023-12-14 16:42:48 +00004462 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Becker545ced42019-02-19 11:10:48 +00004463 make
4464
4465 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
4466 make test
4467
4468 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004469 tests/ssl-opt.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004470
4471 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004472 tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004473
4474 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004475 tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00004476}
4477
Gilles Peskine8f073122018-11-27 15:58:47 +01004478component_test_no_max_fragment_length_small_ssl_out_content_len () {
4479 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004480 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4481 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
4482 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Dave Rodgman17127e92023-12-14 16:42:48 +00004483 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004484 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10004485
Gilles Peskine8f073122018-11-27 15:58:47 +01004486 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004487 tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02004488
4489 msg "test: context-info.sh (disabled MFL extension case)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004490 tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01004491}
Angus Grattonc4dd0732018-04-11 16:28:39 +10004492
Darryl Greenaad82f92019-12-02 10:53:11 +00004493component_test_variable_ssl_in_out_buffer_len () {
4494 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
4495 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgman17127e92023-12-14 16:42:48 +00004496 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004497 make
4498
4499 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
4500 make test
4501
4502 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004503 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004504
4505 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004506 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004507}
4508
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004509component_test_dtls_cid_legacy () {
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004510 msg "build: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled (ASan build)"
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02004511 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 1
Darryl Greenaad82f92019-12-02 10:53:11 +00004512
Dave Rodgman17127e92023-12-14 16:42:48 +00004513 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Darryl Greenaad82f92019-12-02 10:53:11 +00004514 make
4515
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004516 msg "test: MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy)"
Darryl Greenaad82f92019-12-02 10:53:11 +00004517 make test
4518
Hannes Tschofenigdf84bb32022-11-23 11:14:03 +01004519 msg "test: ssl-opt.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004520 tests/ssl-opt.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004521
Manuel Pégourié-Gonnard6a543ba2022-11-25 11:30:10 +01004522 msg "test: compat.sh, MBEDTLS_SSL_DTLS_CONNECTION_ID (legacy) enabled"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004523 tests/compat.sh
Darryl Greenaad82f92019-12-02 10:53:11 +00004524}
4525
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004526component_test_ssl_alloc_buffer_and_mfl () {
4527 msg "build: default config with memory buffer allocator and MFL extension"
4528 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
4529 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4530 scripts/config.py set MBEDTLS_MEMORY_DEBUG
4531 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
4532 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004533 cmake -DCMAKE_BUILD_TYPE:String=Release .
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004534 make
4535
4536 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
4537 make test
4538
4539 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 +02004540 tests/ssl-opt.sh -f "Handshake memory usage"
Piotr Nowicki0937ed22019-11-26 16:32:40 +01004541}
4542
Gilles Peskine636c26a2020-03-04 20:46:15 +01004543component_test_when_no_ciphersuites_have_mac () {
4544 msg "build: when no ciphersuites have MAC"
4545 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
Gilles Peskine636c26a2020-03-04 20:46:15 +01004546 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
TRodziewicz2add5c12021-04-28 16:50:20 +02004547 scripts/config.py unset MBEDTLS_CMAC_C
Gilles Peskine636c26a2020-03-04 20:46:15 +01004548 make
4549
4550 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
4551 make test
4552
4553 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004554 tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
Gilles Peskine636c26a2020-03-04 20:46:15 +01004555}
4556
Raoul Strackxa4e86142020-06-15 17:03:13 +02004557component_test_no_date_time () {
4558 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
4559 scripts/config.py unset MBEDTLS_HAVE_TIME_DATE
Dave Rodgmanea03ef92023-12-19 12:19:59 +00004560 cmake -D CMAKE_BUILD_TYPE:String=Check .
Raoul Strackxa4e86142020-06-15 17:03:13 +02004561 make
4562
4563 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
4564 make test
4565}
4566
Gilles Peskine8f073122018-11-27 15:58:47 +01004567component_test_platform_calloc_macro () {
4568 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02004569 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
4570 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
4571 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Dave Rodgman17127e92023-12-14 16:42:48 +00004572 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine8f073122018-11-27 15:58:47 +01004573 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01004574
Gilles Peskine8f073122018-11-27 15:58:47 +01004575 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
4576 make test
4577}
Hanno Beckere5fecec2018-10-11 11:02:52 +01004578
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004579component_test_malloc_0_null () {
4580 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01004581 scripts/config.py full
Gilles Peskine21570cf2023-12-22 11:49:50 +01004582 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 +02004583
4584 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
4585 make test
4586
4587 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
4588 # Just the calloc selftest. "make test" ran the others as part of the
4589 # test suites.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004590 programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01004591
4592 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
4593 # Run a subset of the tests. The choice is a balance between coverage
4594 # and time (including time indirectly wasted due to flaky tests).
4595 # The current choice is to skip tests whose description includes
4596 # "proxy", which is an approximation of skipping tests that use the
4597 # UDP proxy, which tend to be slower and flakier.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02004598 tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02004599}
4600
Dave Rodgman6a08b682023-06-19 11:51:33 +01004601support_test_aesni() {
4602 # Check that gcc targets x86_64 (we can build AESNI), and check for
4603 # AESNI support on the host (we can run AESNI).
4604 #
4605 # The name of this function is possibly slightly misleading, but needs to align
4606 # with the name of the corresponding test, component_test_aesni.
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004607 #
4608 # In principle 32-bit x86 can support AESNI, but our implementation does not
4609 # support 32-bit x86, so we check for x86-64.
4610 # We can only grep /proc/cpuinfo on Linux, so this also checks for Linux
Dave Rodgman6a08b682023-06-19 11:51:33 +01004611 (gcc -v 2>&1 | grep Target | grep -q x86_64) &&
4612 [[ "$HOSTTYPE" == "x86_64" && "$OSTYPE" == "linux-gnu" ]] &&
Jerry Yua7de78d2023-08-08 12:57:35 +08004613 (lscpu | grep -qw aes)
Dave Rodgmanf8986e32023-06-19 10:55:59 +01004614}
4615
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004616component_test_aesni () { # ~ 60s
4617 # This tests the two AESNI implementations (intrinsics and assembly), and also the plain C
4618 # fallback. It also tests the logic that is used to select which implementation(s) to build.
4619 #
4620 # This test does not require the host to have support for AESNI (if it doesn't, the run-time
4621 # AESNI detection will fallback to the plain C implementation, so the tests will instead
4622 # exercise the plain C impl).
4623
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004624 msg "build: default config with different AES implementations"
Dave Rodgman838dc462023-06-16 13:18:19 +01004625 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004626 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman838dc462023-06-16 13:18:19 +01004627 scripts/config.py set MBEDTLS_HAVE_ASM
4628
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004629 # test the intrinsics implementation
4630 msg "AES tests, test intrinsics"
Dave Rodgman838dc462023-06-16 13:18:19 +01004631 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004632 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004633 # check that we built intrinsics - this should be used by default when supported by the compiler
Jerry Yu1221a312023-08-03 16:09:07 +08004634 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004635
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004636 # test the asm implementation
4637 msg "AES tests, test assembly"
4638 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004639 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mno-pclmul -mno-sse2 -mno-aes'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004640 # check that we built assembly - this should be built if the compiler does not support intrinsics
Jerry Yu1221a312023-08-03 16:09:07 +08004641 ./programs/test/selftest aes | grep "AESNI code" | grep -q "assembly"
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004642
4643 # test the plain C implementation
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004644 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yu17a9d2e2023-08-03 16:14:18 +08004645 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanbe60fcc2023-06-16 17:04:52 +01004646 msg "AES tests, plain C"
4647 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004648 make CC=gcc CFLAGS='-O2 -Werror'
Dave Rodgman96a9e6a2023-06-16 20:18:36 +01004649 # check that there is no AESNI code present
Jerry Yu1221a312023-08-03 16:09:07 +08004650 ./programs/test/selftest aes | not grep -q "AESNI code"
Jerry Yu76a51b92023-08-08 16:03:55 +08004651 not grep -q "AES note: using AESNI" ./programs/test/selftest
4652 grep -q "AES note: built-in implementation." ./programs/test/selftest
Jerry Yu8a599c02023-08-03 17:01:02 +08004653
4654 # test the intrinsics implementation
4655 scripts/config.py set MBEDTLS_AESNI_C
4656 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4657 msg "AES tests, test AESNI only"
4658 make clean
Jerry Yua7de78d2023-08-08 12:57:35 +08004659 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mpclmul -msse2 -maes'
Jerry Yua7de78d2023-08-08 12:57:35 +08004660 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4661 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
Jerry Yu76a51b92023-08-08 16:03:55 +08004662 grep -q "AES note: using AESNI" ./programs/test/selftest
4663 not grep -q "AES note: built-in implementation." ./programs/test/selftest
Dave Rodgman838dc462023-06-16 13:18:19 +01004664}
4665
Dave Rodgman08b81bf2024-02-26 18:03:29 +00004666component_test_sha3_variations() {
4667 msg "sha3 loop unroll variations"
4668
4669 # define minimal config sufficient to test SHA3
4670 cat > include/mbedtls/mbedtls_config.h << END
4671 #define MBEDTLS_SELF_TEST
4672 #define MBEDTLS_SHA3_C
4673END
4674
4675 msg "all loops unrolled"
4676 make clean
4677 make -C tests test_suite_shax CFLAGS="-DMBEDTLS_SHA3_THETA_UNROLL=1 -DMBEDTLS_SHA3_PI_UNROLL=1 -DMBEDTLS_SHA3_CHI_UNROLL=1 -DMBEDTLS_SHA3_RHO_UNROLL=1"
4678 ./tests/test_suite_shax
4679
4680 msg "all loops rolled up"
4681 make clean
4682 make -C tests test_suite_shax CFLAGS="-DMBEDTLS_SHA3_THETA_UNROLL=0 -DMBEDTLS_SHA3_PI_UNROLL=0 -DMBEDTLS_SHA3_CHI_UNROLL=0 -DMBEDTLS_SHA3_RHO_UNROLL=0"
4683 ./tests/test_suite_shax
4684}
4685
Jerry Yub6d39c22023-08-16 15:11:48 +08004686support_test_aesni_m32() {
Dave Rodgman852de3c2023-12-14 14:46:45 +00004687 support_test_m32_no_asm && (lscpu | grep -qw aes)
Jerry Yub6d39c22023-08-16 15:11:48 +08004688}
4689
4690component_test_aesni_m32 () { # ~ 60s
4691 # This tests are duplicated from component_test_aesni for i386 target
4692 #
4693 # AESNI intrinsic code supports i386 and assembly code does not support it.
4694
4695 msg "build: default config with different AES implementations"
4696 scripts/config.py set MBEDTLS_AESNI_C
4697 scripts/config.py set MBEDTLS_PADLOCK_C
4698 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4699 scripts/config.py set MBEDTLS_HAVE_ASM
4700
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004701 # test the intrinsics implementation with gcc
4702 msg "AES tests, test intrinsics (gcc)"
Jerry Yub6d39c22023-08-16 15:11:48 +08004703 make clean
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004704 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
Jerry Yub6d39c22023-08-16 15:11:48 +08004705 # check that we built intrinsics - this should be used by default when supported by the compiler
4706 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4707 grep -q "AES note: using AESNI" ./programs/test/selftest
4708 grep -q "AES note: built-in implementation." ./programs/test/selftest
4709 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4710 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4711
4712 scripts/config.py set MBEDTLS_AESNI_C
Jerry Yub6d39c22023-08-16 15:11:48 +08004713 scripts/config.py unset MBEDTLS_PADLOCK_C
4714 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4715 msg "AES tests, test AESNI only"
4716 make clean
4717 make CC=gcc CFLAGS='-m32 -Werror -Wall -Wextra -mpclmul -msse2 -maes' LDFLAGS='-m32'
4718 ./programs/test/selftest aes | grep -q "AES note: using AESNI"
4719 ./programs/test/selftest aes | not grep -q "AES note: built-in implementation."
4720 grep -q "AES note: using AESNI" ./programs/test/selftest
4721 not grep -q "AES note: built-in implementation." ./programs/test/selftest
4722 not grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4723 not grep -q mbedtls_aesni_has_support ./programs/test/selftest
4724}
4725
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004726support_test_aesni_m32_clang() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004727 # clang >= 4 is required to build with target attributes
4728 support_test_aesni_m32 && [[ $(clang_version) -ge 4 ]]
Beniamin Sandu3bca7812023-10-24 18:55:36 +01004729}
4730
4731component_test_aesni_m32_clang() {
4732
4733 scripts/config.py set MBEDTLS_AESNI_C
4734 scripts/config.py set MBEDTLS_PADLOCK_C
4735 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4736 scripts/config.py set MBEDTLS_HAVE_ASM
4737
4738 # test the intrinsics implementation with clang
4739 msg "AES tests, test intrinsics (clang)"
4740 make clean
4741 make CC=clang CFLAGS='-m32 -Werror -Wall -Wextra' LDFLAGS='-m32'
4742 # check that we built intrinsics - this should be used by default when supported by the compiler
4743 ./programs/test/selftest aes | grep "AESNI code" | grep -q "intrinsics"
4744 grep -q "AES note: using AESNI" ./programs/test/selftest
4745 grep -q "AES note: built-in implementation." ./programs/test/selftest
4746 grep -q "AES note: using VIA Padlock" ./programs/test/selftest
4747 grep -q mbedtls_aesni_has_support ./programs/test/selftest
4748}
4749
Jerry Yu193cbc02023-08-03 17:06:29 +08004750# For timebeing, no aarch64 gcc available in CI and no arm64 CI node.
4751component_build_aes_aesce_armcc () {
4752 msg "Build: AESCE test on arm64 platform without plain C."
4753 scripts/config.py baremetal
4754
4755 # armc[56] don't support SHA-512 intrinsics
4756 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
4757
4758 # Stop armclang warning about feature detection for A64_CRYPTO.
4759 # With this enabled, the library does build correctly under armclang,
4760 # but in baremetal builds (as tested here), feature detection is
4761 # unavailable, and the user is notified via a #warning. So enabling
4762 # this feature would prevent us from building with -Werror on
4763 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01004764 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Jerry Yu193cbc02023-08-03 17:06:29 +08004765 scripts/config.py set MBEDTLS_HAVE_ASM
4766
4767 msg "AESCE, build with default configuration."
4768 scripts/config.py set MBEDTLS_AESCE_C
4769 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4770 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4771
4772 msg "AESCE, build AESCE only"
4773 scripts/config.py set MBEDTLS_AESCE_C
4774 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4775 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto"
4776}
4777
Dave Rodgman0c584032023-10-08 12:26:54 +01004778support_build_aes_armce() {
Tom Cosgrove9e4eeff2024-01-30 13:51:18 +00004779 # clang >= 11 is required to build with AES extensions
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004780 [[ $(clang_version) -ge 11 ]]
Dave Rodgman0c584032023-10-08 12:26:54 +01004781}
4782
4783component_build_aes_armce () {
4784 # Test variations of AES with Armv8 crypto extensions
4785 scripts/config.py set MBEDTLS_AESCE_C
4786 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4787
4788 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
Dave Rodgmanb622ff82023-10-08 22:25:16 +01004789 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004790
4791 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4792 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4793
4794 msg "MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4795 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4796
Dave Rodgman5e419372023-10-23 15:30:20 +01004797 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgman0c584032023-10-08 12:26:54 +01004798
Dave Rodgman5e419372023-10-23 15:30:20 +01004799 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, aarch64"
4800 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a+crypto"
Dave Rodgman0c584032023-10-08 12:26:54 +01004801
Dave Rodgman5e419372023-10-23 15:30:20 +01004802 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, arm"
4803 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
Dave Rodgman0c584032023-10-08 12:26:54 +01004804
Dave Rodgman5e419372023-10-23 15:30:20 +01004805 msg "no MBEDTLS_AES_USE_HARDWARE_ONLY, clang, thumb"
4806 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
Dave Rodgmanf3501b42023-10-11 16:21:25 +01004807
4808 # test for presence of AES instructions
4809 scripts/config.py set MBEDTLS_AES_USE_HARDWARE_ONLY
4810 msg "clang, test A32 crypto instructions built"
4811 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4812 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4813 msg "clang, test T32 crypto instructions built"
4814 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4815 grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4816 msg "clang, test aarch64 crypto instructions built"
4817 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4818 grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
4819
4820 # test for absence of AES instructions
4821 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
4822 scripts/config.py unset MBEDTLS_AESCE_C
4823 msg "clang, test A32 crypto instructions not built"
4824 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4825 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4826 msg "clang, test T32 crypto instructions not built"
4827 make -B library/aesce.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4828 not grep -E 'aes[0-9a-z]+.[0-9]\s*[qv]' library/aesce.o
4829 msg "clang, test aarch64 crypto instructions not built"
4830 make -B library/aesce.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4831 not grep -E 'aes[a-z]+\s*[qv]' library/aesce.o
Dave Rodgman0c584032023-10-08 12:26:54 +01004832}
4833
Dave Rodgman9ed18532023-10-05 00:06:47 +01004834support_build_sha_armce() {
Tom Cosgroved4c373a2024-01-30 13:56:38 +00004835 # clang >= 4 is required to build with SHA extensions
4836 [[ $(clang_version) -ge 4 ]]
Dave Rodgman9ed18532023-10-05 00:06:47 +01004837}
4838
Dave Rodgmand9e80832023-10-04 17:17:46 +01004839component_build_sha_armce () {
Dave Rodgman5b89c552023-10-10 14:59:02 +01004840 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004841
4842
4843 # Test variations of SHA256 Armv8 crypto extensions
Dave Rodgman5b89c552023-10-10 14:59:02 +01004844 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004845 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, aarch64"
4846 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4847 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY clang, arm"
4848 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm"
4849 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004850
Dave Rodgmand9e80832023-10-04 17:17:46 +01004851
Dave Rodgman94a634d2023-10-10 12:59:29 +01004852 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004853 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004854 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY clang, thumb"
4855 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4856 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Dave Rodgmand9e80832023-10-04 17:17:46 +01004857
Dave Rodgman5b89c552023-10-10 14:59:02 +01004858 scripts/config.py set MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004859 msg "MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT clang, aarch64"
4860 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a"
4861 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgmand9e80832023-10-04 17:17:46 +01004862
Dave Rodgmancd654002023-10-05 09:40:07 +01004863
Dave Rodgman94a634d2023-10-10 12:59:29 +01004864 # test the deprecated form of the config option
Dave Rodgman94a634d2023-10-10 12:59:29 +01004865 scripts/config.py set MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004866 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, arm"
4867 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -std=c99"
4868 msg "MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT clang, thumb"
4869 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb"
4870 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01004871
Dave Rodgmancd654002023-10-05 09:40:07 +01004872
Dave Rodgmanf4b415c2023-10-11 16:11:42 +01004873 # examine the disassembly for presence of SHA instructions
4874 for opt in MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT; do
4875 scripts/config.py set ${opt}
4876 msg "${opt} clang, test A32 crypto instructions built"
4877 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4878 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4879
4880 msg "${opt} clang, test T32 crypto instructions built"
4881 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4882 grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4883
4884 msg "${opt} clang, test aarch64 crypto instructions built"
4885 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4886 grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
4887 scripts/config.py unset ${opt}
4888 done
4889
4890
4891 # examine the disassembly for absence of SHA instructions
4892 msg "clang, test A32 crypto instructions not built"
4893 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a72+crypto -marm -S"
4894 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4895
4896 msg "clang, test T32 crypto instructions not built"
4897 make -B library/sha256.o CC=clang CFLAGS="--target=arm-linux-gnueabihf -mcpu=cortex-a32+crypto -mthumb -S"
4898 not grep -E 'sha256[a-z0-9]+.32\s+[qv]' library/sha256.o
4899
4900 msg "clang, test aarch64 crypto instructions not built"
4901 make -B library/sha256.o CC=clang CFLAGS="--target=aarch64-linux-gnu -march=armv8-a -S"
4902 not grep -E 'sha256[a-z0-9]+\s+[qv]' library/sha256.o
Dave Rodgmand9e80832023-10-04 17:17:46 +01004903}
4904
Jerry Yuc935aa62023-08-03 17:08:27 +08004905# For timebeing, no VIA Padlock platform available.
4906component_build_aes_via_padlock () {
4907
4908 msg "AES:VIA PadLock, build with default configuration."
Jerry Yu506759f2023-08-16 17:11:22 +08004909 scripts/config.py unset MBEDTLS_AESNI_C
Jerry Yuc935aa62023-08-03 17:08:27 +08004910 scripts/config.py set MBEDTLS_PADLOCK_C
4911 scripts/config.py unset MBEDTLS_AES_USE_HARDWARE_ONLY
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00004912 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Jerry Yu506759f2023-08-16 17:11:22 +08004913 grep -q mbedtls_padlock_has_support ./programs/test/selftest
Jerry Yuc935aa62023-08-03 17:08:27 +08004914
4915}
4916
4917support_build_aes_via_padlock_only () {
4918 ( [ "$MBEDTLS_TEST_PLATFORM" == "Linux-x86_64" ] || \
4919 [ "$MBEDTLS_TEST_PLATFORM" == "Linux-amd64" ] ) && \
4920 [ "`dpkg --print-foreign-architectures`" == "i386" ]
4921}
4922
Jerry Yu193cbc02023-08-03 17:06:29 +08004923support_build_aes_aesce_armcc () {
4924 support_build_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +01004925}
4926
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004927component_test_aes_only_128_bit_keys () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004928 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH"
Hanno Becker83ebf782017-07-07 12:29:15 +01004929 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004930 scripts/config.py unset MBEDTLS_PADLOCK_C
4931
Dave Rodgmand8d64512023-12-19 12:20:21 +00004932 make CFLAGS='-O2 -Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01004933
4934 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH"
4935 make test
4936}
4937
4938component_test_no_ctr_drbg_aes_only_128_bit_keys () {
4939 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
4940 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01004941 scripts/config.py unset MBEDTLS_CTR_DRBG_C
4942 scripts/config.py unset MBEDTLS_PADLOCK_C
4943
Hanno Becker83ebf782017-07-07 12:29:15 +01004944 make CC=clang CFLAGS='-Werror -Wall -Wextra'
Gilles Peskine8f073122018-11-27 15:58:47 +01004945
4946 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - CTR_DRBG_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02004947 make test
4948}
Gilles Peskine8f073122018-11-27 15:58:47 +01004949
Hanno Becker83ebf782017-07-07 12:29:15 +01004950component_test_aes_only_128_bit_keys_have_builtins () {
Gilles Peskine8f073122018-11-27 15:58:47 +01004951 msg "build: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4952 scripts/config.py set MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
4953 scripts/config.py unset MBEDTLS_PADLOCK_C
4954 scripts/config.py unset MBEDTLS_AESNI_C
Gilles Peskine592f5912019-10-07 18:49:32 +02004955 scripts/config.py unset MBEDTLS_AESCE_C
4956
Dave Rodgmand8d64512023-12-19 12:20:21 +00004957 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine3b46cd32020-02-18 17:56:33 +01004958
4959 msg "test: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
Gilles Peskine592f5912019-10-07 18:49:32 +02004960 make test
4961
4962 msg "selftest: default config + AES_ONLY_128_BIT_KEY_LENGTH - AESNI_C - AESCE_C"
4963 programs/test/selftest
4964}
4965
Matthias Schulz0767fda2024-02-07 10:46:28 +01004966component_test_gcm_largetable () {
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004967 msg "build: default config + GCM_LARGE_TABLE - AESNI_C - AESCE_C"
4968 scripts/config.py set MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01004969 scripts/config.py unset MBEDTLS_PADLOCK_C
4970 scripts/config.py unset MBEDTLS_AESNI_C
4971 scripts/config.py unset MBEDTLS_AESCE_C
4972
4973 make CFLAGS='-O2 -Werror -Wall -Wextra'
4974
Matthias Schulza6ac0f12024-02-09 17:09:42 +01004975 msg "test: default config - GCM_LARGE_TABLE - AESNI_C - AESCE_C"
Matthias Schulz0767fda2024-02-07 10:46:28 +01004976 make test
4977}
4978
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02004979component_test_aes_fewer_tables () {
4980 msg "build: default config with AES_FEWER_TABLES enabled"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004981 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004982 make CFLAGS='-O2 -Werror -Wall -Wextra'
Gilles Peskine7ad603e2017-12-10 23:22:20 +01004983
Gilles Peskine7c652162017-12-11 00:01:40 +01004984 msg "test: AES_FEWER_TABLES"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004985 make test
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004986}
4987
4988component_test_aes_rom_tables () {
4989 msg "build: default config with AES_ROM_TABLES enabled"
4990 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00004991 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01004992
4993 msg "test: AES_ROM_TABLES"
4994 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00004995}
4996
Gilles Peskine14c3c062018-01-29 21:25:12 +01004997component_test_aes_fewer_tables_and_rom_tables () {
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01004998 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
4999 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
5000 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Dave Rodgmand8d64512023-12-19 12:20:21 +00005001 make CFLAGS='-O2 -Werror -Wall -Wextra'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005002
Gilles Peskine8f073122018-11-27 15:58:47 +01005003 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
5004 make test
5005}
5006
Yanray Wang49cd4b52023-11-10 11:58:37 +08005007# helper for common_block_cipher_no_decrypt() which:
5008# - enable/disable the list of config options passed from -s/-u respectively.
5009# - build
5010# - test for tests_suite_xxx
5011# - selftest
5012#
5013# Usage: helper_block_cipher_no_decrypt_build_test
5014# [-s set_opts] [-u unset_opts] [-c cflags] [-l ldflags] [option [...]]
5015# Options: -s set_opts the list of config options to enable
5016# -u unset_opts the list of config options to disable
5017# -c cflags the list of options passed to CFLAGS
5018# -l ldflags the list of options passed to LDFLAGS
5019helper_block_cipher_no_decrypt_build_test () {
5020 while [ $# -gt 0 ]; do
5021 case "$1" in
5022 -s)
5023 shift; local set_opts="$1";;
5024 -u)
5025 shift; local unset_opts="$1";;
5026 -c)
Yanray Wang07e663d2023-11-13 17:15:39 +08005027 shift; local cflags="-Werror -Wall -Wextra $1";;
Yanray Wang49cd4b52023-11-10 11:58:37 +08005028 -l)
5029 shift; local ldflags="$1";;
5030 esac
5031 shift
5032 done
5033 set_opts="${set_opts:-}"
5034 unset_opts="${unset_opts:-}"
5035 cflags="${cflags:-}"
5036 ldflags="${ldflags:-}"
5037
Yanray Wangb2d6e522023-11-13 16:57:47 +08005038 [ -n "$set_opts" ] && echo "Enabling: $set_opts" && scripts/config.py set-all $set_opts
5039 [ -n "$unset_opts" ] && echo "Disabling: $unset_opts" && scripts/config.py unset-all $unset_opts
Yanray Wang49cd4b52023-11-10 11:58:37 +08005040
5041 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5042 make clean
Dave Rodgmandfe5ce82023-12-19 11:47:18 +00005043 make CFLAGS="-O2 $cflags" LDFLAGS="$ldflags"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005044
5045 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5046 not grep mbedtls_aes_setkey_dec library/aes.o
5047 not grep mbedtls_aria_setkey_dec library/aria.o
5048 not grep mbedtls_camellia_setkey_dec library/camellia.o
5049 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5050 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005051 # Make sure we don't have mbedtls_aesni_inverse_key in AESNI
5052 not grep mbedtls_aesni_inverse_key library/aesni.o
Yanray Wang49cd4b52023-11-10 11:58:37 +08005053
5054 msg "test: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5055 make test
5056
5057 msg "selftest: default config + BLOCK_CIPHER_NO_DECRYPT${set_opts:+ + $set_opts}${unset_opts:+ - $unset_opts} with $cflags${ldflags:+, $ldflags}"
5058 programs/test/selftest
5059}
5060
5061# This is a common configuration function used in:
5062# - component_test_block_cipher_no_decrypt_aesni_legacy()
5063# - component_test_block_cipher_no_decrypt_aesni_use_psa()
5064# in order to test BLOCK_CIPHER_NO_DECRYPT with AESNI intrinsics,
5065# AESNI assembly and AES C implementation on x86_64 and with AESNI intrinsics
5066# on x86.
5067common_block_cipher_no_decrypt () {
5068 # test AESNI intrinsics
5069 helper_block_cipher_no_decrypt_build_test \
5070 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005071 -c "-mpclmul -msse2 -maes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005072
5073 # test AESNI assembly
5074 helper_block_cipher_no_decrypt_build_test \
5075 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005076 -c "-mno-pclmul -mno-sse2 -mno-aes"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005077
5078 # test AES C implementation
5079 helper_block_cipher_no_decrypt_build_test \
Yanray Wang07e663d2023-11-13 17:15:39 +08005080 -u "MBEDTLS_AESNI_C"
Yanray Wang49cd4b52023-11-10 11:58:37 +08005081
5082 # test AESNI intrinsics for i386 target
5083 helper_block_cipher_no_decrypt_build_test \
5084 -s "MBEDTLS_AESNI_C" \
Yanray Wang07e663d2023-11-13 17:15:39 +08005085 -c "-m32 -mpclmul -msse2 -maes" \
Yanray Wang49cd4b52023-11-10 11:58:37 +08005086 -l "-m32"
5087}
5088
Yanray Wang3ae11992023-11-13 17:32:09 +08005089# This is a configuration function used in component_test_block_cipher_no_decrypt_xxx:
5090# usage: 0: no PSA crypto configuration
5091# 1: use PSA crypto configuration
5092config_block_cipher_no_decrypt () {
5093 use_psa=$1
5094
Yanray Wang66111392023-10-31 18:54:54 +08005095 scripts/config.py set MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005096 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
5097 scripts/config.py unset MBEDTLS_CIPHER_MODE_XTS
Yanray Wang3caaf0c2023-09-07 17:50:14 +08005098 scripts/config.py unset MBEDTLS_DES_C
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005099 scripts/config.py unset MBEDTLS_NIST_KW_C
5100
Yanray Wang3ae11992023-11-13 17:32:09 +08005101 if [ "$use_psa" -eq 1 ]; then
5102 # Enable support for cryptographic mechanisms through the PSA API.
5103 # Note: XTS, KW are not yet supported via the PSA API in Mbed TLS.
5104 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5105 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_NO_PADDING
5106 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_CBC_PKCS7
5107 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_ALG_ECB_NO_PADDING
5108 scripts/config.py -f "$CRYPTO_CONFIG_H" unset PSA_WANT_KEY_TYPE_DES
5109 fi
5110}
5111
5112component_test_block_cipher_no_decrypt_aesni () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005113 # This consistently causes an llvm crash on clang 3.8, so use gcc
5114 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005115 config_block_cipher_no_decrypt 0
Yanray Wang49cd4b52023-11-10 11:58:37 +08005116 common_block_cipher_no_decrypt
Yanray Wanga8ac23a2023-05-15 18:03:10 +08005117}
5118
Yanray Wangf1496402023-11-01 18:55:13 +08005119component_test_block_cipher_no_decrypt_aesni_use_psa () {
Dave Rodgmanc3932222023-12-19 17:51:51 +00005120 # This consistently causes an llvm crash on clang 3.8, so use gcc
5121 export CC=gcc
Yanray Wang3ae11992023-11-13 17:32:09 +08005122 config_block_cipher_no_decrypt 1
Yanray Wang49cd4b52023-11-10 11:58:37 +08005123 common_block_cipher_no_decrypt
Yanray Wang78219042023-08-31 15:00:57 +08005124}
5125
Yanray Wang66111392023-10-31 18:54:54 +08005126support_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wang799bd842023-11-10 12:21:35 +08005127 support_build_armcc
Yanray Wangbf66ef92023-08-31 14:47:01 +08005128}
5129
Yanray Wang66111392023-10-31 18:54:54 +08005130component_test_block_cipher_no_decrypt_aesce_armcc () {
Yanray Wangbf66ef92023-08-31 14:47:01 +08005131 scripts/config.py baremetal
5132
5133 # armc[56] don't support SHA-512 intrinsics
5134 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
5135
5136 # Stop armclang warning about feature detection for A64_CRYPTO.
5137 # With this enabled, the library does build correctly under armclang,
5138 # but in baremetal builds (as tested here), feature detection is
5139 # unavailable, and the user is notified via a #warning. So enabling
5140 # this feature would prevent us from building with -Werror on
5141 # armclang. Tracked in #7198.
5142 scripts/config.py unset MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
5143 scripts/config.py set MBEDTLS_HAVE_ASM
5144
Yanray Wang3ae11992023-11-13 17:32:09 +08005145 config_block_cipher_no_decrypt 1
Yanray Wangbf66ef92023-08-31 14:47:01 +08005146
5147 # test AESCE baremetal build
5148 scripts/config.py set MBEDTLS_AESCE_C
Yanray Wang66111392023-10-31 18:54:54 +08005149 msg "build: default config + BLOCK_CIPHER_NO_DECRYPT with AESCE"
Yanray Wangc4347912023-11-14 10:10:49 +08005150 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8-a+crypto -Werror -Wall -Wextra"
Yanray Wangbf66ef92023-08-31 14:47:01 +08005151
Yanray Wangef1b04d2023-09-08 11:09:26 +08005152 # Make sure we don't have mbedtls_xxx_setkey_dec in AES/ARIA/CAMELLIA
5153 not grep mbedtls_aes_setkey_dec library/aes.o
5154 not grep mbedtls_aria_setkey_dec library/aria.o
5155 not grep mbedtls_camellia_setkey_dec library/camellia.o
5156 # Make sure we don't have mbedtls_internal_aes_decrypt in AES
5157 not grep mbedtls_internal_aes_decrypt library/aes.o
Yanray Wang85b74652023-11-13 16:48:36 +08005158 # Make sure we don't have mbedtls_aesce_inverse_key and aesce_decrypt_block in AESCE
Yanray Wang4cd1b162023-11-10 12:18:29 +08005159 not grep mbedtls_aesce_inverse_key library/aesce.o
5160 not grep aesce_decrypt_block library/aesce.o
Yanray Wangbf66ef92023-08-31 14:47:01 +08005161}
5162
Gilles Peskine592f5912019-10-07 18:49:32 +02005163component_test_ctr_drbg_aes_256_sha_256 () {
5164 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5165 scripts/config.py full
5166 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5167 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005168 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005169 make
5170
5171 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5172 make test
5173}
5174
5175component_test_ctr_drbg_aes_128_sha_512 () {
5176 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005177 scripts/config.py full
5178 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5179 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Dave Rodgman17127e92023-12-14 16:42:48 +00005180 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005181 make
5182
5183 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
5184 make test
5185}
5186
5187component_test_ctr_drbg_aes_128_sha_256 () {
5188 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01005189 scripts/config.py full
5190 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
5191 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
5192 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Dave Rodgman17127e92023-12-14 16:42:48 +00005193 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Gilles Peskine592f5912019-10-07 18:49:32 +02005194 make
5195
5196 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
5197 make test
5198}
5199
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005200component_test_se_default () {
5201 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005202 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02005203 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02005204
5205 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
5206 make test
5207}
5208
Steven Cooremand57203d2020-07-16 20:28:59 +02005209component_test_psa_crypto_drivers () {
Gilles Peskine1997f302023-07-26 18:45:20 +02005210 msg "build: full + test drivers dispatching to builtins"
Steven Cooreman753f9732021-03-15 11:38:44 +01005211 scripts/config.py full
Gilles Peskine1997f302023-07-26 18:45:20 +02005212 scripts/config.py unset MBEDTLS_PSA_CRYPTO_CONFIG
Gilles Peskine3587dfd2021-09-20 19:20:04 +02005213 loc_cflags="$ASAN_CFLAGS -DPSA_CRYPTO_DRIVER_TEST_ALL"
5214 loc_cflags="${loc_cflags} '-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-for-test.h\"'"
Ronald Cron17b3afc2020-12-10 18:17:09 +01005215 loc_cflags="${loc_cflags} -I../tests/include -O2"
5216
Gilles Peskine21570cf2023-12-22 11:49:50 +01005217 make CC=$ASAN_CC CFLAGS="${loc_cflags}" LDFLAGS="$ASAN_CFLAGS"
Steven Cooremand57203d2020-07-16 20:28:59 +02005218
Gilles Peskine1997f302023-07-26 18:45:20 +02005219 msg "test: full + test drivers dispatching to builtins"
Steven Cooremand57203d2020-07-16 20:28:59 +02005220 make test
5221}
5222
Gilles Peskine8f073122018-11-27 15:58:47 +01005223component_test_make_shared () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005224 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04005225 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02005226 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskineca144592021-11-04 12:52:14 +01005227 programs/test/dlopen_demo.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005228}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005229
Gilles Peskinecf740502019-07-03 20:43:05 +02005230component_test_cmake_shared () {
5231 msg "build/test: cmake shared" # ~ 2min
5232 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
5233 make
Gilles Peskine56c01612019-07-03 20:43:32 +02005234 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02005235 make test
Gilles Peskineca144592021-11-04 12:52:14 +01005236 programs/test/dlopen_demo.sh
Gilles Peskinecf740502019-07-03 20:43:05 +02005237}
5238
Gilles Peskineec10bf12019-09-20 19:56:06 +02005239test_build_opt () {
5240 info=$1 cc=$2; shift 2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005241 $cc --version
Gilles Peskineec10bf12019-09-20 19:56:06 +02005242 for opt in "$@"; do
5243 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine21570cf2023-12-22 11:49:50 +01005244 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskineec10bf12019-09-20 19:56:06 +02005245 # We're confident enough in compilers to not run _all_ the tests,
5246 # but at least run the unit tests. In particular, runs with
5247 # optimizations use inline assembly whereas runs with -O0
5248 # skip inline assembly.
5249 make test # ~30s
5250 make clean
5251 done
5252}
5253
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005254# For FreeBSD we invoke the function by name so this condition is added
5255# to disable the existing test_clang_opt function for linux.
5256if [[ $(uname) != "Linux" ]]; then
5257 component_test_clang_opt () {
5258 scripts/config.py full
5259 test_build_opt 'full config' clang -O0 -Os -O2
5260 }
5261fi
5262
5263component_test_clang_latest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005264 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005265 test_build_opt 'full config' "$CLANG_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005266}
5267support_test_clang_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005268 type "$CLANG_LATEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005269}
5270
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005271component_test_clang_earliest_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01005272 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005273 test_build_opt 'full config' "$CLANG_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005274}
5275support_test_clang_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005276 type "$CLANG_EARLIEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005277}
5278
5279component_test_gcc_latest_opt () {
5280 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005281 test_build_opt 'full config' "$GCC_LATEST" -O0 -Os -O2
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005282}
5283support_test_gcc_latest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005284 type "$GCC_LATEST" >/dev/null 2>/dev/null
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005285}
5286
5287component_test_gcc_earliest_opt () {
5288 scripts/config.py full
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005289 test_build_opt 'full config' "$GCC_EARLIEST" -O0
Gowtham Suresh Kumara12baf82023-07-19 08:39:20 +01005290}
5291support_test_gcc_earliest_opt () {
Gowtham Suresh Kumar6f1977b2023-07-28 17:04:47 +01005292 type "$GCC_EARLIEST" >/dev/null 2>/dev/null
Gilles Peskineec10bf12019-09-20 19:56:06 +02005293}
5294
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005295component_build_mbedtls_config_file () {
5296 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
Gilles Peskine2003c2f2022-04-07 20:55:57 +02005297 scripts/config.py -w full_config.h full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02005298 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
Gilles Peskine21570cf2023-12-22 11:49:50 +01005299 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005300 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskinee10df772022-04-07 21:06:41 +02005301 programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5302 make clean
5303
5304 msg "build: make with MBEDTLS_CONFIG_FILE + MBEDTLS_USER_CONFIG_FILE"
5305 # In the user config, disable one feature (for simplicity, pick a feature
5306 # that nothing else depends on).
5307 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
Gilles Peskine21570cf2023-12-22 11:49:50 +01005308 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"' -DMBEDTLS_USER_CONFIG_FILE='\"user_config.h\"'"
Gilles Peskinee10df772022-04-07 21:06:41 +02005309 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
5310
5311 rm -f user_config.h full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005312}
5313
Gilles Peskine7d904e72022-04-07 21:59:14 +02005314component_build_psa_config_file () {
5315 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE" # ~40s
5316 scripts/config.py set MBEDTLS_PSA_CRYPTO_CONFIG
5317 cp "$CRYPTO_CONFIG_H" psa_test_config.h
5318 echo '#error "MBEDTLS_PSA_CRYPTO_CONFIG_FILE is not working"' >"$CRYPTO_CONFIG_H"
5319 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"'"
Gilles Peskine45e680e2022-04-13 23:23:21 +02005320 # Make sure this feature is enabled. We'll disable it in the next phase.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005321 programs/test/query_compile_time_config MBEDTLS_CMAC_C
5322 make clean
5323
5324 msg "build: make with MBEDTLS_PSA_CRYPTO_CONFIG_FILE + MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE" # ~40s
Ronald Crona33a8242024-05-15 18:31:17 +02005325 # In the user config, disable one feature and its dependencies, which will
5326 # reflect on the mbedtls configuration so we can query it with
5327 # query_compile_time_config.
Gilles Peskine7d904e72022-04-07 21:59:14 +02005328 echo '#undef PSA_WANT_ALG_CMAC' >psa_user_config.h
Ronald Crona33a8242024-05-15 18:31:17 +02005329 echo '#undef PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128' >> psa_user_config.h
Gilles Peskine7d904e72022-04-07 21:59:14 +02005330 scripts/config.py unset MBEDTLS_CMAC_C
5331 make CFLAGS="-I '$PWD' -DMBEDTLS_PSA_CRYPTO_CONFIG_FILE='\"psa_test_config.h\"' -DMBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE='\"psa_user_config.h\"'"
5332 not programs/test/query_compile_time_config MBEDTLS_CMAC_C
5333
5334 rm -f psa_test_config.h psa_user_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005335}
5336
Gilles Peskinedf6e84a2023-02-22 22:09:51 +01005337component_build_psa_alt_headers () {
5338 msg "build: make with PSA alt headers" # ~20s
5339
5340 # Generate alternative versions of the substitutable headers with the
5341 # same content except different include guards.
5342 make -C tests include/alt-extra/psa/crypto_platform_alt.h include/alt-extra/psa/crypto_struct_alt.h
5343
5344 # Build the library and some programs.
5345 # Don't build the fuzzers to avoid having to go through hoops to set
5346 # a correct include path for programs/fuzz/Makefile.
5347 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
5348 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\"'"
5349
5350 # Check that we're getting the alternative include guards and not the
5351 # original include guards.
5352 programs/test/query_included_headers | grep -x PSA_CRYPTO_PLATFORM_ALT_H
5353 programs/test/query_included_headers | grep -x PSA_CRYPTO_STRUCT_ALT_H
5354 programs/test/query_included_headers | not grep -x PSA_CRYPTO_PLATFORM_H
5355 programs/test/query_included_headers | not grep -x PSA_CRYPTO_STRUCT_H
5356}
5357
Dave Rodgman852de3c2023-12-14 14:46:45 +00005358component_test_m32_no_asm () {
5359 # Build without assembly, so as to use portable C code (in a 32-bit
Gilles Peskine77f05352021-10-07 19:27:16 +02005360 # build) and not the i386-specific inline assembly.
Dave Rodgmana2cf2402023-12-15 11:04:13 +00005361 #
5362 # Note that we require gcc, because clang Asan builds fail to link for
5363 # this target (cannot find libclang_rt.lsan-i386.a - this is a known clang issue).
Dave Rodgman852de3c2023-12-14 14:46:45 +00005364 msg "build: i386, make, gcc, no asm (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005365 scripts/config.py full
Dave Rodgman852de3c2023-12-14 14:46:45 +00005366 scripts/config.py unset MBEDTLS_HAVE_ASM
5367 scripts/config.py unset MBEDTLS_PADLOCK_C
Pengyu Lv13226132023-10-16 14:03:29 +08005368 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005369 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005370
Dave Rodgman852de3c2023-12-14 14:46:45 +00005371 msg "test: i386, make, gcc, no asm (ASan build)"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005372 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005373}
Dave Rodgman852de3c2023-12-14 14:46:45 +00005374support_test_m32_no_asm () {
Gilles Peskine878cf602019-01-06 20:50:38 +00005375 case $(uname -m) in
Pengyu Lvc92df3b2022-10-21 10:50:26 +00005376 amd64|x86_64) true;;
Gilles Peskine878cf602019-01-06 20:50:38 +00005377 *) false;;
5378 esac
5379}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005380
Gilles Peskineff0aee02021-10-05 09:36:03 +02005381component_test_m32_o2 () {
5382 # Build with optimization, to use the i386 specific inline assembly
5383 # and go faster for tests.
5384 msg "build: i386, make, gcc -O2 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005385 scripts/config.py full
Pengyu Lv13226132023-10-16 14:03:29 +08005386 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Gilles Peskine21570cf2023-12-22 11:49:50 +01005387 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01005388
Gilles Peskineff0aee02021-10-05 09:36:03 +02005389 msg "test: i386, make, gcc -O2 (ASan build)"
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005390 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005391
Gilles Peskineff0aee02021-10-05 09:36:03 +02005392 msg "test ssl-opt.sh, i386, make, gcc-O2"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005393 tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01005394}
Gilles Peskinecf522222021-10-07 19:25:29 +02005395support_test_m32_o2 () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005396 support_test_m32_no_asm "$@"
Gilles Peskine878cf602019-01-06 20:50:38 +00005397}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005398
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005399component_test_m32_everest () {
5400 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005401 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Pengyu Lv13226132023-10-16 14:03:29 +08005402 scripts/config.py unset MBEDTLS_AESNI_C # AESNI for 32-bit is tested in test_aesni_m32
Dave Rodgmanb90f87b2023-12-14 23:27:33 +00005403 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005404
5405 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
5406 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01005407
5408 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005409 tests/ssl-opt.sh -f ECDH
Gilles Peskine636c26a2020-03-04 20:46:15 +01005410
5411 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
5412 # Exclude some symmetric ciphers that are redundant here to gain time.
Manuel Pégourié-Gonnard296787f2022-04-06 13:28:27 +02005413 tests/compat.sh -f ECDH -V NO -e 'ARIA\|CAMELLIA\|CHACHA'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005414}
5415support_test_m32_everest () {
Dave Rodgman852de3c2023-12-14 14:46:45 +00005416 support_test_m32_no_asm "$@"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02005417}
5418
Gilles Peskine8f073122018-11-27 15:58:47 +01005419component_test_mx32 () {
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005420 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005421 scripts/config.py full
Dave Rodgman84125a12024-01-02 11:42:38 +00005422 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005423
5424 msg "test: 64-bit ILP32, make, gcc"
5425 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01005426}
Gilles Peskine878cf602019-01-06 20:50:38 +00005427support_test_mx32 () {
5428 case $(uname -m) in
5429 amd64|x86_64) true;;
5430 *) false;;
5431 esac
5432}
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005433
Peter Kolbus60c6da22018-12-27 06:59:04 -06005434component_test_min_mpi_window_size () {
5435 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005436 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Dave Rodgman17127e92023-12-14 16:42:48 +00005437 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Peter Kolbus60c6da22018-12-27 06:59:04 -06005438 make
5439
5440 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
5441 make test
5442}
5443
Gilles Peskine8f073122018-11-27 15:58:47 +01005444component_test_have_int32 () {
5445 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005446 scripts/config.py unset MBEDTLS_HAVE_ASM
5447 scripts/config.py unset MBEDTLS_AESNI_C
5448 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005449 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005450 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01005451
Gilles Peskine8f073122018-11-27 15:58:47 +01005452 msg "test: gcc, force 32-bit bignum limbs"
5453 make test
5454}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01005455
Gilles Peskine8f073122018-11-27 15:58:47 +01005456component_test_have_int64 () {
5457 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005458 scripts/config.py unset MBEDTLS_HAVE_ASM
5459 scripts/config.py unset MBEDTLS_AESNI_C
5460 scripts/config.py unset MBEDTLS_PADLOCK_C
Jerry Yue51eddc2023-01-11 14:16:08 +08005461 scripts/config.py unset MBEDTLS_AESCE_C
Dave Rodgmand8d64512023-12-19 12:20:21 +00005462 make CC=gcc CFLAGS='-O2 -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01005463
Gilles Peskine8f073122018-11-27 15:58:47 +01005464 msg "test: gcc, force 64-bit bignum limbs"
5465 make test
5466}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00005467
Gabor Mezeie256cc12023-07-26 17:28:48 +02005468component_test_have_int32_cmake_new_bignum () {
5469 msg "build: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5470 scripts/config.py unset MBEDTLS_HAVE_ASM
5471 scripts/config.py unset MBEDTLS_AESNI_C
5472 scripts/config.py unset MBEDTLS_PADLOCK_C
5473 scripts/config.py unset MBEDTLS_AESCE_C
5474 scripts/config.py set MBEDTLS_TEST_HOOKS
Janos Follath2f045822023-07-31 10:57:16 +01005475 scripts/config.py set MBEDTLS_ECP_WITH_MPI_UINT
Janos Follathf3135af2023-07-31 10:07:57 +01005476 make CC=gcc CFLAGS="$ASAN_CFLAGS -Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32" LDFLAGS="$ASAN_CFLAGS"
Gabor Mezeie256cc12023-07-26 17:28:48 +02005477
5478 msg "test: gcc, force 32-bit bignum limbs, new bignum interface, test hooks (ASan build)"
5479 make test
5480}
5481
Gilles Peskine8f073122018-11-27 15:58:47 +01005482component_test_no_udbl_division () {
5483 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005484 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005485 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005486 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005487
Gilles Peskine8f073122018-11-27 15:58:47 +01005488 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
5489 make test
5490}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005491
Gilles Peskine8f073122018-11-27 15:58:47 +01005492component_test_no_64bit_multiplication () {
5493 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005494 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02005495 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine21570cf2023-12-22 11:49:50 +01005496 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005497
Gilles Peskine8f073122018-11-27 15:58:47 +01005498 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
5499 make test
5500}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005501
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005502component_test_no_strings () {
5503 msg "build: no strings" # ~10s
5504 scripts/config.py full
5505 # Disable options that activate a large amount of string constants.
5506 scripts/config.py unset MBEDTLS_DEBUG_C
5507 scripts/config.py unset MBEDTLS_ERROR_C
5508 scripts/config.py set MBEDTLS_ERROR_STRERROR_DUMMY
5509 scripts/config.py unset MBEDTLS_VERSION_FEATURES
Gilles Peskine21570cf2023-12-22 11:49:50 +01005510 make CFLAGS='-Werror -Os'
Gilles Peskine3809f5f2020-11-09 15:40:05 +01005511
5512 msg "test: no strings" # ~ 10s
5513 make test
5514}
5515
Hanno Beckerc5722d12020-10-09 11:10:42 +01005516component_test_no_x509_info () {
5517 msg "build: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5518 scripts/config.pl full
5519 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
5520 scripts/config.pl set MBEDTLS_X509_REMOVE_INFO
Gilles Peskine21570cf2023-12-22 11:49:50 +01005521 make CFLAGS='-Werror -O2'
Hanno Beckerc5722d12020-10-09 11:10:42 +01005522
5523 msg "test: full + MBEDTLS_X509_REMOVE_INFO" # ~ 10s
5524 make test
5525
5526 msg "test: ssl-opt.sh, full + MBEDTLS_X509_REMOVE_INFO" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005527 tests/ssl-opt.sh
Hanno Beckerc5722d12020-10-09 11:10:42 +01005528}
5529
Gilles Peskine8f073122018-11-27 15:58:47 +01005530component_build_arm_none_eabi_gcc () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005531 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005532 scripts/config.py baremetal
Gilles Peskineaeedd742020-09-02 11:03:04 +02005533 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 +02005534
Gilles Peskinee36fe812021-09-01 20:00:33 +02005535 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005536 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005537}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005538
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005539component_build_arm_linux_gnueabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005540 msg "build: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005541 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02005542 # Build for a target platform that's close to what Debian uses
5543 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
Dave Rodgman017a1992022-03-31 14:07:01 +01005544 # See https://github.com/Mbed-TLS/mbedtls/pull/2169 and comments.
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005545 # Build everything including programs, see for example
Dave Rodgman017a1992022-03-31 14:07:01 +01005546 # https://github.com/Mbed-TLS/mbedtls/pull/3449#issuecomment-675313720
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005547 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'
5548
Gilles Peskinee36fe812021-09-01 20:00:33 +02005549 msg "size: ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005550 ${ARM_LINUX_GNUEABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005551}
5552support_build_arm_linux_gnueabi_gcc_arm5vte () {
5553 type ${ARM_LINUX_GNUEABI_GCC_PREFIX}gcc >/dev/null 2>&1
5554}
5555
5556component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005557 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, baremetal+debug" # ~ 10s
Manuel Pégourié-Gonnard3a6c7692020-08-18 10:28:51 +02005558 scripts/config.py baremetal
5559 # This is an imperfect substitute for
5560 # component_build_arm_linux_gnueabi_gcc_arm5vte
Manuel Pégourié-Gonnardae505ee2021-07-06 09:44:59 +02005561 # in case the gcc-arm-linux-gnueabi toolchain is not available
Gilles Peskineaeedd742020-09-02 11:03:04 +02005562 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 +02005563
Gilles Peskinee36fe812021-09-01 20:00:33 +02005564 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1, baremetal+debug"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005565 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Gilles Peskine93e4e032019-08-05 11:34:25 +02005566}
5567
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005568component_build_arm_none_eabi_gcc_m0plus () {
Gilles Peskinee36fe812021-09-01 20:00:33 +02005569 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus, baremetal_size" # ~ 10s
5570 scripts/config.py baremetal_size
Gilles Peskineaeedd742020-09-02 11:03:04 +02005571 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 +02005572
Gilles Peskinee36fe812021-09-01 20:00:33 +02005573 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os, baremetal_size"
Manuel Pégourié-Gonnarda14b8f02023-03-28 12:49:39 +02005574 ${ARM_NONE_EABI_GCC_PREFIX}size -t library/*.o
Manuel Pégourié-Gonnard67f80372023-06-06 13:01:18 +02005575 for lib in library/*.a; do
5576 echo "$lib:"
5577 ${ARM_NONE_EABI_GCC_PREFIX}size -t $lib | grep TOTALS
5578 done
Gilles Peskine6e2fb862020-04-30 23:00:53 +02005579}
5580
Gilles Peskine8f073122018-11-27 15:58:47 +01005581component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005582 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005583 scripts/config.py baremetal
5584 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005585 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 +01005586 echo "Checking that software 64-bit division is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005587 not grep __aeabi_uldiv library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005588}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005589
Gilles Peskine8f073122018-11-27 15:58:47 +01005590component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02005591 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005592 scripts/config.py baremetal
5593 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskineaeedd742020-09-02 11:03:04 +02005594 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 +01005595 echo "Checking that software 64-bit multiplication is not required"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005596 not grep __aeabi_lmul library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01005597}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02005598
Dave Rodgman8c315f22023-06-02 10:26:24 -04005599component_build_arm_clang_thumb () {
5600 # ~ 30s
5601
5602 scripts/config.py baremetal
5603
5604 msg "build: clang thumb 2, make"
5605 make clean
5606 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -march=armv7-m -mthumb' lib
5607
5608 # Some Thumb 1 asm is sensitive to optimisation level, so test both -O0 and -Os
5609 msg "build: clang thumb 1 -O0, make"
5610 make clean
5611 make CC="clang" CFLAGS='-std=c99 -Werror -O0 --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5612
5613 msg "build: clang thumb 1 -Os, make"
5614 make clean
5615 make CC="clang" CFLAGS='-std=c99 -Werror -Os --target=arm-linux-gnueabihf -mcpu=arm1136j-s -mthumb' lib
5616}
5617
Gilles Peskine8f073122018-11-27 15:58:47 +01005618component_build_armcc () {
Gilles Peskine18487f62020-04-30 23:11:54 +02005619 msg "build: ARM Compiler 5"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005620 scripts/config.py baremetal
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005621 # armc[56] don't support SHA-512 intrinsics
5622 scripts/config.py unset MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005623
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005624 # older versions of armcc/armclang don't support AESCE_C on 32-bit Arm
5625 scripts/config.py unset MBEDTLS_AESCE_C
5626
Dave Rodgman0fddf822023-03-02 15:32:12 +00005627 # Stop armclang warning about feature detection for A64_CRYPTO.
5628 # With this enabled, the library does build correctly under armclang,
5629 # but in baremetal builds (as tested here), feature detection is
5630 # unavailable, and the user is notified via a #warning. So enabling
5631 # this feature would prevent us from building with -Werror on
5632 # armclang. Tracked in #7198.
Dave Rodgman5b89c552023-10-10 14:59:02 +01005633 scripts/config.py unset MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman2f386c52023-03-02 13:38:33 +00005634
Hanno Beckerf0762e92022-07-15 12:08:19 +01005635 scripts/config.py set MBEDTLS_HAVE_ASM
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00005636
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005637 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskine18487f62020-04-30 23:11:54 +02005638
5639 msg "size: ARM Compiler 5"
5640 "$ARMC5_FROMELF" -z library/*.o
5641
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005642 # Compile mostly with -O1 since some Arm inline assembly is disabled for -O0.
Hanno Beckerf0762e92022-07-15 12:08:19 +01005643
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005644 # ARM Compiler 6 - Target ARMv7-A
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005645 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005646
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005647 # ARM Compiler 6 - Target ARMv7-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005648 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m"
5649
5650 # ARM Compiler 6 - Target ARMv7-M+DSP
5651 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv7-m+dsp"
Simon Butcher940737f2017-07-23 13:42:36 +02005652
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005653 # ARM Compiler 6 - Target ARMv8-A - AArch32
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005654 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02005655
Gilles Peskinebca6ab92017-12-19 18:24:31 +01005656 # ARM Compiler 6 - Target ARMv8-M
Dave Rodgman03f7a6e2022-08-17 14:35:29 +01005657 armc6_build_test "-O1 --target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02005658
Dave Rodgmanb45d58b2023-06-02 13:54:00 -04005659 # ARM Compiler 6 - Target Cortex-M0 - no optimisation
5660 armc6_build_test "-O0 --target=arm-arm-none-eabi -mcpu=cortex-m0"
5661
Dave Rodgman99318e62023-05-24 12:27:42 +01005662 # ARM Compiler 6 - Target Cortex-M0
5663 armc6_build_test "-Os --target=arm-arm-none-eabi -mcpu=cortex-m0"
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01005664
5665 # ARM Compiler 6 - Target ARMv8.2-A - AArch64
5666 #
5667 # Re-enable MBEDTLS_AESCE_C as this should be supported by the version of armclang
5668 # that we have in our CI
5669 scripts/config.py set MBEDTLS_AESCE_C
5670 armc6_build_test "-O1 --target=aarch64-arm-none-eabi -march=armv8.2-a+crypto"
Gilles Peskine8f073122018-11-27 15:58:47 +01005671}
Tom Cosgrove6ec39ca2023-06-09 15:34:31 +01005672
Pengyu Lvdf070032023-02-24 16:03:31 +08005673support_build_armcc () {
Pengyu Lvc6298ad2023-03-01 10:31:29 +08005674 armc5_cc="$ARMC5_BIN_DIR/armcc"
5675 armc6_cc="$ARMC6_BIN_DIR/armclang"
5676 (check_tools "$armc5_cc" "$armc6_cc" > /dev/null 2>&1)
Pengyu Lvdf070032023-02-24 16:03:31 +08005677}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01005678
Ronald Crond2cb7f42024-03-18 12:49:18 +01005679component_test_tls12_only () {
5680 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_3, cmake, gcc, ASan"
5681 scripts/config.py unset MBEDTLS_SSL_PROTO_TLS1_3
5682 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5683 make
5684
5685 msg "test: main suites (inc. selftests) (ASan build)"
5686 make test
5687
5688 msg "test: ssl-opt.sh (ASan build)"
5689 tests/ssl-opt.sh
5690
5691 msg "test: compat.sh (ASan build)"
5692 tests/compat.sh
5693}
5694
Jerry Yu81d5e1f2022-01-27 13:01:01 +08005695component_test_tls13_only () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005696 msg "build: default config without MBEDTLS_SSL_PROTO_TLS1_2"
Ronald Cronc2e110f2022-11-22 09:01:46 +01005697 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Waleed Elmelegye8402632024-01-09 17:21:20 +00005698 scripts/config.py set MBEDTLS_SSL_RECORD_SIZE_LIMIT
Jerry Yuda5af222021-12-24 18:45:45 +08005699 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5700
Gilles Peskine4bb369c2022-10-29 17:44:19 +02005701 msg "test: TLS 1.3 only, all key exchange modes enabled"
5702 make test
Jerry Yubaa49342022-02-15 10:26:40 +08005703
Ronald Cronc3f43b62022-10-17 17:35:32 +02005704 msg "ssl-opt.sh: TLS 1.3 only, all key exchange modes enabled"
5705 tests/ssl-opt.sh
Jerry Yuda5af222021-12-24 18:45:45 +08005706}
5707
Ronald Cronc3f43b62022-10-17 17:35:32 +02005708component_test_tls13_only_psk () {
5709 msg "build: TLS 1.3 only from default, only PSK key exchange mode"
5710 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5711 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5712 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiel0c231472023-06-14 11:12:45 +02005713 scripts/config.py unset MBEDTLS_DHM_C
Ronald Cronc3f43b62022-10-17 17:35:32 +02005714 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5715 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5716 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5717 scripts/config.py unset MBEDTLS_ECDSA_C
5718 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005719 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005720 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Crone3dac4a2022-06-10 17:21:51 +02005721 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5722
Ronald Cronc3f43b62022-10-17 17:35:32 +02005723 msg "test_suite_ssl: TLS 1.3 only, only PSK key exchange mode enabled"
5724 cd tests; ./test_suite_ssl; cd ..
Ronald Crone3dac4a2022-06-10 17:21:51 +02005725
Ronald Cronc3f43b62022-10-17 17:35:32 +02005726 msg "ssl-opt.sh: TLS 1.3 only, only PSK key exchange mode enabled"
5727 tests/ssl-opt.sh
5728}
5729
5730component_test_tls13_only_ephemeral () {
5731 msg "build: TLS 1.3 only from default, only ephemeral key exchange mode"
5732 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5733 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian2dbfeda2022-11-15 10:52:57 +00005734 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005735 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5736
5737 msg "test_suite_ssl: TLS 1.3 only, only ephemeral key exchange mode"
5738 cd tests; ./test_suite_ssl; cd ..
5739
5740 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral key exchange mode"
5741 tests/ssl-opt.sh
5742}
5743
Przemek Stekiela01c2422023-06-13 10:46:48 +02005744component_test_tls13_only_ephemeral_ffdh () {
5745 msg "build: TLS 1.3 only from default, only ephemeral ffdh key exchange mode"
5746 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5747 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
5748 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005749 scripts/config.py unset MBEDTLS_ECDH_C
5750
Przemek Stekiela01c2422023-06-13 10:46:48 +02005751 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5752
5753 msg "test_suite_ssl: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5754 cd tests; ./test_suite_ssl; cd ..
5755
5756 msg "ssl-opt.sh: TLS 1.3 only, only ephemeral ffdh key exchange mode"
5757 tests/ssl-opt.sh
5758}
5759
Ronald Cronc3f43b62022-10-17 17:35:32 +02005760component_test_tls13_only_psk_ephemeral () {
5761 msg "build: TLS 1.3 only from default, only PSK ephemeral key exchange mode"
5762 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5763 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5764 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5765 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5766 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5767 scripts/config.py unset MBEDTLS_ECDSA_C
5768 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005769 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005770 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005771 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5772
5773 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral key exchange mode"
5774 cd tests; ./test_suite_ssl; cd ..
5775
5776 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral key exchange mode"
5777 tests/ssl-opt.sh
5778}
5779
Przemek Stekiela01c2422023-06-13 10:46:48 +02005780component_test_tls13_only_psk_ephemeral_ffdh () {
5781 msg "build: TLS 1.3 only from default, only PSK ephemeral ffdh key exchange mode"
5782 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
5783 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5784 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5785 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5786 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5787 scripts/config.py unset MBEDTLS_ECDSA_C
5788 scripts/config.py unset MBEDTLS_PKCS1_V21
5789 scripts/config.py unset MBEDTLS_PKCS7_C
5790 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Przemek Stekielce05f542023-06-15 16:44:08 +02005791 scripts/config.py unset MBEDTLS_ECDH_C
Przemek Stekiela01c2422023-06-13 10:46:48 +02005792 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5793
5794 msg "test_suite_ssl: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5795 cd tests; ./test_suite_ssl; cd ..
5796
5797 msg "ssl-opt.sh: TLS 1.3 only, only PSK ephemeral ffdh key exchange mode"
5798 tests/ssl-opt.sh
5799}
5800
Ronald Cronc3f43b62022-10-17 17:35:32 +02005801component_test_tls13_only_psk_all () {
5802 msg "build: TLS 1.3 only from default, without ephemeral key exchange mode"
5803 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
5804 scripts/config.py unset MBEDTLS_X509_CRT_PARSE_C
5805 scripts/config.py unset MBEDTLS_X509_RSASSA_PSS_SUPPORT
5806 scripts/config.py unset MBEDTLS_SSL_SERVER_NAME_INDICATION
5807 scripts/config.py unset MBEDTLS_ECDSA_C
5808 scripts/config.py unset MBEDTLS_PKCS1_V21
Dave Rodgman71565cf2022-11-11 10:37:38 +00005809 scripts/config.py unset MBEDTLS_PKCS7_C
Ronald Cronc2e110f2022-11-22 09:01:46 +01005810 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005811 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5812
5813 msg "test_suite_ssl: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5814 cd tests; ./test_suite_ssl; cd ..
5815
5816 msg "ssl-opt.sh: TLS 1.3 only, PSK and PSK ephemeral key exchange modes"
5817 tests/ssl-opt.sh
5818}
5819
5820component_test_tls13_only_ephemeral_all () {
5821 msg "build: TLS 1.3 only from default, without PSK key exchange mode"
5822 scripts/config.py unset MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
Ronald Cronc2e110f2022-11-22 09:01:46 +01005823 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Ronald Cronc3f43b62022-10-17 17:35:32 +02005824 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/tls13-only.h\"'"
5825
5826 msg "test_suite_ssl: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5827 cd tests; ./test_suite_ssl; cd ..
5828
5829 msg "ssl-opt.sh: TLS 1.3 only, ephemeral and PSK ephemeral key exchange modes"
5830 tests/ssl-opt.sh
Ronald Crone3dac4a2022-06-10 17:21:51 +02005831}
5832
Ronald Cron46ac0652024-03-18 12:39:04 +01005833component_test_tls13_no_padding () {
5834 msg "build: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005835 scripts/config.py set MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 1
Ronald Cronc2e110f2022-11-22 09:01:46 +01005836 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005837 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005838 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005839 msg "test: default config plus early data minus padding"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005840 make test
Ronald Cron46ac0652024-03-18 12:39:04 +01005841 msg "ssl-opt.sh (TLS 1.3 no padding)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005842 tests/ssl-opt.sh
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005843}
5844
Ronald Cron6f135e12021-12-08 16:57:54 +01005845component_test_tls13_no_compatibility_mode () {
Ronald Cron46ac0652024-03-18 12:39:04 +01005846 msg "build: default config plus early data minus middlebox compatibility mode"
Ronald Cronfdb0e3f2021-12-09 10:39:19 +01005847 scripts/config.py unset MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronc2e110f2022-11-22 09:01:46 +01005848 scripts/config.py set MBEDTLS_SSL_EARLY_DATA
Dave Rodgman17127e92023-12-14 16:42:48 +00005849 CC=$ASAN_CC cmake -D CMAKE_BUILD_TYPE:String=Asan .
Hanno Beckera711f6e2020-05-04 12:03:51 +01005850 make
Ronald Cron46ac0652024-03-18 12:39:04 +01005851 msg "test: default config plus early data minus middlebox compatibility mode"
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005852 make test
Ronald Cron6f135e12021-12-08 16:57:54 +01005853 msg "ssl-opt.sh (TLS 1.3 no compatibility mode)"
Gilles Peskine827dbd92022-02-04 00:30:54 +01005854 tests/ssl-opt.sh
Hanno Becker6c53ecc2021-08-01 19:20:10 +01005855}
5856
Ronald Crondd96c0a2024-04-02 12:34:24 +02005857component_test_full_minus_session_tickets() {
5858 msg "build: full config without session tickets"
5859 scripts/config.py full
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005860 scripts/config.py unset MBEDTLS_SSL_SESSION_TICKETS
Ronald Crondd96c0a2024-04-02 12:34:24 +02005861 scripts/config.py unset MBEDTLS_SSL_EARLY_DATA
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005862 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
5863 make
Ronald Crondd96c0a2024-04-02 12:34:24 +02005864 msg "test: full config without session tickets"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005865 make test
Ronald Crondd96c0a2024-04-02 12:34:24 +02005866 msg "ssl-opt.sh (full config without session tickets)"
Norbert Fabritiusd30e9112023-04-11 15:40:05 +02005867 tests/ssl-opt.sh
5868}
5869
Gilles Peskine8f073122018-11-27 15:58:47 +01005870component_build_mingw () {
5871 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005872 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 +00005873
Gilles Peskine8f073122018-11-27 15:58:47 +01005874 # note Make tests only builds the tests, but doesn't run them
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005875 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -maes -msse2 -mpclmul' WINDOWS_BUILD=1 tests
Gilles Peskine8f073122018-11-27 15:58:47 +01005876 make WINDOWS_BUILD=1 clean
Gilles Peskine2a458da2017-05-12 15:26:58 +02005877
Gilles Peskine8f073122018-11-27 15:58:47 +01005878 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Pengyu Lv64cca2f2023-10-10 18:22:24 +08005879 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
5880 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 +01005881 make WINDOWS_BUILD=1 clean
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005882
Pengyu Lv158eead2023-10-19 11:27:05 +08005883 msg "build: Windows cross build - mingw64, make (Library only, default config without MBEDTLS_AESNI_C)" # ~ 30s
Pengyu Lvbb4f63c2023-10-19 10:38:58 +08005884 ./scripts/config.py unset MBEDTLS_AESNI_C #
Pengyu Lv158eead2023-10-19 11:27:05 +08005885 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 +01005886 make WINDOWS_BUILD=1 clean
5887}
Jaeden Amero117b8a42019-04-17 15:19:26 +01005888support_build_mingw() {
Pengyu Lv51b5f002023-02-24 15:38:52 +08005889 case $(i686-w64-mingw32-gcc -dumpversion 2>/dev/null) in
5890 [0-5]*|"") false;;
Jaeden Amero117b8a42019-04-17 15:19:26 +01005891 *) true;;
5892 esac
5893}
Simon Butcher91aef332016-11-17 09:20:50 +00005894
Gilles Peskine8f073122018-11-27 15:58:47 +01005895component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005896 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02005897 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005898 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
5899 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02005900
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005901 msg "test: main suites (MSan)" # ~ 10s
5902 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005903
Gilles Peskine6848d172023-11-02 19:58:03 +01005904 msg "test: metatests (MSan)"
5905 tests/scripts/run-metatests.sh any msan
5906
Gilles Peskine82b27272019-06-14 18:27:03 +02005907 msg "program demos (MSan)" # ~20s
5908 tests/scripts/run_demos.py
5909
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005910 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005911 tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005912
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005913 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01005914
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005915 if [ "$MEMORY" -gt 0 ]; then
5916 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005917 tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005918 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005919}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01005920
Bence Szépkúti0354d042023-12-06 16:14:37 +01005921component_release_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005922 msg "build: Release (clang)"
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005923 # default config, in particular without MBEDTLS_USE_PSA_CRYPTO
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005924 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5925 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005926
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005927 msg "test: main suites, Valgrind (default config)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005928 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005929
Gilles Peskine636c26a2020-03-04 20:46:15 +01005930 # Optional parts (slow; currently broken on OS X because programs don't
5931 # seem to receive signals under valgrind on OS X).
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005932 # These optional parts don't run on the CI.
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005933 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005934 msg "test: ssl-opt.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005935 tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005936 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005937
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005938 if [ "$MEMORY" -gt 1 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005939 msg "test: compat.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005940 tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01005941 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005942
5943 if [ "$MEMORY" -gt 0 ]; then
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005944 msg "test: context-info.sh --memcheck (default config)"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02005945 tests/context-info.sh --memcheck
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02005946 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01005947}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00005948
Bence Szépkúti0354d042023-12-06 16:14:37 +01005949component_release_test_valgrind_psa () {
Gilles Peskinedf3dd4c2022-11-29 16:45:30 +01005950 msg "build: Release, full (clang)"
5951 # full config, in particular with MBEDTLS_USE_PSA_CRYPTO
5952 scripts/config.py full
5953 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
5954 make
5955
5956 msg "test: main suites, Valgrind (full config)"
5957 make memcheck
5958}
5959
Paul Elliott62dc3922021-11-25 17:29:40 +00005960support_test_cmake_out_of_source () {
5961 distrib_id=""
5962 distrib_ver=""
5963 distrib_ver_minor=""
5964 distrib_ver_major=""
5965
5966 # Attempt to parse lsb-release to find out distribution and version. If not
5967 # found this should fail safe (test is supported).
5968 if [[ -f /etc/lsb-release ]]; then
5969
5970 while read -r lsb_line; do
5971 case "$lsb_line" in
5972 "DISTRIB_ID"*) distrib_id=${lsb_line/#DISTRIB_ID=};;
5973 "DISTRIB_RELEASE"*) distrib_ver=${lsb_line/#DISTRIB_RELEASE=};;
5974 esac
5975 done < /etc/lsb-release
5976
5977 distrib_ver_major="${distrib_ver%%.*}"
5978 distrib_ver="${distrib_ver#*.}"
5979 distrib_ver_minor="${distrib_ver%%.*}"
5980 fi
5981
5982 # Running the out of source CMake test on Ubuntu 16.04 using more than one
5983 # processor (as the CI does) can create a race condition whereby the build
5984 # fails to see a generated file, despite that file actually having been
5985 # generated. This problem appears to go away with 18.04 or newer, so make
5986 # the out of source tests unsupported on Ubuntu 16.04.
5987 [ "$distrib_id" != "Ubuntu" ] || [ "$distrib_ver_major" -gt 16 ]
5988}
5989
Gilles Peskine8f073122018-11-27 15:58:47 +01005990component_test_cmake_out_of_source () {
David Horstmann862abe22023-09-28 10:42:10 +01005991 # Remove existing generated files so that we use the ones cmake
David Horstmann9f48fff2023-09-27 15:53:54 +01005992 # generates
5993 make neat
5994
Gilles Peskine8f073122018-11-27 15:58:47 +01005995 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01005996 MBEDTLS_ROOT_DIR="$PWD"
5997 mkdir "$OUT_OF_SOURCE_DIR"
5998 cd "$OUT_OF_SOURCE_DIR"
David Horstmann9f48fff2023-09-27 15:53:54 +01005999 # Note: Explicitly generate files as these are turned off in releases
6000 cmake -D CMAKE_BUILD_TYPE:String=Check -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006001 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00006002
Gilles Peskine8f073122018-11-27 15:58:47 +01006003 msg "test: cmake 'out-of-source' build"
6004 make test
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006005 # Check that ssl-opt.sh can find the test programs.
Gilles Peskine8f073122018-11-27 15:58:47 +01006006 # Also ensure that there are no error messages such as
6007 # "No such file or directory", which would indicate that some required
6008 # file is missing (ssl-opt.sh tolerates the absence of some files so
6009 # may exit with status 0 but emit errors).
Gilles Peskinea841c2a2022-04-16 11:31:25 +02006010 ./tests/ssl-opt.sh -f 'Default' >ssl-opt.out 2>ssl-opt.err
Gilles Peskine7393ec52022-04-15 22:43:38 +02006011 grep PASS ssl-opt.out
Gilles Peskinef7e956c2020-03-28 18:56:09 +01006012 cat ssl-opt.err >&2
6013 # If ssl-opt.err is non-empty, record an error and keep going.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006014 [ ! -s ssl-opt.err ]
Gilles Peskine7393ec52022-04-15 22:43:38 +02006015 rm ssl-opt.out ssl-opt.err
Gilles Peskine8f073122018-11-27 15:58:47 +01006016 cd "$MBEDTLS_ROOT_DIR"
6017 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +01006018}
Andres AGdc192212016-08-31 17:33:13 +01006019
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006020component_test_cmake_as_subdirectory () {
David Horstmann9f48fff2023-09-27 15:53:54 +01006021 # Remove existing generated files so that we use the ones CMake
6022 # generates
6023 make neat
6024
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006025 msg "build: cmake 'as-subdirectory' build"
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006026 cd programs/test/cmake_subproject
David Horstmann9f48fff2023-09-27 15:53:54 +01006027 # Note: Explicitly generate files as these are turned off in releases
6028 cmake -D GEN_FILES=ON .
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006029 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006030 ./cmake_subproject
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006031}
Gilles Peskinea3000992022-02-04 00:21:12 +01006032support_test_cmake_as_subdirectory () {
6033 support_test_cmake_out_of_source
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01006034}
6035
Chris Kayd259e342021-03-25 16:03:25 +00006036component_test_cmake_as_package () {
David Horstmann6c979852023-09-28 10:40:22 +01006037 # Remove existing generated files so that we use the ones CMake
6038 # generates
6039 make neat
6040
Chris Kayd259e342021-03-25 16:03:25 +00006041 msg "build: cmake 'as-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006042 cd programs/test/cmake_package
6043 cmake .
6044 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006045 ./cmake_package
Chris Kayd259e342021-03-25 16:03:25 +00006046}
Gilles Peskinea3000992022-02-04 00:21:12 +01006047support_test_cmake_as_package () {
6048 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006049}
6050
6051component_test_cmake_as_package_install () {
David Horstmann6c979852023-09-28 10:40:22 +01006052 # Remove existing generated files so that we use the ones CMake
6053 # generates
6054 make neat
6055
Chris Kayd259e342021-03-25 16:03:25 +00006056 msg "build: cmake 'as-installed-package' build"
Chris Kayd259e342021-03-25 16:03:25 +00006057 cd programs/test/cmake_package_install
6058 cmake .
6059 make
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006060 ./cmake_package_install
Chris Kayd259e342021-03-25 16:03:25 +00006061}
Gilles Peskinea3000992022-02-04 00:21:12 +01006062support_test_cmake_as_package_install () {
6063 support_test_cmake_out_of_source
Chris Kayd259e342021-03-25 16:03:25 +00006064}
6065
David Horstmann20550e32023-01-12 14:17:01 +00006066component_build_cmake_custom_config_file () {
David Horstmann969c1452023-01-31 10:34:44 +00006067 # Make a copy of config file to use for the in-tree test
6068 cp "$CONFIG_H" include/mbedtls_config_in_tree_copy.h
David Horstmann20550e32023-01-12 14:17:01 +00006069
6070 MBEDTLS_ROOT_DIR="$PWD"
6071 mkdir "$OUT_OF_SOURCE_DIR"
6072 cd "$OUT_OF_SOURCE_DIR"
6073
David Horstmann969c1452023-01-31 10:34:44 +00006074 # Build once to get the generated files (which need an intact config file)
David Horstmann20550e32023-01-12 14:17:01 +00006075 cmake "$MBEDTLS_ROOT_DIR"
6076 make
6077
6078 msg "build: cmake with -DMBEDTLS_CONFIG_FILE"
6079 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006080 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006081 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h "$MBEDTLS_ROOT_DIR"
6082 make
6083
6084 msg "build: cmake with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6085 # In the user config, disable one feature (for simplicity, pick a feature
6086 # that nothing else depends on).
6087 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6088
6089 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h "$MBEDTLS_ROOT_DIR"
6090 make
6091 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6092
6093 rm -f user_config.h full_config.h
6094
6095 cd "$MBEDTLS_ROOT_DIR"
6096 rm -rf "$OUT_OF_SOURCE_DIR"
6097
6098 # Now repeat the test for an in-tree build:
6099
David Horstmann969c1452023-01-31 10:34:44 +00006100 # Restore config for the in-tree test
6101 mv include/mbedtls_config_in_tree_copy.h "$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006102
David Horstmann969c1452023-01-31 10:34:44 +00006103 # Build once to get the generated files (which need an intact config)
David Horstmann20550e32023-01-12 14:17:01 +00006104 cmake .
6105 make
6106
6107 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE"
6108 scripts/config.py -w full_config.h full
David Horstmann969c1452023-01-31 10:34:44 +00006109 echo '#error "cmake -DMBEDTLS_CONFIG_FILE is not working."' > "$MBEDTLS_ROOT_DIR/$CONFIG_H"
David Horstmann20550e32023-01-12 14:17:01 +00006110 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h .
6111 make
6112
6113 msg "build: cmake (in-tree) with -DMBEDTLS_CONFIG_FILE + -DMBEDTLS_USER_CONFIG_FILE"
6114 # In the user config, disable one feature (for simplicity, pick a feature
6115 # that nothing else depends on).
6116 echo '#undef MBEDTLS_NIST_KW_C' >user_config.h
6117
6118 cmake -DGEN_FILES=OFF -DMBEDTLS_CONFIG_FILE=full_config.h -DMBEDTLS_USER_CONFIG_FILE=user_config.h .
6119 make
6120 not programs/test/query_compile_time_config MBEDTLS_NIST_KW_C
6121
6122 rm -f user_config.h full_config.h
6123}
6124support_build_cmake_custom_config_file () {
6125 support_test_cmake_out_of_source
6126}
6127
David Horstmann041ed422024-05-10 14:37:48 +01006128component_build_cmake_programs_no_testing () {
David Horstmanncbea7d62024-05-10 15:37:57 +01006129 # Verify that the type of builds performed by oss-fuzz don't get accidentally broken
David Horstmann041ed422024-05-10 14:37:48 +01006130 msg "build: cmake with -DENABLE_PROGRAMS=ON and -DENABLE_TESTING=OFF"
6131 cmake -DENABLE_PROGRAMS=ON -DENABLE_TESTING=OFF .
6132 make
6133}
6134support_build_cmake_programs_no_testing () {
6135 support_test_cmake_out_of_source
6136}
David Horstmann20550e32023-01-12 14:17:01 +00006137
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006138component_build_zeroize_checks () {
6139 msg "build: check for obviously wrong calls to mbedtls_platform_zeroize()"
6140
6141 scripts/config.py full
6142
6143 # Only compile - we're looking for sizeof-pointer-memaccess warnings
Dave Rodgman84125a12024-01-02 11:42:38 +00006144 make CFLAGS="'-DMBEDTLS_USER_CONFIG_FILE=\"../tests/configs/user-config-zeroize-memset.h\"' -DMBEDTLS_TEST_DEFINES_ZEROIZE -Werror -Wsizeof-pointer-memaccess"
Tom Cosgrovedaddf112023-09-01 10:40:15 +01006145}
6146
6147
Gilles Peskine8f073122018-11-27 15:58:47 +01006148component_test_zeroize () {
6149 # Test that the function mbedtls_platform_zeroize() is not optimized away by
6150 # different combinations of compilers and optimization flags by using an
6151 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
6152 # system in all cases that the script fails, so we must manually search the
6153 # output to check whether the pass string is present and no failure strings
6154 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01006155
Gilles Peskine4976e822019-01-06 19:52:22 +00006156 # Don't try to disable ASLR. We don't care about ASLR here. We do care
6157 # about a spurious message if Gdb tries and fails, so suppress that.
6158 gdb_disable_aslr=
6159 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
6160 gdb_disable_aslr='set disable-randomization off'
6161 fi
6162
Gilles Peskine8f073122018-11-27 15:58:47 +01006163 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01006164 for compiler in clang gcc; do
6165 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
6166 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006167 gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
6168 grep "The buffer was correctly zeroized" test_zeroize.log
6169 not grep -i "error" test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01006170 rm -f test_zeroize.log
6171 make clean
6172 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01006173 done
Gilles Peskine8f073122018-11-27 15:58:47 +01006174}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006175
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006176component_test_psa_compliance () {
Dave Rodgman932ce852023-12-18 19:55:40 +00006177 # The arch tests build with gcc, so require use of gcc here to link properly
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006178 msg "build: make, default config (out-of-box), libmbedcrypto.a only"
Dave Rodgman932ce852023-12-18 19:55:40 +00006179 CC=gcc make -C library libmbedcrypto.a
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006180
6181 msg "unit test: test_psa_compliance.py"
Dave Rodgmand0a594d2023-12-18 22:29:56 +00006182 CC=gcc ./tests/scripts/test_psa_compliance.py
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006183}
6184
6185support_test_psa_compliance () {
Bence Szépkútief0d02e2021-11-03 11:36:09 +01006186 # psa-compliance-tests only supports CMake >= 3.10.0
Bence Szépkútica9236b2021-10-25 19:29:07 +02006187 ver="$(cmake --version)"
6188 ver="${ver#cmake version }"
6189 ver_major="${ver%%.*}"
6190
6191 ver="${ver#*.}"
6192 ver_minor="${ver%%.*}"
6193
6194 [ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
Bence Szépkúti80b31c52021-10-19 15:05:36 +02006195}
6196
Gilles Peskinec848d222022-12-09 12:23:35 +01006197component_check_code_style () {
6198 msg "Check C code style"
6199 ./scripts/code_style.py
David Horstmann92b5ac12022-11-10 18:30:52 +00006200}
6201
Gilles Peskinec848d222022-12-09 12:23:35 +01006202support_check_code_style() {
David Horstmann92b5ac12022-11-10 18:30:52 +00006203 case $(uncrustify --version) in
6204 *0.75.1*) true;;
6205 *) false;;
6206 esac
6207}
6208
Gilles Peskine8f073122018-11-27 15:58:47 +01006209component_check_python_files () {
6210 msg "Lint: Python scripts"
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006211 tests/scripts/check-python-files.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01006212}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006213
Joe Subbianid614c0b2021-07-29 11:18:29 +01006214component_check_test_helpers () {
6215 msg "unit test: generate_test_code.py"
Manuel Pégourié-Gonnarddfb114a2020-06-02 11:40:08 +02006216 # unittest writes out mundane stuff like number or tests run on stderr.
6217 # Our convention is to reserve stderr for actual errors, and write
6218 # harmless info on stdout so it can be suppress with --quiet.
Gilles Peskine1f0cdaf2021-07-08 18:41:16 +02006219 ./tests/scripts/test_generate_test_code.py 2>&1
Joe Subbianid614c0b2021-07-29 11:18:29 +01006220
Joe Subbiania25ffab2021-08-06 09:41:27 +01006221 msg "unit test: translate_ciphers.py"
6222 python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01006223}
Gilles Peskine192c72f2017-12-21 15:59:21 +01006224
Valerio Settid9e42512024-05-06 15:59:51 +02006225component_test_psasim() {
Valerio Settid1b6ef12024-05-07 16:00:21 +02006226 msg "build library for client"
6227
6228 helper_crypto_client_build client
6229
6230 msg "build library for server"
6231
6232 scripts/config.py crypto
6233
6234 helper_crypto_client_build server
6235
Valerio Settid9e42512024-05-06 15:59:51 +02006236 msg "build psasim"
Valerio Setti4362aae2024-05-09 09:15:39 +02006237 make -C tests/psa-client-server/psasim CFLAGS="$ASAN_CFLAGS" LDFLAGS="$ASAN_CFLAGS"
Valerio Settid9e42512024-05-06 15:59:51 +02006238
6239 msg "test psasim"
Valerio Setti655b9792024-05-09 12:20:40 +02006240 tests/psa-client-server/psasim/test/run_test.sh
Valerio Settid9e42512024-05-06 15:59:51 +02006241
6242 msg "clean psasim"
6243 make -C tests/psa-client-server/psasim clean
6244}
Jerry Yud767cc42023-03-31 15:03:55 +08006245
Gilles Peskine192c72f2017-12-21 15:59:21 +01006246################################################################
6247#### Termination
6248################################################################
6249
Gilles Peskine8f073122018-11-27 15:58:47 +01006250post_report () {
6251 msg "Done, cleaning up"
Gilles Peskinef83eb822020-03-30 20:11:39 +02006252 final_cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006253
Gilles Peskine8f073122018-11-27 15:58:47 +01006254 final_report
6255}
6256
6257
6258
6259################################################################
6260#### Run all the things
6261################################################################
6262
Gilles Peskine5d996822020-03-28 21:09:21 +01006263# Function invoked by --error-test to test error reporting.
6264pseudo_component_error_test () {
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006265 msg "Testing error reporting $error_test_i"
Gilles Peskine5d996822020-03-28 21:09:21 +01006266 if [ $KEEP_GOING -ne 0 ]; then
6267 echo "Expect three failing commands."
6268 fi
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006269 # If the component doesn't run in a subshell, changing error_test_i to an
6270 # invalid integer will cause an error in the loop that runs this function.
6271 error_test_i=this_should_not_be_used_since_the_component_runs_in_a_subshell
Gilles Peskineec135542021-08-02 23:14:03 +02006272 # Expected error: 'grep non_existent /dev/null -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006273 grep non_existent /dev/null
Gilles Peskineec135542021-08-02 23:14:03 +02006274 # Expected error: '! grep -q . tests/scripts/all.sh -> 1'
Gilles Peskine5d996822020-03-28 21:09:21 +01006275 not grep -q . "$0"
Gilles Peskineec135542021-08-02 23:14:03 +02006276 # Expected error: 'make unknown_target -> 2'
Gilles Peskine5d996822020-03-28 21:09:21 +01006277 make unknown_target
6278 false "this should not be executed"
6279}
6280
Gilles Peskinee48351a2018-11-27 16:06:30 +01006281# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01006282run_component () {
Gilles Peskineffcdeff2018-12-04 12:49:28 +01006283 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02006284 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006285
6286 # Unconditionally create a seedfile that's sufficiently long.
6287 # Do this before each component, because a previous component may
6288 # have messed it up or shortened it.
Gilles Peskine88a07452021-07-08 19:03:50 +02006289 local dd_cmd
6290 dd_cmd=(dd if=/dev/urandom of=./tests/seedfile bs=64 count=1)
6291 case $OSTYPE in
Tom Cosgrove226aca12022-03-16 14:11:07 +00006292 linux*|freebsd*|openbsd*) dd_cmd+=(status=none)
Gilles Peskine88a07452021-07-08 19:03:50 +02006293 esac
6294 "${dd_cmd[@]}"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006295
Gilles Peskineec135542021-08-02 23:14:03 +02006296 # Run the component in a subshell, with error trapping and output
6297 # redirection set up based on the relevant options.
Gilles Peskinece266c42020-03-28 18:50:43 +01006298 if [ $KEEP_GOING -eq 1 ]; then
Gilles Peskineec135542021-08-02 23:14:03 +02006299 # We want to keep running if the subshell fails, so 'set -e' must
6300 # be off when the subshell runs.
Gilles Peskinece266c42020-03-28 18:50:43 +01006301 set +e
Manuel Pégourié-Gonnard2b2bdaa2020-06-02 11:28:07 +02006302 fi
Gilles Peskinece266c42020-03-28 18:50:43 +01006303 (
6304 if [ $QUIET -eq 1 ]; then
6305 # msg() will be silenced, so just print the component name here.
6306 echo "${current_component#component_}"
6307 exec >/dev/null
6308 fi
6309 if [ $KEEP_GOING -eq 1 ]; then
6310 # Keep "set -e" off, and run an ERR trap instead to record failures.
6311 set -E
6312 trap err_trap ERR
6313 fi
6314 # The next line is what runs the component
6315 "$@"
6316 if [ $KEEP_GOING -eq 1 ]; then
6317 trap - ERR
6318 exit $last_failure_status
6319 fi
6320 )
6321 component_status=$?
6322 if [ $KEEP_GOING -eq 1 ]; then
6323 set -e
6324 if [ $component_status -ne 0 ]; then
6325 failure_count=$((failure_count + 1))
6326 fi
6327 fi
Gilles Peskine2ef377d2019-10-07 18:44:21 +02006328
6329 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01006330 cleanup
Manuel Pégourié-Gonnard304b0992020-06-08 10:59:41 +02006331 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01006332}
6333
6334# Preliminary setup
6335pre_check_environment
6336pre_initialize_variables
6337pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01006338
Dave Rodgman21900632024-02-26 11:41:19 +00006339setup_quiet_wrappers
Gilles Peskine878cf602019-01-06 20:50:38 +00006340pre_check_git
Gilles Peskine568f53a2021-07-12 18:16:01 +02006341pre_restore_files
Gilles Peskinef83eb822020-03-30 20:11:39 +02006342pre_back_up
Andrzej Kurekeb508712019-02-14 07:18:59 -05006343
Gilles Peskine878cf602019-01-06 20:50:38 +00006344build_status=0
6345if [ $KEEP_GOING -eq 1 ]; then
6346 pre_setup_keep_going
Gilles Peskine8f073122018-11-27 15:58:47 +01006347fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02006348pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00006349pre_print_configuration
6350pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006351cleanup
David Horstmann76a77382023-08-17 17:32:26 +01006352if in_mbedtls_repo; then
David Horstmann9a6c45b2023-07-14 12:30:00 +01006353 pre_generate_files
6354fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01006355
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006356# Run the requested tests.
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006357for ((error_test_i=1; error_test_i <= error_test; error_test_i++)); do
Gilles Peskine5d996822020-03-28 21:09:21 +01006358 run_component pseudo_component_error_test
Gilles Peskine5d996822020-03-28 21:09:21 +01006359done
Gilles Peskine88a7c2b2021-08-02 23:28:00 +02006360unset error_test_i
Gilles Peskinebeb3a812019-01-06 22:11:25 +00006361for component in $RUN_COMPONENTS; do
6362 run_component "component_$component"
6363done
Gilles Peskine8f073122018-11-27 15:58:47 +01006364
6365# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00006366post_report