blob: 7fccb2006f1df2816ee1a7ee5d3566bd4c14c56b [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
Gabor Mezei4e10d6c2024-08-03 14:26:13 +020058from mbedtls_framework import c_build_helper
Gabor Mezei402381d2024-09-24 19:46:54 +020059from mbedtls_framework import crypto_knowledge
60from mbedtls_framework import psa_information
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010061
Andrzej Kurek3322c222022-10-04 15:02:41 -040062class Colors: # pylint: disable=too-few-public-methods
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010063 """Minimalistic support for colored output.
64Each field of an object of this class is either None if colored output
65is not possible or not desired, or a pair of strings (start, stop) such
66that outputting start switches the text color to the desired color and
67stop switches the text color back to the default."""
68 red = None
69 green = None
Andrzej Kurek3f930122022-10-26 08:08:26 -040070 cyan = None
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010071 bold_red = None
72 bold_green = None
73 def __init__(self, options=None):
Andrzej Kurek3322c222022-10-04 15:02:41 -040074 """Initialize color profile according to passed options."""
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010075 if not options or options.color in ['no', 'never']:
76 want_color = False
77 elif options.color in ['yes', 'always']:
78 want_color = True
79 else:
80 want_color = sys.stderr.isatty()
81 if want_color:
82 # Assume ANSI compatible terminal
83 normal = '\033[0m'
84 self.red = ('\033[31m', normal)
85 self.green = ('\033[32m', normal)
Andrzej Kurek3f930122022-10-26 08:08:26 -040086 self.cyan = ('\033[36m', normal)
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010087 self.bold_red = ('\033[1;31m', normal)
88 self.bold_green = ('\033[1;32m', normal)
89NO_COLORS = Colors(None)
90
91def log_line(text, prefix='depends.py:', suffix='', color=None):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010092 """Print a status message."""
Andrzej Kurek3322c222022-10-04 15:02:41 -040093 if color is not None:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010094 prefix = color[0] + prefix
95 suffix = suffix + color[1]
96 sys.stderr.write(prefix + ' ' + text + suffix + '\n')
Gilles Peskine46c82562019-01-29 18:42:55 +010097 sys.stderr.flush()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010098
Gilles Peskine54aa5c62019-01-29 18:46:34 +010099def log_command(cmd):
100 """Print a trace of the specified command.
101cmd is a list of strings: a command name and its arguments."""
102 log_line(' '.join(cmd), prefix='+')
103
Andrzej Kurek3f930122022-10-26 08:08:26 -0400104def option_exists(conf, option):
Andrzej Kurek81cf5ad2023-02-06 10:48:43 +0100105 return option in conf.settings
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100106
Andrzej Kurek576803f2023-01-24 07:40:42 -0500107def set_config_option_value(conf, option, colors, value: Union[bool, str]):
108 """Set/unset a configuration option, optionally specifying a value.
109value can be either True/False (set/unset config option), or a string,
110which will make a symbol defined with a certain value."""
Andrzej Kurek3f930122022-10-26 08:08:26 -0400111 if not option_exists(conf, option):
Ronald Crond5da0202025-07-02 09:12:50 +0200112 if value is False:
Ronald Cron50f99ca2025-07-15 09:32:03 +0200113 log_line(
114 f'Warning, disabling {option} that does not exist in {conf.filename}',
115 color=colors.cyan
116 )
Ronald Crond5da0202025-07-02 09:12:50 +0200117 return True
Andrzej Kurek3f930122022-10-26 08:08:26 -0400118 log_line('Symbol {} was not found in {}'.format(option, conf.filename), color=colors.red)
119 return False
Andrzej Kurek3f930122022-10-26 08:08:26 -0400120
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500121 if value is False:
122 log_command(['config.py', 'unset', option])
123 conf.unset(option)
Andrzej Kurek72082dc2023-02-06 10:49:46 +0100124 elif value is True:
125 log_command(['config.py', 'set', option])
126 conf.set(option)
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500127 else:
Andrzej Kurek72082dc2023-02-06 10:49:46 +0100128 log_command(['config.py', 'set', option, value])
129 conf.set(option, value)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400130 return True
131
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200132def set_reference_config(conf, colors):
Andrzej Kurek3322c222022-10-04 15:02:41 -0400133 """Change the library configuration file (mbedtls_config.h) to the reference state.
134The reference state is the one from which the tested configurations are
135derived."""
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400136 # Turn off options that are not relevant to the tests and slow them down.
Andrzej Kurek3f930122022-10-26 08:08:26 -0400137 log_command(['config.py', 'full'])
138 conf.adapt(config.full_adapter)
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500139 set_config_option_value(conf, 'MBEDTLS_TEST_HOOKS', colors, False)
Andrzej Kurek3322c222022-10-04 15:02:41 -0400140
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100141class Job:
142 """A job builds the library in a specific configuration and runs some tests."""
143 def __init__(self, name, config_settings, commands):
144 """Build a job object.
145The job uses the configuration described by config_settings. This is a
146dictionary where the keys are preprocessor symbols and the values are
147booleans or strings. A boolean indicates whether or not to #define the
148symbol. With a string, the symbol is #define'd to that value.
149After setting the configuration, the job runs the programs specified by
150commands. This is a list of lists of strings; each list of string is a
151command name and its arguments and is passed to subprocess.call with
152shell=False."""
153 self.name = name
154 self.config_settings = config_settings
155 self.commands = commands
156
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100157 def announce(self, colors, what):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100158 '''Announce the start or completion of a job.
159If what is None, announce the start of the job.
160If what is True, announce that the job has passed.
161If what is False, announce that the job has failed.'''
162 if what is True:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100163 log_line(self.name + ' PASSED', color=colors.green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100164 elif what is False:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100165 log_line(self.name + ' FAILED', color=colors.red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100166 else:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400167 log_line('starting ' + self.name, color=colors.cyan)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100168
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200169 def configure(self, conf, colors):
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400170 '''Set library configuration options as required for the job.'''
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200171 set_reference_config(conf, colors)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100172 for key, value in sorted(self.config_settings.items()):
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500173 ret = set_config_option_value(conf, key, colors, value)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400174 if ret is False:
175 return False
176 return True
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100177
Gabor Mezei4e10d6c2024-08-03 14:26:13 +0200178 def _consistency_check(self):
179 '''Check if the testable option is consistent with the goal.
180
181 The purpose of this function to ensure that every option is set or unset according to
182 the settings.
183 '''
184 log_command(['consistency check'])
185 c_name = None
186 exe_name = None
187 header = '#include "mbedtls/build_info.h"\n'
188
189 # Generate a C error directive for each setting to test if it is active
190 for option, value in sorted(self.config_settings.items()):
191 header += '#if '
192 if value:
193 header += '!'
Gabor Mezeic9f01cf2024-09-26 13:02:01 +0200194 header += f'defined({option})\n'
195 header += f'#error "{option}"\n'
Gabor Mezei4e10d6c2024-08-03 14:26:13 +0200196 header += '#endif\n'
197 include_path = ['include', 'tf-psa-crypto/include',
198 'tf-psa-crypto/drivers/builtin/include']
199
200 try:
201 # Generate a C file, build and run it
202 c_file, c_name, exe_name = c_build_helper.create_c_file(self.name)
203 c_build_helper.generate_c_file(c_file, 'depends.py', header, lambda x: '')
204 c_file.close()
205 c_build_helper.compile_c_file(c_name, exe_name, include_path)
Gabor Mezei4e10d6c2024-08-03 14:26:13 +0200206 return True
207
208 except c_build_helper.CompileError as e:
209 # Read the command line output to find out which setting has been failed
210 failed = {m.group(1) for m in re.finditer('.*#error "(.*)"', e.message) if m}
211 log_line('Inconsistent config option(s):')
212 for option in sorted(failed):
213 log_line(' ' + option)
Gabor Mezei4e10d6c2024-08-03 14:26:13 +0200214 return False
215
216 finally:
217 c_build_helper.remove_file_if_exists(c_name)
218 c_build_helper.remove_file_if_exists(exe_name)
219
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100220 def test(self, options):
221 '''Run the job's build and test commands.
222Return True if all the commands succeed and False otherwise.
223If options.keep_going is false, stop as soon as one command fails. Otherwise
224run all the commands, except that if the first command fails, none of the
225other commands are run (typically, the first command is a build command
226and subsequent commands are tests that cannot run if the build failed).'''
Gabor Mezei4e10d6c2024-08-03 14:26:13 +0200227 if not self._consistency_check():
228 return False
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100229 built = False
230 success = True
231 for command in self.commands:
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100232 log_command(command)
Gilles Peskine35cb3192024-02-12 14:16:05 +0100233 env = os.environ.copy()
234 if 'MBEDTLS_TEST_CONFIGURATION' in env:
235 env['MBEDTLS_TEST_CONFIGURATION'] += '-' + self.name
236 ret = subprocess.call(command, env=env)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100237 if ret != 0:
238 if command[0] not in ['make', options.make_command]:
239 log_line('*** [{}] Error {}'.format(' '.join(command), ret))
240 if not options.keep_going or not built:
241 return False
242 success = False
243 built = True
244 return success
245
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100246# If the configuration option A requires B, make sure that
Andrzej Kurek202932f2022-10-04 16:22:22 -0400247# B in REVERSE_DEPENDENCIES[A].
Gabor Mezei610e6e22024-08-03 14:33:21 +0200248# All the information here should be contained in check_config.h or check_crypto_config.h.
249# This file includes a copy because it changes rarely and it would be a pain
Gilles Peskine584c24a2019-01-29 19:30:40 +0100250# to extract automatically.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400251REVERSE_DEPENDENCIES = {
Gabor Mezeib50043b2024-06-18 20:30:36 +0200252 'PSA_WANT_KEY_TYPE_AES': ['PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128',
253 'MBEDTLS_CTR_DRBG_C',
Gabor Mezeie6cfa3b2024-11-04 17:32:34 +0100254 'MBEDTLS_NIST_KW_C',
255 'MBEDTLS_AES_C'],
256 'PSA_WANT_KEY_TYPE_ARIA': ['MBEDTLS_ARIA_C'],
257 'PSA_WANT_KEY_TYPE_CAMELLIA': ['MBEDTLS_CAMELLIA_C'],
Gabor Mezeib50043b2024-06-18 20:30:36 +0200258 'PSA_WANT_KEY_TYPE_CHACHA20': ['PSA_WANT_ALG_CHACHA20_POLY1305',
Gabor Mezeie6cfa3b2024-11-04 17:32:34 +0100259 'PSA_WANT_ALG_STREAM_CIPHER',
260 'MBEDTLS_CHACHA20_C',
261 'MBEDTLS_CHACHAPOLY_C'],
262 'PSA_WANT_KEY_TYPE_DES': ['MBEDTLS_DES_C'],
263 'PSA_WANT_ALG_CCM': ['PSA_WANT_ALG_CCM_STAR_NO_TAG',
264 'MBEDTLS_CCM_C'],
265 'PSA_WANT_ALG_CMAC': ['PSA_WANT_ALG_PBKDF2_AES_CMAC_PRF_128',
266 'MBEDTLS_CMAC_C'],
267 'PSA_WANT_ALG_GCM': ['MBEDTLS_GCM_C'],
Gabor Mezei610e6e22024-08-03 14:33:21 +0200268
Gabor Mezeie191c032024-10-30 17:20:23 +0100269 'PSA_WANT_ALG_CBC_NO_PADDING': ['MBEDTLS_CIPHER_MODE_CBC'],
270 'PSA_WANT_ALG_CBC_PKCS7': ['MBEDTLS_CIPHER_MODE_CBC'],
271 'PSA_WANT_ALG_CFB': ['MBEDTLS_CIPHER_MODE_CFB'],
272 'PSA_WANT_ALG_CTR': ['MBEDTLS_CIPHER_MODE_CTR'],
273 'PSA_WANT_ALG_OFB': ['MBEDTLS_CIPHER_MODE_OFB'],
Gabor Mezei655c4872024-11-12 18:04:19 +0100274 'PSA_WANT_ALG_XTS': ['MBEDTLS_CIPHER_MODE_XTS'],
Gabor Mezei610e6e22024-08-03 14:33:21 +0200275
Gabor Mezei8f944852024-09-12 16:24:38 +0200276 'MBEDTLS_CIPHER_PADDING_PKCS7': ['MBEDTLS_PKCS5_C',
277 'MBEDTLS_PKCS12_C',
278 'PSA_WANT_ALG_CBC_PKCS7'],
Gabor Mezei242806a2024-11-06 16:17:19 +0100279 'MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS': ['MBEDTLS_CIPHER_MODE_CBC'],
280 'MBEDTLS_CIPHER_PADDING_ZEROS': ['MBEDTLS_CIPHER_MODE_CBC'],
281 'MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN': ['MBEDTLS_CIPHER_MODE_CBC'],
Gabor Mezei610e6e22024-08-03 14:33:21 +0200282
Gabor Mezei1c49cff2024-09-23 14:38:59 +0200283 'PSA_WANT_ECC_BRAINPOOL_P_R1_256': ['MBEDTLS_ECP_DP_BP256R1_ENABLED'],
284 'PSA_WANT_ECC_BRAINPOOL_P_R1_384': ['MBEDTLS_ECP_DP_BP384R1_ENABLED'],
285 'PSA_WANT_ECC_BRAINPOOL_P_R1_512': ['MBEDTLS_ECP_DP_BP512R1_ENABLED'],
286 'PSA_WANT_ECC_MONTGOMERY_255': ['MBEDTLS_ECP_DP_CURVE25519_ENABLED'],
287 'PSA_WANT_ECC_MONTGOMERY_448': ['MBEDTLS_ECP_DP_CURVE448_ENABLED'],
288 'PSA_WANT_ECC_SECP_R1_192': ['MBEDTLS_ECP_DP_SECP192R1_ENABLED'],
289 'PSA_WANT_ECC_SECP_R1_224': ['MBEDTLS_ECP_DP_SECP224R1_ENABLED'],
Gabor Mezeif13fd1e2024-09-25 15:49:09 +0200290 'PSA_WANT_ECC_SECP_R1_256': ['PSA_WANT_ALG_JPAKE',
Gabor Mezei1c49cff2024-09-23 14:38:59 +0200291 'MBEDTLS_ECP_DP_SECP256R1_ENABLED'],
292 'PSA_WANT_ECC_SECP_R1_384': ['MBEDTLS_ECP_DP_SECP384R1_ENABLED'],
Gabor Mezei1c49cff2024-09-23 14:38:59 +0200293 'PSA_WANT_ECC_SECP_R1_521': ['MBEDTLS_ECP_DP_SECP521R1_ENABLED'],
294 'PSA_WANT_ECC_SECP_K1_192': ['MBEDTLS_ECP_DP_SECP192K1_ENABLED'],
Gabor Mezei1c49cff2024-09-23 14:38:59 +0200295 'PSA_WANT_ECC_SECP_K1_256': ['MBEDTLS_ECP_DP_SECP256K1_ENABLED'],
Gabor Mezei610e6e22024-08-03 14:33:21 +0200296
Gabor Mezeif13fd1e2024-09-25 15:49:09 +0200297 'PSA_WANT_ALG_ECDSA': ['PSA_WANT_ALG_DETERMINISTIC_ECDSA',
298 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
299 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
300 'MBEDTLS_ECDSA_C'],
301 'PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC': [
302 'PSA_WANT_ALG_ECDSA',
303 'PSA_WANT_ALG_ECDH', 'MBEDTLS_ECDH_C',
304 'PSA_WANT_ALG_JPAKE',
305 'PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY',
306 'PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT',
307 'PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT',
308 'PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE',
309 'PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE',
310 'MBEDTLS_ECP_RESTARTABLE',
311 'MBEDTLS_PK_PARSE_EC_EXTENDED',
312 'MBEDTLS_PK_PARSE_EC_COMPRESSED',
313 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED',
314 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED',
315 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
316 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED',
317 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED',
318 'MBEDTLS_ECP_C'],
319 'PSA_WANT_ALG_JPAKE': ['MBEDTLS_ECJPAKE_C',
320 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
321 'PSA_WANT_ALG_RSA_OAEP': ['PSA_WANT_ALG_RSA_PSS',
322 'MBEDTLS_X509_RSASSA_PSS_SUPPORT',
323 'MBEDTLS_PKCS1_V21'],
324 'PSA_WANT_ALG_RSA_PKCS1V15_CRYPT': ['PSA_WANT_ALG_RSA_PKCS1V15_SIGN',
325 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
326 'MBEDTLS_PKCS1_V15'],
327 'PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC': [
328 'PSA_WANT_ALG_RSA_PKCS1V15_CRYPT',
329 'PSA_WANT_ALG_RSA_OAEP',
330 'PSA_WANT_KEY_TYPE_RSA_PUBLIC_KEY',
331 'PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_IMPORT',
332 'PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_EXPORT',
333 'PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_GENERATE',
334 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED',
335 'MBEDTLS_RSA_C'],
Gabor Mezei610e6e22024-08-03 14:33:21 +0200336
Gabor Mezeief013a62024-09-24 14:12:43 +0200337 'PSA_WANT_ALG_MD5': ['MBEDTLS_MD5_C'],
338 'PSA_WANT_ALG_RIPEMD160': ['MBEDTLS_RIPEMD160_C'],
339 'PSA_WANT_ALG_SHA_1': ['MBEDTLS_SHA1_C'],
340 'PSA_WANT_ALG_SHA_224': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
341 'MBEDTLS_ENTROPY_FORCE_SHA256',
342 'MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT',
343 'MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY',
344 'MBEDTLS_SHA224_C'],
345 'PSA_WANT_ALG_SHA_256': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
346 'MBEDTLS_ENTROPY_FORCE_SHA256',
347 'MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT',
348 'MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY',
349 'MBEDTLS_LMS_C',
350 'MBEDTLS_LMS_PRIVATE',
351 'MBEDTLS_SHA256_C',
352 'PSA_WANT_ALG_TLS12_ECJPAKE_TO_PMS'],
353 'PSA_WANT_ALG_SHA_384': ['MBEDTLS_SHA384_C'],
354 'PSA_WANT_ALG_SHA_512': ['MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT',
355 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY',
356 'MBEDTLS_SHA512_C'],
Ben Taylor1948c942025-03-04 09:11:11 +0000357 'PSA_WANT_ALG_ECB_NO_PADDING' : ['MBEDTLS_NIST_KW_C'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100358}
359
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400360# If an option is tested in an exclusive test, alter the following defines.
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400361# These are not necessarily dependencies, but just minimal required changes
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400362# if a given define is the only one enabled from an exclusive group.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400363EXCLUSIVE_GROUPS = {
Gabor Mezeief013a62024-09-24 14:12:43 +0200364 'PSA_WANT_ALG_SHA_512': ['-MBEDTLS_SSL_COOKIE_C',
365 '-MBEDTLS_SSL_TLS_C'],
Gabor Mezeif13fd1e2024-09-25 15:49:09 +0200366 'PSA_WANT_ECC_MONTGOMERY_448': ['-PSA_WANT_ALG_ECDSA',
367 '-PSA_WANT_ALG_JPAKE',],
368 'PSA_WANT_ECC_MONTGOMERY_255': ['-PSA_WANT_ALG_ECDSA',
369 '-PSA_WANT_ALG_JPAKE'],
Gabor Mezeib50043b2024-06-18 20:30:36 +0200370 'PSA_WANT_KEY_TYPE_ARIA': ['-PSA_WANT_ALG_CMAC',
371 '-PSA_WANT_ALG_CCM',
372 '-PSA_WANT_ALG_GCM',
373 '-MBEDTLS_SSL_TICKET_C',
374 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION'],
375 'PSA_WANT_KEY_TYPE_CAMELLIA': ['-PSA_WANT_ALG_CMAC'],
376 'PSA_WANT_KEY_TYPE_CHACHA20': ['-PSA_WANT_ALG_CMAC',
377 '-PSA_WANT_ALG_CCM',
378 '-PSA_WANT_ALG_GCM',
379 '-PSA_WANT_ALG_ECB_NO_PADDING'],
380 'PSA_WANT_KEY_TYPE_DES': ['-PSA_WANT_ALG_CCM',
381 '-PSA_WANT_ALG_GCM',
382 '-MBEDTLS_SSL_TICKET_C',
383 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400384}
385def handle_exclusive_groups(config_settings, symbol):
386 """For every symbol tested in an exclusive group check if there are other
387defines to be altered. """
Andrzej Kurek202932f2022-10-04 16:22:22 -0400388 for dep in EXCLUSIVE_GROUPS.get(symbol, []):
Andrzej Kurek65b2ac12022-10-14 08:09:16 -0400389 unset = dep.startswith('-')
390 dep = dep[1:]
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400391 config_settings[dep] = not unset
392
Gabor Mezei95be5fb2024-10-30 17:21:49 +0100393def turn_off_dependencies(config_settings, exclude=None):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100394 """For every option turned off config_settings, also turn off what depends on it.
Gabor Mezeifb061012024-09-24 18:58:14 +0200395
396 An option O is turned off if config_settings[O] is False.
397 Handle the dependencies recursively.
Gabor Mezei95be5fb2024-10-30 17:21:49 +0100398
Gabor Mezei6763a552024-11-12 18:07:42 +0100399 If 'exclude' is a symbol, ensure its dependencies are not turned off while dependencies
400 of other settings are turned off.
Gabor Mezeifb061012024-09-24 18:58:14 +0200401 """
Gabor Mezei95be5fb2024-10-30 17:21:49 +0100402
Gabor Mezei6763a552024-11-12 18:07:42 +0100403 # Determine recursively the settings that should not be turned off for the sake of 'exclude'.
Gabor Mezei95be5fb2024-10-30 17:21:49 +0100404 excludes = set()
405 if exclude:
Gabor Mezeiaf198c22024-11-12 18:03:33 +0100406 revdep = set(REVERSE_DEPENDENCIES.get(exclude, []))
407 while revdep:
408 dep = revdep.pop()
Gabor Mezei95be5fb2024-10-30 17:21:49 +0100409 excludes.add(dep)
Gabor Mezeiaf198c22024-11-12 18:03:33 +0100410 revdep.update(set(REVERSE_DEPENDENCIES.get(dep, [])) - excludes)
Gabor Mezei95be5fb2024-10-30 17:21:49 +0100411
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100412 for key, value in sorted(config_settings.items()):
413 if value is not False:
414 continue
Gabor Mezeifb061012024-09-24 18:58:14 +0200415
Gabor Mezei95be5fb2024-10-30 17:21:49 +0100416 # Save the processed settings to handle cross referencies.
Gabor Mezei6763a552024-11-12 18:07:42 +0100417 # Start with set of settings that we do not want to turn off.
Gabor Mezei95be5fb2024-10-30 17:21:49 +0100418 history = excludes.copy()
419 revdep = set(REVERSE_DEPENDENCIES.get(key, [])) - excludes
Gabor Mezei8ec990b2024-07-31 17:14:04 +0200420 while revdep:
421 dep = revdep.pop()
Gabor Mezeifb061012024-09-24 18:58:14 +0200422 history.add(dep)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100423 config_settings[dep] = False
Gabor Mezeifb061012024-09-24 18:58:14 +0200424 # Do not add symbols which are already processed
425 revdep.update(set(REVERSE_DEPENDENCIES.get(dep, [])) - history)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100426
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400427class BaseDomain: # pylint: disable=too-few-public-methods, unused-argument
428 """A base class for all domains."""
429 def __init__(self, symbols, commands, exclude):
430 """Initialize the jobs container"""
431 self.jobs = []
432
433class ExclusiveDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100434 """A domain consisting of a set of conceptually-equivalent settings.
435Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurekfe469492022-10-06 16:57:38 -0400436with this symbol set and the others unset."""
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100437 def __init__(self, symbols, commands, exclude=None):
438 """Build a domain for the specified list of configuration symbols.
Andrzej Kurekfe469492022-10-06 16:57:38 -0400439The domain contains a set of jobs that enable one of the elements
440of symbols and disable the others.
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100441Each job runs the specified commands.
442If exclude is a regular expression, skip generated jobs whose description
443would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400444 super().__init__(symbols, commands, exclude)
Andrzej Kurekfe469492022-10-06 16:57:38 -0400445 base_config_settings = {}
446 for symbol in symbols:
447 base_config_settings[symbol] = False
448 for symbol in symbols:
449 description = symbol
450 if exclude and re.match(exclude, description):
451 continue
452 config_settings = base_config_settings.copy()
453 config_settings[symbol] = True
454 handle_exclusive_groups(config_settings, symbol)
Gabor Mezei95be5fb2024-10-30 17:21:49 +0100455 turn_off_dependencies(config_settings, symbol)
Andrzej Kurekfe469492022-10-06 16:57:38 -0400456 job = Job(description, config_settings, commands)
457 self.jobs.append(job)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100458
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400459class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100460 """A domain consisting of a set of loosely-related settings.
461Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400462with this symbol unset.
463If exclude is a regular expression, skip generated jobs whose description
464would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400465 def __init__(self, symbols, commands, exclude=None):
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100466 """Build a domain for the specified list of configuration symbols.
467Each job in the domain disables one of the specified symbols.
468Each job runs the specified commands."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400469 super().__init__(symbols, commands, exclude)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100470 for symbol in symbols:
471 description = '!' + symbol
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400472 if exclude and re.match(exclude, description):
473 continue
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100474 config_settings = {symbol: False}
475 turn_off_dependencies(config_settings)
476 job = Job(description, config_settings, commands)
477 self.jobs.append(job)
478
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400479class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400480 """A domain that contains both the ExclusiveDomain and BaseDomain tests.
Andrzej Kurekf4b18672022-10-14 07:57:00 -0400481Both parent class __init__ calls are performed in any order and
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400482each call adds respective jobs. The job array initialization is done once in
483BaseDomain, before the parent __init__ calls."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400484
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100485class DomainData:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400486 """A container for domains and jobs, used to structurize testing."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100487 def config_symbols_matching(self, regexp):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400488 """List the mbedtls_config.h settings matching regexp."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100489 return [symbol for symbol in self.all_config_symbols
490 if re.match(regexp, symbol)]
491
Gabor Mezeibd8e8182024-11-06 11:23:23 +0100492 # pylint: disable=too-many-locals
Andrzej Kurek3f930122022-10-26 08:08:26 -0400493 def __init__(self, options, conf):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100494 """Gather data about the library and establish a list of domains to test."""
Dave Rodgman84125a12024-01-02 11:42:38 +0000495 build_command = [options.make_command, 'CFLAGS=-Werror -O2']
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100496 build_and_test = [build_command, [options.make_command, 'test']]
Andrzej Kurek3f930122022-10-26 08:08:26 -0400497 self.all_config_symbols = set(conf.settings.keys())
Gabor Mezei402381d2024-09-24 19:46:54 +0200498 psa_info = psa_information.Information().constructors
499 algs = {crypto_knowledge.Algorithm(alg): symbol
500 for alg, symbol in ((alg, psa_information.psa_want_symbol(alg))
501 for alg in psa_info.algorithms)
502 if symbol in self.all_config_symbols}
Gabor Mezei06a060d2024-11-04 17:36:22 +0100503 cipher_algs = {alg
504 for alg in algs
505 if alg.can_do(crypto_knowledge.AlgorithmCategory.CIPHER)}
Gabor Mezei03cc5922024-11-04 17:28:46 +0100506 key_types = {crypto_knowledge.KeyType(expr): symbol
507 for key_type in psa_info.key_types
508 for expr, symbol in ((expr, psa_information.psa_want_symbol(key_type))
509 for expr in psa_info.generate_expressions([key_type]))
510 if symbol in self.all_config_symbols}
Gabor Mezei402381d2024-09-24 19:46:54 +0200511
Gabor Mezeief013a62024-09-24 14:12:43 +0200512 # Find hash modules by category.
513 hash_symbols = {symbol
514 for alg, symbol in algs.items()
515 if alg.can_do(crypto_knowledge.AlgorithmCategory.HASH)}
Gabor Mezei1c49cff2024-09-23 14:38:59 +0200516
Gabor Mezeief013a62024-09-24 14:12:43 +0200517 # Find elliptic curve enabling macros by name.
Gabor Mezei7554eea2025-01-27 11:17:10 +0100518 # MBEDTLS_ECP_DP_SECP224K1_ENABLED added to disable it for all curves
519 curve_symbols = self.config_symbols_matching(r'PSA_WANT_ECC_\w+\Z|'
520 r'MBEDTLS_ECP_DP_SECP224K1_ENABLED')
Gabor Mezei1c49cff2024-09-23 14:38:59 +0200521
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100522 # Find key exchange enabling macros by name.
523 key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z')
Gabor Mezeib50043b2024-06-18 20:30:36 +0200524
Gabor Mezeifb6b0db2024-11-04 17:30:32 +0100525 # Find cipher key types
526 cipher_key_types = {symbol
527 for key_type, symbol in key_types.items()
528 for alg in cipher_algs
529 if key_type.can_do(alg)}
Gabor Mezei6f77baf2024-09-20 14:18:42 +0200530
Gabor Mezei5a610862024-10-30 17:19:00 +0100531 # Get cipher modes
532 cipher_chaining_symbols = {algs[cipher_alg] for cipher_alg in cipher_algs}
Gabor Mezei6f77baf2024-09-20 14:18:42 +0200533
534 # Find block padding mode enabling macros by name.
Gilles Peskine34a15572019-01-29 23:12:28 +0100535 cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z')
Gabor Mezei6f77baf2024-09-20 14:18:42 +0200536
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100537 self.domains = {
Gabor Mezeifb6b0db2024-11-04 17:30:32 +0100538 # Cipher key types
539 'cipher_id': ExclusiveDomain(cipher_key_types, build_and_test),
Gabor Mezei6f77baf2024-09-20 14:18:42 +0200540
Gabor Mezeia5f35292024-10-30 17:30:25 +0100541 # XTS is not yet supported via the PSA API.
542 # See https://github.com/Mbed-TLS/mbedtls/issues/6384
Gilles Peskine34a15572019-01-29 23:12:28 +0100543 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols,
Gabor Mezei6f77baf2024-09-20 14:18:42 +0200544 build_and_test,
545 exclude=r'PSA_WANT_ALG_XTS'),
546
Gilles Peskine34a15572019-01-29 23:12:28 +0100547 'cipher_padding': ExclusiveDomain(cipher_padding_symbols,
548 build_and_test),
Gabor Mezei1c49cff2024-09-23 14:38:59 +0200549
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100550 # Elliptic curves. Run the test suites.
Gabor Mezeief013a62024-09-24 14:12:43 +0200551 'curves': ExclusiveDomain(curve_symbols, build_and_test),
Gabor Mezei069e3e62025-01-10 17:44:41 +0100552
Gabor Mezeief013a62024-09-24 14:12:43 +0200553 # Hash algorithms. Excluding exclusive domains of MD, RIPEMD, SHA1, SHA3*,
Valerio Settiea8c88f2022-12-29 11:08:35 +0100554 # SHA224 and SHA384 because MBEDTLS_ENTROPY_C is extensively used
555 # across various modules, but it depends on either SHA256 or SHA512.
556 # As a consequence an "exclusive" test of anything other than SHA256
557 # or SHA512 with MBEDTLS_ENTROPY_C enabled is not possible.
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400558 'hashes': DualDomain(hash_symbols, build_and_test,
Gabor Mezeief013a62024-09-24 14:12:43 +0200559 exclude=r'PSA_WANT_ALG_(?!SHA_(256|512))'),
560
Andrzej Kurek98682b52023-01-23 06:16:23 -0500561 # Key exchange types.
Andrzej Kurek1ff73362022-11-02 04:50:16 -0400562 'kex': ExclusiveDomain(key_exchange_symbols, build_and_test),
Gabor Mezeif13fd1e2024-09-25 15:49:09 +0200563
564 'pkalgs': ComplementaryDomain(['PSA_WANT_ALG_ECDSA',
565 'PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC',
566 'PSA_WANT_ALG_RSA_OAEP',
567 'PSA_WANT_ALG_RSA_PKCS1V15_CRYPT',
568 'PSA_WANT_KEY_TYPE_RSA_KEY_PAIR_BASIC',
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100569 'MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
570 build_and_test),
571 }
572 self.jobs = {}
573 for domain in self.domains.values():
574 for job in domain.jobs:
575 self.jobs[job.name] = job
576
577 def get_jobs(self, name):
578 """Return the list of jobs identified by the given name.
579A name can either be the name of a domain or the name of one specific job."""
580 if name in self.domains:
581 return sorted(self.domains[name].jobs, key=lambda job: job.name)
582 else:
583 return [self.jobs[name]]
584
Andrzej Kurek3f930122022-10-26 08:08:26 -0400585def run(options, job, conf, colors=NO_COLORS):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100586 """Run the specified job (a Job instance)."""
587 subprocess.check_call([options.make_command, 'clean'])
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100588 job.announce(colors, None)
Gabor Mezei9ce6d242024-06-19 17:47:05 +0200589 if not job.configure(conf, colors):
Andrzej Kurek3f930122022-10-26 08:08:26 -0400590 job.announce(colors, False)
591 return False
592 conf.write()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100593 success = job.test(options)
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100594 job.announce(colors, success)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100595 return success
596
Andrzej Kurek3f930122022-10-26 08:08:26 -0400597def run_tests(options, domain_data, conf):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100598 """Run the desired jobs.
599domain_data should be a DomainData instance that describes the available
600domains and jobs.
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400601Run the jobs listed in options.tasks."""
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100602 colors = Colors(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100603 jobs = []
604 failures = []
605 successes = []
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400606 for name in options.tasks:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100607 jobs += domain_data.get_jobs(name)
Gabor Mezei035d7c82024-06-19 15:46:21 +0200608 conf.backup()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100609 try:
610 for job in jobs:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400611 success = run(options, job, conf, colors=colors)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100612 if not success:
613 if options.keep_going:
614 failures.append(job.name)
615 else:
616 return False
617 else:
618 successes.append(job.name)
Gabor Mezei035d7c82024-06-19 15:46:21 +0200619 conf.restore()
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100620 except:
621 # Restore the configuration, except in stop-on-error mode if there
622 # was an error, where we leave the failing configuration up for
623 # developer convenience.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100624 if options.keep_going:
Gabor Mezei035d7c82024-06-19 15:46:21 +0200625 conf.restore()
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100626 raise
Gilles Peskinee85163b2019-01-29 18:50:03 +0100627 if successes:
628 log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100629 if failures:
Gilles Peskinee85163b2019-01-29 18:50:03 +0100630 log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100631 return False
632 else:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100633 return True
634
Andrzej Kurek3322c222022-10-04 15:02:41 -0400635def main():
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100636 try:
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400637 parser = argparse.ArgumentParser(
638 formatter_class=argparse.RawDescriptionHelpFormatter,
639 description=
640 "Test Mbed TLS with a subset of algorithms.\n\n"
641 "Example usage:\n"
Andrzej Kurek629c4122022-10-17 08:34:40 -0400642 r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA256_C""\n"
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400643 "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n"
644 "./tests/scripts/depends.py cipher_id cipher_chaining\n")
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100645 parser.add_argument('--color', metavar='WHEN',
646 help='Colorize the output (always/auto/never)',
647 choices=['always', 'auto', 'never'], default='auto')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100648 parser.add_argument('-c', '--config', metavar='FILE',
649 help='Configuration file to modify',
Gabor Mezeif5408f02024-06-14 15:25:46 +0200650 default=config.MbedTLSConfigFile.default_path[0])
651 parser.add_argument('-r', '--crypto-config', metavar='FILE',
652 help='Crypto configuration file to modify',
653 default=config.CryptoConfigFile.default_path[0])
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100654 parser.add_argument('-C', '--directory', metavar='DIR',
655 help='Change to this directory before anything else',
656 default='.')
657 parser.add_argument('-k', '--keep-going',
658 help='Try all configurations even if some fail (default)',
659 action='store_true', dest='keep_going', default=True)
660 parser.add_argument('-e', '--no-keep-going',
661 help='Stop as soon as a configuration fails',
662 action='store_false', dest='keep_going')
663 parser.add_argument('--list-jobs',
664 help='List supported jobs and exit',
665 action='append_const', dest='list', const='jobs')
666 parser.add_argument('--list-domains',
667 help='List supported domains and exit',
668 action='append_const', dest='list', const='domains')
669 parser.add_argument('--make-command', metavar='CMD',
670 help='Command to run instead of make (e.g. gmake)',
671 action='store', default='make')
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400672 parser.add_argument('tasks', metavar='TASKS', nargs='*',
673 help='The domain(s) or job(s) to test (default: all).',
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100674 default=True)
675 options = parser.parse_args()
676 os.chdir(options.directory)
Gabor Mezeif5408f02024-06-14 15:25:46 +0200677 conf = config.CombinedConfig(config.MbedTLSConfigFile(options.config),
678 config.CryptoConfigFile(options.crypto_config))
Andrzej Kurek3f930122022-10-26 08:08:26 -0400679 domain_data = DomainData(options, conf)
680
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400681 if options.tasks is True:
682 options.tasks = sorted(domain_data.domains.keys())
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100683 if options.list:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400684 for arg in options.list:
685 for domain_name in sorted(getattr(domain_data, arg).keys()):
686 print(domain_name)
687 sys.exit(0)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100688 else:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400689 sys.exit(0 if run_tests(options, domain_data, conf) else 1)
Andrzej Kurek3322c222022-10-04 15:02:41 -0400690 except Exception: # pylint: disable=broad-except
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100691 traceback.print_exc()
Andrzej Kurek3322c222022-10-04 15:02:41 -0400692 sys.exit(3)
693
694if __name__ == '__main__':
695 main()