blob: e1c8c13e241e20ee4e063a90b19ea8f28b2c9948 [file] [log] [blame]
Gilles Peskineb39e3ec2019-01-29 08:50:20 +01001#!/usr/bin/env python3
2
3# Copyright (c) 2018, Arm Limited, All Rights Reserved.
4# 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 Peskineb39e3ec2019-01-29 08:50:20 +010020"""
Andrzej Kurek01af84a2022-10-09 05:29:44 -040021Test Mbed TLS with a subset of algorithms.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010022
Andrzej Kurek01af84a2022-10-09 05:29:44 -040023This script can be divided into several steps:
24
25First, include/mbedtls/mbedtls_config.h or a different config file passed
26in the arguments is parsed to extract any configuration options (collect_config_symbols).
27
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:
30- domain name, can be used to run only specific tests via commandline;
31- 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.
46 Examples of EXCLUSIVE_GROUPS usage:
47 - MBEDTLS_SHA224 job turns off all hashes except SHA224, however, when investigating
48 reverse dependencies, SHA256 is found to depend on SHA224, so it is disabled,
49 and then SHA224 is found to depend on SHA256, so it is also disabled. To handle
50 this, there's a field in EXCLUSIVE_GROUPS that states that in a SHA224 test SHA256
51 should also be enabled before processing reverse dependencies:
52 'MBEDTLS_SHA224_C': ['MBEDTLS_SHA256_C']
53 - MBEDTLS_SHA512_C job turns off all hashes except SHA512. MBEDTLS_SSL_COOKIE_C
54 requires either SHA256 or SHA384 to work, so it also has to be disabled.
55 This is not a dependency on SHA512_C, but a result of an exclusive domain
56 config building method. Relevant field:
57 'MBEDTLS_SHA512_C': ['!MBEDTLS_SSL_COOKIE_C'],
58
59- DualDomain - combination of the two above - both complementary and exclusive domain
60 job generation code will be run. Currently only used for hashes.
61
62Lastly, the collected jobs are executed and (optionally) tested, with
63error reporting and coloring as configured in options. Each test starts with
64a full config without a couple of slowing down or unnecessary options
65(see set_reference_config), then the specific job config is derived.
66"""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010067import argparse
68import os
69import re
70import shutil
71import subprocess
72import sys
73import traceback
74
Andrzej Kurek3322c222022-10-04 15:02:41 -040075class Colors: # pylint: disable=too-few-public-methods
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010076 """Minimalistic support for colored output.
77Each field of an object of this class is either None if colored output
78is not possible or not desired, or a pair of strings (start, stop) such
79that outputting start switches the text color to the desired color and
80stop switches the text color back to the default."""
81 red = None
82 green = None
83 bold_red = None
84 bold_green = None
85 def __init__(self, options=None):
Andrzej Kurek3322c222022-10-04 15:02:41 -040086 """Initialize color profile according to passed options."""
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010087 if not options or options.color in ['no', 'never']:
88 want_color = False
89 elif options.color in ['yes', 'always']:
90 want_color = True
91 else:
92 want_color = sys.stderr.isatty()
93 if want_color:
94 # Assume ANSI compatible terminal
95 normal = '\033[0m'
96 self.red = ('\033[31m', normal)
97 self.green = ('\033[32m', normal)
98 self.bold_red = ('\033[1;31m', normal)
99 self.bold_green = ('\033[1;32m', normal)
100NO_COLORS = Colors(None)
101
102def log_line(text, prefix='depends.py:', suffix='', color=None):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100103 """Print a status message."""
Andrzej Kurek3322c222022-10-04 15:02:41 -0400104 if color is not None:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100105 prefix = color[0] + prefix
106 suffix = suffix + color[1]
107 sys.stderr.write(prefix + ' ' + text + suffix + '\n')
Gilles Peskine46c82562019-01-29 18:42:55 +0100108 sys.stderr.flush()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100109
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100110def log_command(cmd):
111 """Print a trace of the specified command.
112cmd is a list of strings: a command name and its arguments."""
113 log_line(' '.join(cmd), prefix='+')
114
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100115def backup_config(options):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400116 """Back up the library configuration file (mbedtls_config.h).
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100117If the backup file already exists, it is presumed to be the desired backup,
118so don't make another backup."""
119 if os.path.exists(options.config_backup):
120 options.own_backup = False
121 else:
122 options.own_backup = True
123 shutil.copy(options.config, options.config_backup)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100124
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100125def restore_config(options):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400126 """Restore the library configuration file (mbedtls_config.h).
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100127Remove the backup file if it was saved earlier."""
128 if options.own_backup:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100129 shutil.move(options.config_backup, options.config)
130 else:
131 shutil.copy(options.config_backup, options.config)
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100132
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100133def run_config_pl(options, args):
Andrzej Kurek3322c222022-10-04 15:02:41 -0400134 """Run scripts/config.py with the specified arguments."""
135 cmd = ['scripts/config.py']
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400136 if options.config != 'include/mbedtls/mbedtls_config.h':
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100137 cmd += ['--file', options.config]
138 cmd += args
139 log_command(cmd)
140 subprocess.check_call(cmd)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100141
Andrzej Kurek3322c222022-10-04 15:02:41 -0400142def set_reference_config(options):
143 """Change the library configuration file (mbedtls_config.h) to the reference state.
144The reference state is the one from which the tested configurations are
145derived."""
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400146 # Turn off options that are not relevant to the tests and slow them down.
Andrzej Kurek3322c222022-10-04 15:02:41 -0400147 run_config_pl(options, ['full'])
148 run_config_pl(options, ['unset', 'MBEDTLS_MEMORY_BACKTRACE'])
149 run_config_pl(options, ['unset', 'MBEDTLS_MEMORY_BUFFER_ALLOC_C'])
150 run_config_pl(options, ['unset', 'MBEDTLS_MEMORY_DEBUG'])
Andrzej Kurek2f8ac282022-10-07 16:07:58 -0400151 run_config_pl(options, ['unset', 'MBEDTLS_TEST_HOOKS'])
Andrzej Kurek3322c222022-10-04 15:02:41 -0400152
153def collect_config_symbols(options):
154 """Read the list of settings from mbedtls_config.h.
155Return them in a generator."""
156 with open(options.config, encoding="utf-8") as config_file:
157 rx = re.compile(r'\s*(?://\s*)?#define\s+(\w+)\s*(?:$|/[/*])')
158 for line in config_file:
159 m = re.match(rx, line)
160 if m:
161 yield m.group(1)
162
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100163class Job:
164 """A job builds the library in a specific configuration and runs some tests."""
165 def __init__(self, name, config_settings, commands):
166 """Build a job object.
167The job uses the configuration described by config_settings. This is a
168dictionary where the keys are preprocessor symbols and the values are
169booleans or strings. A boolean indicates whether or not to #define the
170symbol. With a string, the symbol is #define'd to that value.
171After setting the configuration, the job runs the programs specified by
172commands. This is a list of lists of strings; each list of string is a
173command name and its arguments and is passed to subprocess.call with
174shell=False."""
175 self.name = name
176 self.config_settings = config_settings
177 self.commands = commands
178
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100179 def announce(self, colors, what):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100180 '''Announce the start or completion of a job.
181If what is None, announce the start of the job.
182If what is True, announce that the job has passed.
183If what is False, announce that the job has failed.'''
184 if what is True:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100185 log_line(self.name + ' PASSED', color=colors.green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100186 elif what is False:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100187 log_line(self.name + ' FAILED', color=colors.red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100188 else:
189 log_line('starting ' + self.name)
190
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100191 def configure(self, options):
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400192 '''Set library configuration options as required for the job.'''
Andrzej Kurek3322c222022-10-04 15:02:41 -0400193 set_reference_config(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100194 for key, value in sorted(self.config_settings.items()):
195 if value is True:
196 args = ['set', key]
197 elif value is False:
198 args = ['unset', key]
199 else:
200 args = ['set', key, value]
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100201 run_config_pl(options, args)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100202
203 def test(self, options):
204 '''Run the job's build and test commands.
205Return True if all the commands succeed and False otherwise.
206If options.keep_going is false, stop as soon as one command fails. Otherwise
207run all the commands, except that if the first command fails, none of the
208other commands are run (typically, the first command is a build command
209and subsequent commands are tests that cannot run if the build failed).'''
210 built = False
211 success = True
212 for command in self.commands:
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100213 log_command(command)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100214 ret = subprocess.call(command)
215 if ret != 0:
216 if command[0] not in ['make', options.make_command]:
217 log_line('*** [{}] Error {}'.format(' '.join(command), ret))
218 if not options.keep_going or not built:
219 return False
220 success = False
221 built = True
222 return success
223
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100224# If the configuration option A requires B, make sure that
Andrzej Kurek202932f2022-10-04 16:22:22 -0400225# B in REVERSE_DEPENDENCIES[A].
Gilles Peskine584c24a2019-01-29 19:30:40 +0100226# All the information here should be contained in check_config.h. This
227# file includes a copy because it changes rarely and it would be a pain
228# to extract automatically.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400229REVERSE_DEPENDENCIES = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100230 'MBEDTLS_AES_C': ['MBEDTLS_CTR_DRBG_C',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400231 'MBEDTLS_NIST_KW_C'],
Gilles Peskine34a15572019-01-29 23:12:28 +0100232 'MBEDTLS_CHACHA20_C': ['MBEDTLS_CHACHAPOLY_C'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400233 'MBEDTLS_ECDSA_C': ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
234 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100235 'MBEDTLS_ECP_C': ['MBEDTLS_ECDSA_C',
236 'MBEDTLS_ECDH_C',
237 'MBEDTLS_ECJPAKE_C',
238 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
239 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED',
240 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED',
241 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400242 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
243 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100244 'MBEDTLS_ECP_DP_SECP256R1_ENABLED': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100245 'MBEDTLS_PKCS1_V21': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
246 'MBEDTLS_PKCS1_V15': ['MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
247 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
248 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
249 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'],
250 'MBEDTLS_RSA_C': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT',
251 'MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
252 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
253 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400254 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED',
255 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100256 'MBEDTLS_SHA256_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400257 'MBEDTLS_ENTROPY_FORCE_SHA256',
258 'MBEDTLS_SHA224_C',
259 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kurekf4b18672022-10-14 07:57:00 -0400260 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400261 'MBEDTLS_SHA512_C': ['MBEDTLS_SHA384_C',
262 'MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT',
263 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY'],
264 'MBEDTLS_SHA224_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
265 'MBEDTLS_ENTROPY_FORCE_SHA256',
266 'MBEDTLS_SHA256_C',
267 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
268 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400269 'MBEDTLS_X509_RSASSA_PSS_SUPPORT': []
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100270}
271
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400272# If an option is tested in an exclusive test, alter the following defines.
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400273# These are not necessarily dependencies, but just minimal required changes
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400274# if a given define is the only one enabled from an exclusive group.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400275EXCLUSIVE_GROUPS = {
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400276 'MBEDTLS_SHA256_C': ['MBEDTLS_SHA224_C'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400277 'MBEDTLS_SHA384_C': ['MBEDTLS_SHA512_C'],
Andrzej Kurekf4b18672022-10-14 07:57:00 -0400278 'MBEDTLS_SHA512_C': ['!MBEDTLS_SSL_COOKIE_C', '!MBEDTLS_SSL_PROTO_TLS1_3'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400279 'MBEDTLS_ECP_DP_CURVE448_ENABLED': ['!MBEDTLS_ECDSA_C',
Andrzej Kurek0e8b2d72022-10-04 11:14:59 -0400280 '!MBEDTLS_ECDSA_DETERMINISTIC',
281 '!MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
282 '!MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
283 '!MBEDTLS_ECJPAKE_C',
284 '!MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400285 'MBEDTLS_ECP_DP_CURVE25519_ENABLED': ['!MBEDTLS_ECDSA_C',
Andrzej Kurek0e8b2d72022-10-04 11:14:59 -0400286 '!MBEDTLS_ECDSA_DETERMINISTIC',
287 '!MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
288 '!MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
289 '!MBEDTLS_ECJPAKE_C',
290 '!MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400291 'MBEDTLS_ARIA_C': ['!MBEDTLS_CMAC_C'],
292 'MBEDTLS_CAMELLIA_C': ['!MBEDTLS_CMAC_C'],
293 'MBEDTLS_CHACHA20_C': ['!MBEDTLS_CMAC_C', '!MBEDTLS_CCM_C', '!MBEDTLS_GCM_C'],
Andrzej Kureke5535e32022-10-13 09:07:47 -0400294 'MBEDTLS_DES_C': ['!MBEDTLS_CCM_C', '!MBEDTLS_GCM_C', '!MBEDTLS_SSL_TICKET_C',
295 '!MBEDTLS_SSL_CONTEXT_SERIALIZATION'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400296}
297def handle_exclusive_groups(config_settings, symbol):
298 """For every symbol tested in an exclusive group check if there are other
299defines to be altered. """
Andrzej Kurek202932f2022-10-04 16:22:22 -0400300 for dep in EXCLUSIVE_GROUPS.get(symbol, []):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400301 unset = dep.startswith('!')
302 if unset:
Andrzej Kurek0e8b2d72022-10-04 11:14:59 -0400303 dep = dep[1:]
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400304 config_settings[dep] = not unset
305
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100306def turn_off_dependencies(config_settings):
307 """For every option turned off config_settings, also turn off what depends on it.
308An option O is turned off if config_settings[O] is False."""
309 for key, value in sorted(config_settings.items()):
310 if value is not False:
311 continue
Andrzej Kurek202932f2022-10-04 16:22:22 -0400312 for dep in REVERSE_DEPENDENCIES.get(key, []):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100313 config_settings[dep] = False
314
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400315class BaseDomain: # pylint: disable=too-few-public-methods, unused-argument
316 """A base class for all domains."""
317 def __init__(self, symbols, commands, exclude):
318 """Initialize the jobs container"""
319 self.jobs = []
320
321class ExclusiveDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100322 """A domain consisting of a set of conceptually-equivalent settings.
323Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurekfe469492022-10-06 16:57:38 -0400324with this symbol set and the others unset."""
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100325 def __init__(self, symbols, commands, exclude=None):
326 """Build a domain for the specified list of configuration symbols.
Andrzej Kurekfe469492022-10-06 16:57:38 -0400327The domain contains a set of jobs that enable one of the elements
328of symbols and disable the others.
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100329Each job runs the specified commands.
330If exclude is a regular expression, skip generated jobs whose description
331would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400332 super().__init__(symbols, commands, exclude)
Andrzej Kurekfe469492022-10-06 16:57:38 -0400333 base_config_settings = {}
334 for symbol in symbols:
335 base_config_settings[symbol] = False
336 for symbol in symbols:
337 description = symbol
338 if exclude and re.match(exclude, description):
339 continue
340 config_settings = base_config_settings.copy()
341 config_settings[symbol] = True
342 handle_exclusive_groups(config_settings, symbol)
343 turn_off_dependencies(config_settings)
344 job = Job(description, config_settings, commands)
345 self.jobs.append(job)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100346
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400347class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100348 """A domain consisting of a set of loosely-related settings.
349Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400350with this symbol unset.
351If exclude is a regular expression, skip generated jobs whose description
352would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400353 def __init__(self, symbols, commands, exclude=None):
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100354 """Build a domain for the specified list of configuration symbols.
355Each job in the domain disables one of the specified symbols.
356Each job runs the specified commands."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400357 super().__init__(symbols, commands, exclude)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100358 for symbol in symbols:
359 description = '!' + symbol
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400360 if exclude and re.match(exclude, description):
361 continue
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100362 config_settings = {symbol: False}
363 turn_off_dependencies(config_settings)
364 job = Job(description, config_settings, commands)
365 self.jobs.append(job)
366
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400367class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400368 """A domain that contains both the ExclusiveDomain and BaseDomain tests.
Andrzej Kurekf4b18672022-10-14 07:57:00 -0400369Both parent class __init__ calls are performed in any order and
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400370each call adds respective jobs. The job array initialization is done once in
371BaseDomain, before the parent __init__ calls."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400372
Andrzej Kurek3322c222022-10-04 15:02:41 -0400373class CipherInfo: # pylint: disable=too-few-public-methods
Gilles Peskine34a15572019-01-29 23:12:28 +0100374 """Collect data about cipher.h."""
Andrzej Kurek3322c222022-10-04 15:02:41 -0400375 def __init__(self):
Gilles Peskine34a15572019-01-29 23:12:28 +0100376 self.base_symbols = set()
Andrzej Kurek3322c222022-10-04 15:02:41 -0400377 with open('include/mbedtls/cipher.h', encoding="utf-8") as fh:
Gilles Peskine34a15572019-01-29 23:12:28 +0100378 for line in fh:
379 m = re.match(r' *MBEDTLS_CIPHER_ID_(\w+),', line)
380 if m and m.group(1) not in ['NONE', 'NULL', '3DES']:
381 self.base_symbols.add('MBEDTLS_' + m.group(1) + '_C')
382
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100383class DomainData:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400384 """A container for domains and jobs, used to structurize testing."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100385 def config_symbols_matching(self, regexp):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400386 """List the mbedtls_config.h settings matching regexp."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100387 return [symbol for symbol in self.all_config_symbols
388 if re.match(regexp, symbol)]
389
390 def __init__(self, options):
391 """Gather data about the library and establish a list of domains to test."""
392 build_command = [options.make_command, 'CFLAGS=-Werror']
393 build_and_test = [build_command, [options.make_command, 'test']]
Andrzej Kurek3322c222022-10-04 15:02:41 -0400394 self.all_config_symbols = set(collect_config_symbols(options))
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100395 # Find hash modules by name.
396 hash_symbols = self.config_symbols_matching(r'MBEDTLS_(MD|RIPEMD|SHA)[0-9]+_C\Z')
397 # Find elliptic curve enabling macros by name.
398 curve_symbols = self.config_symbols_matching(r'MBEDTLS_ECP_DP_\w+_ENABLED\Z')
399 # Find key exchange enabling macros by name.
400 key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z')
Gilles Peskine34a15572019-01-29 23:12:28 +0100401 # Find cipher IDs (block permutations and stream ciphers --- chaining
402 # and padding modes are exercised separately) information by parsing
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400403 # cipher.h, as the information is not readily available in mbedtls_config.h.
Andrzej Kurek3322c222022-10-04 15:02:41 -0400404 cipher_info = CipherInfo()
Gilles Peskine34a15572019-01-29 23:12:28 +0100405 # Find block cipher chaining and padding mode enabling macros by name.
406 cipher_chaining_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_MODE_\w+\Z')
407 cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100408 self.domains = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100409 # Cipher IDs, chaining modes and padding modes. Run the test suites.
410 'cipher_id': ExclusiveDomain(cipher_info.base_symbols,
411 build_and_test),
412 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols,
413 build_and_test),
414 'cipher_padding': ExclusiveDomain(cipher_padding_symbols,
415 build_and_test),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100416 # Elliptic curves. Run the test suites.
417 'curves': ExclusiveDomain(curve_symbols, build_and_test),
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400418 # Hash algorithms. Exclude three groups:
419 # - Exclusive domain of MD, RIPEMD, SHA1 (obsolete);
420 # - Exclusive domain of SHA224 (tested with and depends on SHA256);
421 # - Complementary domain of SHA224 and SHA384 - tested with and depend
422 # on SHA256 and SHA512, respectively.
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400423 'hashes': DualDomain(hash_symbols, build_and_test,
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400424 exclude=r'MBEDTLS_(MD|RIPEMD|SHA1_)' \
425 '|MBEDTLS_SHA224_'\
426 '|!MBEDTLS_(SHA224_|SHA384_)'),
Gilles Peskinec3b4dee2019-01-29 19:33:05 +0100427 # Key exchange types. Only build the library and the sample
428 # programs.
429 'kex': ExclusiveDomain(key_exchange_symbols,
430 [build_command + ['lib'],
431 build_command + ['-C', 'programs']]),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100432 'pkalgs': ComplementaryDomain(['MBEDTLS_ECDSA_C',
433 'MBEDTLS_ECP_C',
434 'MBEDTLS_PKCS1_V21',
435 'MBEDTLS_PKCS1_V15',
436 'MBEDTLS_RSA_C',
437 'MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
438 build_and_test),
439 }
440 self.jobs = {}
441 for domain in self.domains.values():
442 for job in domain.jobs:
443 self.jobs[job.name] = job
444
445 def get_jobs(self, name):
446 """Return the list of jobs identified by the given name.
447A name can either be the name of a domain or the name of one specific job."""
448 if name in self.domains:
449 return sorted(self.domains[name].jobs, key=lambda job: job.name)
450 else:
451 return [self.jobs[name]]
452
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100453def run(options, job, colors=NO_COLORS):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100454 """Run the specified job (a Job instance)."""
455 subprocess.check_call([options.make_command, 'clean'])
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100456 job.announce(colors, None)
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100457 job.configure(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100458 success = job.test(options)
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100459 job.announce(colors, success)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100460 return success
461
Andrzej Kurek3322c222022-10-04 15:02:41 -0400462def run_tests(options, domain_data):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100463 """Run the desired jobs.
464domain_data should be a DomainData instance that describes the available
465domains and jobs.
466Run the jobs listed in options.domains."""
467 if not hasattr(options, 'config_backup'):
468 options.config_backup = options.config + '.bak'
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100469 colors = Colors(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100470 jobs = []
471 failures = []
472 successes = []
473 for name in options.domains:
474 jobs += domain_data.get_jobs(name)
475 backup_config(options)
476 try:
477 for job in jobs:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100478 success = run(options, job, colors=colors)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100479 if not success:
480 if options.keep_going:
481 failures.append(job.name)
482 else:
483 return False
484 else:
485 successes.append(job.name)
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100486 restore_config(options)
487 except:
488 # Restore the configuration, except in stop-on-error mode if there
489 # was an error, where we leave the failing configuration up for
490 # developer convenience.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100491 if options.keep_going:
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100492 restore_config(options)
493 raise
Gilles Peskinee85163b2019-01-29 18:50:03 +0100494 if successes:
495 log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100496 if failures:
Gilles Peskinee85163b2019-01-29 18:50:03 +0100497 log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100498 return False
499 else:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100500 return True
501
Andrzej Kurek3322c222022-10-04 15:02:41 -0400502def main():
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100503 try:
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400504 parser = argparse.ArgumentParser(
505 formatter_class=argparse.RawDescriptionHelpFormatter,
506 description=
507 "Test Mbed TLS with a subset of algorithms.\n\n"
508 "Example usage:\n"
509 r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA224_C""\n"
510 "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n"
511 "./tests/scripts/depends.py cipher_id cipher_chaining\n")
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100512 parser.add_argument('--color', metavar='WHEN',
513 help='Colorize the output (always/auto/never)',
514 choices=['always', 'auto', 'never'], default='auto')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100515 parser.add_argument('-c', '--config', metavar='FILE',
516 help='Configuration file to modify',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400517 default='include/mbedtls/mbedtls_config.h')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100518 parser.add_argument('-C', '--directory', metavar='DIR',
519 help='Change to this directory before anything else',
520 default='.')
521 parser.add_argument('-k', '--keep-going',
522 help='Try all configurations even if some fail (default)',
523 action='store_true', dest='keep_going', default=True)
524 parser.add_argument('-e', '--no-keep-going',
525 help='Stop as soon as a configuration fails',
526 action='store_false', dest='keep_going')
527 parser.add_argument('--list-jobs',
528 help='List supported jobs and exit',
529 action='append_const', dest='list', const='jobs')
530 parser.add_argument('--list-domains',
531 help='List supported domains and exit',
532 action='append_const', dest='list', const='domains')
533 parser.add_argument('--make-command', metavar='CMD',
534 help='Command to run instead of make (e.g. gmake)',
535 action='store', default='make')
536 parser.add_argument('domains', metavar='DOMAIN', nargs='*',
Andrzej Kurek3322c222022-10-04 15:02:41 -0400537 help='The domain(s) to test (default: all). This can \
538 be also a list of jobs to run.',
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100539 default=True)
540 options = parser.parse_args()
541 os.chdir(options.directory)
542 domain_data = DomainData(options)
Andrzej Kurek3322c222022-10-04 15:02:41 -0400543 if options.domains is True:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100544 options.domains = sorted(domain_data.domains.keys())
545 if options.list:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400546 for arg in options.list:
547 for domain_name in sorted(getattr(domain_data, arg).keys()):
548 print(domain_name)
549 sys.exit(0)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100550 else:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400551 sys.exit(0 if run_tests(options, domain_data) else 1)
552 except Exception: # pylint: disable=broad-except
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100553 traceback.print_exc()
Andrzej Kurek3322c222022-10-04 15:02:41 -0400554 sys.exit(3)
555
556if __name__ == '__main__':
557 main()