blob: a2c939a15718eb94f5ec45cb9fdc42f509f5207d [file] [log] [blame]
Gilles Peskineb39e3ec2019-01-29 08:50:20 +01001#!/usr/bin/env python3
2
3# Copyright (c) 2018, Arm Limited, All Rights Reserved.
4# SPDX-License-Identifier: Apache-2.0
5#
6# Licensed under the Apache License, Version 2.0 (the "License"); you may
7# not use this file except in compliance with the License.
8# You may obtain a copy of the License at
9#
10# http://www.apache.org/licenses/LICENSE-2.0
11#
12# Unless required by applicable law or agreed to in writing, software
13# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15# See the License for the specific language governing permissions and
16# limitations under the License.
17#
18# This file is part of Mbed TLS (https://tls.mbed.org)
19
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010020"""
Andrzej Kurek01af84a2022-10-09 05:29:44 -040021Test Mbed TLS with a subset of algorithms.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010022
Andrzej Kurek01af84a2022-10-09 05:29:44 -040023This script can be divided into several steps:
24
25First, include/mbedtls/mbedtls_config.h or a different config file passed
26in the arguments is parsed to extract any configuration options (collect_config_symbols).
27
28Then, test domains (groups of jobs, tests) are built based on predefined data
29collected in the DomainData class. Here, each domain has five major traits:
30- domain name, can be used to run only specific tests via commandline;
31- configuration building method, described in detail below;
32- list of symbols passed to the configuration building method;
33- commands to be run on each job (only build, build and test, or any other custom);
34- optional list of symbols to be excluded from testing.
35
36The configuration building method can be one of the three following:
37
38- ComplementaryDomain - build a job for each passed symbol by disabling a single
39 symbol and its reverse dependencies (defined in REVERSE_DEPENDENCIES);
40
41- ExclusiveDomain - build a job where, for each passed symbol, only this particular
42 one is defined and other symbols from the list are unset. For each job look for
43 any non-standard symbols to set/unset in EXCLUSIVE_GROUPS. These are usually not
44 direct dependencies, but rather non-trivial results of other configs missing. Then
45 look for any unset symbols and handle their reverse dependencies.
46 Examples of EXCLUSIVE_GROUPS usage:
47 - MBEDTLS_SHA224 job turns off all hashes except SHA224, however, when investigating
48 reverse dependencies, SHA256 is found to depend on SHA224, so it is disabled,
49 and then SHA224 is found to depend on SHA256, so it is also disabled. To handle
50 this, there's a field in EXCLUSIVE_GROUPS that states that in a SHA224 test SHA256
51 should also be enabled before processing reverse dependencies:
52 'MBEDTLS_SHA224_C': ['MBEDTLS_SHA256_C']
53 - MBEDTLS_SHA512_C job turns off all hashes except SHA512. MBEDTLS_SSL_COOKIE_C
54 requires either SHA256 or SHA384 to work, so it also has to be disabled.
55 This is not a dependency on SHA512_C, but a result of an exclusive domain
56 config building method. Relevant field:
57 'MBEDTLS_SHA512_C': ['!MBEDTLS_SSL_COOKIE_C'],
58
59- DualDomain - combination of the two above - both complementary and exclusive domain
60 job generation code will be run. Currently only used for hashes.
61
62Lastly, the collected jobs are executed and (optionally) tested, with
63error reporting and coloring as configured in options. Each test starts with
64a full config without a couple of slowing down or unnecessary options
65(see set_reference_config), then the specific job config is derived.
66"""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010067import argparse
68import os
69import re
70import shutil
71import subprocess
72import sys
73import traceback
74
Andrzej Kurek3322c222022-10-04 15:02:41 -040075class Colors: # pylint: disable=too-few-public-methods
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010076 """Minimalistic support for colored output.
77Each field of an object of this class is either None if colored output
78is not possible or not desired, or a pair of strings (start, stop) such
79that outputting start switches the text color to the desired color and
80stop switches the text color back to the default."""
81 red = None
82 green = None
83 bold_red = None
84 bold_green = None
85 def __init__(self, options=None):
Andrzej Kurek3322c222022-10-04 15:02:41 -040086 """Initialize color profile according to passed options."""
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010087 if not options or options.color in ['no', 'never']:
88 want_color = False
89 elif options.color in ['yes', 'always']:
90 want_color = True
91 else:
92 want_color = sys.stderr.isatty()
93 if want_color:
94 # Assume ANSI compatible terminal
95 normal = '\033[0m'
96 self.red = ('\033[31m', normal)
97 self.green = ('\033[32m', normal)
98 self.bold_red = ('\033[1;31m', normal)
99 self.bold_green = ('\033[1;32m', normal)
100NO_COLORS = Colors(None)
101
102def log_line(text, prefix='depends.py:', suffix='', color=None):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100103 """Print a status message."""
Andrzej Kurek3322c222022-10-04 15:02:41 -0400104 if color is not None:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100105 prefix = color[0] + prefix
106 suffix = suffix + color[1]
107 sys.stderr.write(prefix + ' ' + text + suffix + '\n')
Gilles Peskine46c82562019-01-29 18:42:55 +0100108 sys.stderr.flush()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100109
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100110def log_command(cmd):
111 """Print a trace of the specified command.
112cmd is a list of strings: a command name and its arguments."""
113 log_line(' '.join(cmd), prefix='+')
114
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100115def backup_config(options):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400116 """Back up the library configuration file (mbedtls_config.h).
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100117If the backup file already exists, it is presumed to be the desired backup,
118so don't make another backup."""
119 if os.path.exists(options.config_backup):
120 options.own_backup = False
121 else:
122 options.own_backup = True
123 shutil.copy(options.config, options.config_backup)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100124
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100125def restore_config(options):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400126 """Restore the library configuration file (mbedtls_config.h).
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100127Remove the backup file if it was saved earlier."""
128 if options.own_backup:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100129 shutil.move(options.config_backup, options.config)
130 else:
131 shutil.copy(options.config_backup, options.config)
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100132
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100133def run_config_pl(options, args):
Andrzej Kurek3322c222022-10-04 15:02:41 -0400134 """Run scripts/config.py with the specified arguments."""
135 cmd = ['scripts/config.py']
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400136 if options.config != 'include/mbedtls/mbedtls_config.h':
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100137 cmd += ['--file', options.config]
138 cmd += args
139 log_command(cmd)
140 subprocess.check_call(cmd)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100141
Andrzej Kurek3322c222022-10-04 15:02:41 -0400142def set_reference_config(options):
143 """Change the library configuration file (mbedtls_config.h) to the reference state.
144The reference state is the one from which the tested configurations are
145derived."""
146 # Turn off memory management options that are not relevant to
147 # the tests and slow them down.
148 run_config_pl(options, ['full'])
149 run_config_pl(options, ['unset', 'MBEDTLS_MEMORY_BACKTRACE'])
150 run_config_pl(options, ['unset', 'MBEDTLS_MEMORY_BUFFER_ALLOC_C'])
151 run_config_pl(options, ['unset', 'MBEDTLS_MEMORY_DEBUG'])
Andrzej Kurek2f8ac282022-10-07 16:07:58 -0400152 run_config_pl(options, ['unset', 'MBEDTLS_TEST_HOOKS'])
Andrzej Kurek3322c222022-10-04 15:02:41 -0400153
154def collect_config_symbols(options):
155 """Read the list of settings from mbedtls_config.h.
156Return them in a generator."""
157 with open(options.config, encoding="utf-8") as config_file:
158 rx = re.compile(r'\s*(?://\s*)?#define\s+(\w+)\s*(?:$|/[/*])')
159 for line in config_file:
160 m = re.match(rx, line)
161 if m:
162 yield m.group(1)
163
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100164class Job:
165 """A job builds the library in a specific configuration and runs some tests."""
166 def __init__(self, name, config_settings, commands):
167 """Build a job object.
168The job uses the configuration described by config_settings. This is a
169dictionary where the keys are preprocessor symbols and the values are
170booleans or strings. A boolean indicates whether or not to #define the
171symbol. With a string, the symbol is #define'd to that value.
172After setting the configuration, the job runs the programs specified by
173commands. This is a list of lists of strings; each list of string is a
174command name and its arguments and is passed to subprocess.call with
175shell=False."""
176 self.name = name
177 self.config_settings = config_settings
178 self.commands = commands
179
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100180 def announce(self, colors, what):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100181 '''Announce the start or completion of a job.
182If what is None, announce the start of the job.
183If what is True, announce that the job has passed.
184If what is False, announce that the job has failed.'''
185 if what is True:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100186 log_line(self.name + ' PASSED', color=colors.green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100187 elif what is False:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100188 log_line(self.name + ' FAILED', color=colors.red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100189 else:
190 log_line('starting ' + self.name)
191
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100192 def configure(self, options):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100193 '''Set library configuration options as required for the job.
194config_file_name indicates which file to modify.'''
Andrzej Kurek3322c222022-10-04 15:02:41 -0400195 set_reference_config(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100196 for key, value in sorted(self.config_settings.items()):
197 if value is True:
198 args = ['set', key]
199 elif value is False:
200 args = ['unset', key]
201 else:
202 args = ['set', key, value]
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100203 run_config_pl(options, args)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100204
205 def test(self, options):
206 '''Run the job's build and test commands.
207Return True if all the commands succeed and False otherwise.
208If options.keep_going is false, stop as soon as one command fails. Otherwise
209run all the commands, except that if the first command fails, none of the
210other commands are run (typically, the first command is a build command
211and subsequent commands are tests that cannot run if the build failed).'''
212 built = False
213 success = True
214 for command in self.commands:
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100215 log_command(command)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100216 ret = subprocess.call(command)
217 if ret != 0:
218 if command[0] not in ['make', options.make_command]:
219 log_line('*** [{}] Error {}'.format(' '.join(command), ret))
220 if not options.keep_going or not built:
221 return False
222 success = False
223 built = True
224 return success
225
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100226# If the configuration option A requires B, make sure that
Andrzej Kurek202932f2022-10-04 16:22:22 -0400227# B in REVERSE_DEPENDENCIES[A].
Gilles Peskine584c24a2019-01-29 19:30:40 +0100228# All the information here should be contained in check_config.h. This
229# file includes a copy because it changes rarely and it would be a pain
230# to extract automatically.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400231REVERSE_DEPENDENCIES = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100232 'MBEDTLS_AES_C': ['MBEDTLS_CTR_DRBG_C',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400233 'MBEDTLS_NIST_KW_C'],
Gilles Peskine34a15572019-01-29 23:12:28 +0100234 'MBEDTLS_CHACHA20_C': ['MBEDTLS_CHACHAPOLY_C'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400235 'MBEDTLS_ECDSA_C': ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
236 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100237 'MBEDTLS_ECP_C': ['MBEDTLS_ECDSA_C',
238 'MBEDTLS_ECDH_C',
239 'MBEDTLS_ECJPAKE_C',
240 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
241 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED',
242 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED',
243 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400244 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
245 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100246 'MBEDTLS_ECP_DP_SECP256R1_ENABLED': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100247 'MBEDTLS_PKCS1_V21': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
248 'MBEDTLS_PKCS1_V15': ['MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
249 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
250 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
251 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'],
252 'MBEDTLS_RSA_C': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT',
253 'MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
254 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
255 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400256 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED',
257 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100258 'MBEDTLS_SHA256_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400259 'MBEDTLS_ENTROPY_FORCE_SHA256',
260 'MBEDTLS_SHA224_C',
261 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
262 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY',
263 'MBEDTLS_SSL_PROTO_TLS1_3'],
264 'MBEDTLS_SHA512_C': ['MBEDTLS_SHA384_C',
265 'MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT',
266 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY'],
267 'MBEDTLS_SHA224_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
268 'MBEDTLS_ENTROPY_FORCE_SHA256',
269 'MBEDTLS_SHA256_C',
270 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
271 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY'],
272 'MBEDTLS_SHA384_C': ['MBEDTLS_SSL_PROTO_TLS1_3'],
273 'MBEDTLS_X509_RSASSA_PSS_SUPPORT': []
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100274}
275
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400276# If an option is tested in an exclusive test, alter the following defines.
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400277# These are not necessarily dependencies, but just minimal required changes
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400278# if a given define is the only one enabled from an exclusive group.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400279EXCLUSIVE_GROUPS = {
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400280 'MBEDTLS_SHA224_C': ['MBEDTLS_SHA256_C'],
281 'MBEDTLS_SHA384_C': ['MBEDTLS_SHA512_C'],
Andrzej Kurekeabeb302022-10-17 07:52:51 -0400282 'MBEDTLS_SHA512_C': ['!MBEDTLS_SSL_COOKIE_C'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400283 'MBEDTLS_ECP_DP_CURVE448_ENABLED': ['!MBEDTLS_ECDSA_C',
Andrzej Kurek0e8b2d72022-10-04 11:14:59 -0400284 '!MBEDTLS_ECDSA_DETERMINISTIC',
285 '!MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
286 '!MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
287 '!MBEDTLS_ECJPAKE_C',
288 '!MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400289 'MBEDTLS_ECP_DP_CURVE25519_ENABLED': ['!MBEDTLS_ECDSA_C',
Andrzej Kurek0e8b2d72022-10-04 11:14:59 -0400290 '!MBEDTLS_ECDSA_DETERMINISTIC',
291 '!MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
292 '!MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
293 '!MBEDTLS_ECJPAKE_C',
294 '!MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400295 'MBEDTLS_ARIA_C': ['!MBEDTLS_CMAC_C'],
296 'MBEDTLS_CAMELLIA_C': ['!MBEDTLS_CMAC_C'],
297 'MBEDTLS_CHACHA20_C': ['!MBEDTLS_CMAC_C', '!MBEDTLS_CCM_C', '!MBEDTLS_GCM_C'],
Andrzej Kureke5535e32022-10-13 09:07:47 -0400298 'MBEDTLS_DES_C': ['!MBEDTLS_CCM_C', '!MBEDTLS_GCM_C', '!MBEDTLS_SSL_TICKET_C',
299 '!MBEDTLS_SSL_CONTEXT_SERIALIZATION'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400300}
301def handle_exclusive_groups(config_settings, symbol):
302 """For every symbol tested in an exclusive group check if there are other
303defines to be altered. """
Andrzej Kurek202932f2022-10-04 16:22:22 -0400304 for dep in EXCLUSIVE_GROUPS.get(symbol, []):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400305 unset = dep.startswith('!')
306 if unset:
Andrzej Kurek0e8b2d72022-10-04 11:14:59 -0400307 dep = dep[1:]
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400308 config_settings[dep] = not unset
309
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100310def turn_off_dependencies(config_settings):
311 """For every option turned off config_settings, also turn off what depends on it.
312An option O is turned off if config_settings[O] is False."""
313 for key, value in sorted(config_settings.items()):
314 if value is not False:
315 continue
Andrzej Kurek202932f2022-10-04 16:22:22 -0400316 for dep in REVERSE_DEPENDENCIES.get(key, []):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100317 config_settings[dep] = False
318
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400319class BaseDomain: # pylint: disable=too-few-public-methods, unused-argument
320 """A base class for all domains."""
321 def __init__(self, symbols, commands, exclude):
322 """Initialize the jobs container"""
323 self.jobs = []
324
325class ExclusiveDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100326 """A domain consisting of a set of conceptually-equivalent settings.
327Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurekfe469492022-10-06 16:57:38 -0400328with this symbol set and the others unset."""
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100329 def __init__(self, symbols, commands, exclude=None):
330 """Build a domain for the specified list of configuration symbols.
Andrzej Kurekfe469492022-10-06 16:57:38 -0400331The domain contains a set of jobs that enable one of the elements
332of symbols and disable the others.
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100333Each job runs the specified commands.
334If exclude is a regular expression, skip generated jobs whose description
335would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400336 super().__init__(symbols, commands, exclude)
Andrzej Kurekfe469492022-10-06 16:57:38 -0400337 base_config_settings = {}
338 for symbol in symbols:
339 base_config_settings[symbol] = False
340 for symbol in symbols:
341 description = symbol
342 if exclude and re.match(exclude, description):
343 continue
344 config_settings = base_config_settings.copy()
345 config_settings[symbol] = True
346 handle_exclusive_groups(config_settings, symbol)
347 turn_off_dependencies(config_settings)
348 job = Job(description, config_settings, commands)
349 self.jobs.append(job)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100350
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400351class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100352 """A domain consisting of a set of loosely-related settings.
353Establish a list of configuration symbols. For each symbol, run a test job
354with this symbol unset."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400355 def __init__(self, symbols, commands, exclude=None):
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100356 """Build a domain for the specified list of configuration symbols.
357Each job in the domain disables one of the specified symbols.
358Each job runs the specified commands."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400359 super().__init__(symbols, commands, exclude)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100360 for symbol in symbols:
361 description = '!' + symbol
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400362 if exclude and re.match(exclude, description):
363 continue
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100364 config_settings = {symbol: False}
365 turn_off_dependencies(config_settings)
366 job = Job(description, config_settings, commands)
367 self.jobs.append(job)
368
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400369class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods
370 """A domain that contains both the ExclusiveDomain and BaseDomain tests"""
371 def __init__(self, symbols, commands, exclude=None):
372 super().__init__(symbols=symbols, commands=commands, exclude=exclude)
373
Andrzej Kurek3322c222022-10-04 15:02:41 -0400374class CipherInfo: # pylint: disable=too-few-public-methods
Gilles Peskine34a15572019-01-29 23:12:28 +0100375 """Collect data about cipher.h."""
Andrzej Kurek3322c222022-10-04 15:02:41 -0400376 def __init__(self):
Gilles Peskine34a15572019-01-29 23:12:28 +0100377 self.base_symbols = set()
Andrzej Kurek3322c222022-10-04 15:02:41 -0400378 with open('include/mbedtls/cipher.h', encoding="utf-8") as fh:
Gilles Peskine34a15572019-01-29 23:12:28 +0100379 for line in fh:
380 m = re.match(r' *MBEDTLS_CIPHER_ID_(\w+),', line)
381 if m and m.group(1) not in ['NONE', 'NULL', '3DES']:
382 self.base_symbols.add('MBEDTLS_' + m.group(1) + '_C')
383
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100384class DomainData:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400385 """A container for domains and jobs, used to structurize testing."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100386 def config_symbols_matching(self, regexp):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400387 """List the mbedtls_config.h settings matching regexp."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100388 return [symbol for symbol in self.all_config_symbols
389 if re.match(regexp, symbol)]
390
391 def __init__(self, options):
392 """Gather data about the library and establish a list of domains to test."""
393 build_command = [options.make_command, 'CFLAGS=-Werror']
394 build_and_test = [build_command, [options.make_command, 'test']]
Andrzej Kurek3322c222022-10-04 15:02:41 -0400395 self.all_config_symbols = set(collect_config_symbols(options))
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100396 # Find hash modules by name.
397 hash_symbols = self.config_symbols_matching(r'MBEDTLS_(MD|RIPEMD|SHA)[0-9]+_C\Z')
398 # Find elliptic curve enabling macros by name.
399 curve_symbols = self.config_symbols_matching(r'MBEDTLS_ECP_DP_\w+_ENABLED\Z')
400 # Find key exchange enabling macros by name.
401 key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z')
Gilles Peskine34a15572019-01-29 23:12:28 +0100402 # Find cipher IDs (block permutations and stream ciphers --- chaining
403 # and padding modes are exercised separately) information by parsing
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400404 # cipher.h, as the information is not readily available in mbedtls_config.h.
405
Andrzej Kurek3322c222022-10-04 15:02:41 -0400406 cipher_info = CipherInfo()
Gilles Peskine34a15572019-01-29 23:12:28 +0100407 # Find block cipher chaining and padding mode enabling macros by name.
408 cipher_chaining_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_MODE_\w+\Z')
409 cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100410 self.domains = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100411 # Cipher IDs, chaining modes and padding modes. Run the test suites.
412 'cipher_id': ExclusiveDomain(cipher_info.base_symbols,
413 build_and_test),
414 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols,
415 build_and_test),
416 'cipher_padding': ExclusiveDomain(cipher_padding_symbols,
417 build_and_test),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100418 # Elliptic curves. Run the test suites.
419 'curves': ExclusiveDomain(curve_symbols, build_and_test),
420 # Hash algorithms. Exclude configurations with only one
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400421 # hash which is obsolete. Run the test suites. Exclude
422 # SHA512 and SHA256, as these are tested with SHA384 and SHA224.
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400423 'hashes': DualDomain(hash_symbols, build_and_test,
424 exclude=r'MBEDTLS_(MD|RIPEMD|SHA1_|SHA256_|SHA512_)' \
425 '|!MBEDTLS_(SHA256_|SHA512_)'),
Gilles Peskinec3b4dee2019-01-29 19:33:05 +0100426 # Key exchange types. Only build the library and the sample
427 # programs.
428 'kex': ExclusiveDomain(key_exchange_symbols,
429 [build_command + ['lib'],
430 build_command + ['-C', 'programs']]),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100431 'pkalgs': ComplementaryDomain(['MBEDTLS_ECDSA_C',
432 'MBEDTLS_ECP_C',
433 'MBEDTLS_PKCS1_V21',
434 'MBEDTLS_PKCS1_V15',
435 'MBEDTLS_RSA_C',
436 'MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
437 build_and_test),
438 }
439 self.jobs = {}
440 for domain in self.domains.values():
441 for job in domain.jobs:
442 self.jobs[job.name] = job
443
444 def get_jobs(self, name):
445 """Return the list of jobs identified by the given name.
446A name can either be the name of a domain or the name of one specific job."""
447 if name in self.domains:
448 return sorted(self.domains[name].jobs, key=lambda job: job.name)
449 else:
450 return [self.jobs[name]]
451
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100452def run(options, job, colors=NO_COLORS):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100453 """Run the specified job (a Job instance)."""
454 subprocess.check_call([options.make_command, 'clean'])
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100455 job.announce(colors, None)
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100456 job.configure(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100457 success = job.test(options)
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100458 job.announce(colors, success)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100459 return success
460
Andrzej Kurek3322c222022-10-04 15:02:41 -0400461def run_tests(options, domain_data):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100462 """Run the desired jobs.
463domain_data should be a DomainData instance that describes the available
464domains and jobs.
465Run the jobs listed in options.domains."""
466 if not hasattr(options, 'config_backup'):
467 options.config_backup = options.config + '.bak'
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100468 colors = Colors(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100469 jobs = []
470 failures = []
471 successes = []
472 for name in options.domains:
473 jobs += domain_data.get_jobs(name)
474 backup_config(options)
475 try:
476 for job in jobs:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100477 success = run(options, job, colors=colors)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100478 if not success:
479 if options.keep_going:
480 failures.append(job.name)
481 else:
482 return False
483 else:
484 successes.append(job.name)
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100485 restore_config(options)
486 except:
487 # Restore the configuration, except in stop-on-error mode if there
488 # was an error, where we leave the failing configuration up for
489 # developer convenience.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100490 if options.keep_going:
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100491 restore_config(options)
492 raise
Gilles Peskinee85163b2019-01-29 18:50:03 +0100493 if successes:
494 log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100495 if failures:
Gilles Peskinee85163b2019-01-29 18:50:03 +0100496 log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100497 return False
498 else:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100499 return True
500
Andrzej Kurek3322c222022-10-04 15:02:41 -0400501def main():
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100502 try:
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400503 parser = argparse.ArgumentParser(
504 formatter_class=argparse.RawDescriptionHelpFormatter,
505 description=
506 "Test Mbed TLS with a subset of algorithms.\n\n"
507 "Example usage:\n"
508 r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA224_C""\n"
509 "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n"
510 "./tests/scripts/depends.py cipher_id cipher_chaining\n")
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100511 parser.add_argument('--color', metavar='WHEN',
512 help='Colorize the output (always/auto/never)',
513 choices=['always', 'auto', 'never'], default='auto')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100514 parser.add_argument('-c', '--config', metavar='FILE',
515 help='Configuration file to modify',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400516 default='include/mbedtls/mbedtls_config.h')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100517 parser.add_argument('-C', '--directory', metavar='DIR',
518 help='Change to this directory before anything else',
519 default='.')
520 parser.add_argument('-k', '--keep-going',
521 help='Try all configurations even if some fail (default)',
522 action='store_true', dest='keep_going', default=True)
523 parser.add_argument('-e', '--no-keep-going',
524 help='Stop as soon as a configuration fails',
525 action='store_false', dest='keep_going')
526 parser.add_argument('--list-jobs',
527 help='List supported jobs and exit',
528 action='append_const', dest='list', const='jobs')
529 parser.add_argument('--list-domains',
530 help='List supported domains and exit',
531 action='append_const', dest='list', const='domains')
532 parser.add_argument('--make-command', metavar='CMD',
533 help='Command to run instead of make (e.g. gmake)',
534 action='store', default='make')
535 parser.add_argument('domains', metavar='DOMAIN', nargs='*',
Andrzej Kurek3322c222022-10-04 15:02:41 -0400536 help='The domain(s) to test (default: all). This can \
537 be also a list of jobs to run.',
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100538 default=True)
539 options = parser.parse_args()
540 os.chdir(options.directory)
541 domain_data = DomainData(options)
Andrzej Kurek3322c222022-10-04 15:02:41 -0400542 if options.domains is True:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100543 options.domains = sorted(domain_data.domains.keys())
544 if options.list:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400545 for arg in options.list:
546 for domain_name in sorted(getattr(domain_data, arg).keys()):
547 print(domain_name)
548 sys.exit(0)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100549 else:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400550 sys.exit(0 if run_tests(options, domain_data) else 1)
551 except Exception: # pylint: disable=broad-except
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100552 traceback.print_exc()
Andrzej Kurek3322c222022-10-04 15:02:41 -0400553 sys.exit(3)
554
555if __name__ == '__main__':
556 main()