blob: 09e14c476c39daab05b6726c0fff1d33b8bc6602 [file] [log] [blame]
Gilles Peskineb39e3ec2019-01-29 08:50:20 +01001#!/usr/bin/env python3
2
Dave Rodgman4eb44e42023-11-03 12:15:12 +00003# Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00004# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Gilles Peskineb39e3ec2019-01-29 08:50:20 +01005
Gilles Peskineb39e3ec2019-01-29 08:50:20 +01006"""
Andrzej Kurek01af84a2022-10-09 05:29:44 -04007Test Mbed TLS with a subset of algorithms.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +01008
Andrzej Kurek01af84a2022-10-09 05:29:44 -04009This script can be divided into several steps:
10
11First, include/mbedtls/mbedtls_config.h or a different config file passed
Andrzej Kurek3f930122022-10-26 08:08:26 -040012in the arguments is parsed to extract any configuration options (using config.py).
Andrzej Kurek01af84a2022-10-09 05:29:44 -040013
14Then, test domains (groups of jobs, tests) are built based on predefined data
15collected in the DomainData class. Here, each domain has five major traits:
Andrzej Kurek629c4122022-10-17 08:34:40 -040016- domain name, can be used to run only specific tests via command-line;
Andrzej Kurek01af84a2022-10-09 05:29:44 -040017- configuration building method, described in detail below;
18- list of symbols passed to the configuration building method;
19- commands to be run on each job (only build, build and test, or any other custom);
20- optional list of symbols to be excluded from testing.
21
22The configuration building method can be one of the three following:
23
24- ComplementaryDomain - build a job for each passed symbol by disabling a single
25 symbol and its reverse dependencies (defined in REVERSE_DEPENDENCIES);
26
27- ExclusiveDomain - build a job where, for each passed symbol, only this particular
28 one is defined and other symbols from the list are unset. For each job look for
29 any non-standard symbols to set/unset in EXCLUSIVE_GROUPS. These are usually not
30 direct dependencies, but rather non-trivial results of other configs missing. Then
31 look for any unset symbols and handle their reverse dependencies.
32 Examples of EXCLUSIVE_GROUPS usage:
Andrzej Kurek01af84a2022-10-09 05:29:44 -040033 - MBEDTLS_SHA512_C job turns off all hashes except SHA512. MBEDTLS_SSL_COOKIE_C
34 requires either SHA256 or SHA384 to work, so it also has to be disabled.
35 This is not a dependency on SHA512_C, but a result of an exclusive domain
36 config building method. Relevant field:
Andrzej Kurek629c4122022-10-17 08:34:40 -040037 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_COOKIE_C'],
Andrzej Kurek01af84a2022-10-09 05:29:44 -040038
39- DualDomain - combination of the two above - both complementary and exclusive domain
40 job generation code will be run. Currently only used for hashes.
41
42Lastly, the collected jobs are executed and (optionally) tested, with
43error reporting and coloring as configured in options. Each test starts with
44a full config without a couple of slowing down or unnecessary options
45(see set_reference_config), then the specific job config is derived.
46"""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010047import argparse
48import os
49import re
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010050import subprocess
51import sys
52import traceback
Andrzej Kurek576803f2023-01-24 07:40:42 -050053from typing import Union
54
Andrzej Kurek3b0215d2023-01-23 07:19:22 -050055# Add the Mbed TLS Python library directory to the module search path
Andrzej Kurek3f930122022-10-26 08:08:26 -040056import scripts_path # pylint: disable=unused-import
57import config
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010058
Andrzej Kurek3322c222022-10-04 15:02:41 -040059class Colors: # pylint: disable=too-few-public-methods
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010060 """Minimalistic support for colored output.
61Each field of an object of this class is either None if colored output
62is not possible or not desired, or a pair of strings (start, stop) such
63that outputting start switches the text color to the desired color and
64stop switches the text color back to the default."""
65 red = None
66 green = None
Andrzej Kurek3f930122022-10-26 08:08:26 -040067 cyan = None
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010068 bold_red = None
69 bold_green = None
70 def __init__(self, options=None):
Andrzej Kurek3322c222022-10-04 15:02:41 -040071 """Initialize color profile according to passed options."""
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010072 if not options or options.color in ['no', 'never']:
73 want_color = False
74 elif options.color in ['yes', 'always']:
75 want_color = True
76 else:
77 want_color = sys.stderr.isatty()
78 if want_color:
79 # Assume ANSI compatible terminal
80 normal = '\033[0m'
81 self.red = ('\033[31m', normal)
82 self.green = ('\033[32m', normal)
Andrzej Kurek3f930122022-10-26 08:08:26 -040083 self.cyan = ('\033[36m', normal)
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010084 self.bold_red = ('\033[1;31m', normal)
85 self.bold_green = ('\033[1;32m', normal)
86NO_COLORS = Colors(None)
87
88def log_line(text, prefix='depends.py:', suffix='', color=None):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010089 """Print a status message."""
Andrzej Kurek3322c222022-10-04 15:02:41 -040090 if color is not None:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010091 prefix = color[0] + prefix
92 suffix = suffix + color[1]
93 sys.stderr.write(prefix + ' ' + text + suffix + '\n')
Gilles Peskine46c82562019-01-29 18:42:55 +010094 sys.stderr.flush()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010095
Gilles Peskine54aa5c62019-01-29 18:46:34 +010096def log_command(cmd):
97 """Print a trace of the specified command.
98cmd is a list of strings: a command name and its arguments."""
99 log_line(' '.join(cmd), prefix='+')
100
Andrzej Kurek3f930122022-10-26 08:08:26 -0400101def option_exists(conf, option):
Andrzej Kurek81cf5ad2023-02-06 10:48:43 +0100102 return option in conf.settings
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100103
Andrzej Kurek576803f2023-01-24 07:40:42 -0500104def set_config_option_value(conf, option, colors, value: Union[bool, str]):
105 """Set/unset a configuration option, optionally specifying a value.
106value can be either True/False (set/unset config option), or a string,
107which will make a symbol defined with a certain value."""
Andrzej Kurek3f930122022-10-26 08:08:26 -0400108 if not option_exists(conf, option):
109 log_line('Symbol {} was not found in {}'.format(option, conf.filename), color=colors.red)
110 return False
Andrzej Kurek3f930122022-10-26 08:08:26 -0400111
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500112 if value is False:
113 log_command(['config.py', 'unset', option])
114 conf.unset(option)
Andrzej Kurek72082dc2023-02-06 10:49:46 +0100115 elif value is True:
116 log_command(['config.py', 'set', option])
117 conf.set(option)
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500118 else:
Andrzej Kurek72082dc2023-02-06 10:49:46 +0100119 log_command(['config.py', 'set', option, value])
120 conf.set(option, value)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400121 return True
122
123def set_reference_config(conf, options, colors):
Andrzej Kurek3322c222022-10-04 15:02:41 -0400124 """Change the library configuration file (mbedtls_config.h) to the reference state.
125The reference state is the one from which the tested configurations are
126derived."""
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400127 # Turn off options that are not relevant to the tests and slow them down.
Andrzej Kurek3f930122022-10-26 08:08:26 -0400128 log_command(['config.py', 'full'])
129 conf.adapt(config.full_adapter)
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500130 set_config_option_value(conf, 'MBEDTLS_TEST_HOOKS', colors, False)
Andrzej Kurek2c7993c2022-10-24 10:41:20 -0400131 if options.unset_use_psa:
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500132 set_config_option_value(conf, 'MBEDTLS_USE_PSA_CRYPTO', colors, False)
Andrzej Kurek3322c222022-10-04 15:02:41 -0400133
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100134class Job:
135 """A job builds the library in a specific configuration and runs some tests."""
136 def __init__(self, name, config_settings, commands):
137 """Build a job object.
138The job uses the configuration described by config_settings. This is a
139dictionary where the keys are preprocessor symbols and the values are
140booleans or strings. A boolean indicates whether or not to #define the
141symbol. With a string, the symbol is #define'd to that value.
142After setting the configuration, the job runs the programs specified by
143commands. This is a list of lists of strings; each list of string is a
144command name and its arguments and is passed to subprocess.call with
145shell=False."""
146 self.name = name
147 self.config_settings = config_settings
148 self.commands = commands
149
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100150 def announce(self, colors, what):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100151 '''Announce the start or completion of a job.
152If what is None, announce the start of the job.
153If what is True, announce that the job has passed.
154If what is False, announce that the job has failed.'''
155 if what is True:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100156 log_line(self.name + ' PASSED', color=colors.green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100157 elif what is False:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100158 log_line(self.name + ' FAILED', color=colors.red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100159 else:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400160 log_line('starting ' + self.name, color=colors.cyan)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100161
Andrzej Kurek3f930122022-10-26 08:08:26 -0400162 def configure(self, conf, options, colors):
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400163 '''Set library configuration options as required for the job.'''
Andrzej Kurek3f930122022-10-26 08:08:26 -0400164 set_reference_config(conf, options, colors)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100165 for key, value in sorted(self.config_settings.items()):
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500166 ret = set_config_option_value(conf, key, colors, value)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400167 if ret is False:
168 return False
169 return True
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100170
171 def test(self, options):
172 '''Run the job's build and test commands.
173Return True if all the commands succeed and False otherwise.
174If options.keep_going is false, stop as soon as one command fails. Otherwise
175run all the commands, except that if the first command fails, none of the
176other commands are run (typically, the first command is a build command
177and subsequent commands are tests that cannot run if the build failed).'''
178 built = False
179 success = True
180 for command in self.commands:
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100181 log_command(command)
Gilles Peskine35cb3192024-02-12 14:16:05 +0100182 env = os.environ.copy()
183 if 'MBEDTLS_TEST_CONFIGURATION' in env:
184 env['MBEDTLS_TEST_CONFIGURATION'] += '-' + self.name
185 ret = subprocess.call(command, env=env)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100186 if ret != 0:
187 if command[0] not in ['make', options.make_command]:
188 log_line('*** [{}] Error {}'.format(' '.join(command), ret))
189 if not options.keep_going or not built:
190 return False
191 success = False
192 built = True
193 return success
194
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100195# If the configuration option A requires B, make sure that
Andrzej Kurek202932f2022-10-04 16:22:22 -0400196# B in REVERSE_DEPENDENCIES[A].
Gilles Peskine584c24a2019-01-29 19:30:40 +0100197# All the information here should be contained in check_config.h. This
198# file includes a copy because it changes rarely and it would be a pain
199# to extract automatically.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400200REVERSE_DEPENDENCIES = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100201 'MBEDTLS_AES_C': ['MBEDTLS_CTR_DRBG_C',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400202 'MBEDTLS_NIST_KW_C'],
Gilles Peskine34a15572019-01-29 23:12:28 +0100203 'MBEDTLS_CHACHA20_C': ['MBEDTLS_CHACHAPOLY_C'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400204 'MBEDTLS_ECDSA_C': ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
205 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100206 'MBEDTLS_ECP_C': ['MBEDTLS_ECDSA_C',
207 'MBEDTLS_ECDH_C',
208 'MBEDTLS_ECJPAKE_C',
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100209 'MBEDTLS_ECP_RESTARTABLE',
Valerio Setti15e70442023-06-15 09:47:26 +0200210 'MBEDTLS_PK_PARSE_EC_EXTENDED',
211 'MBEDTLS_PK_PARSE_EC_COMPRESSED',
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100212 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
213 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED',
214 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED',
215 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400216 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
Ronald Crond8d2ea52022-10-04 15:48:06 +0200217 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
218 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED',
219 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100220 'MBEDTLS_ECP_DP_SECP256R1_ENABLED': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100221 'MBEDTLS_PKCS1_V21': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
222 'MBEDTLS_PKCS1_V15': ['MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
223 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
224 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
225 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'],
226 'MBEDTLS_RSA_C': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT',
227 'MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
228 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
229 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400230 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED',
231 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100232 'MBEDTLS_SHA256_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400233 'MBEDTLS_ENTROPY_FORCE_SHA256',
Dave Rodgmand680d4f2023-10-11 11:05:22 +0100234 'MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT',
235 'MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY',
Andrzej Kurek22b959d2022-10-16 12:51:41 -0400236 'MBEDTLS_LMS_C',
237 'MBEDTLS_LMS_PRIVATE'],
Valerio Settie7221a22022-12-16 11:53:45 +0100238 'MBEDTLS_SHA512_C': ['MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400239 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY'],
240 'MBEDTLS_SHA224_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
241 'MBEDTLS_ENTROPY_FORCE_SHA256',
Dave Rodgmand680d4f2023-10-11 11:05:22 +0100242 'MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT',
243 'MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400244 'MBEDTLS_X509_RSASSA_PSS_SUPPORT': []
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100245}
246
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400247# If an option is tested in an exclusive test, alter the following defines.
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400248# These are not necessarily dependencies, but just minimal required changes
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400249# if a given define is the only one enabled from an exclusive group.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400250EXCLUSIVE_GROUPS = {
Andrzej Kurek65b2ac12022-10-14 08:09:16 -0400251 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_COOKIE_C',
Manuel Pégourié-Gonnard5a51d0d2023-03-22 13:04:08 +0100252 '-MBEDTLS_SSL_TLS_C'],
Andrzej Kurek65b2ac12022-10-14 08:09:16 -0400253 'MBEDTLS_ECP_DP_CURVE448_ENABLED': ['-MBEDTLS_ECDSA_C',
254 '-MBEDTLS_ECDSA_DETERMINISTIC',
255 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
256 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
257 '-MBEDTLS_ECJPAKE_C',
258 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
259 'MBEDTLS_ECP_DP_CURVE25519_ENABLED': ['-MBEDTLS_ECDSA_C',
260 '-MBEDTLS_ECDSA_DETERMINISTIC',
261 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
262 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
263 '-MBEDTLS_ECJPAKE_C',
264 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
265 'MBEDTLS_ARIA_C': ['-MBEDTLS_CMAC_C'],
266 'MBEDTLS_CAMELLIA_C': ['-MBEDTLS_CMAC_C'],
267 'MBEDTLS_CHACHA20_C': ['-MBEDTLS_CMAC_C', '-MBEDTLS_CCM_C', '-MBEDTLS_GCM_C'],
268 'MBEDTLS_DES_C': ['-MBEDTLS_CCM_C',
269 '-MBEDTLS_GCM_C',
270 '-MBEDTLS_SSL_TICKET_C',
271 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400272}
273def handle_exclusive_groups(config_settings, symbol):
274 """For every symbol tested in an exclusive group check if there are other
275defines to be altered. """
Andrzej Kurek202932f2022-10-04 16:22:22 -0400276 for dep in EXCLUSIVE_GROUPS.get(symbol, []):
Andrzej Kurek65b2ac12022-10-14 08:09:16 -0400277 unset = dep.startswith('-')
278 dep = dep[1:]
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400279 config_settings[dep] = not unset
280
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100281def turn_off_dependencies(config_settings):
282 """For every option turned off config_settings, also turn off what depends on it.
283An option O is turned off if config_settings[O] is False."""
284 for key, value in sorted(config_settings.items()):
285 if value is not False:
286 continue
Andrzej Kurek202932f2022-10-04 16:22:22 -0400287 for dep in REVERSE_DEPENDENCIES.get(key, []):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100288 config_settings[dep] = False
289
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400290class BaseDomain: # pylint: disable=too-few-public-methods, unused-argument
291 """A base class for all domains."""
292 def __init__(self, symbols, commands, exclude):
293 """Initialize the jobs container"""
294 self.jobs = []
295
296class ExclusiveDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100297 """A domain consisting of a set of conceptually-equivalent settings.
298Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurekfe469492022-10-06 16:57:38 -0400299with this symbol set and the others unset."""
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100300 def __init__(self, symbols, commands, exclude=None):
301 """Build a domain for the specified list of configuration symbols.
Andrzej Kurekfe469492022-10-06 16:57:38 -0400302The domain contains a set of jobs that enable one of the elements
303of symbols and disable the others.
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100304Each job runs the specified commands.
305If exclude is a regular expression, skip generated jobs whose description
306would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400307 super().__init__(symbols, commands, exclude)
Andrzej Kurekfe469492022-10-06 16:57:38 -0400308 base_config_settings = {}
309 for symbol in symbols:
310 base_config_settings[symbol] = False
311 for symbol in symbols:
312 description = symbol
313 if exclude and re.match(exclude, description):
314 continue
315 config_settings = base_config_settings.copy()
316 config_settings[symbol] = True
317 handle_exclusive_groups(config_settings, symbol)
318 turn_off_dependencies(config_settings)
319 job = Job(description, config_settings, commands)
320 self.jobs.append(job)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100321
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400322class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100323 """A domain consisting of a set of loosely-related settings.
324Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400325with this symbol unset.
326If exclude is a regular expression, skip generated jobs whose description
327would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400328 def __init__(self, symbols, commands, exclude=None):
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100329 """Build a domain for the specified list of configuration symbols.
330Each job in the domain disables one of the specified symbols.
331Each job runs the specified commands."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400332 super().__init__(symbols, commands, exclude)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100333 for symbol in symbols:
334 description = '!' + symbol
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400335 if exclude and re.match(exclude, description):
336 continue
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100337 config_settings = {symbol: False}
338 turn_off_dependencies(config_settings)
339 job = Job(description, config_settings, commands)
340 self.jobs.append(job)
341
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400342class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400343 """A domain that contains both the ExclusiveDomain and BaseDomain tests.
Andrzej Kurekf4b18672022-10-14 07:57:00 -0400344Both parent class __init__ calls are performed in any order and
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400345each call adds respective jobs. The job array initialization is done once in
346BaseDomain, before the parent __init__ calls."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400347
Andrzej Kurek3322c222022-10-04 15:02:41 -0400348class CipherInfo: # pylint: disable=too-few-public-methods
Gilles Peskine34a15572019-01-29 23:12:28 +0100349 """Collect data about cipher.h."""
Andrzej Kurek3322c222022-10-04 15:02:41 -0400350 def __init__(self):
Gilles Peskine34a15572019-01-29 23:12:28 +0100351 self.base_symbols = set()
Ronald Cronb50d30f2024-06-21 08:56:43 +0200352 if os.path.isdir('tf-psa-crypto'):
353 cipher_h_path = 'tf-psa-crypto/drivers/builtin/include/mbedtls/cipher.h'
354 else:
355 cipher_h_path = 'include/mbedtls/cipher.h'
356 with open(cipher_h_path, encoding="utf-8") as fh:
Gilles Peskine34a15572019-01-29 23:12:28 +0100357 for line in fh:
358 m = re.match(r' *MBEDTLS_CIPHER_ID_(\w+),', line)
359 if m and m.group(1) not in ['NONE', 'NULL', '3DES']:
360 self.base_symbols.add('MBEDTLS_' + m.group(1) + '_C')
361
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100362class DomainData:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400363 """A container for domains and jobs, used to structurize testing."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100364 def config_symbols_matching(self, regexp):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400365 """List the mbedtls_config.h settings matching regexp."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100366 return [symbol for symbol in self.all_config_symbols
367 if re.match(regexp, symbol)]
368
Andrzej Kurek3f930122022-10-26 08:08:26 -0400369 def __init__(self, options, conf):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100370 """Gather data about the library and establish a list of domains to test."""
Dave Rodgman84125a12024-01-02 11:42:38 +0000371 build_command = [options.make_command, 'CFLAGS=-Werror -O2']
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100372 build_and_test = [build_command, [options.make_command, 'test']]
Andrzej Kurek3f930122022-10-26 08:08:26 -0400373 self.all_config_symbols = set(conf.settings.keys())
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100374 # Find hash modules by name.
375 hash_symbols = self.config_symbols_matching(r'MBEDTLS_(MD|RIPEMD|SHA)[0-9]+_C\Z')
376 # Find elliptic curve enabling macros by name.
377 curve_symbols = self.config_symbols_matching(r'MBEDTLS_ECP_DP_\w+_ENABLED\Z')
378 # Find key exchange enabling macros by name.
379 key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z')
Gilles Peskine34a15572019-01-29 23:12:28 +0100380 # Find cipher IDs (block permutations and stream ciphers --- chaining
381 # and padding modes are exercised separately) information by parsing
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400382 # cipher.h, as the information is not readily available in mbedtls_config.h.
Andrzej Kurek3322c222022-10-04 15:02:41 -0400383 cipher_info = CipherInfo()
Gilles Peskine34a15572019-01-29 23:12:28 +0100384 # Find block cipher chaining and padding mode enabling macros by name.
385 cipher_chaining_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_MODE_\w+\Z')
386 cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100387 self.domains = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100388 # Cipher IDs, chaining modes and padding modes. Run the test suites.
389 'cipher_id': ExclusiveDomain(cipher_info.base_symbols,
390 build_and_test),
391 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols,
392 build_and_test),
393 'cipher_padding': ExclusiveDomain(cipher_padding_symbols,
394 build_and_test),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100395 # Elliptic curves. Run the test suites.
396 'curves': ExclusiveDomain(curve_symbols, build_and_test),
Valerio Settiea8c88f2022-12-29 11:08:35 +0100397 # Hash algorithms. Excluding exclusive domains of MD, RIPEMD, SHA1,
398 # SHA224 and SHA384 because MBEDTLS_ENTROPY_C is extensively used
399 # across various modules, but it depends on either SHA256 or SHA512.
400 # As a consequence an "exclusive" test of anything other than SHA256
401 # or SHA512 with MBEDTLS_ENTROPY_C enabled is not possible.
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400402 'hashes': DualDomain(hash_symbols, build_and_test,
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400403 exclude=r'MBEDTLS_(MD|RIPEMD|SHA1_)' \
Valerio Settib6bf7dc2022-12-22 14:28:03 +0100404 '|MBEDTLS_SHA224_' \
Pol Henarejosaa426e02023-02-08 12:52:10 +0100405 '|MBEDTLS_SHA384_' \
406 '|MBEDTLS_SHA3_'),
Andrzej Kurek98682b52023-01-23 06:16:23 -0500407 # Key exchange types.
Andrzej Kurek1ff73362022-11-02 04:50:16 -0400408 'kex': ExclusiveDomain(key_exchange_symbols, build_and_test),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100409 'pkalgs': ComplementaryDomain(['MBEDTLS_ECDSA_C',
410 'MBEDTLS_ECP_C',
411 'MBEDTLS_PKCS1_V21',
412 'MBEDTLS_PKCS1_V15',
413 'MBEDTLS_RSA_C',
414 'MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
415 build_and_test),
416 }
417 self.jobs = {}
418 for domain in self.domains.values():
419 for job in domain.jobs:
420 self.jobs[job.name] = job
421
422 def get_jobs(self, name):
423 """Return the list of jobs identified by the given name.
424A name can either be the name of a domain or the name of one specific job."""
425 if name in self.domains:
426 return sorted(self.domains[name].jobs, key=lambda job: job.name)
427 else:
428 return [self.jobs[name]]
429
Andrzej Kurek3f930122022-10-26 08:08:26 -0400430def run(options, job, conf, colors=NO_COLORS):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100431 """Run the specified job (a Job instance)."""
432 subprocess.check_call([options.make_command, 'clean'])
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100433 job.announce(colors, None)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400434 if not job.configure(conf, options, colors):
435 job.announce(colors, False)
436 return False
437 conf.write()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100438 success = job.test(options)
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100439 job.announce(colors, success)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100440 return success
441
Andrzej Kurek3f930122022-10-26 08:08:26 -0400442def run_tests(options, domain_data, conf):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100443 """Run the desired jobs.
444domain_data should be a DomainData instance that describes the available
445domains and jobs.
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400446Run the jobs listed in options.tasks."""
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100447 colors = Colors(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100448 jobs = []
449 failures = []
450 successes = []
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400451 for name in options.tasks:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100452 jobs += domain_data.get_jobs(name)
Gabor Mezei035d7c82024-06-19 15:46:21 +0200453 conf.backup()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100454 try:
455 for job in jobs:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400456 success = run(options, job, conf, colors=colors)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100457 if not success:
458 if options.keep_going:
459 failures.append(job.name)
460 else:
461 return False
462 else:
463 successes.append(job.name)
Gabor Mezei035d7c82024-06-19 15:46:21 +0200464 conf.restore()
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100465 except:
466 # Restore the configuration, except in stop-on-error mode if there
467 # was an error, where we leave the failing configuration up for
468 # developer convenience.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100469 if options.keep_going:
Gabor Mezei035d7c82024-06-19 15:46:21 +0200470 conf.restore()
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100471 raise
Gilles Peskinee85163b2019-01-29 18:50:03 +0100472 if successes:
473 log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100474 if failures:
Gilles Peskinee85163b2019-01-29 18:50:03 +0100475 log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100476 return False
477 else:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100478 return True
479
Andrzej Kurek3322c222022-10-04 15:02:41 -0400480def main():
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100481 try:
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400482 parser = argparse.ArgumentParser(
483 formatter_class=argparse.RawDescriptionHelpFormatter,
484 description=
485 "Test Mbed TLS with a subset of algorithms.\n\n"
486 "Example usage:\n"
Andrzej Kurek629c4122022-10-17 08:34:40 -0400487 r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA256_C""\n"
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400488 "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n"
489 "./tests/scripts/depends.py cipher_id cipher_chaining\n")
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100490 parser.add_argument('--color', metavar='WHEN',
491 help='Colorize the output (always/auto/never)',
492 choices=['always', 'auto', 'never'], default='auto')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100493 parser.add_argument('-c', '--config', metavar='FILE',
494 help='Configuration file to modify',
Gabor Mezeif5408f02024-06-14 15:25:46 +0200495 default=config.MbedTLSConfigFile.default_path[0])
496 parser.add_argument('-r', '--crypto-config', metavar='FILE',
497 help='Crypto configuration file to modify',
498 default=config.CryptoConfigFile.default_path[0])
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100499 parser.add_argument('-C', '--directory', metavar='DIR',
500 help='Change to this directory before anything else',
501 default='.')
502 parser.add_argument('-k', '--keep-going',
503 help='Try all configurations even if some fail (default)',
504 action='store_true', dest='keep_going', default=True)
505 parser.add_argument('-e', '--no-keep-going',
506 help='Stop as soon as a configuration fails',
507 action='store_false', dest='keep_going')
508 parser.add_argument('--list-jobs',
509 help='List supported jobs and exit',
510 action='append_const', dest='list', const='jobs')
511 parser.add_argument('--list-domains',
512 help='List supported domains and exit',
513 action='append_const', dest='list', const='domains')
514 parser.add_argument('--make-command', metavar='CMD',
515 help='Command to run instead of make (e.g. gmake)',
516 action='store', default='make')
Andrzej Kurek2c7993c2022-10-24 10:41:20 -0400517 parser.add_argument('--unset-use-psa',
518 help='Unset MBEDTLS_USE_PSA_CRYPTO before any test',
519 action='store_true', dest='unset_use_psa')
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400520 parser.add_argument('tasks', metavar='TASKS', nargs='*',
521 help='The domain(s) or job(s) to test (default: all).',
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100522 default=True)
523 options = parser.parse_args()
524 os.chdir(options.directory)
Gabor Mezeif5408f02024-06-14 15:25:46 +0200525 conf = config.CombinedConfig(config.MbedTLSConfigFile(options.config),
526 config.CryptoConfigFile(options.crypto_config))
Andrzej Kurek3f930122022-10-26 08:08:26 -0400527 domain_data = DomainData(options, conf)
528
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400529 if options.tasks is True:
530 options.tasks = sorted(domain_data.domains.keys())
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100531 if options.list:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400532 for arg in options.list:
533 for domain_name in sorted(getattr(domain_data, arg).keys()):
534 print(domain_name)
535 sys.exit(0)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100536 else:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400537 sys.exit(0 if run_tests(options, domain_data, conf) else 1)
Andrzej Kurek3322c222022-10-04 15:02:41 -0400538 except Exception: # pylint: disable=broad-except
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100539 traceback.print_exc()
Andrzej Kurek3322c222022-10-04 15:02:41 -0400540 sys.exit(3)
541
542if __name__ == '__main__':
543 main()