blob: 9c3c49a9a98c0a9823bbc9b0436c5fac8439d079 [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 Kurekcf394062023-02-15 05:42:02 -050026in the arguments is parsed to extract any configuration options (using config.py).
Andrzej Kurek110fc482022-10-09 05:29:44 -040027
28Then, test domains (groups of jobs, tests) are built based on predefined data
29collected in the DomainData class. Here, each domain has five major traits:
Andrzej 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
Andrzej Kurek2432dc22023-01-24 07:40:42 -050062from typing import Union
63
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -050064# Add the Mbed TLS Python library directory to the module search path
Andrzej Kurekcf394062023-02-15 05:42:02 -050065import scripts_path # pylint: disable=unused-import
66import config
67
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -040068class Colors: # pylint: disable=too-few-public-methods
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010069 """Minimalistic support for colored output.
70Each field of an object of this class is either None if colored output
71is not possible or not desired, or a pair of strings (start, stop) such
72that outputting start switches the text color to the desired color and
73stop switches the text color back to the default."""
74 red = None
75 green = None
Andrzej Kurekcf394062023-02-15 05:42:02 -050076 cyan = None
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010077 bold_red = None
78 bold_green = None
79 def __init__(self, options=None):
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -040080 """Initialize color profile according to passed options."""
Gilles Peskinefd1d69c2019-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)
Andrzej Kurekcf394062023-02-15 05:42:02 -050092 self.cyan = ('\033[36m', normal)
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010093 self.bold_red = ('\033[1;31m', normal)
94 self.bold_green = ('\033[1;32m', normal)
95NO_COLORS = Colors(None)
96
97def log_line(text, prefix='depends.py:', suffix='', color=None):
Gilles Peskinef5ea1972019-01-29 08:50:20 +010098 """Print a status message."""
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -040099 if color is not None:
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100100 prefix = color[0] + prefix
101 suffix = suffix + color[1]
102 sys.stderr.write(prefix + ' ' + text + suffix + '\n')
Gilles Peskinee6a60db2019-01-29 18:42:55 +0100103 sys.stderr.flush()
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100104
Gilles Peskined43ce2b2019-01-29 18:46:34 +0100105def log_command(cmd):
106 """Print a trace of the specified command.
107cmd is a list of strings: a command name and its arguments."""
108 log_line(' '.join(cmd), prefix='+')
109
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100110def backup_config(options):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400111 """Back up the library configuration file (config.h).
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100112If the backup file already exists, it is presumed to be the desired backup,
113so don't make another backup."""
114 if os.path.exists(options.config_backup):
115 options.own_backup = False
116 else:
117 options.own_backup = True
118 shutil.copy(options.config, options.config_backup)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100119
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100120def restore_config(options):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400121 """Restore the library configuration file (config.h).
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100122Remove the backup file if it was saved earlier."""
123 if options.own_backup:
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100124 shutil.move(options.config_backup, options.config)
125 else:
126 shutil.copy(options.config_backup, options.config)
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100127
Andrzej Kurekcf394062023-02-15 05:42:02 -0500128def option_exists(conf, option):
129 if option not in conf.settings:
130 return False
131 return True
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100132
Andrzej Kurek2432dc22023-01-24 07:40:42 -0500133def set_config_option_value(conf, option, colors, value: Union[bool, str]):
134 """Set/unset a configuration option, optionally specifying a value.
135value can be either True/False (set/unset config option), or a string,
136which will make a symbol defined with a certain value."""
Andrzej Kurekcf394062023-02-15 05:42:02 -0500137 if not option_exists(conf, option):
138 log_line('Symbol {} was not found in {}'.format(option, conf.filename), color=colors.red)
139 return False
Andrzej Kurekcf394062023-02-15 05:42:02 -0500140
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500141 if value is False:
142 log_command(['config.py', 'unset', option])
143 conf.unset(option)
144 else:
145 if value is True:
146 log_command(['config.py', 'set', option])
147 conf.set(option)
148 else:
149 log_command(['config.py', 'set', option, value])
150 conf.set(option, value)
Andrzej Kurekcf394062023-02-15 05:42:02 -0500151 return True
152
153def set_reference_config(conf, options, colors):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400154 """Change the library configuration file (config.h) to the reference state.
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400155The reference state is the one from which the tested configurations are
156derived."""
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400157 # Turn off options that are not relevant to the tests and slow them down.
Andrzej Kurekcf394062023-02-15 05:42:02 -0500158 log_command(['config.py', 'full'])
159 conf.adapt(config.full_adapter)
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500160 set_config_option_value(conf, 'MBEDTLS_TEST_HOOKS', colors, False)
Andrzej Kurek2b44a922022-10-24 10:41:20 -0400161 if options.unset_use_psa:
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500162 set_config_option_value(conf, 'MBEDTLS_USE_PSA_CRYPTO', colors, False)
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400163
Gilles Peskinef5ea1972019-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 Peskinefd1d69c2019-01-29 18:48:48 +0100180 def announce(self, colors, what):
Gilles Peskinef5ea1972019-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 Peskinefd1d69c2019-01-29 18:48:48 +0100186 log_line(self.name + ' PASSED', color=colors.green)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100187 elif what is False:
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100188 log_line(self.name + ' FAILED', color=colors.red)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100189 else:
Andrzej Kurekcf394062023-02-15 05:42:02 -0500190 log_line('starting ' + self.name, color=colors.cyan)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100191
Andrzej Kurekcf394062023-02-15 05:42:02 -0500192 def configure(self, conf, options, colors):
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400193 '''Set library configuration options as required for the job.'''
Andrzej Kurekcf394062023-02-15 05:42:02 -0500194 set_reference_config(conf, options, colors)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100195 for key, value in sorted(self.config_settings.items()):
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500196 ret = set_config_option_value(conf, key, colors, value)
Andrzej Kurekcf394062023-02-15 05:42:02 -0500197 if ret is False:
198 return False
199 return True
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100200
201 def test(self, options):
202 '''Run the job's build and test commands.
203Return True if all the commands succeed and False otherwise.
204If options.keep_going is false, stop as soon as one command fails. Otherwise
205run all the commands, except that if the first command fails, none of the
206other commands are run (typically, the first command is a build command
207and subsequent commands are tests that cannot run if the build failed).'''
208 built = False
209 success = True
210 for command in self.commands:
Gilles Peskined43ce2b2019-01-29 18:46:34 +0100211 log_command(command)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100212 ret = subprocess.call(command)
213 if ret != 0:
214 if command[0] not in ['make', options.make_command]:
215 log_line('*** [{}] Error {}'.format(' '.join(command), ret))
216 if not options.keep_going or not built:
217 return False
218 success = False
219 built = True
220 return success
221
222# SSL/TLS versions up to 1.1 and corresponding options. These require
223# both MD5 and SHA-1.
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400224SSL_PRE_1_2_DEPENDENCIES = ['MBEDTLS_SSL_CBC_RECORD_SPLITTING',
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100225 'MBEDTLS_SSL_PROTO_SSL3',
226 'MBEDTLS_SSL_PROTO_TLS1',
227 'MBEDTLS_SSL_PROTO_TLS1_1']
228
229# If the configuration option A requires B, make sure that
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400230# B in REVERSE_DEPENDENCIES[A].
Gilles Peskineb81f4062019-01-29 19:30:40 +0100231# All the information here should be contained in check_config.h. This
232# file includes a copy because it changes rarely and it would be a pain
233# to extract automatically.
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400234REVERSE_DEPENDENCIES = {
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100235 'MBEDTLS_AES_C': ['MBEDTLS_CTR_DRBG_C',
Andrzej Kurek90686252022-09-28 03:17:56 -0400236 'MBEDTLS_NIST_KW_C'],
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100237 'MBEDTLS_CHACHA20_C': ['MBEDTLS_CHACHAPOLY_C'],
Andrzej Kurek90686252022-09-28 03:17:56 -0400238 'MBEDTLS_ECDSA_C': ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
239 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'],
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100240 'MBEDTLS_ECP_C': ['MBEDTLS_ECDSA_C',
241 'MBEDTLS_ECDH_C',
242 'MBEDTLS_ECJPAKE_C',
Manuel Pégourié-Gonnard3dc7f232022-12-06 13:20:06 +0100243 'MBEDTLS_ECP_RESTARTABLE',
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100244 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
245 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED',
246 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED',
247 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
Andrzej Kurek90686252022-09-28 03:17:56 -0400248 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
249 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Gilles Peskineb81f4062019-01-29 19:30:40 +0100250 'MBEDTLS_ECP_DP_SECP256R1_ENABLED': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400251 'MBEDTLS_MD5_C': SSL_PRE_1_2_DEPENDENCIES,
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100252 'MBEDTLS_PKCS1_V21': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
253 'MBEDTLS_PKCS1_V15': ['MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
254 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
255 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
256 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'],
257 'MBEDTLS_RSA_C': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT',
258 'MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
259 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
260 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
Andrzej Kurek90686252022-09-28 03:17:56 -0400261 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED',
262 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED'],
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400263 'MBEDTLS_SHA1_C': SSL_PRE_1_2_DEPENDENCIES,
Gilles Peskineb81f4062019-01-29 19:30:40 +0100264 'MBEDTLS_SHA256_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
Andrzej Kurek90686252022-09-28 03:17:56 -0400265 'MBEDTLS_ENTROPY_FORCE_SHA256',
Andrzej Kurek90686252022-09-28 03:17:56 -0400266 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kurek0325ced2022-10-18 09:37:59 -0400267 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY'],
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400268 'MBEDTLS_SHA512_C': ['MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kurek90686252022-09-28 03:17:56 -0400269 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY'],
Andrzej Kurek90686252022-09-28 03:17:56 -0400270 'MBEDTLS_X509_RSASSA_PSS_SUPPORT': []
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100271}
272
Andrzej Kurek90686252022-09-28 03:17:56 -0400273# If an option is tested in an exclusive test, alter the following defines.
Andrzej Kurek110fc482022-10-09 05:29:44 -0400274# These are not necessarily dependencies, but just minimal required changes
Andrzej Kurek90686252022-09-28 03:17:56 -0400275# if a given define is the only one enabled from an exclusive group.
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400276EXCLUSIVE_GROUPS = {
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400277 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL'],
Andrzej Kurekf53d0ba2022-11-23 05:54:46 -0500278 'MBEDTLS_SHA512_NO_SHA384': ['+MBEDTLS_SHA512_C',
279 '-MBEDTLS_SSL_PROTO_TLS1_2',
280 '-MBEDTLS_SSL_PROTO_DTLS',
281 '-MBEDTLS_SSL_TLS_C',
282 '-MBEDTLS_SSL_CLI_C',
283 '-MBEDTLS_SSL_SRV_C',
284 '-MBEDTLS_SSL_DTLS_HELLO_VERIFY',
285 '-MBEDTLS_SSL_DTLS_ANTI_REPLAY',
286 '-MBEDTLS_SSL_DTLS_CONNECTION_ID',
287 '-MBEDTLS_SSL_DTLS_BADMAC_LIMIT',
288 '-MBEDTLS_SSL_ENCRYPT_THEN_MAC',
289 '-MBEDTLS_SSL_EXTENDED_MASTER_SECRET',
290 '-MBEDTLS_SSL_DTLS_SRTP',
291 '-MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE'],
Andrzej Kurek9cbdf102022-10-14 08:09:16 -0400292 'MBEDTLS_ECP_DP_CURVE448_ENABLED': ['-MBEDTLS_ECDSA_C',
293 '-MBEDTLS_ECDSA_DETERMINISTIC',
294 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
295 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
296 '-MBEDTLS_ECJPAKE_C',
297 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
298 'MBEDTLS_ECP_DP_CURVE25519_ENABLED': ['-MBEDTLS_ECDSA_C',
299 '-MBEDTLS_ECDSA_DETERMINISTIC',
300 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
301 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
302 '-MBEDTLS_ECJPAKE_C',
303 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
304 'MBEDTLS_ARIA_C': ['-MBEDTLS_CMAC_C'],
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400305 'MBEDTLS_ARC4_C': ['-MBEDTLS_CMAC_C',
306 '-MBEDTLS_CCM_C',
307 '-MBEDTLS_SSL_TICKET_C',
308 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION',
309 '-MBEDTLS_GCM_C'],
310 'MBEDTLS_BLOWFISH_C': ['-MBEDTLS_CMAC_C',
311 '-MBEDTLS_CCM_C',
312 '-MBEDTLS_SSL_TICKET_C',
313 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION',
314 '-MBEDTLS_GCM_C'],
Andrzej Kurek9cbdf102022-10-14 08:09:16 -0400315 'MBEDTLS_CAMELLIA_C': ['-MBEDTLS_CMAC_C'],
316 'MBEDTLS_CHACHA20_C': ['-MBEDTLS_CMAC_C', '-MBEDTLS_CCM_C', '-MBEDTLS_GCM_C'],
317 'MBEDTLS_DES_C': ['-MBEDTLS_CCM_C',
318 '-MBEDTLS_GCM_C',
319 '-MBEDTLS_SSL_TICKET_C',
320 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION'],
Andrzej Kurek90686252022-09-28 03:17:56 -0400321}
322def handle_exclusive_groups(config_settings, symbol):
323 """For every symbol tested in an exclusive group check if there are other
324defines to be altered. """
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400325 for dep in EXCLUSIVE_GROUPS.get(symbol, []):
Andrzej Kurek9cbdf102022-10-14 08:09:16 -0400326 unset = dep.startswith('-')
327 dep = dep[1:]
Andrzej Kurek90686252022-09-28 03:17:56 -0400328 config_settings[dep] = not unset
329
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100330def turn_off_dependencies(config_settings):
331 """For every option turned off config_settings, also turn off what depends on it.
332An option O is turned off if config_settings[O] is False."""
333 for key, value in sorted(config_settings.items()):
334 if value is not False:
335 continue
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400336 for dep in REVERSE_DEPENDENCIES.get(key, []):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100337 config_settings[dep] = False
338
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400339class BaseDomain: # pylint: disable=too-few-public-methods, unused-argument
340 """A base class for all domains."""
341 def __init__(self, symbols, commands, exclude):
342 """Initialize the jobs container"""
343 self.jobs = []
344
345class ExclusiveDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100346 """A domain consisting of a set of conceptually-equivalent settings.
347Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurek2e105b52022-10-06 16:57:38 -0400348with this symbol set and the others unset."""
Gilles Peskine3dd0dab2019-01-29 18:56:03 +0100349 def __init__(self, symbols, commands, exclude=None):
350 """Build a domain for the specified list of configuration symbols.
Andrzej Kurek2e105b52022-10-06 16:57:38 -0400351The domain contains a set of jobs that enable one of the elements
352of symbols and disable the others.
Gilles Peskine3dd0dab2019-01-29 18:56:03 +0100353Each job runs the specified commands.
354If exclude is a regular expression, skip generated jobs whose description
355would match this regular expression."""
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400356 super().__init__(symbols, commands, exclude)
Andrzej Kurek2e105b52022-10-06 16:57:38 -0400357 base_config_settings = {}
358 for symbol in symbols:
359 base_config_settings[symbol] = False
360 for symbol in symbols:
361 description = symbol
362 if exclude and re.match(exclude, description):
363 continue
364 config_settings = base_config_settings.copy()
365 config_settings[symbol] = True
366 handle_exclusive_groups(config_settings, symbol)
367 turn_off_dependencies(config_settings)
368 job = Job(description, config_settings, commands)
369 self.jobs.append(job)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100370
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400371class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100372 """A domain consisting of a set of loosely-related settings.
373Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400374with this symbol unset.
375If exclude is a regular expression, skip generated jobs whose description
376would match this regular expression."""
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400377 def __init__(self, symbols, commands, exclude=None):
Gilles Peskine3dd0dab2019-01-29 18:56:03 +0100378 """Build a domain for the specified list of configuration symbols.
379Each job in the domain disables one of the specified symbols.
380Each job runs the specified commands."""
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400381 super().__init__(symbols, commands, exclude)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100382 for symbol in symbols:
383 description = '!' + symbol
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400384 if exclude and re.match(exclude, description):
385 continue
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100386 config_settings = {symbol: False}
387 turn_off_dependencies(config_settings)
388 job = Job(description, config_settings, commands)
389 self.jobs.append(job)
390
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400391class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400392 """A domain that contains both the ExclusiveDomain and BaseDomain tests.
Andrzej Kurek0325ced2022-10-18 09:37:59 -0400393Both parent class __init__ calls are performed in any order and
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400394each call adds respective jobs. The job array initialization is done once in
395BaseDomain, before the parent __init__ calls."""
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400396
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400397class CipherInfo: # pylint: disable=too-few-public-methods
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100398 """Collect data about cipher.h."""
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400399 def __init__(self):
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100400 self.base_symbols = set()
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400401 with open('include/mbedtls/cipher.h', encoding="utf-8") as fh:
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100402 for line in fh:
403 m = re.match(r' *MBEDTLS_CIPHER_ID_(\w+),', line)
404 if m and m.group(1) not in ['NONE', 'NULL', '3DES']:
405 self.base_symbols.add('MBEDTLS_' + m.group(1) + '_C')
406
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100407class DomainData:
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400408 """A container for domains and jobs, used to structurize testing."""
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100409 def config_symbols_matching(self, regexp):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400410 """List the config.h settings matching regexp."""
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100411 return [symbol for symbol in self.all_config_symbols
412 if re.match(regexp, symbol)]
413
Andrzej Kurekcf394062023-02-15 05:42:02 -0500414 def __init__(self, options, conf):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100415 """Gather data about the library and establish a list of domains to test."""
416 build_command = [options.make_command, 'CFLAGS=-Werror']
417 build_and_test = [build_command, [options.make_command, 'test']]
Andrzej Kurekcf394062023-02-15 05:42:02 -0500418 self.all_config_symbols = set(conf.settings.keys())
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100419 # Find hash modules by name.
420 hash_symbols = self.config_symbols_matching(r'MBEDTLS_(MD|RIPEMD|SHA)[0-9]+_C\Z')
Andrzej Kurekaa112812022-11-22 08:13:45 -0500421 hash_symbols.append("MBEDTLS_SHA512_NO_SHA384")
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100422 # Find elliptic curve enabling macros by name.
423 curve_symbols = self.config_symbols_matching(r'MBEDTLS_ECP_DP_\w+_ENABLED\Z')
424 # Find key exchange enabling macros by name.
425 key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z')
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100426 # Find cipher IDs (block permutations and stream ciphers --- chaining
427 # and padding modes are exercised separately) information by parsing
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400428 # cipher.h, as the information is not readily available in config.h.
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400429 cipher_info = CipherInfo()
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100430 # Find block cipher chaining and padding mode enabling macros by name.
431 cipher_chaining_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_MODE_\w+\Z')
432 cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z')
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100433 self.domains = {
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100434 # Cipher IDs, chaining modes and padding modes. Run the test suites.
435 'cipher_id': ExclusiveDomain(cipher_info.base_symbols,
436 build_and_test),
437 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols,
438 build_and_test),
439 'cipher_padding': ExclusiveDomain(cipher_padding_symbols,
440 build_and_test),
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100441 # Elliptic curves. Run the test suites.
442 'curves': ExclusiveDomain(curve_symbols, build_and_test),
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400443 # Hash algorithms. Exclude exclusive domain of MD, RIPEMD, SHA1 (obsolete)
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400444 'hashes': DualDomain(hash_symbols, build_and_test,
Andrzej Kurekaa112812022-11-22 08:13:45 -0500445 exclude=r'MBEDTLS_(MD|RIPEMD|SHA1_)'\
446 '|!MBEDTLS_*_NO_SHA'),
Andrzej Kurekddf62602023-01-23 06:19:14 -0500447 # Key exchange types.
Andrzej Kurekde416fc2022-11-02 04:50:16 -0400448 'kex': ExclusiveDomain(key_exchange_symbols, build_and_test),
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100449 'pkalgs': ComplementaryDomain(['MBEDTLS_ECDSA_C',
450 'MBEDTLS_ECP_C',
451 'MBEDTLS_PKCS1_V21',
452 'MBEDTLS_PKCS1_V15',
453 'MBEDTLS_RSA_C',
454 'MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
455 build_and_test),
456 }
457 self.jobs = {}
458 for domain in self.domains.values():
459 for job in domain.jobs:
460 self.jobs[job.name] = job
461
462 def get_jobs(self, name):
463 """Return the list of jobs identified by the given name.
464A name can either be the name of a domain or the name of one specific job."""
465 if name in self.domains:
466 return sorted(self.domains[name].jobs, key=lambda job: job.name)
467 else:
468 return [self.jobs[name]]
469
Andrzej Kurekcf394062023-02-15 05:42:02 -0500470def run(options, job, conf, colors=NO_COLORS):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100471 """Run the specified job (a Job instance)."""
472 subprocess.check_call([options.make_command, 'clean'])
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100473 job.announce(colors, None)
Andrzej Kurekcf394062023-02-15 05:42:02 -0500474 if not job.configure(conf, options, colors):
475 job.announce(colors, False)
476 return False
477 conf.write()
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100478 success = job.test(options)
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100479 job.announce(colors, success)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100480 return success
481
Andrzej Kurekcf394062023-02-15 05:42:02 -0500482def run_tests(options, domain_data, conf):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100483 """Run the desired jobs.
484domain_data should be a DomainData instance that describes the available
485domains and jobs.
Andrzej Kurek113952d2022-10-17 08:39:09 -0400486Run the jobs listed in options.tasks."""
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100487 if not hasattr(options, 'config_backup'):
488 options.config_backup = options.config + '.bak'
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100489 colors = Colors(options)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100490 jobs = []
491 failures = []
492 successes = []
Andrzej Kurek113952d2022-10-17 08:39:09 -0400493 for name in options.tasks:
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100494 jobs += domain_data.get_jobs(name)
495 backup_config(options)
496 try:
497 for job in jobs:
Andrzej Kurekcf394062023-02-15 05:42:02 -0500498 success = run(options, job, conf, colors=colors)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100499 if not success:
500 if options.keep_going:
501 failures.append(job.name)
502 else:
503 return False
504 else:
505 successes.append(job.name)
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100506 restore_config(options)
507 except:
508 # Restore the configuration, except in stop-on-error mode if there
509 # was an error, where we leave the failing configuration up for
510 # developer convenience.
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100511 if options.keep_going:
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100512 restore_config(options)
513 raise
Gilles Peskinedc68f612019-01-29 18:50:03 +0100514 if successes:
515 log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100516 if failures:
Gilles Peskinedc68f612019-01-29 18:50:03 +0100517 log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100518 return False
519 else:
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100520 return True
521
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400522def main():
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100523 try:
Andrzej Kurek110fc482022-10-09 05:29:44 -0400524 parser = argparse.ArgumentParser(
525 formatter_class=argparse.RawDescriptionHelpFormatter,
526 description=
527 "Test Mbed TLS with a subset of algorithms.\n\n"
528 "Example usage:\n"
Andrzej Kurekffbc8f52022-10-17 08:34:40 -0400529 r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA256_C""\n"
Andrzej Kurek110fc482022-10-09 05:29:44 -0400530 "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n"
531 "./tests/scripts/depends.py cipher_id cipher_chaining\n")
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100532 parser.add_argument('--color', metavar='WHEN',
533 help='Colorize the output (always/auto/never)',
534 choices=['always', 'auto', 'never'], default='auto')
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100535 parser.add_argument('-c', '--config', metavar='FILE',
536 help='Configuration file to modify',
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400537 default='include/mbedtls/config.h')
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100538 parser.add_argument('-C', '--directory', metavar='DIR',
539 help='Change to this directory before anything else',
540 default='.')
541 parser.add_argument('-k', '--keep-going',
542 help='Try all configurations even if some fail (default)',
543 action='store_true', dest='keep_going', default=True)
544 parser.add_argument('-e', '--no-keep-going',
545 help='Stop as soon as a configuration fails',
546 action='store_false', dest='keep_going')
547 parser.add_argument('--list-jobs',
548 help='List supported jobs and exit',
549 action='append_const', dest='list', const='jobs')
550 parser.add_argument('--list-domains',
551 help='List supported domains and exit',
552 action='append_const', dest='list', const='domains')
553 parser.add_argument('--make-command', metavar='CMD',
554 help='Command to run instead of make (e.g. gmake)',
555 action='store', default='make')
Andrzej Kurek2b44a922022-10-24 10:41:20 -0400556 parser.add_argument('--unset-use-psa',
557 help='Unset MBEDTLS_USE_PSA_CRYPTO before any test',
558 action='store_true', dest='unset_use_psa')
Andrzej Kurek113952d2022-10-17 08:39:09 -0400559 parser.add_argument('tasks', metavar='TASKS', nargs='*',
560 help='The domain(s) or job(s) to test (default: all).',
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100561 default=True)
562 options = parser.parse_args()
563 os.chdir(options.directory)
Andrzej Kurekcf394062023-02-15 05:42:02 -0500564 conf = config.ConfigFile(options.config)
565 domain_data = DomainData(options, conf)
566
Andrzej Kurek113952d2022-10-17 08:39:09 -0400567 if options.tasks is True:
568 options.tasks = sorted(domain_data.domains.keys())
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100569 if options.list:
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400570 for arg in options.list:
571 for domain_name in sorted(getattr(domain_data, arg).keys()):
572 print(domain_name)
573 sys.exit(0)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100574 else:
Andrzej Kurekcf394062023-02-15 05:42:02 -0500575 sys.exit(0 if run_tests(options, domain_data, conf) else 1)
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400576 except Exception: # pylint: disable=broad-except
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100577 traceback.print_exc()
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400578 sys.exit(3)
579
580if __name__ == '__main__':
581 main()