blob: a2a26b45b3efd2a260525e118ccb2fd61f53c02f [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#
Bence Szépkútia2947ac2020-08-19 16:37:36 +02005# Copyright The Mbed TLS Contributors
Bence Szépkútif744bd72020-06-05 13:02:18 +02006# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
7#
8# This file is provided under the Apache License 2.0, or the
9# GNU General Public License v2.0 or later.
10#
11# **********
12# Apache License 2.0:
Bence Szépkúti51b41d52020-05-26 01:54:15 +020013#
14# Licensed under the Apache License, Version 2.0 (the "License"); you may
15# not use this file except in compliance with the License.
16# You may obtain a copy of the License at
17#
18# http://www.apache.org/licenses/LICENSE-2.0
19#
20# Unless required by applicable law or agreed to in writing, software
21# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23# See the License for the specific language governing permissions and
24# limitations under the License.
25#
Bence Szépkútif744bd72020-06-05 13:02:18 +020026# **********
27#
28# **********
29# GNU General Public License v2.0 or later:
30#
31# This program is free software; you can redistribute it and/or modify
32# it under the terms of the GNU General Public License as published by
33# the Free Software Foundation; either version 2 of the License, or
34# (at your option) any later version.
35#
36# This program is distributed in the hope that it will be useful,
37# but WITHOUT ANY WARRANTY; without even the implied warranty of
38# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
39# GNU General Public License for more details.
40#
41# You should have received a copy of the GNU General Public License along
42# with this program; if not, write to the Free Software Foundation, Inc.,
43# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
44#
45# **********
Gilles Peskine192c72f2017-12-21 15:59:21 +010046
47
48
49################################################################
50#### Documentation
51################################################################
52
Simon Butcher3ea7f522016-03-07 23:22:10 +000053# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010054# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000055#
SimonB2e23c822016-04-16 21:54:39 +010056# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010057#
Gilles Peskine192c72f2017-12-21 15:59:21 +010058# Notes for users
59# ---------------
60#
SimonB2e23c822016-04-16 21:54:39 +010061# Warning: the test is destructive. It includes various build modes and
62# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010063# configuration. The following files must be committed into git:
64# * include/mbedtls/config.h
65# * Makefile, library/Makefile, programs/Makefile, tests/Makefile
66# After running this script, the CMake cache will be lost and CMake
67# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010068#
Gilles Peskine192c72f2017-12-21 15:59:21 +010069# The script assumes the presence of a number of tools:
70# * Basic Unix tools (Windows users note: a Unix-style find must be before
71# the Windows find in the PATH)
72# * Perl
73# * GNU Make
74# * CMake
75# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040076# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010077# * arm-gcc and mingw-gcc
78# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine192c72f2017-12-21 15:59:21 +010079# * OpenSSL and GnuTLS command line tools, recent enough for the
80# interoperability tests. If they don't support SSLv3 then a legacy
81# version of these tools must be present as well (search for LEGACY
82# below).
83# See the invocation of check_tools below for details.
84#
85# This script must be invoked from the toplevel directory of a git
86# working copy of Mbed TLS.
87#
88# Note that the output is not saved. You may want to run
89# script -c tests/scripts/all.sh
90# or
91# tests/scripts/all.sh >all.log 2>&1
92#
93# Notes for maintainers
94# ---------------------
95#
Gilles Peskine8f073122018-11-27 15:58:47 +010096# The bulk of the code is organized into functions that follow one of the
97# following naming conventions:
98# * pre_XXX: things to do before running the tests, in order.
99# * component_XXX: independent components. They can be run in any order.
Gilles Peskinec70637a2019-01-09 22:29:17 +0100100# * component_check_XXX: quick tests that aren't worth parallelizing.
101# * component_build_XXX: build things but don't run them.
102# * component_test_XXX: build and test.
Gilles Peskine878cf602019-01-06 20:50:38 +0000103# * support_XXX: if support_XXX exists and returns false then
104# component_XXX is not run by default.
Gilles Peskine8f073122018-11-27 15:58:47 +0100105# * post_XXX: things to do after running the tests.
106# * other: miscellaneous support functions.
107#
Gilles Peskinec70637a2019-01-09 22:29:17 +0100108# Each component must start by invoking `msg` with a short informative message.
109#
110# The framework performs some cleanup tasks after each component. This
111# means that components can assume that the working directory is in a
112# cleaned-up state, and don't need to perform the cleanup themselves.
113# * Run `make clean`.
114# * Restore `include/mbedtks/config.h` from a backup made before running
115# the component.
116# * Check out `Makefile`, `library/Makefile`, `programs/Makefile` and
117# `tests/Makefile` from git. This cleans up after an in-tree use of
118# CMake.
119#
120# Any command that is expected to fail must be protected so that the
121# script keeps running in --keep-going mode despite `set -e`. In keep-going
122# mode, if a protected command fails, this is logged as a failure and the
123# script will exit with a failure status once it has run all components.
124# Commands can be protected in any of the following ways:
125# * `make` is a function which runs the `make` command with protection.
126# Note that you must write `make VAR=value`, not `VAR=value make`,
127# because the `VAR=value make` syntax doesn't work with functions.
128# * Put `report_status` before the command to protect it.
129# * Put `if_build_successful` before a command. This protects it, and
130# additionally skips it if a prior invocation of `make` in the same
131# component failed.
132#
Gilles Peskine192c72f2017-12-21 15:59:21 +0100133# The tests are roughly in order from fastest to slowest. This doesn't
134# have to be exact, but in general you should add slower tests towards
135# the end and fast checks near the beginning.
Gilles Peskine192c72f2017-12-21 15:59:21 +0100136
137
138
139################################################################
140#### Initialization and command line parsing
141################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100142
SimonB2e23c822016-04-16 21:54:39 +0100143# Abort on errors (and uninitialised variables)
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100144set -eu
145
Gilles Peskine8f073122018-11-27 15:58:47 +0100146pre_check_environment () {
Gilles Peskinea16c2b12019-01-06 19:58:02 +0000147 if [ -d library -a -d include -a -d tests ]; then :; else
Gilles Peskine8f073122018-11-27 15:58:47 +0100148 echo "Must be run from mbed TLS root" >&2
149 exit 1
150 fi
151}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100152
Gilles Peskine8f073122018-11-27 15:58:47 +0100153pre_initialize_variables () {
154 CONFIG_H='include/mbedtls/config.h'
155 CONFIG_BAK="$CONFIG_H.bak"
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200156
Gilles Peskine8f073122018-11-27 15:58:47 +0100157 MEMORY=0
158 FORCE=0
Manuel Pégourié-Gonnardde4ad2d2020-06-02 11:28:07 +0200159 QUIET=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100160 KEEP_GOING=0
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100161
Manuel Pégourié-Gonnardc2400d32020-06-08 12:59:27 +0200162 # Seed value used with the --release-test option.
Manuel Pégourié-Gonnard1bff6842020-06-22 10:11:47 +0200163 #
164 # See also RELEASE_SEED in basic-build-test.sh. Debugging is easier if
165 # both values are kept in sync. If you change the value here because it
166 # breaks some tests, you'll definitely want to change it in
167 # basic-build-test.sh as well.
Manuel Pégourié-Gonnardc2400d32020-06-08 12:59:27 +0200168 RELEASE_SEED=1
169
Antonin Décimod5f47592019-01-23 15:24:37 +0100170 # Default commands, can be overridden by the environment
Gilles Peskine8f073122018-11-27 15:58:47 +0100171 : ${OPENSSL:="openssl"}
172 : ${OPENSSL_LEGACY:="$OPENSSL"}
173 : ${OPENSSL_NEXT:="$OPENSSL"}
174 : ${GNUTLS_CLI:="gnutls-cli"}
175 : ${GNUTLS_SERV:="gnutls-serv"}
176 : ${GNUTLS_LEGACY_CLI:="$GNUTLS_CLI"}
177 : ${GNUTLS_LEGACY_SERV:="$GNUTLS_SERV"}
178 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
179 : ${ARMC5_BIN_DIR:=/usr/bin}
180 : ${ARMC6_BIN_DIR:=/usr/bin}
Gilles Peskinea3c6c8a2020-04-30 18:19:32 +0200181 : ${ARM_NONE_EABI_GCC_PREFIX:=arm-none-eabi-}
Andres AGdc192212016-08-31 17:33:13 +0100182
Gilles Peskine8f073122018-11-27 15:58:47 +0100183 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskinea1fc4b52019-01-06 20:15:26 +0000184 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine8f073122018-11-27 15:58:47 +0100185 export MAKEFLAGS="-j"
186 fi
Gilles Peskine878cf602019-01-06 20:50:38 +0000187
Jaeden Amerobd1b89a2019-02-07 17:43:39 +0000188 # Include more verbose output for failing tests run by CMake
189 export CTEST_OUTPUT_ON_FAILURE=1
190
Gilles Peskineff26b042019-10-21 17:11:33 +0200191 # CFLAGS and LDFLAGS for Asan builds that don't use CMake
Gilles Peskineac479062019-10-21 19:06:33 +0200192 ASAN_CFLAGS='-Werror -Wall -Wextra -fsanitize=address,undefined -fno-sanitize-recover=all'
Gilles Peskineff26b042019-10-21 17:11:33 +0200193
Gilles Peskine878cf602019-01-06 20:50:38 +0000194 # Gather the list of available components. These are the functions
195 # defined in this script whose name starts with "component_".
196 # Parse the script with sed, because in sh there is no way to list
197 # defined functions.
198 ALL_COMPONENTS=$(sed -n 's/^ *component_\([0-9A-Z_a-z]*\) *().*/\1/p' <"$0")
199
200 # Exclude components that are not supported on this platform.
201 SUPPORTED_COMPONENTS=
202 for component in $ALL_COMPONENTS; do
203 case $(type "support_$component" 2>&1) in
204 *' function'*)
205 if ! support_$component; then continue; fi;;
206 esac
207 SUPPORTED_COMPONENTS="$SUPPORTED_COMPONENTS $component"
208 done
Gilles Peskine8f073122018-11-27 15:58:47 +0100209}
Andres AG38495a32016-07-12 16:54:33 +0100210
Gilles Peskinea28db922019-01-10 00:05:18 +0100211# Test whether the component $1 is included in the command line patterns.
212is_component_included()
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100213{
214 set -f
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000215 for pattern in $COMMAND_LINE_COMPONENTS; do
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100216 set +f
217 case ${1#component_} in $pattern) return 0;; esac
218 done
219 set +f
220 return 1
221}
222
Simon Butcher41eeccf2016-09-07 00:07:09 +0100223usage()
SimonB2e23c822016-04-16 21:54:39 +0100224{
Gilles Peskine709346a2017-12-10 23:43:39 +0100225 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100226Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100227Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100228By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskinea28db922019-01-10 00:05:18 +0100229COMPONENT can be the name of a component or a shell wildcard pattern.
230
231Examples:
232 $0 "check_*"
233 Run all sanity checks.
234 $0 --no-armcc --except test_memsan
235 Run everything except builds that require armcc and MemSan.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100236
237Special options:
238 -h|--help Print this help and exit.
Gilles Peskine878cf602019-01-06 20:50:38 +0000239 --list-all-components List all available test components and exit.
240 --list-components List components supported on this platform and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100241
242General options:
Manuel Pégourié-Gonnardde4ad2d2020-06-02 11:28:07 +0200243 -q|--quiet Only output component names, and errors if any.
Gilles Peskine709346a2017-12-10 23:43:39 +0100244 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100245 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100246 -m|--memory Additional optional memory tests.
Gilles Peskinea3c6c8a2020-04-30 18:19:32 +0200247 --arm-none-eabi-gcc-prefix=<string>
248 Prefix for a cross-compiler for arm-none-eabi
249 (default: "${ARM_NONE_EABI_GCC_PREFIX}")
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100250 --armcc Run ARM Compiler builds (on by default).
Gilles Peskinea28db922019-01-10 00:05:18 +0100251 --except Exclude the COMPONENTs listed on the command line,
252 instead of running only those.
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100253 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100254 --no-force Refuse to overwrite modified files (default).
255 --no-keep-going Stop at the first error (default).
256 --no-memory No additional memory tests (default).
Manuel Pégourié-Gonnardde4ad2d2020-06-02 11:28:07 +0200257 --no-quiet Print full ouput from components.
Gilles Peskine709346a2017-12-10 23:43:39 +0100258 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine38d81652018-03-21 08:40:26 +0100259 --random-seed Use a random seed value for randomized tests (default).
Manuel Pégourié-Gonnardc2400d32020-06-08 12:59:27 +0200260 -r|--release-test Run this script in release mode. This fixes the seed value to ${RELEASE_SEED}.
Gilles Peskine709346a2017-12-10 23:43:39 +0100261 -s|--seed Integer seed value to use for this test run.
262
263Tool path options:
264 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
265 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
266 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
267 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
268 --gnutls-legacy-cli=<GnuTLS_cli_path> GnuTLS client executable to use for legacy tests.
269 --gnutls-legacy-serv=<GnuTLS_serv_path> GnuTLS server executable to use for legacy tests.
270 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
271 --openssl-legacy=<OpenSSL_path> OpenSSL executable to use for legacy tests e.g. SSLv3.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100272 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100273EOF
SimonB2e23c822016-04-16 21:54:39 +0100274}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100275
276# remove built files as well as the cmake cache/config
277cleanup()
278{
Gilles Peskinea71d64c2018-03-21 12:16:57 +0100279 if [ -n "${MBEDTLS_ROOT_DIR+set}" ]; then
280 cd "$MBEDTLS_ROOT_DIR"
281 fi
282
Gilles Peskine7c652162017-12-11 00:01:40 +0100283 command make clean
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200284
Gilles Peskine31b07e22018-03-21 12:15:06 +0100285 # Remove CMake artefacts
Simon Butcher3ad2efd2018-05-02 14:49:38 +0100286 find . -name .git -prune \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100287 -iname CMakeFiles -exec rm -rf {} \+ -o \
288 \( -iname cmake_install.cmake -o \
289 -iname CTestTestfile.cmake -o \
290 -iname CMakeCache.txt \) -exec rm {} \+
291 # Recover files overwritten by in-tree CMake builds
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +0000292 rm -f include/Makefile include/mbedtls/Makefile programs/*/Makefile
Paul Bakkerfe0984d2014-06-13 00:13:45 +0200293 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile
294 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200295
296 if [ -f "$CONFIG_BAK" ]; then
297 mv "$CONFIG_BAK" "$CONFIG_H"
298 fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100299}
300
Gilles Peskine7c652162017-12-11 00:01:40 +0100301# Executed on exit. May be redefined depending on command line options.
302final_report () {
303 :
304}
305
306fatal_signal () {
307 cleanup
308 final_report $1
309 trap - $1
310 kill -$1 $$
311}
312
313trap 'fatal_signal HUP' HUP
314trap 'fatal_signal INT' INT
315trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200316
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100317msg()
318{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100319 if [ -n "${current_component:-}" ]; then
320 current_section="${current_component#component_}: $1"
321 else
322 current_section="$1"
323 fi
Manuel Pégourié-Gonnardde4ad2d2020-06-02 11:28:07 +0200324
325 if [ $QUIET -eq 1 ]; then
326 return
327 fi
328
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100329 echo ""
330 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100331 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000332 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100333 echo "******************************************************************"
334}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100335
Gilles Peskine8f073122018-11-27 15:58:47 +0100336armc6_build_test()
337{
338 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100339
Gilles Peskinee6c0c7d2020-04-30 23:11:54 +0200340 msg "build: ARM Compiler 6 ($FLAGS)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100341 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
342 WARNING_CFLAGS='-xc -std=c99' make lib
Gilles Peskinee6c0c7d2020-04-30 23:11:54 +0200343
344 msg "size: ARM Compiler 6 ($FLAGS)"
345 "$ARMC6_FROMELF" -z library/*.o
346
Gilles Peskine8f073122018-11-27 15:58:47 +0100347 make clean
348}
Andres AGa5cd9732016-10-17 15:23:10 +0100349
Andres AGd9eba4b2016-08-26 14:42:14 +0100350err_msg()
351{
352 echo "$1" >&2
353}
354
355check_tools()
356{
357 for TOOL in "$@"; do
Andres AG98393602017-01-31 17:04:45 +0000358 if ! `type "$TOOL" >/dev/null 2>&1`; then
Andres AGd9eba4b2016-08-26 14:42:14 +0100359 err_msg "$TOOL not found!"
360 exit 1
361 fi
362 done
363}
364
Andrzej Kurek991f9fe2018-07-02 09:08:21 -0400365check_headers_in_cpp () {
Peter Kolbus30987072019-02-01 17:19:08 -0600366 ls include/mbedtls | grep "\.h$" >headers.txt
Andrzej Kurek991f9fe2018-07-02 09:08:21 -0400367 <programs/test/cpp_dummy_build.cpp sed -n 's/"$//; s!^#include "mbedtls/!!p' |
368 sort |
369 diff headers.txt -
370 rm headers.txt
371}
372
Gilles Peskine8f073122018-11-27 15:58:47 +0100373pre_parse_command_line () {
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000374 COMMAND_LINE_COMPONENTS=
Gilles Peskinea28db922019-01-10 00:05:18 +0100375 all_except=0
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000376 no_armcc=
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000377
Gilles Peskine8f073122018-11-27 15:58:47 +0100378 while [ $# -gt 0 ]; do
Gilles Peskine55f7c942019-01-09 22:28:21 +0100379 case "$1" in
Gilles Peskinea3c6c8a2020-04-30 18:19:32 +0200380 --arm-none-eabi-gcc-prefix) shift; ARM_NONE_EABI_GCC_PREFIX="$1";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000381 --armcc) no_armcc=;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100382 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
383 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000384 --except) all_except=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100385 --force|-f) FORCE=1;;
386 --gnutls-cli) shift; GNUTLS_CLI="$1";;
387 --gnutls-legacy-cli) shift; GNUTLS_LEGACY_CLI="$1";;
388 --gnutls-legacy-serv) shift; GNUTLS_LEGACY_SERV="$1";;
389 --gnutls-serv) shift; GNUTLS_SERV="$1";;
390 --help|-h) usage; exit;;
391 --keep-going|-k) KEEP_GOING=1;;
Gilles Peskine878cf602019-01-06 20:50:38 +0000392 --list-all-components) printf '%s\n' $ALL_COMPONENTS; exit;;
393 --list-components) printf '%s\n' $SUPPORTED_COMPONENTS; exit;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100394 --memory|-m) MEMORY=1;;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000395 --no-armcc) no_armcc=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100396 --no-force) FORCE=0;;
397 --no-keep-going) KEEP_GOING=0;;
398 --no-memory) MEMORY=0;;
Manuel Pégourié-Gonnardde4ad2d2020-06-02 11:28:07 +0200399 --no-quiet) QUIET=0;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100400 --openssl) shift; OPENSSL="$1";;
401 --openssl-legacy) shift; OPENSSL_LEGACY="$1";;
402 --openssl-next) shift; OPENSSL_NEXT="$1";;
403 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Manuel Pégourié-Gonnardde4ad2d2020-06-02 11:28:07 +0200404 --quiet|-q) QUIET=1;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100405 --random-seed) unset SEED;;
Manuel Pégourié-Gonnardc2400d32020-06-08 12:59:27 +0200406 --release-test|-r) SEED=$RELEASE_SEED;;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100407 --seed|-s) shift; SEED="$1";;
408 -*)
409 echo >&2 "Unknown option: $1"
410 echo >&2 "Run $0 --help for usage."
411 exit 120
412 ;;
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000413 *) COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS $1";;
Gilles Peskine55f7c942019-01-09 22:28:21 +0100414 esac
415 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100416 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000417
Gilles Peskinea28db922019-01-10 00:05:18 +0100418 # With no list of components, run everything.
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000419 if [ -z "$COMMAND_LINE_COMPONENTS" ]; then
420 all_except=1
421 fi
422
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000423 # --no-armcc is a legacy option. The modern way is --except '*_armcc*'.
424 # Ignore it if components are listed explicitly on the command line.
Gilles Peskinea28db922019-01-10 00:05:18 +0100425 if [ -n "$no_armcc" ] && [ $all_except -eq 1 ]; then
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000426 COMMAND_LINE_COMPONENTS="$COMMAND_LINE_COMPONENTS *_armcc*"
427 fi
428
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000429 # Build the list of components to run.
Gilles Peskinea28db922019-01-10 00:05:18 +0100430 RUN_COMPONENTS=
431 for component in $SUPPORTED_COMPONENTS; do
432 if is_component_included "$component"; [ $? -eq $all_except ]; then
433 RUN_COMPONENTS="$RUN_COMPONENTS $component"
434 fi
435 done
Gilles Peskinebeb3a812019-01-06 22:11:25 +0000436
437 unset all_except
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000438 unset no_armcc
Gilles Peskine8f073122018-11-27 15:58:47 +0100439}
SimonB2e23c822016-04-16 21:54:39 +0100440
Gilles Peskine8f073122018-11-27 15:58:47 +0100441pre_check_git () {
442 if [ $FORCE -eq 1 ]; then
Gilles Peskine53190e62019-01-09 23:17:35 +0100443 rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine8f073122018-11-27 15:58:47 +0100444 git checkout-index -f -q $CONFIG_H
445 cleanup
446 else
SimonB2e23c822016-04-16 21:54:39 +0100447
Gilles Peskine8f073122018-11-27 15:58:47 +0100448 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
449 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
450 echo "You can either delete this directory manually, or force the test by rerunning"
451 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
452 exit 1
453 fi
454
Gilles Peskined1174cf2019-01-09 22:30:01 +0100455 if ! git diff --quiet include/mbedtls/config.h; then
Gilles Peskine8f073122018-11-27 15:58:47 +0100456 err_msg "Warning - the configuration file 'include/mbedtls/config.h' has been edited. "
457 echo "You can either delete or preserve your work, or force the test by rerunning the"
458 echo "script as: $0 --force"
459 exit 1
460 fi
Andres AGdc192212016-08-31 17:33:13 +0100461 fi
Gilles Peskine8f073122018-11-27 15:58:47 +0100462}
Andres AGdc192212016-08-31 17:33:13 +0100463
Gilles Peskine8f073122018-11-27 15:58:47 +0100464pre_setup_keep_going () {
Gilles Peskine7c652162017-12-11 00:01:40 +0100465 failure_summary=
466 failure_count=0
467 start_red=
468 end_color=
469 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100470 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100471 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
472 start_red=$(printf '\033[31m')
473 end_color=$(printf '\033[0m')
474 ;;
475 esac
476 fi
477 record_status () {
478 if "$@"; then
479 last_status=0
480 else
481 last_status=$?
482 text="$current_section: $* -> $last_status"
483 failure_summary="$failure_summary
484$text"
485 failure_count=$((failure_count + 1))
Manuel Pégourié-Gonnardde4ad2d2020-06-02 11:28:07 +0200486 echo "${start_red}^^^^$text^^^^${end_color}" >&2
Gilles Peskine7c652162017-12-11 00:01:40 +0100487 fi
488 }
489 make () {
490 case "$*" in
491 *test|*check)
492 if [ $build_status -eq 0 ]; then
493 record_status command make "$@"
494 else
495 echo "(skipped because the build failed)"
496 fi
497 ;;
498 *)
499 record_status command make "$@"
500 build_status=$last_status
501 ;;
502 esac
503 }
504 final_report () {
505 if [ $failure_count -gt 0 ]; then
506 echo
507 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
508 echo "${start_red}FAILED: $failure_count${end_color}$failure_summary"
509 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Jaeden Amero7c1258d2018-07-20 16:42:14 +0100510 exit 1
Gilles Peskine7c652162017-12-11 00:01:40 +0100511 elif [ -z "${1-}" ]; then
512 echo "SUCCESS :)"
513 fi
514 if [ -n "${1-}" ]; then
515 echo "Killed by SIG$1."
516 fi
517 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100518}
519
Gilles Peskine7c652162017-12-11 00:01:40 +0100520if_build_succeeded () {
521 if [ $build_status -eq 0 ]; then
522 record_status "$@"
523 fi
524}
525
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +0200526# to be used instead of ! for commands run with
527# record_status or if_build_succeeded
528not() {
529 ! "$@"
530}
531
Manuel Pégourié-Gonnardde4ad2d2020-06-02 11:28:07 +0200532pre_setup_quiet_redirect () {
533 if [ $QUIET -ne 1 ]; then
534 redirect_out () {
535 "$@"
536 }
537 else
538 redirect_out () {
539 "$@" >/dev/null
540 }
541 fi
542}
543
Gilles Peskine8f073122018-11-27 15:58:47 +0100544pre_print_configuration () {
Manuel Pégourié-Gonnardde4ad2d2020-06-02 11:28:07 +0200545 if [ $QUIET -eq 1 ]; then
546 return
547 fi
548
Gilles Peskine8f073122018-11-27 15:58:47 +0100549 msg "info: $0 configuration"
550 echo "MEMORY: $MEMORY"
551 echo "FORCE: $FORCE"
552 echo "SEED: ${SEED-"UNSET"}"
553 echo "OPENSSL: $OPENSSL"
554 echo "OPENSSL_LEGACY: $OPENSSL_LEGACY"
555 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
556 echo "GNUTLS_CLI: $GNUTLS_CLI"
557 echo "GNUTLS_SERV: $GNUTLS_SERV"
558 echo "GNUTLS_LEGACY_CLI: $GNUTLS_LEGACY_CLI"
559 echo "GNUTLS_LEGACY_SERV: $GNUTLS_LEGACY_SERV"
560 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
561 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
562}
Andres AG87bb5772016-09-27 15:05:15 +0100563
Gilles Peskine87964262019-01-06 22:40:00 +0000564# Make sure the tools we need are available.
Gilles Peskine8f073122018-11-27 15:58:47 +0100565pre_check_tools () {
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000566 # Build the list of variables to pass to output_env.sh.
567 set env
568
Gilles Peskine87964262019-01-06 22:40:00 +0000569 case " $RUN_COMPONENTS " in
570 # Require OpenSSL and GnuTLS if running any tests (as opposed to
571 # only doing builds). Not all tests run OpenSSL and GnuTLS, but this
572 # is a good enough approximation in practice.
573 *" test_"*)
574 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh
575 # and ssl-opt.sh, we just export the variables they require.
576 export OPENSSL_CMD="$OPENSSL"
577 export GNUTLS_CLI="$GNUTLS_CLI"
578 export GNUTLS_SERV="$GNUTLS_SERV"
579 # Avoid passing --seed flag in every call to ssl-opt.sh
580 if [ -n "${SEED-}" ]; then
581 export SEED
582 fi
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000583 set "$@" OPENSSL="$OPENSSL" OPENSSL_LEGACY="$OPENSSL_LEGACY"
584 set "$@" GNUTLS_CLI="$GNUTLS_CLI" GNUTLS_SERV="$GNUTLS_SERV"
585 set "$@" GNUTLS_LEGACY_CLI="$GNUTLS_LEGACY_CLI"
586 set "$@" GNUTLS_LEGACY_SERV="$GNUTLS_LEGACY_SERV"
Gilles Peskine87964262019-01-06 22:40:00 +0000587 check_tools "$OPENSSL" "$OPENSSL_LEGACY" "$OPENSSL_NEXT" \
588 "$GNUTLS_CLI" "$GNUTLS_SERV" \
589 "$GNUTLS_LEGACY_CLI" "$GNUTLS_LEGACY_SERV"
590 ;;
591 esac
Andres AGd9eba4b2016-08-26 14:42:14 +0100592
Gilles Peskine87964262019-01-06 22:40:00 +0000593 case " $RUN_COMPONENTS " in
594 *_doxygen[_\ ]*) check_tools "doxygen" "dot";;
595 esac
Andres AGb2fdd042016-09-22 14:17:46 +0100596
Gilles Peskine87964262019-01-06 22:40:00 +0000597 case " $RUN_COMPONENTS " in
Gilles Peskinea3c6c8a2020-04-30 18:19:32 +0200598 *_arm_none_eabi_gcc[_\ ]*) check_tools "${ARM_NONE_EABI_GCC_PREFIX}gcc";;
Gilles Peskine87964262019-01-06 22:40:00 +0000599 esac
Andres AG7770ea82016-10-10 15:46:20 +0100600
Gilles Peskine87964262019-01-06 22:40:00 +0000601 case " $RUN_COMPONENTS " in
602 *_mingw[_\ ]*) check_tools "i686-w64-mingw32-gcc";;
603 esac
604
605 case " $RUN_COMPONENTS " in
606 *" test_zeroize "*) check_tools "gdb";;
607 esac
608
609 case " $RUN_COMPONENTS " in
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000610 *_armcc*)
Gilles Peskine87964262019-01-06 22:40:00 +0000611 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
612 ARMC5_AR="$ARMC5_BIN_DIR/armar"
Gilles Peskinee6c0c7d2020-04-30 23:11:54 +0200613 ARMC5_FROMELF="$ARMC5_BIN_DIR/fromelf"
Gilles Peskine87964262019-01-06 22:40:00 +0000614 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
615 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Gilles Peskinee6c0c7d2020-04-30 23:11:54 +0200616 ARMC6_FROMELF="$ARMC6_BIN_DIR/fromelf"
617 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC5_FROMELF" \
618 "$ARMC6_CC" "$ARMC6_AR" "$ARMC6_FROMELF";;
Gilles Peskine5331c6e2019-01-06 22:23:42 +0000619 esac
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000620
Manuel Pégourié-Gonnardde4ad2d2020-06-02 11:28:07 +0200621 # past this point, no call to check_tool, only printing output
622 if [ $QUIET -eq 1 ]; then
623 return
624 fi
625
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000626 msg "info: output_env.sh"
627 case $RUN_COMPONENTS in
628 *_armcc*)
629 set "$@" ARMC5_CC="$ARMC5_CC" ARMC6_CC="$ARMC6_CC" RUN_ARMCC=1;;
630 *) set "$@" RUN_ARMCC=0;;
631 esac
632 "$@" scripts/output_env.sh
Gilles Peskine8f073122018-11-27 15:58:47 +0100633}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100634
635
Gilles Peskinecc9f0b92019-01-06 22:46:21 +0000636
Gilles Peskine192c72f2017-12-21 15:59:21 +0100637################################################################
638#### Basic checks
639################################################################
Andres AGd9eba4b2016-08-26 14:42:14 +0100640
SimonB2e23c822016-04-16 21:54:39 +0100641#
642# Test Suites to be executed
643#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200644# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100645# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard61bc57a2014-08-14 11:29:06 +0200646# and/or are more likely to fail than others (eg I use Clang most of the
647# time, so start with a GCC build).
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200648# 2. Minimize total running time, by avoiding useless rebuilds
649#
650# Indicative running times are given for reference.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100651
Gilles Peskine8f073122018-11-27 15:58:47 +0100652component_check_recursion () {
653 msg "test: recursion.pl" # < 1s
654 record_status tests/scripts/recursion.pl library/*.c
655}
Manuel Pégourié-Gonnardea29d152014-11-20 17:32:33 +0100656
Gilles Peskine8f073122018-11-27 15:58:47 +0100657component_check_generated_files () {
658 msg "test: freshness of generated source files" # < 1s
659 record_status tests/scripts/check-generated-files.sh
660}
Manuel Pégourié-Gonnardb3b8e432015-02-13 14:52:19 +0000661
Gilles Peskine8f073122018-11-27 15:58:47 +0100662component_check_doxy_blocks () {
663 msg "test: doxygen markup outside doxygen blocks" # < 1s
664 record_status tests/scripts/check-doxy-blocks.pl
665}
Manuel Pégourié-Gonnardd09a6b52015-04-09 17:19:23 +0200666
Gilles Peskine8f073122018-11-27 15:58:47 +0100667component_check_files () {
Gilles Peskineee694772020-06-25 14:18:34 +0200668 msg "Check: file sanity checks (permissions, encodings)" # < 1s
669 record_status tests/scripts/check_files.py
Gilles Peskine8f073122018-11-27 15:58:47 +0100670}
Darryl Greena07039c2018-03-13 16:48:16 +0000671
Gilles Peskine3c23c822020-05-10 17:40:49 +0200672component_check_changelog () {
673 msg "Check: changelog entries" # < 1s
674 rm -f ChangeLog.new
675 record_status scripts/assemble_changelog.py -o ChangeLog.new
676 if [ -e ChangeLog.new ]; then
677 # Show the diff for information. It isn't an error if the diff is
678 # non-empty.
679 diff -u ChangeLog ChangeLog.new || true
680 rm ChangeLog.new
681 fi
682}
683
Gilles Peskine8f073122018-11-27 15:58:47 +0100684component_check_names () {
685 msg "test/build: declared and exported names" # < 3s
Gilles Peskine473f2d42019-05-15 17:52:22 +0200686 record_status tests/scripts/check-names.sh -v
Gilles Peskine8f073122018-11-27 15:58:47 +0100687}
Manuel Pégourié-Gonnarda687baf2015-04-09 11:09:03 +0200688
Gilles Peskine8f073122018-11-27 15:58:47 +0100689component_check_doxygen_warnings () {
690 msg "test: doxygen warnings" # ~ 3s
Gilles Peskine8f073122018-11-27 15:58:47 +0100691 record_status tests/scripts/doxygen.sh
692}
Manuel Pégourié-Gonnard1d552e72016-01-04 16:49:09 +0100693
Gilles Peskine192c72f2017-12-21 15:59:21 +0100694
695
696################################################################
697#### Build and test many configurations and targets
698################################################################
699
k-stachowiak11f38e22019-06-04 13:14:58 +0200700component_test_large_ecdsa_key_signature () {
701
702 SMALL_MPI_MAX_SIZE=136 # Small enough to interfere with the EC signatures
703
704 msg "build: cmake + MBEDTLS_MPI_MAX_SIZE=${SMALL_MPI_MAX_SIZE}, gcc, ASan" # ~ 1 min 50s
705 scripts/config.pl set MBEDTLS_MPI_MAX_SIZE $SMALL_MPI_MAX_SIZE
706 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
707 make
708
709 INEVITABLY_PRESENT_FILE=Makefile
710 SIGNATURE_FILE="${INEVITABLY_PRESENT_FILE}.sig" # Warning, this is rm -f'ed below
711
712 msg "test: pk_sign secp521r1_prv.der for MBEDTLS_MPI_MAX_SIZE=${SMALL_MPI_MAX_SIZE} (ASan build)" # ~ 5s
713 if_build_succeeded programs/pkey/pk_sign tests/data_files/secp521r1_prv.der $INEVITABLY_PRESENT_FILE
714 rm -f $SIGNATURE_FILE
715}
716
Gilles Peskine99a33102019-04-08 17:00:15 +0200717component_test_default_out_of_box () {
718 msg "build: make, default config (out-of-box)" # ~1min
719 make
720
721 msg "test: main suites make, default config (out-of-box)" # ~10s
722 make test
723
724 msg "selftest: make, default config (out-of-box)" # ~10s
Gilles Peskine5bd9f562020-04-23 23:37:45 +0200725 if_build_succeeded programs/test/selftest
Gilles Peskine99a33102019-04-08 17:00:15 +0200726}
727
Gilles Peskine8f073122018-11-27 15:58:47 +0100728component_test_default_cmake_gcc_asan () {
729 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +0100730 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
731 make
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100732
Gilles Peskine8f073122018-11-27 15:58:47 +0100733 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
734 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200735
Gilles Peskine5bd9f562020-04-23 23:37:45 +0200736 msg "test: selftest (ASan build)" # ~ 10s
737 if_build_succeeded programs/test/selftest
738
Gilles Peskine8f073122018-11-27 15:58:47 +0100739 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
740 if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200741
Gilles Peskine8f073122018-11-27 15:58:47 +0100742 msg "test: compat.sh (ASan build)" # ~ 6 min
743 if_build_succeeded tests/compat.sh
744}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200745
Hanno Beckerf8799e82019-02-26 14:27:09 +0000746component_test_full_cmake_gcc_asan () {
747 msg "build: full config, cmake, gcc, ASan"
748 scripts/config.pl full
749 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
750 make
751
752 msg "test: main suites (inc. selftests) (full config, ASan build)"
753 make test
754
Gilles Peskine5bd9f562020-04-23 23:37:45 +0200755 msg "test: selftest (ASan build)" # ~ 10s
756 if_build_succeeded programs/test/selftest
757
Hanno Beckerf8799e82019-02-26 14:27:09 +0000758 msg "test: ssl-opt.sh (full config, ASan build)"
759 if_build_succeeded tests/ssl-opt.sh
760
761 msg "test: compat.sh (full config, ASan build)"
762 if_build_succeeded tests/compat.sh
763}
764
Manuel Pégourié-Gonnard4ef189d2020-01-02 11:45:12 +0100765component_test_zlib_make() {
766 msg "build: zlib enabled, make"
767 scripts/config.pl set MBEDTLS_ZLIB_SUPPORT
768 make ZLIB=1 CFLAGS='-Werror -O1'
769
770 msg "test: main suites (zlib, make)"
771 make test
772
773 msg "test: ssl-opt.sh (zlib, make)"
774 if_build_succeeded tests/ssl-opt.sh
775}
Manuel Pégourié-Gonnard114d3392020-01-24 10:17:20 +0100776support_test_zlib_make () {
777 base=support_test_zlib_$$
778 cat <<'EOF' > ${base}.c
779#include "zlib.h"
780int main(void) { return 0; }
781EOF
782 gcc -o ${base}.exe ${base}.c -lz 2>/dev/null
783 ret=$?
784 rm -f ${base}.*
785 return $ret
786}
Manuel Pégourié-Gonnard4ef189d2020-01-02 11:45:12 +0100787
788component_test_zlib_cmake() {
789 msg "build: zlib enabled, cmake"
790 scripts/config.pl set MBEDTLS_ZLIB_SUPPORT
791 cmake -D ENABLE_ZLIB_SUPPORT=On -D CMAKE_BUILD_TYPE:String=Check .
792 make
793
794 msg "test: main suites (zlib, cmake)"
795 make test
796
797 msg "test: ssl-opt.sh (zlib, cmake)"
798 if_build_succeeded tests/ssl-opt.sh
799}
Manuel Pégourié-Gonnard114d3392020-01-24 10:17:20 +0100800support_test_zlib_cmake () {
801 support_test_zlib_make "$@"
802}
Manuel Pégourié-Gonnard4ef189d2020-01-02 11:45:12 +0100803
Gilles Peskine782f4112018-11-27 16:11:09 +0100804component_test_ref_configs () {
805 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
806 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
807 record_status tests/scripts/test-ref-configs.pl
808}
809
Gilles Peskine8f073122018-11-27 15:58:47 +0100810component_test_sslv3 () {
811 msg "build: Default + SSLv3 (ASan build)" # ~ 6 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100812 scripts/config.pl set MBEDTLS_SSL_PROTO_SSL3
813 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
814 make
Simon Butcher3ea7f522016-03-07 23:22:10 +0000815
Gilles Peskine8f073122018-11-27 15:58:47 +0100816 msg "test: SSLv3 - main suites (inc. selftests) (ASan build)" # ~ 50s
817 make test
Simon Butcher3ea7f522016-03-07 23:22:10 +0000818
Gilles Peskine8f073122018-11-27 15:58:47 +0100819 msg "build: SSLv3 - compat.sh (ASan build)" # ~ 6 min
820 if_build_succeeded tests/compat.sh -m 'tls1 tls1_1 tls1_2 dtls1 dtls1_2'
821 if_build_succeeded env OPENSSL_CMD="$OPENSSL_LEGACY" tests/compat.sh -m 'ssl3'
Simon Butcher3ea7f522016-03-07 23:22:10 +0000822
Gilles Peskine8f073122018-11-27 15:58:47 +0100823 msg "build: SSLv3 - ssl-opt.sh (ASan build)" # ~ 6 min
824 if_build_succeeded tests/ssl-opt.sh
825}
Simon Butcher3ea7f522016-03-07 23:22:10 +0000826
Gilles Peskine8f073122018-11-27 15:58:47 +0100827component_test_no_renegotiation () {
828 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100829 scripts/config.pl unset MBEDTLS_SSL_RENEGOTIATION
830 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
831 make
Hanno Becker134c2ab2017-10-12 15:29:50 +0100832
Gilles Peskine8f073122018-11-27 15:58:47 +0100833 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
834 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +0100835
Gilles Peskine8f073122018-11-27 15:58:47 +0100836 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
837 if_build_succeeded tests/ssl-opt.sh
838}
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +0100839
Hanno Beckere562e7d2019-05-10 14:45:37 +0100840component_test_no_pem_no_fs () {
841 msg "build: Default + !MBEDTLS_PEM_PARSE_C + !MBEDTLS_FS_IO (ASan build)"
842 scripts/config.pl unset MBEDTLS_PEM_PARSE_C
843 scripts/config.pl unset MBEDTLS_FS_IO
844 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
845 make
846
847 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - main suites (inc. selftests) (ASan build)" # ~ 50s
848 make test
849
850 msg "test: !MBEDTLS_PEM_PARSE_C !MBEDTLS_FS_IO - ssl-opt.sh (ASan build)" # ~ 6 min
851 if_build_succeeded tests/ssl-opt.sh
852}
853
Gilles Peskine8f073122018-11-27 15:58:47 +0100854component_test_rsa_no_crt () {
855 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100856 scripts/config.pl set MBEDTLS_RSA_NO_CRT
857 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
858 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100859
Gilles Peskine8f073122018-11-27 15:58:47 +0100860 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
861 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100862
Gilles Peskine8f073122018-11-27 15:58:47 +0100863 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
864 if_build_succeeded tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100865
Gilles Peskine8f073122018-11-27 15:58:47 +0100866 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
867 if_build_succeeded tests/compat.sh -t RSA
868}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100869
Manuel Pégourié-Gonnard014ff5b2020-05-28 12:55:10 +0200870component_test_no_ctr_drbg () {
871 msg "build: Full minus CTR_DRBG"
872 scripts/config.pl full
873 scripts/config.pl unset MBEDTLS_CTR_DRBG_C
874
875 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
876 make
877
878 msg "test: no CTR_DRBG"
879 make test
880
Manuel Pégourié-Gonnardc5243c12020-06-05 09:29:51 +0200881 # no ssl-opt.sh/compat.sh as they all depend on CTR_DRBG so far
882}
883
884component_test_no_hmac_drbg () {
885 msg "build: Full minus HMAC_DRBG"
886 scripts/config.pl full
887 scripts/config.pl unset MBEDTLS_HMAC_DRBG_C
888 scripts/config.pl unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
889
890 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
891 make
892
893 msg "test: no HMAC_DRBG"
894 make test
895
896 # No ssl-opt.sh/compat.sh as they never use HMAC_DRBG so far,
897 # so there's little value in running those lengthy tests here.
Manuel Pégourié-Gonnard014ff5b2020-05-28 12:55:10 +0200898}
899
Manuel Pégourié-Gonnard72177e32020-06-16 12:51:42 +0200900component_test_no_drbg_all_hashes () {
901 # this tests the internal ECP DRBG using a KDF based on SHA-512
902 msg "build: Default minus DRBGs"
903 scripts/config.pl unset MBEDTLS_CTR_DRBG_C
904 scripts/config.pl unset MBEDTLS_HMAC_DRBG_C
905 scripts/config.pl unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
906 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_C # requires a DRBG
907 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA Crypto
908
909 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
910 make
911
912 msg "test: Default minus DRBGs"
913 make test
914
915 # no SSL tests as they all depend on having a DRBG
916}
917
918component_test_no_drbg_no_sha512 () {
919 # this tests the internal ECP DRBG using a KDF based on SHA-256
920 msg "build: Default minus DRBGs minus SHA-512"
921 scripts/config.pl unset MBEDTLS_CTR_DRBG_C
922 scripts/config.pl unset MBEDTLS_HMAC_DRBG_C
923 scripts/config.pl unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
924 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_C # requires a DRBG
925 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA Crypto
926 scripts/config.pl unset MBEDTLS_SHA512_C
927
928 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
929 make
930
931 msg "test: Default minus DRBGs minus SHA-512"
932 make test
933
934 # no SSL tests as they all depend on having a DRBG
935}
936
Manuel Pégourié-Gonnard23983f32020-05-19 12:38:31 +0200937component_test_ecp_no_internal_rng () {
938 msg "build: Default plus ECP_NO_INTERNAL_RNG minus DRBG modules"
939 scripts/config.pl set MBEDTLS_ECP_NO_INTERNAL_RNG
940 scripts/config.pl unset MBEDTLS_CTR_DRBG_C
941 scripts/config.pl unset MBEDTLS_HMAC_DRBG_C
942 scripts/config.pl unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
943 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_C # requires a DRBG
944 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA Crypto
945
946 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
947 make
948
949 msg "test: ECP_NO_INTERNAL_RNG, no DRBG module"
950 make test
951
952 # no SSL tests as they all depend on having a DRBG
953}
954
Manuel Pégourié-Gonnard047986c2020-06-04 09:43:14 +0200955component_test_ecp_restartable_no_internal_rng () {
956 msg "build: Default plus ECP_RESTARTABLE and ECP_NO_INTERNAL_RNG, no DRBG"
957 scripts/config.pl set MBEDTLS_ECP_NO_INTERNAL_RNG
958 scripts/config.pl set MBEDTLS_ECP_RESTARTABLE
959 scripts/config.pl unset MBEDTLS_CTR_DRBG_C
960 scripts/config.pl unset MBEDTLS_HMAC_DRBG_C
961 scripts/config.pl unset MBEDTLS_ECDSA_DETERMINISTIC # requires HMAC_DRBG
962 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_C # requires CTR_DRBG
963 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_C # requires PSA Crypto
964
965 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
966 make
967
968 msg "test: ECP_RESTARTABLE and ECP_NO_INTERNAL_RNG, no DRBG module"
969 make test
970
971 # no SSL tests as they all depend on having a DRBG
972}
973
Gilles Peskine8f073122018-11-27 15:58:47 +0100974component_test_small_ssl_out_content_len () {
975 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100976 scripts/config.pl set MBEDTLS_SSL_IN_CONTENT_LEN 16384
977 scripts/config.pl set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
978 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
979 make
Angus Grattonc4dd0732018-04-11 16:28:39 +1000980
Gilles Peskine8f073122018-11-27 15:58:47 +0100981 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
982 if_build_succeeded tests/ssl-opt.sh -f "Max fragment\|Large packet"
983}
Angus Grattonc4dd0732018-04-11 16:28:39 +1000984
Gilles Peskine8f073122018-11-27 15:58:47 +0100985component_test_small_ssl_in_content_len () {
986 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100987 scripts/config.pl set MBEDTLS_SSL_IN_CONTENT_LEN 4096
988 scripts/config.pl set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
989 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
990 make
Angus Grattonc4dd0732018-04-11 16:28:39 +1000991
Gilles Peskine8f073122018-11-27 15:58:47 +0100992 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
993 if_build_succeeded tests/ssl-opt.sh -f "Max fragment"
994}
Angus Grattonc4dd0732018-04-11 16:28:39 +1000995
Gilles Peskine8f073122018-11-27 15:58:47 +0100996component_test_small_ssl_dtls_max_buffering () {
997 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine8f073122018-11-27 15:58:47 +0100998 scripts/config.pl set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
999 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1000 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01001001
Gilles Peskine8f073122018-11-27 15:58:47 +01001002 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
1003 if_build_succeeded tests/ssl-opt.sh -f "DTLS reordering: Buffer out-of-order hs msg before reassembling next, free buffered msg"
1004}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01001005
Gilles Peskine8f073122018-11-27 15:58:47 +01001006component_test_small_mbedtls_ssl_dtls_max_buffering () {
1007 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine8f073122018-11-27 15:58:47 +01001008 scripts/config.pl set MBEDTLS_SSL_DTLS_MAX_BUFFERING 240
1009 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1010 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01001011
Gilles Peskine8f073122018-11-27 15:58:47 +01001012 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
1013 if_build_succeeded tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
1014}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +01001015
Gilles Peskine8f073122018-11-27 15:58:47 +01001016component_test_full_cmake_clang () {
1017 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine8f073122018-11-27 15:58:47 +01001018 scripts/config.pl full
Gilles Peskine8f073122018-11-27 15:58:47 +01001019 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Check -D ENABLE_TESTING=On .
1020 make
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01001021
Gilles Peskine8f073122018-11-27 15:58:47 +01001022 msg "test: main suites (full config)" # ~ 5s
1023 make test
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02001024
Gilles Peskine8f073122018-11-27 15:58:47 +01001025 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
1026 if_build_succeeded tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02001027
Andres Amaya Garciaac9c5222019-01-08 21:42:27 +00001028 msg "test: compat.sh RC4, DES, 3DES & NULL (full config)" # ~ 2 min
Andres Amaya Garcia37e0a8c2019-02-19 20:20:57 +00001029 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 +02001030
Gilles Peskine8f073122018-11-27 15:58:47 +01001031 msg "test: compat.sh ARIA + ChachaPoly"
1032 if_build_succeeded env OPENSSL_CMD="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
1033}
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +01001034
Manuel Pégourié-Gonnarda2377222020-07-28 10:53:06 +02001035component_test_memsan_constant_flow () {
Manuel Pégourié-Gonnard2b802492020-07-22 11:09:28 +02001036 # This tests both (1) accesses to undefined memory, and (2) branches or
1037 # memory access depending on secret values. To distinguish between those:
1038 # - unset MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN - does the failure persist?
1039 # - or alternatively, change the build type to MemSanDbg, which enables
1040 # origin tracking and nicer stack traces (which are useful for debugging
1041 # anyway), and check if the origin was TEST_CF_SECRET() or something else.
1042 msg "build: cmake MSan (clang), full config with constant flow testing"
Manuel Pégourié-Gonnarda2377222020-07-28 10:53:06 +02001043 scripts/config.pl full
1044 scripts/config.pl set MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1045 scripts/config.pl unset MBEDTLS_AESNI_C # memsan doesn't grok asm
1046 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
1047 make
1048
Manuel Pégourié-Gonnard2b802492020-07-22 11:09:28 +02001049 msg "test: main suites (Msan + constant flow)"
Manuel Pégourié-Gonnarda2377222020-07-28 10:53:06 +02001050 make test
1051}
1052
Manuel Pégourié-Gonnardf0828472020-08-25 11:26:37 +02001053component_test_valgrind_constant_flow () {
1054 # This tests both (1) everything that valgrind's memcheck usually checks
1055 # (heap buffer overflows, use of uninitialized memory, use-after-free,
1056 # etc.) and (2) branches or memory access depending on secret values,
1057 # which will be reported as uninitialized memory. To distinguish between
1058 # secret and actually uninitialized:
1059 # - unset MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND - does the failure persist?
1060 # - or alternatively, build with debug info and manually run the offending
1061 # test suite with valgrind --track-origins=yes, then check if the origin
1062 # was TEST_CF_SECRET() or something else.
1063 msg "build: cmake release GCC, full config with constant flow testing"
1064 scripts/config.pl full
1065 scripts/config.pl set MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1066 cmake -D CMAKE_BUILD_TYPE:String=Release .
1067 make
1068
1069 # this only shows a summary of the results (how many of each type)
1070 # details are left in Testing/<date>/DynamicAnalysis.xml
1071 msg "test: main suites (valgrind + constant flow)"
1072 make memcheck
1073}
1074
Gilles Peskine77b1f302020-04-28 14:04:28 +02001075component_test_default_no_deprecated () {
1076 # Test that removing the deprecated features from the default
1077 # configuration leaves something consistent.
1078 msg "build: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01001079 scripts/config.pl set MBEDTLS_DEPRECATED_REMOVED
Gilles Peskine77b1f302020-04-28 14:04:28 +02001080 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
1081
1082 msg "test: make, default + MBEDTLS_DEPRECATED_REMOVED" # ~ 5s
1083 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01001084}
Gilles Peskine0afe6242018-02-21 19:28:12 +01001085
Gilles Peskine77b1f302020-04-28 14:04:28 +02001086component_test_full_deprecated_warning () {
1087 # Test that there is nothing deprecated in the full configuration.
1088 # A deprecated feature would trigger a warning (made fatal) from
1089 # MBEDTLS_DEPRECATED_WARNING.
1090 msg "build: make, full + MBEDTLS_DEPRECATED_WARNING" # ~ 30s
1091 scripts/config.pl full
1092 scripts/config.pl unset MBEDTLS_DEPRECATED_REMOVED
1093 scripts/config.pl set MBEDTLS_DEPRECATED_WARNING
1094 # There are currently no tests for any deprecated feature.
1095 # If some are added, 'make test' would trigger warnings here.
1096 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra'
1097
1098 msg "test: make, full + MBEDTLS_DEPRECATED_WARNING" # ~ 5s
1099 make test
1100}
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +02001101
Gilles Peskine8f073122018-11-27 15:58:47 +01001102component_test_depends_curves () {
1103 msg "test/build: curves.pl (gcc)" # ~ 4 min
Gilles Peskine8f073122018-11-27 15:58:47 +01001104 record_status tests/scripts/curves.pl
1105}
Manuel Pégourié-Gonnard1fe6bb92017-06-06 11:36:16 +02001106
Gilles Peskine8f073122018-11-27 15:58:47 +01001107component_test_depends_hashes () {
1108 msg "test/build: depends-hashes.pl (gcc)" # ~ 2 min
Gilles Peskine8f073122018-11-27 15:58:47 +01001109 record_status tests/scripts/depends-hashes.pl
1110}
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +02001111
Gilles Peskine8f073122018-11-27 15:58:47 +01001112component_test_depends_pkalgs () {
1113 msg "test/build: depends-pkalgs.pl (gcc)" # ~ 2 min
Gilles Peskine8f073122018-11-27 15:58:47 +01001114 record_status tests/scripts/depends-pkalgs.pl
1115}
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +02001116
Gilles Peskine8f073122018-11-27 15:58:47 +01001117component_build_key_exchanges () {
1118 msg "test/build: key-exchanges (gcc)" # ~ 1 min
Gilles Peskine8f073122018-11-27 15:58:47 +01001119 record_status tests/scripts/key-exchanges.pl
1120}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001121
Gilles Peskine8f073122018-11-27 15:58:47 +01001122component_build_default_make_gcc_and_cxx () {
1123 msg "build: Unix make, -Os (gcc)" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01001124 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04001125
Gilles Peskine8f073122018-11-27 15:58:47 +01001126 msg "test: verify header list in cpp_dummy_build.cpp"
1127 record_status check_headers_in_cpp
Andrzej Kurek991f9fe2018-07-02 09:08:21 -04001128
Gilles Peskine8f073122018-11-27 15:58:47 +01001129 msg "build: Unix make, incremental g++"
1130 make TEST_CPP=1
1131}
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +00001132
Gilles Peskinedcab2022019-06-12 16:05:50 +02001133component_test_check_params_functionality () {
1134 msg "build+test: MBEDTLS_CHECK_PARAMS functionality"
1135 scripts/config.pl full # includes CHECK_PARAMS
1136 # Make MBEDTLS_PARAM_FAILED call mbedtls_param_failed().
1137 scripts/config.pl unset MBEDTLS_CHECK_PARAMS_ASSERT
Gilles Peskinedcab2022019-06-12 16:05:50 +02001138 # Only build and run tests. Do not build sample programs, because
1139 # they don't have a mbedtls_param_failed() function.
1140 make CC=gcc CFLAGS='-Werror -O1' lib test
1141}
1142
Gilles Peskineb28636b2019-01-02 19:06:24 +01001143component_test_check_params_without_platform () {
1144 msg "build+test: MBEDTLS_CHECK_PARAMS without MBEDTLS_PLATFORM_C"
1145 scripts/config.pl full # includes CHECK_PARAMS
Gilles Peskinedcab2022019-06-12 16:05:50 +02001146 # Keep MBEDTLS_PARAM_FAILED as assert.
Gilles Peskineb28636b2019-01-02 19:06:24 +01001147 scripts/config.pl unset MBEDTLS_PLATFORM_EXIT_ALT
1148 scripts/config.pl unset MBEDTLS_PLATFORM_TIME_ALT
1149 scripts/config.pl unset MBEDTLS_PLATFORM_FPRINTF_ALT
1150 scripts/config.pl unset MBEDTLS_PLATFORM_MEMORY
Gilles Peskinedf4f7c12020-04-28 10:41:20 +02001151 scripts/config.pl unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskineb28636b2019-01-02 19:06:24 +01001152 scripts/config.pl unset MBEDTLS_PLATFORM_PRINTF_ALT
1153 scripts/config.pl unset MBEDTLS_PLATFORM_SNPRINTF_ALT
1154 scripts/config.pl unset MBEDTLS_ENTROPY_NV_SEED
1155 scripts/config.pl unset MBEDTLS_PLATFORM_C
1156 make CC=gcc CFLAGS='-Werror -O1' all test
1157}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +02001158
Gilles Peskineb28636b2019-01-02 19:06:24 +01001159component_test_check_params_silent () {
1160 msg "build+test: MBEDTLS_CHECK_PARAMS with alternative MBEDTLS_PARAM_FAILED()"
1161 scripts/config.pl full # includes CHECK_PARAMS
Gilles Peskinedcab2022019-06-12 16:05:50 +02001162 # Set MBEDTLS_PARAM_FAILED to nothing.
Gilles Peskineb28636b2019-01-02 19:06:24 +01001163 sed -i 's/.*\(#define MBEDTLS_PARAM_FAILED( cond )\).*/\1/' "$CONFIG_H"
1164 make CC=gcc CFLAGS='-Werror -O1' all test
1165}
Hanno Becker5175ac62017-09-18 15:36:25 +01001166
Gilles Peskine8f073122018-11-27 15:58:47 +01001167component_test_no_platform () {
1168 # Full configuration build, without platform support, file IO and net sockets.
1169 # This should catch missing mbedtls_printf definitions, and by disabling file
1170 # IO, it should catch missing '#include <stdio.h>'
1171 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01001172 scripts/config.pl full
1173 scripts/config.pl unset MBEDTLS_PLATFORM_C
1174 scripts/config.pl unset MBEDTLS_NET_C
1175 scripts/config.pl unset MBEDTLS_PLATFORM_MEMORY
1176 scripts/config.pl unset MBEDTLS_PLATFORM_PRINTF_ALT
1177 scripts/config.pl unset MBEDTLS_PLATFORM_FPRINTF_ALT
1178 scripts/config.pl unset MBEDTLS_PLATFORM_SNPRINTF_ALT
1179 scripts/config.pl unset MBEDTLS_PLATFORM_TIME_ALT
1180 scripts/config.pl unset MBEDTLS_PLATFORM_EXIT_ALT
Gilles Peskinedf4f7c12020-04-28 10:41:20 +02001181 scripts/config.pl unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine8f073122018-11-27 15:58:47 +01001182 scripts/config.pl unset MBEDTLS_ENTROPY_NV_SEED
Gilles Peskine8f073122018-11-27 15:58:47 +01001183 scripts/config.pl unset MBEDTLS_FS_IO
1184 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
1185 # to re-enable platform integration features otherwise disabled in C99 builds
Gilles Peskine99d70d82019-09-20 19:23:10 +02001186 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -Os -D_DEFAULT_SOURCE' lib programs
1187 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os' test
Gilles Peskine8f073122018-11-27 15:58:47 +01001188}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02001189
Gilles Peskine8f073122018-11-27 15:58:47 +01001190component_build_no_std_function () {
1191 # catch compile bugs in _uninit functions
1192 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01001193 scripts/config.pl full
1194 scripts/config.pl set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
1195 scripts/config.pl unset MBEDTLS_ENTROPY_NV_SEED
Gilles Peskinedf4f7c12020-04-28 10:41:20 +02001196 scripts/config.pl unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine99d70d82019-09-20 19:23:10 +02001197 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os'
Gilles Peskine8f073122018-11-27 15:58:47 +01001198}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02001199
Gilles Peskine8f073122018-11-27 15:58:47 +01001200component_build_no_ssl_srv () {
1201 msg "build: full config except ssl_srv.c, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01001202 scripts/config.pl full
1203 scripts/config.pl unset MBEDTLS_SSL_SRV_C
Gilles Peskine99d70d82019-09-20 19:23:10 +02001204 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01001205}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +02001206
Gilles Peskine8f073122018-11-27 15:58:47 +01001207component_build_no_ssl_cli () {
1208 msg "build: full config except ssl_cli.c, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01001209 scripts/config.pl full
1210 scripts/config.pl unset MBEDTLS_SSL_CLI_C
Gilles Peskine99d70d82019-09-20 19:23:10 +02001211 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1'
Gilles Peskine8f073122018-11-27 15:58:47 +01001212}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001213
Gilles Peskine8f073122018-11-27 15:58:47 +01001214component_build_no_sockets () {
1215 # Note, C99 compliance can also be tested with the sockets support disabled,
1216 # as that requires a POSIX platform (which isn't the same as C99).
1217 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01001218 scripts/config.pl full
1219 scripts/config.pl unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
1220 scripts/config.pl set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
Gilles Peskine99d70d82019-09-20 19:23:10 +02001221 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O1 -std=c99 -pedantic' lib
Gilles Peskine8f073122018-11-27 15:58:47 +01001222}
Hanno Becker5175ac62017-09-18 15:36:25 +01001223
Andrzej Kurek1d070822019-09-05 09:27:47 -04001224component_test_memory_buffer_allocator_backtrace () {
1225 msg "build: default config with memory buffer allocator and backtrace enabled"
Hanno Becker74b5e342019-02-26 14:34:13 +00001226 scripts/config.pl set MBEDTLS_MEMORY_BUFFER_ALLOC_C
Andrzej Kurek1d070822019-09-05 09:27:47 -04001227 scripts/config.pl set MBEDTLS_PLATFORM_MEMORY
Hanno Becker74b5e342019-02-26 14:34:13 +00001228 scripts/config.pl set MBEDTLS_MEMORY_BACKTRACE
Andrzej Kurek60ebd982019-09-10 02:58:34 -04001229 scripts/config.pl set MBEDTLS_MEMORY_DEBUG
Andrzej Kurek1d070822019-09-05 09:27:47 -04001230 CC=gcc cmake .
1231 make
1232
1233 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C and MBEDTLS_MEMORY_BACKTRACE"
1234 make test
1235}
1236
1237component_test_memory_buffer_allocator () {
1238 msg "build: default config with memory buffer allocator"
1239 scripts/config.pl set MBEDTLS_MEMORY_BUFFER_ALLOC_C
Hanno Beckerd130b982019-06-03 16:35:02 +01001240 scripts/config.pl set MBEDTLS_PLATFORM_MEMORY
Hanno Becker74b5e342019-02-26 14:34:13 +00001241 CC=gcc cmake .
1242 make
1243
1244 msg "test: MBEDTLS_MEMORY_BUFFER_ALLOC_C"
1245 make test
1246
1247 msg "test: ssl-opt.sh, MBEDTLS_MEMORY_BUFFER_ALLOC_C"
Andrzej Kurek1f5a5962019-09-05 10:09:37 -04001248 # MBEDTLS_MEMORY_BUFFER_ALLOC is slow. Skip tests that tend to time out.
1249 if_build_succeeded tests/ssl-opt.sh -e '^DTLS proxy'
Hanno Becker74b5e342019-02-26 14:34:13 +00001250}
1251
Gilles Peskine8f073122018-11-27 15:58:47 +01001252component_test_no_max_fragment_length () {
1253 # Run max fragment length tests with MFL disabled
1254 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01001255 scripts/config.pl unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
1256 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1257 make
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001258
Gilles Peskine8f073122018-11-27 15:58:47 +01001259 msg "test: ssl-opt.sh, MFL-related tests"
1260 if_build_succeeded tests/ssl-opt.sh -f "Max fragment length"
1261}
Angus Grattonc4dd0732018-04-11 16:28:39 +10001262
Gilles Peskine8f073122018-11-27 15:58:47 +01001263component_test_no_max_fragment_length_small_ssl_out_content_len () {
1264 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine8f073122018-11-27 15:58:47 +01001265 scripts/config.pl unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
1266 scripts/config.pl set MBEDTLS_SSL_IN_CONTENT_LEN 16384
1267 scripts/config.pl set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
1268 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1269 make
Angus Grattonc4dd0732018-04-11 16:28:39 +10001270
Gilles Peskine8f073122018-11-27 15:58:47 +01001271 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
1272 if_build_succeeded tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
1273}
Janos Follath06c54002016-06-09 13:57:40 +01001274
Gilles Peskine8f073122018-11-27 15:58:47 +01001275component_test_null_entropy () {
1276 msg "build: default config with MBEDTLS_TEST_NULL_ENTROPY (ASan build)"
Gilles Peskine8f073122018-11-27 15:58:47 +01001277 scripts/config.pl set MBEDTLS_TEST_NULL_ENTROPY
1278 scripts/config.pl set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
1279 scripts/config.pl set MBEDTLS_ENTROPY_C
1280 scripts/config.pl unset MBEDTLS_ENTROPY_NV_SEED
Gilles Peskinedf4f7c12020-04-28 10:41:20 +02001281 scripts/config.pl unset MBEDTLS_PLATFORM_NV_SEED_ALT
Gilles Peskine8f073122018-11-27 15:58:47 +01001282 scripts/config.pl unset MBEDTLS_ENTROPY_HARDWARE_ALT
1283 scripts/config.pl unset MBEDTLS_HAVEGE_C
Gilles Peskine5fa32a72019-01-06 19:48:30 +00001284 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan -D UNSAFE_BUILD=ON .
Gilles Peskine8f073122018-11-27 15:58:47 +01001285 make
Janos Follath06c54002016-06-09 13:57:40 +01001286
Gilles Peskine8f073122018-11-27 15:58:47 +01001287 msg "test: MBEDTLS_TEST_NULL_ENTROPY - main suites (inc. selftests) (ASan build)"
1288 make test
1289}
Hanno Beckere5fecec2018-10-11 11:02:52 +01001290
Raoul Strackx75475d82020-06-15 17:03:13 +02001291component_test_no_date_time () {
1292 msg "build: default config without MBEDTLS_HAVE_TIME_DATE"
1293 scripts/config.pl unset MBEDTLS_HAVE_TIME_DATE
1294 CC=gcc cmake
1295 make
1296
1297 msg "test: !MBEDTLS_HAVE_TIME_DATE - main suites"
1298 make test
1299}
1300
Gilles Peskine8f073122018-11-27 15:58:47 +01001301component_test_platform_calloc_macro () {
1302 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine8f073122018-11-27 15:58:47 +01001303 scripts/config.pl set MBEDTLS_PLATFORM_MEMORY
1304 scripts/config.pl set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
1305 scripts/config.pl set MBEDTLS_PLATFORM_FREE_MACRO free
1306 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1307 make
Hanno Beckere5fecec2018-10-11 11:02:52 +01001308
Gilles Peskine8f073122018-11-27 15:58:47 +01001309 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
1310 make test
1311}
Hanno Becker83ebf782017-07-07 12:29:15 +01001312
Gilles Peskinec6b09862019-09-17 19:04:38 +02001313component_test_malloc_0_null () {
1314 msg "build: malloc(0) returns NULL (ASan+UBSan build)"
1315 scripts/config.pl full
1316 scripts/config.pl unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
1317 make CC=gcc CFLAGS="'-DMBEDTLS_CONFIG_FILE=\"$PWD/tests/configs/config-wrapper-malloc-0-null.h\"' -O -Werror -Wall -Wextra -fsanitize=address,undefined" LDFLAGS='-fsanitize=address,undefined'
1318
1319 msg "test: malloc(0) returns NULL (ASan+UBSan build)"
1320 make test
1321
1322 msg "selftest: malloc(0) returns NULL (ASan+UBSan build)"
1323 # Just the calloc selftest. "make test" ran the others as part of the
1324 # test suites.
1325 if_build_succeeded programs/test/selftest calloc
1326}
1327
Gilles Peskine8f073122018-11-27 15:58:47 +01001328component_test_aes_fewer_tables () {
1329 msg "build: default config with AES_FEWER_TABLES enabled"
Gilles Peskine8f073122018-11-27 15:58:47 +01001330 scripts/config.pl set MBEDTLS_AES_FEWER_TABLES
1331 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01001332
Gilles Peskine8f073122018-11-27 15:58:47 +01001333 msg "test: AES_FEWER_TABLES"
1334 make test
1335}
Hanno Becker83ebf782017-07-07 12:29:15 +01001336
Gilles Peskine8f073122018-11-27 15:58:47 +01001337component_test_aes_rom_tables () {
1338 msg "build: default config with AES_ROM_TABLES enabled"
Gilles Peskine8f073122018-11-27 15:58:47 +01001339 scripts/config.pl set MBEDTLS_AES_ROM_TABLES
1340 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01001341
Gilles Peskine8f073122018-11-27 15:58:47 +01001342 msg "test: AES_ROM_TABLES"
1343 make test
1344}
Hanno Becker83ebf782017-07-07 12:29:15 +01001345
Gilles Peskine8f073122018-11-27 15:58:47 +01001346component_test_aes_fewer_tables_and_rom_tables () {
1347 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
Gilles Peskine8f073122018-11-27 15:58:47 +01001348 scripts/config.pl set MBEDTLS_AES_FEWER_TABLES
1349 scripts/config.pl set MBEDTLS_AES_ROM_TABLES
1350 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +01001351
Gilles Peskine8f073122018-11-27 15:58:47 +01001352 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
1353 make test
1354}
1355
1356component_test_make_shared () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001357 msg "build/test: make shared" # ~ 40s
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001358 make SHARED=1 all check
Gilles Peskinedc25c322019-07-03 20:43:32 +02001359 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskine8f073122018-11-27 15:58:47 +01001360}
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +02001361
Gilles Peskine2c47ffc2019-07-03 20:43:05 +02001362component_test_cmake_shared () {
1363 msg "build/test: cmake shared" # ~ 2min
1364 cmake -DUSE_SHARED_MBEDTLS_LIBRARY=On .
1365 make
Gilles Peskinedc25c322019-07-03 20:43:32 +02001366 ldd programs/util/strerror | grep libmbedcrypto
Gilles Peskine2c47ffc2019-07-03 20:43:05 +02001367 make test
1368}
1369
Gilles Peskine0fe92c22019-09-20 19:56:06 +02001370test_build_opt () {
1371 info=$1 cc=$2; shift 2
1372 for opt in "$@"; do
1373 msg "build/test: $cc $opt, $info" # ~ 30s
Gilles Peskine313bb502020-04-14 20:08:41 +02001374 make CC="$cc" CFLAGS="$opt -std=c99 -pedantic -Wall -Wextra -Werror"
Gilles Peskine0fe92c22019-09-20 19:56:06 +02001375 # We're confident enough in compilers to not run _all_ the tests,
1376 # but at least run the unit tests. In particular, runs with
1377 # optimizations use inline assembly whereas runs with -O0
1378 # skip inline assembly.
1379 make test # ~30s
1380 make clean
1381 done
1382}
1383
1384component_test_clang_opt () {
1385 scripts/config.pl full
1386 test_build_opt 'full config' clang -O0 -Os -O2
1387}
1388
1389component_test_gcc_opt () {
1390 scripts/config.pl full
1391 test_build_opt 'full config' gcc -O0 -Os -O2
1392}
1393
Gilles Peskine87bf1b52019-07-03 20:42:16 +02001394component_build_mbedtls_config_file () {
1395 msg "build: make with MBEDTLS_CONFIG_FILE" # ~40s
1396 # Use the full config so as to catch a maximum of places where
1397 # the check of MBEDTLS_CONFIG_FILE might be missing.
1398 scripts/config.pl full
1399 sed 's!"check_config.h"!"mbedtls/check_config.h"!' <"$CONFIG_H" >full_config.h
1400 echo '#error "MBEDTLS_CONFIG_FILE is not working"' >"$CONFIG_H"
1401 make CFLAGS="-I '$PWD' -DMBEDTLS_CONFIG_FILE='\"full_config.h\"'"
1402 rm -f full_config.h
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001403}
1404
Gilles Peskine8f073122018-11-27 15:58:47 +01001405component_test_m32_o0 () {
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001406 # Build once with -O0, to compile out the i386 specific inline assembly
1407 msg "build: i386, make, gcc -O0 (ASan build)" # ~ 30s
Simon Butcher7a6da6e2018-06-27 21:52:54 +01001408 scripts/config.pl full
Gilles Peskineff26b042019-10-21 17:11:33 +02001409 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O0" LDFLAGS="-m32 $ASAN_CFLAGS"
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01001410
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001411 msg "test: i386, make, gcc -O0 (ASan build)"
1412 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01001413}
Gilles Peskine878cf602019-01-06 20:50:38 +00001414support_test_m32_o0 () {
1415 case $(uname -m) in
1416 *64*) true;;
1417 *) false;;
1418 esac
1419}
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001420
Gilles Peskine8f073122018-11-27 15:58:47 +01001421component_test_m32_o1 () {
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001422 # Build again with -O1, to compile in the i386 specific inline assembly
1423 msg "build: i386, make, gcc -O1 (ASan build)" # ~ 30s
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001424 scripts/config.pl full
Gilles Peskineff26b042019-10-21 17:11:33 +02001425 make CC=gcc CFLAGS="$ASAN_CFLAGS -m32 -O1" LDFLAGS="-m32 $ASAN_CFLAGS"
Simon Butcher8e6a22a2018-07-20 21:27:33 +01001426
1427 msg "test: i386, make, gcc -O1 (ASan build)"
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01001428 make test
Gilles Peskine7dd44b22019-04-08 16:58:02 +02001429
1430 msg "test ssl-opt.sh, i386, make, gcc-O1"
1431 if_build_succeeded tests/ssl-opt.sh
Gilles Peskine8f073122018-11-27 15:58:47 +01001432}
Gilles Peskine878cf602019-01-06 20:50:38 +00001433support_test_m32_o1 () {
1434 support_test_m32_o0 "$@"
1435}
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01001436
Gilles Peskine8f073122018-11-27 15:58:47 +01001437component_test_mx32 () {
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01001438 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Simon Butcher7a6da6e2018-06-27 21:52:54 +01001439 scripts/config.pl full
Gilles Peskine8118e462019-06-07 14:50:09 +02001440 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mx32' LDFLAGS='-mx32'
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +01001441
1442 msg "test: 64-bit ILP32, make, gcc"
1443 make test
Gilles Peskine8f073122018-11-27 15:58:47 +01001444}
Gilles Peskine878cf602019-01-06 20:50:38 +00001445support_test_mx32 () {
1446 case $(uname -m) in
1447 amd64|x86_64) true;;
1448 *) false;;
1449 esac
1450}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001451
Peter Kolbus1e2aa722018-12-27 06:59:04 -06001452component_test_min_mpi_window_size () {
1453 msg "build: Default + MBEDTLS_MPI_WINDOW_SIZE=1 (ASan build)" # ~ 10s
1454 scripts/config.pl set MBEDTLS_MPI_WINDOW_SIZE 1
1455 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
1456 make
1457
1458 msg "test: MBEDTLS_MPI_WINDOW_SIZE=1 - main suites (inc. selftests) (ASan build)" # ~ 10s
1459 make test
1460}
1461
Gilles Peskine8f073122018-11-27 15:58:47 +01001462component_test_have_int32 () {
1463 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine8f073122018-11-27 15:58:47 +01001464 scripts/config.pl unset MBEDTLS_HAVE_ASM
1465 scripts/config.pl unset MBEDTLS_AESNI_C
1466 scripts/config.pl unset MBEDTLS_PADLOCK_C
1467 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +01001468
Gilles Peskine8f073122018-11-27 15:58:47 +01001469 msg "test: gcc, force 32-bit bignum limbs"
1470 make test
1471}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +01001472
Gilles Peskine8f073122018-11-27 15:58:47 +01001473component_test_have_int64 () {
1474 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine8f073122018-11-27 15:58:47 +01001475 scripts/config.pl unset MBEDTLS_HAVE_ASM
1476 scripts/config.pl unset MBEDTLS_AESNI_C
1477 scripts/config.pl unset MBEDTLS_PADLOCK_C
1478 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +01001479
Gilles Peskine8f073122018-11-27 15:58:47 +01001480 msg "test: gcc, force 64-bit bignum limbs"
1481 make test
1482}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +00001483
Gilles Peskine8f073122018-11-27 15:58:47 +01001484component_test_no_udbl_division () {
1485 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine8f073122018-11-27 15:58:47 +01001486 scripts/config.pl full
Gilles Peskine8f073122018-11-27 15:58:47 +01001487 scripts/config.pl set MBEDTLS_NO_UDBL_DIVISION
1488 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001489
Gilles Peskine8f073122018-11-27 15:58:47 +01001490 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
1491 make test
1492}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001493
Gilles Peskine8f073122018-11-27 15:58:47 +01001494component_test_no_64bit_multiplication () {
1495 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine8f073122018-11-27 15:58:47 +01001496 scripts/config.pl full
Gilles Peskine8f073122018-11-27 15:58:47 +01001497 scripts/config.pl set MBEDTLS_NO_64BIT_MULTIPLICATION
1498 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001499
Gilles Peskine8f073122018-11-27 15:58:47 +01001500 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
1501 make test
1502}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001503
Gilles Peskine8ffc1582020-11-09 15:40:05 +01001504component_test_no_strings () {
1505 msg "build: no strings" # ~10s
1506 scripts/config.pl full
1507 # Disable options that activate a large amount of string constants.
1508 scripts/config.pl unset MBEDTLS_DEBUG_C
1509 scripts/config.pl unset MBEDTLS_ERROR_C
1510 scripts/config.pl set MBEDTLS_ERROR_STRERROR_DUMMY
1511 scripts/config.pl unset MBEDTLS_VERSION_FEATURES
1512 make CFLAGS='-Werror -Os'
1513
1514 msg "test: no strings" # ~ 10s
1515 make test
1516}
1517
Gilles Peskine8f073122018-11-27 15:58:47 +01001518component_build_arm_none_eabi_gcc () {
Gilles Peskinee6c0c7d2020-04-30 23:11:54 +02001519 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1" # ~ 10s
Manuel Pégourié-Gonnard6e6ae9b2019-04-29 12:44:12 +02001520 scripts/config.pl baremetal
Gilles Peskinefcccfbc2020-04-30 22:54:00 +02001521 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-Werror -Wall -Wextra -O1' lib
Gilles Peskinee6c0c7d2020-04-30 23:11:54 +02001522
1523 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -O1"
1524 ${ARM_NONE_EABI_GCC_PREFIX}size library/*.o
Gilles Peskine8f073122018-11-27 15:58:47 +01001525}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +02001526
Gilles Peskine560f3322019-08-09 16:05:05 +02001527component_build_arm_none_eabi_gcc_arm5vte () {
Gilles Peskinee6c0c7d2020-04-30 23:11:54 +02001528 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=arm5vte" # ~ 10s
Gilles Peskine0bd284d2019-08-05 11:34:25 +02001529 scripts/config.pl baremetal
Gilles Peskine560f3322019-08-09 16:05:05 +02001530 # Build for a target platform that's close to what Debian uses
1531 # for its "armel" distribution (https://wiki.debian.org/ArmEabiPort).
1532 # See https://github.com/ARMmbed/mbedtls/pull/2169 and comments.
1533 # It would be better to build with arm-linux-gnueabi-gcc but
1534 # we don't have that on our CI at this time.
Gilles Peskinea3c6c8a2020-04-30 18:19:32 +02001535 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" CFLAGS='-Werror -Wall -Wextra -march=armv5te -O1' LDFLAGS='-march=armv5te' SHELL='sh -x' lib
Gilles Peskinee6c0c7d2020-04-30 23:11:54 +02001536
1537 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -march=armv5te -O1"
1538 ${ARM_NONE_EABI_GCC_PREFIX}size library/*.o
Gilles Peskine0bd284d2019-08-05 11:34:25 +02001539}
1540
Gilles Peskinedac156b2020-04-30 23:00:53 +02001541component_build_arm_none_eabi_gcc_m0plus () {
1542 msg "build: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus" # ~ 10s
1543 scripts/config.pl baremetal
1544 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-Werror -Wall -Wextra -mthumb -mcpu=cortex-m0plus -Os' lib
Gilles Peskinee6c0c7d2020-04-30 23:11:54 +02001545
1546 msg "size: ${ARM_NONE_EABI_GCC_PREFIX}gcc -mthumb -mcpu=cortex-m0plus -Os"
1547 ${ARM_NONE_EABI_GCC_PREFIX}size library/*.o
Gilles Peskine5331c6e2019-01-06 22:23:42 +00001548}
Andres AG87bb5772016-09-27 15:05:15 +01001549
Gilles Peskine5331c6e2019-01-06 22:23:42 +00001550component_build_arm_none_eabi_gcc_no_udbl_division () {
Gilles Peskinea3c6c8a2020-04-30 18:19:32 +02001551 msg "build: ${ARM_NONE_EABI_GCC_PREFIX} -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552 scripts/config.pl baremetal
Simon Butcher1c719652016-06-27 19:02:12 +01001553 scripts/config.pl set MBEDTLS_NO_UDBL_DIVISION
Gilles Peskinea3c6c8a2020-04-30 18:19:32 +02001554 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-Werror -Wall -Wextra' lib
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555 echo "Checking that software 64-bit division is not required"
1556 if_build_succeeded not grep __aeabi_uldiv library/*.o
1557}
1558
Manuel Pégourié-Gonnardbbc60db2015-06-22 14:31:50 +02001559component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
Gilles Peskinea3c6c8a2020-04-30 18:19:32 +02001560 msg "build: ${ARM_NONE_EABI_GCC_PREFIX} MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01001561 scripts/config.pl baremetal
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001562 scripts/config.pl set MBEDTLS_NO_64BIT_MULTIPLICATION
Gilles Peskinea3c6c8a2020-04-30 18:19:32 +02001563 make CC="${ARM_NONE_EABI_GCC_PREFIX}gcc" AR="${ARM_NONE_EABI_GCC_PREFIX}ar" LD="${ARM_NONE_EABI_GCC_PREFIX}ld" CFLAGS='-Werror -O1 -march=armv6-m -mthumb' lib
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564 echo "Checking that software 64-bit multiplication is not required"
1565 if_build_succeeded not grep __aeabi_lmul library/*.o
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01001566}
Simon Butcherbc6a4862016-03-07 17:35:59 +00001567
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01001568component_build_armcc () {
Gilles Peskinee6c0c7d2020-04-30 23:11:54 +02001569 msg "build: ARM Compiler 5"
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570 scripts/config.pl baremetal
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +01001571 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
Gilles Peskinee6c0c7d2020-04-30 23:11:54 +02001572
1573 msg "size: ARM Compiler 5"
1574 "$ARMC5_FROMELF" -z library/*.o
1575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576 make clean
1577
1578 # ARM Compiler 6 - Target ARMv7-A
1579 armc6_build_test "--target=arm-arm-none-eabi -march=armv7-a"
1580
1581 # ARM Compiler 6 - Target ARMv7-M
Simon Butcher4df5eaf2016-08-24 22:58:31 +03001582 armc6_build_test "--target=arm-arm-none-eabi -march=armv7-m"
Andres AG87bb5772016-09-27 15:05:15 +01001583
Gilles Peskine5331c6e2019-01-06 22:23:42 +00001584 # ARM Compiler 6 - Target ARMv8-A - AArch32
1585 armc6_build_test "--target=arm-arm-none-eabi -march=armv8.2-a"
Andres AG87bb5772016-09-27 15:05:15 +01001586
Gilles Peskine5331c6e2019-01-06 22:23:42 +00001587 # ARM Compiler 6 - Target ARMv8-M
1588 armc6_build_test "--target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +02001589
Gilles Peskine5331c6e2019-01-06 22:23:42 +00001590 # ARM Compiler 6 - Target ARMv8-A - AArch64
1591 armc6_build_test "--target=aarch64-arm-none-eabi -march=armv8.2-a"
Gilles Peskine8f073122018-11-27 15:58:47 +01001592}
Simon Butcher940737f2017-07-23 13:42:36 +02001593
Andres Amaya Garcia9f3bdb82018-12-05 22:03:56 +00001594component_build_ssl_hw_record_accel() {
1595 msg "build: default config with MBEDTLS_SSL_HW_RECORD_ACCEL enabled"
1596 scripts/config.pl set MBEDTLS_SSL_HW_RECORD_ACCEL
1597 make CFLAGS='-Werror -O1'
1598}
1599
Gilles Peskine8f073122018-11-27 15:58:47 +01001600component_test_allow_sha1 () {
1601 msg "build: allow SHA1 in certificates by default"
Gilles Peskine8f073122018-11-27 15:58:47 +01001602 scripts/config.pl set MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
1603 make CFLAGS='-Werror -Wall -Wextra'
1604 msg "test: allow SHA1 in certificates by default"
1605 make test
1606 if_build_succeeded tests/ssl-opt.sh -f SHA-1
1607}
Simon Butcher940737f2017-07-23 13:42:36 +02001608
Gilles Peskine8f073122018-11-27 15:58:47 +01001609component_build_mingw () {
1610 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01001611 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
Gilles Peskine2a458da2017-05-12 15:26:58 +02001612
Gilles Peskine8f073122018-11-27 15:58:47 +01001613 # note Make tests only builds the tests, but doesn't run them
1614 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror' WINDOWS_BUILD=1 tests
1615 make WINDOWS_BUILD=1 clean
Hanno Beckere963efa2018-01-03 10:03:43 +00001616
Gilles Peskine8f073122018-11-27 15:58:47 +01001617 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
1618 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
1619 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
1620 make WINDOWS_BUILD=1 clean
1621}
Simon Butcher002bc622016-11-17 09:27:45 +00001622
Gilles Peskine8f073122018-11-27 15:58:47 +01001623component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001624 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001625 scripts/config.pl unset MBEDTLS_AESNI_C # memsan doesn't grok asm
1626 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
1627 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02001628
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001629 msg "test: main suites (MSan)" # ~ 10s
1630 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001631
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001632 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine7c652162017-12-11 00:01:40 +01001633 if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001634
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001635 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001636
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001637 if [ "$MEMORY" -gt 0 ]; then
1638 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine7c652162017-12-11 00:01:40 +01001639 if_build_succeeded tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001640 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01001641}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001642
Gilles Peskine69f190e2019-01-10 00:11:42 +01001643component_test_valgrind () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001644 msg "build: Release (clang)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001645 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
1646 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001647
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001648 msg "test: main suites valgrind (Release)"
1649 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001650
Gilles Peskine0a47c4f2019-04-08 17:00:56 +02001651 # Optional parts (slow; currently broken on OS X because programs don't
1652 # seem to receive signals under valgrind on OS X).
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001653 if [ "$MEMORY" -gt 0 ]; then
1654 msg "test: ssl-opt.sh --memcheck (Release)"
Gilles Peskine7c652162017-12-11 00:01:40 +01001655 if_build_succeeded tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001656 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001657
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001658 if [ "$MEMORY" -gt 1 ]; then
1659 msg "test: compat.sh --memcheck (Release)"
Gilles Peskine7c652162017-12-11 00:01:40 +01001660 if_build_succeeded tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001661 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01001662}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001663
Gilles Peskine8f073122018-11-27 15:58:47 +01001664component_test_cmake_out_of_source () {
1665 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01001666 MBEDTLS_ROOT_DIR="$PWD"
1667 mkdir "$OUT_OF_SOURCE_DIR"
1668 cd "$OUT_OF_SOURCE_DIR"
1669 cmake "$MBEDTLS_ROOT_DIR"
1670 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001671
Gilles Peskine8f073122018-11-27 15:58:47 +01001672 msg "test: cmake 'out-of-source' build"
1673 make test
1674 # Test an SSL option that requires an auxiliary script in test/scripts/.
1675 # Also ensure that there are no error messages such as
1676 # "No such file or directory", which would indicate that some required
1677 # file is missing (ssl-opt.sh tolerates the absence of some files so
1678 # may exit with status 0 but emit errors).
1679 if_build_succeeded ./tests/ssl-opt.sh -f 'Fallback SCSV: beginning of list' 2>ssl-opt.err
1680 if [ -s ssl-opt.err ]; then
1681 cat ssl-opt.err >&2
1682 record_status [ ! -s ssl-opt.err ]
1683 rm ssl-opt.err
1684 fi
1685 cd "$MBEDTLS_ROOT_DIR"
1686 rm -rf "$OUT_OF_SOURCE_DIR"
1687 unset MBEDTLS_ROOT_DIR
1688}
Andres AGdc192212016-08-31 17:33:13 +01001689
Gilles Peskine8f073122018-11-27 15:58:47 +01001690component_test_zeroize () {
1691 # Test that the function mbedtls_platform_zeroize() is not optimized away by
1692 # different combinations of compilers and optimization flags by using an
1693 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
1694 # system in all cases that the script fails, so we must manually search the
1695 # output to check whether the pass string is present and no failure strings
1696 # were printed.
Gilles Peskine4976e822019-01-06 19:52:22 +00001697
1698 # Don't try to disable ASLR. We don't care about ASLR here. We do care
1699 # about a spurious message if Gdb tries and fails, so suppress that.
1700 gdb_disable_aslr=
1701 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
1702 gdb_disable_aslr='set disable-randomization off'
1703 fi
1704
Gilles Peskine8f073122018-11-27 15:58:47 +01001705 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine55f7c942019-01-09 22:28:21 +01001706 for compiler in clang gcc; do
1707 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
1708 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine4976e822019-01-06 19:52:22 +00001709 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 +01001710 if_build_succeeded grep "The buffer was correctly zeroized" test_zeroize.log
1711 if_build_succeeded not grep -i "error" test_zeroize.log
1712 rm -f test_zeroize.log
1713 make clean
1714 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01001715 done
Gilles Peskine4976e822019-01-06 19:52:22 +00001716
1717 unset gdb_disable_aslr
Gilles Peskine8f073122018-11-27 15:58:47 +01001718}
Andres Amaya Garciad0d7bf62017-10-25 09:01:31 +01001719
Gilles Peskine8f073122018-11-27 15:58:47 +01001720component_check_python_files () {
1721 msg "Lint: Python scripts"
1722 record_status tests/scripts/check-python-files.sh
1723}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001724
Gilles Peskine8f073122018-11-27 15:58:47 +01001725component_check_generate_test_code () {
1726 msg "uint test: generate_test_code.py"
Manuel Pégourié-Gonnard1ee68502020-06-02 11:40:08 +02001727 # unittest writes out mundane stuff like number or tests run on stderr.
1728 # Our convention is to reserve stderr for actual errors, and write
1729 # harmless info on stdout so it can be suppress with --quiet.
1730 record_status ./tests/scripts/test_generate_test_code.py 2>&1
Gilles Peskine8f073122018-11-27 15:58:47 +01001731}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001732
1733################################################################
1734#### Termination
1735################################################################
1736
Gilles Peskine8f073122018-11-27 15:58:47 +01001737post_report () {
1738 msg "Done, cleaning up"
1739 cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001740
Gilles Peskine8f073122018-11-27 15:58:47 +01001741 final_report
1742}
1743
1744
1745
1746################################################################
1747#### Run all the things
1748################################################################
1749
Gilles Peskinee48351a2018-11-27 16:06:30 +01001750# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01001751run_component () {
Gilles Peskine608953e2019-01-02 18:57:02 +01001752 # Back up the configuration in case the component modifies it.
1753 # The cleanup function will restore it.
1754 cp -p "$CONFIG_H" "$CONFIG_BAK"
Gilles Peskineffcdeff2018-12-04 12:49:28 +01001755 current_component="$1"
Manuel Pégourié-Gonnardde4ad2d2020-06-02 11:28:07 +02001756
1757 # Run the component code.
1758 if [ $QUIET -eq 1 ]; then
1759 # msg() is silenced, so just print the component name here
1760 echo "${current_component#component_}"
1761 fi
1762 redirect_out "$@"
1763
1764 # Restore the build tree to a clean state.
Gilles Peskinee48351a2018-11-27 16:06:30 +01001765 cleanup
Manuel Pégourié-Gonnard805b1462020-06-08 10:59:41 +02001766 unset current_component
Gilles Peskine8f073122018-11-27 15:58:47 +01001767}
1768
1769# Preliminary setup
1770pre_check_environment
1771pre_initialize_variables
1772pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01001773
Gilles Peskine878cf602019-01-06 20:50:38 +00001774pre_check_git
1775build_status=0
1776if [ $KEEP_GOING -eq 1 ]; then
1777 pre_setup_keep_going
1778else
1779 record_status () {
1780 "$@"
1781 }
1782fi
Manuel Pégourié-Gonnardde4ad2d2020-06-02 11:28:07 +02001783pre_setup_quiet_redirect
Gilles Peskine878cf602019-01-06 20:50:38 +00001784pre_print_configuration
1785pre_check_tools
Gilles Peskine878cf602019-01-06 20:50:38 +00001786cleanup
Gilles Peskine8f073122018-11-27 15:58:47 +01001787
Gilles Peskinebeb3a812019-01-06 22:11:25 +00001788# Run the requested tests.
1789for component in $RUN_COMPONENTS; do
1790 run_component "component_$component"
1791done
Gilles Peskine8f073122018-11-27 15:58:47 +01001792
1793# We're done.
Gilles Peskine878cf602019-01-06 20:50:38 +00001794post_report