blob: 302a4be512c0d526fe2015e8f4b9b924ea6c76b4 [file] [log] [blame]
Gilles Peskineb39e3ec2019-01-29 08:50:20 +01001#!/usr/bin/env python3
2
Andrzej Kurek629c4122022-10-17 08:34:40 -04003# Copyright (c) 2022, Arm Limited, All Rights Reserved.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +01004# SPDX-License-Identifier: Apache-2.0
5#
6# Licensed under the Apache License, Version 2.0 (the "License"); you may
7# not use this file except in compliance with the License.
8# You may obtain a copy of the License at
9#
10# http://www.apache.org/licenses/LICENSE-2.0
11#
12# Unless required by applicable law or agreed to in writing, software
13# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15# See the License for the specific language governing permissions and
16# limitations under the License.
17#
18# This file is part of Mbed TLS (https://tls.mbed.org)
19
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010020"""
Andrzej Kurek01af84a2022-10-09 05:29:44 -040021Test Mbed TLS with a subset of algorithms.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010022
Andrzej Kurek01af84a2022-10-09 05:29:44 -040023This script can be divided into several steps:
24
25First, include/mbedtls/mbedtls_config.h or a different config file passed
Andrzej Kurek3f930122022-10-26 08:08:26 -040026in the arguments is parsed to extract any configuration options (using config.py).
Andrzej Kurek01af84a2022-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 Kurek629c4122022-10-17 08:34:40 -040030- domain name, can be used to run only specific tests via command-line;
Andrzej Kurek01af84a2022-10-09 05:29:44 -040031- configuration building method, described in detail below;
32- list of symbols passed to the configuration building method;
33- commands to be run on each job (only build, build and test, or any other custom);
34- optional list of symbols to be excluded from testing.
35
36The configuration building method can be one of the three following:
37
38- ComplementaryDomain - build a job for each passed symbol by disabling a single
39 symbol and its reverse dependencies (defined in REVERSE_DEPENDENCIES);
40
41- ExclusiveDomain - build a job where, for each passed symbol, only this particular
42 one is defined and other symbols from the list are unset. For each job look for
43 any non-standard symbols to set/unset in EXCLUSIVE_GROUPS. These are usually not
44 direct dependencies, but rather non-trivial results of other configs missing. Then
45 look for any unset symbols and handle their reverse dependencies.
46 Examples of EXCLUSIVE_GROUPS usage:
Andrzej Kurek629c4122022-10-17 08:34:40 -040047 - MBEDTLS_SHA256 job turns off all hashes except SHA256, however, when investigating
48 reverse dependencies, SHA224 is found to depend on SHA256, so it is disabled,
49 and then SHA256 is found to depend on SHA224, so it is also disabled. To handle
50 this, there's a field in EXCLUSIVE_GROUPS that states that in a SHA256 test SHA224
Andrzej Kurek01af84a2022-10-09 05:29:44 -040051 should also be enabled before processing reverse dependencies:
Andrzej Kurek629c4122022-10-17 08:34:40 -040052 'MBEDTLS_SHA256_C': ['+MBEDTLS_SHA224_C']
Andrzej Kurek01af84a2022-10-09 05:29:44 -040053 - MBEDTLS_SHA512_C job turns off all hashes except SHA512. MBEDTLS_SSL_COOKIE_C
54 requires either SHA256 or SHA384 to work, so it also has to be disabled.
55 This is not a dependency on SHA512_C, but a result of an exclusive domain
56 config building method. Relevant field:
Andrzej Kurek629c4122022-10-17 08:34:40 -040057 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_COOKIE_C'],
Andrzej Kurek01af84a2022-10-09 05:29:44 -040058
59- DualDomain - combination of the two above - both complementary and exclusive domain
60 job generation code will be run. Currently only used for hashes.
61
62Lastly, the collected jobs are executed and (optionally) tested, with
63error reporting and coloring as configured in options. Each test starts with
64a full config without a couple of slowing down or unnecessary options
65(see set_reference_config), then the specific job config is derived.
66"""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +010067import argparse
68import os
69import re
70import shutil
71import subprocess
72import sys
73import traceback
Andrzej Kurek576803f2023-01-24 07:40:42 -050074from typing import Union
75
Andrzej Kurek3b0215d2023-01-23 07:19:22 -050076# Add the Mbed TLS Python library directory to the module search path
Andrzej Kurek3f930122022-10-26 08:08:26 -040077import scripts_path # pylint: disable=unused-import
78import config
79
Andrzej Kurek3322c222022-10-04 15:02:41 -040080class Colors: # pylint: disable=too-few-public-methods
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010081 """Minimalistic support for colored output.
82Each field of an object of this class is either None if colored output
83is not possible or not desired, or a pair of strings (start, stop) such
84that outputting start switches the text color to the desired color and
85stop switches the text color back to the default."""
86 red = None
87 green = None
Andrzej Kurek3f930122022-10-26 08:08:26 -040088 cyan = None
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010089 bold_red = None
90 bold_green = None
91 def __init__(self, options=None):
Andrzej Kurek3322c222022-10-04 15:02:41 -040092 """Initialize color profile according to passed options."""
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +010093 if not options or options.color in ['no', 'never']:
94 want_color = False
95 elif options.color in ['yes', 'always']:
96 want_color = True
97 else:
98 want_color = sys.stderr.isatty()
99 if want_color:
100 # Assume ANSI compatible terminal
101 normal = '\033[0m'
102 self.red = ('\033[31m', normal)
103 self.green = ('\033[32m', normal)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400104 self.cyan = ('\033[36m', normal)
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100105 self.bold_red = ('\033[1;31m', normal)
106 self.bold_green = ('\033[1;32m', normal)
107NO_COLORS = Colors(None)
108
109def log_line(text, prefix='depends.py:', suffix='', color=None):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100110 """Print a status message."""
Andrzej Kurek3322c222022-10-04 15:02:41 -0400111 if color is not None:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100112 prefix = color[0] + prefix
113 suffix = suffix + color[1]
114 sys.stderr.write(prefix + ' ' + text + suffix + '\n')
Gilles Peskine46c82562019-01-29 18:42:55 +0100115 sys.stderr.flush()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100116
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100117def log_command(cmd):
118 """Print a trace of the specified command.
119cmd is a list of strings: a command name and its arguments."""
120 log_line(' '.join(cmd), prefix='+')
121
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100122def backup_config(options):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400123 """Back up the library configuration file (mbedtls_config.h).
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100124If the backup file already exists, it is presumed to be the desired backup,
125so don't make another backup."""
126 if os.path.exists(options.config_backup):
127 options.own_backup = False
128 else:
129 options.own_backup = True
130 shutil.copy(options.config, options.config_backup)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100131
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100132def restore_config(options):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400133 """Restore the library configuration file (mbedtls_config.h).
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100134Remove the backup file if it was saved earlier."""
135 if options.own_backup:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100136 shutil.move(options.config_backup, options.config)
137 else:
138 shutil.copy(options.config_backup, options.config)
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100139
Andrzej Kurek3f930122022-10-26 08:08:26 -0400140def option_exists(conf, option):
141 if option not in conf.settings:
142 return False
143 return True
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100144
Andrzej Kurek576803f2023-01-24 07:40:42 -0500145def set_config_option_value(conf, option, colors, value: Union[bool, str]):
146 """Set/unset a configuration option, optionally specifying a value.
147value can be either True/False (set/unset config option), or a string,
148which will make a symbol defined with a certain value."""
Andrzej Kurek3f930122022-10-26 08:08:26 -0400149 if not option_exists(conf, option):
150 log_line('Symbol {} was not found in {}'.format(option, conf.filename), color=colors.red)
151 return False
Andrzej Kurek3f930122022-10-26 08:08:26 -0400152
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500153 if value is False:
154 log_command(['config.py', 'unset', option])
155 conf.unset(option)
156 else:
157 if value is True:
158 log_command(['config.py', 'set', option])
159 conf.set(option)
160 else:
161 log_command(['config.py', 'set', option, value])
162 conf.set(option, value)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400163 return True
164
165def set_reference_config(conf, options, colors):
Andrzej Kurek3322c222022-10-04 15:02:41 -0400166 """Change the library configuration file (mbedtls_config.h) to the reference state.
167The reference state is the one from which the tested configurations are
168derived."""
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400169 # Turn off options that are not relevant to the tests and slow them down.
Andrzej Kurek3f930122022-10-26 08:08:26 -0400170 log_command(['config.py', 'full'])
171 conf.adapt(config.full_adapter)
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500172 set_config_option_value(conf, 'MBEDTLS_TEST_HOOKS', colors, False)
Andrzej Kurek2c7993c2022-10-24 10:41:20 -0400173 if options.unset_use_psa:
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500174 set_config_option_value(conf, 'MBEDTLS_USE_PSA_CRYPTO', colors, False)
Andrzej Kurek3322c222022-10-04 15:02:41 -0400175
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100176class Job:
177 """A job builds the library in a specific configuration and runs some tests."""
178 def __init__(self, name, config_settings, commands):
179 """Build a job object.
180The job uses the configuration described by config_settings. This is a
181dictionary where the keys are preprocessor symbols and the values are
182booleans or strings. A boolean indicates whether or not to #define the
183symbol. With a string, the symbol is #define'd to that value.
184After setting the configuration, the job runs the programs specified by
185commands. This is a list of lists of strings; each list of string is a
186command name and its arguments and is passed to subprocess.call with
187shell=False."""
188 self.name = name
189 self.config_settings = config_settings
190 self.commands = commands
191
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100192 def announce(self, colors, what):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100193 '''Announce the start or completion of a job.
194If what is None, announce the start of the job.
195If what is True, announce that the job has passed.
196If what is False, announce that the job has failed.'''
197 if what is True:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100198 log_line(self.name + ' PASSED', color=colors.green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100199 elif what is False:
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100200 log_line(self.name + ' FAILED', color=colors.red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100201 else:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400202 log_line('starting ' + self.name, color=colors.cyan)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100203
Andrzej Kurek3f930122022-10-26 08:08:26 -0400204 def configure(self, conf, options, colors):
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400205 '''Set library configuration options as required for the job.'''
Andrzej Kurek3f930122022-10-26 08:08:26 -0400206 set_reference_config(conf, options, colors)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100207 for key, value in sorted(self.config_settings.items()):
Andrzej Kurek3b0215d2023-01-23 07:19:22 -0500208 ret = set_config_option_value(conf, key, colors, value)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400209 if ret is False:
210 return False
211 return True
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100212
213 def test(self, options):
214 '''Run the job's build and test commands.
215Return True if all the commands succeed and False otherwise.
216If options.keep_going is false, stop as soon as one command fails. Otherwise
217run all the commands, except that if the first command fails, none of the
218other commands are run (typically, the first command is a build command
219and subsequent commands are tests that cannot run if the build failed).'''
220 built = False
221 success = True
222 for command in self.commands:
Gilles Peskine54aa5c62019-01-29 18:46:34 +0100223 log_command(command)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100224 ret = subprocess.call(command)
225 if ret != 0:
226 if command[0] not in ['make', options.make_command]:
227 log_line('*** [{}] Error {}'.format(' '.join(command), ret))
228 if not options.keep_going or not built:
229 return False
230 success = False
231 built = True
232 return success
233
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100234# If the configuration option A requires B, make sure that
Andrzej Kurek202932f2022-10-04 16:22:22 -0400235# B in REVERSE_DEPENDENCIES[A].
Gilles Peskine584c24a2019-01-29 19:30:40 +0100236# All the information here should be contained in check_config.h. This
237# file includes a copy because it changes rarely and it would be a pain
238# to extract automatically.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400239REVERSE_DEPENDENCIES = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100240 'MBEDTLS_AES_C': ['MBEDTLS_CTR_DRBG_C',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400241 'MBEDTLS_NIST_KW_C'],
Gilles Peskine34a15572019-01-29 23:12:28 +0100242 'MBEDTLS_CHACHA20_C': ['MBEDTLS_CHACHAPOLY_C'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400243 'MBEDTLS_ECDSA_C': ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
244 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100245 'MBEDTLS_ECP_C': ['MBEDTLS_ECDSA_C',
246 'MBEDTLS_ECDH_C',
247 'MBEDTLS_ECJPAKE_C',
248 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
249 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED',
250 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED',
251 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400252 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
Ronald Crond8d2ea52022-10-04 15:48:06 +0200253 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
254 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED',
255 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100256 'MBEDTLS_ECP_DP_SECP256R1_ENABLED': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100257 'MBEDTLS_PKCS1_V21': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
258 'MBEDTLS_PKCS1_V15': ['MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
259 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
260 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
261 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'],
262 'MBEDTLS_RSA_C': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT',
263 'MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED',
264 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED',
265 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400266 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED',
267 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED'],
Gilles Peskine584c24a2019-01-29 19:30:40 +0100268 'MBEDTLS_SHA256_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400269 'MBEDTLS_ENTROPY_FORCE_SHA256',
270 'MBEDTLS_SHA224_C',
271 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
Andrzej Kurek22b959d2022-10-16 12:51:41 -0400272 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY',
273 'MBEDTLS_LMS_C',
274 'MBEDTLS_LMS_PRIVATE'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400275 'MBEDTLS_SHA512_C': ['MBEDTLS_SHA384_C',
276 'MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT',
277 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY'],
278 'MBEDTLS_SHA224_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED',
279 'MBEDTLS_ENTROPY_FORCE_SHA256',
280 'MBEDTLS_SHA256_C',
281 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT',
282 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400283 'MBEDTLS_X509_RSASSA_PSS_SUPPORT': []
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100284}
285
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400286# If an option is tested in an exclusive test, alter the following defines.
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400287# These are not necessarily dependencies, but just minimal required changes
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400288# if a given define is the only one enabled from an exclusive group.
Andrzej Kurek202932f2022-10-04 16:22:22 -0400289EXCLUSIVE_GROUPS = {
Andrzej Kurek65b2ac12022-10-14 08:09:16 -0400290 'MBEDTLS_SHA256_C': ['+MBEDTLS_SHA224_C'],
291 'MBEDTLS_SHA384_C': ['+MBEDTLS_SHA512_C'],
292 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_COOKIE_C',
293 '-MBEDTLS_SSL_PROTO_TLS1_3'],
294 'MBEDTLS_ECP_DP_CURVE448_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_ECP_DP_CURVE25519_ENABLED': ['-MBEDTLS_ECDSA_C',
301 '-MBEDTLS_ECDSA_DETERMINISTIC',
302 '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED',
303 '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED',
304 '-MBEDTLS_ECJPAKE_C',
305 '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'],
306 'MBEDTLS_ARIA_C': ['-MBEDTLS_CMAC_C'],
307 'MBEDTLS_CAMELLIA_C': ['-MBEDTLS_CMAC_C'],
308 'MBEDTLS_CHACHA20_C': ['-MBEDTLS_CMAC_C', '-MBEDTLS_CCM_C', '-MBEDTLS_GCM_C'],
309 'MBEDTLS_DES_C': ['-MBEDTLS_CCM_C',
310 '-MBEDTLS_GCM_C',
311 '-MBEDTLS_SSL_TICKET_C',
312 '-MBEDTLS_SSL_CONTEXT_SERIALIZATION'],
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400313}
314def handle_exclusive_groups(config_settings, symbol):
315 """For every symbol tested in an exclusive group check if there are other
316defines to be altered. """
Andrzej Kurek202932f2022-10-04 16:22:22 -0400317 for dep in EXCLUSIVE_GROUPS.get(symbol, []):
Andrzej Kurek65b2ac12022-10-14 08:09:16 -0400318 unset = dep.startswith('-')
319 dep = dep[1:]
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400320 config_settings[dep] = not unset
321
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100322def turn_off_dependencies(config_settings):
323 """For every option turned off config_settings, also turn off what depends on it.
324An option O is turned off if config_settings[O] is False."""
325 for key, value in sorted(config_settings.items()):
326 if value is not False:
327 continue
Andrzej Kurek202932f2022-10-04 16:22:22 -0400328 for dep in REVERSE_DEPENDENCIES.get(key, []):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100329 config_settings[dep] = False
330
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400331class BaseDomain: # pylint: disable=too-few-public-methods, unused-argument
332 """A base class for all domains."""
333 def __init__(self, symbols, commands, exclude):
334 """Initialize the jobs container"""
335 self.jobs = []
336
337class ExclusiveDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100338 """A domain consisting of a set of conceptually-equivalent settings.
339Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kurekfe469492022-10-06 16:57:38 -0400340with this symbol set and the others unset."""
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100341 def __init__(self, symbols, commands, exclude=None):
342 """Build a domain for the specified list of configuration symbols.
Andrzej Kurekfe469492022-10-06 16:57:38 -0400343The domain contains a set of jobs that enable one of the elements
344of symbols and disable the others.
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100345Each job runs the specified commands.
346If exclude is a regular expression, skip generated jobs whose description
347would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400348 super().__init__(symbols, commands, exclude)
Andrzej Kurekfe469492022-10-06 16:57:38 -0400349 base_config_settings = {}
350 for symbol in symbols:
351 base_config_settings[symbol] = False
352 for symbol in symbols:
353 description = symbol
354 if exclude and re.match(exclude, description):
355 continue
356 config_settings = base_config_settings.copy()
357 config_settings[symbol] = True
358 handle_exclusive_groups(config_settings, symbol)
359 turn_off_dependencies(config_settings)
360 job = Job(description, config_settings, commands)
361 self.jobs.append(job)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100362
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400363class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100364 """A domain consisting of a set of loosely-related settings.
365Establish a list of configuration symbols. For each symbol, run a test job
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400366with this symbol unset.
367If exclude is a regular expression, skip generated jobs whose description
368would match this regular expression."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400369 def __init__(self, symbols, commands, exclude=None):
Gilles Peskineb1284cf2019-01-29 18:56:03 +0100370 """Build a domain for the specified list of configuration symbols.
371Each job in the domain disables one of the specified symbols.
372Each job runs the specified commands."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400373 super().__init__(symbols, commands, exclude)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100374 for symbol in symbols:
375 description = '!' + symbol
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400376 if exclude and re.match(exclude, description):
377 continue
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100378 config_settings = {symbol: False}
379 turn_off_dependencies(config_settings)
380 job = Job(description, config_settings, commands)
381 self.jobs.append(job)
382
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400383class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400384 """A domain that contains both the ExclusiveDomain and BaseDomain tests.
Andrzej Kurekf4b18672022-10-14 07:57:00 -0400385Both parent class __init__ calls are performed in any order and
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400386each call adds respective jobs. The job array initialization is done once in
387BaseDomain, before the parent __init__ calls."""
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400388
Andrzej Kurek3322c222022-10-04 15:02:41 -0400389class CipherInfo: # pylint: disable=too-few-public-methods
Gilles Peskine34a15572019-01-29 23:12:28 +0100390 """Collect data about cipher.h."""
Andrzej Kurek3322c222022-10-04 15:02:41 -0400391 def __init__(self):
Gilles Peskine34a15572019-01-29 23:12:28 +0100392 self.base_symbols = set()
Andrzej Kurek3322c222022-10-04 15:02:41 -0400393 with open('include/mbedtls/cipher.h', encoding="utf-8") as fh:
Gilles Peskine34a15572019-01-29 23:12:28 +0100394 for line in fh:
395 m = re.match(r' *MBEDTLS_CIPHER_ID_(\w+),', line)
396 if m and m.group(1) not in ['NONE', 'NULL', '3DES']:
397 self.base_symbols.add('MBEDTLS_' + m.group(1) + '_C')
398
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100399class DomainData:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400400 """A container for domains and jobs, used to structurize testing."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100401 def config_symbols_matching(self, regexp):
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400402 """List the mbedtls_config.h settings matching regexp."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100403 return [symbol for symbol in self.all_config_symbols
404 if re.match(regexp, symbol)]
405
Andrzej Kurek3f930122022-10-26 08:08:26 -0400406 def __init__(self, options, conf):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100407 """Gather data about the library and establish a list of domains to test."""
408 build_command = [options.make_command, 'CFLAGS=-Werror']
409 build_and_test = [build_command, [options.make_command, 'test']]
Andrzej Kurek3f930122022-10-26 08:08:26 -0400410 self.all_config_symbols = set(conf.settings.keys())
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100411 # Find hash modules by name.
412 hash_symbols = self.config_symbols_matching(r'MBEDTLS_(MD|RIPEMD|SHA)[0-9]+_C\Z')
413 # Find elliptic curve enabling macros by name.
414 curve_symbols = self.config_symbols_matching(r'MBEDTLS_ECP_DP_\w+_ENABLED\Z')
415 # Find key exchange enabling macros by name.
416 key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z')
Gilles Peskine34a15572019-01-29 23:12:28 +0100417 # Find cipher IDs (block permutations and stream ciphers --- chaining
418 # and padding modes are exercised separately) information by parsing
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400419 # cipher.h, as the information is not readily available in mbedtls_config.h.
Andrzej Kurek3322c222022-10-04 15:02:41 -0400420 cipher_info = CipherInfo()
Gilles Peskine34a15572019-01-29 23:12:28 +0100421 # Find block cipher chaining and padding mode enabling macros by name.
422 cipher_chaining_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_MODE_\w+\Z')
423 cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100424 self.domains = {
Gilles Peskine34a15572019-01-29 23:12:28 +0100425 # Cipher IDs, chaining modes and padding modes. Run the test suites.
426 'cipher_id': ExclusiveDomain(cipher_info.base_symbols,
427 build_and_test),
428 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols,
429 build_and_test),
430 'cipher_padding': ExclusiveDomain(cipher_padding_symbols,
431 build_and_test),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100432 # Elliptic curves. Run the test suites.
433 'curves': ExclusiveDomain(curve_symbols, build_and_test),
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400434 # Hash algorithms. Exclude three groups:
435 # - Exclusive domain of MD, RIPEMD, SHA1 (obsolete);
436 # - Exclusive domain of SHA224 (tested with and depends on SHA256);
437 # - Complementary domain of SHA224 and SHA384 - tested with and depend
438 # on SHA256 and SHA512, respectively.
Andrzej Kurek228b12c2022-10-06 18:52:44 -0400439 'hashes': DualDomain(hash_symbols, build_and_test,
Andrzej Kureka0cb4fa2022-10-14 07:06:43 -0400440 exclude=r'MBEDTLS_(MD|RIPEMD|SHA1_)' \
441 '|MBEDTLS_SHA224_'\
442 '|!MBEDTLS_(SHA224_|SHA384_)'),
Gilles Peskinec3b4dee2019-01-29 19:33:05 +0100443 # Key exchange types. Only build the library and the sample
444 # programs.
445 'kex': ExclusiveDomain(key_exchange_symbols,
446 [build_command + ['lib'],
447 build_command + ['-C', 'programs']]),
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100448 'pkalgs': ComplementaryDomain(['MBEDTLS_ECDSA_C',
449 'MBEDTLS_ECP_C',
450 'MBEDTLS_PKCS1_V21',
451 'MBEDTLS_PKCS1_V15',
452 'MBEDTLS_RSA_C',
453 'MBEDTLS_X509_RSASSA_PSS_SUPPORT'],
454 build_and_test),
455 }
456 self.jobs = {}
457 for domain in self.domains.values():
458 for job in domain.jobs:
459 self.jobs[job.name] = job
460
461 def get_jobs(self, name):
462 """Return the list of jobs identified by the given name.
463A name can either be the name of a domain or the name of one specific job."""
464 if name in self.domains:
465 return sorted(self.domains[name].jobs, key=lambda job: job.name)
466 else:
467 return [self.jobs[name]]
468
Andrzej Kurek3f930122022-10-26 08:08:26 -0400469def run(options, job, conf, colors=NO_COLORS):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100470 """Run the specified job (a Job instance)."""
471 subprocess.check_call([options.make_command, 'clean'])
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100472 job.announce(colors, None)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400473 if not job.configure(conf, options, colors):
474 job.announce(colors, False)
475 return False
476 conf.write()
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100477 success = job.test(options)
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100478 job.announce(colors, success)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100479 return success
480
Andrzej Kurek3f930122022-10-26 08:08:26 -0400481def run_tests(options, domain_data, conf):
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100482 """Run the desired jobs.
483domain_data should be a DomainData instance that describes the available
484domains and jobs.
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400485Run the jobs listed in options.tasks."""
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100486 if not hasattr(options, 'config_backup'):
487 options.config_backup = options.config + '.bak'
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100488 colors = Colors(options)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100489 jobs = []
490 failures = []
491 successes = []
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400492 for name in options.tasks:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100493 jobs += domain_data.get_jobs(name)
494 backup_config(options)
495 try:
496 for job in jobs:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400497 success = run(options, job, conf, colors=colors)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100498 if not success:
499 if options.keep_going:
500 failures.append(job.name)
501 else:
502 return False
503 else:
504 successes.append(job.name)
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100505 restore_config(options)
506 except:
507 # Restore the configuration, except in stop-on-error mode if there
508 # was an error, where we leave the failing configuration up for
509 # developer convenience.
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100510 if options.keep_going:
Gilles Peskinebf7537d2019-01-29 18:52:16 +0100511 restore_config(options)
512 raise
Gilles Peskinee85163b2019-01-29 18:50:03 +0100513 if successes:
514 log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100515 if failures:
Gilles Peskinee85163b2019-01-29 18:50:03 +0100516 log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100517 return False
518 else:
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100519 return True
520
Andrzej Kurek3322c222022-10-04 15:02:41 -0400521def main():
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100522 try:
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400523 parser = argparse.ArgumentParser(
524 formatter_class=argparse.RawDescriptionHelpFormatter,
525 description=
526 "Test Mbed TLS with a subset of algorithms.\n\n"
527 "Example usage:\n"
Andrzej Kurek629c4122022-10-17 08:34:40 -0400528 r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA256_C""\n"
Andrzej Kurek01af84a2022-10-09 05:29:44 -0400529 "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n"
530 "./tests/scripts/depends.py cipher_id cipher_chaining\n")
Gilles Peskine0fa7cbe2019-01-29 18:48:48 +0100531 parser.add_argument('--color', metavar='WHEN',
532 help='Colorize the output (always/auto/never)',
533 choices=['always', 'auto', 'never'], default='auto')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100534 parser.add_argument('-c', '--config', metavar='FILE',
535 help='Configuration file to modify',
Andrzej Kureke05b17f2022-09-28 03:17:56 -0400536 default='include/mbedtls/mbedtls_config.h')
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100537 parser.add_argument('-C', '--directory', metavar='DIR',
538 help='Change to this directory before anything else',
539 default='.')
540 parser.add_argument('-k', '--keep-going',
541 help='Try all configurations even if some fail (default)',
542 action='store_true', dest='keep_going', default=True)
543 parser.add_argument('-e', '--no-keep-going',
544 help='Stop as soon as a configuration fails',
545 action='store_false', dest='keep_going')
546 parser.add_argument('--list-jobs',
547 help='List supported jobs and exit',
548 action='append_const', dest='list', const='jobs')
549 parser.add_argument('--list-domains',
550 help='List supported domains and exit',
551 action='append_const', dest='list', const='domains')
552 parser.add_argument('--make-command', metavar='CMD',
553 help='Command to run instead of make (e.g. gmake)',
554 action='store', default='make')
Andrzej Kurek2c7993c2022-10-24 10:41:20 -0400555 parser.add_argument('--unset-use-psa',
556 help='Unset MBEDTLS_USE_PSA_CRYPTO before any test',
557 action='store_true', dest='unset_use_psa')
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400558 parser.add_argument('tasks', metavar='TASKS', nargs='*',
559 help='The domain(s) or job(s) to test (default: all).',
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100560 default=True)
561 options = parser.parse_args()
562 os.chdir(options.directory)
Andrzej Kurek3f930122022-10-26 08:08:26 -0400563 conf = config.ConfigFile(options.config)
564 domain_data = DomainData(options, conf)
565
Andrzej Kurekb8a97e72022-10-17 08:39:09 -0400566 if options.tasks is True:
567 options.tasks = sorted(domain_data.domains.keys())
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100568 if options.list:
Andrzej Kurek3322c222022-10-04 15:02:41 -0400569 for arg in options.list:
570 for domain_name in sorted(getattr(domain_data, arg).keys()):
571 print(domain_name)
572 sys.exit(0)
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100573 else:
Andrzej Kurek3f930122022-10-26 08:08:26 -0400574 sys.exit(0 if run_tests(options, domain_data, conf) else 1)
Andrzej Kurek3322c222022-10-04 15:02:41 -0400575 except Exception: # pylint: disable=broad-except
Gilles Peskineb39e3ec2019-01-29 08:50:20 +0100576 traceback.print_exc()
Andrzej Kurek3322c222022-10-04 15:02:41 -0400577 sys.exit(3)
578
579if __name__ == '__main__':
580 main()