blob: 182471376a39c9e1a9b370e7aa0e82c89e4d2a80 [file] [log] [blame]
Gilles Peskinef5ea1972019-01-29 08:50:20 +01001#!/usr/bin/env python3
2
Andrzej Kurekffbc8f52022-10-17 08:34:40 -04003# Copyright (c) 2022, Arm Limited, All Rights Reserved.
Gilles Peskinef5ea1972019-01-29 08:50:20 +01004# SPDX-License-Identifier: Apache-2.0
5#
6# Licensed under the Apache License, Version 2.0 (the "License"); you may
7# not use this file except in compliance with the License.
8# You may obtain a copy of the License at
9#
10# http://www.apache.org/licenses/LICENSE-2.0
11#
12# Unless required by applicable law or agreed to in writing, software
13# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15# See the License for the specific language governing permissions and
16# limitations under the License.
17#
18# This file is part of Mbed TLS (https://tls.mbed.org)
19
Gilles Peskinef5ea1972019-01-29 08:50:20 +010020"""
Andrzej Kurek110fc482022-10-09 05:29:44 -040021Test Mbed TLS with a subset of algorithms.
Gilles Peskinef5ea1972019-01-29 08:50:20 +010022
Andrzej Kurek110fc482022-10-09 05:29:44 -040023This script can be divided into several steps:
24
Andrzej Kurek467a0f22022-10-20 06:15:06 -040025First, include/mbedtls/config.h or a different config file passed
Andrzej Kurekcf394062023-02-15 05:42:02 -050026in the arguments is parsed to extract any configuration options (using config.py).
Andrzej Kurek110fc482022-10-09 05:29:44 -040027
28Then, test domains (groups of jobs, tests) are built based on predefined data
29collected in the DomainData class. Here, each domain has five major traits:
Andrzej Kurekffbc8f52022-10-17 08:34:40 -040030- domain name, can be used to run only specific tests via command-line;
Andrzej Kurek110fc482022-10-09 05:29:44 -040031- configuration building method, described in detail below;
32- list of symbols passed to the configuration building method;
33- commands to be run on each job (only build, build and test, or any other custom);
34- optional list of symbols to be excluded from testing.
35
36The configuration building method can be one of the three following:
37
38- ComplementaryDomain - build a job for each passed symbol by disabling a single
39 symbol and its reverse dependencies (defined in REVERSE_DEPENDENCIES);
40
41- ExclusiveDomain - build a job where, for each passed symbol, only this particular
42 one is defined and other symbols from the list are unset. For each job look for
43 any non-standard symbols to set/unset in EXCLUSIVE_GROUPS. These are usually not
44 direct dependencies, but rather non-trivial results of other configs missing. Then
45 look for any unset symbols and handle their reverse dependencies.
Andrzej Kurek110fc482022-10-09 05:29:44 -040046
47- DualDomain - combination of the two above - both complementary and exclusive domain
48 job generation code will be run. Currently only used for hashes.
49
50Lastly, the collected jobs are executed and (optionally) tested, with
51error reporting and coloring as configured in options. Each test starts with
52a full config without a couple of slowing down or unnecessary options
53(see set_reference_config), then the specific job config is derived.
54"""
Gilles Peskinef5ea1972019-01-29 08:50:20 +010055import argparse
56import os
57import re
58import shutil
59import subprocess
60import sys
61import traceback
Andrzej Kurek2432dc22023-01-24 07:40:42 -050062from typing import Union
63
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -050064# Add the Mbed TLS Python library directory to the module search path
Andrzej Kurekcf394062023-02-15 05:42:02 -050065import scripts_path # pylint: disable=unused-import
66import config
67
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -040068class Colors: # pylint: disable=too-few-public-methods
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010069 """Minimalistic support for colored output.
70Each field of an object of this class is either None if colored output
71is not possible or not desired, or a pair of strings (start, stop) such
72that outputting start switches the text color to the desired color and
73stop switches the text color back to the default."""
74 red = None
75 green = None
Andrzej Kurekcf394062023-02-15 05:42:02 -050076 cyan = None
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010077 bold_red = None
78 bold_green = None
79 def __init__(self, options=None):
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -040080 """Initialize color profile according to passed options."""
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010081 if not options or options.color in ['no', 'never']:
82 want_color = False
83 elif options.color in ['yes', 'always']:
84 want_color = True
85 else:
86 want_color = sys.stderr.isatty()
87 if want_color:
88 # Assume ANSI compatible terminal
89 normal = '\033[0m'
90 self.red = ('\033[31m', normal)
91 self.green = ('\033[32m', normal)
Andrzej Kurekcf394062023-02-15 05:42:02 -050092 self.cyan = ('\033[36m', normal)
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010093 self.bold_red = ('\033[1;31m', normal)
94 self.bold_green = ('\033[1;32m', normal)
95NO_COLORS = Colors(None)
96
97def log_line(text, prefix='depends.py:', suffix='', color=None):
Gilles Peskinef5ea1972019-01-29 08:50:20 +010098 """Print a status message."""
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -040099 if color is not None:
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100100 prefix = color[0] + prefix
101 suffix = suffix + color[1]
102 sys.stderr.write(prefix + ' ' + text + suffix + '\n')
Gilles Peskinee6a60db2019-01-29 18:42:55 +0100103 sys.stderr.flush()
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100104
Gilles Peskined43ce2b2019-01-29 18:46:34 +0100105def log_command(cmd):
106 """Print a trace of the specified command.
107cmd is a list of strings: a command name and its arguments."""
108 log_line(' '.join(cmd), prefix='+')
109
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100110def backup_config(options):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400111 """Back up the library configuration file (config.h).
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100112If the backup file already exists, it is presumed to be the desired backup,
113so don't make another backup."""
114 if os.path.exists(options.config_backup):
115 options.own_backup = False
116 else:
117 options.own_backup = True
118 shutil.copy(options.config, options.config_backup)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100119
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100120def restore_config(options):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400121 """Restore the library configuration file (config.h).
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100122Remove the backup file if it was saved earlier."""
123 if options.own_backup:
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100124 shutil.move(options.config_backup, options.config)
125 else:
126 shutil.copy(options.config_backup, options.config)
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100127
Andrzej Kurekcf394062023-02-15 05:42:02 -0500128def option_exists(conf, option):
Andrzej Kurek3ebe7d62023-02-06 10:48:43 +0100129 return option in conf.settings
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100130
Andrzej Kurek2432dc22023-01-24 07:40:42 -0500131def set_config_option_value(conf, option, colors, value: Union[bool, str]):
132 """Set/unset a configuration option, optionally specifying a value.
133value can be either True/False (set/unset config option), or a string,
134which will make a symbol defined with a certain value."""
Andrzej Kurekcf394062023-02-15 05:42:02 -0500135 if not option_exists(conf, option):
136 log_line('Symbol {} was not found in {}'.format(option, conf.filename), color=colors.red)
137 return False
Andrzej Kurekcf394062023-02-15 05:42:02 -0500138
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500139 if value is False:
140 log_command(['config.py', 'unset', option])
141 conf.unset(option)
Andrzej Kurek3e7666b2023-02-06 10:49:46 +0100142 elif value is True:
143 log_command(['config.py', 'set', option])
144 conf.set(option)
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500145 else:
Andrzej Kurek3e7666b2023-02-06 10:49:46 +0100146 log_command(['config.py', 'set', option, value])
147 conf.set(option, value)
Andrzej Kurekcf394062023-02-15 05:42:02 -0500148 return True
149
150def set_reference_config(conf, options, colors):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400151 """Change the library configuration file (config.h) to the reference state.
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400152The reference state is the one from which the tested configurations are
153derived."""
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400154 # Turn off options that are not relevant to the tests and slow them down.
Andrzej Kurekcf394062023-02-15 05:42:02 -0500155 log_command(['config.py', 'full'])
156 conf.adapt(config.full_adapter)
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500157 set_config_option_value(conf, 'MBEDTLS_TEST_HOOKS', colors, False)
Andrzej Kurek2b44a922022-10-24 10:41:20 -0400158 if options.unset_use_psa:
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500159 set_config_option_value(conf, 'MBEDTLS_USE_PSA_CRYPTO', colors, False)
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400160
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100161class Job:
162 """A job builds the library in a specific configuration and runs some tests."""
163 def __init__(self, name, config_settings, commands):
164 """Build a job object.
165The job uses the configuration described by config_settings. This is a
166dictionary where the keys are preprocessor symbols and the values are
167booleans or strings. A boolean indicates whether or not to #define the
168symbol. With a string, the symbol is #define'd to that value.
169After setting the configuration, the job runs the programs specified by
170commands. This is a list of lists of strings; each list of string is a
171command name and its arguments and is passed to subprocess.call with
172shell=False."""
173 self.name = name
174 self.config_settings = config_settings
175 self.commands = commands
176
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100177 def announce(self, colors, what):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100178 '''Announce the start or completion of a job.
179If what is None, announce the start of the job.
180If what is True, announce that the job has passed.
181If what is False, announce that the job has failed.'''
182 if what is True:
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100183 log_line(self.name + ' PASSED', color=colors.green)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100184 elif what is False:
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100185 log_line(self.name + ' FAILED', color=colors.red)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100186 else:
Andrzej Kurekcf394062023-02-15 05:42:02 -0500187 log_line('starting ' + self.name, color=colors.cyan)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100188
Andrzej Kurekcf394062023-02-15 05:42:02 -0500189 def configure(self, conf, options, colors):
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400190 '''Set library configuration options as required for the job.'''
Andrzej Kurekcf394062023-02-15 05:42:02 -0500191 set_reference_config(conf, options, colors)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100192 for key, value in sorted(self.config_settings.items()):
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500193 ret = set_config_option_value(conf, key, colors, value)
Andrzej Kurekcf394062023-02-15 05:42:02 -0500194 if ret is False:
195 return False
196 return True
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100197
198 def test(self, options):
199 '''Run the job's build and test commands.
200Return True if all the commands succeed and False otherwise.
201If options.keep_going is false, stop as soon as one command fails. Otherwise
202run all the commands, except that if the first command fails, none of the
203other commands are run (typically, the first command is a build command
204and subsequent commands are tests that cannot run if the build failed).'''
205 built = False
206 success = True
207 for command in self.commands:
Gilles Peskined43ce2b2019-01-29 18:46:34 +0100208 log_command(command)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100209 ret = subprocess.call(command)
210 if ret != 0:
211 if command[0] not in ['make', options.make_command]:
212 log_line('*** [{}] Error {}'.format(' '.join(command), ret))
213 if not options.keep_going or not built:
214 return False
215 success = False
216 built = True
217 return success
218
219# SSL/TLS versions up to 1.1 and corresponding options. These require
220# both MD5 and SHA-1.
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400221SSL_PRE_1_2_DEPENDENCIES = ['MBEDTLS_SSL_CBC_RECORD_SPLITTING',
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100222 'MBEDTLS_SSL_PROTO_SSL3',
223 'MBEDTLS_SSL_PROTO_TLS1',
224 'MBEDTLS_SSL_PROTO_TLS1_1']
225
226# If the configuration option A requires B, make sure that
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400227# B in REVERSE_DEPENDENCIES[A].
Gilles Peskineb81f4062019-01-29 19:30:40 +0100228# All the information here should be contained in check_config.h. This
229# file includes a copy because it changes rarely and it would be a pain
230# to extract automatically.
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400231REVERSE_DEPENDENCIES = {
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100232 'MBEDTLS_AES_C': ['MBEDTLS_CTR_DRBG_C',
Andrzej Kurek90686252022-09-28 03:17:56 -0400233 'MBEDTLS_NIST_KW_C'],
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100234 'MBEDTLS_CHACHA20_C': ['MBEDTLS_CHACHAPOLY_C'],
Andrzej Kurek90686252022-09-28 03:17:56 -0400235 'MBEDTLS_ECDSA_C': ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
236 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'],
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100237 'MBEDTLS_ECP_C': ['MBEDTLS_ECDSA_C',
238 'MBEDTLS_ECDH_C',
239 'MBEDTLS_ECJPAKE_C',
Manuel Pégourié-Gonnard3dc7f232022-12-06 13:20:06 +0100240 'MBEDTLS_ECP_RESTARTABLE',
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100241 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
242 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED',
243 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED',
244 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
Andrzej Kurek90686252022-09-28 03:17:56 -0400245 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
246 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Gilles Peskineb81f4062019-01-29 19:30:40 +0100247 'MBEDTLS_ECP_DP_SECP256R1_ENABLED': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400248 'MBEDTLS_MD5_C': SSL_PRE_1_2_DEPENDENCIES,
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100249 'MBEDTLS_PKCS1_V21': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
250 'MBEDTLS_PKCS1_V15': ['MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
251 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
252 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
253 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'],
254 'MBEDTLS_RSA_C': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT',
255 'MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
256 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
257 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
Andrzej Kurek90686252022-09-28 03:17:56 -0400258 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED',
259 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED'],
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400260 'MBEDTLS_SHA1_C': SSL_PRE_1_2_DEPENDENCIES,
Gilles Peskineb81f4062019-01-29 19:30:40 +0100261 'MBEDTLS_SHA256_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
Andrzej Kurek90686252022-09-28 03:17:56 -0400262 'MBEDTLS_ENTROPY_FORCE_SHA256',
Andrzej Kurek90686252022-09-28 03:17:56 -0400263 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kurek0325ced2022-10-18 09:37:59 -0400264 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY'],
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400265 'MBEDTLS_SHA512_C': ['MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kurek90686252022-09-28 03:17:56 -0400266 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY'],
Andrzej Kurek90686252022-09-28 03:17:56 -0400267 'MBEDTLS_X509_RSASSA_PSS_SUPPORT': []
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100268}
269
Andrzej Kurek90686252022-09-28 03:17:56 -0400270# If an option is tested in an exclusive test, alter the following defines.
Andrzej Kurek110fc482022-10-09 05:29:44 -0400271# These are not necessarily dependencies, but just minimal required changes
Andrzej Kurek90686252022-09-28 03:17:56 -0400272# if a given define is the only one enabled from an exclusive group.
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400273EXCLUSIVE_GROUPS = {
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400274 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL'],
Andrzej Kurekf53d0ba2022-11-23 05:54:46 -0500275 'MBEDTLS_SHA512_NO_SHA384': ['+MBEDTLS_SHA512_C',
276 '-MBEDTLS_SSL_PROTO_TLS1_2',
277 '-MBEDTLS_SSL_PROTO_DTLS',
278 '-MBEDTLS_SSL_TLS_C',
279 '-MBEDTLS_SSL_CLI_C',
280 '-MBEDTLS_SSL_SRV_C',
281 '-MBEDTLS_SSL_DTLS_HELLO_VERIFY',
282 '-MBEDTLS_SSL_DTLS_ANTI_REPLAY',
283 '-MBEDTLS_SSL_DTLS_CONNECTION_ID',
284 '-MBEDTLS_SSL_DTLS_BADMAC_LIMIT',
285 '-MBEDTLS_SSL_ENCRYPT_THEN_MAC',
286 '-MBEDTLS_SSL_EXTENDED_MASTER_SECRET',
287 '-MBEDTLS_SSL_DTLS_SRTP',
288 '-MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE'],
Andrzej Kurek9cbdf102022-10-14 08:09:16 -0400289 'MBEDTLS_ECP_DP_CURVE448_ENABLED': ['-MBEDTLS_ECDSA_C',
290 '-MBEDTLS_ECDSA_DETERMINISTIC',
291 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
292 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
293 '-MBEDTLS_ECJPAKE_C',
294 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
295 'MBEDTLS_ECP_DP_CURVE25519_ENABLED': ['-MBEDTLS_ECDSA_C',
296 '-MBEDTLS_ECDSA_DETERMINISTIC',
297 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
298 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
299 '-MBEDTLS_ECJPAKE_C',
300 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
301 'MBEDTLS_ARIA_C': ['-MBEDTLS_CMAC_C'],
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400302 'MBEDTLS_ARC4_C': ['-MBEDTLS_CMAC_C',
303 '-MBEDTLS_CCM_C',
304 '-MBEDTLS_SSL_TICKET_C',
305 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION',
306 '-MBEDTLS_GCM_C'],
307 'MBEDTLS_BLOWFISH_C': ['-MBEDTLS_CMAC_C',
308 '-MBEDTLS_CCM_C',
309 '-MBEDTLS_SSL_TICKET_C',
310 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION',
311 '-MBEDTLS_GCM_C'],
Andrzej Kurek9cbdf102022-10-14 08:09:16 -0400312 'MBEDTLS_CAMELLIA_C': ['-MBEDTLS_CMAC_C'],
313 'MBEDTLS_CHACHA20_C': ['-MBEDTLS_CMAC_C', '-MBEDTLS_CCM_C', '-MBEDTLS_GCM_C'],
314 'MBEDTLS_DES_C': ['-MBEDTLS_CCM_C',
315 '-MBEDTLS_GCM_C',
316 '-MBEDTLS_SSL_TICKET_C',
317 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION'],
Andrzej Kurek90686252022-09-28 03:17:56 -0400318}
319def handle_exclusive_groups(config_settings, symbol):
320 """For every symbol tested in an exclusive group check if there are other
321defines to be altered. """
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400322 for dep in EXCLUSIVE_GROUPS.get(symbol, []):
Andrzej Kurek9cbdf102022-10-14 08:09:16 -0400323 unset = dep.startswith('-')
324 dep = dep[1:]
Andrzej Kurek90686252022-09-28 03:17:56 -0400325 config_settings[dep] = not unset
326
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100327def turn_off_dependencies(config_settings):
328 """For every option turned off config_settings, also turn off what depends on it.
329An option O is turned off if config_settings[O] is False."""
330 for key, value in sorted(config_settings.items()):
331 if value is not False:
332 continue
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400333 for dep in REVERSE_DEPENDENCIES.get(key, []):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100334 config_settings[dep] = False
335
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400336class BaseDomain: # pylint: disable=too-few-public-methods, unused-argument
337 """A base class for all domains."""
338 def __init__(self, symbols, commands, exclude):
339 """Initialize the jobs container"""
340 self.jobs = []
341
342class ExclusiveDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100343 """A domain consisting of a set of conceptually-equivalent settings.
344Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurek2e105b52022-10-06 16:57:38 -0400345with this symbol set and the others unset."""
Gilles Peskine3dd0dab2019-01-29 18:56:03 +0100346 def __init__(self, symbols, commands, exclude=None):
347 """Build a domain for the specified list of configuration symbols.
Andrzej Kurek2e105b52022-10-06 16:57:38 -0400348The domain contains a set of jobs that enable one of the elements
349of symbols and disable the others.
Gilles Peskine3dd0dab2019-01-29 18:56:03 +0100350Each job runs the specified commands.
351If exclude is a regular expression, skip generated jobs whose description
352would match this regular expression."""
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400353 super().__init__(symbols, commands, exclude)
Andrzej Kurek2e105b52022-10-06 16:57:38 -0400354 base_config_settings = {}
355 for symbol in symbols:
356 base_config_settings[symbol] = False
357 for symbol in symbols:
358 description = symbol
359 if exclude and re.match(exclude, description):
360 continue
361 config_settings = base_config_settings.copy()
362 config_settings[symbol] = True
363 handle_exclusive_groups(config_settings, symbol)
364 turn_off_dependencies(config_settings)
365 job = Job(description, config_settings, commands)
366 self.jobs.append(job)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100367
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400368class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100369 """A domain consisting of a set of loosely-related settings.
370Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400371with this symbol unset.
372If exclude is a regular expression, skip generated jobs whose description
373would match this regular expression."""
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400374 def __init__(self, symbols, commands, exclude=None):
Gilles Peskine3dd0dab2019-01-29 18:56:03 +0100375 """Build a domain for the specified list of configuration symbols.
376Each job in the domain disables one of the specified symbols.
377Each job runs the specified commands."""
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400378 super().__init__(symbols, commands, exclude)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100379 for symbol in symbols:
380 description = '!' + symbol
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400381 if exclude and re.match(exclude, description):
382 continue
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100383 config_settings = {symbol: False}
384 turn_off_dependencies(config_settings)
385 job = Job(description, config_settings, commands)
386 self.jobs.append(job)
387
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400388class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400389 """A domain that contains both the ExclusiveDomain and BaseDomain tests.
Andrzej Kurek0325ced2022-10-18 09:37:59 -0400390Both parent class __init__ calls are performed in any order and
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400391each call adds respective jobs. The job array initialization is done once in
392BaseDomain, before the parent __init__ calls."""
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400393
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400394class CipherInfo: # pylint: disable=too-few-public-methods
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100395 """Collect data about cipher.h."""
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400396 def __init__(self):
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100397 self.base_symbols = set()
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400398 with open('include/mbedtls/cipher.h', encoding="utf-8") as fh:
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100399 for line in fh:
400 m = re.match(r' *MBEDTLS_CIPHER_ID_(\w+),', line)
401 if m and m.group(1) not in ['NONE', 'NULL', '3DES']:
402 self.base_symbols.add('MBEDTLS_' + m.group(1) + '_C')
403
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100404class DomainData:
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400405 """A container for domains and jobs, used to structurize testing."""
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100406 def config_symbols_matching(self, regexp):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400407 """List the config.h settings matching regexp."""
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100408 return [symbol for symbol in self.all_config_symbols
409 if re.match(regexp, symbol)]
410
Andrzej Kurekcf394062023-02-15 05:42:02 -0500411 def __init__(self, options, conf):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100412 """Gather data about the library and establish a list of domains to test."""
413 build_command = [options.make_command, 'CFLAGS=-Werror']
414 build_and_test = [build_command, [options.make_command, 'test']]
Andrzej Kurekcf394062023-02-15 05:42:02 -0500415 self.all_config_symbols = set(conf.settings.keys())
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100416 # Find hash modules by name.
417 hash_symbols = self.config_symbols_matching(r'MBEDTLS_(MD|RIPEMD|SHA)[0-9]+_C\Z')
Andrzej Kurekaa112812022-11-22 08:13:45 -0500418 hash_symbols.append("MBEDTLS_SHA512_NO_SHA384")
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100419 # Find elliptic curve enabling macros by name.
420 curve_symbols = self.config_symbols_matching(r'MBEDTLS_ECP_DP_\w+_ENABLED\Z')
421 # Find key exchange enabling macros by name.
422 key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z')
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100423 # Find cipher IDs (block permutations and stream ciphers --- chaining
424 # and padding modes are exercised separately) information by parsing
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400425 # cipher.h, as the information is not readily available in config.h.
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400426 cipher_info = CipherInfo()
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100427 # Find block cipher chaining and padding mode enabling macros by name.
428 cipher_chaining_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_MODE_\w+\Z')
429 cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z')
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100430 self.domains = {
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100431 # Cipher IDs, chaining modes and padding modes. Run the test suites.
432 'cipher_id': ExclusiveDomain(cipher_info.base_symbols,
433 build_and_test),
434 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols,
435 build_and_test),
436 'cipher_padding': ExclusiveDomain(cipher_padding_symbols,
437 build_and_test),
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100438 # Elliptic curves. Run the test suites.
439 'curves': ExclusiveDomain(curve_symbols, build_and_test),
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400440 # Hash algorithms. Exclude exclusive domain of MD, RIPEMD, SHA1 (obsolete)
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400441 'hashes': DualDomain(hash_symbols, build_and_test,
Andrzej Kurekaa112812022-11-22 08:13:45 -0500442 exclude=r'MBEDTLS_(MD|RIPEMD|SHA1_)'\
443 '|!MBEDTLS_*_NO_SHA'),
Andrzej Kurekddf62602023-01-23 06:19:14 -0500444 # Key exchange types.
Andrzej Kurekde416fc2022-11-02 04:50:16 -0400445 'kex': ExclusiveDomain(key_exchange_symbols, build_and_test),
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100446 'pkalgs': ComplementaryDomain(['MBEDTLS_ECDSA_C',
447 'MBEDTLS_ECP_C',
448 'MBEDTLS_PKCS1_V21',
449 'MBEDTLS_PKCS1_V15',
450 'MBEDTLS_RSA_C',
451 'MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
452 build_and_test),
453 }
454 self.jobs = {}
455 for domain in self.domains.values():
456 for job in domain.jobs:
457 self.jobs[job.name] = job
458
459 def get_jobs(self, name):
460 """Return the list of jobs identified by the given name.
461A name can either be the name of a domain or the name of one specific job."""
462 if name in self.domains:
463 return sorted(self.domains[name].jobs, key=lambda job: job.name)
464 else:
465 return [self.jobs[name]]
466
Andrzej Kurekcf394062023-02-15 05:42:02 -0500467def run(options, job, conf, colors=NO_COLORS):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100468 """Run the specified job (a Job instance)."""
469 subprocess.check_call([options.make_command, 'clean'])
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100470 job.announce(colors, None)
Andrzej Kurekcf394062023-02-15 05:42:02 -0500471 if not job.configure(conf, options, colors):
472 job.announce(colors, False)
473 return False
474 conf.write()
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100475 success = job.test(options)
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100476 job.announce(colors, success)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100477 return success
478
Andrzej Kurekcf394062023-02-15 05:42:02 -0500479def run_tests(options, domain_data, conf):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100480 """Run the desired jobs.
481domain_data should be a DomainData instance that describes the available
482domains and jobs.
Andrzej Kurek113952d2022-10-17 08:39:09 -0400483Run the jobs listed in options.tasks."""
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100484 if not hasattr(options, 'config_backup'):
485 options.config_backup = options.config + '.bak'
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100486 colors = Colors(options)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100487 jobs = []
488 failures = []
489 successes = []
Andrzej Kurek113952d2022-10-17 08:39:09 -0400490 for name in options.tasks:
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100491 jobs += domain_data.get_jobs(name)
492 backup_config(options)
493 try:
494 for job in jobs:
Andrzej Kurekcf394062023-02-15 05:42:02 -0500495 success = run(options, job, conf, colors=colors)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100496 if not success:
497 if options.keep_going:
498 failures.append(job.name)
499 else:
500 return False
501 else:
502 successes.append(job.name)
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100503 restore_config(options)
504 except:
505 # Restore the configuration, except in stop-on-error mode if there
506 # was an error, where we leave the failing configuration up for
507 # developer convenience.
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100508 if options.keep_going:
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100509 restore_config(options)
510 raise
Gilles Peskinedc68f612019-01-29 18:50:03 +0100511 if successes:
512 log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100513 if failures:
Gilles Peskinedc68f612019-01-29 18:50:03 +0100514 log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100515 return False
516 else:
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100517 return True
518
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400519def main():
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100520 try:
Andrzej Kurek110fc482022-10-09 05:29:44 -0400521 parser = argparse.ArgumentParser(
522 formatter_class=argparse.RawDescriptionHelpFormatter,
523 description=
524 "Test Mbed TLS with a subset of algorithms.\n\n"
525 "Example usage:\n"
Andrzej Kurekffbc8f52022-10-17 08:34:40 -0400526 r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA256_C""\n"
Andrzej Kurek110fc482022-10-09 05:29:44 -0400527 "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n"
528 "./tests/scripts/depends.py cipher_id cipher_chaining\n")
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100529 parser.add_argument('--color', metavar='WHEN',
530 help='Colorize the output (always/auto/never)',
531 choices=['always', 'auto', 'never'], default='auto')
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100532 parser.add_argument('-c', '--config', metavar='FILE',
533 help='Configuration file to modify',
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400534 default='include/mbedtls/config.h')
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100535 parser.add_argument('-C', '--directory', metavar='DIR',
536 help='Change to this directory before anything else',
537 default='.')
538 parser.add_argument('-k', '--keep-going',
539 help='Try all configurations even if some fail (default)',
540 action='store_true', dest='keep_going', default=True)
541 parser.add_argument('-e', '--no-keep-going',
542 help='Stop as soon as a configuration fails',
543 action='store_false', dest='keep_going')
544 parser.add_argument('--list-jobs',
545 help='List supported jobs and exit',
546 action='append_const', dest='list', const='jobs')
547 parser.add_argument('--list-domains',
548 help='List supported domains and exit',
549 action='append_const', dest='list', const='domains')
550 parser.add_argument('--make-command', metavar='CMD',
551 help='Command to run instead of make (e.g. gmake)',
552 action='store', default='make')
Andrzej Kurek2b44a922022-10-24 10:41:20 -0400553 parser.add_argument('--unset-use-psa',
554 help='Unset MBEDTLS_USE_PSA_CRYPTO before any test',
555 action='store_true', dest='unset_use_psa')
Andrzej Kurek113952d2022-10-17 08:39:09 -0400556 parser.add_argument('tasks', metavar='TASKS', nargs='*',
557 help='The domain(s) or job(s) to test (default: all).',
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100558 default=True)
559 options = parser.parse_args()
560 os.chdir(options.directory)
Andrzej Kurekcf394062023-02-15 05:42:02 -0500561 conf = config.ConfigFile(options.config)
562 domain_data = DomainData(options, conf)
563
Andrzej Kurek113952d2022-10-17 08:39:09 -0400564 if options.tasks is True:
565 options.tasks = sorted(domain_data.domains.keys())
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100566 if options.list:
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400567 for arg in options.list:
568 for domain_name in sorted(getattr(domain_data, arg).keys()):
569 print(domain_name)
570 sys.exit(0)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100571 else:
Andrzej Kurekcf394062023-02-15 05:42:02 -0500572 sys.exit(0 if run_tests(options, domain_data, conf) else 1)
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400573 except Exception: # pylint: disable=broad-except
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100574 traceback.print_exc()
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400575 sys.exit(3)
576
577if __name__ == '__main__':
578 main()