blob: 1ab6d70b404bdc62c3da9f1b0ce97fd1133b2235 [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 Kurek2e1aeb12023-01-23 07:19:22 -050062# Add the Mbed TLS Python library directory to the module search path
Andrzej Kurekcf394062023-02-15 05:42:02 -050063import scripts_path # pylint: disable=unused-import
64import config
65
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -040066class Colors: # pylint: disable=too-few-public-methods
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010067 """Minimalistic support for colored output.
68Each field of an object of this class is either None if colored output
69is not possible or not desired, or a pair of strings (start, stop) such
70that outputting start switches the text color to the desired color and
71stop switches the text color back to the default."""
72 red = None
73 green = None
Andrzej Kurekcf394062023-02-15 05:42:02 -050074 cyan = None
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010075 bold_red = None
76 bold_green = None
77 def __init__(self, options=None):
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -040078 """Initialize color profile according to passed options."""
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010079 if not options or options.color in ['no', 'never']:
80 want_color = False
81 elif options.color in ['yes', 'always']:
82 want_color = True
83 else:
84 want_color = sys.stderr.isatty()
85 if want_color:
86 # Assume ANSI compatible terminal
87 normal = '\033[0m'
88 self.red = ('\033[31m', normal)
89 self.green = ('\033[32m', normal)
Andrzej Kurekcf394062023-02-15 05:42:02 -050090 self.cyan = ('\033[36m', normal)
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010091 self.bold_red = ('\033[1;31m', normal)
92 self.bold_green = ('\033[1;32m', normal)
93NO_COLORS = Colors(None)
94
95def log_line(text, prefix='depends.py:', suffix='', color=None):
Gilles Peskinef5ea1972019-01-29 08:50:20 +010096 """Print a status message."""
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -040097 if color is not None:
Gilles Peskinefd1d69c2019-01-29 18:48:48 +010098 prefix = color[0] + prefix
99 suffix = suffix + color[1]
100 sys.stderr.write(prefix + ' ' + text + suffix + '\n')
Gilles Peskinee6a60db2019-01-29 18:42:55 +0100101 sys.stderr.flush()
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100102
Gilles Peskined43ce2b2019-01-29 18:46:34 +0100103def log_command(cmd):
104 """Print a trace of the specified command.
105cmd is a list of strings: a command name and its arguments."""
106 log_line(' '.join(cmd), prefix='+')
107
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100108def backup_config(options):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400109 """Back up the library configuration file (config.h).
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100110If the backup file already exists, it is presumed to be the desired backup,
111so don't make another backup."""
112 if os.path.exists(options.config_backup):
113 options.own_backup = False
114 else:
115 options.own_backup = True
116 shutil.copy(options.config, options.config_backup)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100117
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100118def restore_config(options):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400119 """Restore the library configuration file (config.h).
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100120Remove the backup file if it was saved earlier."""
121 if options.own_backup:
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100122 shutil.move(options.config_backup, options.config)
123 else:
124 shutil.copy(options.config_backup, options.config)
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100125
Andrzej Kurekcf394062023-02-15 05:42:02 -0500126def option_exists(conf, option):
127 if option not in conf.settings:
128 return False
129 return True
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100130
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500131def set_config_option_value(conf, option, colors, value):
132 """Set/unset a configuration option, optionally specifying a value"""
Andrzej Kurekcf394062023-02-15 05:42:02 -0500133 if not option_exists(conf, option):
134 log_line('Symbol {} was not found in {}'.format(option, conf.filename), color=colors.red)
135 return False
Andrzej Kurekcf394062023-02-15 05:42:02 -0500136
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500137 if value is False:
138 log_command(['config.py', 'unset', option])
139 conf.unset(option)
140 else:
141 if value is True:
142 log_command(['config.py', 'set', option])
143 conf.set(option)
144 else:
145 log_command(['config.py', 'set', option, value])
146 conf.set(option, value)
Andrzej Kurekcf394062023-02-15 05:42:02 -0500147 return True
148
149def set_reference_config(conf, options, colors):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400150 """Change the library configuration file (config.h) to the reference state.
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400151The reference state is the one from which the tested configurations are
152derived."""
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400153 # Turn off options that are not relevant to the tests and slow them down.
Andrzej Kurekcf394062023-02-15 05:42:02 -0500154 log_command(['config.py', 'full'])
155 conf.adapt(config.full_adapter)
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500156 set_config_option_value(conf, 'MBEDTLS_TEST_HOOKS', colors, False)
Andrzej Kurek2b44a922022-10-24 10:41:20 -0400157 if options.unset_use_psa:
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500158 set_config_option_value(conf, 'MBEDTLS_USE_PSA_CRYPTO', colors, False)
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400159
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100160class Job:
161 """A job builds the library in a specific configuration and runs some tests."""
162 def __init__(self, name, config_settings, commands):
163 """Build a job object.
164The job uses the configuration described by config_settings. This is a
165dictionary where the keys are preprocessor symbols and the values are
166booleans or strings. A boolean indicates whether or not to #define the
167symbol. With a string, the symbol is #define'd to that value.
168After setting the configuration, the job runs the programs specified by
169commands. This is a list of lists of strings; each list of string is a
170command name and its arguments and is passed to subprocess.call with
171shell=False."""
172 self.name = name
173 self.config_settings = config_settings
174 self.commands = commands
175
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100176 def announce(self, colors, what):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100177 '''Announce the start or completion of a job.
178If what is None, announce the start of the job.
179If what is True, announce that the job has passed.
180If what is False, announce that the job has failed.'''
181 if what is True:
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100182 log_line(self.name + ' PASSED', color=colors.green)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100183 elif what is False:
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100184 log_line(self.name + ' FAILED', color=colors.red)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100185 else:
Andrzej Kurekcf394062023-02-15 05:42:02 -0500186 log_line('starting ' + self.name, color=colors.cyan)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100187
Andrzej Kurekcf394062023-02-15 05:42:02 -0500188 def configure(self, conf, options, colors):
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400189 '''Set library configuration options as required for the job.'''
Andrzej Kurekcf394062023-02-15 05:42:02 -0500190 set_reference_config(conf, options, colors)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100191 for key, value in sorted(self.config_settings.items()):
Andrzej Kurek2e1aeb12023-01-23 07:19:22 -0500192 ret = set_config_option_value(conf, key, colors, value)
Andrzej Kurekcf394062023-02-15 05:42:02 -0500193 if ret is False:
194 return False
195 return True
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100196
197 def test(self, options):
198 '''Run the job's build and test commands.
199Return True if all the commands succeed and False otherwise.
200If options.keep_going is false, stop as soon as one command fails. Otherwise
201run all the commands, except that if the first command fails, none of the
202other commands are run (typically, the first command is a build command
203and subsequent commands are tests that cannot run if the build failed).'''
204 built = False
205 success = True
206 for command in self.commands:
Gilles Peskined43ce2b2019-01-29 18:46:34 +0100207 log_command(command)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100208 ret = subprocess.call(command)
209 if ret != 0:
210 if command[0] not in ['make', options.make_command]:
211 log_line('*** [{}] Error {}'.format(' '.join(command), ret))
212 if not options.keep_going or not built:
213 return False
214 success = False
215 built = True
216 return success
217
218# SSL/TLS versions up to 1.1 and corresponding options. These require
219# both MD5 and SHA-1.
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400220SSL_PRE_1_2_DEPENDENCIES = ['MBEDTLS_SSL_CBC_RECORD_SPLITTING',
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100221 'MBEDTLS_SSL_PROTO_SSL3',
222 'MBEDTLS_SSL_PROTO_TLS1',
223 'MBEDTLS_SSL_PROTO_TLS1_1']
224
225# If the configuration option A requires B, make sure that
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400226# B in REVERSE_DEPENDENCIES[A].
Gilles Peskineb81f4062019-01-29 19:30:40 +0100227# All the information here should be contained in check_config.h. This
228# file includes a copy because it changes rarely and it would be a pain
229# to extract automatically.
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400230REVERSE_DEPENDENCIES = {
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100231 'MBEDTLS_AES_C': ['MBEDTLS_CTR_DRBG_C',
Andrzej Kurek90686252022-09-28 03:17:56 -0400232 'MBEDTLS_NIST_KW_C'],
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100233 'MBEDTLS_CHACHA20_C': ['MBEDTLS_CHACHAPOLY_C'],
Andrzej Kurek90686252022-09-28 03:17:56 -0400234 'MBEDTLS_ECDSA_C': ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
235 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'],
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100236 'MBEDTLS_ECP_C': ['MBEDTLS_ECDSA_C',
237 'MBEDTLS_ECDH_C',
238 'MBEDTLS_ECJPAKE_C',
Manuel Pégourié-Gonnard3dc7f232022-12-06 13:20:06 +0100239 'MBEDTLS_ECP_RESTARTABLE',
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100240 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
241 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED',
242 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED',
243 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
Andrzej Kurek90686252022-09-28 03:17:56 -0400244 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
245 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Gilles Peskineb81f4062019-01-29 19:30:40 +0100246 'MBEDTLS_ECP_DP_SECP256R1_ENABLED': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400247 'MBEDTLS_MD5_C': SSL_PRE_1_2_DEPENDENCIES,
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100248 'MBEDTLS_PKCS1_V21': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
249 'MBEDTLS_PKCS1_V15': ['MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
250 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
251 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
252 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'],
253 'MBEDTLS_RSA_C': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT',
254 'MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
255 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
256 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
Andrzej Kurek90686252022-09-28 03:17:56 -0400257 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED',
258 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED'],
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400259 'MBEDTLS_SHA1_C': SSL_PRE_1_2_DEPENDENCIES,
Gilles Peskineb81f4062019-01-29 19:30:40 +0100260 'MBEDTLS_SHA256_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
Andrzej Kurek90686252022-09-28 03:17:56 -0400261 'MBEDTLS_ENTROPY_FORCE_SHA256',
Andrzej Kurek90686252022-09-28 03:17:56 -0400262 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kurek0325ced2022-10-18 09:37:59 -0400263 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY'],
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400264 'MBEDTLS_SHA512_C': ['MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kurek90686252022-09-28 03:17:56 -0400265 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY'],
Andrzej Kurek90686252022-09-28 03:17:56 -0400266 'MBEDTLS_X509_RSASSA_PSS_SUPPORT': []
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100267}
268
Andrzej Kurek90686252022-09-28 03:17:56 -0400269# If an option is tested in an exclusive test, alter the following defines.
Andrzej Kurek110fc482022-10-09 05:29:44 -0400270# These are not necessarily dependencies, but just minimal required changes
Andrzej Kurek90686252022-09-28 03:17:56 -0400271# if a given define is the only one enabled from an exclusive group.
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400272EXCLUSIVE_GROUPS = {
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400273 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL'],
Andrzej Kurekf53d0ba2022-11-23 05:54:46 -0500274 'MBEDTLS_SHA512_NO_SHA384': ['+MBEDTLS_SHA512_C',
275 '-MBEDTLS_SSL_PROTO_TLS1_2',
276 '-MBEDTLS_SSL_PROTO_DTLS',
277 '-MBEDTLS_SSL_TLS_C',
278 '-MBEDTLS_SSL_CLI_C',
279 '-MBEDTLS_SSL_SRV_C',
280 '-MBEDTLS_SSL_DTLS_HELLO_VERIFY',
281 '-MBEDTLS_SSL_DTLS_ANTI_REPLAY',
282 '-MBEDTLS_SSL_DTLS_CONNECTION_ID',
283 '-MBEDTLS_SSL_DTLS_BADMAC_LIMIT',
284 '-MBEDTLS_SSL_ENCRYPT_THEN_MAC',
285 '-MBEDTLS_SSL_EXTENDED_MASTER_SECRET',
286 '-MBEDTLS_SSL_DTLS_SRTP',
287 '-MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE'],
Andrzej Kurek9cbdf102022-10-14 08:09:16 -0400288 'MBEDTLS_ECP_DP_CURVE448_ENABLED': ['-MBEDTLS_ECDSA_C',
289 '-MBEDTLS_ECDSA_DETERMINISTIC',
290 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
291 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
292 '-MBEDTLS_ECJPAKE_C',
293 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
294 'MBEDTLS_ECP_DP_CURVE25519_ENABLED': ['-MBEDTLS_ECDSA_C',
295 '-MBEDTLS_ECDSA_DETERMINISTIC',
296 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
297 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
298 '-MBEDTLS_ECJPAKE_C',
299 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
300 'MBEDTLS_ARIA_C': ['-MBEDTLS_CMAC_C'],
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400301 'MBEDTLS_ARC4_C': ['-MBEDTLS_CMAC_C',
302 '-MBEDTLS_CCM_C',
303 '-MBEDTLS_SSL_TICKET_C',
304 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION',
305 '-MBEDTLS_GCM_C'],
306 'MBEDTLS_BLOWFISH_C': ['-MBEDTLS_CMAC_C',
307 '-MBEDTLS_CCM_C',
308 '-MBEDTLS_SSL_TICKET_C',
309 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION',
310 '-MBEDTLS_GCM_C'],
Andrzej Kurek9cbdf102022-10-14 08:09:16 -0400311 'MBEDTLS_CAMELLIA_C': ['-MBEDTLS_CMAC_C'],
312 'MBEDTLS_CHACHA20_C': ['-MBEDTLS_CMAC_C', '-MBEDTLS_CCM_C', '-MBEDTLS_GCM_C'],
313 'MBEDTLS_DES_C': ['-MBEDTLS_CCM_C',
314 '-MBEDTLS_GCM_C',
315 '-MBEDTLS_SSL_TICKET_C',
316 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION'],
Andrzej Kurek90686252022-09-28 03:17:56 -0400317}
318def handle_exclusive_groups(config_settings, symbol):
319 """For every symbol tested in an exclusive group check if there are other
320defines to be altered. """
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400321 for dep in EXCLUSIVE_GROUPS.get(symbol, []):
Andrzej Kurek9cbdf102022-10-14 08:09:16 -0400322 unset = dep.startswith('-')
323 dep = dep[1:]
Andrzej Kurek90686252022-09-28 03:17:56 -0400324 config_settings[dep] = not unset
325
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100326def turn_off_dependencies(config_settings):
327 """For every option turned off config_settings, also turn off what depends on it.
328An option O is turned off if config_settings[O] is False."""
329 for key, value in sorted(config_settings.items()):
330 if value is not False:
331 continue
Andrzej Kurekfb3e27e2022-10-04 16:22:22 -0400332 for dep in REVERSE_DEPENDENCIES.get(key, []):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100333 config_settings[dep] = False
334
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400335class BaseDomain: # pylint: disable=too-few-public-methods, unused-argument
336 """A base class for all domains."""
337 def __init__(self, symbols, commands, exclude):
338 """Initialize the jobs container"""
339 self.jobs = []
340
341class ExclusiveDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100342 """A domain consisting of a set of conceptually-equivalent settings.
343Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurek2e105b52022-10-06 16:57:38 -0400344with this symbol set and the others unset."""
Gilles Peskine3dd0dab2019-01-29 18:56:03 +0100345 def __init__(self, symbols, commands, exclude=None):
346 """Build a domain for the specified list of configuration symbols.
Andrzej Kurek2e105b52022-10-06 16:57:38 -0400347The domain contains a set of jobs that enable one of the elements
348of symbols and disable the others.
Gilles Peskine3dd0dab2019-01-29 18:56:03 +0100349Each job runs the specified commands.
350If exclude is a regular expression, skip generated jobs whose description
351would match this regular expression."""
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400352 super().__init__(symbols, commands, exclude)
Andrzej Kurek2e105b52022-10-06 16:57:38 -0400353 base_config_settings = {}
354 for symbol in symbols:
355 base_config_settings[symbol] = False
356 for symbol in symbols:
357 description = symbol
358 if exclude and re.match(exclude, description):
359 continue
360 config_settings = base_config_settings.copy()
361 config_settings[symbol] = True
362 handle_exclusive_groups(config_settings, symbol)
363 turn_off_dependencies(config_settings)
364 job = Job(description, config_settings, commands)
365 self.jobs.append(job)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100366
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400367class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100368 """A domain consisting of a set of loosely-related settings.
369Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400370with this symbol unset.
371If exclude is a regular expression, skip generated jobs whose description
372would match this regular expression."""
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400373 def __init__(self, symbols, commands, exclude=None):
Gilles Peskine3dd0dab2019-01-29 18:56:03 +0100374 """Build a domain for the specified list of configuration symbols.
375Each job in the domain disables one of the specified symbols.
376Each job runs the specified commands."""
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400377 super().__init__(symbols, commands, exclude)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100378 for symbol in symbols:
379 description = '!' + symbol
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400380 if exclude and re.match(exclude, description):
381 continue
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100382 config_settings = {symbol: False}
383 turn_off_dependencies(config_settings)
384 job = Job(description, config_settings, commands)
385 self.jobs.append(job)
386
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400387class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400388 """A domain that contains both the ExclusiveDomain and BaseDomain tests.
Andrzej Kurek0325ced2022-10-18 09:37:59 -0400389Both parent class __init__ calls are performed in any order and
Andrzej Kurek8b7a1572022-10-14 07:06:43 -0400390each call adds respective jobs. The job array initialization is done once in
391BaseDomain, before the parent __init__ calls."""
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400392
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400393class CipherInfo: # pylint: disable=too-few-public-methods
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100394 """Collect data about cipher.h."""
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400395 def __init__(self):
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100396 self.base_symbols = set()
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400397 with open('include/mbedtls/cipher.h', encoding="utf-8") as fh:
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100398 for line in fh:
399 m = re.match(r' *MBEDTLS_CIPHER_ID_(\w+),', line)
400 if m and m.group(1) not in ['NONE', 'NULL', '3DES']:
401 self.base_symbols.add('MBEDTLS_' + m.group(1) + '_C')
402
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100403class DomainData:
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400404 """A container for domains and jobs, used to structurize testing."""
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100405 def config_symbols_matching(self, regexp):
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400406 """List the config.h settings matching regexp."""
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100407 return [symbol for symbol in self.all_config_symbols
408 if re.match(regexp, symbol)]
409
Andrzej Kurekcf394062023-02-15 05:42:02 -0500410 def __init__(self, options, conf):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100411 """Gather data about the library and establish a list of domains to test."""
412 build_command = [options.make_command, 'CFLAGS=-Werror']
413 build_and_test = [build_command, [options.make_command, 'test']]
Andrzej Kurekcf394062023-02-15 05:42:02 -0500414 self.all_config_symbols = set(conf.settings.keys())
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100415 # Find hash modules by name.
416 hash_symbols = self.config_symbols_matching(r'MBEDTLS_(MD|RIPEMD|SHA)[0-9]+_C\Z')
Andrzej Kurekaa112812022-11-22 08:13:45 -0500417 hash_symbols.append("MBEDTLS_SHA512_NO_SHA384")
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100418 # Find elliptic curve enabling macros by name.
419 curve_symbols = self.config_symbols_matching(r'MBEDTLS_ECP_DP_\w+_ENABLED\Z')
420 # Find key exchange enabling macros by name.
421 key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z')
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100422 # Find cipher IDs (block permutations and stream ciphers --- chaining
423 # and padding modes are exercised separately) information by parsing
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400424 # cipher.h, as the information is not readily available in config.h.
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400425 cipher_info = CipherInfo()
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100426 # Find block cipher chaining and padding mode enabling macros by name.
427 cipher_chaining_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_MODE_\w+\Z')
428 cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z')
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100429 self.domains = {
Gilles Peskine3ce0e322019-01-29 23:12:28 +0100430 # Cipher IDs, chaining modes and padding modes. Run the test suites.
431 'cipher_id': ExclusiveDomain(cipher_info.base_symbols,
432 build_and_test),
433 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols,
434 build_and_test),
435 'cipher_padding': ExclusiveDomain(cipher_padding_symbols,
436 build_and_test),
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100437 # Elliptic curves. Run the test suites.
438 'curves': ExclusiveDomain(curve_symbols, build_and_test),
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400439 # Hash algorithms. Exclude exclusive domain of MD, RIPEMD, SHA1 (obsolete)
Andrzej Kurek068a73f2022-10-06 18:52:44 -0400440 'hashes': DualDomain(hash_symbols, build_and_test,
Andrzej Kurekaa112812022-11-22 08:13:45 -0500441 exclude=r'MBEDTLS_(MD|RIPEMD|SHA1_)'\
442 '|!MBEDTLS_*_NO_SHA'),
Andrzej Kurekddf62602023-01-23 06:19:14 -0500443 # Key exchange types.
Andrzej Kurekde416fc2022-11-02 04:50:16 -0400444 'kex': ExclusiveDomain(key_exchange_symbols, build_and_test),
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100445 'pkalgs': ComplementaryDomain(['MBEDTLS_ECDSA_C',
446 'MBEDTLS_ECP_C',
447 'MBEDTLS_PKCS1_V21',
448 'MBEDTLS_PKCS1_V15',
449 'MBEDTLS_RSA_C',
450 'MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
451 build_and_test),
452 }
453 self.jobs = {}
454 for domain in self.domains.values():
455 for job in domain.jobs:
456 self.jobs[job.name] = job
457
458 def get_jobs(self, name):
459 """Return the list of jobs identified by the given name.
460A name can either be the name of a domain or the name of one specific job."""
461 if name in self.domains:
462 return sorted(self.domains[name].jobs, key=lambda job: job.name)
463 else:
464 return [self.jobs[name]]
465
Andrzej Kurekcf394062023-02-15 05:42:02 -0500466def run(options, job, conf, colors=NO_COLORS):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100467 """Run the specified job (a Job instance)."""
468 subprocess.check_call([options.make_command, 'clean'])
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100469 job.announce(colors, None)
Andrzej Kurekcf394062023-02-15 05:42:02 -0500470 if not job.configure(conf, options, colors):
471 job.announce(colors, False)
472 return False
473 conf.write()
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100474 success = job.test(options)
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100475 job.announce(colors, success)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100476 return success
477
Andrzej Kurekcf394062023-02-15 05:42:02 -0500478def run_tests(options, domain_data, conf):
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100479 """Run the desired jobs.
480domain_data should be a DomainData instance that describes the available
481domains and jobs.
Andrzej Kurek113952d2022-10-17 08:39:09 -0400482Run the jobs listed in options.tasks."""
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100483 if not hasattr(options, 'config_backup'):
484 options.config_backup = options.config + '.bak'
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100485 colors = Colors(options)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100486 jobs = []
487 failures = []
488 successes = []
Andrzej Kurek113952d2022-10-17 08:39:09 -0400489 for name in options.tasks:
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100490 jobs += domain_data.get_jobs(name)
491 backup_config(options)
492 try:
493 for job in jobs:
Andrzej Kurekcf394062023-02-15 05:42:02 -0500494 success = run(options, job, conf, colors=colors)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100495 if not success:
496 if options.keep_going:
497 failures.append(job.name)
498 else:
499 return False
500 else:
501 successes.append(job.name)
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100502 restore_config(options)
503 except:
504 # Restore the configuration, except in stop-on-error mode if there
505 # was an error, where we leave the failing configuration up for
506 # developer convenience.
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100507 if options.keep_going:
Gilles Peskine88e8dd62019-01-29 18:52:16 +0100508 restore_config(options)
509 raise
Gilles Peskinedc68f612019-01-29 18:50:03 +0100510 if successes:
511 log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100512 if failures:
Gilles Peskinedc68f612019-01-29 18:50:03 +0100513 log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100514 return False
515 else:
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100516 return True
517
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400518def main():
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100519 try:
Andrzej Kurek110fc482022-10-09 05:29:44 -0400520 parser = argparse.ArgumentParser(
521 formatter_class=argparse.RawDescriptionHelpFormatter,
522 description=
523 "Test Mbed TLS with a subset of algorithms.\n\n"
524 "Example usage:\n"
Andrzej Kurekffbc8f52022-10-17 08:34:40 -0400525 r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA256_C""\n"
Andrzej Kurek110fc482022-10-09 05:29:44 -0400526 "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n"
527 "./tests/scripts/depends.py cipher_id cipher_chaining\n")
Gilles Peskinefd1d69c2019-01-29 18:48:48 +0100528 parser.add_argument('--color', metavar='WHEN',
529 help='Colorize the output (always/auto/never)',
530 choices=['always', 'auto', 'never'], default='auto')
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100531 parser.add_argument('-c', '--config', metavar='FILE',
532 help='Configuration file to modify',
Andrzej Kurek467a0f22022-10-20 06:15:06 -0400533 default='include/mbedtls/config.h')
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100534 parser.add_argument('-C', '--directory', metavar='DIR',
535 help='Change to this directory before anything else',
536 default='.')
537 parser.add_argument('-k', '--keep-going',
538 help='Try all configurations even if some fail (default)',
539 action='store_true', dest='keep_going', default=True)
540 parser.add_argument('-e', '--no-keep-going',
541 help='Stop as soon as a configuration fails',
542 action='store_false', dest='keep_going')
543 parser.add_argument('--list-jobs',
544 help='List supported jobs and exit',
545 action='append_const', dest='list', const='jobs')
546 parser.add_argument('--list-domains',
547 help='List supported domains and exit',
548 action='append_const', dest='list', const='domains')
549 parser.add_argument('--make-command', metavar='CMD',
550 help='Command to run instead of make (e.g. gmake)',
551 action='store', default='make')
Andrzej Kurek2b44a922022-10-24 10:41:20 -0400552 parser.add_argument('--unset-use-psa',
553 help='Unset MBEDTLS_USE_PSA_CRYPTO before any test',
554 action='store_true', dest='unset_use_psa')
Andrzej Kurek113952d2022-10-17 08:39:09 -0400555 parser.add_argument('tasks', metavar='TASKS', nargs='*',
556 help='The domain(s) or job(s) to test (default: all).',
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100557 default=True)
558 options = parser.parse_args()
559 os.chdir(options.directory)
Andrzej Kurekcf394062023-02-15 05:42:02 -0500560 conf = config.ConfigFile(options.config)
561 domain_data = DomainData(options, conf)
562
Andrzej Kurek113952d2022-10-17 08:39:09 -0400563 if options.tasks is True:
564 options.tasks = sorted(domain_data.domains.keys())
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100565 if options.list:
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400566 for arg in options.list:
567 for domain_name in sorted(getattr(domain_data, arg).keys()):
568 print(domain_name)
569 sys.exit(0)
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100570 else:
Andrzej Kurekcf394062023-02-15 05:42:02 -0500571 sys.exit(0 if run_tests(options, domain_data, conf) else 1)
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400572 except Exception: # pylint: disable=broad-except
Gilles Peskinef5ea1972019-01-29 08:50:20 +0100573 traceback.print_exc()
Andrzej Kurekb95ba9a2022-10-04 15:02:41 -0400574 sys.exit(3)
575
576if __name__ == '__main__':
577 main()