blob: 67bf6ddff731bbd71cd5a6bf9fac8c847984f317 [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
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:
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 Kurek01af84a2022-10-09 05:29:44 -040047 - MBEDTLS_SHA512_C job turns off all hashes except SHA512. MBEDTLS_SSL_COOKIE_C
48 requires either SHA256 or SHA384 to work, so it also has to be disabled.
49 This is not a dependency on SHA512_C, but a result of an exclusive domain
50 config building method. Relevant field:
Andrzej Kurek629c4122022-10-17 08:34:40 -040051 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_COOKIE_C'],
Andrzej Kurek01af84a2022-10-09 05:29:44 -040052
53- DualDomain - combination of the two above - both complementary and exclusive domain
54 job generation code will be run. Currently only used for hashes.
55
56Lastly, the collected jobs are executed and (optionally) tested, with
57error reporting and coloring as configured in options. Each test starts with
58a full config without a couple of slowing down or unnecessary options
59(see set_reference_config), then the specific job config is derived.
60"""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010061import argparse
62import os
63import re
64import shutil
65import subprocess
66import sys
67import traceback
68
Andrzej Kurek3322c222022-10-04 15:02:41 -040069class Colors: # pylint: disable=too-few-public-methods
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010070 """Minimalistic support for colored output.
71Each field of an object of this class is either None if colored output
72is not possible or not desired, or a pair of strings (start, stop) such
73that outputting start switches the text color to the desired color and
74stop switches the text color back to the default."""
75 red = None
76 green = None
77 bold_red = None
78 bold_green = None
79 def __init__(self, options=None):
Andrzej Kurek3322c222022-10-04 15:02:41 -040080 """Initialize color profile according to passed options."""
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010081 if not options or options.color in ['no', 'never']:
82 want_color = False
83 elif options.color in ['yes', 'always']:
84 want_color = True
85 else:
86 want_color = sys.stderr.isatty()
87 if want_color:
88 # Assume ANSI compatible terminal
89 normal = '\033[0m'
90 self.red = ('\033[31m', normal)
91 self.green = ('\033[32m', normal)
92 self.bold_red = ('\033[1;31m', normal)
93 self.bold_green = ('\033[1;32m', normal)
94NO_COLORS = Colors(None)
95
96def log_line(text, prefix='depends.py:', suffix='', color=None):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010097 """Print a status message."""
Andrzej Kurek3322c222022-10-04 15:02:41 -040098 if color is not None:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010099 prefix = color[0] + prefix
100 suffix = suffix + color[1]
101 sys.stderr.write(prefix + ' ' + text + suffix + '\n')
Gilles Peskine46c82562019-01-29 18:42:55 +0100102 sys.stderr.flush()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100103
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100104def log_command(cmd):
105 """Print a trace of the specified command.
106cmd is a list of strings: a command name and its arguments."""
107 log_line(' '.join(cmd), prefix='+')
108
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100109def backup_config(options):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400110 """Back up the library configuration file (mbedtls_config.h).
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100111If the backup file already exists, it is presumed to be the desired backup,
112so don't make another backup."""
113 if os.path.exists(options.config_backup):
114 options.own_backup = False
115 else:
116 options.own_backup = True
117 shutil.copy(options.config, options.config_backup)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100118
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100119def restore_config(options):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400120 """Restore the library configuration file (mbedtls_config.h).
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100121Remove the backup file if it was saved earlier."""
122 if options.own_backup:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100123 shutil.move(options.config_backup, options.config)
124 else:
125 shutil.copy(options.config_backup, options.config)
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100126
Andrzej Kureka44c5bc2022-10-16 12:52:20 -0400127def run_config_py(options, args):
Andrzej Kurek3322c222022-10-04 15:02:41 -0400128 """Run scripts/config.py with the specified arguments."""
129 cmd = ['scripts/config.py']
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400130 if options.config != 'include/mbedtls/mbedtls_config.h':
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100131 cmd += ['--file', options.config]
132 cmd += args
133 log_command(cmd)
134 subprocess.check_call(cmd)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100135
Andrzej Kurek3322c222022-10-04 15:02:41 -0400136def set_reference_config(options):
137 """Change the library configuration file (mbedtls_config.h) to the reference state.
138The reference state is the one from which the tested configurations are
139derived."""
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400140 # Turn off options that are not relevant to the tests and slow them down.
Andrzej Kureka44c5bc2022-10-16 12:52:20 -0400141 run_config_py(options, ['full'])
Andrzej Kureka44c5bc2022-10-16 12:52:20 -0400142 run_config_py(options, ['unset', 'MBEDTLS_TEST_HOOKS'])
Andrzej Kurek2c7993c2022-10-24 10:41:20 -0400143 if options.unset_use_psa:
144 run_config_py(options, ['unset', 'MBEDTLS_USE_PSA_CRYPTO'])
Andrzej Kurek3322c222022-10-04 15:02:41 -0400145
146def collect_config_symbols(options):
147 """Read the list of settings from mbedtls_config.h.
148Return them in a generator."""
149 with open(options.config, encoding="utf-8") as config_file:
150 rx = re.compile(r'\s*(?://\s*)?#define\s+(\w+)\s*(?:$|/[/*])')
151 for line in config_file:
152 m = re.match(rx, line)
153 if m:
154 yield m.group(1)
155
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100156class Job:
157 """A job builds the library in a specific configuration and runs some tests."""
158 def __init__(self, name, config_settings, commands):
159 """Build a job object.
160The job uses the configuration described by config_settings. This is a
161dictionary where the keys are preprocessor symbols and the values are
162booleans or strings. A boolean indicates whether or not to #define the
163symbol. With a string, the symbol is #define'd to that value.
164After setting the configuration, the job runs the programs specified by
165commands. This is a list of lists of strings; each list of string is a
166command name and its arguments and is passed to subprocess.call with
167shell=False."""
168 self.name = name
169 self.config_settings = config_settings
170 self.commands = commands
171
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100172 def announce(self, colors, what):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100173 '''Announce the start or completion of a job.
174If what is None, announce the start of the job.
175If what is True, announce that the job has passed.
176If what is False, announce that the job has failed.'''
177 if what is True:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100178 log_line(self.name + ' PASSED', color=colors.green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100179 elif what is False:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100180 log_line(self.name + ' FAILED', color=colors.red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100181 else:
182 log_line('starting ' + self.name)
183
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100184 def configure(self, options):
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400185 '''Set library configuration options as required for the job.'''
Andrzej Kurek3322c222022-10-04 15:02:41 -0400186 set_reference_config(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100187 for key, value in sorted(self.config_settings.items()):
188 if value is True:
189 args = ['set', key]
190 elif value is False:
191 args = ['unset', key]
192 else:
193 args = ['set', key, value]
Andrzej Kureka44c5bc2022-10-16 12:52:20 -0400194 run_config_py(options, args)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100195
196 def test(self, options):
197 '''Run the job's build and test commands.
198Return True if all the commands succeed and False otherwise.
199If options.keep_going is false, stop as soon as one command fails. Otherwise
200run all the commands, except that if the first command fails, none of the
201other commands are run (typically, the first command is a build command
202and subsequent commands are tests that cannot run if the build failed).'''
203 built = False
204 success = True
205 for command in self.commands:
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100206 log_command(command)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100207 ret = subprocess.call(command)
208 if ret != 0:
209 if command[0] not in ['make', options.make_command]:
210 log_line('*** [{}] Error {}'.format(' '.join(command), ret))
211 if not options.keep_going or not built:
212 return False
213 success = False
214 built = True
215 return success
216
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100217# If the configuration option A requires B, make sure that
Andrzej Kurek202932f2022-10-04 16:22:22 -0400218# B in REVERSE_DEPENDENCIES[A].
Gilles Peskine584c24a2019-01-29 19:30:40 +0100219# All the information here should be contained in check_config.h. This
220# file includes a copy because it changes rarely and it would be a pain
221# to extract automatically.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400222REVERSE_DEPENDENCIES = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100223 'MBEDTLS_AES_C': ['MBEDTLS_CTR_DRBG_C',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400224 'MBEDTLS_NIST_KW_C'],
Gilles Peskine34a15572019-01-29 23:12:28 +0100225 'MBEDTLS_CHACHA20_C': ['MBEDTLS_CHACHAPOLY_C'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400226 'MBEDTLS_ECDSA_C': ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
227 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100228 'MBEDTLS_ECP_C': ['MBEDTLS_ECDSA_C',
229 'MBEDTLS_ECDH_C',
230 'MBEDTLS_ECJPAKE_C',
231 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
232 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED',
233 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED',
234 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400235 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
Ronald Crond8d2ea52022-10-04 15:48:06 +0200236 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
237 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED',
238 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100239 'MBEDTLS_ECP_DP_SECP256R1_ENABLED': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100240 'MBEDTLS_PKCS1_V21': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
241 'MBEDTLS_PKCS1_V15': ['MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
242 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
243 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
244 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'],
245 'MBEDTLS_RSA_C': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT',
246 'MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
247 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
248 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400249 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED',
250 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100251 'MBEDTLS_SHA256_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400252 'MBEDTLS_ENTROPY_FORCE_SHA256',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400253 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kurek22b959d2022-10-16 12:51:41 -0400254 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY',
255 'MBEDTLS_LMS_C',
256 'MBEDTLS_LMS_PRIVATE'],
Valerio Settie7221a22022-12-16 11:53:45 +0100257 'MBEDTLS_SHA512_C': ['MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400258 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY'],
259 'MBEDTLS_SHA224_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
260 'MBEDTLS_ENTROPY_FORCE_SHA256',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400261 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
262 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400263 'MBEDTLS_X509_RSASSA_PSS_SUPPORT': []
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100264}
265
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400266# If an option is tested in an exclusive test, alter the following defines.
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400267# These are not necessarily dependencies, but just minimal required changes
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400268# if a given define is the only one enabled from an exclusive group.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400269EXCLUSIVE_GROUPS = {
Andrzej Kurek65b2ac12022-10-14 08:09:16 -0400270 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_COOKIE_C',
271 '-MBEDTLS_SSL_PROTO_TLS1_3'],
272 'MBEDTLS_ECP_DP_CURVE448_ENABLED': ['-MBEDTLS_ECDSA_C',
273 '-MBEDTLS_ECDSA_DETERMINISTIC',
274 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
275 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
276 '-MBEDTLS_ECJPAKE_C',
277 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
278 'MBEDTLS_ECP_DP_CURVE25519_ENABLED': ['-MBEDTLS_ECDSA_C',
279 '-MBEDTLS_ECDSA_DETERMINISTIC',
280 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
281 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
282 '-MBEDTLS_ECJPAKE_C',
283 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
284 'MBEDTLS_ARIA_C': ['-MBEDTLS_CMAC_C'],
285 'MBEDTLS_CAMELLIA_C': ['-MBEDTLS_CMAC_C'],
286 'MBEDTLS_CHACHA20_C': ['-MBEDTLS_CMAC_C', '-MBEDTLS_CCM_C', '-MBEDTLS_GCM_C'],
287 'MBEDTLS_DES_C': ['-MBEDTLS_CCM_C',
288 '-MBEDTLS_GCM_C',
289 '-MBEDTLS_SSL_TICKET_C',
290 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400291}
292def handle_exclusive_groups(config_settings, symbol):
293 """For every symbol tested in an exclusive group check if there are other
294defines to be altered. """
Andrzej Kurek202932f2022-10-04 16:22:22 -0400295 for dep in EXCLUSIVE_GROUPS.get(symbol, []):
Andrzej Kurek65b2ac12022-10-14 08:09:16 -0400296 unset = dep.startswith('-')
297 dep = dep[1:]
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400298 config_settings[dep] = not unset
299
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100300def turn_off_dependencies(config_settings):
301 """For every option turned off config_settings, also turn off what depends on it.
302An option O is turned off if config_settings[O] is False."""
303 for key, value in sorted(config_settings.items()):
304 if value is not False:
305 continue
Andrzej Kurek202932f2022-10-04 16:22:22 -0400306 for dep in REVERSE_DEPENDENCIES.get(key, []):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100307 config_settings[dep] = False
308
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400309class BaseDomain: # pylint: disable=too-few-public-methods, unused-argument
310 """A base class for all domains."""
311 def __init__(self, symbols, commands, exclude):
312 """Initialize the jobs container"""
313 self.jobs = []
314
315class ExclusiveDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100316 """A domain consisting of a set of conceptually-equivalent settings.
317Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurekfe469492022-10-06 16:57:38 -0400318with this symbol set and the others unset."""
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100319 def __init__(self, symbols, commands, exclude=None):
320 """Build a domain for the specified list of configuration symbols.
Andrzej Kurekfe469492022-10-06 16:57:38 -0400321The domain contains a set of jobs that enable one of the elements
322of symbols and disable the others.
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100323Each job runs the specified commands.
324If exclude is a regular expression, skip generated jobs whose description
325would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400326 super().__init__(symbols, commands, exclude)
Andrzej Kurekfe469492022-10-06 16:57:38 -0400327 base_config_settings = {}
328 for symbol in symbols:
329 base_config_settings[symbol] = False
330 for symbol in symbols:
331 description = symbol
332 if exclude and re.match(exclude, description):
333 continue
334 config_settings = base_config_settings.copy()
335 config_settings[symbol] = True
336 handle_exclusive_groups(config_settings, symbol)
337 turn_off_dependencies(config_settings)
338 job = Job(description, config_settings, commands)
339 self.jobs.append(job)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100340
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400341class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100342 """A domain consisting of a set of loosely-related settings.
343Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400344with this symbol unset.
345If exclude is a regular expression, skip generated jobs whose description
346would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400347 def __init__(self, symbols, commands, exclude=None):
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100348 """Build a domain for the specified list of configuration symbols.
349Each job in the domain disables one of the specified symbols.
350Each job runs the specified commands."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400351 super().__init__(symbols, commands, exclude)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100352 for symbol in symbols:
353 description = '!' + symbol
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400354 if exclude and re.match(exclude, description):
355 continue
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100356 config_settings = {symbol: False}
357 turn_off_dependencies(config_settings)
358 job = Job(description, config_settings, commands)
359 self.jobs.append(job)
360
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400361class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400362 """A domain that contains both the ExclusiveDomain and BaseDomain tests.
Andrzej Kurekf4b18672022-10-14 07:57:00 -0400363Both parent class __init__ calls are performed in any order and
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400364each call adds respective jobs. The job array initialization is done once in
365BaseDomain, before the parent __init__ calls."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400366
Andrzej Kurek3322c222022-10-04 15:02:41 -0400367class CipherInfo: # pylint: disable=too-few-public-methods
Gilles Peskine34a15572019-01-29 23:12:28 +0100368 """Collect data about cipher.h."""
Andrzej Kurek3322c222022-10-04 15:02:41 -0400369 def __init__(self):
Gilles Peskine34a15572019-01-29 23:12:28 +0100370 self.base_symbols = set()
Andrzej Kurek3322c222022-10-04 15:02:41 -0400371 with open('include/mbedtls/cipher.h', encoding="utf-8") as fh:
Gilles Peskine34a15572019-01-29 23:12:28 +0100372 for line in fh:
373 m = re.match(r' *MBEDTLS_CIPHER_ID_(\w+),', line)
374 if m and m.group(1) not in ['NONE', 'NULL', '3DES']:
375 self.base_symbols.add('MBEDTLS_' + m.group(1) + '_C')
376
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100377class DomainData:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400378 """A container for domains and jobs, used to structurize testing."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100379 def config_symbols_matching(self, regexp):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400380 """List the mbedtls_config.h settings matching regexp."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100381 return [symbol for symbol in self.all_config_symbols
382 if re.match(regexp, symbol)]
383
384 def __init__(self, options):
385 """Gather data about the library and establish a list of domains to test."""
386 build_command = [options.make_command, 'CFLAGS=-Werror']
387 build_and_test = [build_command, [options.make_command, 'test']]
Andrzej Kurek3322c222022-10-04 15:02:41 -0400388 self.all_config_symbols = set(collect_config_symbols(options))
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100389 # Find hash modules by name.
390 hash_symbols = self.config_symbols_matching(r'MBEDTLS_(MD|RIPEMD|SHA)[0-9]+_C\Z')
391 # Find elliptic curve enabling macros by name.
392 curve_symbols = self.config_symbols_matching(r'MBEDTLS_ECP_DP_\w+_ENABLED\Z')
393 # Find key exchange enabling macros by name.
394 key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z')
Gilles Peskine34a15572019-01-29 23:12:28 +0100395 # Find cipher IDs (block permutations and stream ciphers --- chaining
396 # and padding modes are exercised separately) information by parsing
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400397 # cipher.h, as the information is not readily available in mbedtls_config.h.
Andrzej Kurek3322c222022-10-04 15:02:41 -0400398 cipher_info = CipherInfo()
Gilles Peskine34a15572019-01-29 23:12:28 +0100399 # Find block cipher chaining and padding mode enabling macros by name.
400 cipher_chaining_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_MODE_\w+\Z')
401 cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100402 self.domains = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100403 # Cipher IDs, chaining modes and padding modes. Run the test suites.
404 'cipher_id': ExclusiveDomain(cipher_info.base_symbols,
405 build_and_test),
406 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols,
407 build_and_test),
408 'cipher_padding': ExclusiveDomain(cipher_padding_symbols,
409 build_and_test),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100410 # Elliptic curves. Run the test suites.
411 'curves': ExclusiveDomain(curve_symbols, build_and_test),
Valerio Settib6bf7dc2022-12-22 14:28:03 +0100412 # Hash algorithms. Exclude two groups:
413 # - Exclusive domain of MD, RIPEMD, SHA1;
414 # - Exclusive domain of SHA224 and SHA384, because MBEDTLS_ENTROPY_C
415 # is extensively used across various modules, but it depends on
416 # either SHA256 or SHA512. As a consequence an "exclusive" test
417 # of SHA224/SHA384 with MBEDTLS_ENTROPY_C enabled is not possible.
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400418 'hashes': DualDomain(hash_symbols, build_and_test,
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400419 exclude=r'MBEDTLS_(MD|RIPEMD|SHA1_)' \
Valerio Settib6bf7dc2022-12-22 14:28:03 +0100420 '|MBEDTLS_SHA224_' \
421 '|MBEDTLS_SHA384_'),
Gilles Peskinec3b4dee2019-01-29 19:33:05 +0100422 # Key exchange types. Only build the library and the sample
423 # programs.
424 'kex': ExclusiveDomain(key_exchange_symbols,
425 [build_command + ['lib'],
426 build_command + ['-C', 'programs']]),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100427 'pkalgs': ComplementaryDomain(['MBEDTLS_ECDSA_C',
428 'MBEDTLS_ECP_C',
429 'MBEDTLS_PKCS1_V21',
430 'MBEDTLS_PKCS1_V15',
431 'MBEDTLS_RSA_C',
432 'MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
433 build_and_test),
434 }
435 self.jobs = {}
436 for domain in self.domains.values():
437 for job in domain.jobs:
438 self.jobs[job.name] = job
439
440 def get_jobs(self, name):
441 """Return the list of jobs identified by the given name.
442A name can either be the name of a domain or the name of one specific job."""
443 if name in self.domains:
444 return sorted(self.domains[name].jobs, key=lambda job: job.name)
445 else:
446 return [self.jobs[name]]
447
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100448def run(options, job, colors=NO_COLORS):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100449 """Run the specified job (a Job instance)."""
450 subprocess.check_call([options.make_command, 'clean'])
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100451 job.announce(colors, None)
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100452 job.configure(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100453 success = job.test(options)
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100454 job.announce(colors, success)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100455 return success
456
Andrzej Kurek3322c222022-10-04 15:02:41 -0400457def run_tests(options, domain_data):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100458 """Run the desired jobs.
459domain_data should be a DomainData instance that describes the available
460domains and jobs.
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400461Run the jobs listed in options.tasks."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100462 if not hasattr(options, 'config_backup'):
463 options.config_backup = options.config + '.bak'
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100464 colors = Colors(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100465 jobs = []
466 failures = []
467 successes = []
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400468 for name in options.tasks:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100469 jobs += domain_data.get_jobs(name)
470 backup_config(options)
471 try:
472 for job in jobs:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100473 success = run(options, job, colors=colors)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100474 if not success:
475 if options.keep_going:
476 failures.append(job.name)
477 else:
478 return False
479 else:
480 successes.append(job.name)
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100481 restore_config(options)
482 except:
483 # Restore the configuration, except in stop-on-error mode if there
484 # was an error, where we leave the failing configuration up for
485 # developer convenience.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100486 if options.keep_going:
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100487 restore_config(options)
488 raise
Gilles Peskinee85163b2019-01-29 18:50:03 +0100489 if successes:
490 log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100491 if failures:
Gilles Peskinee85163b2019-01-29 18:50:03 +0100492 log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100493 return False
494 else:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100495 return True
496
Andrzej Kurek3322c222022-10-04 15:02:41 -0400497def main():
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100498 try:
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400499 parser = argparse.ArgumentParser(
500 formatter_class=argparse.RawDescriptionHelpFormatter,
501 description=
502 "Test Mbed TLS with a subset of algorithms.\n\n"
503 "Example usage:\n"
Andrzej Kurek629c4122022-10-17 08:34:40 -0400504 r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA256_C""\n"
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400505 "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n"
506 "./tests/scripts/depends.py cipher_id cipher_chaining\n")
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100507 parser.add_argument('--color', metavar='WHEN',
508 help='Colorize the output (always/auto/never)',
509 choices=['always', 'auto', 'never'], default='auto')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100510 parser.add_argument('-c', '--config', metavar='FILE',
511 help='Configuration file to modify',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400512 default='include/mbedtls/mbedtls_config.h')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100513 parser.add_argument('-C', '--directory', metavar='DIR',
514 help='Change to this directory before anything else',
515 default='.')
516 parser.add_argument('-k', '--keep-going',
517 help='Try all configurations even if some fail (default)',
518 action='store_true', dest='keep_going', default=True)
519 parser.add_argument('-e', '--no-keep-going',
520 help='Stop as soon as a configuration fails',
521 action='store_false', dest='keep_going')
522 parser.add_argument('--list-jobs',
523 help='List supported jobs and exit',
524 action='append_const', dest='list', const='jobs')
525 parser.add_argument('--list-domains',
526 help='List supported domains and exit',
527 action='append_const', dest='list', const='domains')
528 parser.add_argument('--make-command', metavar='CMD',
529 help='Command to run instead of make (e.g. gmake)',
530 action='store', default='make')
Andrzej Kurek2c7993c2022-10-24 10:41:20 -0400531 parser.add_argument('--unset-use-psa',
532 help='Unset MBEDTLS_USE_PSA_CRYPTO before any test',
533 action='store_true', dest='unset_use_psa')
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400534 parser.add_argument('tasks', metavar='TASKS', nargs='*',
535 help='The domain(s) or job(s) to test (default: all).',
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100536 default=True)
537 options = parser.parse_args()
538 os.chdir(options.directory)
539 domain_data = DomainData(options)
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400540 if options.tasks is True:
541 options.tasks = sorted(domain_data.domains.keys())
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100542 if options.list:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400543 for arg in options.list:
544 for domain_name in sorted(getattr(domain_data, arg).keys()):
545 print(domain_name)
546 sys.exit(0)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100547 else:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400548 sys.exit(0 if run_tests(options, domain_data) else 1)
549 except Exception: # pylint: disable=broad-except
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100550 traceback.print_exc()
Andrzej Kurek3322c222022-10-04 15:02:41 -0400551 sys.exit(3)
552
553if __name__ == '__main__':
554 main()