blob: 64a3d46b2c799f75304e90ca02fbd1cdfb1a1088 [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
50import shutil
51import subprocess
52import sys
53import traceback
Andrzej Kurek576803f2023-01-24 07:40:42 -050054from typing import Union
55
Andrzej Kurek3b0215d2023-01-23 07:19:22 -050056# Add the Mbed TLS Python library directory to the module search path
Andrzej Kurek3f930122022-10-26 08:08:26 -040057import scripts_path # pylint: disable=unused-import
58import config
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010059
Andrzej Kurek3322c222022-10-04 15:02:41 -040060class Colors: # pylint: disable=too-few-public-methods
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010061 """Minimalistic support for colored output.
62Each field of an object of this class is either None if colored output
63is not possible or not desired, or a pair of strings (start, stop) such
64that outputting start switches the text color to the desired color and
65stop switches the text color back to the default."""
66 red = None
67 green = None
Andrzej Kurek3f930122022-10-26 08:08:26 -040068 cyan = None
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010069 bold_red = None
70 bold_green = None
71 def __init__(self, options=None):
Andrzej Kurek3322c222022-10-04 15:02:41 -040072 """Initialize color profile according to passed options."""
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010073 if not options or options.color in ['no', 'never']:
74 want_color = False
75 elif options.color in ['yes', 'always']:
76 want_color = True
77 else:
78 want_color = sys.stderr.isatty()
79 if want_color:
80 # Assume ANSI compatible terminal
81 normal = '\033[0m'
82 self.red = ('\033[31m', normal)
83 self.green = ('\033[32m', normal)
Andrzej Kurek3f930122022-10-26 08:08:26 -040084 self.cyan = ('\033[36m', normal)
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010085 self.bold_red = ('\033[1;31m', normal)
86 self.bold_green = ('\033[1;32m', normal)
87NO_COLORS = Colors(None)
88
89def log_line(text, prefix='depends.py:', suffix='', color=None):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010090 """Print a status message."""
Andrzej Kurek3322c222022-10-04 15:02:41 -040091 if color is not None:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010092 prefix = color[0] + prefix
93 suffix = suffix + color[1]
94 sys.stderr.write(prefix + ' ' + text + suffix + '\n')
Gilles Peskine46c82562019-01-29 18:42:55 +010095 sys.stderr.flush()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010096
Gilles Peskine54aa5c62019-01-29 18:46:34 +010097def log_command(cmd):
98 """Print a trace of the specified command.
99cmd is a list of strings: a command name and its arguments."""
100 log_line(' '.join(cmd), prefix='+')
101
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100102def backup_config(options):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400103 """Back up the library configuration file (mbedtls_config.h).
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100104If the backup file already exists, it is presumed to be the desired backup,
105so don't make another backup."""
106 if os.path.exists(options.config_backup):
107 options.own_backup = False
108 else:
109 options.own_backup = True
110 shutil.copy(options.config, options.config_backup)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100111
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100112def restore_config(options):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400113 """Restore the library configuration file (mbedtls_config.h).
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100114Remove the backup file if it was saved earlier."""
115 if options.own_backup:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100116 shutil.move(options.config_backup, options.config)
117 else:
118 shutil.copy(options.config_backup, options.config)
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100119
Andrzej Kurek3f930122022-10-26 08:08:26 -0400120def option_exists(conf, option):
Andrzej Kurek81cf5ad2023-02-06 10:48:43 +0100121 return option in conf.settings
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100122
Andrzej Kurek576803f2023-01-24 07:40:42 -0500123def set_config_option_value(conf, option, colors, value: Union[bool, str]):
124 """Set/unset a configuration option, optionally specifying a value.
125value can be either True/False (set/unset config option), or a string,
126which will make a symbol defined with a certain value."""
Andrzej Kurek3f930122022-10-26 08:08:26 -0400127 if not option_exists(conf, option):
128 log_line('Symbol {} was not found in {}'.format(option, conf.filename), color=colors.red)
129 return False
Andrzej Kurek3f930122022-10-26 08:08:26 -0400130
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500131 if value is False:
132 log_command(['config.py', 'unset', option])
133 conf.unset(option)
Andrzej Kurek72082dc2023-02-06 10:49:46 +0100134 elif value is True:
135 log_command(['config.py', 'set', option])
136 conf.set(option)
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500137 else:
Andrzej Kurek72082dc2023-02-06 10:49:46 +0100138 log_command(['config.py', 'set', option, value])
139 conf.set(option, value)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400140 return True
141
142def set_reference_config(conf, options, colors):
Andrzej Kurek3322c222022-10-04 15:02:41 -0400143 """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 Kurek3f930122022-10-26 08:08:26 -0400147 log_command(['config.py', 'full'])
148 conf.adapt(config.full_adapter)
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500149 set_config_option_value(conf, 'MBEDTLS_TEST_HOOKS', colors, False)
Gilles Peskine884b4622023-07-20 20:11:51 +0200150 set_config_option_value(conf, 'MBEDTLS_PSA_CRYPTO_CONFIG', colors, False)
Andrzej Kurek2c7993c2022-10-24 10:41:20 -0400151 if options.unset_use_psa:
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500152 set_config_option_value(conf, 'MBEDTLS_USE_PSA_CRYPTO', colors, False)
Andrzej Kurek3322c222022-10-04 15:02:41 -0400153
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100154class Job:
155 """A job builds the library in a specific configuration and runs some tests."""
156 def __init__(self, name, config_settings, commands):
157 """Build a job object.
158The job uses the configuration described by config_settings. This is a
159dictionary where the keys are preprocessor symbols and the values are
160booleans or strings. A boolean indicates whether or not to #define the
161symbol. With a string, the symbol is #define'd to that value.
162After setting the configuration, the job runs the programs specified by
163commands. This is a list of lists of strings; each list of string is a
164command name and its arguments and is passed to subprocess.call with
165shell=False."""
166 self.name = name
167 self.config_settings = config_settings
168 self.commands = commands
169
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100170 def announce(self, colors, what):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100171 '''Announce the start or completion of a job.
172If what is None, announce the start of the job.
173If what is True, announce that the job has passed.
174If what is False, announce that the job has failed.'''
175 if what is True:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100176 log_line(self.name + ' PASSED', color=colors.green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100177 elif what is False:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100178 log_line(self.name + ' FAILED', color=colors.red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100179 else:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400180 log_line('starting ' + self.name, color=colors.cyan)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100181
Andrzej Kurek3f930122022-10-26 08:08:26 -0400182 def configure(self, conf, options, colors):
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400183 '''Set library configuration options as required for the job.'''
Andrzej Kurek3f930122022-10-26 08:08:26 -0400184 set_reference_config(conf, options, colors)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100185 for key, value in sorted(self.config_settings.items()):
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500186 ret = set_config_option_value(conf, key, colors, value)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400187 if ret is False:
188 return False
189 return True
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100190
191 def test(self, options):
192 '''Run the job's build and test commands.
193Return True if all the commands succeed and False otherwise.
194If options.keep_going is false, stop as soon as one command fails. Otherwise
195run all the commands, except that if the first command fails, none of the
196other commands are run (typically, the first command is a build command
197and subsequent commands are tests that cannot run if the build failed).'''
198 built = False
199 success = True
200 for command in self.commands:
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100201 log_command(command)
Gilles Peskine35cb3192024-02-12 14:16:05 +0100202 env = os.environ.copy()
203 if 'MBEDTLS_TEST_CONFIGURATION' in env:
204 env['MBEDTLS_TEST_CONFIGURATION'] += '-' + self.name
205 ret = subprocess.call(command, env=env)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100206 if ret != 0:
207 if command[0] not in ['make', options.make_command]:
208 log_line('*** [{}] Error {}'.format(' '.join(command), ret))
209 if not options.keep_going or not built:
210 return False
211 success = False
212 built = True
213 return success
214
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100215# If the configuration option A requires B, make sure that
Andrzej Kurek202932f2022-10-04 16:22:22 -0400216# B in REVERSE_DEPENDENCIES[A].
Gilles Peskine584c24a2019-01-29 19:30:40 +0100217# All the information here should be contained in check_config.h. This
218# file includes a copy because it changes rarely and it would be a pain
219# to extract automatically.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400220REVERSE_DEPENDENCIES = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100221 'MBEDTLS_AES_C': ['MBEDTLS_CTR_DRBG_C',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400222 'MBEDTLS_NIST_KW_C'],
Gilles Peskine34a15572019-01-29 23:12:28 +0100223 'MBEDTLS_CHACHA20_C': ['MBEDTLS_CHACHAPOLY_C'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400224 'MBEDTLS_ECDSA_C': ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
225 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100226 'MBEDTLS_ECP_C': ['MBEDTLS_ECDSA_C',
227 'MBEDTLS_ECDH_C',
228 'MBEDTLS_ECJPAKE_C',
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100229 'MBEDTLS_ECP_RESTARTABLE',
Valerio Setti15e70442023-06-15 09:47:26 +0200230 'MBEDTLS_PK_PARSE_EC_EXTENDED',
231 'MBEDTLS_PK_PARSE_EC_COMPRESSED',
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100232 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
233 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED',
234 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED',
235 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400236 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
Ronald Crond8d2ea52022-10-04 15:48:06 +0200237 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
238 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED',
239 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100240 'MBEDTLS_ECP_DP_SECP256R1_ENABLED': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100241 'MBEDTLS_PKCS1_V21': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
242 'MBEDTLS_PKCS1_V15': ['MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
243 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
244 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
245 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'],
246 'MBEDTLS_RSA_C': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT',
247 'MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
248 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
249 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400250 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED',
251 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100252 'MBEDTLS_SHA256_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400253 'MBEDTLS_ENTROPY_FORCE_SHA256',
Dave Rodgmand680d4f2023-10-11 11:05:22 +0100254 'MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT',
255 'MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY',
Andrzej Kurek22b959d2022-10-16 12:51:41 -0400256 'MBEDTLS_LMS_C',
257 'MBEDTLS_LMS_PRIVATE'],
Valerio Settie7221a22022-12-16 11:53:45 +0100258 'MBEDTLS_SHA512_C': ['MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400259 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY'],
260 'MBEDTLS_SHA224_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
261 'MBEDTLS_ENTROPY_FORCE_SHA256',
Dave Rodgmand680d4f2023-10-11 11:05:22 +0100262 'MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT',
263 'MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400264 'MBEDTLS_X509_RSASSA_PSS_SUPPORT': []
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100265}
266
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400267# If an option is tested in an exclusive test, alter the following defines.
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400268# These are not necessarily dependencies, but just minimal required changes
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400269# if a given define is the only one enabled from an exclusive group.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400270EXCLUSIVE_GROUPS = {
Andrzej Kurek65b2ac12022-10-14 08:09:16 -0400271 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_COOKIE_C',
Manuel Pégourié-Gonnard5a51d0d2023-03-22 13:04:08 +0100272 '-MBEDTLS_SSL_TLS_C'],
Andrzej Kurek65b2ac12022-10-14 08:09:16 -0400273 'MBEDTLS_ECP_DP_CURVE448_ENABLED': ['-MBEDTLS_ECDSA_C',
274 '-MBEDTLS_ECDSA_DETERMINISTIC',
275 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
276 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
277 '-MBEDTLS_ECJPAKE_C',
278 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
279 'MBEDTLS_ECP_DP_CURVE25519_ENABLED': ['-MBEDTLS_ECDSA_C',
280 '-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'],
285 'MBEDTLS_ARIA_C': ['-MBEDTLS_CMAC_C'],
286 'MBEDTLS_CAMELLIA_C': ['-MBEDTLS_CMAC_C'],
287 'MBEDTLS_CHACHA20_C': ['-MBEDTLS_CMAC_C', '-MBEDTLS_CCM_C', '-MBEDTLS_GCM_C'],
288 'MBEDTLS_DES_C': ['-MBEDTLS_CCM_C',
289 '-MBEDTLS_GCM_C',
290 '-MBEDTLS_SSL_TICKET_C',
291 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400292}
293def handle_exclusive_groups(config_settings, symbol):
294 """For every symbol tested in an exclusive group check if there are other
295defines to be altered. """
Andrzej Kurek202932f2022-10-04 16:22:22 -0400296 for dep in EXCLUSIVE_GROUPS.get(symbol, []):
Andrzej Kurek65b2ac12022-10-14 08:09:16 -0400297 unset = dep.startswith('-')
298 dep = dep[1:]
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400299 config_settings[dep] = not unset
300
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100301def turn_off_dependencies(config_settings):
302 """For every option turned off config_settings, also turn off what depends on it.
303An option O is turned off if config_settings[O] is False."""
304 for key, value in sorted(config_settings.items()):
305 if value is not False:
306 continue
Andrzej Kurek202932f2022-10-04 16:22:22 -0400307 for dep in REVERSE_DEPENDENCIES.get(key, []):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100308 config_settings[dep] = False
309
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400310class BaseDomain: # pylint: disable=too-few-public-methods, unused-argument
311 """A base class for all domains."""
312 def __init__(self, symbols, commands, exclude):
313 """Initialize the jobs container"""
314 self.jobs = []
315
316class ExclusiveDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100317 """A domain consisting of a set of conceptually-equivalent settings.
318Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurekfe469492022-10-06 16:57:38 -0400319with this symbol set and the others unset."""
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100320 def __init__(self, symbols, commands, exclude=None):
321 """Build a domain for the specified list of configuration symbols.
Andrzej Kurekfe469492022-10-06 16:57:38 -0400322The domain contains a set of jobs that enable one of the elements
323of symbols and disable the others.
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100324Each job runs the specified commands.
325If exclude is a regular expression, skip generated jobs whose description
326would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400327 super().__init__(symbols, commands, exclude)
Andrzej Kurekfe469492022-10-06 16:57:38 -0400328 base_config_settings = {}
329 for symbol in symbols:
330 base_config_settings[symbol] = False
331 for symbol in symbols:
332 description = symbol
333 if exclude and re.match(exclude, description):
334 continue
335 config_settings = base_config_settings.copy()
336 config_settings[symbol] = True
337 handle_exclusive_groups(config_settings, symbol)
338 turn_off_dependencies(config_settings)
339 job = Job(description, config_settings, commands)
340 self.jobs.append(job)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100341
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400342class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100343 """A domain consisting of a set of loosely-related settings.
344Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400345with this symbol unset.
346If exclude is a regular expression, skip generated jobs whose description
347would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400348 def __init__(self, symbols, commands, exclude=None):
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100349 """Build a domain for the specified list of configuration symbols.
350Each job in the domain disables one of the specified symbols.
351Each job runs the specified commands."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400352 super().__init__(symbols, commands, exclude)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100353 for symbol in symbols:
354 description = '!' + symbol
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400355 if exclude and re.match(exclude, description):
356 continue
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100357 config_settings = {symbol: False}
358 turn_off_dependencies(config_settings)
359 job = Job(description, config_settings, commands)
360 self.jobs.append(job)
361
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400362class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400363 """A domain that contains both the ExclusiveDomain and BaseDomain tests.
Andrzej Kurekf4b18672022-10-14 07:57:00 -0400364Both parent class __init__ calls are performed in any order and
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400365each call adds respective jobs. The job array initialization is done once in
366BaseDomain, before the parent __init__ calls."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400367
Andrzej Kurek3322c222022-10-04 15:02:41 -0400368class CipherInfo: # pylint: disable=too-few-public-methods
Gilles Peskine34a15572019-01-29 23:12:28 +0100369 """Collect data about cipher.h."""
Andrzej Kurek3322c222022-10-04 15:02:41 -0400370 def __init__(self):
Gilles Peskine34a15572019-01-29 23:12:28 +0100371 self.base_symbols = set()
Andrzej Kurek3322c222022-10-04 15:02:41 -0400372 with open('include/mbedtls/cipher.h', encoding="utf-8") as fh:
Gilles Peskine34a15572019-01-29 23:12:28 +0100373 for line in fh:
374 m = re.match(r' *MBEDTLS_CIPHER_ID_(\w+),', line)
375 if m and m.group(1) not in ['NONE', 'NULL', '3DES']:
376 self.base_symbols.add('MBEDTLS_' + m.group(1) + '_C')
377
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100378class DomainData:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400379 """A container for domains and jobs, used to structurize testing."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100380 def config_symbols_matching(self, regexp):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400381 """List the mbedtls_config.h settings matching regexp."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100382 return [symbol for symbol in self.all_config_symbols
383 if re.match(regexp, symbol)]
384
Andrzej Kurek3f930122022-10-26 08:08:26 -0400385 def __init__(self, options, conf):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100386 """Gather data about the library and establish a list of domains to test."""
Dave Rodgman84125a12024-01-02 11:42:38 +0000387 build_command = [options.make_command, 'CFLAGS=-Werror -O2']
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100388 build_and_test = [build_command, [options.make_command, 'test']]
Andrzej Kurek3f930122022-10-26 08:08:26 -0400389 self.all_config_symbols = set(conf.settings.keys())
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100390 # Find hash modules by name.
391 hash_symbols = self.config_symbols_matching(r'MBEDTLS_(MD|RIPEMD|SHA)[0-9]+_C\Z')
392 # Find elliptic curve enabling macros by name.
393 curve_symbols = self.config_symbols_matching(r'MBEDTLS_ECP_DP_\w+_ENABLED\Z')
394 # Find key exchange enabling macros by name.
395 key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z')
Gilles Peskine34a15572019-01-29 23:12:28 +0100396 # Find cipher IDs (block permutations and stream ciphers --- chaining
397 # and padding modes are exercised separately) information by parsing
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400398 # cipher.h, as the information is not readily available in mbedtls_config.h.
Andrzej Kurek3322c222022-10-04 15:02:41 -0400399 cipher_info = CipherInfo()
Gilles Peskine34a15572019-01-29 23:12:28 +0100400 # Find block cipher chaining and padding mode enabling macros by name.
401 cipher_chaining_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_MODE_\w+\Z')
402 cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100403 self.domains = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100404 # Cipher IDs, chaining modes and padding modes. Run the test suites.
405 'cipher_id': ExclusiveDomain(cipher_info.base_symbols,
406 build_and_test),
407 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols,
408 build_and_test),
409 'cipher_padding': ExclusiveDomain(cipher_padding_symbols,
410 build_and_test),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100411 # Elliptic curves. Run the test suites.
412 'curves': ExclusiveDomain(curve_symbols, build_and_test),
Valerio Settiea8c88f2022-12-29 11:08:35 +0100413 # Hash algorithms. Excluding exclusive domains of MD, RIPEMD, SHA1,
414 # SHA224 and SHA384 because MBEDTLS_ENTROPY_C is extensively used
415 # across various modules, but it depends on either SHA256 or SHA512.
416 # As a consequence an "exclusive" test of anything other than SHA256
417 # or SHA512 with MBEDTLS_ENTROPY_C enabled is not possible.
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400418 'hashes': DualDomain(hash_symbols, build_and_test,
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400419 exclude=r'MBEDTLS_(MD|RIPEMD|SHA1_)' \
Valerio Settib6bf7dc2022-12-22 14:28:03 +0100420 '|MBEDTLS_SHA224_' \
Pol Henarejosaa426e02023-02-08 12:52:10 +0100421 '|MBEDTLS_SHA384_' \
422 '|MBEDTLS_SHA3_'),
Andrzej Kurek98682b52023-01-23 06:16:23 -0500423 # Key exchange types.
Andrzej Kurek1ff73362022-11-02 04:50:16 -0400424 'kex': ExclusiveDomain(key_exchange_symbols, build_and_test),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100425 'pkalgs': ComplementaryDomain(['MBEDTLS_ECDSA_C',
426 'MBEDTLS_ECP_C',
427 'MBEDTLS_PKCS1_V21',
428 'MBEDTLS_PKCS1_V15',
429 'MBEDTLS_RSA_C',
430 'MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
431 build_and_test),
432 }
433 self.jobs = {}
434 for domain in self.domains.values():
435 for job in domain.jobs:
436 self.jobs[job.name] = job
437
438 def get_jobs(self, name):
439 """Return the list of jobs identified by the given name.
440A name can either be the name of a domain or the name of one specific job."""
441 if name in self.domains:
442 return sorted(self.domains[name].jobs, key=lambda job: job.name)
443 else:
444 return [self.jobs[name]]
445
Andrzej Kurek3f930122022-10-26 08:08:26 -0400446def run(options, job, conf, colors=NO_COLORS):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100447 """Run the specified job (a Job instance)."""
448 subprocess.check_call([options.make_command, 'clean'])
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100449 job.announce(colors, None)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400450 if not job.configure(conf, options, colors):
451 job.announce(colors, False)
452 return False
453 conf.write()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100454 success = job.test(options)
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100455 job.announce(colors, success)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100456 return success
457
Andrzej Kurek3f930122022-10-26 08:08:26 -0400458def run_tests(options, domain_data, conf):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100459 """Run the desired jobs.
460domain_data should be a DomainData instance that describes the available
461domains and jobs.
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400462Run the jobs listed in options.tasks."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100463 if not hasattr(options, 'config_backup'):
464 options.config_backup = options.config + '.bak'
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100465 colors = Colors(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100466 jobs = []
467 failures = []
468 successes = []
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400469 for name in options.tasks:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100470 jobs += domain_data.get_jobs(name)
471 backup_config(options)
472 try:
473 for job in jobs:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400474 success = run(options, job, conf, colors=colors)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100475 if not success:
476 if options.keep_going:
477 failures.append(job.name)
478 else:
479 return False
480 else:
481 successes.append(job.name)
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100482 restore_config(options)
483 except:
484 # Restore the configuration, except in stop-on-error mode if there
485 # was an error, where we leave the failing configuration up for
486 # developer convenience.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100487 if options.keep_going:
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100488 restore_config(options)
489 raise
Gilles Peskinee85163b2019-01-29 18:50:03 +0100490 if successes:
491 log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100492 if failures:
Gilles Peskinee85163b2019-01-29 18:50:03 +0100493 log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100494 return False
495 else:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100496 return True
497
Andrzej Kurek3322c222022-10-04 15:02:41 -0400498def main():
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100499 try:
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400500 parser = argparse.ArgumentParser(
501 formatter_class=argparse.RawDescriptionHelpFormatter,
502 description=
503 "Test Mbed TLS with a subset of algorithms.\n\n"
504 "Example usage:\n"
Andrzej Kurek629c4122022-10-17 08:34:40 -0400505 r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA256_C""\n"
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400506 "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n"
507 "./tests/scripts/depends.py cipher_id cipher_chaining\n")
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100508 parser.add_argument('--color', metavar='WHEN',
509 help='Colorize the output (always/auto/never)',
510 choices=['always', 'auto', 'never'], default='auto')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100511 parser.add_argument('-c', '--config', metavar='FILE',
512 help='Configuration file to modify',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400513 default='include/mbedtls/mbedtls_config.h')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100514 parser.add_argument('-C', '--directory', metavar='DIR',
515 help='Change to this directory before anything else',
516 default='.')
517 parser.add_argument('-k', '--keep-going',
518 help='Try all configurations even if some fail (default)',
519 action='store_true', dest='keep_going', default=True)
520 parser.add_argument('-e', '--no-keep-going',
521 help='Stop as soon as a configuration fails',
522 action='store_false', dest='keep_going')
523 parser.add_argument('--list-jobs',
524 help='List supported jobs and exit',
525 action='append_const', dest='list', const='jobs')
526 parser.add_argument('--list-domains',
527 help='List supported domains and exit',
528 action='append_const', dest='list', const='domains')
529 parser.add_argument('--make-command', metavar='CMD',
530 help='Command to run instead of make (e.g. gmake)',
531 action='store', default='make')
Andrzej Kurek2c7993c2022-10-24 10:41:20 -0400532 parser.add_argument('--unset-use-psa',
533 help='Unset MBEDTLS_USE_PSA_CRYPTO before any test',
534 action='store_true', dest='unset_use_psa')
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400535 parser.add_argument('tasks', metavar='TASKS', nargs='*',
536 help='The domain(s) or job(s) to test (default: all).',
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100537 default=True)
538 options = parser.parse_args()
539 os.chdir(options.directory)
Gabor Mezei6f90e792024-09-03 16:58:25 +0200540 conf = config.MbedTLSConfig(options.config)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400541 domain_data = DomainData(options, conf)
542
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400543 if options.tasks is True:
544 options.tasks = sorted(domain_data.domains.keys())
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100545 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 Kurek3f930122022-10-26 08:08:26 -0400551 sys.exit(0 if run_tests(options, domain_data, conf) else 1)
Andrzej Kurek3322c222022-10-04 15:02:41 -0400552 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()