blob: 11cdbe80cd6e8246475b196589e4d42b3282f257 [file] [log] [blame]
Andres AG31f9b5b2016-10-04 17:14:38 +01001#! /usr/bin/env sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01002
Simon Butcher3ea7f522016-03-07 23:22:10 +00003# all.sh
4#
SimonB2e23c822016-04-16 21:54:39 +01005# This file is part of mbed TLS (https://tls.mbed.org)
6#
Gilles Peskine192c72f2017-12-21 15:59:21 +01007# Copyright (c) 2014-2017, ARM Limited, All Rights Reserved
8
9
10
11################################################################
12#### Documentation
13################################################################
14
Simon Butcher3ea7f522016-03-07 23:22:10 +000015# Purpose
Gilles Peskine192c72f2017-12-21 15:59:21 +010016# -------
Simon Butcher3ea7f522016-03-07 23:22:10 +000017#
SimonB2e23c822016-04-16 21:54:39 +010018# To run all tests possible or available on the platform.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010019#
Gilles Peskine192c72f2017-12-21 15:59:21 +010020# Notes for users
21# ---------------
22#
SimonB2e23c822016-04-16 21:54:39 +010023# Warning: the test is destructive. It includes various build modes and
24# configurations, and can and will arbitrarily change the current CMake
Gilles Peskine192c72f2017-12-21 15:59:21 +010025# configuration. The following files must be committed into git:
26# * include/mbedtls/config.h
27# * Makefile, library/Makefile, programs/Makefile, tests/Makefile
28# After running this script, the CMake cache will be lost and CMake
29# will no longer be initialised.
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +010030#
Gilles Peskine192c72f2017-12-21 15:59:21 +010031# The script assumes the presence of a number of tools:
32# * Basic Unix tools (Windows users note: a Unix-style find must be before
33# the Windows find in the PATH)
34# * Perl
35# * GNU Make
36# * CMake
37# * GCC and Clang (recent enough for using ASan with gcc and MemSan with clang, or valgrind)
Andrzej Kurek05be06c2018-06-28 04:41:50 -040038# * G++
Gilles Peskine192c72f2017-12-21 15:59:21 +010039# * arm-gcc and mingw-gcc
40# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
Gilles Peskine192c72f2017-12-21 15:59:21 +010041# * OpenSSL and GnuTLS command line tools, recent enough for the
42# interoperability tests. If they don't support SSLv3 then a legacy
43# version of these tools must be present as well (search for LEGACY
44# below).
45# See the invocation of check_tools below for details.
46#
47# This script must be invoked from the toplevel directory of a git
48# working copy of Mbed TLS.
49#
50# Note that the output is not saved. You may want to run
51# script -c tests/scripts/all.sh
52# or
53# tests/scripts/all.sh >all.log 2>&1
54#
55# Notes for maintainers
56# ---------------------
57#
Gilles Peskine8f073122018-11-27 15:58:47 +010058# The bulk of the code is organized into functions that follow one of the
59# following naming conventions:
60# * pre_XXX: things to do before running the tests, in order.
61# * component_XXX: independent components. They can be run in any order.
62# * component_check_XXX: quick tests that aren't worth parallelizing
63# * component_build_XXX: build things but don't run them
64# * component_test_XXX: build and test
65# * post_XXX: things to do after running the tests.
66# * other: miscellaneous support functions.
67#
Gilles Peskine192c72f2017-12-21 15:59:21 +010068# The tests are roughly in order from fastest to slowest. This doesn't
69# have to be exact, but in general you should add slower tests towards
70# the end and fast checks near the beginning.
71#
72# Sanity checks have the following form:
73# 1. msg "short description of what is about to be done"
74# 2. run sanity check (failure stops the script)
75#
76# Build or build-and-test steps have the following form:
77# 1. msg "short description of what is about to be done"
78# 2. cleanup
79# 3. preparation (config.pl, cmake, ...) (failure stops the script)
80# 4. make
81# 5. Run tests if relevant. All tests must be prefixed with
82# if_build_successful for the sake of --keep-going.
83
84
85
86################################################################
87#### Initialization and command line parsing
88################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010089
SimonB2e23c822016-04-16 21:54:39 +010090# Abort on errors (and uninitialised variables)
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010091set -eu
92
Gilles Peskine8f073122018-11-27 15:58:47 +010093pre_check_environment () {
Gilles Peskinebdf3f522019-01-06 19:58:02 +000094 if [ -d library -a -d include -a -d tests ]; then :; else
Gilles Peskine8f073122018-11-27 15:58:47 +010095 echo "Must be run from mbed TLS root" >&2
96 exit 1
97 fi
98}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010099
Gilles Peskine8f073122018-11-27 15:58:47 +0100100pre_initialize_variables () {
101 CONFIG_H='include/mbedtls/config.h'
102 CONFIG_BAK="$CONFIG_H.bak"
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200103
Gilles Peskine92525112018-11-27 18:15:35 +0100104 COMPONENTS=
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100105 ALL_EXCEPT=0
Gilles Peskine8f073122018-11-27 15:58:47 +0100106 MEMORY=0
107 FORCE=0
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100108 INTROSPECTION_MODE=
Gilles Peskine8f073122018-11-27 15:58:47 +0100109 KEEP_GOING=0
110 RUN_ARMCC=1
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100111
Gilles Peskine8f073122018-11-27 15:58:47 +0100112 # Default commands, can be overriden by the environment
113 : ${OPENSSL:="openssl"}
114 : ${OPENSSL_LEGACY:="$OPENSSL"}
115 : ${OPENSSL_NEXT:="$OPENSSL"}
116 : ${GNUTLS_CLI:="gnutls-cli"}
117 : ${GNUTLS_SERV:="gnutls-serv"}
118 : ${GNUTLS_LEGACY_CLI:="$GNUTLS_CLI"}
119 : ${GNUTLS_LEGACY_SERV:="$GNUTLS_SERV"}
120 : ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
121 : ${ARMC5_BIN_DIR:=/usr/bin}
122 : ${ARMC6_BIN_DIR:=/usr/bin}
Andres AGdc192212016-08-31 17:33:13 +0100123
Gilles Peskine8f073122018-11-27 15:58:47 +0100124 # if MAKEFLAGS is not set add the -j option to speed up invocations of make
Gilles Peskine55ae1622019-01-06 20:15:26 +0000125 if [ -z "${MAKEFLAGS+set}" ]; then
Gilles Peskine8f073122018-11-27 15:58:47 +0100126 export MAKEFLAGS="-j"
127 fi
128}
Andres AG38495a32016-07-12 16:54:33 +0100129
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100130# Test whether $1 is excluded via $COMPONENTS (a space-separated list of
131# wildcard patterns).
132component_is_excluded()
133{
134 set -f
135 for pattern in $COMPONENTS; do
136 set +f
137 case ${1#component_} in $pattern) return 0;; esac
138 done
139 set +f
140 return 1
141}
142
Simon Butcher41eeccf2016-09-07 00:07:09 +0100143usage()
SimonB2e23c822016-04-16 21:54:39 +0100144{
Gilles Peskine709346a2017-12-10 23:43:39 +0100145 cat <<EOF
Gilles Peskine92525112018-11-27 18:15:35 +0100146Usage: $0 [OPTION]... [COMPONENT]...
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100147Run mbedtls release validation tests.
Gilles Peskine92525112018-11-27 18:15:35 +0100148By default, run all tests. With one or more COMPONENT, run only those.
Gilles Peskine348fb9a2018-11-27 17:04:29 +0100149
150Special options:
151 -h|--help Print this help and exit.
152 --list-components List available test components and exit.
Gilles Peskine709346a2017-12-10 23:43:39 +0100153
154General options:
155 -f|--force Force the tests to overwrite any modified files.
Gilles Peskine7c652162017-12-11 00:01:40 +0100156 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskine709346a2017-12-10 23:43:39 +0100157 -m|--memory Additional optional memory tests.
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100158 --armcc Run ARM Compiler builds (on by default).
Gilles Peskine81b96ed2018-11-27 21:37:53 +0100159 --except If some components are passed on the command line,
160 run all the tests except for these components. In
161 this mode, you can pass shell wildcard patterns as
162 component names, e.g. "$0 --except 'test_*'" to
163 exclude all components that run tests.
Gilles Peskinebca6ab92017-12-19 18:24:31 +0100164 --no-armcc Skip ARM Compiler builds.
Gilles Peskine38d81652018-03-21 08:40:26 +0100165 --no-force Refuse to overwrite modified files (default).
166 --no-keep-going Stop at the first error (default).
167 --no-memory No additional memory tests (default).
Gilles Peskine709346a2017-12-10 23:43:39 +0100168 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine38d81652018-03-21 08:40:26 +0100169 --random-seed Use a random seed value for randomized tests (default).
Gilles Peskine709346a2017-12-10 23:43:39 +0100170 -r|--release-test Run this script in release mode. This fixes the seed value to 1.
171 -s|--seed Integer seed value to use for this test run.
172
173Tool path options:
174 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
175 --armc6-bin-dir=<ARMC6_bin_dir_path> ARM Compiler 6 bin directory.
176 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
177 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
178 --gnutls-legacy-cli=<GnuTLS_cli_path> GnuTLS client executable to use for legacy tests.
179 --gnutls-legacy-serv=<GnuTLS_serv_path> GnuTLS server executable to use for legacy tests.
180 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
181 --openssl-legacy=<OpenSSL_path> OpenSSL executable to use for legacy tests e.g. SSLv3.
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100182 --openssl-next=<OpenSSL_path> OpenSSL executable to use for recent things like ARIA
Gilles Peskine709346a2017-12-10 23:43:39 +0100183EOF
SimonB2e23c822016-04-16 21:54:39 +0100184}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100185
186# remove built files as well as the cmake cache/config
187cleanup()
188{
Gilles Peskinea71d64c2018-03-21 12:16:57 +0100189 if [ -n "${MBEDTLS_ROOT_DIR+set}" ]; then
190 cd "$MBEDTLS_ROOT_DIR"
191 fi
192
Gilles Peskine7c652162017-12-11 00:01:40 +0100193 command make clean
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200194
Gilles Peskine31b07e22018-03-21 12:15:06 +0100195 # Remove CMake artefacts
Simon Butcher3ad2efd2018-05-02 14:49:38 +0100196 find . -name .git -prune \
Gilles Peskine31b07e22018-03-21 12:15:06 +0100197 -iname CMakeFiles -exec rm -rf {} \+ -o \
198 \( -iname cmake_install.cmake -o \
199 -iname CTestTestfile.cmake -o \
200 -iname CMakeCache.txt \) -exec rm {} \+
201 # Recover files overwritten by in-tree CMake builds
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +0000202 rm -f include/Makefile include/mbedtls/Makefile programs/*/Makefile
Paul Bakkerfe0984d2014-06-13 00:13:45 +0200203 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile
204 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200205
206 if [ -f "$CONFIG_BAK" ]; then
207 mv "$CONFIG_BAK" "$CONFIG_H"
208 fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100209}
210
Gilles Peskine7c652162017-12-11 00:01:40 +0100211# Executed on exit. May be redefined depending on command line options.
212final_report () {
213 :
214}
215
216fatal_signal () {
217 cleanup
218 final_report $1
219 trap - $1
220 kill -$1 $$
221}
222
223trap 'fatal_signal HUP' HUP
224trap 'fatal_signal INT' INT
225trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200226
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100227msg()
228{
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100229 if [ -n "${current_component:-}" ]; then
230 current_section="${current_component#component_}: $1"
231 else
232 current_section="$1"
233 fi
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100234 echo ""
235 echo "******************************************************************"
Gilles Peskineffcdeff2018-12-04 12:49:28 +0100236 echo "* $current_section "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000237 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100238 echo "******************************************************************"
239}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100240
Gilles Peskine8f073122018-11-27 15:58:47 +0100241armc6_build_test()
242{
243 FLAGS="$1"
Andres AGa5cd9732016-10-17 15:23:10 +0100244
Gilles Peskine8f073122018-11-27 15:58:47 +0100245 msg "build: ARM Compiler 6 ($FLAGS), make"
246 ARM_TOOL_VARIANT="ult" CC="$ARMC6_CC" AR="$ARMC6_AR" CFLAGS="$FLAGS" \
247 WARNING_CFLAGS='-xc -std=c99' make lib
248 make clean
249}
Andres AGa5cd9732016-10-17 15:23:10 +0100250
Andres AGd9eba4b2016-08-26 14:42:14 +0100251err_msg()
252{
253 echo "$1" >&2
254}
255
256check_tools()
257{
258 for TOOL in "$@"; do
Andres AG98393602017-01-31 17:04:45 +0000259 if ! `type "$TOOL" >/dev/null 2>&1`; then
Andres AGd9eba4b2016-08-26 14:42:14 +0100260 err_msg "$TOOL not found!"
261 exit 1
262 fi
263 done
264}
265
Andrzej Kurek991f9fe2018-07-02 09:08:21 -0400266check_headers_in_cpp () {
267 ls include/mbedtls >headers.txt
268 <programs/test/cpp_dummy_build.cpp sed -n 's/"$//; s!^#include "mbedtls/!!p' |
269 sort |
270 diff headers.txt -
271 rm headers.txt
272}
273
Gilles Peskine8f073122018-11-27 15:58:47 +0100274pre_parse_command_line () {
275 while [ $# -gt 0 ]; do
Gilles Peskine06b385f2019-01-09 22:28:21 +0100276 case "$1" in
277 --armcc) RUN_ARMCC=1;;
278 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
279 --armc6-bin-dir) shift; ARMC6_BIN_DIR="$1";;
280 --except) ALL_EXCEPT=1;;
281 --force|-f) FORCE=1;;
282 --gnutls-cli) shift; GNUTLS_CLI="$1";;
283 --gnutls-legacy-cli) shift; GNUTLS_LEGACY_CLI="$1";;
284 --gnutls-legacy-serv) shift; GNUTLS_LEGACY_SERV="$1";;
285 --gnutls-serv) shift; GNUTLS_SERV="$1";;
286 --help|-h) usage; exit;;
287 --keep-going|-k) KEEP_GOING=1;;
288 --list-components) INTROSPECTION_MODE=list_components;;
289 --memory|-m) MEMORY=1;;
290 --no-armcc) RUN_ARMCC=0;;
291 --no-force) FORCE=0;;
292 --no-keep-going) KEEP_GOING=0;;
293 --no-memory) MEMORY=0;;
294 --openssl) shift; OPENSSL="$1";;
295 --openssl-legacy) shift; OPENSSL_LEGACY="$1";;
296 --openssl-next) shift; OPENSSL_NEXT="$1";;
297 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
298 --random-seed) unset SEED;;
299 --release-test|-r) SEED=1;;
300 --seed|-s) shift; SEED="$1";;
301 -*)
302 echo >&2 "Unknown option: $1"
303 echo >&2 "Run $0 --help for usage."
304 exit 120
305 ;;
306 *)
307 COMPONENTS="$COMPONENTS $1";;
308 esac
309 shift
Gilles Peskine8f073122018-11-27 15:58:47 +0100310 done
311}
SimonB2e23c822016-04-16 21:54:39 +0100312
Gilles Peskine8f073122018-11-27 15:58:47 +0100313pre_check_git () {
314 if [ $FORCE -eq 1 ]; then
315 git checkout-index -f -q $CONFIG_H
316 cleanup
317 else
SimonB2e23c822016-04-16 21:54:39 +0100318
Gilles Peskine8f073122018-11-27 15:58:47 +0100319 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
320 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
321 echo "You can either delete this directory manually, or force the test by rerunning"
322 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
323 exit 1
324 fi
325
326 if ! git diff-files --quiet include/mbedtls/config.h; then
327 err_msg "Warning - the configuration file 'include/mbedtls/config.h' has been edited. "
328 echo "You can either delete or preserve your work, or force the test by rerunning the"
329 echo "script as: $0 --force"
330 exit 1
331 fi
Andres AGdc192212016-08-31 17:33:13 +0100332 fi
Gilles Peskine8f073122018-11-27 15:58:47 +0100333}
Andres AGdc192212016-08-31 17:33:13 +0100334
Gilles Peskine8f073122018-11-27 15:58:47 +0100335pre_setup_keep_going () {
Gilles Peskine7c652162017-12-11 00:01:40 +0100336 failure_summary=
337 failure_count=0
338 start_red=
339 end_color=
340 if [ -t 1 ]; then
Gilles Peskine9736b9d2018-01-02 21:54:17 +0100341 case "${TERM:-}" in
Gilles Peskine7c652162017-12-11 00:01:40 +0100342 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
343 start_red=$(printf '\033[31m')
344 end_color=$(printf '\033[0m')
345 ;;
346 esac
347 fi
348 record_status () {
349 if "$@"; then
350 last_status=0
351 else
352 last_status=$?
353 text="$current_section: $* -> $last_status"
354 failure_summary="$failure_summary
355$text"
356 failure_count=$((failure_count + 1))
357 echo "${start_red}^^^^$text^^^^${end_color}"
358 fi
359 }
360 make () {
361 case "$*" in
362 *test|*check)
363 if [ $build_status -eq 0 ]; then
364 record_status command make "$@"
365 else
366 echo "(skipped because the build failed)"
367 fi
368 ;;
369 *)
370 record_status command make "$@"
371 build_status=$last_status
372 ;;
373 esac
374 }
375 final_report () {
376 if [ $failure_count -gt 0 ]; then
377 echo
378 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
379 echo "${start_red}FAILED: $failure_count${end_color}$failure_summary"
380 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
Jaeden Amero7c1258d2018-07-20 16:42:14 +0100381 exit 1
Gilles Peskine7c652162017-12-11 00:01:40 +0100382 elif [ -z "${1-}" ]; then
383 echo "SUCCESS :)"
384 fi
385 if [ -n "${1-}" ]; then
386 echo "Killed by SIG$1."
387 fi
388 }
Gilles Peskine8f073122018-11-27 15:58:47 +0100389}
390
Gilles Peskine7c652162017-12-11 00:01:40 +0100391if_build_succeeded () {
392 if [ $build_status -eq 0 ]; then
393 record_status "$@"
394 fi
395}
396
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +0200397# to be used instead of ! for commands run with
398# record_status or if_build_succeeded
399not() {
400 ! "$@"
401}
402
Gilles Peskine8f073122018-11-27 15:58:47 +0100403pre_print_configuration () {
404 msg "info: $0 configuration"
405 echo "MEMORY: $MEMORY"
406 echo "FORCE: $FORCE"
407 echo "SEED: ${SEED-"UNSET"}"
408 echo "OPENSSL: $OPENSSL"
409 echo "OPENSSL_LEGACY: $OPENSSL_LEGACY"
410 echo "OPENSSL_NEXT: $OPENSSL_NEXT"
411 echo "GNUTLS_CLI: $GNUTLS_CLI"
412 echo "GNUTLS_SERV: $GNUTLS_SERV"
413 echo "GNUTLS_LEGACY_CLI: $GNUTLS_LEGACY_CLI"
414 echo "GNUTLS_LEGACY_SERV: $GNUTLS_LEGACY_SERV"
415 echo "ARMC5_BIN_DIR: $ARMC5_BIN_DIR"
416 echo "ARMC6_BIN_DIR: $ARMC6_BIN_DIR"
417}
Andres AG87bb5772016-09-27 15:05:15 +0100418
Gilles Peskine8f073122018-11-27 15:58:47 +0100419pre_check_tools () {
420 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
421 ARMC5_AR="$ARMC5_BIN_DIR/armar"
422 ARMC6_CC="$ARMC6_BIN_DIR/armclang"
423 ARMC6_AR="$ARMC6_BIN_DIR/armar"
Andres AGd9eba4b2016-08-26 14:42:14 +0100424
Gilles Peskine8f073122018-11-27 15:58:47 +0100425 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh and ssl-opt.sh
426 # we just export the variables they require
427 export OPENSSL_CMD="$OPENSSL"
428 export GNUTLS_CLI="$GNUTLS_CLI"
429 export GNUTLS_SERV="$GNUTLS_SERV"
Andres AGb2fdd042016-09-22 14:17:46 +0100430
Gilles Peskine8f073122018-11-27 15:58:47 +0100431 # Avoid passing --seed flag in every call to ssl-opt.sh
432 if [ -n "${SEED-}" ]; then
433 export SEED
434 fi
Andres AG7770ea82016-10-10 15:46:20 +0100435
Gilles Peskine8f073122018-11-27 15:58:47 +0100436 # Make sure the tools we need are available.
437 check_tools "$OPENSSL" "$OPENSSL_LEGACY" "$OPENSSL_NEXT" \
438 "$GNUTLS_CLI" "$GNUTLS_SERV" \
439 "$GNUTLS_LEGACY_CLI" "$GNUTLS_LEGACY_SERV" "doxygen" "dot" \
440 "arm-none-eabi-gcc" "i686-w64-mingw32-gcc" "gdb"
441 if [ $RUN_ARMCC -ne 0 ]; then
442 check_tools "$ARMC5_CC" "$ARMC5_AR" "$ARMC6_CC" "$ARMC6_AR"
443 fi
444}
Gilles Peskine192c72f2017-12-21 15:59:21 +0100445
446
447################################################################
448#### Basic checks
449################################################################
Andres AGd9eba4b2016-08-26 14:42:14 +0100450
SimonB2e23c822016-04-16 21:54:39 +0100451#
452# Test Suites to be executed
453#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200454# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100455# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard61bc57a2014-08-14 11:29:06 +0200456# and/or are more likely to fail than others (eg I use Clang most of the
457# time, so start with a GCC build).
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200458# 2. Minimize total running time, by avoiding useless rebuilds
459#
460# Indicative running times are given for reference.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100461
Gilles Peskine8f073122018-11-27 15:58:47 +0100462pre_print_tools () {
463 msg "info: output_env.sh"
464 OPENSSL="$OPENSSL" OPENSSL_LEGACY="$OPENSSL_LEGACY" GNUTLS_CLI="$GNUTLS_CLI" \
465 GNUTLS_SERV="$GNUTLS_SERV" GNUTLS_LEGACY_CLI="$GNUTLS_LEGACY_CLI" \
466 GNUTLS_LEGACY_SERV="$GNUTLS_LEGACY_SERV" ARMC5_CC="$ARMC5_CC" \
467 ARMC6_CC="$ARMC6_CC" RUN_ARMCC="$RUN_ARMCC" scripts/output_env.sh
468}
Janos Follathb72c6782016-07-19 14:54:17 +0100469
Gilles Peskine8f073122018-11-27 15:58:47 +0100470component_check_recursion () {
471 msg "test: recursion.pl" # < 1s
472 record_status tests/scripts/recursion.pl library/*.c
473}
Manuel Pégourié-Gonnardea29d152014-11-20 17:32:33 +0100474
Gilles Peskine8f073122018-11-27 15:58:47 +0100475component_check_generated_files () {
476 msg "test: freshness of generated source files" # < 1s
477 record_status tests/scripts/check-generated-files.sh
478}
Manuel Pégourié-Gonnardb3b8e432015-02-13 14:52:19 +0000479
Gilles Peskine8f073122018-11-27 15:58:47 +0100480component_check_doxy_blocks () {
481 msg "test: doxygen markup outside doxygen blocks" # < 1s
482 record_status tests/scripts/check-doxy-blocks.pl
483}
Manuel Pégourié-Gonnardd09a6b52015-04-09 17:19:23 +0200484
Gilles Peskine8f073122018-11-27 15:58:47 +0100485component_check_files () {
486 msg "test: check-files.py" # < 1s
Gilles Peskine8f073122018-11-27 15:58:47 +0100487 record_status tests/scripts/check-files.py
488}
Darryl Greena07039c2018-03-13 16:48:16 +0000489
Gilles Peskine8f073122018-11-27 15:58:47 +0100490component_check_names () {
491 msg "test/build: declared and exported names" # < 3s
Gilles Peskine8f073122018-11-27 15:58:47 +0100492 record_status tests/scripts/check-names.sh
493}
Manuel Pégourié-Gonnarda687baf2015-04-09 11:09:03 +0200494
Gilles Peskine8f073122018-11-27 15:58:47 +0100495component_check_doxygen_warnings () {
496 msg "test: doxygen warnings" # ~ 3s
Gilles Peskine8f073122018-11-27 15:58:47 +0100497 record_status tests/scripts/doxygen.sh
498}
Manuel Pégourié-Gonnard1d552e72016-01-04 16:49:09 +0100499
Gilles Peskine192c72f2017-12-21 15:59:21 +0100500
Gilles Peskine192c72f2017-12-21 15:59:21 +0100501################################################################
502#### Build and test many configurations and targets
503################################################################
504
Gilles Peskine8f073122018-11-27 15:58:47 +0100505component_test_default_cmake_gcc_asan () {
506 msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Gilles Peskine8f073122018-11-27 15:58:47 +0100507 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
508 make
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100509
Gilles Peskine8f073122018-11-27 15:58:47 +0100510 msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
511 make test
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200512
Gilles Peskine8f073122018-11-27 15:58:47 +0100513 msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
514 if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200515
Gilles Peskine8f073122018-11-27 15:58:47 +0100516 msg "test: compat.sh (ASan build)" # ~ 6 min
517 if_build_succeeded tests/compat.sh
518}
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200519
Gilles Peskine782f4112018-11-27 16:11:09 +0100520component_test_ref_configs () {
521 msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
522 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
523 record_status tests/scripts/test-ref-configs.pl
524}
525
Gilles Peskine8f073122018-11-27 15:58:47 +0100526component_test_sslv3 () {
527 msg "build: Default + SSLv3 (ASan build)" # ~ 6 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100528 scripts/config.pl set MBEDTLS_SSL_PROTO_SSL3
529 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
530 make
Simon Butcher3ea7f522016-03-07 23:22:10 +0000531
Gilles Peskine8f073122018-11-27 15:58:47 +0100532 msg "test: SSLv3 - main suites (inc. selftests) (ASan build)" # ~ 50s
533 make test
Simon Butcher3ea7f522016-03-07 23:22:10 +0000534
Gilles Peskine8f073122018-11-27 15:58:47 +0100535 msg "build: SSLv3 - compat.sh (ASan build)" # ~ 6 min
536 if_build_succeeded tests/compat.sh -m 'tls1 tls1_1 tls1_2 dtls1 dtls1_2'
537 if_build_succeeded env OPENSSL_CMD="$OPENSSL_LEGACY" tests/compat.sh -m 'ssl3'
Simon Butcher3ea7f522016-03-07 23:22:10 +0000538
Gilles Peskine8f073122018-11-27 15:58:47 +0100539 msg "build: SSLv3 - ssl-opt.sh (ASan build)" # ~ 6 min
540 if_build_succeeded tests/ssl-opt.sh
541}
Simon Butcher3ea7f522016-03-07 23:22:10 +0000542
Gilles Peskine8f073122018-11-27 15:58:47 +0100543component_test_no_renegotiation () {
544 msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100545 scripts/config.pl unset MBEDTLS_SSL_RENEGOTIATION
546 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
547 make
Hanno Becker134c2ab2017-10-12 15:29:50 +0100548
Gilles Peskine8f073122018-11-27 15:58:47 +0100549 msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
550 make test
Hanno Becker134c2ab2017-10-12 15:29:50 +0100551
Gilles Peskine8f073122018-11-27 15:58:47 +0100552 msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
553 if_build_succeeded tests/ssl-opt.sh
554}
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +0100555
Gilles Peskine8f073122018-11-27 15:58:47 +0100556component_test_rsa_no_crt () {
557 msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100558 scripts/config.pl set MBEDTLS_RSA_NO_CRT
559 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
560 make
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100561
Gilles Peskine8f073122018-11-27 15:58:47 +0100562 msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
563 make test
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100564
Gilles Peskine8f073122018-11-27 15:58:47 +0100565 msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
566 if_build_succeeded tests/ssl-opt.sh -f RSA
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100567
Gilles Peskine8f073122018-11-27 15:58:47 +0100568 msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
569 if_build_succeeded tests/compat.sh -t RSA
570}
Hanno Beckerd5ba5ef2017-09-28 12:53:51 +0100571
Gilles Peskine8f073122018-11-27 15:58:47 +0100572component_test_small_ssl_out_content_len () {
573 msg "build: small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100574 scripts/config.pl set MBEDTLS_SSL_IN_CONTENT_LEN 16384
575 scripts/config.pl set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
576 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
577 make
Angus Grattonc4dd0732018-04-11 16:28:39 +1000578
Gilles Peskine8f073122018-11-27 15:58:47 +0100579 msg "test: small SSL_OUT_CONTENT_LEN - ssl-opt.sh MFL and large packet tests"
580 if_build_succeeded tests/ssl-opt.sh -f "Max fragment\|Large packet"
581}
Angus Grattonc4dd0732018-04-11 16:28:39 +1000582
Gilles Peskine8f073122018-11-27 15:58:47 +0100583component_test_small_ssl_in_content_len () {
584 msg "build: small SSL_IN_CONTENT_LEN (ASan build)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100585 scripts/config.pl set MBEDTLS_SSL_IN_CONTENT_LEN 4096
586 scripts/config.pl set MBEDTLS_SSL_OUT_CONTENT_LEN 16384
587 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
588 make
Angus Grattonc4dd0732018-04-11 16:28:39 +1000589
Gilles Peskine8f073122018-11-27 15:58:47 +0100590 msg "test: small SSL_IN_CONTENT_LEN - ssl-opt.sh MFL tests"
591 if_build_succeeded tests/ssl-opt.sh -f "Max fragment"
592}
Angus Grattonc4dd0732018-04-11 16:28:39 +1000593
Gilles Peskine8f073122018-11-27 15:58:47 +0100594component_test_small_ssl_dtls_max_buffering () {
595 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0"
Gilles Peskine8f073122018-11-27 15:58:47 +0100596 scripts/config.pl set MBEDTLS_SSL_DTLS_MAX_BUFFERING 1000
597 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
598 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +0100599
Gilles Peskine8f073122018-11-27 15:58:47 +0100600 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #0 - ssl-opt.sh specific reordering test"
601 if_build_succeeded tests/ssl-opt.sh -f "DTLS reordering: Buffer out-of-order hs msg before reassembling next, free buffered msg"
602}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +0100603
Gilles Peskine8f073122018-11-27 15:58:47 +0100604component_test_small_mbedtls_ssl_dtls_max_buffering () {
605 msg "build: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1"
Gilles Peskine8f073122018-11-27 15:58:47 +0100606 scripts/config.pl set MBEDTLS_SSL_DTLS_MAX_BUFFERING 240
607 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
608 make
Hanno Becker2f5aa4c2018-08-24 14:43:44 +0100609
Gilles Peskine8f073122018-11-27 15:58:47 +0100610 msg "test: small MBEDTLS_SSL_DTLS_MAX_BUFFERING #1 - ssl-opt.sh specific reordering test"
611 if_build_succeeded tests/ssl-opt.sh -f "DTLS reordering: Buffer encrypted Finished message, drop for fragmented NewSessionTicket"
612}
Hanno Becker2f5aa4c2018-08-24 14:43:44 +0100613
Gilles Peskine8f073122018-11-27 15:58:47 +0100614component_test_full_cmake_clang () {
615 msg "build: cmake, full config, clang" # ~ 50s
Gilles Peskine8f073122018-11-27 15:58:47 +0100616 scripts/config.pl full
617 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
618 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Check -D ENABLE_TESTING=On .
619 make
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100620
Gilles Peskine8f073122018-11-27 15:58:47 +0100621 msg "test: main suites (full config)" # ~ 5s
622 make test
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200623
Gilles Peskine8f073122018-11-27 15:58:47 +0100624 msg "test: ssl-opt.sh default, ECJPAKE, SSL async (full config)" # ~ 1s
625 if_build_succeeded tests/ssl-opt.sh -f 'Default\|ECJPAKE\|SSL async private'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200626
Gilles Peskine8f073122018-11-27 15:58:47 +0100627 msg "test: compat.sh RC4, DES & NULL (full config)" # ~ 2 min
628 if_build_succeeded env OPENSSL_CMD="$OPENSSL_LEGACY" GNUTLS_CLI="$GNUTLS_LEGACY_CLI" GNUTLS_SERV="$GNUTLS_LEGACY_SERV" tests/compat.sh -e '3DES\|DES-CBC3' -f 'NULL\|DES\|RC4\|ARCFOUR'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200629
Gilles Peskine8f073122018-11-27 15:58:47 +0100630 msg "test: compat.sh ARIA + ChachaPoly"
631 if_build_succeeded env OPENSSL_CMD="$OPENSSL_NEXT" tests/compat.sh -e '^$' -f 'ARIA\|CHACHA'
632}
Manuel Pégourié-Gonnard6b368922018-02-20 12:02:07 +0100633
Gilles Peskine8f073122018-11-27 15:58:47 +0100634component_build_deprecated () {
635 msg "build: make, full config + DEPRECATED_WARNING, gcc -O" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +0100636 scripts/config.pl full
637 scripts/config.pl set MBEDTLS_DEPRECATED_WARNING
638 # Build with -O -Wextra to catch a maximum of issues.
639 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra' lib programs
640 make CC=gcc CFLAGS='-O -Werror -Wall -Wextra -Wno-unused-function' tests
Gilles Peskineb4ef45b2018-03-01 22:23:50 +0100641
Gilles Peskine8f073122018-11-27 15:58:47 +0100642 msg "build: make, full config + DEPRECATED_REMOVED, clang -O" # ~ 30s
643 # No cleanup, just tweak the configuration and rebuild
644 make clean
645 scripts/config.pl unset MBEDTLS_DEPRECATED_WARNING
646 scripts/config.pl set MBEDTLS_DEPRECATED_REMOVED
647 # Build with -O -Wextra to catch a maximum of issues.
648 make CC=clang CFLAGS='-O -Werror -Wall -Wextra' lib programs
649 make CC=clang CFLAGS='-O -Werror -Wall -Wextra -Wno-unused-function' tests
650}
Gilles Peskine0afe6242018-02-21 19:28:12 +0100651
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200652
Gilles Peskine8f073122018-11-27 15:58:47 +0100653component_test_depends_curves () {
654 msg "test/build: curves.pl (gcc)" # ~ 4 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100655 record_status tests/scripts/curves.pl
656}
Manuel Pégourié-Gonnard1fe6bb92017-06-06 11:36:16 +0200657
Gilles Peskine8f073122018-11-27 15:58:47 +0100658component_test_depends_hashes () {
659 msg "test/build: depends-hashes.pl (gcc)" # ~ 2 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100660 record_status tests/scripts/depends-hashes.pl
661}
Manuel Pégourié-Gonnard43be6cd2017-06-20 09:53:42 +0200662
Gilles Peskine8f073122018-11-27 15:58:47 +0100663component_test_depends_pkalgs () {
664 msg "test/build: depends-pkalgs.pl (gcc)" # ~ 2 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100665 record_status tests/scripts/depends-pkalgs.pl
666}
Manuel Pégourié-Gonnard503a5ef2015-10-23 09:04:45 +0200667
Gilles Peskine8f073122018-11-27 15:58:47 +0100668component_build_key_exchanges () {
669 msg "test/build: key-exchanges (gcc)" # ~ 1 min
Gilles Peskine8f073122018-11-27 15:58:47 +0100670 record_status tests/scripts/key-exchanges.pl
671}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100672
Gilles Peskine8f073122018-11-27 15:58:47 +0100673component_build_default_make_gcc_and_cxx () {
674 msg "build: Unix make, -Os (gcc)" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +0100675 make CC=gcc CFLAGS='-Werror -Wall -Wextra -Os'
Andrzej Kurek991f9fe2018-07-02 09:08:21 -0400676
Gilles Peskine8f073122018-11-27 15:58:47 +0100677 msg "test: verify header list in cpp_dummy_build.cpp"
678 record_status check_headers_in_cpp
Andrzej Kurek991f9fe2018-07-02 09:08:21 -0400679
Gilles Peskine8f073122018-11-27 15:58:47 +0100680 msg "build: Unix make, incremental g++"
681 make TEST_CPP=1
682}
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +0000683
Gilles Peskine8f073122018-11-27 15:58:47 +0100684component_test_no_platform () {
685 # Full configuration build, without platform support, file IO and net sockets.
686 # This should catch missing mbedtls_printf definitions, and by disabling file
687 # IO, it should catch missing '#include <stdio.h>'
688 msg "build: full config except platform/fsio/net, make, gcc, C99" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +0100689 scripts/config.pl full
690 scripts/config.pl unset MBEDTLS_PLATFORM_C
691 scripts/config.pl unset MBEDTLS_NET_C
692 scripts/config.pl unset MBEDTLS_PLATFORM_MEMORY
693 scripts/config.pl unset MBEDTLS_PLATFORM_PRINTF_ALT
694 scripts/config.pl unset MBEDTLS_PLATFORM_FPRINTF_ALT
695 scripts/config.pl unset MBEDTLS_PLATFORM_SNPRINTF_ALT
696 scripts/config.pl unset MBEDTLS_PLATFORM_TIME_ALT
697 scripts/config.pl unset MBEDTLS_PLATFORM_EXIT_ALT
698 scripts/config.pl unset MBEDTLS_ENTROPY_NV_SEED
699 scripts/config.pl unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
700 scripts/config.pl unset MBEDTLS_FS_IO
Gilles Peskine51585382019-01-05 10:27:47 +0100701 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_FILE_C
702 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Gilles Peskine8f073122018-11-27 15:58:47 +0100703 # Note, _DEFAULT_SOURCE needs to be defined for platforms using glibc version >2.19,
704 # to re-enable platform integration features otherwise disabled in C99 builds
705 make CC=gcc CFLAGS='-Werror -Wall -Wextra -std=c99 -pedantic -O0 -D_DEFAULT_SOURCE' lib programs
706 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O0' test
707}
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +0100708
Gilles Peskine8f073122018-11-27 15:58:47 +0100709component_build_no_std_function () {
710 # catch compile bugs in _uninit functions
711 msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +0100712 scripts/config.pl full
713 scripts/config.pl set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
714 scripts/config.pl unset MBEDTLS_ENTROPY_NV_SEED
715 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O0'
716}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +0200717
Gilles Peskine8f073122018-11-27 15:58:47 +0100718component_build_no_ssl_srv () {
719 msg "build: full config except ssl_srv.c, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +0100720 scripts/config.pl full
721 scripts/config.pl unset MBEDTLS_SSL_SRV_C
722 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O0'
723}
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +0200724
Gilles Peskine8f073122018-11-27 15:58:47 +0100725component_build_no_ssl_cli () {
726 msg "build: full config except ssl_cli.c, make, gcc" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +0100727 scripts/config.pl full
728 scripts/config.pl unset MBEDTLS_SSL_CLI_C
729 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O0'
730}
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +0200731
Gilles Peskine8f073122018-11-27 15:58:47 +0100732component_build_no_sockets () {
733 # Note, C99 compliance can also be tested with the sockets support disabled,
734 # as that requires a POSIX platform (which isn't the same as C99).
735 msg "build: full config except net_sockets.c, make, gcc -std=c99 -pedantic" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +0100736 scripts/config.pl full
737 scripts/config.pl unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
738 scripts/config.pl set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
739 make CC=gcc CFLAGS='-Werror -Wall -Wextra -O0 -std=c99 -pedantic' lib
740}
Hanno Becker5175ac62017-09-18 15:36:25 +0100741
Gilles Peskine8f073122018-11-27 15:58:47 +0100742component_test_no_max_fragment_length () {
743 # Run max fragment length tests with MFL disabled
744 msg "build: default config except MFL extension (ASan build)" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +0100745 scripts/config.pl unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
746 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
747 make
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000748
Gilles Peskine8f073122018-11-27 15:58:47 +0100749 msg "test: ssl-opt.sh, MFL-related tests"
750 if_build_succeeded tests/ssl-opt.sh -f "Max fragment length"
751}
Angus Grattonc4dd0732018-04-11 16:28:39 +1000752
Gilles Peskine8f073122018-11-27 15:58:47 +0100753component_test_no_max_fragment_length_small_ssl_out_content_len () {
754 msg "build: no MFL extension, small SSL_OUT_CONTENT_LEN (ASan build)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100755 scripts/config.pl unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
756 scripts/config.pl set MBEDTLS_SSL_IN_CONTENT_LEN 16384
757 scripts/config.pl set MBEDTLS_SSL_OUT_CONTENT_LEN 4096
758 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
759 make
Angus Grattonc4dd0732018-04-11 16:28:39 +1000760
Gilles Peskine8f073122018-11-27 15:58:47 +0100761 msg "test: MFL tests (disabled MFL extension case) & large packet tests"
762 if_build_succeeded tests/ssl-opt.sh -f "Max fragment length\|Large buffer"
763}
Janos Follath06c54002016-06-09 13:57:40 +0100764
Gilles Peskine8f073122018-11-27 15:58:47 +0100765component_test_null_entropy () {
766 msg "build: default config with MBEDTLS_TEST_NULL_ENTROPY (ASan build)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100767 scripts/config.pl set MBEDTLS_TEST_NULL_ENTROPY
768 scripts/config.pl set MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
769 scripts/config.pl set MBEDTLS_ENTROPY_C
770 scripts/config.pl unset MBEDTLS_ENTROPY_NV_SEED
771 scripts/config.pl unset MBEDTLS_ENTROPY_HARDWARE_ALT
772 scripts/config.pl unset MBEDTLS_HAVEGE_C
Gilles Peskine19275652019-01-06 19:48:30 +0000773 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan -D UNSAFE_BUILD=ON .
Gilles Peskine8f073122018-11-27 15:58:47 +0100774 make
Janos Follath06c54002016-06-09 13:57:40 +0100775
Gilles Peskine8f073122018-11-27 15:58:47 +0100776 msg "test: MBEDTLS_TEST_NULL_ENTROPY - main suites (inc. selftests) (ASan build)"
777 make test
778}
Hanno Beckere5fecec2018-10-11 11:02:52 +0100779
Gilles Peskine8f073122018-11-27 15:58:47 +0100780component_test_platform_calloc_macro () {
781 msg "build: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
Gilles Peskine8f073122018-11-27 15:58:47 +0100782 scripts/config.pl set MBEDTLS_PLATFORM_MEMORY
783 scripts/config.pl set MBEDTLS_PLATFORM_CALLOC_MACRO calloc
784 scripts/config.pl set MBEDTLS_PLATFORM_FREE_MACRO free
785 CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
786 make
Hanno Beckere5fecec2018-10-11 11:02:52 +0100787
Gilles Peskine8f073122018-11-27 15:58:47 +0100788 msg "test: MBEDTLS_PLATFORM_{CALLOC/FREE}_MACRO enabled (ASan build)"
789 make test
790}
Hanno Becker83ebf782017-07-07 12:29:15 +0100791
Gilles Peskine8f073122018-11-27 15:58:47 +0100792component_test_aes_fewer_tables () {
793 msg "build: default config with AES_FEWER_TABLES enabled"
Gilles Peskine8f073122018-11-27 15:58:47 +0100794 scripts/config.pl set MBEDTLS_AES_FEWER_TABLES
795 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +0100796
Gilles Peskine8f073122018-11-27 15:58:47 +0100797 msg "test: AES_FEWER_TABLES"
798 make test
799}
Hanno Becker83ebf782017-07-07 12:29:15 +0100800
Gilles Peskine8f073122018-11-27 15:58:47 +0100801component_test_aes_rom_tables () {
802 msg "build: default config with AES_ROM_TABLES enabled"
Gilles Peskine8f073122018-11-27 15:58:47 +0100803 scripts/config.pl set MBEDTLS_AES_ROM_TABLES
804 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +0100805
Gilles Peskine8f073122018-11-27 15:58:47 +0100806 msg "test: AES_ROM_TABLES"
807 make test
808}
Hanno Becker83ebf782017-07-07 12:29:15 +0100809
Gilles Peskine8f073122018-11-27 15:58:47 +0100810component_test_aes_fewer_tables_and_rom_tables () {
811 msg "build: default config with AES_ROM_TABLES and AES_FEWER_TABLES enabled"
Gilles Peskine8f073122018-11-27 15:58:47 +0100812 scripts/config.pl set MBEDTLS_AES_FEWER_TABLES
813 scripts/config.pl set MBEDTLS_AES_ROM_TABLES
814 make CC=gcc CFLAGS='-Werror -Wall -Wextra'
Hanno Becker83ebf782017-07-07 12:29:15 +0100815
Gilles Peskine8f073122018-11-27 15:58:47 +0100816 msg "test: AES_FEWER_TABLES + AES_ROM_TABLES"
817 make test
818}
819
820component_test_make_shared () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +0100821 msg "build/test: make shared" # ~ 40s
Gilles Peskine7ad603e2017-12-10 23:22:20 +0100822 make SHARED=1 all check
Gilles Peskine8f073122018-11-27 15:58:47 +0100823}
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +0200824
Gilles Peskine8f073122018-11-27 15:58:47 +0100825component_test_m32_o0 () {
Simon Butcher8e6a22a2018-07-20 21:27:33 +0100826 # Build once with -O0, to compile out the i386 specific inline assembly
827 msg "build: i386, make, gcc -O0 (ASan build)" # ~ 30s
Simon Butcher7a6da6e2018-06-27 21:52:54 +0100828 scripts/config.pl full
Simon Butcher8e6a22a2018-07-20 21:27:33 +0100829 make CC=gcc CFLAGS='-O0 -Werror -Wall -Wextra -m32 -fsanitize=address'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +0100830
Simon Butcher8e6a22a2018-07-20 21:27:33 +0100831 msg "test: i386, make, gcc -O0 (ASan build)"
832 make test
Gilles Peskine8f073122018-11-27 15:58:47 +0100833}
Simon Butcher8e6a22a2018-07-20 21:27:33 +0100834
Gilles Peskine8f073122018-11-27 15:58:47 +0100835component_test_m32_o1 () {
Simon Butcher8e6a22a2018-07-20 21:27:33 +0100836 # Build again with -O1, to compile in the i386 specific inline assembly
837 msg "build: i386, make, gcc -O1 (ASan build)" # ~ 30s
Simon Butcher8e6a22a2018-07-20 21:27:33 +0100838 scripts/config.pl full
839 make CC=gcc CFLAGS='-O1 -Werror -Wall -Wextra -m32 -fsanitize=address'
840
841 msg "test: i386, make, gcc -O1 (ASan build)"
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +0100842 make test
Gilles Peskine8f073122018-11-27 15:58:47 +0100843}
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +0100844
Gilles Peskine8f073122018-11-27 15:58:47 +0100845component_test_mx32 () {
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +0100846 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
Simon Butcher7a6da6e2018-06-27 21:52:54 +0100847 scripts/config.pl full
Andres Amaya Garciaf4fbdda2017-05-08 11:19:19 +0100848 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mx32'
849
850 msg "test: 64-bit ILP32, make, gcc"
851 make test
Gilles Peskine8f073122018-11-27 15:58:47 +0100852}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000853
Gilles Peskine8f073122018-11-27 15:58:47 +0100854component_test_have_int32 () {
855 msg "build: gcc, force 32-bit bignum limbs"
Gilles Peskine8f073122018-11-27 15:58:47 +0100856 scripts/config.pl unset MBEDTLS_HAVE_ASM
857 scripts/config.pl unset MBEDTLS_AESNI_C
858 scripts/config.pl unset MBEDTLS_PADLOCK_C
859 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT32'
Andres Amaya Garcia84e6ce82017-05-04 11:35:51 +0100860
Gilles Peskine8f073122018-11-27 15:58:47 +0100861 msg "test: gcc, force 32-bit bignum limbs"
862 make test
863}
Andres Amaya Garciafe843a32017-07-20 13:21:34 +0100864
Gilles Peskine8f073122018-11-27 15:58:47 +0100865component_test_have_int64 () {
866 msg "build: gcc, force 64-bit bignum limbs"
Gilles Peskine8f073122018-11-27 15:58:47 +0100867 scripts/config.pl unset MBEDTLS_HAVE_ASM
868 scripts/config.pl unset MBEDTLS_AESNI_C
869 scripts/config.pl unset MBEDTLS_PADLOCK_C
870 make CC=gcc CFLAGS='-Werror -Wall -Wextra -DMBEDTLS_HAVE_INT64'
Gilles Peskine14c3c062018-01-29 21:25:12 +0100871
Gilles Peskine8f073122018-11-27 15:58:47 +0100872 msg "test: gcc, force 64-bit bignum limbs"
873 make test
874}
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000875
Gilles Peskine8f073122018-11-27 15:58:47 +0100876component_test_no_udbl_division () {
877 msg "build: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
Gilles Peskine8f073122018-11-27 15:58:47 +0100878 scripts/config.pl full
879 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
880 scripts/config.pl set MBEDTLS_NO_UDBL_DIVISION
881 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +0200882
Gilles Peskine8f073122018-11-27 15:58:47 +0100883 msg "test: MBEDTLS_NO_UDBL_DIVISION native" # ~ 10s
884 make test
885}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +0200886
Gilles Peskine8f073122018-11-27 15:58:47 +0100887component_test_no_64bit_multiplication () {
888 msg "build: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
Gilles Peskine8f073122018-11-27 15:58:47 +0100889 scripts/config.pl full
890 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
891 scripts/config.pl set MBEDTLS_NO_64BIT_MULTIPLICATION
892 make CFLAGS='-Werror -O1'
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +0200893
Gilles Peskine8f073122018-11-27 15:58:47 +0100894 msg "test: MBEDTLS_NO_64BIT_MULTIPLICATION native" # ~ 10s
895 make test
896}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +0200897
Gilles Peskine8f073122018-11-27 15:58:47 +0100898component_build_arm_none_eabi_gcc () {
899 msg "build: arm-none-eabi-gcc, make" # ~ 10s
Gilles Peskine8f073122018-11-27 15:58:47 +0100900 scripts/config.pl full
901 scripts/config.pl unset MBEDTLS_NET_C
902 scripts/config.pl unset MBEDTLS_TIMING_C
903 scripts/config.pl unset MBEDTLS_FS_IO
Gilles Peskine51585382019-01-05 10:27:47 +0100904 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_FILE_C
905 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Gilles Peskine8f073122018-11-27 15:58:47 +0100906 scripts/config.pl unset MBEDTLS_ENTROPY_NV_SEED
907 scripts/config.pl set MBEDTLS_NO_PLATFORM_ENTROPY
908 # following things are not in the default config
909 scripts/config.pl unset MBEDTLS_HAVEGE_C # depends on timing.c
910 scripts/config.pl unset MBEDTLS_THREADING_PTHREAD
911 scripts/config.pl unset MBEDTLS_THREADING_C
912 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # execinfo.h
913 scripts/config.pl unset MBEDTLS_MEMORY_BUFFER_ALLOC_C # calls exit
914 make CC=arm-none-eabi-gcc AR=arm-none-eabi-ar LD=arm-none-eabi-ld CFLAGS='-Werror -Wall -Wextra' lib
915}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +0200916
Gilles Peskine8f073122018-11-27 15:58:47 +0100917component_build_arm_none_eabi_gcc_no_udbl_division () {
918 msg "build: arm-none-eabi-gcc -DMBEDTLS_NO_UDBL_DIVISION, make" # ~ 10s
Gilles Peskine8f073122018-11-27 15:58:47 +0100919 scripts/config.pl full
920 scripts/config.pl unset MBEDTLS_NET_C
921 scripts/config.pl unset MBEDTLS_TIMING_C
922 scripts/config.pl unset MBEDTLS_FS_IO
Gilles Peskine51585382019-01-05 10:27:47 +0100923 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_FILE_C
924 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Gilles Peskine8f073122018-11-27 15:58:47 +0100925 scripts/config.pl unset MBEDTLS_ENTROPY_NV_SEED
926 scripts/config.pl set MBEDTLS_NO_PLATFORM_ENTROPY
927 # following things are not in the default config
928 scripts/config.pl unset MBEDTLS_HAVEGE_C # depends on timing.c
929 scripts/config.pl unset MBEDTLS_THREADING_PTHREAD
930 scripts/config.pl unset MBEDTLS_THREADING_C
931 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # execinfo.h
932 scripts/config.pl unset MBEDTLS_MEMORY_BUFFER_ALLOC_C # calls exit
933 scripts/config.pl set MBEDTLS_NO_UDBL_DIVISION
934 make CC=arm-none-eabi-gcc AR=arm-none-eabi-ar LD=arm-none-eabi-ld CFLAGS='-Werror -Wall -Wextra' lib
935 echo "Checking that software 64-bit division is not required"
936 if_build_succeeded not grep __aeabi_uldiv library/*.o
937}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +0200938
Gilles Peskine8f073122018-11-27 15:58:47 +0100939component_build_arm_none_eabi_gcc_no_64bit_multiplication () {
940 msg "build: arm-none-eabi-gcc MBEDTLS_NO_64BIT_MULTIPLICATION, make" # ~ 10s
Gilles Peskine8f073122018-11-27 15:58:47 +0100941 scripts/config.pl full
942 scripts/config.pl unset MBEDTLS_NET_C
943 scripts/config.pl unset MBEDTLS_TIMING_C
944 scripts/config.pl unset MBEDTLS_FS_IO
Gilles Peskine51585382019-01-05 10:27:47 +0100945 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_FILE_C
946 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Gilles Peskine8f073122018-11-27 15:58:47 +0100947 scripts/config.pl unset MBEDTLS_ENTROPY_NV_SEED
948 scripts/config.pl set MBEDTLS_NO_PLATFORM_ENTROPY
949 # following things are not in the default config
950 scripts/config.pl unset MBEDTLS_HAVEGE_C # depends on timing.c
951 scripts/config.pl unset MBEDTLS_THREADING_PTHREAD
952 scripts/config.pl unset MBEDTLS_THREADING_C
953 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # execinfo.h
954 scripts/config.pl unset MBEDTLS_MEMORY_BUFFER_ALLOC_C # calls exit
955 scripts/config.pl set MBEDTLS_NO_64BIT_MULTIPLICATION
956 make CC=arm-none-eabi-gcc AR=arm-none-eabi-ar LD=arm-none-eabi-ld CFLAGS='-Werror -O1 -march=armv6-m -mthumb' lib
957 echo "Checking that software 64-bit multiplication is not required"
958 if_build_succeeded not grep __aeabi_lmul library/*.o
959}
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +0200960
Gilles Peskine8f073122018-11-27 15:58:47 +0100961component_build_armcc () {
962 msg "build: ARM Compiler 5, make"
Gilles Peskine8f073122018-11-27 15:58:47 +0100963 scripts/config.pl full
964 scripts/config.pl unset MBEDTLS_NET_C
965 scripts/config.pl unset MBEDTLS_TIMING_C
966 scripts/config.pl unset MBEDTLS_FS_IO
Gilles Peskine51585382019-01-05 10:27:47 +0100967 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_FILE_C
968 scripts/config.pl unset MBEDTLS_PSA_CRYPTO_STORAGE_C
Gilles Peskine8f073122018-11-27 15:58:47 +0100969 scripts/config.pl unset MBEDTLS_ENTROPY_NV_SEED
970 scripts/config.pl unset MBEDTLS_HAVE_TIME
971 scripts/config.pl unset MBEDTLS_HAVE_TIME_DATE
972 scripts/config.pl set MBEDTLS_NO_PLATFORM_ENTROPY
973 # following things are not in the default config
974 scripts/config.pl unset MBEDTLS_DEPRECATED_WARNING
975 scripts/config.pl unset MBEDTLS_HAVEGE_C # depends on timing.c
976 scripts/config.pl unset MBEDTLS_THREADING_PTHREAD
977 scripts/config.pl unset MBEDTLS_THREADING_C
978 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # execinfo.h
979 scripts/config.pl unset MBEDTLS_MEMORY_BUFFER_ALLOC_C # calls exit
980 scripts/config.pl unset MBEDTLS_PLATFORM_TIME_ALT # depends on MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000981
Gilles Peskine8f073122018-11-27 15:58:47 +0100982 if [ $RUN_ARMCC -ne 0 ]; then
983 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS='--strict --c99' lib
984 make clean
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +0200985
Gilles Peskine8f073122018-11-27 15:58:47 +0100986 # ARM Compiler 6 - Target ARMv7-A
987 armc6_build_test "--target=arm-arm-none-eabi -march=armv7-a"
Gilles Peskineed942f82017-06-08 15:19:20 +0200988
Gilles Peskine8f073122018-11-27 15:58:47 +0100989 # ARM Compiler 6 - Target ARMv7-M
990 armc6_build_test "--target=arm-arm-none-eabi -march=armv7-m"
Andres AG87bb5772016-09-27 15:05:15 +0100991
Gilles Peskine8f073122018-11-27 15:58:47 +0100992 # ARM Compiler 6 - Target ARMv8-A - AArch32
993 armc6_build_test "--target=arm-arm-none-eabi -march=armv8.2-a"
Andres AG87bb5772016-09-27 15:05:15 +0100994
Gilles Peskine8f073122018-11-27 15:58:47 +0100995 # ARM Compiler 6 - Target ARMv8-M
996 armc6_build_test "--target=arm-arm-none-eabi -march=armv8-m.main"
Simon Butcher940737f2017-07-23 13:42:36 +0200997
Gilles Peskine8f073122018-11-27 15:58:47 +0100998 # ARM Compiler 6 - Target ARMv8-A - AArch64
999 armc6_build_test "--target=aarch64-arm-none-eabi -march=armv8.2-a"
1000 fi
1001}
Simon Butcher940737f2017-07-23 13:42:36 +02001002
Gilles Peskine8f073122018-11-27 15:58:47 +01001003component_test_allow_sha1 () {
1004 msg "build: allow SHA1 in certificates by default"
Gilles Peskine8f073122018-11-27 15:58:47 +01001005 scripts/config.pl set MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
1006 make CFLAGS='-Werror -Wall -Wextra'
1007 msg "test: allow SHA1 in certificates by default"
1008 make test
1009 if_build_succeeded tests/ssl-opt.sh -f SHA-1
1010}
Simon Butcher940737f2017-07-23 13:42:36 +02001011
Gilles Peskine8f073122018-11-27 15:58:47 +01001012component_build_mingw () {
1013 msg "build: Windows cross build - mingw64, make (Link Library)" # ~ 30s
Gilles Peskine8f073122018-11-27 15:58:47 +01001014 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 +02001015
Gilles Peskine8f073122018-11-27 15:58:47 +01001016 # note Make tests only builds the tests, but doesn't run them
1017 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS='-Werror' WINDOWS_BUILD=1 tests
1018 make WINDOWS_BUILD=1 clean
Hanno Beckere963efa2018-01-03 10:03:43 +00001019
Gilles Peskine8f073122018-11-27 15:58:47 +01001020 msg "build: Windows cross build - mingw64, make (DLL)" # ~ 30s
1021 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
1022 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
1023 make WINDOWS_BUILD=1 clean
1024}
Simon Butcher002bc622016-11-17 09:27:45 +00001025
Gilles Peskine8f073122018-11-27 15:58:47 +01001026component_test_memsan () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001027 msg "build: MSan (clang)" # ~ 1 min 20s
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001028 scripts/config.pl unset MBEDTLS_AESNI_C # memsan doesn't grok asm
1029 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
1030 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +02001031
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001032 msg "test: main suites (MSan)" # ~ 10s
1033 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001034
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001035 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskine7c652162017-12-11 00:01:40 +01001036 if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001037
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001038 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +01001039
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001040 if [ "$MEMORY" -gt 0 ]; then
1041 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskine7c652162017-12-11 00:01:40 +01001042 if_build_succeeded tests/compat.sh
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001043 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01001044}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001045
Gilles Peskine8f073122018-11-27 15:58:47 +01001046component_test_memcheck () {
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001047 msg "build: Release (clang)"
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001048 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
1049 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001050
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001051 msg "test: main suites valgrind (Release)"
1052 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001053
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001054 # Optional part(s)
1055 # Currently broken, programs don't seem to receive signals
1056 # under valgrind on OS X
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001057
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001058 if [ "$MEMORY" -gt 0 ]; then
1059 msg "test: ssl-opt.sh --memcheck (Release)"
Gilles Peskine7c652162017-12-11 00:01:40 +01001060 if_build_succeeded tests/ssl-opt.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001061 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001062
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001063 if [ "$MEMORY" -gt 1 ]; then
1064 msg "test: compat.sh --memcheck (Release)"
Gilles Peskine7c652162017-12-11 00:01:40 +01001065 if_build_succeeded tests/compat.sh --memcheck
Gilles Peskine7ad603e2017-12-10 23:22:20 +01001066 fi
Gilles Peskine8f073122018-11-27 15:58:47 +01001067}
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001068
Gilles Peskine8f073122018-11-27 15:58:47 +01001069component_test_cmake_out_of_source () {
1070 msg "build: cmake 'out-of-source' build"
Gilles Peskine8f073122018-11-27 15:58:47 +01001071 MBEDTLS_ROOT_DIR="$PWD"
1072 mkdir "$OUT_OF_SOURCE_DIR"
1073 cd "$OUT_OF_SOURCE_DIR"
1074 cmake "$MBEDTLS_ROOT_DIR"
1075 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +00001076
Gilles Peskine8f073122018-11-27 15:58:47 +01001077 msg "test: cmake 'out-of-source' build"
1078 make test
1079 # Test an SSL option that requires an auxiliary script in test/scripts/.
1080 # Also ensure that there are no error messages such as
1081 # "No such file or directory", which would indicate that some required
1082 # file is missing (ssl-opt.sh tolerates the absence of some files so
1083 # may exit with status 0 but emit errors).
1084 if_build_succeeded ./tests/ssl-opt.sh -f 'Fallback SCSV: beginning of list' 2>ssl-opt.err
1085 if [ -s ssl-opt.err ]; then
1086 cat ssl-opt.err >&2
1087 record_status [ ! -s ssl-opt.err ]
1088 rm ssl-opt.err
1089 fi
1090 cd "$MBEDTLS_ROOT_DIR"
1091 rm -rf "$OUT_OF_SOURCE_DIR"
1092 unset MBEDTLS_ROOT_DIR
1093}
Andres AGdc192212016-08-31 17:33:13 +01001094
Gilles Peskine8f073122018-11-27 15:58:47 +01001095component_test_zeroize () {
1096 # Test that the function mbedtls_platform_zeroize() is not optimized away by
1097 # different combinations of compilers and optimization flags by using an
1098 # auxiliary GDB script. Unfortunately, GDB does not return error values to the
1099 # system in all cases that the script fails, so we must manually search the
1100 # output to check whether the pass string is present and no failure strings
1101 # were printed.
Gilles Peskine74851d82019-01-06 19:52:22 +00001102
1103 # Don't try to disable ASLR. We don't care about ASLR here. We do care
1104 # about a spurious message if Gdb tries and fails, so suppress that.
1105 gdb_disable_aslr=
1106 if [ -z "$(gdb -batch -nw -ex 'set disable-randomization off' 2>&1)" ]; then
1107 gdb_disable_aslr='set disable-randomization off'
1108 fi
1109
Gilles Peskine8f073122018-11-27 15:58:47 +01001110 for optimization_flag in -O2 -O3 -Ofast -Os; do
Gilles Peskine06b385f2019-01-09 22:28:21 +01001111 for compiler in clang gcc; do
1112 msg "test: $compiler $optimization_flag, mbedtls_platform_zeroize()"
1113 make programs CC="$compiler" DEBUG=1 CFLAGS="$optimization_flag"
Gilles Peskine74851d82019-01-06 19:52:22 +00001114 if_build_succeeded gdb -ex "$gdb_disable_aslr" -x tests/scripts/test_zeroize.gdb -nw -batch -nx 2>&1 | tee test_zeroize.log
Gilles Peskine06b385f2019-01-09 22:28:21 +01001115 if_build_succeeded grep "The buffer was correctly zeroized" test_zeroize.log
1116 if_build_succeeded not grep -i "error" test_zeroize.log
1117 rm -f test_zeroize.log
1118 make clean
1119 done
Andres Amaya Garcia29673812017-10-25 10:35:51 +01001120 done
Gilles Peskine74851d82019-01-06 19:52:22 +00001121
1122 unset gdb_disable_aslr
Gilles Peskine8f073122018-11-27 15:58:47 +01001123}
Andres Amaya Garciad0d7bf62017-10-25 09:01:31 +01001124
Gilles Peskine8f073122018-11-27 15:58:47 +01001125component_check_python_files () {
1126 msg "Lint: Python scripts"
1127 record_status tests/scripts/check-python-files.sh
1128}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001129
Gilles Peskine8f073122018-11-27 15:58:47 +01001130component_check_generate_test_code () {
1131 msg "uint test: generate_test_code.py"
1132 record_status ./tests/scripts/test_generate_test_code.py
1133}
Gilles Peskine192c72f2017-12-21 15:59:21 +01001134
1135################################################################
1136#### Termination
1137################################################################
1138
Gilles Peskine8f073122018-11-27 15:58:47 +01001139post_report () {
1140 msg "Done, cleaning up"
1141 cleanup
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001142
Gilles Peskine8f073122018-11-27 15:58:47 +01001143 final_report
1144}
1145
1146
1147
1148################################################################
1149#### Run all the things
1150################################################################
1151
Gilles Peskine92525112018-11-27 18:15:35 +01001152run_all_components () {
1153 # Small things
1154 run_component component_check_recursion
1155 run_component component_check_generated_files
1156 run_component component_check_doxy_blocks
1157 run_component component_check_files
1158 run_component component_check_names
1159 run_component component_check_doxygen_warnings
1160
1161 # Test many different configurations
1162 run_component component_test_default_cmake_gcc_asan
1163 run_component component_test_ref_configs
1164 run_component component_test_sslv3
1165 run_component component_test_no_renegotiation
1166 run_component component_test_rsa_no_crt
1167 run_component component_test_small_ssl_out_content_len
1168 run_component component_test_small_ssl_in_content_len
1169 run_component component_test_small_ssl_dtls_max_buffering
1170 run_component component_test_small_mbedtls_ssl_dtls_max_buffering
1171 run_component component_test_full_cmake_clang
1172 run_component component_build_deprecated
1173 run_component component_test_depends_curves
1174 run_component component_test_depends_hashes
1175 run_component component_test_depends_pkalgs
1176 run_component component_build_key_exchanges
1177 run_component component_build_default_make_gcc_and_cxx
1178 run_component component_test_no_platform
1179 run_component component_build_no_std_function
1180 run_component component_build_no_ssl_srv
1181 run_component component_build_no_ssl_cli
1182 run_component component_build_no_sockets
1183 run_component component_test_no_max_fragment_length
1184 run_component component_test_no_max_fragment_length_small_ssl_out_content_len
1185 run_component component_test_null_entropy
1186 run_component component_test_platform_calloc_macro
1187 run_component component_test_aes_fewer_tables
1188 run_component component_test_aes_rom_tables
1189 run_component component_test_aes_fewer_tables_and_rom_tables
Gilles Peskinebdf3f522019-01-06 19:58:02 +00001190 run_component component_test_make_shared
1191 case $(uname -m) in
1192 amd64|x86_64)
1193 run_component component_test_m32_o0
1194 run_component component_test_m32_o1
1195 run_component component_test_mx32
1196 ;;
1197 esac
Gilles Peskine92525112018-11-27 18:15:35 +01001198 run_component component_test_have_int32
1199 run_component component_test_have_int64
1200 run_component component_test_no_udbl_division
1201 run_component component_test_no_64bit_multiplication
1202 run_component component_build_arm_none_eabi_gcc
1203 run_component component_build_arm_none_eabi_gcc_no_udbl_division
1204 run_component component_build_arm_none_eabi_gcc_no_64bit_multiplication
1205 run_component component_build_armcc
1206 run_component component_test_allow_sha1
1207 run_component component_build_mingw
Gilles Peskinebdf3f522019-01-06 19:58:02 +00001208 run_component component_test_memsan
1209 run_component component_test_memcheck
Gilles Peskine92525112018-11-27 18:15:35 +01001210 run_component component_test_cmake_out_of_source
1211
1212 # More small things
1213 run_component component_test_zeroize
1214 run_component component_check_python_files
1215 run_component component_check_generate_test_code
1216}
1217
Gilles Peskinee48351a2018-11-27 16:06:30 +01001218# Run one component and clean up afterwards.
Gilles Peskine8f073122018-11-27 15:58:47 +01001219run_component () {
Gilles Peskine81b96ed2018-11-27 21:37:53 +01001220 if [ $ALL_EXCEPT -ne 0 ] && component_is_excluded "$1"; then
1221 return
1222 fi
Gilles Peskine8ae15dd2019-01-02 18:57:02 +01001223 # Back up the configuration in case the component modifies it.
1224 # The cleanup function will restore it.
1225 cp -p "$CONFIG_H" "$CONFIG_BAK"
Gilles Peskineffcdeff2018-12-04 12:49:28 +01001226 current_component="$1"
Gilles Peskine8f073122018-11-27 15:58:47 +01001227 "$@"
Gilles Peskinee48351a2018-11-27 16:06:30 +01001228 cleanup
Gilles Peskine8f073122018-11-27 15:58:47 +01001229}
1230
1231# Preliminary setup
1232pre_check_environment
1233pre_initialize_variables
1234pre_parse_command_line "$@"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01001235
1236case "$INTROSPECTION_MODE" in
1237 list_components)
1238 components=
1239 newline='
1240'
1241 run_component () {
Gilles Peskine92525112018-11-27 18:15:35 +01001242 components="${components}${newline}${1#component_}"
Gilles Peskine348fb9a2018-11-27 17:04:29 +01001243 }
1244 ;;
1245
1246 *)
1247 pre_check_git
1248 build_status=0
1249 if [ $KEEP_GOING -eq 1 ]; then
1250 pre_setup_keep_going
1251 else
1252 record_status () {
1253 "$@"
1254 }
1255 fi
1256 pre_print_configuration
1257 pre_check_tools
1258 pre_print_tools
1259 cleanup
1260 ;;
1261esac
Gilles Peskine8f073122018-11-27 15:58:47 +01001262
Gilles Peskine81b96ed2018-11-27 21:37:53 +01001263if [ -n "$COMPONENTS" ] && [ $ALL_EXCEPT -eq 0 ]; then
Gilles Peskine92525112018-11-27 18:15:35 +01001264 for component in $COMPONENTS; do
1265 run_component "component_$component"
1266 done
1267else
1268 run_all_components
Gilles Peskine8f073122018-11-27 15:58:47 +01001269fi
Gilles Peskine8f073122018-11-27 15:58:47 +01001270
1271# We're done.
Gilles Peskine348fb9a2018-11-27 17:04:29 +01001272case "$INTROSPECTION_MODE" in
1273 list_components)
1274 echo "$components" | sort
1275 ;;
1276 *)
1277 post_report
1278 ;;
1279esac