blob: 6f2bfad366378e9c9e16581387f10bda3463f8ed [file] [log] [blame]
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01001#!/bin/sh
2
Simon Butcherd7f19022016-10-14 09:49:48 +01003# all.sh
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +01004#
Simon Butcherd7f19022016-10-14 09:49:48 +01005# This file is part of mbed TLS (https://tls.mbed.org)
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +01006#
Gilles Peskined7602c22017-12-21 15:59:21 +01007# Copyright (c) 2014-2017, ARM Limited, All Rights Reserved
8
9
10
11################################################################
12#### Documentation
13################################################################
14
Simon Butcherd7f19022016-10-14 09:49:48 +010015# Purpose
Gilles Peskined7602c22017-12-21 15:59:21 +010016# -------
Simon Butcherd7f19022016-10-14 09:49:48 +010017#
18# To run all tests possible or available on the platform.
19#
Gilles Peskined7602c22017-12-21 15:59:21 +010020# Notes for users
21# ---------------
22#
Simon Butcherd7f19022016-10-14 09:49:48 +010023# Warning: the test is destructive. It includes various build modes and
24# configurations, and can and will arbitrarily change the current CMake
Gilles Peskined7602c22017-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.
Simon Butcherd7f19022016-10-14 09:49:48 +010030#
Gilles Peskined7602c22017-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)
38# * arm-gcc and mingw-gcc
39# * ArmCC 5 and ArmCC 6, unless invoked with --no-armcc
40# * OpenSSL and GnuTLS command line tools, recent enough for the
41# interoperability tests. If they don't support SSLv3 then a legacy
42# version of these tools must be present as well (search for LEGACY
43# below).
44# See the invocation of check_tools below for details.
45#
46# This script must be invoked from the toplevel directory of a git
47# working copy of Mbed TLS.
48#
49# Note that the output is not saved. You may want to run
50# script -c tests/scripts/all.sh
51# or
52# tests/scripts/all.sh >all.log 2>&1
53#
54# Notes for maintainers
55# ---------------------
56#
57# The tests are roughly in order from fastest to slowest. This doesn't
58# have to be exact, but in general you should add slower tests towards
59# the end and fast checks near the beginning.
60#
61# Sanity checks have the following form:
62# 1. msg "short description of what is about to be done"
63# 2. run sanity check (failure stops the script)
64#
65# Build or build-and-test steps have the following form:
66# 1. msg "short description of what is about to be done"
67# 2. cleanup
68# 3. preparation (config.pl, cmake, ...) (failure stops the script)
69# 4. make
70# 5. Run tests if relevant. All tests must be prefixed with
71# if_build_successful for the sake of --keep-going.
72
73
74
75################################################################
76#### Initialization and command line parsing
77################################################################
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010078
Simon Butcherd7f19022016-10-14 09:49:48 +010079# Abort on errors (and uninitialised variables)
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010080set -eu
81
82if [ -d library -a -d include -a -d tests ]; then :; else
Simon Butcherd7f19022016-10-14 09:49:48 +010083 err_msg "Must be run from mbed TLS root"
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010084 exit 1
85fi
86
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000087CONFIG_H='include/mbedtls/config.h'
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +020088CONFIG_BAK="$CONFIG_H.bak"
89
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010090MEMORY=0
Simon Butcherd7f19022016-10-14 09:49:48 +010091FORCE=0
Gilles Peskinea8bf9862017-12-11 00:01:40 +010092KEEP_GOING=0
Gilles Peskineb9344e32017-12-19 18:24:31 +010093RUN_ARMCC=1
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +010094
Simon Butcherd7f19022016-10-14 09:49:48 +010095# Default commands, can be overriden by the environment
96: ${OPENSSL:="openssl"}
97: ${OPENSSL_LEGACY:="$OPENSSL"}
98: ${GNUTLS_CLI:="gnutls-cli"}
99: ${GNUTLS_SERV:="gnutls-serv"}
100: ${GNUTLS_LEGACY_CLI:="$GNUTLS_CLI"}
101: ${GNUTLS_LEGACY_SERV:="$GNUTLS_SERV"}
102: ${OUT_OF_SOURCE_DIR:=./mbedtls_out_of_source_build}
103
104usage()
105{
Gilles Peskinea6901f42017-12-10 23:43:39 +0100106 cat <<EOF
107Usage: $0 [OPTION]...
108 -h|--help Print this help.
109
110General options:
111 -f|--force Force the tests to overwrite any modified files.
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100112 -k|--keep-going Run all tests and report errors at the end.
Gilles Peskinea6901f42017-12-10 23:43:39 +0100113 -m|--memory Additional optional memory tests.
Gilles Peskineb9344e32017-12-19 18:24:31 +0100114 --armcc Run ARM Compiler builds (on by default).
115 --no-armcc Skip ARM Compiler builds.
Gilles Peskine243bb4c2018-03-21 08:40:26 +0100116 --no-force Refuse to overwrite modified files (default).
117 --no-keep-going Stop at the first error (default).
118 --no-memory No additional memory tests (default).
Gilles Peskine32d92932018-03-21 10:14:05 +0100119 --no-yotta Ignored for compatibility with other Mbed TLS versions.
Gilles Peskinea6901f42017-12-10 23:43:39 +0100120 --out-of-source-dir=<path> Directory used for CMake out-of-source build tests.
Gilles Peskine243bb4c2018-03-21 08:40:26 +0100121 --random-seed Use a random seed value for randomized tests (default).
Gilles Peskinea6901f42017-12-10 23:43:39 +0100122 -r|--release-test Run this script in release mode. This fixes the seed value to 1.
123 -s|--seed Integer seed value to use for this test run.
124
125Tool path options:
Gilles Peskine37c88db2018-03-21 11:44:52 +0100126 --armc5-bin-dir=<ARMC5_bin_dir_path> ARM Compiler 5 bin directory.
127 --armc6-bin-dir=<ARMC6_bin_dir_path> Ignored for compatibility with other Mbed TLS versions.
Gilles Peskinea6901f42017-12-10 23:43:39 +0100128 --gnutls-cli=<GnuTLS_cli_path> GnuTLS client executable to use for most tests.
129 --gnutls-serv=<GnuTLS_serv_path> GnuTLS server executable to use for most tests.
130 --gnutls-legacy-cli=<GnuTLS_cli_path> GnuTLS client executable to use for legacy tests.
131 --gnutls-legacy-serv=<GnuTLS_serv_path> GnuTLS server executable to use for legacy tests.
132 --openssl=<OpenSSL_path> OpenSSL executable to use for most tests.
133 --openssl-legacy=<OpenSSL_path> OpenSSL executable to use for legacy tests e.g. SSLv3.
134EOF
Simon Butcherd7f19022016-10-14 09:49:48 +0100135}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100136
137# remove built files as well as the cmake cache/config
138cleanup()
139{
Gilles Peskine00de2fd2018-03-21 12:16:57 +0100140 if [ -n "${MBEDTLS_ROOT_DIR+set}" ]; then
141 cd "$MBEDTLS_ROOT_DIR"
142 fi
143
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100144 command make clean
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200145
Gilles Peskine341ea252018-03-21 12:15:06 +0100146 # Remove CMake artefacts
147 find . -name .git -prune -o -name yotta -prune -o \
148 -iname CMakeFiles -exec rm -rf {} \+ -o \
149 \( -iname cmake_install.cmake -o \
150 -iname CTestTestfile.cmake -o \
151 -iname CMakeCache.txt \) -exec rm {} \+
152 # Recover files overwritten by in-tree CMake builds
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +0000153 rm -f include/Makefile include/mbedtls/Makefile programs/*/Makefile
Paul Bakkerfe0984d2014-06-13 00:13:45 +0200154 git update-index --no-skip-worktree Makefile library/Makefile programs/Makefile tests/Makefile
155 git checkout -- Makefile library/Makefile programs/Makefile tests/Makefile
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200156
157 if [ -f "$CONFIG_BAK" ]; then
158 mv "$CONFIG_BAK" "$CONFIG_H"
159 fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100160}
161
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100162# Executed on exit. May be redefined depending on command line options.
163final_report () {
164 :
165}
166
167fatal_signal () {
168 cleanup
169 final_report $1
170 trap - $1
171 kill -$1 $$
172}
173
174trap 'fatal_signal HUP' HUP
175trap 'fatal_signal INT' INT
176trap 'fatal_signal TERM' TERM
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200177
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100178msg()
179{
180 echo ""
181 echo "******************************************************************"
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100182 echo "* $1 "
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000183 printf "* "; date
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100184 echo "******************************************************************"
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100185 current_section=$1
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100186}
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100187
Simon Butcherd7f19022016-10-14 09:49:48 +0100188err_msg()
189{
190 echo "$1" >&2
191}
192
193check_tools()
194{
195 for TOOL in "$@"; do
196 if ! `hash "$TOOL" >/dev/null 2>&1`; then
197 err_msg "$TOOL not found!"
198 exit 1
199 fi
200 done
201}
202
203while [ $# -gt 0 ]; do
204 case "$1" in
Gilles Peskine7efa8cf2018-03-21 10:04:49 +0100205 --armcc) RUN_ARMCC=1;;
Gilles Peskine37c88db2018-03-21 11:44:52 +0100206 --armc5-bin-dir) shift; ARMC5_BIN_DIR="$1";;
207 --armc6-bin-dir) shift;; # Ignore for compatibility with later Mbed TLS versions
Gilles Peskine7efa8cf2018-03-21 10:04:49 +0100208 --force|-f) FORCE=1;;
209 --gnutls-cli) shift; GNUTLS_CLI="$1";;
210 --gnutls-legacy-cli) shift; GNUTLS_LEGACY_CLI="$1";;
211 --gnutls-legacy-serv) shift; GNUTLS_LEGACY_SERV="$1";;
212 --gnutls-serv) shift; GNUTLS_SERV="$1";;
213 --help|-h) usage; exit;;
214 --keep-going|-k) KEEP_GOING=1;;
215 --memory|-m) MEMORY=1;;
216 --no-armcc) RUN_ARMCC=0;;
Gilles Peskine243bb4c2018-03-21 08:40:26 +0100217 --no-force) FORCE=0;;
218 --no-keep-going) KEEP_GOING=0;;
219 --no-memory) MEMORY=0;;
Gilles Peskine32d92932018-03-21 10:14:05 +0100220 --no-yotta) :;; # No Yotta support anyway, so just ignore --no-yotta
Gilles Peskine7efa8cf2018-03-21 10:04:49 +0100221 --openssl) shift; OPENSSL="$1";;
222 --openssl-legacy) shift; OPENSSL_LEGACY="$1";;
223 --out-of-source-dir) shift; OUT_OF_SOURCE_DIR="$1";;
Gilles Peskine243bb4c2018-03-21 08:40:26 +0100224 --random-seed) unset SEED;;
225 --release-test|-r) SEED=1;;
Gilles Peskine7efa8cf2018-03-21 10:04:49 +0100226 --seed|-s) shift; SEED="$1";;
Gilles Peskinea6901f42017-12-10 23:43:39 +0100227 *)
228 echo >&2 "Unknown option: $1"
229 echo >&2 "Run $0 --help for usage."
230 exit 120
Simon Butcherd7f19022016-10-14 09:49:48 +0100231 ;;
232 esac
233 shift
234done
235
236if [ $FORCE -eq 1 ]; then
237 rm -rf yotta/module "$OUT_OF_SOURCE_DIR"
238 git checkout-index -f -q $CONFIG_H
239 cleanup
240else
241
242 if [ -d yotta/module ]; then
243 err_msg "Warning - there is an existing yotta module in the directory 'yotta/module'"
244 echo "You can either delete your work and retry, or force the test to overwrite the"
245 echo "test by rerunning the script as: $0 --force"
246 exit 1
247 fi
248
249 if [ -d "$OUT_OF_SOURCE_DIR" ]; then
250 echo "Warning - there is an existing directory at '$OUT_OF_SOURCE_DIR'" >&2
251 echo "You can either delete this directory manually, or force the test by rerunning"
252 echo "the script as: $0 --force --out-of-source-dir $OUT_OF_SOURCE_DIR"
253 exit 1
254 fi
255
256 if ! git diff-files --quiet include/mbedtls/config.h; then
Simon Butcherd7f19022016-10-14 09:49:48 +0100257 err_msg "Warning - the configuration file 'include/mbedtls/config.h' has been edited. "
258 echo "You can either delete or preserve your work, or force the test by rerunning the"
259 echo "script as: $0 --force"
260 exit 1
261 fi
262fi
263
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100264build_status=0
265if [ $KEEP_GOING -eq 1 ]; then
266 failure_summary=
267 failure_count=0
268 start_red=
269 end_color=
270 if [ -t 1 ]; then
Gilles Peskine92deeaa2018-01-02 21:54:17 +0100271 case "${TERM:-}" in
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100272 *color*|cygwin|linux|rxvt*|screen|[Eex]term*)
273 start_red=$(printf '\033[31m')
274 end_color=$(printf '\033[0m')
275 ;;
276 esac
277 fi
278 record_status () {
279 if "$@"; then
280 last_status=0
281 else
282 last_status=$?
283 text="$current_section: $* -> $last_status"
284 failure_summary="$failure_summary
285$text"
286 failure_count=$((failure_count + 1))
287 echo "${start_red}^^^^$text^^^^${end_color}"
288 fi
289 }
290 make () {
291 case "$*" in
292 *test|*check)
293 if [ $build_status -eq 0 ]; then
294 record_status command make "$@"
295 else
296 echo "(skipped because the build failed)"
297 fi
298 ;;
299 *)
300 record_status command make "$@"
301 build_status=$last_status
302 ;;
303 esac
304 }
305 final_report () {
306 if [ $failure_count -gt 0 ]; then
307 echo
308 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
309 echo "${start_red}FAILED: $failure_count${end_color}$failure_summary"
310 echo "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
311 elif [ -z "${1-}" ]; then
312 echo "SUCCESS :)"
313 fi
314 if [ -n "${1-}" ]; then
315 echo "Killed by SIG$1."
316 fi
317 }
318else
319 record_status () {
320 "$@"
321 }
322fi
323if_build_succeeded () {
324 if [ $build_status -eq 0 ]; then
325 record_status "$@"
326 fi
327}
328
Simon Butcherd7f19022016-10-14 09:49:48 +0100329msg "info: $0 configuration"
330echo "MEMORY: $MEMORY"
331echo "FORCE: $FORCE"
332echo "SEED: ${SEED-"UNSET"}"
333echo "OPENSSL: $OPENSSL"
334echo "OPENSSL_LEGACY: $OPENSSL_LEGACY"
335echo "GNUTLS_CLI: $GNUTLS_CLI"
336echo "GNUTLS_SERV: $GNUTLS_SERV"
337echo "GNUTLS_LEGACY_CLI: $GNUTLS_LEGACY_CLI"
338echo "GNUTLS_LEGACY_SERV: $GNUTLS_LEGACY_SERV"
Gilles Peskine37c88db2018-03-21 11:44:52 +0100339echo "ARMC5_BIN_DIR: ${ARMC5_BIN_DIR:-UNSET}"
340
341if [ -n "${ARMC5_BIN_DIR-}" ]; then
342 ARMC5_CC="$ARMC5_BIN_DIR/armcc"
343 ARMC5_AR="$ARMC5_BIN_DIR/armar"
344else
345 ARMC5_CC=armcc
346 ARMC5_AR=armar
347fi
Simon Butcherd7f19022016-10-14 09:49:48 +0100348
349# To avoid setting OpenSSL and GnuTLS for each call to compat.sh and ssl-opt.sh
350# we just export the variables they require
351export OPENSSL_CMD="$OPENSSL"
352export GNUTLS_CLI="$GNUTLS_CLI"
353export GNUTLS_SERV="$GNUTLS_SERV"
354
355# Avoid passing --seed flag in every call to ssl-opt.sh
Gilles Peskine243bb4c2018-03-21 08:40:26 +0100356if [ -n "${SEED-}" ]; then
357 export SEED
358fi
Simon Butcherd7f19022016-10-14 09:49:48 +0100359
360# Make sure the tools we need are available.
361check_tools "$OPENSSL" "$OPENSSL_LEGACY" "$GNUTLS_CLI" "$GNUTLS_SERV" \
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100362 "$GNUTLS_LEGACY_CLI" "$GNUTLS_LEGACY_SERV" "doxygen" "dot" \
Gilles Peskineb9344e32017-12-19 18:24:31 +0100363 "arm-none-eabi-gcc"
364if [ $RUN_ARMCC -ne 0 ]; then
Gilles Peskine37c88db2018-03-21 11:44:52 +0100365 check_tools "$ARMC5_CC" "$ARMC5_AR"
Gilles Peskineb9344e32017-12-19 18:24:31 +0100366fi
Simon Butcherd7f19022016-10-14 09:49:48 +0100367
Gilles Peskined7602c22017-12-21 15:59:21 +0100368
369
370################################################################
371#### Basic checks
372################################################################
373
Simon Butcherd7f19022016-10-14 09:49:48 +0100374#
375# Test Suites to be executed
376#
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200377# The test ordering tries to optimize for the following criteria:
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100378# 1. Catch possible problems early, by running first tests that run quickly
Manuel Pégourié-Gonnard61bc57a2014-08-14 11:29:06 +0200379# and/or are more likely to fail than others (eg I use Clang most of the
380# time, so start with a GCC build).
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200381# 2. Minimize total running time, by avoiding useless rebuilds
382#
383# Indicative running times are given for reference.
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100384
Manuel Pégourié-Gonnardea29d152014-11-20 17:32:33 +0100385msg "test: recursion.pl" # < 1s
Manuel Pégourié-Gonnardd09a6b52015-04-09 17:19:23 +0200386tests/scripts/recursion.pl library/*.c
Manuel Pégourié-Gonnardea29d152014-11-20 17:32:33 +0100387
Manuel Pégourié-Gonnardb3b8e432015-02-13 14:52:19 +0000388msg "test: freshness of generated source files" # < 1s
389tests/scripts/check-generated-files.sh
390
Manuel Pégourié-Gonnardd09a6b52015-04-09 17:19:23 +0200391msg "test: doxygen markup outside doxygen blocks" # < 1s
392tests/scripts/check-doxy-blocks.pl
393
Manuel Pégourié-Gonnarda687baf2015-04-09 11:09:03 +0200394msg "test/build: declared and exported names" # < 3s
395cleanup
396tests/scripts/check-names.sh
397
Gilles Peskined7602c22017-12-21 15:59:21 +0100398
399
400################################################################
401#### Build and test many configurations and targets
402################################################################
403
Simon Butcher73156352015-11-04 00:36:30 +0000404# Yotta not supported in 2.1 branch
405#msg "build: create and build yotta module" # ~ 30s
406#cleanup
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100407#record_status tests/scripts/yotta-build.sh
Manuel Pégourié-Gonnard77d56bb2015-07-28 15:00:37 +0200408
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100409msg "build: cmake, gcc, ASan" # ~ 1 min 50s
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100410cleanup
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100411CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100412make
413
Simon Butcherd7f19022016-10-14 09:49:48 +0100414msg "test: main suites (inc. selftests) (ASan build)" # ~ 50s
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100415make test
416programs/test/selftest
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200417
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100418msg "test: ssl-opt.sh (ASan build)" # ~ 1 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100419if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200420
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100421msg "test/build: ref-configs (ASan build)" # ~ 6 min 20s
Gilles Peskinea1931692018-03-22 22:26:03 +0100422record_status tests/scripts/test-ref-configs.pl
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200423
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200424msg "build: with ASan (rebuild after ref-configs)" # ~ 1 min
425make
426
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100427msg "test: compat.sh (ASan build)" # ~ 6 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100428if_build_succeeded tests/compat.sh
Manuel Pégourié-Gonnard57255b12014-06-09 11:21:49 +0200429
Hanno Becker797c0842017-10-19 15:49:21 +0100430msg "build: default config except MFL extension (ASan build)" # ~ 30s
431cleanup
432cp "$CONFIG_H" "$CONFIG_BAK"
433scripts/config.pl unset MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
434CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
435make
436
437msg "test: ssl-opt.sh, MFL-related tests"
438tests/ssl-opt.sh -f "Max fragment length"
439
Simon Butcher02b8d482016-03-15 20:39:52 +0000440msg "build: Default + SSLv3 (ASan build)" # ~ 6 min
441cleanup
442cp "$CONFIG_H" "$CONFIG_BAK"
443scripts/config.pl set MBEDTLS_SSL_PROTO_SSL3
444CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
445make
446
Simon Butcherd7f19022016-10-14 09:49:48 +0100447msg "test: SSLv3 - main suites (inc. selftests) (ASan build)" # ~ 50s
Simon Butcher02b8d482016-03-15 20:39:52 +0000448make test
449programs/test/selftest
450
451msg "build: SSLv3 - compat.sh (ASan build)" # ~ 6 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100452if_build_succeeded tests/compat.sh -m 'tls1 tls1_1 tls1_2 dtls1 dtls1_2'
453if_build_succeeded env OPENSSL_CMD="$OPENSSL_LEGACY" tests/compat.sh -m 'ssl3'
Simon Butcher02b8d482016-03-15 20:39:52 +0000454
455msg "build: SSLv3 - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100456if_build_succeeded tests/ssl-opt.sh
Simon Butcher02b8d482016-03-15 20:39:52 +0000457
Hanno Becker4f9973e2017-10-24 11:56:28 +0100458msg "build: Default + !MBEDTLS_SSL_RENEGOTIATION (ASan build)" # ~ 6 min
459cleanup
460cp "$CONFIG_H" "$CONFIG_BAK"
461scripts/config.pl unset MBEDTLS_SSL_RENEGOTIATION
462CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
463make
464
465msg "test: !MBEDTLS_SSL_RENEGOTIATION - main suites (inc. selftests) (ASan build)" # ~ 50s
466make test
467
468msg "test: !MBEDTLS_SSL_RENEGOTIATION - ssl-opt.sh (ASan build)" # ~ 6 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100469if_build_succeeded tests/ssl-opt.sh
Hanno Becker4f9973e2017-10-24 11:56:28 +0100470
Hanno Becker92935922017-11-06 15:07:09 +0000471msg "build: Default + RSA_NO_CRT (ASan build)" # ~ 6 min
472cleanup
473cp "$CONFIG_H" "$CONFIG_BAK"
474scripts/config.pl set MBEDTLS_RSA_NO_CRT
475CC=gcc cmake -D CMAKE_BUILD_TYPE:String=Asan .
476make
477
478msg "test: RSA_NO_CRT - main suites (inc. selftests) (ASan build)" # ~ 50s
479make test
480
481msg "test: RSA_NO_CRT - RSA-related part of ssl-opt.sh (ASan build)" # ~ 5s
482tests/ssl-opt.sh -f RSA
483
484msg "test: RSA_NO_CRT - RSA-related part of compat.sh (ASan build)" # ~ 3 min
485tests/compat.sh -t RSA
486
487
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100488msg "build: cmake, full config, clang" # ~ 50s
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100489cleanup
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200490cp "$CONFIG_H" "$CONFIG_BAK"
491scripts/config.pl full
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200492scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # too slow for tests
Manuel Pégourié-Gonnardac92a482017-06-20 10:49:24 +0200493CC=clang cmake -D CMAKE_BUILD_TYPE:String=Check -D ENABLE_TESTING=On .
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100494make
495
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100496msg "test: main suites (full config)" # ~ 5s
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200497make test
498
Manuel Pégourié-Gonnard89d69b32014-11-20 13:48:53 +0100499msg "test: ssl-opt.sh default (full config)" # ~ 1s
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100500if_build_succeeded tests/ssl-opt.sh -f Default
Manuel Pégourié-Gonnarde73b2632014-07-12 04:00:00 +0200501
Manuel Pégourié-Gonnardea0920f2015-03-24 09:50:15 +0100502msg "test: compat.sh RC4, DES & NULL (full config)" # ~ 2 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100503if_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 +0200504
Manuel Pégourié-Gonnard134ca182015-10-23 09:04:45 +0200505msg "test/build: curves.pl (gcc)" # ~ 4 min
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +0100506cleanup
Gilles Peskinea1931692018-03-22 22:26:03 +0100507record_status tests/scripts/curves.pl
Manuel Pégourié-Gonnard246978d2014-11-20 13:29:53 +0100508
Manuel Pégourié-Gonnard57176e52017-06-06 11:36:16 +0200509msg "test/build: depends-hashes.pl (gcc)" # ~ 2 min
510cleanup
Gilles Peskinea1931692018-03-22 22:26:03 +0100511record_status tests/scripts/depends-hashes.pl
Manuel Pégourié-Gonnard57176e52017-06-06 11:36:16 +0200512
Manuel Pégourié-Gonnardf2fd5462017-06-20 09:53:42 +0200513msg "test/build: depends-pkalgs.pl (gcc)" # ~ 2 min
514cleanup
Gilles Peskinea1931692018-03-22 22:26:03 +0100515record_status tests/scripts/depends-pkalgs.pl
Manuel Pégourié-Gonnardf2fd5462017-06-20 09:53:42 +0200516
Manuel Pégourié-Gonnard134ca182015-10-23 09:04:45 +0200517msg "test/build: key-exchanges (gcc)" # ~ 1 min
518cleanup
Gilles Peskinea1931692018-03-22 22:26:03 +0100519record_status tests/scripts/key-exchanges.pl
Manuel Pégourié-Gonnard134ca182015-10-23 09:04:45 +0200520
Manuel Pégourié-Gonnard61fe8b02015-03-13 14:33:16 +0000521msg "build: Unix make, -Os (gcc)" # ~ 30s
Manuel Pégourié-Gonnard3895f5a2014-03-27 14:44:04 +0100522cleanup
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100523make CC=gcc CFLAGS='-Werror -Os'
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100524
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200525# this is meant to cath missing #define mbedtls_printf etc
Manuel Pégourié-Gonnard981732b2015-02-17 15:46:45 +0000526# disable fsio to catch some more missing #include <stdio.h>
Manuel Pégourié-Gonnard757ca002015-03-23 15:24:07 +0100527msg "build: full config except platform/fsio, make, gcc" # ~ 30s
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +0000528cleanup
529cp "$CONFIG_H" "$CONFIG_BAK"
530scripts/config.pl full
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200531scripts/config.pl unset MBEDTLS_PLATFORM_C
532scripts/config.pl unset MBEDTLS_PLATFORM_MEMORY
Manuel Pégourié-Gonnard3d4755b2015-06-03 14:03:17 +0100533scripts/config.pl unset MBEDTLS_PLATFORM_PRINTF_ALT
534scripts/config.pl unset MBEDTLS_PLATFORM_FPRINTF_ALT
535scripts/config.pl unset MBEDTLS_PLATFORM_SNPRINTF_ALT
536scripts/config.pl unset MBEDTLS_PLATFORM_EXIT_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200537scripts/config.pl unset MBEDTLS_MEMORY_BUFFER_ALLOC_C
538scripts/config.pl unset MBEDTLS_FS_IO
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100539make CC=gcc CFLAGS='-Werror -O0'
Manuel Pégourié-Gonnarda71780e2015-02-13 13:56:55 +0000540
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +0100541# catch compile bugs in _uninit functions
542msg "build: full config with NO_STD_FUNCTION, make, gcc" # ~ 30s
543cleanup
544cp "$CONFIG_H" "$CONFIG_BAK"
545scripts/config.pl full
Manuel Pégourié-Gonnard7ee5ddd2015-06-03 10:33:55 +0100546scripts/config.pl set MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100547make CC=gcc CFLAGS='-Werror -O0'
Manuel Pégourié-Gonnarddccb80b2015-06-03 10:20:33 +0100548
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +0200549msg "build: full config except ssl_srv.c, make, gcc" # ~ 30s
550cleanup
551cp "$CONFIG_H" "$CONFIG_BAK"
552scripts/config.pl full
553scripts/config.pl unset MBEDTLS_SSL_SRV_C
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100554make CC=gcc CFLAGS='-Werror -O0'
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +0200555
556msg "build: full config except ssl_cli.c, make, gcc" # ~ 30s
557cleanup
558cp "$CONFIG_H" "$CONFIG_BAK"
559scripts/config.pl full
560scripts/config.pl unset MBEDTLS_SSL_CLI_C
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100561make CC=gcc CFLAGS='-Werror -O0'
Manuel Pégourié-Gonnard66b8e952015-05-20 11:13:56 +0200562
Manuel Pégourié-Gonnardf78e4de2015-05-29 10:52:14 +0200563msg "build: full config except net.c, make, gcc -std=c99 -pedantic" # ~ 30s
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +0200564cleanup
565cp "$CONFIG_H" "$CONFIG_BAK"
566scripts/config.pl full
Manuel Pégourié-Gonnardf78e4de2015-05-29 10:52:14 +0200567scripts/config.pl unset MBEDTLS_NET_C # getaddrinfo() undeclared, etc.
568scripts/config.pl set MBEDTLS_NO_PLATFORM_ENTROPY # uses syscall() on GNU/Linux
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100569make CC=gcc CFLAGS='-Werror -O0 -std=c99 -pedantic' lib
Manuel Pégourié-Gonnard009a2642015-05-29 10:31:13 +0200570
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +0200571if uname -a | grep -F Linux >/dev/null; then
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100572 msg "build/test: make shared" # ~ 40s
573 cleanup
574 make SHARED=1 all check
Manuel Pégourié-Gonnard9b06abe2015-06-25 09:56:07 +0200575fi
576
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000577if uname -a | grep -F x86_64 >/dev/null; then
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100578 msg "build: i386, make, gcc" # ~ 30s
579 cleanup
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100580 make CC=gcc CFLAGS='-Werror -m32'
Andres Amaya Garcia401441b2017-05-08 11:19:19 +0100581
582 msg "test: i386, make, gcc"
583 make test
584
585 msg "build: 64-bit ILP32, make, gcc" # ~ 30s
586 cleanup
587 make CC=gcc CFLAGS='-Werror -Wall -Wextra -mx32'
588
589 msg "test: 64-bit ILP32, make, gcc"
590 make test
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000591fi # x86_64
592
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000593msg "build: arm-none-eabi-gcc, make" # ~ 10s
594cleanup
595cp "$CONFIG_H" "$CONFIG_BAK"
596scripts/config.pl full
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200597scripts/config.pl unset MBEDTLS_NET_C
598scripts/config.pl unset MBEDTLS_TIMING_C
599scripts/config.pl unset MBEDTLS_FS_IO
Simon Butcherd7f19022016-10-14 09:49:48 +0100600scripts/config.pl set MBEDTLS_NO_PLATFORM_ENTROPY
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000601# following things are not in the default config
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602scripts/config.pl unset MBEDTLS_HAVEGE_C # depends on timing.c
603scripts/config.pl unset MBEDTLS_THREADING_PTHREAD
604scripts/config.pl unset MBEDTLS_THREADING_C
605scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # execinfo.h
606scripts/config.pl unset MBEDTLS_MEMORY_BUFFER_ALLOC_C # calls exit
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100607make CC=arm-none-eabi-gcc AR=arm-none-eabi-ar LD=arm-none-eabi-ld CFLAGS=-Werror lib
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000608
Gilles Peskineb9344e32017-12-19 18:24:31 +0100609if [ $RUN_ARMCC -ne 0 ]; then
610 msg "build: armcc, make"
611 cleanup
612 cp "$CONFIG_H" "$CONFIG_BAK"
613 scripts/config.pl full
614 scripts/config.pl unset MBEDTLS_NET_C
615 scripts/config.pl unset MBEDTLS_TIMING_C
616 scripts/config.pl unset MBEDTLS_FS_IO
617 scripts/config.pl unset MBEDTLS_HAVE_TIME
618 scripts/config.pl unset MBEDTLS_HAVE_TIME_DATE
619 scripts/config.pl set MBEDTLS_NO_PLATFORM_ENTROPY
620 # following things are not in the default config
621 scripts/config.pl unset MBEDTLS_DEPRECATED_WARNING
622 scripts/config.pl unset MBEDTLS_HAVEGE_C # depends on timing.c
623 scripts/config.pl unset MBEDTLS_THREADING_PTHREAD
624 scripts/config.pl unset MBEDTLS_THREADING_C
625 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE # execinfo.h
626 scripts/config.pl unset MBEDTLS_MEMORY_BUFFER_ALLOC_C # calls exit
Gilles Peskine37c88db2018-03-21 11:44:52 +0100627 make CC="$ARMC5_CC" AR="$ARMC5_AR" WARNING_CFLAGS= lib
Gilles Peskineb9344e32017-12-19 18:24:31 +0100628fi
Manuel Pégourié-Gonnardc5c59392015-02-10 17:38:54 +0100629
Gilles Peskineb49351d2017-05-12 15:26:58 +0200630msg "build: allow SHA1 in certificates by default"
631cleanup
632cp "$CONFIG_H" "$CONFIG_BAK"
633scripts/config.pl set MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_CERTIFICATES
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100634make CFLAGS='-Werror -Wall -Wextra'
Gilles Peskineb49351d2017-05-12 15:26:58 +0200635msg "test: allow SHA1 in certificates by default"
636make test
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100637if_build_succeeded tests/ssl-opt.sh -f SHA-1
Gilles Peskineb49351d2017-05-12 15:26:58 +0200638
Manuel Pégourié-Gonnard6448bce2015-02-16 17:18:36 +0100639if which i686-w64-mingw32-gcc >/dev/null; then
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100640 msg "build: cross-mingw64, make" # ~ 30s
641 cleanup
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100642 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS=-Werror WINDOWS_BUILD=1
643 make WINDOWS_BUILD=1 clean
644 make CC=i686-w64-mingw32-gcc AR=i686-w64-mingw32-ar LD=i686-w64-minggw32-ld CFLAGS=-Werror WINDOWS_BUILD=1 SHARED=1
645 make WINDOWS_BUILD=1 clean
Manuel Pégourié-Gonnard6448bce2015-02-16 17:18:36 +0100646fi
647
Manuel Pégourié-Gonnardedb2dc92015-02-10 14:36:31 +0000648# MemSan currently only available on Linux 64 bits
649if uname -a | grep 'Linux.*x86_64' >/dev/null; then
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000650
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100651 msg "build: MSan (clang)" # ~ 1 min 20s
652 cleanup
653 cp "$CONFIG_H" "$CONFIG_BAK"
654 scripts/config.pl unset MBEDTLS_AESNI_C # memsan doesn't grok asm
655 CC=clang cmake -D CMAKE_BUILD_TYPE:String=MemSan .
656 make
Manuel Pégourié-Gonnard4a9dc2a2014-05-09 13:46:59 +0200657
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100658 msg "test: main suites (MSan)" # ~ 10s
659 make test
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100660
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100661 msg "test: ssl-opt.sh (MSan)" # ~ 1 min
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100662 if_build_succeeded tests/ssl-opt.sh
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100663
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100664 # Optional part(s)
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100665
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100666 if [ "$MEMORY" -gt 0 ]; then
667 msg "test: compat.sh (MSan)" # ~ 6 min 20s
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100668 if_build_succeeded tests/compat.sh
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100669 fi
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100670
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000671else # no MemSan
672
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100673 msg "build: Release (clang)"
674 cleanup
675 CC=clang cmake -D CMAKE_BUILD_TYPE:String=Release .
676 make
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000677
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100678 msg "test: main suites valgrind (Release)"
679 make memcheck
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000680
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100681 # Optional part(s)
682 # Currently broken, programs don't seem to receive signals
683 # under valgrind on OS X
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000684
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100685 if [ "$MEMORY" -gt 0 ]; then
686 msg "test: ssl-opt.sh --memcheck (Release)"
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100687 if_build_succeeded tests/ssl-opt.sh --memcheck
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100688 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000689
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100690 if [ "$MEMORY" -gt 1 ]; then
691 msg "test: compat.sh --memcheck (Release)"
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100692 if_build_succeeded tests/compat.sh --memcheck
Gilles Peskine30dfbaf2017-12-10 23:22:20 +0100693 fi
Manuel Pégourié-Gonnard392d3dd2015-01-26 14:03:56 +0000694
695fi # MemSan
696
Simon Butcherd7f19022016-10-14 09:49:48 +0100697msg "build: cmake 'out-of-source' build"
698cleanup
699MBEDTLS_ROOT_DIR="$PWD"
700mkdir "$OUT_OF_SOURCE_DIR"
701cd "$OUT_OF_SOURCE_DIR"
702cmake "$MBEDTLS_ROOT_DIR"
703make
704
705msg "test: cmake 'out-of-source' build"
706make test
Gilles Peskineaebcfbb2018-03-21 12:17:20 +0100707# Test an SSL option that requires an auxiliary script in test/scripts/.
708# Also ensure that there are no error messages such as
709# "No such file or directory", which would indicate that some required
710# file is missing (ssl-opt.sh tolerates the absence of some files so
711# may exit with status 0 but emit errors).
712if_build_succeeded ./tests/ssl-opt.sh -f 'Fallback SCSV: beginning of list' 2>ssl-opt.err
713if [ -s ssl-opt.err ]; then
714 cat ssl-opt.err >&2
715 record_status [ ! -s ssl-opt.err ]
716 rm ssl-opt.err
717fi
Simon Butcherd7f19022016-10-14 09:49:48 +0100718cd "$MBEDTLS_ROOT_DIR"
719rm -rf "$OUT_OF_SOURCE_DIR"
Gilles Peskine00de2fd2018-03-21 12:16:57 +0100720unset MBEDTLS_ROOT_DIR
Simon Butcherd7f19022016-10-14 09:49:48 +0100721
Gilles Peskined7602c22017-12-21 15:59:21 +0100722
723
724################################################################
725#### Termination
726################################################################
727
Manuel Pégourié-Gonnard9bda9b32014-11-20 13:10:22 +0100728msg "Done, cleaning up"
Manuel Pégourié-Gonnard80955ee2014-03-19 18:29:01 +0100729cleanup
Gilles Peskinea8bf9862017-12-11 00:01:40 +0100730
731final_report