blob: 2a4bf8b7cf98828158ea2b2ed00d4c58528ec68b [file] [log] [blame]
Andres AG31f9b5b2016-10-04 17:14:38 +01001#! /usr/bin/env sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
SimonB2e23c822016-04-16 21:54:39 +01005# This file is part of mbed TLS (https://tls.mbed.org)
6#
Gilles Peskine192c72f2017-12-21 15:59:21 +01007# Copyright (c) 2014-2017, ARM Limited, All Rights Reserved
8
9
10
11################################################################
12#### Documentation
13################################################################
14
Simon Butcher3ea7f522016-03-07 23:22:10 +000015# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010016# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000017#
SimonB2e23c822016-04-16 21:54:39 +010018# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010019#
Gilles Peskine192c72f2017-12-21 15:59:21 +010020# Notes for users
21# ---------------
22#
SimonB2e23c822016-04-16 21:54:39 +010023# Warning: the test is destructive. It includes various build modes and
24# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010025# configuration. The following files must be committed into git:
26# * include/mbedtls/config.h
Gilles Peskine636c26a2020-03-04 20:46:15 +010027# * Makefile, library/Makefile, programs/Makefile, tests/Makefile,
28# programs/fuzz/Makefile
Gilles Peskine192c72f2017-12-21 15:59:21 +010029# After running this script, the CMake cache will be lost and CMake
30# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010031#
Gilles Peskine192c72f2017-12-21 15:59:21 +010032# The script assumes the presence of a number of tools:
33# * Basic Unix tools (Windows users note: a Unix-style find must be before
34# the Windows find in the PATH)
35# * Perl
36# * GNU Make
37# * CMake
38# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040039# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010040# * arm-gcc and mingw-gcc
41# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine192c72f2017-12-21 15:59:21 +010042# * OpenSSL and GnuTLS command line tools, recent enough for the
43# interoperability tests. If they don't support SSLv3 then a legacy
44# version of these tools must be present as well (search for LEGACY
45# below).
46# See the invocation of check_tools below for details.
47#
48# This script must be invoked from the toplevel directory of a git
49# working copy of Mbed TLS.
50#
51# Note that the output is not saved. You may want to run
52# script -c tests/scripts/all.sh
53# or
54# tests/scripts/all.sh >all.log 2>&1
55#
56# Notes for maintainers
57# ---------------------
58#
Gilles Peskine8f073122018-11-27 15:58:47 +010059# The bulk of the code is organized into functions that follow one of the
60# following naming conventions:
61# * pre_XXX: things to do before running the tests, in order.
62# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +010063# * component_check_XXX: quick tests that aren't worth parallelizing.
64# * component_build_XXX: build things but don't run them.
65# * component_test_XXX: build and test.
Gilles Peskine878cf602019-01-06 20:50:38 +000066# * support_XXX: if support_XXX exists and returns false then
67# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +010068# * post_XXX: things to do after running the tests.
69# * other: miscellaneous support functions.
70#
Gilles Peskinec70637a2019-01-09 22:29:17 +010071# Each component must start by invoking `msg` with a short informative message.
72#
73# The framework performs some cleanup tasks after each component. This
74# means that components can assume that the working directory is in a
75# cleaned-up state, and don't need to perform the cleanup themselves.
76# * Run `make clean`.
77# * Restore `include/mbedtks/config.h` from a backup made before running
78# the component.
Gilles Peskine636c26a2020-03-04 20:46:15 +010079# * Check out `Makefile`, `library/Makefile`, `programs/Makefile`,
80# `tests/Makefile` and `programs/fuzz/Makefile` from git.
81# This cleans up after an in-tree use of CMake.
Gilles Peskinec70637a2019-01-09 22:29:17 +010082#
83# Any command that is expected to fail must be protected so that the
84# script keeps running in --keep-going mode despite `set -e`. In keep-going
85# mode, if a protected command fails, this is logged as a failure and the
86# script will exit with a failure status once it has run all components.
87# Commands can be protected in any of the following ways:
88# * `make` is a function which runs the `make` command with protection.
89# Note that you must write `make VAR=value`, not `VAR=value make`,
90# because the `VAR=value make` syntax doesn't work with functions.
91# * Put `report_status` before the command to protect it.
92# * Put `if_build_successful` before a command. This protects it, and
93# additionally skips it if a prior invocation of `make` in the same
94# component failed.
95#
Gilles Peskine192c72f2017-12-21 15:59:21 +010096# The tests are roughly in order from fastest to slowest. This doesn't
97# have to be exact, but in general you should add slower tests towards
98# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +010099
100
101
102################################################################
103#### Initialization and command line parsing
104################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100105
SimonB2e23c822016-04-16 21:54:39 +0100106# Abort on errors (and uninitialised variables)
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100107set -eu
108
Gilles Peskine8f073122018-11-27 15:58:47 +0100109pre_check_environment () {
Gilles Peskinea16c2b12019-01-06 19:58:02 +0000110 if [ -d library -a -d include -a -d tests ]; then :; else
Gilles Peskine8f073122018-11-27 15:58:47 +0100111 echo "Must be run from mbed TLS root" >&2
112 exit 1
113 fi
114}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100115
Gilles Peskine8f073122018-11-27 15:58:47 +0100116pre_initialize_variables () {
117 CONFIG_H='include/mbedtls/config.h'
118 CONFIG_BAK="$CONFIG_H.bak"
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200119
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200120 append_outcome=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100121 MEMORY=0
122 FORCE=0
123 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100124
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200125 : ${MBEDTLS_TEST_OUTCOME_FILE=}
Gilles Peskine9004a172019-09-16 15:20:36 +0200126 : ${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 +0200127 export MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine9004a172019-09-16 15:20:36 +0200128 export MBEDTLS_TEST_PLATFORM
129
Jaeden Ameroc4cc2512019-01-30 15:35:44 +0000130 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100131 : ${OPENSSL:="openssl"}
132 : ${OPENSSL_LEGACY:="$OPENSSL"}
133 : ${OPENSSL_NEXT:="$OPENSSL"}
134 : ${GNUTLS_CLI:="gnutls-cli"}
135 : ${GNUTLS_SERV:="gnutls-serv"}
136 : ${GNUTLS_LEGACY_CLI:="$GNUTLS_CLI"}
137 : ${GNUTLS_LEGACY_SERV:="$GNUTLS_SERV"}
138 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
139 : ${ARMC5_BIN_DIR:=/usr/bin}
140 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskine6d061342020-04-30 18:19:32 +0200141 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Andres AGdc192212016-08-31 17:33:13 +0100142
Gilles Peskine8f073122018-11-27 15:58:47 +0100143 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000144 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine8f073122018-11-27 15:58:47 +0100145 export MAKEFLAGS="-j"
146 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000147
Jaeden Amerod48e9c72019-02-07 17:43:39 +0000148 # Include more verbose output for failing tests run by CMake
149 export CTEST_OUTPUT_ON_FAILURE=1
150
Gilles Peskine8fd59422019-10-21 17:11:33 +0200151 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Gilles Peskine5ca393f2019-10-21 19:06:33 +0200152 ASAN_CFLAGS='-Werror -Wall -Wextra -fsanitize=address,undefined -fno-sanitize-recover=all'
Gilles Peskine8fd59422019-10-21 17:11:33 +0200153
Gilles Peskine878cf602019-01-06 20:50:38 +0000154 # Gather the list of available components. These are the functions
155 # defined in this script whose name starts with "component_".
156 # Parse the script with sed, because in sh there is no way to list
157 # defined functions.
158 ALL_COMPONENTS=$(sed -n 's/^ *component_\([0-9A-Z_a-z]*\) *().*/\1/p' <"$0")
159
160 # Exclude components that are not supported on this platform.
161 SUPPORTED_COMPONENTS=
162 for component in $ALL_COMPONENTS; do
163 case $(type "support_$component" 2>&1) in
164 *' function'*)
165 if ! support_$component; then continue; fi;;
166 esac
167 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
168 done
Gilles Peskine8f073122018-11-27 15:58:47 +0100169}
Andres AG38495a32016-07-12 16:54:33 +0100170
Gilles Peskinea28db922019-01-10 00:05:18 +0100171# Test whether the component $1 is included in the command line patterns.
172is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100173{
174 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000175 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100176 set +f
177 case ${1#component_} in $pattern) return 0;; esac
178 done
179 set +f
180 return 1
181}
Andres AG7770ea82016-10-10 15:46:20 +0100182
Simon Butcher41eeccf2016-09-07 00:07:09 +0100183usage()
Andres AGd9eba4b2016-08-26 14:42:14 +0100184{
Gilles Peskine709346a2017-12-10 23:43:39 +0100185 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100186Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100187Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100188By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100189COMPONENT can be the name of a component or a shell wildcard pattern.
190
191Examples:
192 $0 "check_*"
193 Run all sanity checks.
194 $0 --no-armcc --except test_memsan
195 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100196
197Special options:
198 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000199 --list-all-components List all available test components and exit.
200 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100201
202General options:
203 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100204 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100205 -m|--memory Additional optional memory tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200206 --append-outcome Append to the outcome file (if used).
Gilles Peskine6d061342020-04-30 18:19:32 +0200207 --arm-none-eabi-gcc-prefix=<string>
208 Prefix for a cross-compiler for arm-none-eabi
209 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100210 --armcc Run ARM Compiler builds (on by default).
Gilles Peskinea28db922019-01-10 00:05:18 +0100211 --except Exclude the COMPONENTs listed on the command line,
212 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200213 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100214 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100215 --no-force Refuse to overwrite modified files (default).
216 --no-keep-going Stop at the first error (default).
217 --no-memory No additional memory tests (default).
Gilles Peskine709346a2017-12-10 23:43:39 +0100218 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200219 --outcome-file=<path> File where test outcomes are written (not done if
220 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100221 --random-seed Use a random seed value for randomized tests (default).
Gilles Peskine709346a2017-12-10 23:43:39 +0100222 -r|--release-test Run this script in release mode. This fixes the seed value to 1.
223 -s|--seed Integer seed value to use for this test run.
224
225Tool path options:
226 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
227 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
228 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
229 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
230 --gnutls-legacy-cli=<GnuTLS_cli_path> GnuTLS client executable to use for legacy tests.
231 --gnutls-legacy-serv=<GnuTLS_serv_path> GnuTLS server executable to use for legacy tests.
232 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
233 --openssl-legacy=<OpenSSL_path> OpenSSL executable to use for legacy tests e.g. SSLv3.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100234 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100235EOF
SimonB2e23c822016-04-16 21:54:39 +0100236}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100237
238# remove built files as well as the cmake cache/config
239cleanup()
240{
Gilles Peskinea71d64c2018-03-21 12:16:57 +0100241 if [ -n "${MBEDTLS_ROOT_DIR+set}" ]; then
242 cd "$MBEDTLS_ROOT_DIR"
243 fi
244
Gilles Peskine7c652162017-12-11 00:01:40 +0100245 command make clean
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200246
Gilles Peskine31b07e22018-03-21 12:15:06 +0100247 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000248 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100249 -iname CMakeFiles -exec rm -rf {} \+ -o \
250 \( -iname cmake_install.cmake -o \
251 -iname CTestTestfile.cmake -o \
252 -iname CMakeCache.txt \) -exec rm {} \+
253 # Recover files overwritten by in-tree CMake builds
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +0000254 rm -f include/Makefile include/mbedtls/Makefile programs/*/Makefile
Gilles Peskine636c26a2020-03-04 20:46:15 +0100255 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
256 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200257
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100258 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
259 rm -rf programs/test/cmake_subproject/build
260 rm -f programs/test/cmake_subproject/Makefile
261 rm -f programs/test/cmake_subproject/cmake_subproject
262
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200263 if [ -f "$CONFIG_BAK" ]; then
264 mv "$CONFIG_BAK" "$CONFIG_H"
265 fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100266}
267
Gilles Peskine7c652162017-12-11 00:01:40 +0100268# Executed on exit. May be redefined depending on command line options.
269final_report () {
270 :
271}
272
273fatal_signal () {
274 cleanup
275 final_report $1
276 trap - $1
277 kill -$1 $$
278}
279
280trap 'fatal_signal HUP' HUP
281trap 'fatal_signal INT' INT
282trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200283
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100284msg()
285{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100286 if [ -n "${current_component:-}" ]; then
287 current_section="${current_component#component_}: $1"
288 else
289 current_section="$1"
290 fi
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100291 echo ""
292 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100293 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000294 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100295 echo "******************************************************************"
296}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100297
Gilles Peskine8f073122018-11-27 15:58:47 +0100298armc6_build_test()
299{
300 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100301
Gilles Peskine8f073122018-11-27 15:58:47 +0100302 msg "build: ARM Compiler 6 ($FLAGS), make"
303 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
304 WARNING_CFLAGS='-xc -std=c99' make lib
305 make clean
306}
Andres AGa5cd9732016-10-17 15:23:10 +0100307
Andres AGd9eba4b2016-08-26 14:42:14 +0100308err_msg()
309{
310 echo "$1" >&2
311}
312
313check_tools()
314{
315 for TOOL in "$@"; do
Andres AG98393602017-01-31 17:04:45 +0000316 if ! `type "$TOOL" >/dev/null 2>&1`; then
Andres AGd9eba4b2016-08-26 14:42:14 +0100317 err_msg "$TOOL not found!"
318 exit 1
319 fi
320 done
321}
322
Andrzej Kurek991f9fe2018-07-02 09:08:21 -0400323check_headers_in_cpp () {
Peter Kolbus1bc1a4c2019-02-01 17:19:08 -0600324 ls include/mbedtls | grep "\.h$" >headers.txt
Andrzej Kurek991f9fe2018-07-02 09:08:21 -0400325 <programs/test/cpp_dummy_build.cpp sed -n 's/"$//; s!^#include "mbedtls/!!p' |
326 sort |
327 diff headers.txt -
328 rm headers.txt
329}
330
Gilles Peskine8f073122018-11-27 15:58:47 +0100331pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000332 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100333 all_except=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000334 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100335
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000336 # Note that legacy options are ignored instead of being omitted from this
337 # list of options, so invocations that worked with previous version of
338 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100339 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100340 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200341 --append-outcome) append_outcome=1;;
Gilles Peskine6d061342020-04-30 18:19:32 +0200342 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000343 --armcc) no_armcc=;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100344 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
345 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000346 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100347 --force|-f) FORCE=1;;
348 --gnutls-cli) shift; GNUTLS_CLI="$1";;
349 --gnutls-legacy-cli) shift; GNUTLS_LEGACY_CLI="$1";;
350 --gnutls-legacy-serv) shift; GNUTLS_LEGACY_SERV="$1";;
351 --gnutls-serv) shift; GNUTLS_SERV="$1";;
352 --help|-h) usage; exit;;
353 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000354 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
355 --list-components) printf '%s\n' $SUPPORTED_COMPONENTS; exit;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100356 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200357 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000358 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100359 --no-force) FORCE=0;;
360 --no-keep-going) KEEP_GOING=0;;
361 --no-memory) MEMORY=0;;
362 --openssl) shift; OPENSSL="$1";;
363 --openssl-legacy) shift; OPENSSL_LEGACY="$1";;
364 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200365 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100366 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
367 --random-seed) unset SEED;;
368 --release-test|-r) SEED=1;;
369 --seed|-s) shift; SEED="$1";;
370 -*)
371 echo >&2 "Unknown option: $1"
372 echo >&2 "Run $0 --help for usage."
373 exit 120
374 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000375 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100376 esac
377 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100378 done
SimonB2e23c822016-04-16 21:54:39 +0100379
Gilles Peskinea28db922019-01-10 00:05:18 +0100380 # With no list of components, run everything.
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000381 if [ -z "$COMMAND_LINE_COMPONENTS" ]; then
382 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100383 fi
384
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000385 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
386 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100387 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000388 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100389 fi
SimonB2e23c822016-04-16 21:54:39 +0100390
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000391 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100392 RUN_COMPONENTS=
393 for component in $SUPPORTED_COMPONENTS; do
394 if is_component_included "$component"; [ $? -eq $all_except ]; then
395 RUN_COMPONENTS="$RUN_COMPONENTS $component"
396 fi
397 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000398
399 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000400 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100401}
SimonB2e23c822016-04-16 21:54:39 +0100402
Gilles Peskine8f073122018-11-27 15:58:47 +0100403pre_check_git () {
404 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100405 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100406 git checkout-index -f -q $CONFIG_H
407 cleanup
408 else
SimonB2e23c822016-04-16 21:54:39 +0100409
Gilles Peskine8f073122018-11-27 15:58:47 +0100410 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
411 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
412 echo "You can either delete this directory manually, or force the test by rerunning"
413 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
414 exit 1
415 fi
416
Gilles Peskined1174cf2019-01-09 22:30:01 +0100417 if ! git diff --quiet include/mbedtls/config.h; then
Gilles Peskine8f073122018-11-27 15:58:47 +0100418 err_msg "Warning - the configuration file 'include/mbedtls/config.h' has been edited. "
419 echo "You can either delete or preserve your work, or force the test by rerunning the"
420 echo "script as: $0 --force"
421 exit 1
422 fi
SimonB2e23c822016-04-16 21:54:39 +0100423 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500424}
425
Gilles Peskine8f073122018-11-27 15:58:47 +0100426pre_setup_keep_going () {
Gilles Peskine7c652162017-12-11 00:01:40 +0100427 failure_summary=
428 failure_count=0
429 start_red=
430 end_color=
431 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100432 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100433 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
434 start_red=$(printf '\033[31m')
435 end_color=$(printf '\033[0m')
436 ;;
437 esac
438 fi
439 record_status () {
440 if "$@"; then
441 last_status=0
442 else
443 last_status=$?
444 text="$current_section: $* -> $last_status"
445 failure_summary="$failure_summary
446$text"
447 failure_count=$((failure_count + 1))
448 echo "${start_red}^^^^$text^^^^${end_color}"
449 fi
450 }
451 make () {
452 case "$*" in
453 *test|*check)
454 if [ $build_status -eq 0 ]; then
455 record_status command make "$@"
456 else
457 echo "(skipped because the build failed)"
458 fi
459 ;;
460 *)
461 record_status command make "$@"
462 build_status=$last_status
463 ;;
464 esac
465 }
466 final_report () {
467 if [ $failure_count -gt 0 ]; then
468 echo
469 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
470 echo "${start_red}FAILED: $failure_count${end_color}$failure_summary"
471 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Jaeden Amero7c1258d2018-07-20 16:42:14 +0100472 exit 1
Gilles Peskine7c652162017-12-11 00:01:40 +0100473 elif [ -z "${1-}" ]; then
474 echo "SUCCESS :)"
475 fi
476 if [ -n "${1-}" ]; then
477 echo "Killed by SIG$1."
478 fi
479 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100480}
481
Gilles Peskine7c652162017-12-11 00:01:40 +0100482if_build_succeeded () {
483 if [ $build_status -eq 0 ]; then
484 record_status "$@"
485 fi
486}
487
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +0200488# to be used instead of ! for commands run with
489# record_status or if_build_succeeded
490not() {
491 ! "$@"
492}
493
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200494pre_prepare_outcome_file () {
495 case "$MBEDTLS_TEST_OUTCOME_FILE" in
496 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
497 esac
498 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
499 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
500 fi
501}
502
Gilles Peskine8f073122018-11-27 15:58:47 +0100503pre_print_configuration () {
504 msg "info: $0 configuration"
505 echo "MEMORY: $MEMORY"
506 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200507 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100508 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100509 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100510 echo "OPENSSL: $OPENSSL"
511 echo "OPENSSL_LEGACY: $OPENSSL_LEGACY"
512 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
513 echo "GNUTLS_CLI: $GNUTLS_CLI"
514 echo "GNUTLS_SERV: $GNUTLS_SERV"
515 echo "GNUTLS_LEGACY_CLI: $GNUTLS_LEGACY_CLI"
516 echo "GNUTLS_LEGACY_SERV: $GNUTLS_LEGACY_SERV"
517 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
518 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
519}
Andres AG7770ea82016-10-10 15:46:20 +0100520
Andres AGd9eba4b2016-08-26 14:42:14 +0100521# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100522pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000523 # Build the list of variables to pass to output_env.sh.
524 set env
SimonB2e23c822016-04-16 21:54:39 +0100525
Gilles Peskine87964262019-01-06 22:40:00 +0000526 case " $RUN_COMPONENTS " in
527 # Require OpenSSL and GnuTLS if running any tests (as opposed to
528 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
529 # is a good enough approximation in practice.
530 *" test_"*)
531 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
532 # and ssl-opt.sh, we just export the variables they require.
533 export OPENSSL_CMD="$OPENSSL"
534 export GNUTLS_CLI="$GNUTLS_CLI"
535 export GNUTLS_SERV="$GNUTLS_SERV"
536 # Avoid passing --seed flag in every call to ssl-opt.sh
537 if [ -n "${SEED-}" ]; then
538 export SEED
539 fi
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000540 set "$@" OPENSSL="$OPENSSL" OPENSSL_LEGACY="$OPENSSL_LEGACY"
541 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
542 set "$@" GNUTLS_LEGACY_CLI="$GNUTLS_LEGACY_CLI"
543 set "$@" GNUTLS_LEGACY_SERV="$GNUTLS_LEGACY_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000544 check_tools "$OPENSSL" "$OPENSSL_LEGACY" "$OPENSSL_NEXT" \
545 "$GNUTLS_CLI" "$GNUTLS_SERV" \
546 "$GNUTLS_LEGACY_CLI" "$GNUTLS_LEGACY_SERV"
547 ;;
548 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200549
Gilles Peskine87964262019-01-06 22:40:00 +0000550 case " $RUN_COMPONENTS " in
551 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
552 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100553
Gilles Peskine87964262019-01-06 22:40:00 +0000554 case " $RUN_COMPONENTS " in
Gilles Peskine6d061342020-04-30 18:19:32 +0200555 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000556 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100557
Gilles Peskine87964262019-01-06 22:40:00 +0000558 case " $RUN_COMPONENTS " in
559 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
560 esac
561
562 case " $RUN_COMPONENTS " in
563 *" test_zeroize "*) check_tools "gdb";;
564 esac
565
566 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000567 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000568 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
569 ARMC5_AR="$ARMC5_BIN_DIR/armar"
570 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
571 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000572 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC6_CC" "$ARMC6_AR";;
573 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000574
575 msg "info: output_env.sh"
576 case $RUN_COMPONENTS in
577 *_armcc*)
578 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
579 *) set "$@" RUN_ARMCC=0;;
580 esac
581 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100582}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100583
Gilles Peskine192c72f2017-12-21 15:59:21 +0100584
585
586################################################################
587#### Basic checks
588################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100589
590#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200591# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100592#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +0100593# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200594# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100595# 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 +0200596# time, so start with a GCC build).
597# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100598#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +0100599# Indicative running times are given for reference.
600
Gilles Peskine8f073122018-11-27 15:58:47 +0100601component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200602 msg "Check: recursion.pl" # < 1s
Gilles Peskine8f073122018-11-27 15:58:47 +0100603 record_status tests/scripts/recursion.pl library/*.c
604}
Janos Follathb72c6782016-07-19 14:54:17 +0100605
Gilles Peskine8f073122018-11-27 15:58:47 +0100606component_check_generated_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200607 msg "Check: freshness of generated source files" # < 1s
Gilles Peskine8f073122018-11-27 15:58:47 +0100608 record_status tests/scripts/check-generated-files.sh
609}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200610
Gilles Peskine8f073122018-11-27 15:58:47 +0100611component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200612 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine8f073122018-11-27 15:58:47 +0100613 record_status tests/scripts/check-doxy-blocks.pl
614}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200615
Gilles Peskine8f073122018-11-27 15:58:47 +0100616component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200617 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine8f073122018-11-27 15:58:47 +0100618 record_status tests/scripts/check-files.py
619}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200620
Gilles Peskine8f073122018-11-27 15:58:47 +0100621component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200622 msg "Check: declared and exported names (builds the library)" # < 3s
Gilles Peskine13f97dc2019-05-15 17:52:22 +0200623 record_status tests/scripts/check-names.sh -v
Gilles Peskine8f073122018-11-27 15:58:47 +0100624}
Darryl Greena07039c2018-03-13 16:48:16 +0000625
Gilles Peskine895868b2019-09-19 21:30:05 +0200626component_check_test_cases () {
627 msg "Check: test case descriptions" # < 1s
628 record_status tests/scripts/check-test-cases.py
629}
630
Gilles Peskine8f073122018-11-27 15:58:47 +0100631component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200632 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine8f073122018-11-27 15:58:47 +0100633 record_status tests/scripts/doxygen.sh
634}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200635
Gilles Peskine192c72f2017-12-21 15:59:21 +0100636
Gilles Peskine636c26a2020-03-04 20:46:15 +0100637
Gilles Peskine192c72f2017-12-21 15:59:21 +0100638################################################################
639#### Build and test many configurations and targets
640################################################################
641
Gilles Peskine7832c9f2019-04-08 17:00:15 +0200642component_test_default_out_of_box () {
643 msg "build: make, default config (out-of-box)" # ~1min
644 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200645 # Disable fancy stuff
Gilles Peskine717cd762019-09-27 20:21:11 +0200646 SAVE_MBEDTLS_TEST_OUTCOME_FILE="$MBEDTLS_TEST_OUTCOME_FILE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200647 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +0200648
649 msg "test: main suites make, default config (out-of-box)" # ~10s
650 make test
651
652 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine97bea012020-04-23 23:37:45 +0200653 if_build_succeeded programs/test/selftest
Gilles Peskine717cd762019-09-27 20:21:11 +0200654
655 export MBEDTLS_TEST_OUTCOME_FILE="$SAVE_MBEDTLS_TEST_OUTCOME_FILE"
656 unset SAVE_MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +0200657}
658
Gilles Peskine8f073122018-11-27 15:58:47 +0100659component_test_default_cmake_gcc_asan () {
660 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +0100661 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
662 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200663
Gilles Peskine8f073122018-11-27 15:58:47 +0100664 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
665 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200666
Gilles Peskine97bea012020-04-23 23:37:45 +0200667 msg "test: selftest (ASan build)" # ~ 10s
668 if_build_succeeded programs/test/selftest
669
Gilles Peskine8f073122018-11-27 15:58:47 +0100670 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
671 if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200672
Gilles Peskine8f073122018-11-27 15:58:47 +0100673 msg "test: compat.sh (ASan build)" # ~ 6 min
674 if_build_succeeded tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +0200675
676 msg "test: context-info.sh (ASan build)" # ~ 15 sec
677 if_build_succeeded tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100678}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200679
Hanno Becker01635512019-02-26 14:27:09 +0000680component_test_full_cmake_gcc_asan () {
681 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200682 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +0000683 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
684 make
685
686 msg "test: main suites (inc. selftests) (full config, ASan build)"
687 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +0100688
Gilles Peskine97bea012020-04-23 23:37:45 +0200689 msg "test: selftest (ASan build)" # ~ 10s
690 if_build_succeeded programs/test/selftest
691
Gilles Peskine636c26a2020-03-04 20:46:15 +0100692 msg "test: ssl-opt.sh (full config, ASan build)"
693 if_build_succeeded tests/ssl-opt.sh
694
695 msg "test: compat.sh (full config, ASan build)"
696 if_build_succeeded tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +0200697
698 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
699 if_build_succeeded tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +0100700}
701
702component_test_zlib_make() {
703 msg "build: zlib enabled, make"
704 scripts/config.py set MBEDTLS_ZLIB_SUPPORT
705 make ZLIB=1 CFLAGS='-Werror -O1'
706
707 msg "test: main suites (zlib, make)"
708 make test
709
710 msg "test: ssl-opt.sh (zlib, make)"
711 if_build_succeeded tests/ssl-opt.sh
712}
713support_test_zlib_make () {
714 base=support_test_zlib_$$
715 cat <<'EOF' > ${base}.c
716#include "zlib.h"
717int main(void) { return 0; }
718EOF
719 gcc -o ${base}.exe ${base}.c -lz 2>/dev/null
720 ret=$?
721 rm -f ${base}.*
722 return $ret
723}
724
725component_test_zlib_cmake() {
726 msg "build: zlib enabled, cmake"
727 scripts/config.py set MBEDTLS_ZLIB_SUPPORT
728 cmake -D ENABLE_ZLIB_SUPPORT=On -D CMAKE_BUILD_TYPE:String=Check .
729 make
730
731 msg "test: main suites (zlib, cmake)"
732 make test
733
734 msg "test: ssl-opt.sh (zlib, cmake)"
735 if_build_succeeded tests/ssl-opt.sh
736}
737support_test_zlib_cmake () {
738 support_test_zlib_make "$@"
Manuel Pégourié-Gonnardf2e29022020-01-24 10:17:20 +0100739}
Manuel Pégourié-Gonnard95e04492020-01-02 11:45:12 +0100740
Gilles Peskine782f4112018-11-27 16:11:09 +0100741component_test_ref_configs () {
742 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
743 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
744 record_status tests/scripts/test-ref-configs.pl
745}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200746
Gilles Peskine8f073122018-11-27 15:58:47 +0100747component_test_sslv3 () {
748 msg "build: Default + SSLv3 (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200749 scripts/config.py set MBEDTLS_SSL_PROTO_SSL3
Gilles Peskine8f073122018-11-27 15:58:47 +0100750 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
751 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200752
Gilles Peskine8f073122018-11-27 15:58:47 +0100753 msg "test: SSLv3 - main suites (inc. selftests) (ASan build)" # ~ 50s
754 make test
Simon Butcher3ea7f522016-03-07 23:22:10 +0000755
Gilles Peskine8f073122018-11-27 15:58:47 +0100756 msg "build: SSLv3 - compat.sh (ASan build)" # ~ 6 min
757 if_build_succeeded tests/compat.sh -m 'tls1 tls1_1 tls1_2 dtls1 dtls1_2'
758 if_build_succeeded env OPENSSL_CMD="$OPENSSL_LEGACY" tests/compat.sh -m 'ssl3'
Simon Butcher3ea7f522016-03-07 23:22:10 +0000759
Gilles Peskine8f073122018-11-27 15:58:47 +0100760 msg "build: SSLv3 - ssl-opt.sh (ASan build)" # ~ 6 min
761 if_build_succeeded tests/ssl-opt.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +0200762
763 msg "build: SSLv3 - context-info.sh (ASan build)" # ~ 15 sec
764 if_build_succeeded tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100765}
Simon Butcher3ea7f522016-03-07 23:22:10 +0000766
Gilles Peskine8f073122018-11-27 15:58:47 +0100767component_test_no_renegotiation () {
768 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200769 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Gilles Peskine8f073122018-11-27 15:58:47 +0100770 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
771 make
Simon Butcher3ea7f522016-03-07 23:22:10 +0000772
Gilles Peskine8f073122018-11-27 15:58:47 +0100773 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
774 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +0100775
Gilles Peskine8f073122018-11-27 15:58:47 +0100776 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
777 if_build_succeeded tests/ssl-opt.sh
778}
Hanno Becker134c2ab2017-10-12 15:29:50 +0100779
Gilles Peskine636c26a2020-03-04 20:46:15 +0100780component_test_no_pem_no_fs () {
781 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
782 scripts/config.py unset MBEDTLS_PEM_PARSE_C
783 scripts/config.py unset MBEDTLS_FS_IO
784 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
785 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
786 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
787 make
788
789 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
790 make test
791
792 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
793 if_build_succeeded tests/ssl-opt.sh
794}
795
Gilles Peskine8f073122018-11-27 15:58:47 +0100796component_test_rsa_no_crt () {
797 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200798 scripts/config.py set MBEDTLS_RSA_NO_CRT
Gilles Peskine8f073122018-11-27 15:58:47 +0100799 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
800 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +0100801
Gilles Peskine8f073122018-11-27 15:58:47 +0100802 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
803 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100804
Gilles Peskine8f073122018-11-27 15:58:47 +0100805 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
806 if_build_succeeded tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100807
Gilles Peskine8f073122018-11-27 15:58:47 +0100808 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
809 if_build_succeeded tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +0200810
811 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
812 if_build_succeeded tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100813}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100814
Gilles Peskine636c26a2020-03-04 20:46:15 +0100815component_test_new_ecdh_context () {
816 msg "build: new ECDH context (ASan build)" # ~ 6 min
817 scripts/config.py unset MBEDTLS_ECDH_LEGACY_CONTEXT
818 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
819 make
820
821 msg "test: new ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
822 make test
823
824 msg "test: new ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
825 if_build_succeeded tests/ssl-opt.sh -f ECDH
826
827 msg "test: new ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
828 # Exclude some symmetric ciphers that are redundant here to gain time.
829 if_build_succeeded tests/compat.sh -f ECDH -V NO -e 'ARCFOUR\|ARIA\|CAMELLIA\|CHACHA\|DES\|RC4'
830}
831
832component_test_everest () {
833 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
834 scripts/config.py unset MBEDTLS_ECDH_LEGACY_CONTEXT
835 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
836 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
837 make
838
839 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
840 make test
841
842 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
843 if_build_succeeded tests/ssl-opt.sh -f ECDH
844
845 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
846 # Exclude some symmetric ciphers that are redundant here to gain time.
847 if_build_succeeded tests/compat.sh -f ECDH -V NO -e 'ARCFOUR\|ARIA\|CAMELLIA\|CHACHA\|DES\|RC4'
848}
849
Gilles Peskine8f073122018-11-27 15:58:47 +0100850component_test_small_ssl_out_content_len () {
851 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200852 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
853 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Gilles Peskine8f073122018-11-27 15:58:47 +0100854 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
855 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100856
Gilles Peskine8f073122018-11-27 15:58:47 +0100857 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
858 if_build_succeeded tests/ssl-opt.sh -f "Max fragment\|Large packet"
859}
Angus Grattonc4dd0732018-04-11 16:28:39 +1000860
Gilles Peskine8f073122018-11-27 15:58:47 +0100861component_test_small_ssl_in_content_len () {
862 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200863 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
864 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Gilles Peskine8f073122018-11-27 15:58:47 +0100865 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
866 make
Angus Grattonc4dd0732018-04-11 16:28:39 +1000867
Gilles Peskine8f073122018-11-27 15:58:47 +0100868 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
869 if_build_succeeded tests/ssl-opt.sh -f "Max fragment"
870}
Angus Grattonc4dd0732018-04-11 16:28:39 +1000871
Gilles Peskine8f073122018-11-27 15:58:47 +0100872component_test_small_ssl_dtls_max_buffering () {
873 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200874 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Gilles Peskine8f073122018-11-27 15:58:47 +0100875 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
876 make
Angus Grattonc4dd0732018-04-11 16:28:39 +1000877
Gilles Peskine8f073122018-11-27 15:58:47 +0100878 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
879 if_build_succeeded tests/ssl-opt.sh -f "DTLS reordering: Buffer out-of-order hs msg before reassembling next, free buffered msg"
880}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +0100881
Gilles Peskine8f073122018-11-27 15:58:47 +0100882component_test_small_mbedtls_ssl_dtls_max_buffering () {
883 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100884 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Gilles Peskine8f073122018-11-27 15:58:47 +0100885 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
886 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +0100887
Gilles Peskine8f073122018-11-27 15:58:47 +0100888 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
889 if_build_succeeded tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
890}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +0100891
Gilles Peskine75cc7712019-09-06 19:47:17 +0200892component_test_psa_collect_statuses () {
893 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +0200894 scripts/config.py full
Gilles Peskine75cc7712019-09-06 19:47:17 +0200895 record_status tests/scripts/psa_collect_statuses.py
896 # Check that psa_crypto_init() succeeded at least once
897 record_status grep -q '^0:psa_crypto_init:' tests/statuses.log
898 rm -f tests/statuses.log
899}
900
Gilles Peskine8f073122018-11-27 15:58:47 +0100901component_test_full_cmake_clang () {
902 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200903 scripts/config.py full
Gilles Peskine8f073122018-11-27 15:58:47 +0100904 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Check -D ENABLE_TESTING=On .
905 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +0100906
k-stachowiak0291cb72019-06-26 15:52:12 +0200907 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +0100908 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100909
k-stachowiak0291cb72019-06-26 15:52:12 +0200910 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Darryl Green45010a32019-02-06 13:43:58 +0000911 record_status tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +0100912
Gilles Peskine8f073122018-11-27 15:58:47 +0100913 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
914 if_build_succeeded tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200915
Andres Amaya Garcia2dadab72019-01-08 21:42:27 +0000916 msg "test: compat.sh RC4, DES, 3DES & NULL (full config)" # ~ 2 min
Andres Amaya Garcia419bd002019-02-19 20:20:57 +0000917 if_build_succeeded env OPENSSL_CMD="$OPENSSL_LEGACY" GNUTLS_CLI="$GNUTLS_LEGACY_CLI" GNUTLS_SERV="$GNUTLS_LEGACY_SERV" tests/compat.sh -e '^$' -f 'NULL\|DES\|RC4\|ARCFOUR'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200918
Gilles Peskine8f073122018-11-27 15:58:47 +0100919 msg "test: compat.sh ARIA + ChachaPoly"
920 if_build_succeeded env OPENSSL_CMD="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
921}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200922
Gilles Peskine8f073122018-11-27 15:58:47 +0100923component_build_deprecated () {
924 msg "build: make, full config + DEPRECATED_WARNING, gcc -O" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200925 scripts/config.py full
926 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine8f073122018-11-27 15:58:47 +0100927 # Build with -O -Wextra to catch a maximum of issues.
928 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra' lib programs
929 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-unused-function' tests
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100930
Gilles Peskine841b14b2019-11-26 17:37:37 +0100931 msg "test: make, full config + DEPRECATED_WARNING, expect warnings" # ~ 30s
932 make -C tests clean
933 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=deprecated-declarations -DMBEDTLS_TEST_DEPRECATED' tests
934
Gilles Peskine8f073122018-11-27 15:58:47 +0100935 msg "build: make, full config + DEPRECATED_REMOVED, clang -O" # ~ 30s
936 # No cleanup, just tweak the configuration and rebuild
937 make clean
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200938 scripts/config.py unset MBEDTLS_DEPRECATED_WARNING
939 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Gilles Peskine8f073122018-11-27 15:58:47 +0100940 # Build with -O -Wextra to catch a maximum of issues.
941 make CC=clang CFLAGS='-O -Werror -Wall -Wextra' lib programs
942 make CC=clang CFLAGS='-O -Werror -Wall -Wextra -Wno-unused-function' tests
943}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +0000944
Gilles Peskineec541fe2020-01-31 14:24:14 +0100945# Check that the specified libraries exist and are empty.
946are_empty_libraries () {
947 nm "$@" >/dev/null 2>/dev/null
948 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
949}
950
951component_build_crypto_default () {
952 msg "build: make, crypto only"
953 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +0100954 make CFLAGS='-O1 -Werror'
Gilles Peskineec541fe2020-01-31 14:24:14 +0100955 if_build_succeeded are_empty_libraries library/libmbedx509.* library/libmbedtls.*
956}
957
958component_build_crypto_full () {
959 msg "build: make, crypto only, full config"
960 scripts/config.py crypto_full
Gilles Peskine6bb39152020-02-03 11:59:20 +0100961 make CFLAGS='-O1 -Werror'
Gilles Peskineec541fe2020-01-31 14:24:14 +0100962 if_build_succeeded are_empty_libraries library/libmbedx509.* library/libmbedtls.*
963}
964
965component_build_crypto_baremetal () {
966 msg "build: make, crypto only, baremetal config"
967 scripts/config.py crypto_baremetal
Gilles Peskine6bb39152020-02-03 11:59:20 +0100968 make CFLAGS='-O1 -Werror'
Gilles Peskineec541fe2020-01-31 14:24:14 +0100969 if_build_succeeded are_empty_libraries library/libmbedx509.* library/libmbedtls.*
970}
971
Gilles Peskine8f073122018-11-27 15:58:47 +0100972component_test_depends_curves () {
973 msg "test/build: curves.pl (gcc)" # ~ 4 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100974 record_status tests/scripts/curves.pl
975}
Jaeden Ameroacaabe72018-11-07 11:52:52 +0000976
Gilles Peskine8f073122018-11-27 15:58:47 +0100977component_test_depends_hashes () {
978 msg "test/build: depends-hashes.pl (gcc)" # ~ 2 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100979 record_status tests/scripts/depends-hashes.pl
980}
Jaeden Ameroacaabe72018-11-07 11:52:52 +0000981
Gilles Peskine8f073122018-11-27 15:58:47 +0100982component_test_depends_pkalgs () {
983 msg "test/build: depends-pkalgs.pl (gcc)" # ~ 2 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100984 record_status tests/scripts/depends-pkalgs.pl
985}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +0100986
Gilles Peskine8f073122018-11-27 15:58:47 +0100987component_build_key_exchanges () {
988 msg "test/build: key-exchanges (gcc)" # ~ 1 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100989 record_status tests/scripts/key-exchanges.pl
990}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +0100991
Gilles Peskine8f073122018-11-27 15:58:47 +0100992component_build_default_make_gcc_and_cxx () {
993 msg "build: Unix make, -Os (gcc)" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +0100994 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os'
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +0100995
Gilles Peskine8f073122018-11-27 15:58:47 +0100996 msg "test: verify header list in cpp_dummy_build.cpp"
997 record_status check_headers_in_cpp
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +0100998
Gilles Peskine8f073122018-11-27 15:58:47 +0100999 msg "build: Unix make, incremental g++"
1000 make TEST_CPP=1
1001}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01001002
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001003component_test_no_use_psa_crypto_full_cmake_asan() {
1004 # full minus MBEDTLS_USE_PSA_CRYPTO: run the same set of tests as basic-build-test.sh
Gilles Peskinedc3a1792019-09-03 11:42:04 +02001005 msg "build: cmake, full config minus MBEDTLS_USE_PSA_CRYPTO, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001006 scripts/config.py full
1007 scripts/config.py set MBEDTLS_ECP_RESTARTABLE # not using PSA, so enable restartable ECC
1008 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1009 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
1010 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
1011 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnardd8167e82019-02-01 11:12:52 +01001012 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05001013 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02001014
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001015 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05001016 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02001017
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001018 msg "test: ssl-opt.sh (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05001019 if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001020
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001021 msg "test: compat.sh default (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05001022 if_build_succeeded tests/compat.sh
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04001023
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001024 msg "test: compat.sh RC4, DES & NULL (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05001025 if_build_succeeded env OPENSSL_CMD="$OPENSSL_LEGACY" GNUTLS_CLI="$GNUTLS_LEGACY_CLI" GNUTLS_SERV="$GNUTLS_LEGACY_SERV" tests/compat.sh -e '3DES\|DES-CBC3' -f 'NULL\|DES\|RC4\|ARCFOUR'
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001026
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001027 msg "test: compat.sh ARIA + ChachaPoly (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05001028 if_build_succeeded env OPENSSL_CMD="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
1029}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001030
Gilles Peskineadcde5e2019-06-12 16:05:50 +02001031component_test_check_params_functionality () {
1032 msg "build+test: MBEDTLS_CHECK_PARAMS functionality"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001033 scripts/config.py full # includes CHECK_PARAMS
Gilles Peskineadcde5e2019-06-12 16:05:50 +02001034 # Make MBEDTLS_PARAM_FAILED call mbedtls_param_failed().
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001035 scripts/config.py unset MBEDTLS_CHECK_PARAMS_ASSERT
Gilles Peskineadcde5e2019-06-12 16:05:50 +02001036 # Only build and run tests. Do not build sample programs, because
1037 # they don't have a mbedtls_param_failed() function.
1038 make CC=gcc CFLAGS='-Werror -O1' lib test
1039}
1040
Gilles Peskineb28636b2019-01-02 19:06:24 +01001041component_test_check_params_without_platform () {
1042 msg "build+test: MBEDTLS_CHECK_PARAMS without MBEDTLS_PLATFORM_C"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001043 scripts/config.py full # includes CHECK_PARAMS
Gilles Peskineadcde5e2019-06-12 16:05:50 +02001044 # Keep MBEDTLS_PARAM_FAILED as assert.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001045 scripts/config.py unset MBEDTLS_PLATFORM_EXIT_ALT
1046 scripts/config.py unset MBEDTLS_PLATFORM_TIME_ALT
1047 scripts/config.py unset MBEDTLS_PLATFORM_FPRINTF_ALT
1048 scripts/config.py unset MBEDTLS_PLATFORM_MEMORY
1049 scripts/config.py unset MBEDTLS_PLATFORM_PRINTF_ALT
1050 scripts/config.py unset MBEDTLS_PLATFORM_SNPRINTF_ALT
1051 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1052 scripts/config.py unset MBEDTLS_PLATFORM_C
Gilles Peskineb28636b2019-01-02 19:06:24 +01001053 make CC=gcc CFLAGS='-Werror -O1' all test
1054}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001055
Gilles Peskineb28636b2019-01-02 19:06:24 +01001056component_test_check_params_silent () {
1057 msg "build+test: MBEDTLS_CHECK_PARAMS with alternative MBEDTLS_PARAM_FAILED()"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001058 scripts/config.py full # includes CHECK_PARAMS
Gilles Peskineadcde5e2019-06-12 16:05:50 +02001059 # Set MBEDTLS_PARAM_FAILED to nothing.
Gilles Peskineb28636b2019-01-02 19:06:24 +01001060 sed -i 's/.*\(#define MBEDTLS_PARAM_FAILED( cond )\).*/\1/' "$CONFIG_H"
1061 make CC=gcc CFLAGS='-Werror -O1' all test
1062}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001063
Gilles Peskine8f073122018-11-27 15:58:47 +01001064component_test_no_platform () {
1065 # Full configuration build, without platform support, file IO and net sockets.
1066 # This should catch missing mbedtls_printf definitions, and by disabling file
1067 # IO, it should catch missing '#include <stdio.h>'
1068 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001069 scripts/config.py full
1070 scripts/config.py unset MBEDTLS_PLATFORM_C
1071 scripts/config.py unset MBEDTLS_NET_C
1072 scripts/config.py unset MBEDTLS_PLATFORM_MEMORY
1073 scripts/config.py unset MBEDTLS_PLATFORM_PRINTF_ALT
1074 scripts/config.py unset MBEDTLS_PLATFORM_FPRINTF_ALT
1075 scripts/config.py unset MBEDTLS_PLATFORM_SNPRINTF_ALT
1076 scripts/config.py unset MBEDTLS_PLATFORM_TIME_ALT
1077 scripts/config.py unset MBEDTLS_PLATFORM_EXIT_ALT
1078 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1079 scripts/config.py unset MBEDTLS_FS_IO
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001080 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001081 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1082 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskine8f073122018-11-27 15:58:47 +01001083 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
1084 # to re-enable platform integration features otherwise disabled in C99 builds
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02001085 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
1086 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Gilles Peskine8f073122018-11-27 15:58:47 +01001087}
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00001088
Gilles Peskine8f073122018-11-27 15:58:47 +01001089component_build_no_std_function () {
1090 # catch compile bugs in _uninit functions
1091 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001092 scripts/config.py full
1093 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
1094 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02001095 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os'
Gilles Peskine8f073122018-11-27 15:58:47 +01001096}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01001097
Gilles Peskine8f073122018-11-27 15:58:47 +01001098component_build_no_ssl_srv () {
1099 msg "build: full config except ssl_srv.c, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001100 scripts/config.py full
1101 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02001102 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01001103}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02001104
Gilles Peskine8f073122018-11-27 15:58:47 +01001105component_build_no_ssl_cli () {
1106 msg "build: full config except ssl_cli.c, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001107 scripts/config.py full
1108 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02001109 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01001110}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02001111
Gilles Peskine8f073122018-11-27 15:58:47 +01001112component_build_no_sockets () {
1113 # Note, C99 compliance can also be tested with the sockets support disabled,
1114 # as that requires a POSIX platform (which isn't the same as C99).
1115 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001116 scripts/config.py full
1117 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
1118 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02001119 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01001120}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02001121
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04001122component_test_memory_buffer_allocator_backtrace () {
1123 msg "build: default config with memory buffer allocator and backtrace enabled"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001124 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
1125 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
1126 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
1127 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04001128 CC=gcc cmake .
1129 make
1130
1131 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
1132 make test
1133}
1134
1135component_test_memory_buffer_allocator () {
1136 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001137 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
1138 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Hanno Becker0fb9ba22019-02-26 14:34:13 +00001139 CC=gcc cmake .
1140 make
1141
1142 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
1143 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001144
1145 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
1146 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
1147 if_build_succeeded tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00001148}
1149
Gilles Peskine8f073122018-11-27 15:58:47 +01001150component_test_no_max_fragment_length () {
1151 # Run max fragment length tests with MFL disabled
1152 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001153 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01001154 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1155 make
Hanno Becker5175ac62017-09-18 15:36:25 +01001156
Gilles Peskine8f073122018-11-27 15:58:47 +01001157 msg "test: ssl-opt.sh, MFL-related tests"
1158 if_build_succeeded tests/ssl-opt.sh -f "Max fragment length"
1159}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001160
Hanno Becker545ced42019-02-19 11:10:48 +00001161component_test_asan_remove_peer_certificate () {
1162 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001163 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Hanno Becker545ced42019-02-19 11:10:48 +00001164 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1165 make
1166
1167 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
1168 make test
1169
1170 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
1171 if_build_succeeded tests/ssl-opt.sh
1172
1173 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
1174 if_build_succeeded tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001175
1176 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
1177 if_build_succeeded tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00001178}
1179
Gilles Peskine8f073122018-11-27 15:58:47 +01001180component_test_no_max_fragment_length_small_ssl_out_content_len () {
1181 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001182 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
1183 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
1184 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Gilles Peskine8f073122018-11-27 15:58:47 +01001185 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1186 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10001187
Gilles Peskine8f073122018-11-27 15:58:47 +01001188 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
1189 if_build_succeeded tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001190
1191 msg "test: context-info.sh (disabled MFL extension case)"
1192 if_build_succeeded tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001193}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001194
Darryl Greenaad82f92019-12-02 10:53:11 +00001195component_test_variable_ssl_in_out_buffer_len () {
1196 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
1197 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1198 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1199 make
1200
1201 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
1202 make test
1203
1204 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
1205 if_build_succeeded tests/ssl-opt.sh
1206
1207 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
1208 if_build_succeeded tests/compat.sh
1209}
1210
1211component_test_variable_ssl_in_out_buffer_len_CID () {
1212 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_DTLS_CONNECTION_ID enabled (ASan build)"
1213 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1214 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID
1215
1216 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1217 make
1218
1219 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_DTLS_CONNECTION_ID"
1220 make test
1221
1222 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_DTLS_CONNECTION_ID enabled"
1223 if_build_succeeded tests/ssl-opt.sh
1224
1225 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_DTLS_CONNECTION_ID enabled"
1226 if_build_succeeded tests/compat.sh
1227}
1228
1229component_test_variable_ssl_in_out_buffer_len_record_splitting () {
1230 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_CBC_RECORD_SPLITTING enabled (ASan build)"
1231 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1232 scripts/config.py set MBEDTLS_SSL_CBC_RECORD_SPLITTING
1233
1234 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1235 make
1236
1237 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_CBC_RECORD_SPLITTING"
1238 make test
1239
1240 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_CBC_RECORD_SPLITTING enabled"
1241 if_build_succeeded tests/ssl-opt.sh
1242
1243 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_CBC_RECORD_SPLITTING enabled"
1244 if_build_succeeded tests/compat.sh
1245}
1246
Piotr Nowicki0937ed22019-11-26 16:32:40 +01001247component_test_ssl_alloc_buffer_and_mfl () {
1248 msg "build: default config with memory buffer allocator and MFL extension"
1249 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
1250 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
1251 scripts/config.py set MBEDTLS_MEMORY_DEBUG
1252 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
1253 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1254 CC=gcc cmake .
1255 make
1256
1257 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
1258 make test
1259
1260 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
1261 if_build_succeeded tests/ssl-opt.sh -f "Handshake memory usage"
1262}
1263
Gilles Peskine636c26a2020-03-04 20:46:15 +01001264component_test_when_no_ciphersuites_have_mac () {
1265 msg "build: when no ciphersuites have MAC"
1266 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
1267 scripts/config.py unset MBEDTLS_ARC4_C
1268 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
1269 make
1270
1271 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
1272 make test
1273
1274 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
1275 if_build_succeeded tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
1276}
1277
Gilles Peskine8f073122018-11-27 15:58:47 +01001278component_test_null_entropy () {
1279 msg "build: default config with MBEDTLS_TEST_NULL_ENTROPY (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001280 scripts/config.py set MBEDTLS_TEST_NULL_ENTROPY
1281 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1282 scripts/config.py set MBEDTLS_ENTROPY_C
1283 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1284 scripts/config.py unset MBEDTLS_ENTROPY_HARDWARE_ALT
1285 scripts/config.py unset MBEDTLS_HAVEGE_C
Gilles Peskine5fa32a72019-01-06 19:48:30 +00001286 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan -D UNSAFE_BUILD=ON .
Gilles Peskine8f073122018-11-27 15:58:47 +01001287 make
Janos Follath06c54002016-06-09 13:57:40 +01001288
Gilles Peskine8f073122018-11-27 15:58:47 +01001289 msg "test: MBEDTLS_TEST_NULL_ENTROPY - main suites (inc. selftests) (ASan build)"
1290 make test
1291}
Janos Follath06c54002016-06-09 13:57:40 +01001292
Gilles Peskine8f073122018-11-27 15:58:47 +01001293component_test_platform_calloc_macro () {
1294 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001295 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
1296 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
1297 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Gilles Peskine8f073122018-11-27 15:58:47 +01001298 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1299 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01001300
Gilles Peskine8f073122018-11-27 15:58:47 +01001301 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
1302 make test
1303}
Hanno Beckere5fecec2018-10-11 11:02:52 +01001304
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02001305component_test_malloc_0_null () {
1306 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01001307 scripts/config.py full
Gilles Peskine004206c2019-10-21 17:11:33 +02001308 make CC=gcc CFLAGS="'-DMBEDTLS_CONFIG_FILE=\"$PWD/tests/configs/config-wrapper-malloc-0-null.h\"' $ASAN_CFLAGS -O" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02001309
1310 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
1311 make test
1312
1313 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
1314 # Just the calloc selftest. "make test" ran the others as part of the
1315 # test suites.
1316 if_build_succeeded programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01001317
1318 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
1319 # Run a subset of the tests. The choice is a balance between coverage
1320 # and time (including time indirectly wasted due to flaky tests).
1321 # The current choice is to skip tests whose description includes
1322 # "proxy", which is an approximation of skipping tests that use the
1323 # UDP proxy, which tend to be slower and flakier.
1324 if_build_succeeded tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02001325}
1326
Gilles Peskine8f073122018-11-27 15:58:47 +01001327component_test_aes_fewer_tables () {
1328 msg "build: default config with AES_FEWER_TABLES enabled"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001329 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Gilles Peskine8f073122018-11-27 15:58:47 +01001330 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01001331
Gilles Peskine8f073122018-11-27 15:58:47 +01001332 msg "test: AES_FEWER_TABLES"
1333 make test
1334}
Hanno Becker83ebf782017-07-07 12:29:15 +01001335
Gilles Peskine8f073122018-11-27 15:58:47 +01001336component_test_aes_rom_tables () {
1337 msg "build: default config with AES_ROM_TABLES enabled"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001338 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Gilles Peskine8f073122018-11-27 15:58:47 +01001339 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01001340
Gilles Peskine8f073122018-11-27 15:58:47 +01001341 msg "test: AES_ROM_TABLES"
1342 make test
1343}
Hanno Becker83ebf782017-07-07 12:29:15 +01001344
Gilles Peskine8f073122018-11-27 15:58:47 +01001345component_test_aes_fewer_tables_and_rom_tables () {
1346 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001347 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
1348 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Gilles Peskine8f073122018-11-27 15:58:47 +01001349 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01001350
Gilles Peskine8f073122018-11-27 15:58:47 +01001351 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
1352 make test
1353}
1354
Gilles Peskine592f5912019-10-07 18:49:32 +02001355component_test_ctr_drbg_aes_256_sha_256 () {
1356 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01001357 scripts/config.py full
1358 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
1359 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Gilles Peskine592f5912019-10-07 18:49:32 +02001360 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1361 make
1362
1363 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
1364 make test
1365}
1366
1367component_test_ctr_drbg_aes_128_sha_512 () {
1368 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01001369 scripts/config.py full
1370 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
1371 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Gilles Peskine592f5912019-10-07 18:49:32 +02001372 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1373 make
1374
1375 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
1376 make test
1377}
1378
1379component_test_ctr_drbg_aes_128_sha_256 () {
1380 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01001381 scripts/config.py full
1382 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
1383 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
1384 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Gilles Peskine592f5912019-10-07 18:49:32 +02001385 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1386 make
1387
1388 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
1389 make test
1390}
1391
Gilles Peskinef96aefe2019-07-24 14:58:38 +02001392component_test_se_default () {
1393 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001394 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02001395 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02001396
1397 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
1398 make test
1399}
1400
1401component_test_se_full () {
1402 msg "build: full config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001403 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001404 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02001405 make CC=gcc CFLAGS="$ASAN_CFLAGS -O2" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02001406
1407 msg "test: full config + MBEDTLS_PSA_CRYPTO_SE_C"
1408 make test
1409}
1410
Gilles Peskine8f073122018-11-27 15:58:47 +01001411component_test_make_shared () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001412 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04001413 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02001414 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskine8f073122018-11-27 15:58:47 +01001415}
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02001416
Gilles Peskinecf740502019-07-03 20:43:05 +02001417component_test_cmake_shared () {
1418 msg "build/test: cmake shared" # ~ 2min
1419 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
1420 make
Gilles Peskine56c01612019-07-03 20:43:32 +02001421 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02001422 make test
1423}
1424
Gilles Peskineec10bf12019-09-20 19:56:06 +02001425test_build_opt () {
1426 info=$1 cc=$2; shift 2
1427 for opt in "$@"; do
1428 msg "build/test: $cc $opt, $info" # ~ 30s
1429 make CC="$cc" CFLAGS="$opt -Wall -Wextra -Werror"
1430 # We're confident enough in compilers to not run _all_ the tests,
1431 # but at least run the unit tests. In particular, runs with
1432 # optimizations use inline assembly whereas runs with -O0
1433 # skip inline assembly.
1434 make test # ~30s
1435 make clean
1436 done
1437}
1438
1439component_test_clang_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01001440 scripts/config.py full
Gilles Peskineec10bf12019-09-20 19:56:06 +02001441 test_build_opt 'full config' clang -O0 -Os -O2
1442}
1443
1444component_test_gcc_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01001445 scripts/config.py full
Gilles Peskineec10bf12019-09-20 19:56:06 +02001446 test_build_opt 'full config' gcc -O0 -Os -O2
1447}
1448
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02001449component_build_mbedtls_config_file () {
1450 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
1451 # Use the full config so as to catch a maximum of places where
1452 # the check of MBEDTLS_CONFIG_FILE might be missing.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001453 scripts/config.py full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02001454 sed 's!"check_config.h"!"mbedtls/check_config.h"!' <"$CONFIG_H" >full_config.h
1455 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
1456 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
1457 rm -f full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001458}
1459
Gilles Peskine8f073122018-11-27 15:58:47 +01001460component_test_m32_o0 () {
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001461 # Build once with -O0, to compile out the i386 specific inline assembly
1462 msg "build: i386, make, gcc -O0 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001463 scripts/config.py full
Gilles Peskine8fd59422019-10-21 17:11:33 +02001464 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O0" LDFLAGS="-m32 $ASAN_CFLAGS"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01001465
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001466 msg "test: i386, make, gcc -O0 (ASan build)"
1467 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01001468}
Gilles Peskine878cf602019-01-06 20:50:38 +00001469support_test_m32_o0 () {
1470 case $(uname -m) in
1471 *64*) true;;
1472 *) false;;
1473 esac
1474}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001475
Gilles Peskine8f073122018-11-27 15:58:47 +01001476component_test_m32_o1 () {
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001477 # Build again with -O1, to compile in the i386 specific inline assembly
1478 msg "build: i386, make, gcc -O1 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001479 scripts/config.py full
Gilles Peskine8fd59422019-10-21 17:11:33 +02001480 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O1" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001481
1482 msg "test: i386, make, gcc -O1 (ASan build)"
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01001483 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001484
1485 msg "test ssl-opt.sh, i386, make, gcc-O1"
1486 if_build_succeeded tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001487}
Gilles Peskine878cf602019-01-06 20:50:38 +00001488support_test_m32_o1 () {
1489 support_test_m32_o0 "$@"
1490}
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01001491
Gilles Peskine0c6b7992019-04-12 20:29:48 +02001492component_test_m32_everest () {
1493 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001494 scripts/config.py unset MBEDTLS_ECDH_LEGACY_CONTEXT
1495 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Gilles Peskine8fd59422019-10-21 17:11:33 +02001496 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O2" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02001497
1498 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1499 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001500
1501 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
1502 if_build_succeeded tests/ssl-opt.sh -f ECDH
1503
1504 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1505 # Exclude some symmetric ciphers that are redundant here to gain time.
1506 if_build_succeeded tests/compat.sh -f ECDH -V NO -e 'ARCFOUR\|ARIA\|CAMELLIA\|CHACHA\|DES\|RC4'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02001507}
1508support_test_m32_everest () {
1509 support_test_m32_o0 "$@"
1510}
1511
Gilles Peskine8f073122018-11-27 15:58:47 +01001512component_test_mx32 () {
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01001513 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001514 scripts/config.py full
Gilles Peskine5d26e7c2019-06-07 14:50:09 +02001515 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01001516
1517 msg "test: 64-bit ILP32, make, gcc"
1518 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01001519}
Gilles Peskine878cf602019-01-06 20:50:38 +00001520support_test_mx32 () {
1521 case $(uname -m) in
1522 amd64|x86_64) true;;
1523 *) false;;
1524 esac
1525}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001526
Peter Kolbus60c6da22018-12-27 06:59:04 -06001527component_test_min_mpi_window_size () {
1528 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001529 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Peter Kolbus60c6da22018-12-27 06:59:04 -06001530 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1531 make
1532
1533 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
1534 make test
1535}
1536
Gilles Peskine8f073122018-11-27 15:58:47 +01001537component_test_have_int32 () {
1538 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001539 scripts/config.py unset MBEDTLS_HAVE_ASM
1540 scripts/config.py unset MBEDTLS_AESNI_C
1541 scripts/config.py unset MBEDTLS_PADLOCK_C
Gilles Peskine8f073122018-11-27 15:58:47 +01001542 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01001543
Gilles Peskine8f073122018-11-27 15:58:47 +01001544 msg "test: gcc, force 32-bit bignum limbs"
1545 make test
1546}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01001547
Gilles Peskine8f073122018-11-27 15:58:47 +01001548component_test_have_int64 () {
1549 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001550 scripts/config.py unset MBEDTLS_HAVE_ASM
1551 scripts/config.py unset MBEDTLS_AESNI_C
1552 scripts/config.py unset MBEDTLS_PADLOCK_C
Gilles Peskine8f073122018-11-27 15:58:47 +01001553 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01001554
Gilles Peskine8f073122018-11-27 15:58:47 +01001555 msg "test: gcc, force 64-bit bignum limbs"
1556 make test
1557}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001558
Gilles Peskine8f073122018-11-27 15:58:47 +01001559component_test_no_udbl_division () {
1560 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001561 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001562 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine8f073122018-11-27 15:58:47 +01001563 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001564
Gilles Peskine8f073122018-11-27 15:58:47 +01001565 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
1566 make test
1567}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001568
Gilles Peskine8f073122018-11-27 15:58:47 +01001569component_test_no_64bit_multiplication () {
1570 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001571 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001572 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine8f073122018-11-27 15:58:47 +01001573 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001574
Gilles Peskine8f073122018-11-27 15:58:47 +01001575 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
1576 make test
1577}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001578
Gilles Peskine8f073122018-11-27 15:58:47 +01001579component_build_arm_none_eabi_gcc () {
Gilles Peskine6d061342020-04-30 18:19:32 +02001580 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001581 scripts/config.py baremetal
Gilles Peskine6d061342020-04-30 18:19:32 +02001582 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-Werror -Wall -Wextra' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01001583}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001584
Gilles Peskine2c897d72019-08-09 16:05:05 +02001585component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskine6d061342020-04-30 18:19:32 +02001586 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001587 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02001588 # Build for a target platform that's close to what Debian uses
1589 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
1590 # See https://github.com/ARMmbed/mbedtls/pull/2169 and comments.
1591 # It would be better to build with arm-linux-gnueabi-gcc but
1592 # we don't have that on our CI at this time.
Gilles Peskine6d061342020-04-30 18:19:32 +02001593 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" CFLAGS='-Werror -Wall -Wextra -march=armv5te -O1' LDFLAGS='-march=armv5te' SHELL='sh -x' lib
Gilles Peskine93e4e032019-08-05 11:34:25 +02001594}
1595
Gilles Peskine8f073122018-11-27 15:58:47 +01001596component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine6d061342020-04-30 18:19:32 +02001597 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001598 scripts/config.py baremetal
1599 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine6d061342020-04-30 18:19:32 +02001600 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-Werror -Wall -Wextra' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01001601 echo "Checking that software 64-bit division is not required"
1602 if_build_succeeded not grep __aeabi_uldiv library/*.o
1603}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001604
Gilles Peskine8f073122018-11-27 15:58:47 +01001605component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine6d061342020-04-30 18:19:32 +02001606 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001607 scripts/config.py baremetal
1608 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine6d061342020-04-30 18:19:32 +02001609 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-Werror -O1 -march=armv6-m -mthumb' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01001610 echo "Checking that software 64-bit multiplication is not required"
1611 if_build_succeeded not grep __aeabi_lmul library/*.o
1612}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001613
Gilles Peskine8f073122018-11-27 15:58:47 +01001614component_build_armcc () {
1615 msg "build: ARM Compiler 5, make"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001616 scripts/config.py baremetal
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001617
Gilles Peskinebca6ab92017-12-19 18:24:31 +01001618 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
1619 make clean
Andres AG87bb5772016-09-27 15:05:15 +01001620
Gilles Peskinebca6ab92017-12-19 18:24:31 +01001621 # ARM Compiler 6 - Target ARMv7-A
1622 armc6_build_test "--target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02001623
Gilles Peskinebca6ab92017-12-19 18:24:31 +01001624 # ARM Compiler 6 - Target ARMv7-M
1625 armc6_build_test "--target=arm-arm-none-eabi -march=armv7-m"
Simon Butcher940737f2017-07-23 13:42:36 +02001626
Gilles Peskinebca6ab92017-12-19 18:24:31 +01001627 # ARM Compiler 6 - Target ARMv8-A - AArch32
1628 armc6_build_test "--target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02001629
Gilles Peskinebca6ab92017-12-19 18:24:31 +01001630 # ARM Compiler 6 - Target ARMv8-M
1631 armc6_build_test "--target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02001632
Gilles Peskinebca6ab92017-12-19 18:24:31 +01001633 # ARM Compiler 6 - Target ARMv8-A - AArch64
1634 armc6_build_test "--target=aarch64-arm-none-eabi -march=armv8.2-a"
Gilles Peskine8f073122018-11-27 15:58:47 +01001635}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01001636
Manuel Pégourié-Gonnarddd8807f2020-02-26 09:56:27 +01001637component_build_ssl_hw_record_accel() {
1638 msg "build: default config with MBEDTLS_SSL_HW_RECORD_ACCEL enabled"
1639 scripts/config.pl set MBEDTLS_SSL_HW_RECORD_ACCEL
1640 make CFLAGS='-Werror -O1'
1641}
1642
Gilles Peskine8f073122018-11-27 15:58:47 +01001643component_test_allow_sha1 () {
1644 msg "build: allow SHA1 in certificates by default"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001645 scripts/config.py set MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
Gilles Peskine8f073122018-11-27 15:58:47 +01001646 make CFLAGS='-Werror -Wall -Wextra'
1647 msg "test: allow SHA1 in certificates by default"
1648 make test
1649 if_build_succeeded tests/ssl-opt.sh -f SHA-1
1650}
Gilles Peskine2a458da2017-05-12 15:26:58 +02001651
Gilles Peskine8f073122018-11-27 15:58:47 +01001652component_build_mingw () {
1653 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04001654 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra' WINDOWS_BUILD=1 lib programs
Hanno Beckere963efa2018-01-03 10:03:43 +00001655
Gilles Peskine8f073122018-11-27 15:58:47 +01001656 # note Make tests only builds the tests, but doesn't run them
Andrzej Kurek232e8f92019-10-03 03:18:01 -04001657 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror' WINDOWS_BUILD=1 tests
Gilles Peskine8f073122018-11-27 15:58:47 +01001658 make WINDOWS_BUILD=1 clean
Simon Butcher002bc622016-11-17 09:27:45 +00001659
Gilles Peskine8f073122018-11-27 15:58:47 +01001660 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04001661 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra' WINDOWS_BUILD=1 SHARED=1 lib programs
1662 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror -Wall -Wextra' WINDOWS_BUILD=1 SHARED=1 tests
Gilles Peskine8f073122018-11-27 15:58:47 +01001663 make WINDOWS_BUILD=1 clean
1664}
Jaeden Amero117b8a42019-04-17 15:19:26 +01001665support_build_mingw() {
1666 case $(i686-w64-mingw32-gcc -dumpversion) in
1667 [0-5]*) false;;
1668 *) true;;
1669 esac
1670}
Manuel Pégourié-Gonnard6448bce2015-02-16 17:18:36 +01001671
Gilles Peskine8f073122018-11-27 15:58:47 +01001672component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001673 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001674 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001675 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
1676 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02001677
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001678 msg "test: main suites (MSan)" # ~ 10s
1679 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001680
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001681 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine7c652162017-12-11 00:01:40 +01001682 if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001683
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001684 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001685
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001686 if [ "$MEMORY" -gt 0 ]; then
1687 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine7c652162017-12-11 00:01:40 +01001688 if_build_succeeded tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001689 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01001690}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001691
Gilles Peskine69f190e2019-01-10 00:11:42 +01001692component_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001693 msg "build: Release (clang)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001694 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
1695 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001696
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001697 msg "test: main suites valgrind (Release)"
1698 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001699
Gilles Peskine636c26a2020-03-04 20:46:15 +01001700 # Optional parts (slow; currently broken on OS X because programs don't
1701 # seem to receive signals under valgrind on OS X).
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001702 if [ "$MEMORY" -gt 0 ]; then
1703 msg "test: ssl-opt.sh --memcheck (Release)"
Gilles Peskine7c652162017-12-11 00:01:40 +01001704 if_build_succeeded tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001705 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001706
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001707 if [ "$MEMORY" -gt 1 ]; then
1708 msg "test: compat.sh --memcheck (Release)"
Gilles Peskine7c652162017-12-11 00:01:40 +01001709 if_build_succeeded tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001710 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001711
1712 if [ "$MEMORY" -gt 0 ]; then
1713 msg "test: context-info.sh --memcheck (Release)"
1714 if_build_succeeded tests/context-info.sh --memcheck
1715 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01001716}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001717
Gilles Peskine8f073122018-11-27 15:58:47 +01001718component_test_cmake_out_of_source () {
1719 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01001720 MBEDTLS_ROOT_DIR="$PWD"
1721 mkdir "$OUT_OF_SOURCE_DIR"
1722 cd "$OUT_OF_SOURCE_DIR"
1723 cmake "$MBEDTLS_ROOT_DIR"
1724 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001725
Gilles Peskine8f073122018-11-27 15:58:47 +01001726 msg "test: cmake 'out-of-source' build"
1727 make test
1728 # Test an SSL option that requires an auxiliary script in test/scripts/.
1729 # Also ensure that there are no error messages such as
1730 # "No such file or directory", which would indicate that some required
1731 # file is missing (ssl-opt.sh tolerates the absence of some files so
1732 # may exit with status 0 but emit errors).
1733 if_build_succeeded ./tests/ssl-opt.sh -f 'Fallback SCSV: beginning of list' 2>ssl-opt.err
1734 if [ -s ssl-opt.err ]; then
1735 cat ssl-opt.err >&2
1736 record_status [ ! -s ssl-opt.err ]
1737 rm ssl-opt.err
1738 fi
1739 cd "$MBEDTLS_ROOT_DIR"
1740 rm -rf "$OUT_OF_SOURCE_DIR"
1741 unset MBEDTLS_ROOT_DIR
1742}
Andres AGdc192212016-08-31 17:33:13 +01001743
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01001744component_test_cmake_as_subdirectory () {
1745 msg "build: cmake 'as-subdirectory' build"
1746 MBEDTLS_ROOT_DIR="$PWD"
1747
1748 cd programs/test/cmake_subproject
1749 cmake .
1750 make
1751 if_build_succeeded ./cmake_subproject
1752
1753 cd "$MBEDTLS_ROOT_DIR"
1754 unset MBEDTLS_ROOT_DIR
1755}
1756
Gilles Peskine8f073122018-11-27 15:58:47 +01001757component_test_zeroize () {
1758 # Test that the function mbedtls_platform_zeroize() is not optimized away by
1759 # different combinations of compilers and optimization flags by using an
1760 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
1761 # system in all cases that the script fails, so we must manually search the
1762 # output to check whether the pass string is present and no failure strings
1763 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01001764
Gilles Peskine4976e822019-01-06 19:52:22 +00001765 # Don't try to disable ASLR. We don't care about ASLR here. We do care
1766 # about a spurious message if Gdb tries and fails, so suppress that.
1767 gdb_disable_aslr=
1768 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
1769 gdb_disable_aslr='set disable-randomization off'
1770 fi
1771
Gilles Peskine8f073122018-11-27 15:58:47 +01001772 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01001773 for compiler in clang gcc; do
1774 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
1775 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine4976e822019-01-06 19:52:22 +00001776 if_build_succeeded gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
Gilles Peskine55f7c942019-01-09 22:28:21 +01001777 if_build_succeeded grep "The buffer was correctly zeroized" test_zeroize.log
1778 if_build_succeeded not grep -i "error" test_zeroize.log
1779 rm -f test_zeroize.log
1780 make clean
1781 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01001782 done
Andres Amaya Garciad0d7bf62017-10-25 09:01:31 +01001783
Gilles Peskine4976e822019-01-06 19:52:22 +00001784 unset gdb_disable_aslr
Gilles Peskine8f073122018-11-27 15:58:47 +01001785}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001786
Gilles Peskine8f073122018-11-27 15:58:47 +01001787component_check_python_files () {
1788 msg "Lint: Python scripts"
1789 record_status tests/scripts/check-python-files.sh
1790}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001791
Gilles Peskine8f073122018-11-27 15:58:47 +01001792component_check_generate_test_code () {
1793 msg "uint test: generate_test_code.py"
1794 record_status ./tests/scripts/test_generate_test_code.py
1795}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001796
1797################################################################
1798#### Termination
1799################################################################
1800
Gilles Peskine8f073122018-11-27 15:58:47 +01001801post_report () {
1802 msg "Done, cleaning up"
1803 cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001804
Gilles Peskine8f073122018-11-27 15:58:47 +01001805 final_report
1806}
1807
1808
1809
1810################################################################
1811#### Run all the things
1812################################################################
1813
Gilles Peskinee48351a2018-11-27 16:06:30 +01001814# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01001815run_component () {
Gilles Peskine608953e2019-01-02 18:57:02 +01001816 # Back up the configuration in case the component modifies it.
1817 # The cleanup function will restore it.
1818 cp -p "$CONFIG_H" "$CONFIG_BAK"
Gilles Peskineffcdeff2018-12-04 12:49:28 +01001819 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02001820 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02001821
1822 # Unconditionally create a seedfile that's sufficiently long.
1823 # Do this before each component, because a previous component may
1824 # have messed it up or shortened it.
1825 dd if=/dev/urandom of=./tests/seedfile bs=64 count=1
1826
1827 # Run the component code.
Gilles Peskine8f073122018-11-27 15:58:47 +01001828 "$@"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02001829
1830 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01001831 cleanup
Gilles Peskine8f073122018-11-27 15:58:47 +01001832}
1833
1834# Preliminary setup
1835pre_check_environment
1836pre_initialize_variables
1837pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01001838
Gilles Peskine878cf602019-01-06 20:50:38 +00001839pre_check_git
Andrzej Kurekeb508712019-02-14 07:18:59 -05001840
Gilles Peskine878cf602019-01-06 20:50:38 +00001841build_status=0
1842if [ $KEEP_GOING -eq 1 ]; then
1843 pre_setup_keep_going
Gilles Peskine92525112018-11-27 18:15:35 +01001844else
Gilles Peskine878cf602019-01-06 20:50:38 +00001845 record_status () {
1846 "$@"
1847 }
Gilles Peskine8f073122018-11-27 15:58:47 +01001848fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001849pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00001850pre_print_configuration
1851pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001852cleanup
1853
Gilles Peskinebeb3a812019-01-06 22:11:25 +00001854# Run the requested tests.
1855for component in $RUN_COMPONENTS; do
1856 run_component "component_$component"
1857done
Gilles Peskine8f073122018-11-27 15:58:47 +01001858
1859# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00001860post_report