blob: 2c38f9d7054e64147f9e1e3652051e6a03c810da [file] [log] [blame]
Gilles Peskinef5ea1972019-01-29 08:50:20 +01001#!/usr/bin/env python3
2
Andrzej Kurekffbc8f52022-10-17 08:34:40 -04003# Copyright (c) 2022, Arm Limited, All Rights Reserved.
Gilles Peskinef5ea1972019-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 Peskinef5ea1972019-01-29 08:50:20 +010020"""
Andrzej Kurek110fc482022-10-09 05:29:44 -040021Test Mbed TLS with a subset of algorithms.
Gilles Peskinef5ea1972019-01-29 08:50:20 +010022
Andrzej Kurek110fc482022-10-09 05:29:44 -040023This script can be divided into several steps:
24
Andrzej Kurek467a0f22022-10-20 06:15:06 -040025First, include/mbedtls/config.h or a different config file passed
Andrzej Kurek110fc482022-10-09 05:29:44 -040026in 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 Kurekffbc8f52022-10-17 08:34:40 -040030- domain name, can be used to run only specific tests via command-line;
Andrzej Kurek110fc482022-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.
Andrzej Kurek110fc482022-10-09 05:29:44 -040046
47- DualDomain - combination of the two above - both complementary and exclusive domain
48 job generation code will be run. Currently only used for hashes.
49
50Lastly, the collected jobs are executed and (optionally) tested, with
51error reporting and coloring as configured in options. Each test starts with
52a full config without a couple of slowing down or unnecessary options
53(see set_reference_config), then the specific job config is derived.
54"""
Gilles Peskinef5ea1972019-01-29 08:50:20 +010055import argparse
56import os
57import re
58import shutil
59import subprocess
60import sys
61import traceback
62
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -040063class Colors: # pylint: disable=too-few-public-methods
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010064 """Minimalistic support for colored output.
65Each field of an object of this class is either None if colored output
66is not possible or not desired, or a pair of strings (start, stop) such
67that outputting start switches the text color to the desired color and
68stop switches the text color back to the default."""
69 red = None
70 green = None
71 bold_red = None
72 bold_green = None
73 def __init__(self, options=None):
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -040074 """Initialize color profile according to passed options."""
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010075 if not options or options.color in ['no', 'never']:
76 want_color = False
77 elif options.color in ['yes', 'always']:
78 want_color = True
79 else:
80 want_color = sys.stderr.isatty()
81 if want_color:
82 # Assume ANSI compatible terminal
83 normal = '\033[0m'
84 self.red = ('\033[31m', normal)
85 self.green = ('\033[32m', normal)
86 self.bold_red = ('\033[1;31m', normal)
87 self.bold_green = ('\033[1;32m', normal)
88NO_COLORS = Colors(None)
89
90def log_line(text, prefix='depends.py:', suffix='', color=None):
Gilles Peskinef5ea1972019-01-29 08:50:20 +010091 """Print a status message."""
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -040092 if color is not None:
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010093 prefix = color[0] + prefix
94 suffix = suffix + color[1]
95 sys.stderr.write(prefix + ' ' + text + suffix + '\n')
Gilles Peskinee6a60db2019-01-29 18:42:55 +010096 sys.stderr.flush()
Gilles Peskinef5ea1972019-01-29 08:50:20 +010097
Gilles Peskined43ce2b2019-01-29 18:46:34 +010098def log_command(cmd):
99 """Print a trace of the specified command.
100cmd is a list of strings: a command name and its arguments."""
101 log_line(' '.join(cmd), prefix='+')
102
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100103def backup_config(options):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400104 """Back up the library configuration file (config.h).
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100105If the backup file already exists, it is presumed to be the desired backup,
106so don't make another backup."""
107 if os.path.exists(options.config_backup):
108 options.own_backup = False
109 else:
110 options.own_backup = True
111 shutil.copy(options.config, options.config_backup)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100112
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100113def restore_config(options):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400114 """Restore the library configuration file (config.h).
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100115Remove the backup file if it was saved earlier."""
116 if options.own_backup:
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100117 shutil.move(options.config_backup, options.config)
118 else:
119 shutil.copy(options.config_backup, options.config)
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100120
Andrzej Kurekbec35a12022-10-16 12:52:20 -0400121def run_config_py(options, args):
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400122 """Run scripts/config.py with the specified arguments."""
123 cmd = ['scripts/config.py']
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400124 if options.config != 'include/mbedtls/config.h':
Gilles Peskined43ce2b2019-01-29 18:46:34 +0100125 cmd += ['--file', options.config]
126 cmd += args
127 log_command(cmd)
128 subprocess.check_call(cmd)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100129
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400130def set_reference_config(options):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400131 """Change the library configuration file (config.h) to the reference state.
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400132The reference state is the one from which the tested configurations are
133derived."""
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400134 # Turn off options that are not relevant to the tests and slow them down.
Andrzej Kurekbec35a12022-10-16 12:52:20 -0400135 run_config_py(options, ['full'])
Andrzej Kurekbec35a12022-10-16 12:52:20 -0400136 run_config_py(options, ['unset', 'MBEDTLS_TEST_HOOKS'])
Andrzej Kurek2b44a922022-10-24 10:41:20 -0400137 if options.unset_use_psa:
138 run_config_py(options, ['unset', 'MBEDTLS_USE_PSA_CRYPTO'])
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400139
140def collect_config_symbols(options):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400141 """Read the list of settings from config.h.
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400142Return them in a generator."""
143 with open(options.config, encoding="utf-8") as config_file:
144 rx = re.compile(r'\s*(?://\s*)?#define\s+(\w+)\s*(?:$|/[/*])')
145 for line in config_file:
146 m = re.match(rx, line)
147 if m:
148 yield m.group(1)
149
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100150class Job:
151 """A job builds the library in a specific configuration and runs some tests."""
152 def __init__(self, name, config_settings, commands):
153 """Build a job object.
154The job uses the configuration described by config_settings. This is a
155dictionary where the keys are preprocessor symbols and the values are
156booleans or strings. A boolean indicates whether or not to #define the
157symbol. With a string, the symbol is #define'd to that value.
158After setting the configuration, the job runs the programs specified by
159commands. This is a list of lists of strings; each list of string is a
160command name and its arguments and is passed to subprocess.call with
161shell=False."""
162 self.name = name
163 self.config_settings = config_settings
164 self.commands = commands
165
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100166 def announce(self, colors, what):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100167 '''Announce the start or completion of a job.
168If what is None, announce the start of the job.
169If what is True, announce that the job has passed.
170If what is False, announce that the job has failed.'''
171 if what is True:
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100172 log_line(self.name + ' PASSED', color=colors.green)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100173 elif what is False:
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100174 log_line(self.name + ' FAILED', color=colors.red)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100175 else:
176 log_line('starting ' + self.name)
177
Gilles Peskined43ce2b2019-01-29 18:46:34 +0100178 def configure(self, options):
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400179 '''Set library configuration options as required for the job.'''
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400180 set_reference_config(options)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100181 for key, value in sorted(self.config_settings.items()):
182 if value is True:
183 args = ['set', key]
184 elif value is False:
185 args = ['unset', key]
186 else:
187 args = ['set', key, value]
Andrzej Kurekbec35a12022-10-16 12:52:20 -0400188 run_config_py(options, args)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100189
190 def test(self, options):
191 '''Run the job's build and test commands.
192Return True if all the commands succeed and False otherwise.
193If options.keep_going is false, stop as soon as one command fails. Otherwise
194run all the commands, except that if the first command fails, none of the
195other commands are run (typically, the first command is a build command
196and subsequent commands are tests that cannot run if the build failed).'''
197 built = False
198 success = True
199 for command in self.commands:
Gilles Peskined43ce2b2019-01-29 18:46:34 +0100200 log_command(command)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100201 ret = subprocess.call(command)
202 if ret != 0:
203 if command[0] not in ['make', options.make_command]:
204 log_line('*** [{}] Error {}'.format(' '.join(command), ret))
205 if not options.keep_going or not built:
206 return False
207 success = False
208 built = True
209 return success
210
211# SSL/TLS versions up to 1.1 and corresponding options. These require
212# both MD5 and SHA-1.
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400213SSL_PRE_1_2_DEPENDENCIES = ['MBEDTLS_SSL_CBC_RECORD_SPLITTING',
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100214 'MBEDTLS_SSL_PROTO_SSL3',
215 'MBEDTLS_SSL_PROTO_TLS1',
216 'MBEDTLS_SSL_PROTO_TLS1_1']
217
218# If the configuration option A requires B, make sure that
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400219# B in REVERSE_DEPENDENCIES[A].
Gilles Peskineb81f4062019-01-29 19:30:40 +0100220# All the information here should be contained in check_config.h. This
221# file includes a copy because it changes rarely and it would be a pain
222# to extract automatically.
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400223REVERSE_DEPENDENCIES = {
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100224 'MBEDTLS_AES_C': ['MBEDTLS_CTR_DRBG_C',
Andrzej Kurek90686252022-09-28 03:17:56 -0400225 'MBEDTLS_NIST_KW_C'],
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100226 'MBEDTLS_CHACHA20_C': ['MBEDTLS_CHACHAPOLY_C'],
Andrzej Kurek90686252022-09-28 03:17:56 -0400227 'MBEDTLS_ECDSA_C': ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
228 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'],
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100229 'MBEDTLS_ECP_C': ['MBEDTLS_ECDSA_C',
230 'MBEDTLS_ECDH_C',
231 'MBEDTLS_ECJPAKE_C',
232 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
233 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED',
234 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED',
235 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
Andrzej Kurek90686252022-09-28 03:17:56 -0400236 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
237 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Gilles Peskineb81f4062019-01-29 19:30:40 +0100238 'MBEDTLS_ECP_DP_SECP256R1_ENABLED': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400239 'MBEDTLS_MD5_C': SSL_PRE_1_2_DEPENDENCIES,
Gilles Peskinef5ea1972019-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 Kurek90686252022-09-28 03:17:56 -0400249 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED',
250 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED'],
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400251 'MBEDTLS_SHA1_C': SSL_PRE_1_2_DEPENDENCIES,
Gilles Peskineb81f4062019-01-29 19:30:40 +0100252 'MBEDTLS_SHA256_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
Andrzej Kurek90686252022-09-28 03:17:56 -0400253 'MBEDTLS_ENTROPY_FORCE_SHA256',
Andrzej Kurek90686252022-09-28 03:17:56 -0400254 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kurek0325ced2022-10-18 09:37:59 -0400255 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY'],
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400256 'MBEDTLS_SHA512_C': ['MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kurek90686252022-09-28 03:17:56 -0400257 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY'],
Andrzej Kurek90686252022-09-28 03:17:56 -0400258 'MBEDTLS_X509_RSASSA_PSS_SUPPORT': []
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100259}
260
Andrzej Kurek90686252022-09-28 03:17:56 -0400261# If an option is tested in an exclusive test, alter the following defines.
Andrzej Kurek110fc482022-10-09 05:29:44 -0400262# These are not necessarily dependencies, but just minimal required changes
Andrzej Kurek90686252022-09-28 03:17:56 -0400263# if a given define is the only one enabled from an exclusive group.
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400264EXCLUSIVE_GROUPS = {
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400265 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL'],
Andrzej Kurekf53d0ba2022-11-23 05:54:46 -0500266 'MBEDTLS_SHA512_NO_SHA384': ['+MBEDTLS_SHA512_C',
267 '-MBEDTLS_SSL_PROTO_TLS1_2',
268 '-MBEDTLS_SSL_PROTO_DTLS',
269 '-MBEDTLS_SSL_TLS_C',
270 '-MBEDTLS_SSL_CLI_C',
271 '-MBEDTLS_SSL_SRV_C',
272 '-MBEDTLS_SSL_DTLS_HELLO_VERIFY',
273 '-MBEDTLS_SSL_DTLS_ANTI_REPLAY',
274 '-MBEDTLS_SSL_DTLS_CONNECTION_ID',
275 '-MBEDTLS_SSL_DTLS_BADMAC_LIMIT',
276 '-MBEDTLS_SSL_ENCRYPT_THEN_MAC',
277 '-MBEDTLS_SSL_EXTENDED_MASTER_SECRET',
278 '-MBEDTLS_SSL_DTLS_SRTP',
279 '-MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE'],
Andrzej Kurek9cbdf102022-10-14 08:09:16 -0400280 'MBEDTLS_ECP_DP_CURVE448_ENABLED': ['-MBEDTLS_ECDSA_C',
281 '-MBEDTLS_ECDSA_DETERMINISTIC',
282 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
283 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
284 '-MBEDTLS_ECJPAKE_C',
285 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
286 'MBEDTLS_ECP_DP_CURVE25519_ENABLED': ['-MBEDTLS_ECDSA_C',
287 '-MBEDTLS_ECDSA_DETERMINISTIC',
288 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
289 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
290 '-MBEDTLS_ECJPAKE_C',
291 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
292 'MBEDTLS_ARIA_C': ['-MBEDTLS_CMAC_C'],
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400293 'MBEDTLS_ARC4_C': ['-MBEDTLS_CMAC_C',
294 '-MBEDTLS_CCM_C',
295 '-MBEDTLS_SSL_TICKET_C',
296 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION',
297 '-MBEDTLS_GCM_C'],
298 'MBEDTLS_BLOWFISH_C': ['-MBEDTLS_CMAC_C',
299 '-MBEDTLS_CCM_C',
300 '-MBEDTLS_SSL_TICKET_C',
301 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION',
302 '-MBEDTLS_GCM_C'],
Andrzej Kurek9cbdf102022-10-14 08:09:16 -0400303 '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 Kurek90686252022-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 Kurekfb3e27e2022-10-04 16:22:22 -0400313 for dep in EXCLUSIVE_GROUPS.get(symbol, []):
Andrzej Kurek9cbdf102022-10-14 08:09:16 -0400314 unset = dep.startswith('-')
315 dep = dep[1:]
Andrzej Kurek90686252022-09-28 03:17:56 -0400316 config_settings[dep] = not unset
317
Gilles Peskinef5ea1972019-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 Kurekfb3e27e2022-10-04 16:22:22 -0400324 for dep in REVERSE_DEPENDENCIES.get(key, []):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100325 config_settings[dep] = False
326
Andrzej Kurek068a73f2022-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 Peskinef5ea1972019-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 Kurek2e105b52022-10-06 16:57:38 -0400336with this symbol set and the others unset."""
Gilles Peskine3dd0dab2019-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 Kurek2e105b52022-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 Peskine3dd0dab2019-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 Kurek068a73f2022-10-06 18:52:44 -0400344 super().__init__(symbols, commands, exclude)
Andrzej Kurek2e105b52022-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 Peskinef5ea1972019-01-29 08:50:20 +0100358
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400359class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskinef5ea1972019-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 Kurek8b7a1572022-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 Kurek068a73f2022-10-06 18:52:44 -0400365 def __init__(self, symbols, commands, exclude=None):
Gilles Peskine3dd0dab2019-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 Kurek068a73f2022-10-06 18:52:44 -0400369 super().__init__(symbols, commands, exclude)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100370 for symbol in symbols:
371 description = '!' + symbol
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400372 if exclude and re.match(exclude, description):
373 continue
Gilles Peskinef5ea1972019-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 Kurek068a73f2022-10-06 18:52:44 -0400379class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400380 """A domain that contains both the ExclusiveDomain and BaseDomain tests.
Andrzej Kurek0325ced2022-10-18 09:37:59 -0400381Both parent class __init__ calls are performed in any order and
Andrzej Kurek8b7a1572022-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 Kurek068a73f2022-10-06 18:52:44 -0400384
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400385class CipherInfo: # pylint: disable=too-few-public-methods
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100386 """Collect data about cipher.h."""
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400387 def __init__(self):
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100388 self.base_symbols = set()
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400389 with open('include/mbedtls/cipher.h', encoding="utf-8") as fh:
Gilles Peskine3ce0e322019-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 Peskinef5ea1972019-01-29 08:50:20 +0100395class DomainData:
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400396 """A container for domains and jobs, used to structurize testing."""
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100397 def config_symbols_matching(self, regexp):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400398 """List the config.h settings matching regexp."""
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100399 return [symbol for symbol in self.all_config_symbols
400 if re.match(regexp, symbol)]
401
402 def __init__(self, options):
403 """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 Kurekb95ba9a2022-10-04 15:02:41 -0400406 self.all_config_symbols = set(collect_config_symbols(options))
Gilles Peskinef5ea1972019-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')
Andrzej Kurekaa112812022-11-22 08:13:45 -0500409 hash_symbols.append("MBEDTLS_SHA512_NO_SHA384")
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100410 # Find elliptic curve enabling macros by name.
411 curve_symbols = self.config_symbols_matching(r'MBEDTLS_ECP_DP_\w+_ENABLED\Z')
412 # Find key exchange enabling macros by name.
413 key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z')
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100414 # Find cipher IDs (block permutations and stream ciphers --- chaining
415 # and padding modes are exercised separately) information by parsing
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400416 # cipher.h, as the information is not readily available in config.h.
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400417 cipher_info = CipherInfo()
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100418 # Find block cipher chaining and padding mode enabling macros by name.
419 cipher_chaining_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_MODE_\w+\Z')
420 cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z')
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100421 self.domains = {
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100422 # Cipher IDs, chaining modes and padding modes. Run the test suites.
423 'cipher_id': ExclusiveDomain(cipher_info.base_symbols,
424 build_and_test),
425 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols,
426 build_and_test),
427 'cipher_padding': ExclusiveDomain(cipher_padding_symbols,
428 build_and_test),
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100429 # Elliptic curves. Run the test suites.
430 'curves': ExclusiveDomain(curve_symbols, build_and_test),
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400431 # Hash algorithms. Exclude exclusive domain of MD, RIPEMD, SHA1 (obsolete)
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400432 'hashes': DualDomain(hash_symbols, build_and_test,
Andrzej Kurekaa112812022-11-22 08:13:45 -0500433 exclude=r'MBEDTLS_(MD|RIPEMD|SHA1_)'\
434 '|!MBEDTLS_*_NO_SHA'),
Gilles Peskine7088a732019-01-29 19:33:05 +0100435 # Key exchange types. Only build the library and the sample
436 # programs.
437 'kex': ExclusiveDomain(key_exchange_symbols,
438 [build_command + ['lib'],
439 build_command + ['-C', 'programs']]),
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100440 'pkalgs': ComplementaryDomain(['MBEDTLS_ECDSA_C',
441 'MBEDTLS_ECP_C',
442 'MBEDTLS_PKCS1_V21',
443 'MBEDTLS_PKCS1_V15',
444 'MBEDTLS_RSA_C',
445 'MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
446 build_and_test),
447 }
448 self.jobs = {}
449 for domain in self.domains.values():
450 for job in domain.jobs:
451 self.jobs[job.name] = job
452
453 def get_jobs(self, name):
454 """Return the list of jobs identified by the given name.
455A name can either be the name of a domain or the name of one specific job."""
456 if name in self.domains:
457 return sorted(self.domains[name].jobs, key=lambda job: job.name)
458 else:
459 return [self.jobs[name]]
460
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100461def run(options, job, colors=NO_COLORS):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100462 """Run the specified job (a Job instance)."""
463 subprocess.check_call([options.make_command, 'clean'])
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100464 job.announce(colors, None)
Gilles Peskined43ce2b2019-01-29 18:46:34 +0100465 job.configure(options)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100466 success = job.test(options)
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100467 job.announce(colors, success)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100468 return success
469
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400470def run_tests(options, domain_data):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100471 """Run the desired jobs.
472domain_data should be a DomainData instance that describes the available
473domains and jobs.
Andrzej Kurek113952d2022-10-17 08:39:09 -0400474Run the jobs listed in options.tasks."""
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100475 if not hasattr(options, 'config_backup'):
476 options.config_backup = options.config + '.bak'
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100477 colors = Colors(options)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100478 jobs = []
479 failures = []
480 successes = []
Andrzej Kurek113952d2022-10-17 08:39:09 -0400481 for name in options.tasks:
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100482 jobs += domain_data.get_jobs(name)
483 backup_config(options)
484 try:
485 for job in jobs:
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100486 success = run(options, job, colors=colors)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100487 if not success:
488 if options.keep_going:
489 failures.append(job.name)
490 else:
491 return False
492 else:
493 successes.append(job.name)
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100494 restore_config(options)
495 except:
496 # Restore the configuration, except in stop-on-error mode if there
497 # was an error, where we leave the failing configuration up for
498 # developer convenience.
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100499 if options.keep_going:
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100500 restore_config(options)
501 raise
Gilles Peskinedc68f612019-01-29 18:50:03 +0100502 if successes:
503 log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100504 if failures:
Gilles Peskinedc68f612019-01-29 18:50:03 +0100505 log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100506 return False
507 else:
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100508 return True
509
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400510def main():
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100511 try:
Andrzej Kurek110fc482022-10-09 05:29:44 -0400512 parser = argparse.ArgumentParser(
513 formatter_class=argparse.RawDescriptionHelpFormatter,
514 description=
515 "Test Mbed TLS with a subset of algorithms.\n\n"
516 "Example usage:\n"
Andrzej Kurekffbc8f52022-10-17 08:34:40 -0400517 r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA256_C""\n"
Andrzej Kurek110fc482022-10-09 05:29:44 -0400518 "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n"
519 "./tests/scripts/depends.py cipher_id cipher_chaining\n")
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100520 parser.add_argument('--color', metavar='WHEN',
521 help='Colorize the output (always/auto/never)',
522 choices=['always', 'auto', 'never'], default='auto')
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100523 parser.add_argument('-c', '--config', metavar='FILE',
524 help='Configuration file to modify',
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400525 default='include/mbedtls/config.h')
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100526 parser.add_argument('-C', '--directory', metavar='DIR',
527 help='Change to this directory before anything else',
528 default='.')
529 parser.add_argument('-k', '--keep-going',
530 help='Try all configurations even if some fail (default)',
531 action='store_true', dest='keep_going', default=True)
532 parser.add_argument('-e', '--no-keep-going',
533 help='Stop as soon as a configuration fails',
534 action='store_false', dest='keep_going')
535 parser.add_argument('--list-jobs',
536 help='List supported jobs and exit',
537 action='append_const', dest='list', const='jobs')
538 parser.add_argument('--list-domains',
539 help='List supported domains and exit',
540 action='append_const', dest='list', const='domains')
541 parser.add_argument('--make-command', metavar='CMD',
542 help='Command to run instead of make (e.g. gmake)',
543 action='store', default='make')
Andrzej Kurek2b44a922022-10-24 10:41:20 -0400544 parser.add_argument('--unset-use-psa',
545 help='Unset MBEDTLS_USE_PSA_CRYPTO before any test',
546 action='store_true', dest='unset_use_psa')
Andrzej Kurek113952d2022-10-17 08:39:09 -0400547 parser.add_argument('tasks', metavar='TASKS', nargs='*',
548 help='The domain(s) or job(s) to test (default: all).',
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100549 default=True)
550 options = parser.parse_args()
551 os.chdir(options.directory)
552 domain_data = DomainData(options)
Andrzej Kurek113952d2022-10-17 08:39:09 -0400553 if options.tasks is True:
554 options.tasks = sorted(domain_data.domains.keys())
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100555 if options.list:
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400556 for arg in options.list:
557 for domain_name in sorted(getattr(domain_data, arg).keys()):
558 print(domain_name)
559 sys.exit(0)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100560 else:
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400561 sys.exit(0 if run_tests(options, domain_data) else 1)
562 except Exception: # pylint: disable=broad-except
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100563 traceback.print_exc()
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400564 sys.exit(3)
565
566if __name__ == '__main__':
567 main()