blob: c6583e545532bff333e664e90cafac4eae60540b [file] [log] [blame]
Gilles Peskineb39e3ec2019-01-29 08:50:20 +01001#!/usr/bin/env python3
2
Andrzej Kurek629c4122022-10-17 08:34:40 -04003# Copyright (c) 2022, Arm Limited, All Rights Reserved.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +01004# SPDX-License-Identifier: Apache-2.0
5#
6# Licensed under the Apache License, Version 2.0 (the "License"); you may
7# not use this file except in compliance with the License.
8# You may obtain a copy of the License at
9#
10# http://www.apache.org/licenses/LICENSE-2.0
11#
12# Unless required by applicable law or agreed to in writing, software
13# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15# See the License for the specific language governing permissions and
16# limitations under the License.
17#
18# This file is part of Mbed TLS (https://tls.mbed.org)
19
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010020"""
Andrzej Kurek01af84a2022-10-09 05:29:44 -040021Test Mbed TLS with a subset of algorithms.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010022
Andrzej Kurek01af84a2022-10-09 05:29:44 -040023This script can be divided into several steps:
24
25First, include/mbedtls/mbedtls_config.h or a different config file passed
Andrzej Kurek3f930122022-10-26 08:08:26 -040026in the arguments is parsed to extract any configuration options (using config.py).
Andrzej Kurek01af84a2022-10-09 05:29:44 -040027
28Then, test domains (groups of jobs, tests) are built based on predefined data
29collected in the DomainData class. Here, each domain has five major traits:
Andrzej Kurek629c4122022-10-17 08:34:40 -040030- domain name, can be used to run only specific tests via command-line;
Andrzej Kurek01af84a2022-10-09 05:29:44 -040031- configuration building method, described in detail below;
32- list of symbols passed to the configuration building method;
33- commands to be run on each job (only build, build and test, or any other custom);
34- optional list of symbols to be excluded from testing.
35
36The configuration building method can be one of the three following:
37
38- ComplementaryDomain - build a job for each passed symbol by disabling a single
39 symbol and its reverse dependencies (defined in REVERSE_DEPENDENCIES);
40
41- ExclusiveDomain - build a job where, for each passed symbol, only this particular
42 one is defined and other symbols from the list are unset. For each job look for
43 any non-standard symbols to set/unset in EXCLUSIVE_GROUPS. These are usually not
44 direct dependencies, but rather non-trivial results of other configs missing. Then
45 look for any unset symbols and handle their reverse dependencies.
46 Examples of EXCLUSIVE_GROUPS usage:
Andrzej Kurek629c4122022-10-17 08:34:40 -040047 - MBEDTLS_SHA256 job turns off all hashes except SHA256, however, when investigating
48 reverse dependencies, SHA224 is found to depend on SHA256, so it is disabled,
49 and then SHA256 is found to depend on SHA224, so it is also disabled. To handle
50 this, there's a field in EXCLUSIVE_GROUPS that states that in a SHA256 test SHA224
Andrzej Kurek01af84a2022-10-09 05:29:44 -040051 should also be enabled before processing reverse dependencies:
Andrzej Kurek629c4122022-10-17 08:34:40 -040052 'MBEDTLS_SHA256_C': ['+MBEDTLS_SHA224_C']
Andrzej Kurek01af84a2022-10-09 05:29:44 -040053 - MBEDTLS_SHA512_C job turns off all hashes except SHA512. MBEDTLS_SSL_COOKIE_C
54 requires either SHA256 or SHA384 to work, so it also has to be disabled.
55 This is not a dependency on SHA512_C, but a result of an exclusive domain
56 config building method. Relevant field:
Andrzej Kurek629c4122022-10-17 08:34:40 -040057 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_COOKIE_C'],
Andrzej Kurek01af84a2022-10-09 05:29:44 -040058
59- DualDomain - combination of the two above - both complementary and exclusive domain
60 job generation code will be run. Currently only used for hashes.
61
62Lastly, the collected jobs are executed and (optionally) tested, with
63error reporting and coloring as configured in options. Each test starts with
64a full config without a couple of slowing down or unnecessary options
65(see set_reference_config), then the specific job config is derived.
66"""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010067import argparse
68import os
69import re
70import shutil
71import subprocess
72import sys
73import traceback
Andrzej Kurek3b0215d2023-01-23 07:19:22 -050074# Add the Mbed TLS Python library directory to the module search path
Andrzej Kurek3f930122022-10-26 08:08:26 -040075import scripts_path # pylint: disable=unused-import
76import config
77
Andrzej Kurek3322c222022-10-04 15:02:41 -040078class Colors: # pylint: disable=too-few-public-methods
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010079 """Minimalistic support for colored output.
80Each field of an object of this class is either None if colored output
81is not possible or not desired, or a pair of strings (start, stop) such
82that outputting start switches the text color to the desired color and
83stop switches the text color back to the default."""
84 red = None
85 green = None
Andrzej Kurek3f930122022-10-26 08:08:26 -040086 cyan = None
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010087 bold_red = None
88 bold_green = None
89 def __init__(self, options=None):
Andrzej Kurek3322c222022-10-04 15:02:41 -040090 """Initialize color profile according to passed options."""
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010091 if not options or options.color in ['no', 'never']:
92 want_color = False
93 elif options.color in ['yes', 'always']:
94 want_color = True
95 else:
96 want_color = sys.stderr.isatty()
97 if want_color:
98 # Assume ANSI compatible terminal
99 normal = '\033[0m'
100 self.red = ('\033[31m', normal)
101 self.green = ('\033[32m', normal)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400102 self.cyan = ('\033[36m', normal)
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100103 self.bold_red = ('\033[1;31m', normal)
104 self.bold_green = ('\033[1;32m', normal)
105NO_COLORS = Colors(None)
106
107def log_line(text, prefix='depends.py:', suffix='', color=None):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100108 """Print a status message."""
Andrzej Kurek3322c222022-10-04 15:02:41 -0400109 if color is not None:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100110 prefix = color[0] + prefix
111 suffix = suffix + color[1]
112 sys.stderr.write(prefix + ' ' + text + suffix + '\n')
Gilles Peskine46c82562019-01-29 18:42:55 +0100113 sys.stderr.flush()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100114
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100115def log_command(cmd):
116 """Print a trace of the specified command.
117cmd is a list of strings: a command name and its arguments."""
118 log_line(' '.join(cmd), prefix='+')
119
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100120def backup_config(options):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400121 """Back up the library configuration file (mbedtls_config.h).
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100122If the backup file already exists, it is presumed to be the desired backup,
123so don't make another backup."""
124 if os.path.exists(options.config_backup):
125 options.own_backup = False
126 else:
127 options.own_backup = True
128 shutil.copy(options.config, options.config_backup)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100129
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100130def restore_config(options):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400131 """Restore the library configuration file (mbedtls_config.h).
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100132Remove the backup file if it was saved earlier."""
133 if options.own_backup:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100134 shutil.move(options.config_backup, options.config)
135 else:
136 shutil.copy(options.config_backup, options.config)
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100137
Andrzej Kurek3f930122022-10-26 08:08:26 -0400138def option_exists(conf, option):
139 if option not in conf.settings:
140 return False
141 return True
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100142
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500143def set_config_option_value(conf, option, colors, value):
144 """Set/unset a configuration option, optionally specifying a value"""
Andrzej Kurek3f930122022-10-26 08:08:26 -0400145 if not option_exists(conf, option):
146 log_line('Symbol {} was not found in {}'.format(option, conf.filename), color=colors.red)
147 return False
Andrzej Kurek3f930122022-10-26 08:08:26 -0400148
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500149 if value is False:
150 log_command(['config.py', 'unset', option])
151 conf.unset(option)
152 else:
153 if value is True:
154 log_command(['config.py', 'set', option])
155 conf.set(option)
156 else:
157 log_command(['config.py', 'set', option, value])
158 conf.set(option, value)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400159 return True
160
161def set_reference_config(conf, options, colors):
Andrzej Kurek3322c222022-10-04 15:02:41 -0400162 """Change the library configuration file (mbedtls_config.h) to the reference state.
163The reference state is the one from which the tested configurations are
164derived."""
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400165 # Turn off options that are not relevant to the tests and slow them down.
Andrzej Kurek3f930122022-10-26 08:08:26 -0400166 log_command(['config.py', 'full'])
167 conf.adapt(config.full_adapter)
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500168 set_config_option_value(conf, 'MBEDTLS_TEST_HOOKS', colors, False)
Andrzej Kurek2c7993c2022-10-24 10:41:20 -0400169 if options.unset_use_psa:
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500170 set_config_option_value(conf, 'MBEDTLS_USE_PSA_CRYPTO', colors, False)
Andrzej Kurek3322c222022-10-04 15:02:41 -0400171
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100172class Job:
173 """A job builds the library in a specific configuration and runs some tests."""
174 def __init__(self, name, config_settings, commands):
175 """Build a job object.
176The job uses the configuration described by config_settings. This is a
177dictionary where the keys are preprocessor symbols and the values are
178booleans or strings. A boolean indicates whether or not to #define the
179symbol. With a string, the symbol is #define'd to that value.
180After setting the configuration, the job runs the programs specified by
181commands. This is a list of lists of strings; each list of string is a
182command name and its arguments and is passed to subprocess.call with
183shell=False."""
184 self.name = name
185 self.config_settings = config_settings
186 self.commands = commands
187
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100188 def announce(self, colors, what):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100189 '''Announce the start or completion of a job.
190If what is None, announce the start of the job.
191If what is True, announce that the job has passed.
192If what is False, announce that the job has failed.'''
193 if what is True:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100194 log_line(self.name + ' PASSED', color=colors.green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100195 elif what is False:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100196 log_line(self.name + ' FAILED', color=colors.red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100197 else:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400198 log_line('starting ' + self.name, color=colors.cyan)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100199
Andrzej Kurek3f930122022-10-26 08:08:26 -0400200 def configure(self, conf, options, colors):
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400201 '''Set library configuration options as required for the job.'''
Andrzej Kurek3f930122022-10-26 08:08:26 -0400202 set_reference_config(conf, options, colors)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100203 for key, value in sorted(self.config_settings.items()):
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500204 ret = set_config_option_value(conf, key, colors, value)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400205 if ret is False:
206 return False
207 return True
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100208
209 def test(self, options):
210 '''Run the job's build and test commands.
211Return True if all the commands succeed and False otherwise.
212If options.keep_going is false, stop as soon as one command fails. Otherwise
213run all the commands, except that if the first command fails, none of the
214other commands are run (typically, the first command is a build command
215and subsequent commands are tests that cannot run if the build failed).'''
216 built = False
217 success = True
218 for command in self.commands:
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100219 log_command(command)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100220 ret = subprocess.call(command)
221 if ret != 0:
222 if command[0] not in ['make', options.make_command]:
223 log_line('*** [{}] Error {}'.format(' '.join(command), ret))
224 if not options.keep_going or not built:
225 return False
226 success = False
227 built = True
228 return success
229
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100230# If the configuration option A requires B, make sure that
Andrzej Kurek202932f2022-10-04 16:22:22 -0400231# B in REVERSE_DEPENDENCIES[A].
Gilles Peskine584c24a2019-01-29 19:30:40 +0100232# All the information here should be contained in check_config.h. This
233# file includes a copy because it changes rarely and it would be a pain
234# to extract automatically.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400235REVERSE_DEPENDENCIES = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100236 'MBEDTLS_AES_C': ['MBEDTLS_CTR_DRBG_C',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400237 'MBEDTLS_NIST_KW_C'],
Gilles Peskine34a15572019-01-29 23:12:28 +0100238 'MBEDTLS_CHACHA20_C': ['MBEDTLS_CHACHAPOLY_C'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400239 'MBEDTLS_ECDSA_C': ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
240 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100241 'MBEDTLS_ECP_C': ['MBEDTLS_ECDSA_C',
242 'MBEDTLS_ECDH_C',
243 'MBEDTLS_ECJPAKE_C',
244 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
245 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED',
246 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED',
247 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400248 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
Ronald Crond8d2ea52022-10-04 15:48:06 +0200249 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
250 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED',
251 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100252 'MBEDTLS_ECP_DP_SECP256R1_ENABLED': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100253 'MBEDTLS_PKCS1_V21': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
254 'MBEDTLS_PKCS1_V15': ['MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
255 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
256 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
257 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'],
258 'MBEDTLS_RSA_C': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT',
259 'MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
260 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
261 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400262 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED',
263 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100264 'MBEDTLS_SHA256_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400265 'MBEDTLS_ENTROPY_FORCE_SHA256',
266 'MBEDTLS_SHA224_C',
267 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kurek22b959d2022-10-16 12:51:41 -0400268 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY',
269 'MBEDTLS_LMS_C',
270 'MBEDTLS_LMS_PRIVATE'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400271 'MBEDTLS_SHA512_C': ['MBEDTLS_SHA384_C',
272 'MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT',
273 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY'],
274 'MBEDTLS_SHA224_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
275 'MBEDTLS_ENTROPY_FORCE_SHA256',
276 'MBEDTLS_SHA256_C',
277 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
278 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400279 'MBEDTLS_X509_RSASSA_PSS_SUPPORT': []
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100280}
281
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400282# If an option is tested in an exclusive test, alter the following defines.
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400283# These are not necessarily dependencies, but just minimal required changes
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400284# if a given define is the only one enabled from an exclusive group.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400285EXCLUSIVE_GROUPS = {
Andrzej Kurek65b2ac12022-10-14 08:09:16 -0400286 'MBEDTLS_SHA256_C': ['+MBEDTLS_SHA224_C'],
287 'MBEDTLS_SHA384_C': ['+MBEDTLS_SHA512_C'],
288 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_COOKIE_C',
289 '-MBEDTLS_SSL_PROTO_TLS1_3'],
290 'MBEDTLS_ECP_DP_CURVE448_ENABLED': ['-MBEDTLS_ECDSA_C',
291 '-MBEDTLS_ECDSA_DETERMINISTIC',
292 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
293 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
294 '-MBEDTLS_ECJPAKE_C',
295 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
296 'MBEDTLS_ECP_DP_CURVE25519_ENABLED': ['-MBEDTLS_ECDSA_C',
297 '-MBEDTLS_ECDSA_DETERMINISTIC',
298 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
299 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
300 '-MBEDTLS_ECJPAKE_C',
301 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
302 'MBEDTLS_ARIA_C': ['-MBEDTLS_CMAC_C'],
303 'MBEDTLS_CAMELLIA_C': ['-MBEDTLS_CMAC_C'],
304 'MBEDTLS_CHACHA20_C': ['-MBEDTLS_CMAC_C', '-MBEDTLS_CCM_C', '-MBEDTLS_GCM_C'],
305 'MBEDTLS_DES_C': ['-MBEDTLS_CCM_C',
306 '-MBEDTLS_GCM_C',
307 '-MBEDTLS_SSL_TICKET_C',
308 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400309}
310def handle_exclusive_groups(config_settings, symbol):
311 """For every symbol tested in an exclusive group check if there are other
312defines to be altered. """
Andrzej Kurek202932f2022-10-04 16:22:22 -0400313 for dep in EXCLUSIVE_GROUPS.get(symbol, []):
Andrzej Kurek65b2ac12022-10-14 08:09:16 -0400314 unset = dep.startswith('-')
315 dep = dep[1:]
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400316 config_settings[dep] = not unset
317
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100318def turn_off_dependencies(config_settings):
319 """For every option turned off config_settings, also turn off what depends on it.
320An option O is turned off if config_settings[O] is False."""
321 for key, value in sorted(config_settings.items()):
322 if value is not False:
323 continue
Andrzej Kurek202932f2022-10-04 16:22:22 -0400324 for dep in REVERSE_DEPENDENCIES.get(key, []):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100325 config_settings[dep] = False
326
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400327class BaseDomain: # pylint: disable=too-few-public-methods, unused-argument
328 """A base class for all domains."""
329 def __init__(self, symbols, commands, exclude):
330 """Initialize the jobs container"""
331 self.jobs = []
332
333class ExclusiveDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100334 """A domain consisting of a set of conceptually-equivalent settings.
335Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurekfe469492022-10-06 16:57:38 -0400336with this symbol set and the others unset."""
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100337 def __init__(self, symbols, commands, exclude=None):
338 """Build a domain for the specified list of configuration symbols.
Andrzej Kurekfe469492022-10-06 16:57:38 -0400339The domain contains a set of jobs that enable one of the elements
340of symbols and disable the others.
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100341Each job runs the specified commands.
342If exclude is a regular expression, skip generated jobs whose description
343would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400344 super().__init__(symbols, commands, exclude)
Andrzej Kurekfe469492022-10-06 16:57:38 -0400345 base_config_settings = {}
346 for symbol in symbols:
347 base_config_settings[symbol] = False
348 for symbol in symbols:
349 description = symbol
350 if exclude and re.match(exclude, description):
351 continue
352 config_settings = base_config_settings.copy()
353 config_settings[symbol] = True
354 handle_exclusive_groups(config_settings, symbol)
355 turn_off_dependencies(config_settings)
356 job = Job(description, config_settings, commands)
357 self.jobs.append(job)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100358
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400359class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100360 """A domain consisting of a set of loosely-related settings.
361Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400362with this symbol unset.
363If exclude is a regular expression, skip generated jobs whose description
364would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400365 def __init__(self, symbols, commands, exclude=None):
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100366 """Build a domain for the specified list of configuration symbols.
367Each job in the domain disables one of the specified symbols.
368Each job runs the specified commands."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400369 super().__init__(symbols, commands, exclude)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100370 for symbol in symbols:
371 description = '!' + symbol
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400372 if exclude and re.match(exclude, description):
373 continue
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100374 config_settings = {symbol: False}
375 turn_off_dependencies(config_settings)
376 job = Job(description, config_settings, commands)
377 self.jobs.append(job)
378
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400379class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400380 """A domain that contains both the ExclusiveDomain and BaseDomain tests.
Andrzej Kurekf4b18672022-10-14 07:57:00 -0400381Both parent class __init__ calls are performed in any order and
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400382each call adds respective jobs. The job array initialization is done once in
383BaseDomain, before the parent __init__ calls."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400384
Andrzej Kurek3322c222022-10-04 15:02:41 -0400385class CipherInfo: # pylint: disable=too-few-public-methods
Gilles Peskine34a15572019-01-29 23:12:28 +0100386 """Collect data about cipher.h."""
Andrzej Kurek3322c222022-10-04 15:02:41 -0400387 def __init__(self):
Gilles Peskine34a15572019-01-29 23:12:28 +0100388 self.base_symbols = set()
Andrzej Kurek3322c222022-10-04 15:02:41 -0400389 with open('include/mbedtls/cipher.h', encoding="utf-8") as fh:
Gilles Peskine34a15572019-01-29 23:12:28 +0100390 for line in fh:
391 m = re.match(r' *MBEDTLS_CIPHER_ID_(\w+),', line)
392 if m and m.group(1) not in ['NONE', 'NULL', '3DES']:
393 self.base_symbols.add('MBEDTLS_' + m.group(1) + '_C')
394
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100395class DomainData:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400396 """A container for domains and jobs, used to structurize testing."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100397 def config_symbols_matching(self, regexp):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400398 """List the mbedtls_config.h settings matching regexp."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100399 return [symbol for symbol in self.all_config_symbols
400 if re.match(regexp, symbol)]
401
Andrzej Kurek3f930122022-10-26 08:08:26 -0400402 def __init__(self, options, conf):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100403 """Gather data about the library and establish a list of domains to test."""
404 build_command = [options.make_command, 'CFLAGS=-Werror']
405 build_and_test = [build_command, [options.make_command, 'test']]
Andrzej Kurek3f930122022-10-26 08:08:26 -0400406 self.all_config_symbols = set(conf.settings.keys())
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100407 # Find hash modules by name.
408 hash_symbols = self.config_symbols_matching(r'MBEDTLS_(MD|RIPEMD|SHA)[0-9]+_C\Z')
409 # Find elliptic curve enabling macros by name.
410 curve_symbols = self.config_symbols_matching(r'MBEDTLS_ECP_DP_\w+_ENABLED\Z')
411 # Find key exchange enabling macros by name.
412 key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z')
Gilles Peskine34a15572019-01-29 23:12:28 +0100413 # Find cipher IDs (block permutations and stream ciphers --- chaining
414 # and padding modes are exercised separately) information by parsing
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400415 # cipher.h, as the information is not readily available in mbedtls_config.h.
Andrzej Kurek3322c222022-10-04 15:02:41 -0400416 cipher_info = CipherInfo()
Gilles Peskine34a15572019-01-29 23:12:28 +0100417 # Find block cipher chaining and padding mode enabling macros by name.
418 cipher_chaining_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_MODE_\w+\Z')
419 cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100420 self.domains = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100421 # Cipher IDs, chaining modes and padding modes. Run the test suites.
422 'cipher_id': ExclusiveDomain(cipher_info.base_symbols,
423 build_and_test),
424 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols,
425 build_and_test),
426 'cipher_padding': ExclusiveDomain(cipher_padding_symbols,
427 build_and_test),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100428 # Elliptic curves. Run the test suites.
429 'curves': ExclusiveDomain(curve_symbols, build_and_test),
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400430 # Hash algorithms. Exclude three groups:
431 # - Exclusive domain of MD, RIPEMD, SHA1 (obsolete);
432 # - Exclusive domain of SHA224 (tested with and depends on SHA256);
433 # - Complementary domain of SHA224 and SHA384 - tested with and depend
434 # on SHA256 and SHA512, respectively.
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400435 'hashes': DualDomain(hash_symbols, build_and_test,
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400436 exclude=r'MBEDTLS_(MD|RIPEMD|SHA1_)' \
437 '|MBEDTLS_SHA224_'\
438 '|!MBEDTLS_(SHA224_|SHA384_)'),
Gilles Peskinec3b4dee2019-01-29 19:33:05 +0100439 # Key exchange types. Only build the library and the sample
440 # programs.
441 'kex': ExclusiveDomain(key_exchange_symbols,
442 [build_command + ['lib'],
443 build_command + ['-C', 'programs']]),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100444 'pkalgs': ComplementaryDomain(['MBEDTLS_ECDSA_C',
445 'MBEDTLS_ECP_C',
446 'MBEDTLS_PKCS1_V21',
447 'MBEDTLS_PKCS1_V15',
448 'MBEDTLS_RSA_C',
449 'MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
450 build_and_test),
451 }
452 self.jobs = {}
453 for domain in self.domains.values():
454 for job in domain.jobs:
455 self.jobs[job.name] = job
456
457 def get_jobs(self, name):
458 """Return the list of jobs identified by the given name.
459A name can either be the name of a domain or the name of one specific job."""
460 if name in self.domains:
461 return sorted(self.domains[name].jobs, key=lambda job: job.name)
462 else:
463 return [self.jobs[name]]
464
Andrzej Kurek3f930122022-10-26 08:08:26 -0400465def run(options, job, conf, colors=NO_COLORS):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100466 """Run the specified job (a Job instance)."""
467 subprocess.check_call([options.make_command, 'clean'])
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100468 job.announce(colors, None)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400469 if not job.configure(conf, options, colors):
470 job.announce(colors, False)
471 return False
472 conf.write()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100473 success = job.test(options)
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100474 job.announce(colors, success)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100475 return success
476
Andrzej Kurek3f930122022-10-26 08:08:26 -0400477def run_tests(options, domain_data, conf):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100478 """Run the desired jobs.
479domain_data should be a DomainData instance that describes the available
480domains and jobs.
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400481Run the jobs listed in options.tasks."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100482 if not hasattr(options, 'config_backup'):
483 options.config_backup = options.config + '.bak'
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100484 colors = Colors(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100485 jobs = []
486 failures = []
487 successes = []
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400488 for name in options.tasks:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100489 jobs += domain_data.get_jobs(name)
490 backup_config(options)
491 try:
492 for job in jobs:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400493 success = run(options, job, conf, colors=colors)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100494 if not success:
495 if options.keep_going:
496 failures.append(job.name)
497 else:
498 return False
499 else:
500 successes.append(job.name)
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100501 restore_config(options)
502 except:
503 # Restore the configuration, except in stop-on-error mode if there
504 # was an error, where we leave the failing configuration up for
505 # developer convenience.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100506 if options.keep_going:
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100507 restore_config(options)
508 raise
Gilles Peskinee85163b2019-01-29 18:50:03 +0100509 if successes:
510 log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100511 if failures:
Gilles Peskinee85163b2019-01-29 18:50:03 +0100512 log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100513 return False
514 else:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100515 return True
516
Andrzej Kurek3322c222022-10-04 15:02:41 -0400517def main():
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100518 try:
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400519 parser = argparse.ArgumentParser(
520 formatter_class=argparse.RawDescriptionHelpFormatter,
521 description=
522 "Test Mbed TLS with a subset of algorithms.\n\n"
523 "Example usage:\n"
Andrzej Kurek629c4122022-10-17 08:34:40 -0400524 r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA256_C""\n"
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400525 "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n"
526 "./tests/scripts/depends.py cipher_id cipher_chaining\n")
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100527 parser.add_argument('--color', metavar='WHEN',
528 help='Colorize the output (always/auto/never)',
529 choices=['always', 'auto', 'never'], default='auto')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100530 parser.add_argument('-c', '--config', metavar='FILE',
531 help='Configuration file to modify',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400532 default='include/mbedtls/mbedtls_config.h')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100533 parser.add_argument('-C', '--directory', metavar='DIR',
534 help='Change to this directory before anything else',
535 default='.')
536 parser.add_argument('-k', '--keep-going',
537 help='Try all configurations even if some fail (default)',
538 action='store_true', dest='keep_going', default=True)
539 parser.add_argument('-e', '--no-keep-going',
540 help='Stop as soon as a configuration fails',
541 action='store_false', dest='keep_going')
542 parser.add_argument('--list-jobs',
543 help='List supported jobs and exit',
544 action='append_const', dest='list', const='jobs')
545 parser.add_argument('--list-domains',
546 help='List supported domains and exit',
547 action='append_const', dest='list', const='domains')
548 parser.add_argument('--make-command', metavar='CMD',
549 help='Command to run instead of make (e.g. gmake)',
550 action='store', default='make')
Andrzej Kurek2c7993c2022-10-24 10:41:20 -0400551 parser.add_argument('--unset-use-psa',
552 help='Unset MBEDTLS_USE_PSA_CRYPTO before any test',
553 action='store_true', dest='unset_use_psa')
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400554 parser.add_argument('tasks', metavar='TASKS', nargs='*',
555 help='The domain(s) or job(s) to test (default: all).',
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100556 default=True)
557 options = parser.parse_args()
558 os.chdir(options.directory)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400559 conf = config.ConfigFile(options.config)
560 domain_data = DomainData(options, conf)
561
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400562 if options.tasks is True:
563 options.tasks = sorted(domain_data.domains.keys())
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100564 if options.list:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400565 for arg in options.list:
566 for domain_name in sorted(getattr(domain_data, arg).keys()):
567 print(domain_name)
568 sys.exit(0)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100569 else:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400570 sys.exit(0 if run_tests(options, domain_data, conf) else 1)
Andrzej Kurek3322c222022-10-04 15:02:41 -0400571 except Exception: # pylint: disable=broad-except
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100572 traceback.print_exc()
Andrzej Kurek3322c222022-10-04 15:02:41 -0400573 sys.exit(3)
574
575if __name__ == '__main__':
576 main()