blob: 6f473bdcd82f52b96fbb63bc026724058f00cf34 [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 Peskine60f267b2020-04-25 22:21:30 +0200141 : ${ARM_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 Peskine60f267b2020-04-25 22:21:30 +0200207 --arm-gcc-prefix=<string> Prefix for gcc as a cross-compiler for arm
208 (default: "${ARM_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100209 --armcc Run ARM Compiler builds (on by default).
Gilles Peskinea28db922019-01-10 00:05:18 +0100210 --except Exclude the COMPONENTs listed on the command line,
211 instead of running only those.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200212 --no-append-outcome Write a new outcome file and analyze it (default).
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100213 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100214 --no-force Refuse to overwrite modified files (default).
215 --no-keep-going Stop at the first error (default).
216 --no-memory No additional memory tests (default).
Gilles Peskine709346a2017-12-10 23:43:39 +0100217 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200218 --outcome-file=<path> File where test outcomes are written (not done if
219 empty; default: \$MBEDTLS_TEST_OUTCOME_FILE).
Gilles Peskine38d81652018-03-21 08:40:26 +0100220 --random-seed Use a random seed value for randomized tests (default).
Gilles Peskine709346a2017-12-10 23:43:39 +0100221 -r|--release-test Run this script in release mode. This fixes the seed value to 1.
222 -s|--seed Integer seed value to use for this test run.
223
224Tool path options:
225 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
226 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
227 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
228 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
229 --gnutls-legacy-cli=<GnuTLS_cli_path> GnuTLS client executable to use for legacy tests.
230 --gnutls-legacy-serv=<GnuTLS_serv_path> GnuTLS server executable to use for legacy tests.
231 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
232 --openssl-legacy=<OpenSSL_path> OpenSSL executable to use for legacy tests e.g. SSLv3.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100233 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100234EOF
SimonB2e23c822016-04-16 21:54:39 +0100235}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100236
237# remove built files as well as the cmake cache/config
238cleanup()
239{
Gilles Peskinea71d64c2018-03-21 12:16:57 +0100240 if [ -n "${MBEDTLS_ROOT_DIR+set}" ]; then
241 cd "$MBEDTLS_ROOT_DIR"
242 fi
243
Gilles Peskine7c652162017-12-11 00:01:40 +0100244 command make clean
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200245
Gilles Peskine31b07e22018-03-21 12:15:06 +0100246 # Remove CMake artefacts
Jaeden Amero2d0e00f2018-11-07 18:46:41 +0000247 find . -name .git -prune -o \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100248 -iname CMakeFiles -exec rm -rf {} \+ -o \
249 \( -iname cmake_install.cmake -o \
250 -iname CTestTestfile.cmake -o \
251 -iname CMakeCache.txt \) -exec rm {} \+
252 # Recover files overwritten by in-tree CMake builds
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +0000253 rm -f include/Makefile include/mbedtls/Makefile programs/*/Makefile
Gilles Peskine636c26a2020-03-04 20:46:15 +0100254 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
255 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile programs/fuzz/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200256
Jaeden Ameroab83fdf2019-06-20 17:38:22 +0100257 # Remove any artifacts from the component_test_cmake_as_subdirectory test.
258 rm -rf programs/test/cmake_subproject/build
259 rm -f programs/test/cmake_subproject/Makefile
260 rm -f programs/test/cmake_subproject/cmake_subproject
261
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200262 if [ -f "$CONFIG_BAK" ]; then
263 mv "$CONFIG_BAK" "$CONFIG_H"
264 fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100265}
266
Gilles Peskine7c652162017-12-11 00:01:40 +0100267# Executed on exit. May be redefined depending on command line options.
268final_report () {
269 :
270}
271
272fatal_signal () {
273 cleanup
274 final_report $1
275 trap - $1
276 kill -$1 $$
277}
278
279trap 'fatal_signal HUP' HUP
280trap 'fatal_signal INT' INT
281trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200282
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100283msg()
284{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100285 if [ -n "${current_component:-}" ]; then
286 current_section="${current_component#component_}: $1"
287 else
288 current_section="$1"
289 fi
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100290 echo ""
291 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100292 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000293 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100294 echo "******************************************************************"
295}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100296
Gilles Peskine8f073122018-11-27 15:58:47 +0100297armc6_build_test()
298{
299 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100300
Gilles Peskine8f073122018-11-27 15:58:47 +0100301 msg "build: ARM Compiler 6 ($FLAGS), make"
302 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
303 WARNING_CFLAGS='-xc -std=c99' make lib
304 make clean
305}
Andres AGa5cd9732016-10-17 15:23:10 +0100306
Andres AGd9eba4b2016-08-26 14:42:14 +0100307err_msg()
308{
309 echo "$1" >&2
310}
311
312check_tools()
313{
314 for TOOL in "$@"; do
Andres AG98393602017-01-31 17:04:45 +0000315 if ! `type "$TOOL" >/dev/null 2>&1`; then
Andres AGd9eba4b2016-08-26 14:42:14 +0100316 err_msg "$TOOL not found!"
317 exit 1
318 fi
319 done
320}
321
Andrzej Kurek991f9fe2018-07-02 09:08:21 -0400322check_headers_in_cpp () {
Peter Kolbus1bc1a4c2019-02-01 17:19:08 -0600323 ls include/mbedtls | grep "\.h$" >headers.txt
Andrzej Kurek991f9fe2018-07-02 09:08:21 -0400324 <programs/test/cpp_dummy_build.cpp sed -n 's/"$//; s!^#include "mbedtls/!!p' |
325 sort |
326 diff headers.txt -
327 rm headers.txt
328}
329
Gilles Peskine8f073122018-11-27 15:58:47 +0100330pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000331 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100332 all_except=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000333 no_armcc=
SimonB2e23c822016-04-16 21:54:39 +0100334
Jaeden Amero9b90f2e2018-11-02 18:34:17 +0000335 # Note that legacy options are ignored instead of being omitted from this
336 # list of options, so invocations that worked with previous version of
337 # all.sh will still run and work properly.
Gilles Peskine8f073122018-11-27 15:58:47 +0100338 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100339 case "$1" in
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200340 --append-outcome) append_outcome=1;;
Gilles Peskine60f267b2020-04-25 22:21:30 +0200341 --arm-gcc-prefix) shift; ARM_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000342 --armcc) no_armcc=;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100343 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
344 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000345 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100346 --force|-f) FORCE=1;;
347 --gnutls-cli) shift; GNUTLS_CLI="$1";;
348 --gnutls-legacy-cli) shift; GNUTLS_LEGACY_CLI="$1";;
349 --gnutls-legacy-serv) shift; GNUTLS_LEGACY_SERV="$1";;
350 --gnutls-serv) shift; GNUTLS_SERV="$1";;
351 --help|-h) usage; exit;;
352 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000353 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
354 --list-components) printf '%s\n' $SUPPORTED_COMPONENTS; exit;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100355 --memory|-m) MEMORY=1;;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200356 --no-append-outcome) append_outcome=0;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000357 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100358 --no-force) FORCE=0;;
359 --no-keep-going) KEEP_GOING=0;;
360 --no-memory) MEMORY=0;;
361 --openssl) shift; OPENSSL="$1";;
362 --openssl-legacy) shift; OPENSSL_LEGACY="$1";;
363 --openssl-next) shift; OPENSSL_NEXT="$1";;
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200364 --outcome-file) shift; MBEDTLS_TEST_OUTCOME_FILE="$1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100365 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
366 --random-seed) unset SEED;;
367 --release-test|-r) SEED=1;;
368 --seed|-s) shift; SEED="$1";;
369 -*)
370 echo >&2 "Unknown option: $1"
371 echo >&2 "Run $0 --help for usage."
372 exit 120
373 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000374 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100375 esac
376 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100377 done
SimonB2e23c822016-04-16 21:54:39 +0100378
Gilles Peskinea28db922019-01-10 00:05:18 +0100379 # With no list of components, run everything.
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000380 if [ -z "$COMMAND_LINE_COMPONENTS" ]; then
381 all_except=1
Andres AGdc192212016-08-31 17:33:13 +0100382 fi
383
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000384 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
385 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100386 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000387 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
SimonB2e23c822016-04-16 21:54:39 +0100388 fi
SimonB2e23c822016-04-16 21:54:39 +0100389
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000390 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100391 RUN_COMPONENTS=
392 for component in $SUPPORTED_COMPONENTS; do
393 if is_component_included "$component"; [ $? -eq $all_except ]; then
394 RUN_COMPONENTS="$RUN_COMPONENTS $component"
395 fi
396 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000397
398 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000399 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100400}
SimonB2e23c822016-04-16 21:54:39 +0100401
Gilles Peskine8f073122018-11-27 15:58:47 +0100402pre_check_git () {
403 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100404 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100405 git checkout-index -f -q $CONFIG_H
406 cleanup
407 else
SimonB2e23c822016-04-16 21:54:39 +0100408
Gilles Peskine8f073122018-11-27 15:58:47 +0100409 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
410 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
411 echo "You can either delete this directory manually, or force the test by rerunning"
412 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
413 exit 1
414 fi
415
Gilles Peskined1174cf2019-01-09 22:30:01 +0100416 if ! git diff --quiet include/mbedtls/config.h; then
Gilles Peskine8f073122018-11-27 15:58:47 +0100417 err_msg "Warning - the configuration file 'include/mbedtls/config.h' has been edited. "
418 echo "You can either delete or preserve your work, or force the test by rerunning the"
419 echo "script as: $0 --force"
420 exit 1
421 fi
SimonB2e23c822016-04-16 21:54:39 +0100422 fi
Andrzej Kurekeb508712019-02-14 07:18:59 -0500423}
424
Gilles Peskine8f073122018-11-27 15:58:47 +0100425pre_setup_keep_going () {
Gilles Peskine7c652162017-12-11 00:01:40 +0100426 failure_summary=
427 failure_count=0
428 start_red=
429 end_color=
430 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100431 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100432 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
433 start_red=$(printf '\033[31m')
434 end_color=$(printf '\033[0m')
435 ;;
436 esac
437 fi
438 record_status () {
439 if "$@"; then
440 last_status=0
441 else
442 last_status=$?
443 text="$current_section: $* -> $last_status"
444 failure_summary="$failure_summary
445$text"
446 failure_count=$((failure_count + 1))
447 echo "${start_red}^^^^$text^^^^${end_color}"
448 fi
449 }
450 make () {
451 case "$*" in
452 *test|*check)
453 if [ $build_status -eq 0 ]; then
454 record_status command make "$@"
455 else
456 echo "(skipped because the build failed)"
457 fi
458 ;;
459 *)
460 record_status command make "$@"
461 build_status=$last_status
462 ;;
463 esac
464 }
465 final_report () {
466 if [ $failure_count -gt 0 ]; then
467 echo
468 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
469 echo "${start_red}FAILED: $failure_count${end_color}$failure_summary"
470 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Jaeden Amero7c1258d2018-07-20 16:42:14 +0100471 exit 1
Gilles Peskine7c652162017-12-11 00:01:40 +0100472 elif [ -z "${1-}" ]; then
473 echo "SUCCESS :)"
474 fi
475 if [ -n "${1-}" ]; then
476 echo "Killed by SIG$1."
477 fi
478 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100479}
480
Gilles Peskine7c652162017-12-11 00:01:40 +0100481if_build_succeeded () {
482 if [ $build_status -eq 0 ]; then
483 record_status "$@"
484 fi
485}
486
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +0200487# to be used instead of ! for commands run with
488# record_status or if_build_succeeded
489not() {
490 ! "$@"
491}
492
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200493pre_prepare_outcome_file () {
494 case "$MBEDTLS_TEST_OUTCOME_FILE" in
495 [!/]*) MBEDTLS_TEST_OUTCOME_FILE="$PWD/$MBEDTLS_TEST_OUTCOME_FILE";;
496 esac
497 if [ -n "$MBEDTLS_TEST_OUTCOME_FILE" ] && [ "$append_outcome" -eq 0 ]; then
498 rm -f "$MBEDTLS_TEST_OUTCOME_FILE"
499 fi
500}
501
Gilles Peskine8f073122018-11-27 15:58:47 +0100502pre_print_configuration () {
503 msg "info: $0 configuration"
504 echo "MEMORY: $MEMORY"
505 echo "FORCE: $FORCE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200506 echo "MBEDTLS_TEST_OUTCOME_FILE: ${MBEDTLS_TEST_OUTCOME_FILE:-(none)}"
Gilles Peskine8f073122018-11-27 15:58:47 +0100507 echo "SEED: ${SEED-"UNSET"}"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100508 echo
Gilles Peskine8f073122018-11-27 15:58:47 +0100509 echo "OPENSSL: $OPENSSL"
510 echo "OPENSSL_LEGACY: $OPENSSL_LEGACY"
511 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
512 echo "GNUTLS_CLI: $GNUTLS_CLI"
513 echo "GNUTLS_SERV: $GNUTLS_SERV"
514 echo "GNUTLS_LEGACY_CLI: $GNUTLS_LEGACY_CLI"
515 echo "GNUTLS_LEGACY_SERV: $GNUTLS_LEGACY_SERV"
516 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
517 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
518}
Andres AG7770ea82016-10-10 15:46:20 +0100519
Andres AGd9eba4b2016-08-26 14:42:14 +0100520# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100521pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000522 # Build the list of variables to pass to output_env.sh.
523 set env
SimonB2e23c822016-04-16 21:54:39 +0100524
Gilles Peskine87964262019-01-06 22:40:00 +0000525 case " $RUN_COMPONENTS " in
526 # Require OpenSSL and GnuTLS if running any tests (as opposed to
527 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
528 # is a good enough approximation in practice.
529 *" test_"*)
530 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
531 # and ssl-opt.sh, we just export the variables they require.
532 export OPENSSL_CMD="$OPENSSL"
533 export GNUTLS_CLI="$GNUTLS_CLI"
534 export GNUTLS_SERV="$GNUTLS_SERV"
535 # Avoid passing --seed flag in every call to ssl-opt.sh
536 if [ -n "${SEED-}" ]; then
537 export SEED
538 fi
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000539 set "$@" OPENSSL="$OPENSSL" OPENSSL_LEGACY="$OPENSSL_LEGACY"
540 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
541 set "$@" GNUTLS_LEGACY_CLI="$GNUTLS_LEGACY_CLI"
542 set "$@" GNUTLS_LEGACY_SERV="$GNUTLS_LEGACY_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000543 check_tools "$OPENSSL" "$OPENSSL_LEGACY" "$OPENSSL_NEXT" \
544 "$GNUTLS_CLI" "$GNUTLS_SERV" \
545 "$GNUTLS_LEGACY_CLI" "$GNUTLS_LEGACY_SERV"
546 ;;
547 esac
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200548
Gilles Peskine87964262019-01-06 22:40:00 +0000549 case " $RUN_COMPONENTS " in
550 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
551 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100552
Gilles Peskine87964262019-01-06 22:40:00 +0000553 case " $RUN_COMPONENTS " in
Gilles Peskine60f267b2020-04-25 22:21:30 +0200554 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000555 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100556
Gilles Peskine87964262019-01-06 22:40:00 +0000557 case " $RUN_COMPONENTS " in
558 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
559 esac
560
561 case " $RUN_COMPONENTS " in
562 *" test_zeroize "*) check_tools "gdb";;
563 esac
564
565 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000566 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000567 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
568 ARMC5_AR="$ARMC5_BIN_DIR/armar"
569 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
570 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000571 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC6_CC" "$ARMC6_AR";;
572 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000573
574 msg "info: output_env.sh"
575 case $RUN_COMPONENTS in
576 *_armcc*)
577 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
578 *) set "$@" RUN_ARMCC=0;;
579 esac
580 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100581}
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100582
Gilles Peskine192c72f2017-12-21 15:59:21 +0100583
584
585################################################################
586#### Basic checks
587################################################################
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100588
589#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200590# Test Suites to be executed
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100591#
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +0100592# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200593# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100594# 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 +0200595# time, so start with a GCC build).
596# 2. Minimize total running time, by avoiding useless rebuilds
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100597#
Manuel Pégourié-Gonnard259b08a2016-01-08 16:27:41 +0100598# Indicative running times are given for reference.
599
Gilles Peskine8f073122018-11-27 15:58:47 +0100600component_check_recursion () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200601 msg "Check: recursion.pl" # < 1s
Gilles Peskine8f073122018-11-27 15:58:47 +0100602 record_status tests/scripts/recursion.pl library/*.c
603}
Janos Follathb72c6782016-07-19 14:54:17 +0100604
Gilles Peskine8f073122018-11-27 15:58:47 +0100605component_check_generated_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200606 msg "Check: freshness of generated source files" # < 1s
Gilles Peskine8f073122018-11-27 15:58:47 +0100607 record_status tests/scripts/check-generated-files.sh
608}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200609
Gilles Peskine8f073122018-11-27 15:58:47 +0100610component_check_doxy_blocks () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200611 msg "Check: doxygen markup outside doxygen blocks" # < 1s
Gilles Peskine8f073122018-11-27 15:58:47 +0100612 record_status tests/scripts/check-doxy-blocks.pl
613}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200614
Gilles Peskine8f073122018-11-27 15:58:47 +0100615component_check_files () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200616 msg "Check: file sanity checks (permissions, encodings)" # < 1s
Gilles Peskine8f073122018-11-27 15:58:47 +0100617 record_status tests/scripts/check-files.py
618}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200619
Gilles Peskine8f073122018-11-27 15:58:47 +0100620component_check_names () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200621 msg "Check: declared and exported names (builds the library)" # < 3s
Gilles Peskine13f97dc2019-05-15 17:52:22 +0200622 record_status tests/scripts/check-names.sh -v
Gilles Peskine8f073122018-11-27 15:58:47 +0100623}
Darryl Greena07039c2018-03-13 16:48:16 +0000624
Gilles Peskine895868b2019-09-19 21:30:05 +0200625component_check_test_cases () {
626 msg "Check: test case descriptions" # < 1s
627 record_status tests/scripts/check-test-cases.py
628}
629
Gilles Peskine8f073122018-11-27 15:58:47 +0100630component_check_doxygen_warnings () {
Gilles Peskine600bb692019-09-19 21:29:11 +0200631 msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
Gilles Peskine8f073122018-11-27 15:58:47 +0100632 record_status tests/scripts/doxygen.sh
633}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200634
Gilles Peskine192c72f2017-12-21 15:59:21 +0100635
Gilles Peskine636c26a2020-03-04 20:46:15 +0100636
Gilles Peskine192c72f2017-12-21 15:59:21 +0100637################################################################
638#### Build and test many configurations and targets
639################################################################
640
Gilles Peskine7832c9f2019-04-08 17:00:15 +0200641component_test_default_out_of_box () {
642 msg "build: make, default config (out-of-box)" # ~1min
643 make
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200644 # Disable fancy stuff
Gilles Peskine717cd762019-09-27 20:21:11 +0200645 SAVE_MBEDTLS_TEST_OUTCOME_FILE="$MBEDTLS_TEST_OUTCOME_FILE"
Gilles Peskine67ffdaf2019-09-16 15:55:46 +0200646 unset MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +0200647
648 msg "test: main suites make, default config (out-of-box)" # ~10s
649 make test
650
651 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine97bea012020-04-23 23:37:45 +0200652 if_build_succeeded programs/test/selftest
Gilles Peskine717cd762019-09-27 20:21:11 +0200653
654 export MBEDTLS_TEST_OUTCOME_FILE="$SAVE_MBEDTLS_TEST_OUTCOME_FILE"
655 unset SAVE_MBEDTLS_TEST_OUTCOME_FILE
Gilles Peskine7832c9f2019-04-08 17:00:15 +0200656}
657
Gilles Peskine8f073122018-11-27 15:58:47 +0100658component_test_default_cmake_gcc_asan () {
659 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +0100660 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
661 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200662
Gilles Peskine8f073122018-11-27 15:58:47 +0100663 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
664 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200665
Gilles Peskine97bea012020-04-23 23:37:45 +0200666 msg "test: selftest (ASan build)" # ~ 10s
667 if_build_succeeded programs/test/selftest
668
Gilles Peskine8f073122018-11-27 15:58:47 +0100669 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
670 if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200671
Gilles Peskine8f073122018-11-27 15:58:47 +0100672 msg "test: compat.sh (ASan build)" # ~ 6 min
673 if_build_succeeded tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +0200674
675 msg "test: context-info.sh (ASan build)" # ~ 15 sec
676 if_build_succeeded tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100677}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200678
Hanno Becker01635512019-02-26 14:27:09 +0000679component_test_full_cmake_gcc_asan () {
680 msg "build: full config, cmake, gcc, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200681 scripts/config.py full
Hanno Becker01635512019-02-26 14:27:09 +0000682 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
683 make
684
685 msg "test: main suites (inc. selftests) (full config, ASan build)"
686 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +0100687
Gilles Peskine97bea012020-04-23 23:37:45 +0200688 msg "test: selftest (ASan build)" # ~ 10s
689 if_build_succeeded programs/test/selftest
690
Gilles Peskine636c26a2020-03-04 20:46:15 +0100691 msg "test: ssl-opt.sh (full config, ASan build)"
692 if_build_succeeded tests/ssl-opt.sh
693
694 msg "test: compat.sh (full config, ASan build)"
695 if_build_succeeded tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +0200696
697 msg "test: context-info.sh (full config, ASan build)" # ~ 15 sec
698 if_build_succeeded tests/context-info.sh
Gilles Peskine636c26a2020-03-04 20:46:15 +0100699}
700
701component_test_zlib_make() {
702 msg "build: zlib enabled, make"
703 scripts/config.py set MBEDTLS_ZLIB_SUPPORT
704 make ZLIB=1 CFLAGS='-Werror -O1'
705
706 msg "test: main suites (zlib, make)"
707 make test
708
709 msg "test: ssl-opt.sh (zlib, make)"
710 if_build_succeeded tests/ssl-opt.sh
711}
712support_test_zlib_make () {
713 base=support_test_zlib_$$
714 cat <<'EOF' > ${base}.c
715#include "zlib.h"
716int main(void) { return 0; }
717EOF
718 gcc -o ${base}.exe ${base}.c -lz 2>/dev/null
719 ret=$?
720 rm -f ${base}.*
721 return $ret
722}
723
724component_test_zlib_cmake() {
725 msg "build: zlib enabled, cmake"
726 scripts/config.py set MBEDTLS_ZLIB_SUPPORT
727 cmake -D ENABLE_ZLIB_SUPPORT=On -D CMAKE_BUILD_TYPE:String=Check .
728 make
729
730 msg "test: main suites (zlib, cmake)"
731 make test
732
733 msg "test: ssl-opt.sh (zlib, cmake)"
734 if_build_succeeded tests/ssl-opt.sh
735}
736support_test_zlib_cmake () {
737 support_test_zlib_make "$@"
Manuel Pégourié-Gonnardf2e29022020-01-24 10:17:20 +0100738}
Manuel Pégourié-Gonnard95e04492020-01-02 11:45:12 +0100739
Gilles Peskine782f4112018-11-27 16:11:09 +0100740component_test_ref_configs () {
741 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
742 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
743 record_status tests/scripts/test-ref-configs.pl
744}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200745
Gilles Peskine8f073122018-11-27 15:58:47 +0100746component_test_sslv3 () {
747 msg "build: Default + SSLv3 (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200748 scripts/config.py set MBEDTLS_SSL_PROTO_SSL3
Gilles Peskine8f073122018-11-27 15:58:47 +0100749 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
750 make
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200751
Gilles Peskine8f073122018-11-27 15:58:47 +0100752 msg "test: SSLv3 - main suites (inc. selftests) (ASan build)" # ~ 50s
753 make test
Simon Butcher3ea7f522016-03-07 23:22:10 +0000754
Gilles Peskine8f073122018-11-27 15:58:47 +0100755 msg "build: SSLv3 - compat.sh (ASan build)" # ~ 6 min
756 if_build_succeeded tests/compat.sh -m 'tls1 tls1_1 tls1_2 dtls1 dtls1_2'
757 if_build_succeeded env OPENSSL_CMD="$OPENSSL_LEGACY" tests/compat.sh -m 'ssl3'
Simon Butcher3ea7f522016-03-07 23:22:10 +0000758
Gilles Peskine8f073122018-11-27 15:58:47 +0100759 msg "build: SSLv3 - ssl-opt.sh (ASan build)" # ~ 6 min
760 if_build_succeeded tests/ssl-opt.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +0200761
762 msg "build: SSLv3 - context-info.sh (ASan build)" # ~ 15 sec
763 if_build_succeeded tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100764}
Simon Butcher3ea7f522016-03-07 23:22:10 +0000765
Gilles Peskine8f073122018-11-27 15:58:47 +0100766component_test_no_renegotiation () {
767 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200768 scripts/config.py unset MBEDTLS_SSL_RENEGOTIATION
Gilles Peskine8f073122018-11-27 15:58:47 +0100769 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
770 make
Simon Butcher3ea7f522016-03-07 23:22:10 +0000771
Gilles Peskine8f073122018-11-27 15:58:47 +0100772 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
773 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +0100774
Gilles Peskine8f073122018-11-27 15:58:47 +0100775 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
776 if_build_succeeded tests/ssl-opt.sh
777}
Hanno Becker134c2ab2017-10-12 15:29:50 +0100778
Gilles Peskine636c26a2020-03-04 20:46:15 +0100779component_test_no_pem_no_fs () {
780 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
781 scripts/config.py unset MBEDTLS_PEM_PARSE_C
782 scripts/config.py unset MBEDTLS_FS_IO
783 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C # requires a filesystem
784 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA ITS
785 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
786 make
787
788 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
789 make test
790
791 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
792 if_build_succeeded tests/ssl-opt.sh
793}
794
Gilles Peskine8f073122018-11-27 15:58:47 +0100795component_test_rsa_no_crt () {
796 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200797 scripts/config.py set MBEDTLS_RSA_NO_CRT
Gilles Peskine8f073122018-11-27 15:58:47 +0100798 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
799 make
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +0100800
Gilles Peskine8f073122018-11-27 15:58:47 +0100801 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
802 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100803
Gilles Peskine8f073122018-11-27 15:58:47 +0100804 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
805 if_build_succeeded tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100806
Gilles Peskine8f073122018-11-27 15:58:47 +0100807 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
808 if_build_succeeded tests/compat.sh -t RSA
Piotr Nowicki9978e6e2020-04-07 16:07:05 +0200809
810 msg "test: RSA_NO_CRT - RSA-related part of context-info.sh (ASan build)" # ~ 15 sec
811 if_build_succeeded tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100812}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100813
Gilles Peskine636c26a2020-03-04 20:46:15 +0100814component_test_new_ecdh_context () {
815 msg "build: new ECDH context (ASan build)" # ~ 6 min
816 scripts/config.py unset MBEDTLS_ECDH_LEGACY_CONTEXT
817 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
818 make
819
820 msg "test: new ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
821 make test
822
823 msg "test: new ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
824 if_build_succeeded tests/ssl-opt.sh -f ECDH
825
826 msg "test: new ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
827 # Exclude some symmetric ciphers that are redundant here to gain time.
828 if_build_succeeded tests/compat.sh -f ECDH -V NO -e 'ARCFOUR\|ARIA\|CAMELLIA\|CHACHA\|DES\|RC4'
829}
830
831component_test_everest () {
832 msg "build: Everest ECDH context (ASan build)" # ~ 6 min
833 scripts/config.py unset MBEDTLS_ECDH_LEGACY_CONTEXT
834 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
835 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Asan .
836 make
837
838 msg "test: Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
839 make test
840
841 msg "test: Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
842 if_build_succeeded tests/ssl-opt.sh -f ECDH
843
844 msg "test: Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
845 # Exclude some symmetric ciphers that are redundant here to gain time.
846 if_build_succeeded tests/compat.sh -f ECDH -V NO -e 'ARCFOUR\|ARIA\|CAMELLIA\|CHACHA\|DES\|RC4'
847}
848
Gilles Peskine8f073122018-11-27 15:58:47 +0100849component_test_small_ssl_out_content_len () {
850 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200851 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
852 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Gilles Peskine8f073122018-11-27 15:58:47 +0100853 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
854 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100855
Gilles Peskine8f073122018-11-27 15:58:47 +0100856 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
857 if_build_succeeded tests/ssl-opt.sh -f "Max fragment\|Large packet"
858}
Angus Grattonc4dd0732018-04-11 16:28:39 +1000859
Gilles Peskine8f073122018-11-27 15:58:47 +0100860component_test_small_ssl_in_content_len () {
861 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200862 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 4096
863 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Gilles Peskine8f073122018-11-27 15:58:47 +0100864 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
865 make
Angus Grattonc4dd0732018-04-11 16:28:39 +1000866
Gilles Peskine8f073122018-11-27 15:58:47 +0100867 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
868 if_build_succeeded tests/ssl-opt.sh -f "Max fragment"
869}
Angus Grattonc4dd0732018-04-11 16:28:39 +1000870
Gilles Peskine8f073122018-11-27 15:58:47 +0100871component_test_small_ssl_dtls_max_buffering () {
872 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200873 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
Gilles Peskine8f073122018-11-27 15:58:47 +0100874 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
875 make
Angus Grattonc4dd0732018-04-11 16:28:39 +1000876
Gilles Peskine8f073122018-11-27 15:58:47 +0100877 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
878 if_build_succeeded tests/ssl-opt.sh -f "DTLS reordering: Buffer out-of-order hs msg before reassembling next, free buffered msg"
879}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +0100880
Gilles Peskine8f073122018-11-27 15:58:47 +0100881component_test_small_mbedtls_ssl_dtls_max_buffering () {
882 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine636c26a2020-03-04 20:46:15 +0100883 scripts/config.py set MBEDTLS_SSL_DTLS_MAX_BUFFERING 190
Gilles Peskine8f073122018-11-27 15:58:47 +0100884 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
885 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +0100886
Gilles Peskine8f073122018-11-27 15:58:47 +0100887 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
888 if_build_succeeded tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
889}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +0100890
Gilles Peskine75cc7712019-09-06 19:47:17 +0200891component_test_psa_collect_statuses () {
892 msg "build+test: psa_collect_statuses" # ~30s
Gilles Peskine3bdd4122019-07-27 23:52:53 +0200893 scripts/config.py full
Gilles Peskine75cc7712019-09-06 19:47:17 +0200894 record_status tests/scripts/psa_collect_statuses.py
895 # Check that psa_crypto_init() succeeded at least once
896 record_status grep -q '^0:psa_crypto_init:' tests/statuses.log
897 rm -f tests/statuses.log
898}
899
Gilles Peskine8f073122018-11-27 15:58:47 +0100900component_test_full_cmake_clang () {
901 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200902 scripts/config.py full
Gilles Peskine8f073122018-11-27 15:58:47 +0100903 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Check -D ENABLE_TESTING=On .
904 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +0100905
k-stachowiak0291cb72019-06-26 15:52:12 +0200906 msg "test: main suites (full config, clang)" # ~ 5s
Gilles Peskine8f073122018-11-27 15:58:47 +0100907 make test
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100908
k-stachowiak0291cb72019-06-26 15:52:12 +0200909 msg "test: psa_constant_names (full config, clang)" # ~ 1s
Darryl Green45010a32019-02-06 13:43:58 +0000910 record_status tests/scripts/test_psa_constant_names.py
Gilles Peskine69e8f7f2020-02-26 19:51:43 +0100911
Gilles Peskine8f073122018-11-27 15:58:47 +0100912 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
913 if_build_succeeded tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200914
Andres Amaya Garcia2dadab72019-01-08 21:42:27 +0000915 msg "test: compat.sh RC4, DES, 3DES & NULL (full config)" # ~ 2 min
Andres Amaya Garcia419bd002019-02-19 20:20:57 +0000916 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 +0200917
Gilles Peskine8f073122018-11-27 15:58:47 +0100918 msg "test: compat.sh ARIA + ChachaPoly"
919 if_build_succeeded env OPENSSL_CMD="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
920}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200921
Gilles Peskine8f073122018-11-27 15:58:47 +0100922component_build_deprecated () {
923 msg "build: make, full config + DEPRECATED_WARNING, gcc -O" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200924 scripts/config.py full
925 scripts/config.py set MBEDTLS_DEPRECATED_WARNING
Gilles Peskine8f073122018-11-27 15:58:47 +0100926 # Build with -O -Wextra to catch a maximum of issues.
927 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra' lib programs
928 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-unused-function' tests
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100929
Gilles Peskine841b14b2019-11-26 17:37:37 +0100930 msg "test: make, full config + DEPRECATED_WARNING, expect warnings" # ~ 30s
931 make -C tests clean
932 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-error=deprecated-declarations -DMBEDTLS_TEST_DEPRECATED' tests
933
Gilles Peskine8f073122018-11-27 15:58:47 +0100934 msg "build: make, full config + DEPRECATED_REMOVED, clang -O" # ~ 30s
935 # No cleanup, just tweak the configuration and rebuild
936 make clean
Gilles Peskine5d46f6a2019-07-27 23:52:53 +0200937 scripts/config.py unset MBEDTLS_DEPRECATED_WARNING
938 scripts/config.py set MBEDTLS_DEPRECATED_REMOVED
Gilles Peskine8f073122018-11-27 15:58:47 +0100939 # Build with -O -Wextra to catch a maximum of issues.
940 make CC=clang CFLAGS='-O -Werror -Wall -Wextra' lib programs
941 make CC=clang CFLAGS='-O -Werror -Wall -Wextra -Wno-unused-function' tests
942}
Jaeden Ameroed93bdc2018-11-02 16:57:24 +0000943
Gilles Peskineec541fe2020-01-31 14:24:14 +0100944# Check that the specified libraries exist and are empty.
945are_empty_libraries () {
946 nm "$@" >/dev/null 2>/dev/null
947 ! nm "$@" 2>/dev/null | grep -v ':$' | grep .
948}
949
950component_build_crypto_default () {
951 msg "build: make, crypto only"
952 scripts/config.py crypto
Gilles Peskine6bb39152020-02-03 11:59:20 +0100953 make CFLAGS='-O1 -Werror'
Gilles Peskineec541fe2020-01-31 14:24:14 +0100954 if_build_succeeded are_empty_libraries library/libmbedx509.* library/libmbedtls.*
955}
956
957component_build_crypto_full () {
958 msg "build: make, crypto only, full config"
959 scripts/config.py crypto_full
Gilles Peskine6bb39152020-02-03 11:59:20 +0100960 make CFLAGS='-O1 -Werror'
Gilles Peskineec541fe2020-01-31 14:24:14 +0100961 if_build_succeeded are_empty_libraries library/libmbedx509.* library/libmbedtls.*
962}
963
964component_build_crypto_baremetal () {
965 msg "build: make, crypto only, baremetal config"
966 scripts/config.py crypto_baremetal
Gilles Peskine6bb39152020-02-03 11:59:20 +0100967 make CFLAGS='-O1 -Werror'
Gilles Peskineec541fe2020-01-31 14:24:14 +0100968 if_build_succeeded are_empty_libraries library/libmbedx509.* library/libmbedtls.*
969}
970
Gilles Peskine8f073122018-11-27 15:58:47 +0100971component_test_depends_curves () {
972 msg "test/build: curves.pl (gcc)" # ~ 4 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100973 record_status tests/scripts/curves.pl
974}
Jaeden Ameroacaabe72018-11-07 11:52:52 +0000975
Gilles Peskine8f073122018-11-27 15:58:47 +0100976component_test_depends_hashes () {
977 msg "test/build: depends-hashes.pl (gcc)" # ~ 2 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100978 record_status tests/scripts/depends-hashes.pl
979}
Jaeden Ameroacaabe72018-11-07 11:52:52 +0000980
Gilles Peskine8f073122018-11-27 15:58:47 +0100981component_test_depends_pkalgs () {
982 msg "test/build: depends-pkalgs.pl (gcc)" # ~ 2 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100983 record_status tests/scripts/depends-pkalgs.pl
984}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +0100985
Gilles Peskine8f073122018-11-27 15:58:47 +0100986component_build_key_exchanges () {
987 msg "test/build: key-exchanges (gcc)" # ~ 1 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100988 record_status tests/scripts/key-exchanges.pl
989}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +0100990
Gilles Peskine8f073122018-11-27 15:58:47 +0100991component_build_default_make_gcc_and_cxx () {
992 msg "build: Unix make, -Os (gcc)" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +0100993 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os'
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +0100994
Gilles Peskine8f073122018-11-27 15:58:47 +0100995 msg "test: verify header list in cpp_dummy_build.cpp"
996 record_status check_headers_in_cpp
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +0100997
Gilles Peskine8f073122018-11-27 15:58:47 +0100998 msg "build: Unix make, incremental g++"
999 make TEST_CPP=1
1000}
Manuel Pégourié-Gonnard655c0a82018-10-30 11:20:45 +01001001
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001002component_test_no_use_psa_crypto_full_cmake_asan() {
1003 # full minus MBEDTLS_USE_PSA_CRYPTO: run the same set of tests as basic-build-test.sh
Gilles Peskinedc3a1792019-09-03 11:42:04 +02001004 msg "build: cmake, full config minus MBEDTLS_USE_PSA_CRYPTO, ASan"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001005 scripts/config.py full
1006 scripts/config.py set MBEDTLS_ECP_RESTARTABLE # not using PSA, so enable restartable ECC
1007 scripts/config.py unset MBEDTLS_PSA_CRYPTO_C
1008 scripts/config.py unset MBEDTLS_USE_PSA_CRYPTO
1009 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
1010 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Manuel Pégourié-Gonnardd8167e82019-02-01 11:12:52 +01001011 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Andrzej Kurekde5a0072019-02-01 07:03:03 -05001012 make
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02001013
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001014 msg "test: main suites (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05001015 make test
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02001016
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001017 msg "test: ssl-opt.sh (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05001018 if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001019
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001020 msg "test: compat.sh default (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05001021 if_build_succeeded tests/compat.sh
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04001022
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001023 msg "test: compat.sh RC4, DES & NULL (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05001024 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 -05001025
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001026 msg "test: compat.sh ARIA + ChachaPoly (full minus MBEDTLS_USE_PSA_CRYPTO)"
Andrzej Kurekde5a0072019-02-01 07:03:03 -05001027 if_build_succeeded env OPENSSL_CMD="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
1028}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001029
Gilles Peskineadcde5e2019-06-12 16:05:50 +02001030component_test_check_params_functionality () {
1031 msg "build+test: MBEDTLS_CHECK_PARAMS functionality"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001032 scripts/config.py full # includes CHECK_PARAMS
Gilles Peskineadcde5e2019-06-12 16:05:50 +02001033 # Make MBEDTLS_PARAM_FAILED call mbedtls_param_failed().
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001034 scripts/config.py unset MBEDTLS_CHECK_PARAMS_ASSERT
Gilles Peskineadcde5e2019-06-12 16:05:50 +02001035 # Only build and run tests. Do not build sample programs, because
1036 # they don't have a mbedtls_param_failed() function.
1037 make CC=gcc CFLAGS='-Werror -O1' lib test
1038}
1039
Gilles Peskineb28636b2019-01-02 19:06:24 +01001040component_test_check_params_without_platform () {
1041 msg "build+test: MBEDTLS_CHECK_PARAMS without MBEDTLS_PLATFORM_C"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001042 scripts/config.py full # includes CHECK_PARAMS
Gilles Peskineadcde5e2019-06-12 16:05:50 +02001043 # Keep MBEDTLS_PARAM_FAILED as assert.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001044 scripts/config.py unset MBEDTLS_PLATFORM_EXIT_ALT
1045 scripts/config.py unset MBEDTLS_PLATFORM_TIME_ALT
1046 scripts/config.py unset MBEDTLS_PLATFORM_FPRINTF_ALT
1047 scripts/config.py unset MBEDTLS_PLATFORM_MEMORY
1048 scripts/config.py unset MBEDTLS_PLATFORM_PRINTF_ALT
1049 scripts/config.py unset MBEDTLS_PLATFORM_SNPRINTF_ALT
1050 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1051 scripts/config.py unset MBEDTLS_PLATFORM_C
Gilles Peskineb28636b2019-01-02 19:06:24 +01001052 make CC=gcc CFLAGS='-Werror -O1' all test
1053}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001054
Gilles Peskineb28636b2019-01-02 19:06:24 +01001055component_test_check_params_silent () {
1056 msg "build+test: MBEDTLS_CHECK_PARAMS with alternative MBEDTLS_PARAM_FAILED()"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001057 scripts/config.py full # includes CHECK_PARAMS
Gilles Peskineadcde5e2019-06-12 16:05:50 +02001058 # Set MBEDTLS_PARAM_FAILED to nothing.
Gilles Peskineb28636b2019-01-02 19:06:24 +01001059 sed -i 's/.*\(#define MBEDTLS_PARAM_FAILED( cond )\).*/\1/' "$CONFIG_H"
1060 make CC=gcc CFLAGS='-Werror -O1' all test
1061}
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001062
Gilles Peskine8f073122018-11-27 15:58:47 +01001063component_test_no_platform () {
1064 # Full configuration build, without platform support, file IO and net sockets.
1065 # This should catch missing mbedtls_printf definitions, and by disabling file
1066 # IO, it should catch missing '#include <stdio.h>'
1067 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001068 scripts/config.py full
1069 scripts/config.py unset MBEDTLS_PLATFORM_C
1070 scripts/config.py unset MBEDTLS_NET_C
1071 scripts/config.py unset MBEDTLS_PLATFORM_MEMORY
1072 scripts/config.py unset MBEDTLS_PLATFORM_PRINTF_ALT
1073 scripts/config.py unset MBEDTLS_PLATFORM_FPRINTF_ALT
1074 scripts/config.py unset MBEDTLS_PLATFORM_SNPRINTF_ALT
1075 scripts/config.py unset MBEDTLS_PLATFORM_TIME_ALT
1076 scripts/config.py unset MBEDTLS_PLATFORM_EXIT_ALT
1077 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1078 scripts/config.py unset MBEDTLS_FS_IO
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001079 scripts/config.py unset MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001080 scripts/config.py unset MBEDTLS_PSA_CRYPTO_STORAGE_C
1081 scripts/config.py unset MBEDTLS_PSA_ITS_FILE_C
Gilles Peskine8f073122018-11-27 15:58:47 +01001082 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
1083 # to re-enable platform integration features otherwise disabled in C99 builds
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02001084 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
1085 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Gilles Peskine8f073122018-11-27 15:58:47 +01001086}
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00001087
Gilles Peskine8f073122018-11-27 15:58:47 +01001088component_build_no_std_function () {
1089 # catch compile bugs in _uninit functions
1090 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001091 scripts/config.py full
1092 scripts/config.py set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
1093 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02001094 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os'
Gilles Peskine8f073122018-11-27 15:58:47 +01001095}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +01001096
Gilles Peskine8f073122018-11-27 15:58:47 +01001097component_build_no_ssl_srv () {
1098 msg "build: full config except ssl_srv.c, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001099 scripts/config.py full
1100 scripts/config.py unset MBEDTLS_SSL_SRV_C
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02001101 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01001102}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02001103
Gilles Peskine8f073122018-11-27 15:58:47 +01001104component_build_no_ssl_cli () {
1105 msg "build: full config except ssl_cli.c, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001106 scripts/config.py full
1107 scripts/config.py unset MBEDTLS_SSL_CLI_C
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02001108 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01001109}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02001110
Gilles Peskine8f073122018-11-27 15:58:47 +01001111component_build_no_sockets () {
1112 # Note, C99 compliance can also be tested with the sockets support disabled,
1113 # as that requires a POSIX platform (which isn't the same as C99).
1114 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001115 scripts/config.py full
1116 scripts/config.py unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
1117 scripts/config.py set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
Gilles Peskine6ec0f0f2019-09-20 19:23:10 +02001118 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01001119}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02001120
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04001121component_test_memory_buffer_allocator_backtrace () {
1122 msg "build: default config with memory buffer allocator and backtrace enabled"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001123 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
1124 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
1125 scripts/config.py set MBEDTLS_MEMORY_BACKTRACE
1126 scripts/config.py set MBEDTLS_MEMORY_DEBUG
Andrzej Kurek69f20aa2019-09-05 09:27:47 -04001127 CC=gcc cmake .
1128 make
1129
1130 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
1131 make test
1132}
1133
1134component_test_memory_buffer_allocator () {
1135 msg "build: default config with memory buffer allocator"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001136 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
1137 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
Hanno Becker0fb9ba22019-02-26 14:34:13 +00001138 CC=gcc cmake .
1139 make
1140
1141 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
1142 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001143
1144 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
1145 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
1146 if_build_succeeded tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker0fb9ba22019-02-26 14:34:13 +00001147}
1148
Gilles Peskine8f073122018-11-27 15:58:47 +01001149component_test_no_max_fragment_length () {
1150 # Run max fragment length tests with MFL disabled
1151 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001152 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskine8f073122018-11-27 15:58:47 +01001153 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1154 make
Hanno Becker5175ac62017-09-18 15:36:25 +01001155
Gilles Peskine8f073122018-11-27 15:58:47 +01001156 msg "test: ssl-opt.sh, MFL-related tests"
1157 if_build_succeeded tests/ssl-opt.sh -f "Max fragment length"
1158}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001159
Hanno Becker545ced42019-02-19 11:10:48 +00001160component_test_asan_remove_peer_certificate () {
1161 msg "build: default config with MBEDTLS_SSL_KEEP_PEER_CERTIFICATE disabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001162 scripts/config.py unset MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Hanno Becker545ced42019-02-19 11:10:48 +00001163 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1164 make
1165
1166 msg "test: !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
1167 make test
1168
1169 msg "test: ssl-opt.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
1170 if_build_succeeded tests/ssl-opt.sh
1171
1172 msg "test: compat.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
1173 if_build_succeeded tests/compat.sh
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001174
1175 msg "test: context-info.sh, !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE"
1176 if_build_succeeded tests/context-info.sh
Hanno Becker545ced42019-02-19 11:10:48 +00001177}
1178
Gilles Peskine8f073122018-11-27 15:58:47 +01001179component_test_no_max_fragment_length_small_ssl_out_content_len () {
1180 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001181 scripts/config.py unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
1182 scripts/config.py set MBEDTLS_SSL_IN_CONTENT_LEN 16384
1183 scripts/config.py set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
Gilles Peskine8f073122018-11-27 15:58:47 +01001184 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1185 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10001186
Gilles Peskine8f073122018-11-27 15:58:47 +01001187 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
1188 if_build_succeeded tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001189
1190 msg "test: context-info.sh (disabled MFL extension case)"
1191 if_build_succeeded tests/context-info.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001192}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001193
Darryl Greenaad82f92019-12-02 10:53:11 +00001194component_test_variable_ssl_in_out_buffer_len () {
1195 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled (ASan build)"
1196 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1197 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1198 make
1199
1200 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
1201 make test
1202
1203 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
1204 if_build_succeeded tests/ssl-opt.sh
1205
1206 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH enabled"
1207 if_build_succeeded tests/compat.sh
1208}
1209
1210component_test_variable_ssl_in_out_buffer_len_CID () {
1211 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_DTLS_CONNECTION_ID enabled (ASan build)"
1212 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1213 scripts/config.py set MBEDTLS_SSL_DTLS_CONNECTION_ID
1214
1215 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1216 make
1217
1218 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_DTLS_CONNECTION_ID"
1219 make test
1220
1221 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_DTLS_CONNECTION_ID enabled"
1222 if_build_succeeded tests/ssl-opt.sh
1223
1224 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_DTLS_CONNECTION_ID enabled"
1225 if_build_succeeded tests/compat.sh
1226}
1227
1228component_test_variable_ssl_in_out_buffer_len_record_splitting () {
1229 msg "build: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_CBC_RECORD_SPLITTING enabled (ASan build)"
1230 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1231 scripts/config.py set MBEDTLS_SSL_CBC_RECORD_SPLITTING
1232
1233 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1234 make
1235
1236 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_CBC_RECORD_SPLITTING"
1237 make test
1238
1239 msg "test: ssl-opt.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_CBC_RECORD_SPLITTING enabled"
1240 if_build_succeeded tests/ssl-opt.sh
1241
1242 msg "test: compat.sh, MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH and MBEDTLS_SSL_CBC_RECORD_SPLITTING enabled"
1243 if_build_succeeded tests/compat.sh
1244}
1245
Piotr Nowicki0937ed22019-11-26 16:32:40 +01001246component_test_ssl_alloc_buffer_and_mfl () {
1247 msg "build: default config with memory buffer allocator and MFL extension"
1248 scripts/config.py set MBEDTLS_MEMORY_BUFFER_ALLOC_C
1249 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
1250 scripts/config.py set MBEDTLS_MEMORY_DEBUG
1251 scripts/config.py set MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
1252 scripts/config.py set MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1253 CC=gcc cmake .
1254 make
1255
1256 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
1257 make test
1258
1259 msg "test: MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH, MBEDTLS_MEMORY_BUFFER_ALLOC_C, MBEDTLS_MEMORY_DEBUG and MBEDTLS_SSL_MAX_FRAGMENT_LENGTH"
1260 if_build_succeeded tests/ssl-opt.sh -f "Handshake memory usage"
1261}
1262
Gilles Peskine636c26a2020-03-04 20:46:15 +01001263component_test_when_no_ciphersuites_have_mac () {
1264 msg "build: when no ciphersuites have MAC"
1265 scripts/config.py unset MBEDTLS_CIPHER_NULL_CIPHER
1266 scripts/config.py unset MBEDTLS_ARC4_C
1267 scripts/config.py unset MBEDTLS_CIPHER_MODE_CBC
1268 make
1269
1270 msg "test: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
1271 make test
1272
1273 msg "test ssl-opt.sh: !MBEDTLS_SSL_SOME_MODES_USE_MAC"
1274 if_build_succeeded tests/ssl-opt.sh -f 'Default\|EtM' -e 'without EtM'
1275}
1276
Gilles Peskine8f073122018-11-27 15:58:47 +01001277component_test_null_entropy () {
1278 msg "build: default config with MBEDTLS_TEST_NULL_ENTROPY (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001279 scripts/config.py set MBEDTLS_TEST_NULL_ENTROPY
1280 scripts/config.py set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1281 scripts/config.py set MBEDTLS_ENTROPY_C
1282 scripts/config.py unset MBEDTLS_ENTROPY_NV_SEED
1283 scripts/config.py unset MBEDTLS_ENTROPY_HARDWARE_ALT
1284 scripts/config.py unset MBEDTLS_HAVEGE_C
Gilles Peskine5fa32a72019-01-06 19:48:30 +00001285 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan -D UNSAFE_BUILD=ON .
Gilles Peskine8f073122018-11-27 15:58:47 +01001286 make
Janos Follath06c54002016-06-09 13:57:40 +01001287
Gilles Peskine8f073122018-11-27 15:58:47 +01001288 msg "test: MBEDTLS_TEST_NULL_ENTROPY - main suites (inc. selftests) (ASan build)"
1289 make test
1290}
Janos Follath06c54002016-06-09 13:57:40 +01001291
Gilles Peskine8f073122018-11-27 15:58:47 +01001292component_test_platform_calloc_macro () {
1293 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001294 scripts/config.py set MBEDTLS_PLATFORM_MEMORY
1295 scripts/config.py set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
1296 scripts/config.py set MBEDTLS_PLATFORM_FREE_MACRO free
Gilles Peskine8f073122018-11-27 15:58:47 +01001297 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1298 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01001299
Gilles Peskine8f073122018-11-27 15:58:47 +01001300 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
1301 make test
1302}
Hanno Beckere5fecec2018-10-11 11:02:52 +01001303
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02001304component_test_malloc_0_null () {
1305 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01001306 scripts/config.py full
Gilles Peskine004206c2019-10-21 17:11:33 +02001307 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 +02001308
1309 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
1310 make test
1311
1312 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
1313 # Just the calloc selftest. "make test" ran the others as part of the
1314 # test suites.
1315 if_build_succeeded programs/test/selftest calloc
Gilles Peskine765d2402020-02-11 18:26:34 +01001316
1317 msg "test ssl-opt.sh: malloc(0) returns NULL (ASan+UBSan build)"
1318 # Run a subset of the tests. The choice is a balance between coverage
1319 # and time (including time indirectly wasted due to flaky tests).
1320 # The current choice is to skip tests whose description includes
1321 # "proxy", which is an approximation of skipping tests that use the
1322 # UDP proxy, which tend to be slower and flakier.
1323 if_build_succeeded tests/ssl-opt.sh -e 'proxy'
Gilles Peskinec4ef7a92019-09-17 19:04:38 +02001324}
1325
Gilles Peskine8f073122018-11-27 15:58:47 +01001326component_test_aes_fewer_tables () {
1327 msg "build: default config with AES_FEWER_TABLES enabled"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001328 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
Gilles Peskine8f073122018-11-27 15:58:47 +01001329 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01001330
Gilles Peskine8f073122018-11-27 15:58:47 +01001331 msg "test: AES_FEWER_TABLES"
1332 make test
1333}
Hanno Becker83ebf782017-07-07 12:29:15 +01001334
Gilles Peskine8f073122018-11-27 15:58:47 +01001335component_test_aes_rom_tables () {
1336 msg "build: default config with AES_ROM_TABLES enabled"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001337 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Gilles Peskine8f073122018-11-27 15:58:47 +01001338 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01001339
Gilles Peskine8f073122018-11-27 15:58:47 +01001340 msg "test: AES_ROM_TABLES"
1341 make test
1342}
Hanno Becker83ebf782017-07-07 12:29:15 +01001343
Gilles Peskine8f073122018-11-27 15:58:47 +01001344component_test_aes_fewer_tables_and_rom_tables () {
1345 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001346 scripts/config.py set MBEDTLS_AES_FEWER_TABLES
1347 scripts/config.py set MBEDTLS_AES_ROM_TABLES
Gilles Peskine8f073122018-11-27 15:58:47 +01001348 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01001349
Gilles Peskine8f073122018-11-27 15:58:47 +01001350 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
1351 make test
1352}
1353
Gilles Peskine592f5912019-10-07 18:49:32 +02001354component_test_ctr_drbg_aes_256_sha_256 () {
1355 msg "build: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01001356 scripts/config.py full
1357 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
1358 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Gilles Peskine592f5912019-10-07 18:49:32 +02001359 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1360 make
1361
1362 msg "test: full + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
1363 make test
1364}
1365
1366component_test_ctr_drbg_aes_128_sha_512 () {
1367 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01001368 scripts/config.py full
1369 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
1370 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Gilles Peskine592f5912019-10-07 18:49:32 +02001371 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1372 make
1373
1374 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY (ASan build)"
1375 make test
1376}
1377
1378component_test_ctr_drbg_aes_128_sha_256 () {
1379 msg "build: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
Gilles Peskine3b46cd32020-02-18 17:56:33 +01001380 scripts/config.py full
1381 scripts/config.py unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
1382 scripts/config.py set MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
1383 scripts/config.py set MBEDTLS_ENTROPY_FORCE_SHA256
Gilles Peskine592f5912019-10-07 18:49:32 +02001384 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1385 make
1386
1387 msg "test: full + MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + MBEDTLS_ENTROPY_FORCE_SHA256 (ASan build)"
1388 make test
1389}
1390
Gilles Peskinef96aefe2019-07-24 14:58:38 +02001391component_test_se_default () {
1392 msg "build: default config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001393 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02001394 make CC=clang CFLAGS="$ASAN_CFLAGS -Os" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02001395
1396 msg "test: default config + MBEDTLS_PSA_CRYPTO_SE_C"
1397 make test
1398}
1399
1400component_test_se_full () {
1401 msg "build: full config + MBEDTLS_PSA_CRYPTO_SE_C"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001402 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001403 scripts/config.py set MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskine004206c2019-10-21 17:11:33 +02001404 make CC=gcc CFLAGS="$ASAN_CFLAGS -O2" LDFLAGS="$ASAN_CFLAGS"
Gilles Peskinef96aefe2019-07-24 14:58:38 +02001405
1406 msg "test: full config + MBEDTLS_PSA_CRYPTO_SE_C"
1407 make test
1408}
1409
Gilles Peskine8f073122018-11-27 15:58:47 +01001410component_test_make_shared () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001411 msg "build/test: make shared" # ~ 40s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04001412 make SHARED=1 all check
Gilles Peskine56c01612019-07-03 20:43:32 +02001413 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskine8f073122018-11-27 15:58:47 +01001414}
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02001415
Gilles Peskinecf740502019-07-03 20:43:05 +02001416component_test_cmake_shared () {
1417 msg "build/test: cmake shared" # ~ 2min
1418 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
1419 make
Gilles Peskine56c01612019-07-03 20:43:32 +02001420 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskinecf740502019-07-03 20:43:05 +02001421 make test
1422}
1423
Gilles Peskineec10bf12019-09-20 19:56:06 +02001424test_build_opt () {
1425 info=$1 cc=$2; shift 2
1426 for opt in "$@"; do
1427 msg "build/test: $cc $opt, $info" # ~ 30s
1428 make CC="$cc" CFLAGS="$opt -Wall -Wextra -Werror"
1429 # We're confident enough in compilers to not run _all_ the tests,
1430 # but at least run the unit tests. In particular, runs with
1431 # optimizations use inline assembly whereas runs with -O0
1432 # skip inline assembly.
1433 make test # ~30s
1434 make clean
1435 done
1436}
1437
1438component_test_clang_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01001439 scripts/config.py full
Gilles Peskineec10bf12019-09-20 19:56:06 +02001440 test_build_opt 'full config' clang -O0 -Os -O2
1441}
1442
1443component_test_gcc_opt () {
Manuel Pégourié-Gonnard68192fc2020-03-04 10:34:47 +01001444 scripts/config.py full
Gilles Peskineec10bf12019-09-20 19:56:06 +02001445 test_build_opt 'full config' gcc -O0 -Os -O2
1446}
1447
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02001448component_build_mbedtls_config_file () {
1449 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
1450 # Use the full config so as to catch a maximum of places where
1451 # the check of MBEDTLS_CONFIG_FILE might be missing.
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001452 scripts/config.py full
Gilles Peskineabf9b4d2019-07-03 20:42:16 +02001453 sed 's!"check_config.h"!"mbedtls/check_config.h"!' <"$CONFIG_H" >full_config.h
1454 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
1455 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
1456 rm -f full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001457}
1458
Gilles Peskine8f073122018-11-27 15:58:47 +01001459component_test_m32_o0 () {
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001460 # Build once with -O0, to compile out the i386 specific inline assembly
1461 msg "build: i386, make, gcc -O0 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001462 scripts/config.py full
Gilles Peskine8fd59422019-10-21 17:11:33 +02001463 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O0" LDFLAGS="-m32 $ASAN_CFLAGS"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01001464
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001465 msg "test: i386, make, gcc -O0 (ASan build)"
1466 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01001467}
Gilles Peskine878cf602019-01-06 20:50:38 +00001468support_test_m32_o0 () {
1469 case $(uname -m) in
1470 *64*) true;;
1471 *) false;;
1472 esac
1473}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001474
Gilles Peskine8f073122018-11-27 15:58:47 +01001475component_test_m32_o1 () {
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001476 # Build again with -O1, to compile in the i386 specific inline assembly
1477 msg "build: i386, make, gcc -O1 (ASan build)" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001478 scripts/config.py full
Gilles Peskine8fd59422019-10-21 17:11:33 +02001479 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O1" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001480
1481 msg "test: i386, make, gcc -O1 (ASan build)"
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01001482 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001483
1484 msg "test ssl-opt.sh, i386, make, gcc-O1"
1485 if_build_succeeded tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001486}
Gilles Peskine878cf602019-01-06 20:50:38 +00001487support_test_m32_o1 () {
1488 support_test_m32_o0 "$@"
1489}
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01001490
Gilles Peskine0c6b7992019-04-12 20:29:48 +02001491component_test_m32_everest () {
1492 msg "build: i386, Everest ECDH context (ASan build)" # ~ 6 min
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001493 scripts/config.py unset MBEDTLS_ECDH_LEGACY_CONTEXT
1494 scripts/config.py set MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Gilles Peskine8fd59422019-10-21 17:11:33 +02001495 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O2" LDFLAGS="-m32 $ASAN_CFLAGS"
Gilles Peskine0c6b7992019-04-12 20:29:48 +02001496
1497 msg "test: i386, Everest ECDH context - main suites (inc. selftests) (ASan build)" # ~ 50s
1498 make test
Gilles Peskine636c26a2020-03-04 20:46:15 +01001499
1500 msg "test: i386, Everest ECDH context - ECDH-related part of ssl-opt.sh (ASan build)" # ~ 5s
1501 if_build_succeeded tests/ssl-opt.sh -f ECDH
1502
1503 msg "test: i386, Everest ECDH context - compat.sh with some ECDH ciphersuites (ASan build)" # ~ 3 min
1504 # Exclude some symmetric ciphers that are redundant here to gain time.
1505 if_build_succeeded tests/compat.sh -f ECDH -V NO -e 'ARCFOUR\|ARIA\|CAMELLIA\|CHACHA\|DES\|RC4'
Gilles Peskine0c6b7992019-04-12 20:29:48 +02001506}
1507support_test_m32_everest () {
1508 support_test_m32_o0 "$@"
1509}
1510
Gilles Peskine8f073122018-11-27 15:58:47 +01001511component_test_mx32 () {
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01001512 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001513 scripts/config.py full
Gilles Peskine5d26e7c2019-06-07 14:50:09 +02001514 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01001515
1516 msg "test: 64-bit ILP32, make, gcc"
1517 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01001518}
Gilles Peskine878cf602019-01-06 20:50:38 +00001519support_test_mx32 () {
1520 case $(uname -m) in
1521 amd64|x86_64) true;;
1522 *) false;;
1523 esac
1524}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001525
Peter Kolbus60c6da22018-12-27 06:59:04 -06001526component_test_min_mpi_window_size () {
1527 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001528 scripts/config.py set MBEDTLS_MPI_WINDOW_SIZE 1
Peter Kolbus60c6da22018-12-27 06:59:04 -06001529 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1530 make
1531
1532 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
1533 make test
1534}
1535
Gilles Peskine8f073122018-11-27 15:58:47 +01001536component_test_have_int32 () {
1537 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001538 scripts/config.py unset MBEDTLS_HAVE_ASM
1539 scripts/config.py unset MBEDTLS_AESNI_C
1540 scripts/config.py unset MBEDTLS_PADLOCK_C
Gilles Peskine8f073122018-11-27 15:58:47 +01001541 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01001542
Gilles Peskine8f073122018-11-27 15:58:47 +01001543 msg "test: gcc, force 32-bit bignum limbs"
1544 make test
1545}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01001546
Gilles Peskine8f073122018-11-27 15:58:47 +01001547component_test_have_int64 () {
1548 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001549 scripts/config.py unset MBEDTLS_HAVE_ASM
1550 scripts/config.py unset MBEDTLS_AESNI_C
1551 scripts/config.py unset MBEDTLS_PADLOCK_C
Gilles Peskine8f073122018-11-27 15:58:47 +01001552 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01001553
Gilles Peskine8f073122018-11-27 15:58:47 +01001554 msg "test: gcc, force 64-bit bignum limbs"
1555 make test
1556}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001557
Gilles Peskine8f073122018-11-27 15:58:47 +01001558component_test_no_udbl_division () {
1559 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001560 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001561 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine8f073122018-11-27 15:58:47 +01001562 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001563
Gilles Peskine8f073122018-11-27 15:58:47 +01001564 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
1565 make test
1566}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001567
Gilles Peskine8f073122018-11-27 15:58:47 +01001568component_test_no_64bit_multiplication () {
1569 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001570 scripts/config.py full
Gilles Peskine3bdd4122019-07-27 23:52:53 +02001571 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine8f073122018-11-27 15:58:47 +01001572 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001573
Gilles Peskine8f073122018-11-27 15:58:47 +01001574 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
1575 make test
1576}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001577
Gilles Peskine8f073122018-11-27 15:58:47 +01001578component_build_arm_none_eabi_gcc () {
Gilles Peskine60f267b2020-04-25 22:21:30 +02001579 msg "build: ${ARM_GCC_PREFIX}gcc, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001580 scripts/config.py baremetal
Gilles Peskine60f267b2020-04-25 22:21:30 +02001581 make CC="${ARM_GCC_PREFIX}gcc" AR="${ARM_GCC_PREFIX}ar" LD="${ARM_GCC_PREFIX}ld" CFLAGS='-Werror -Wall -Wextra' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01001582}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001583
Gilles Peskine2c897d72019-08-09 16:05:05 +02001584component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskine60f267b2020-04-25 22:21:30 +02001585 msg "build: ${ARM_GCC_PREFIX}gcc -march=arm5vte, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001586 scripts/config.py baremetal
Gilles Peskine2c897d72019-08-09 16:05:05 +02001587 # Build for a target platform that's close to what Debian uses
1588 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
1589 # See https://github.com/ARMmbed/mbedtls/pull/2169 and comments.
1590 # It would be better to build with arm-linux-gnueabi-gcc but
1591 # we don't have that on our CI at this time.
Gilles Peskine60f267b2020-04-25 22:21:30 +02001592 make CC="${ARM_GCC_PREFIX}gcc" AR="${ARM_GCC_PREFIX}ar" CFLAGS='-Werror -Wall -Wextra -march=armv5te -O1' LDFLAGS='-march=armv5te' SHELL='sh -x' lib
Gilles Peskine93e4e032019-08-05 11:34:25 +02001593}
1594
Gilles Peskine8f073122018-11-27 15:58:47 +01001595component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskine60f267b2020-04-25 22:21:30 +02001596 msg "build: ${ARM_GCC_PREFIX}gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001597 scripts/config.py baremetal
1598 scripts/config.py set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskine60f267b2020-04-25 22:21:30 +02001599 make CC="${ARM_GCC_PREFIX}gcc" AR="${ARM_GCC_PREFIX}ar" LD="${ARM_GCC_PREFIX}ld" CFLAGS='-Werror -Wall -Wextra' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01001600 echo "Checking that software 64-bit division is not required"
1601 if_build_succeeded not grep __aeabi_uldiv library/*.o
1602}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001603
Gilles Peskine8f073122018-11-27 15:58:47 +01001604component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskine60f267b2020-04-25 22:21:30 +02001605 msg "build: ${ARM_GCC_PREFIX}gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001606 scripts/config.py baremetal
1607 scripts/config.py set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskine60f267b2020-04-25 22:21:30 +02001608 make CC="${ARM_GCC_PREFIX}gcc" AR="${ARM_GCC_PREFIX}ar" LD="${ARM_GCC_PREFIX}ld" CFLAGS='-Werror -O1 -march=armv6-m -mthumb' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01001609 echo "Checking that software 64-bit multiplication is not required"
1610 if_build_succeeded not grep __aeabi_lmul library/*.o
1611}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001612
Gilles Peskine8f073122018-11-27 15:58:47 +01001613component_build_armcc () {
1614 msg "build: ARM Compiler 5, make"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001615 scripts/config.py baremetal
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001616
Gilles Peskinebca6ab92017-12-19 18:24:31 +01001617 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
1618 make clean
Andres AG87bb5772016-09-27 15:05:15 +01001619
Gilles Peskinebca6ab92017-12-19 18:24:31 +01001620 # ARM Compiler 6 - Target ARMv7-A
1621 armc6_build_test "--target=arm-arm-none-eabi -march=armv7-a"
Simon Butcher940737f2017-07-23 13:42:36 +02001622
Gilles Peskinebca6ab92017-12-19 18:24:31 +01001623 # ARM Compiler 6 - Target ARMv7-M
1624 armc6_build_test "--target=arm-arm-none-eabi -march=armv7-m"
Simon Butcher940737f2017-07-23 13:42:36 +02001625
Gilles Peskinebca6ab92017-12-19 18:24:31 +01001626 # ARM Compiler 6 - Target ARMv8-A - AArch32
1627 armc6_build_test "--target=arm-arm-none-eabi -march=armv8.2-a"
Simon Butcher940737f2017-07-23 13:42:36 +02001628
Gilles Peskinebca6ab92017-12-19 18:24:31 +01001629 # ARM Compiler 6 - Target ARMv8-M
1630 armc6_build_test "--target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02001631
Gilles Peskinebca6ab92017-12-19 18:24:31 +01001632 # ARM Compiler 6 - Target ARMv8-A - AArch64
1633 armc6_build_test "--target=aarch64-arm-none-eabi -march=armv8.2-a"
Gilles Peskine8f073122018-11-27 15:58:47 +01001634}
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01001635
Manuel Pégourié-Gonnarddd8807f2020-02-26 09:56:27 +01001636component_build_ssl_hw_record_accel() {
1637 msg "build: default config with MBEDTLS_SSL_HW_RECORD_ACCEL enabled"
1638 scripts/config.pl set MBEDTLS_SSL_HW_RECORD_ACCEL
1639 make CFLAGS='-Werror -O1'
1640}
1641
Gilles Peskine8f073122018-11-27 15:58:47 +01001642component_test_allow_sha1 () {
1643 msg "build: allow SHA1 in certificates by default"
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001644 scripts/config.py set MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
Gilles Peskine8f073122018-11-27 15:58:47 +01001645 make CFLAGS='-Werror -Wall -Wextra'
1646 msg "test: allow SHA1 in certificates by default"
1647 make test
1648 if_build_succeeded tests/ssl-opt.sh -f SHA-1
1649}
Gilles Peskine2a458da2017-05-12 15:26:58 +02001650
Gilles Peskine8f073122018-11-27 15:58:47 +01001651component_build_mingw () {
1652 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04001653 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 +00001654
Gilles Peskine8f073122018-11-27 15:58:47 +01001655 # note Make tests only builds the tests, but doesn't run them
Andrzej Kurek232e8f92019-10-03 03:18:01 -04001656 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 +01001657 make WINDOWS_BUILD=1 clean
Simon Butcher002bc622016-11-17 09:27:45 +00001658
Gilles Peskine8f073122018-11-27 15:58:47 +01001659 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
Andrzej Kurek232e8f92019-10-03 03:18:01 -04001660 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
1661 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 +01001662 make WINDOWS_BUILD=1 clean
1663}
Jaeden Amero117b8a42019-04-17 15:19:26 +01001664support_build_mingw() {
1665 case $(i686-w64-mingw32-gcc -dumpversion) in
1666 [0-5]*) false;;
1667 *) true;;
1668 esac
1669}
Manuel Pégourié-Gonnard6448bce2015-02-16 17:18:36 +01001670
Gilles Peskine8f073122018-11-27 15:58:47 +01001671component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001672 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine5d46f6a2019-07-27 23:52:53 +02001673 scripts/config.py unset MBEDTLS_AESNI_C # memsan doesn't grok asm
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001674 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
1675 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02001676
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001677 msg "test: main suites (MSan)" # ~ 10s
1678 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001679
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001680 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine7c652162017-12-11 00:01:40 +01001681 if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001682
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001683 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001684
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001685 if [ "$MEMORY" -gt 0 ]; then
1686 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine7c652162017-12-11 00:01:40 +01001687 if_build_succeeded tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001688 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01001689}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001690
Gilles Peskine69f190e2019-01-10 00:11:42 +01001691component_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001692 msg "build: Release (clang)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001693 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
1694 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001695
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001696 msg "test: main suites valgrind (Release)"
1697 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001698
Gilles Peskine636c26a2020-03-04 20:46:15 +01001699 # Optional parts (slow; currently broken on OS X because programs don't
1700 # seem to receive signals under valgrind on OS X).
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001701 if [ "$MEMORY" -gt 0 ]; then
1702 msg "test: ssl-opt.sh --memcheck (Release)"
Gilles Peskine7c652162017-12-11 00:01:40 +01001703 if_build_succeeded tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001704 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001705
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001706 if [ "$MEMORY" -gt 1 ]; then
1707 msg "test: compat.sh --memcheck (Release)"
Gilles Peskine7c652162017-12-11 00:01:40 +01001708 if_build_succeeded tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001709 fi
Piotr Nowicki9978e6e2020-04-07 16:07:05 +02001710
1711 if [ "$MEMORY" -gt 0 ]; then
1712 msg "test: context-info.sh --memcheck (Release)"
1713 if_build_succeeded tests/context-info.sh --memcheck
1714 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01001715}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001716
Gilles Peskine8f073122018-11-27 15:58:47 +01001717component_test_cmake_out_of_source () {
1718 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01001719 MBEDTLS_ROOT_DIR="$PWD"
1720 mkdir "$OUT_OF_SOURCE_DIR"
1721 cd "$OUT_OF_SOURCE_DIR"
1722 cmake "$MBEDTLS_ROOT_DIR"
1723 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001724
Gilles Peskine8f073122018-11-27 15:58:47 +01001725 msg "test: cmake 'out-of-source' build"
1726 make test
1727 # Test an SSL option that requires an auxiliary script in test/scripts/.
1728 # Also ensure that there are no error messages such as
1729 # "No such file or directory", which would indicate that some required
1730 # file is missing (ssl-opt.sh tolerates the absence of some files so
1731 # may exit with status 0 but emit errors).
1732 if_build_succeeded ./tests/ssl-opt.sh -f 'Fallback SCSV: beginning of list' 2>ssl-opt.err
1733 if [ -s ssl-opt.err ]; then
1734 cat ssl-opt.err >&2
1735 record_status [ ! -s ssl-opt.err ]
1736 rm ssl-opt.err
1737 fi
1738 cd "$MBEDTLS_ROOT_DIR"
1739 rm -rf "$OUT_OF_SOURCE_DIR"
1740 unset MBEDTLS_ROOT_DIR
1741}
Andres AGdc192212016-08-31 17:33:13 +01001742
Jaeden Ameroab83fdf2019-06-20 17:38:22 +01001743component_test_cmake_as_subdirectory () {
1744 msg "build: cmake 'as-subdirectory' build"
1745 MBEDTLS_ROOT_DIR="$PWD"
1746
1747 cd programs/test/cmake_subproject
1748 cmake .
1749 make
1750 if_build_succeeded ./cmake_subproject
1751
1752 cd "$MBEDTLS_ROOT_DIR"
1753 unset MBEDTLS_ROOT_DIR
1754}
1755
Gilles Peskine8f073122018-11-27 15:58:47 +01001756component_test_zeroize () {
1757 # Test that the function mbedtls_platform_zeroize() is not optimized away by
1758 # different combinations of compilers and optimization flags by using an
1759 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
1760 # system in all cases that the script fails, so we must manually search the
1761 # output to check whether the pass string is present and no failure strings
1762 # were printed.
Andres AGdc192212016-08-31 17:33:13 +01001763
Gilles Peskine4976e822019-01-06 19:52:22 +00001764 # Don't try to disable ASLR. We don't care about ASLR here. We do care
1765 # about a spurious message if Gdb tries and fails, so suppress that.
1766 gdb_disable_aslr=
1767 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
1768 gdb_disable_aslr='set disable-randomization off'
1769 fi
1770
Gilles Peskine8f073122018-11-27 15:58:47 +01001771 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01001772 for compiler in clang gcc; do
1773 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
1774 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine4976e822019-01-06 19:52:22 +00001775 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 +01001776 if_build_succeeded grep "The buffer was correctly zeroized" test_zeroize.log
1777 if_build_succeeded not grep -i "error" test_zeroize.log
1778 rm -f test_zeroize.log
1779 make clean
1780 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01001781 done
Andres Amaya Garciad0d7bf62017-10-25 09:01:31 +01001782
Gilles Peskine4976e822019-01-06 19:52:22 +00001783 unset gdb_disable_aslr
Gilles Peskine8f073122018-11-27 15:58:47 +01001784}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001785
Gilles Peskine8f073122018-11-27 15:58:47 +01001786component_check_python_files () {
1787 msg "Lint: Python scripts"
1788 record_status tests/scripts/check-python-files.sh
1789}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001790
Gilles Peskine8f073122018-11-27 15:58:47 +01001791component_check_generate_test_code () {
1792 msg "uint test: generate_test_code.py"
1793 record_status ./tests/scripts/test_generate_test_code.py
1794}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001795
1796################################################################
1797#### Termination
1798################################################################
1799
Gilles Peskine8f073122018-11-27 15:58:47 +01001800post_report () {
1801 msg "Done, cleaning up"
1802 cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001803
Gilles Peskine8f073122018-11-27 15:58:47 +01001804 final_report
1805}
1806
1807
1808
1809################################################################
1810#### Run all the things
1811################################################################
1812
Gilles Peskinee48351a2018-11-27 16:06:30 +01001813# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01001814run_component () {
Gilles Peskine608953e2019-01-02 18:57:02 +01001815 # Back up the configuration in case the component modifies it.
1816 # The cleanup function will restore it.
1817 cp -p "$CONFIG_H" "$CONFIG_BAK"
Gilles Peskineffcdeff2018-12-04 12:49:28 +01001818 current_component="$1"
Gilles Peskine9004a172019-09-16 15:20:36 +02001819 export MBEDTLS_TEST_CONFIGURATION="$current_component"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02001820
1821 # Unconditionally create a seedfile that's sufficiently long.
1822 # Do this before each component, because a previous component may
1823 # have messed it up or shortened it.
1824 dd if=/dev/urandom of=./tests/seedfile bs=64 count=1
1825
1826 # Run the component code.
Gilles Peskine8f073122018-11-27 15:58:47 +01001827 "$@"
Gilles Peskine2ef377d2019-10-07 18:44:21 +02001828
1829 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01001830 cleanup
Gilles Peskine8f073122018-11-27 15:58:47 +01001831}
1832
1833# Preliminary setup
1834pre_check_environment
1835pre_initialize_variables
1836pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01001837
Gilles Peskine878cf602019-01-06 20:50:38 +00001838pre_check_git
Andrzej Kurekeb508712019-02-14 07:18:59 -05001839
Gilles Peskine878cf602019-01-06 20:50:38 +00001840build_status=0
1841if [ $KEEP_GOING -eq 1 ]; then
1842 pre_setup_keep_going
Gilles Peskine92525112018-11-27 18:15:35 +01001843else
Gilles Peskine878cf602019-01-06 20:50:38 +00001844 record_status () {
1845 "$@"
1846 }
Gilles Peskine8f073122018-11-27 15:58:47 +01001847fi
Gilles Peskine67ffdaf2019-09-16 15:55:46 +02001848pre_prepare_outcome_file
Gilles Peskine878cf602019-01-06 20:50:38 +00001849pre_print_configuration
1850pre_check_tools
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001851cleanup
1852
Gilles Peskinebeb3a812019-01-06 22:11:25 +00001853# Run the requested tests.
1854for component in $RUN_COMPONENTS; do
1855 run_component "component_$component"
1856done
Gilles Peskine8f073122018-11-27 15:58:47 +01001857
1858# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00001859post_report