Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
| 2 | |
Andrzej Kurek | 629c412 | 2022-10-17 08:34:40 -0400 | [diff] [blame] | 3 | # Copyright (c) 2022, Arm Limited, All Rights Reserved. |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 4 | # 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 Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 20 | """ |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 21 | Test Mbed TLS with a subset of algorithms. |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 22 | |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 23 | This script can be divided into several steps: |
| 24 | |
| 25 | First, include/mbedtls/mbedtls_config.h or a different config file passed |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 26 | in the arguments is parsed to extract any configuration options (using config.py). |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 27 | |
| 28 | Then, test domains (groups of jobs, tests) are built based on predefined data |
| 29 | collected in the DomainData class. Here, each domain has five major traits: |
Andrzej Kurek | 629c412 | 2022-10-17 08:34:40 -0400 | [diff] [blame] | 30 | - domain name, can be used to run only specific tests via command-line; |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 31 | - 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 | |
| 36 | The 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 Kurek | 629c412 | 2022-10-17 08:34:40 -0400 | [diff] [blame] | 47 | - 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 Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 51 | should also be enabled before processing reverse dependencies: |
Andrzej Kurek | 629c412 | 2022-10-17 08:34:40 -0400 | [diff] [blame] | 52 | 'MBEDTLS_SHA256_C': ['+MBEDTLS_SHA224_C'] |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 53 | - 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 Kurek | 629c412 | 2022-10-17 08:34:40 -0400 | [diff] [blame] | 57 | 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_COOKIE_C'], |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 58 | |
| 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 | |
| 62 | Lastly, the collected jobs are executed and (optionally) tested, with |
| 63 | error reporting and coloring as configured in options. Each test starts with |
| 64 | a 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 Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 67 | import argparse |
| 68 | import os |
| 69 | import re |
| 70 | import shutil |
| 71 | import subprocess |
| 72 | import sys |
| 73 | import traceback |
Andrzej Kurek | 576803f | 2023-01-24 07:40:42 -0500 | [diff] [blame] | 74 | from typing import Union |
| 75 | |
Andrzej Kurek | 3b0215d | 2023-01-23 07:19:22 -0500 | [diff] [blame] | 76 | # Add the Mbed TLS Python library directory to the module search path |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 77 | import scripts_path # pylint: disable=unused-import |
| 78 | import config |
| 79 | |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 80 | class Colors: # pylint: disable=too-few-public-methods |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 81 | """Minimalistic support for colored output. |
| 82 | Each field of an object of this class is either None if colored output |
| 83 | is not possible or not desired, or a pair of strings (start, stop) such |
| 84 | that outputting start switches the text color to the desired color and |
| 85 | stop switches the text color back to the default.""" |
| 86 | red = None |
| 87 | green = None |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 88 | cyan = None |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 89 | bold_red = None |
| 90 | bold_green = None |
| 91 | def __init__(self, options=None): |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 92 | """Initialize color profile according to passed options.""" |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 93 | 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 Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 104 | self.cyan = ('\033[36m', normal) |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 105 | self.bold_red = ('\033[1;31m', normal) |
| 106 | self.bold_green = ('\033[1;32m', normal) |
| 107 | NO_COLORS = Colors(None) |
| 108 | |
| 109 | def log_line(text, prefix='depends.py:', suffix='', color=None): |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 110 | """Print a status message.""" |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 111 | if color is not None: |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 112 | prefix = color[0] + prefix |
| 113 | suffix = suffix + color[1] |
| 114 | sys.stderr.write(prefix + ' ' + text + suffix + '\n') |
Gilles Peskine | 46c8256 | 2019-01-29 18:42:55 +0100 | [diff] [blame] | 115 | sys.stderr.flush() |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 116 | |
Gilles Peskine | 54aa5c6 | 2019-01-29 18:46:34 +0100 | [diff] [blame] | 117 | def log_command(cmd): |
| 118 | """Print a trace of the specified command. |
| 119 | cmd is a list of strings: a command name and its arguments.""" |
| 120 | log_line(' '.join(cmd), prefix='+') |
| 121 | |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 122 | def backup_config(options): |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 123 | """Back up the library configuration file (mbedtls_config.h). |
Gilles Peskine | bf7537d | 2019-01-29 18:52:16 +0100 | [diff] [blame] | 124 | If the backup file already exists, it is presumed to be the desired backup, |
| 125 | so 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 Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 131 | |
Gilles Peskine | bf7537d | 2019-01-29 18:52:16 +0100 | [diff] [blame] | 132 | def restore_config(options): |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 133 | """Restore the library configuration file (mbedtls_config.h). |
Gilles Peskine | bf7537d | 2019-01-29 18:52:16 +0100 | [diff] [blame] | 134 | Remove the backup file if it was saved earlier.""" |
| 135 | if options.own_backup: |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 136 | shutil.move(options.config_backup, options.config) |
| 137 | else: |
| 138 | shutil.copy(options.config_backup, options.config) |
Gilles Peskine | bf7537d | 2019-01-29 18:52:16 +0100 | [diff] [blame] | 139 | |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 140 | def option_exists(conf, option): |
Andrzej Kurek | 81cf5ad | 2023-02-06 10:48:43 +0100 | [diff] [blame] | 141 | return option in conf.settings |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 142 | |
Andrzej Kurek | 576803f | 2023-01-24 07:40:42 -0500 | [diff] [blame] | 143 | def set_config_option_value(conf, option, colors, value: Union[bool, str]): |
| 144 | """Set/unset a configuration option, optionally specifying a value. |
| 145 | value can be either True/False (set/unset config option), or a string, |
| 146 | which will make a symbol defined with a certain value.""" |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 147 | if not option_exists(conf, option): |
| 148 | log_line('Symbol {} was not found in {}'.format(option, conf.filename), color=colors.red) |
| 149 | return False |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 150 | |
Andrzej Kurek | 3b0215d | 2023-01-23 07:19:22 -0500 | [diff] [blame] | 151 | if value is False: |
| 152 | log_command(['config.py', 'unset', option]) |
| 153 | conf.unset(option) |
Andrzej Kurek | 72082dc | 2023-02-06 10:49:46 +0100 | [diff] [blame^] | 154 | elif value is True: |
| 155 | log_command(['config.py', 'set', option]) |
| 156 | conf.set(option) |
Andrzej Kurek | 3b0215d | 2023-01-23 07:19:22 -0500 | [diff] [blame] | 157 | else: |
Andrzej Kurek | 72082dc | 2023-02-06 10:49:46 +0100 | [diff] [blame^] | 158 | log_command(['config.py', 'set', option, value]) |
| 159 | conf.set(option, value) |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 160 | return True |
| 161 | |
| 162 | def set_reference_config(conf, options, colors): |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 163 | """Change the library configuration file (mbedtls_config.h) to the reference state. |
| 164 | The reference state is the one from which the tested configurations are |
| 165 | derived.""" |
Andrzej Kurek | a0cb4fa | 2022-10-14 07:06:43 -0400 | [diff] [blame] | 166 | # Turn off options that are not relevant to the tests and slow them down. |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 167 | log_command(['config.py', 'full']) |
| 168 | conf.adapt(config.full_adapter) |
Andrzej Kurek | 3b0215d | 2023-01-23 07:19:22 -0500 | [diff] [blame] | 169 | set_config_option_value(conf, 'MBEDTLS_TEST_HOOKS', colors, False) |
Andrzej Kurek | 2c7993c | 2022-10-24 10:41:20 -0400 | [diff] [blame] | 170 | if options.unset_use_psa: |
Andrzej Kurek | 3b0215d | 2023-01-23 07:19:22 -0500 | [diff] [blame] | 171 | set_config_option_value(conf, 'MBEDTLS_USE_PSA_CRYPTO', colors, False) |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 172 | |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 173 | class Job: |
| 174 | """A job builds the library in a specific configuration and runs some tests.""" |
| 175 | def __init__(self, name, config_settings, commands): |
| 176 | """Build a job object. |
| 177 | The job uses the configuration described by config_settings. This is a |
| 178 | dictionary where the keys are preprocessor symbols and the values are |
| 179 | booleans or strings. A boolean indicates whether or not to #define the |
| 180 | symbol. With a string, the symbol is #define'd to that value. |
| 181 | After setting the configuration, the job runs the programs specified by |
| 182 | commands. This is a list of lists of strings; each list of string is a |
| 183 | command name and its arguments and is passed to subprocess.call with |
| 184 | shell=False.""" |
| 185 | self.name = name |
| 186 | self.config_settings = config_settings |
| 187 | self.commands = commands |
| 188 | |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 189 | def announce(self, colors, what): |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 190 | '''Announce the start or completion of a job. |
| 191 | If what is None, announce the start of the job. |
| 192 | If what is True, announce that the job has passed. |
| 193 | If what is False, announce that the job has failed.''' |
| 194 | if what is True: |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 195 | log_line(self.name + ' PASSED', color=colors.green) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 196 | elif what is False: |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 197 | log_line(self.name + ' FAILED', color=colors.red) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 198 | else: |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 199 | log_line('starting ' + self.name, color=colors.cyan) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 200 | |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 201 | def configure(self, conf, options, colors): |
Andrzej Kurek | a0cb4fa | 2022-10-14 07:06:43 -0400 | [diff] [blame] | 202 | '''Set library configuration options as required for the job.''' |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 203 | set_reference_config(conf, options, colors) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 204 | for key, value in sorted(self.config_settings.items()): |
Andrzej Kurek | 3b0215d | 2023-01-23 07:19:22 -0500 | [diff] [blame] | 205 | ret = set_config_option_value(conf, key, colors, value) |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 206 | if ret is False: |
| 207 | return False |
| 208 | return True |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 209 | |
| 210 | def test(self, options): |
| 211 | '''Run the job's build and test commands. |
| 212 | Return True if all the commands succeed and False otherwise. |
| 213 | If options.keep_going is false, stop as soon as one command fails. Otherwise |
| 214 | run all the commands, except that if the first command fails, none of the |
| 215 | other commands are run (typically, the first command is a build command |
| 216 | and subsequent commands are tests that cannot run if the build failed).''' |
| 217 | built = False |
| 218 | success = True |
| 219 | for command in self.commands: |
Gilles Peskine | 54aa5c6 | 2019-01-29 18:46:34 +0100 | [diff] [blame] | 220 | log_command(command) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 221 | ret = subprocess.call(command) |
| 222 | if ret != 0: |
| 223 | if command[0] not in ['make', options.make_command]: |
| 224 | log_line('*** [{}] Error {}'.format(' '.join(command), ret)) |
| 225 | if not options.keep_going or not built: |
| 226 | return False |
| 227 | success = False |
| 228 | built = True |
| 229 | return success |
| 230 | |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 231 | # If the configuration option A requires B, make sure that |
Andrzej Kurek | 202932f | 2022-10-04 16:22:22 -0400 | [diff] [blame] | 232 | # B in REVERSE_DEPENDENCIES[A]. |
Gilles Peskine | 584c24a | 2019-01-29 19:30:40 +0100 | [diff] [blame] | 233 | # All the information here should be contained in check_config.h. This |
| 234 | # file includes a copy because it changes rarely and it would be a pain |
| 235 | # to extract automatically. |
Andrzej Kurek | 202932f | 2022-10-04 16:22:22 -0400 | [diff] [blame] | 236 | REVERSE_DEPENDENCIES = { |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 237 | 'MBEDTLS_AES_C': ['MBEDTLS_CTR_DRBG_C', |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 238 | 'MBEDTLS_NIST_KW_C'], |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 239 | 'MBEDTLS_CHACHA20_C': ['MBEDTLS_CHACHAPOLY_C'], |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 240 | 'MBEDTLS_ECDSA_C': ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED', |
| 241 | 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'], |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 242 | 'MBEDTLS_ECP_C': ['MBEDTLS_ECDSA_C', |
| 243 | 'MBEDTLS_ECDH_C', |
| 244 | 'MBEDTLS_ECJPAKE_C', |
| 245 | 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED', |
| 246 | 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED', |
| 247 | 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED', |
| 248 | 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED', |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 249 | 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED', |
Ronald Cron | d8d2ea5 | 2022-10-04 15:48:06 +0200 | [diff] [blame] | 250 | 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED', |
| 251 | 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED', |
| 252 | 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED'], |
Gilles Peskine | 584c24a | 2019-01-29 19:30:40 +0100 | [diff] [blame] | 253 | 'MBEDTLS_ECP_DP_SECP256R1_ENABLED': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'], |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 254 | 'MBEDTLS_PKCS1_V21': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT'], |
| 255 | 'MBEDTLS_PKCS1_V15': ['MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED', |
| 256 | 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED', |
| 257 | 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED', |
| 258 | 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'], |
| 259 | 'MBEDTLS_RSA_C': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT', |
| 260 | 'MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED', |
| 261 | 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED', |
| 262 | 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED', |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 263 | 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED', |
| 264 | 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED'], |
Gilles Peskine | 584c24a | 2019-01-29 19:30:40 +0100 | [diff] [blame] | 265 | 'MBEDTLS_SHA256_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED', |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 266 | 'MBEDTLS_ENTROPY_FORCE_SHA256', |
| 267 | 'MBEDTLS_SHA224_C', |
| 268 | 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT', |
Andrzej Kurek | 22b959d | 2022-10-16 12:51:41 -0400 | [diff] [blame] | 269 | 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY', |
| 270 | 'MBEDTLS_LMS_C', |
| 271 | 'MBEDTLS_LMS_PRIVATE'], |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 272 | 'MBEDTLS_SHA512_C': ['MBEDTLS_SHA384_C', |
| 273 | 'MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT', |
| 274 | 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY'], |
| 275 | 'MBEDTLS_SHA224_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED', |
| 276 | 'MBEDTLS_ENTROPY_FORCE_SHA256', |
| 277 | 'MBEDTLS_SHA256_C', |
| 278 | 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT', |
| 279 | 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY'], |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 280 | 'MBEDTLS_X509_RSASSA_PSS_SUPPORT': [] |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 281 | } |
| 282 | |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 283 | # If an option is tested in an exclusive test, alter the following defines. |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 284 | # These are not necessarily dependencies, but just minimal required changes |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 285 | # if a given define is the only one enabled from an exclusive group. |
Andrzej Kurek | 202932f | 2022-10-04 16:22:22 -0400 | [diff] [blame] | 286 | EXCLUSIVE_GROUPS = { |
Andrzej Kurek | 65b2ac1 | 2022-10-14 08:09:16 -0400 | [diff] [blame] | 287 | 'MBEDTLS_SHA256_C': ['+MBEDTLS_SHA224_C'], |
| 288 | 'MBEDTLS_SHA384_C': ['+MBEDTLS_SHA512_C'], |
| 289 | 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_COOKIE_C', |
| 290 | '-MBEDTLS_SSL_PROTO_TLS1_3'], |
| 291 | 'MBEDTLS_ECP_DP_CURVE448_ENABLED': ['-MBEDTLS_ECDSA_C', |
| 292 | '-MBEDTLS_ECDSA_DETERMINISTIC', |
| 293 | '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED', |
| 294 | '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED', |
| 295 | '-MBEDTLS_ECJPAKE_C', |
| 296 | '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'], |
| 297 | 'MBEDTLS_ECP_DP_CURVE25519_ENABLED': ['-MBEDTLS_ECDSA_C', |
| 298 | '-MBEDTLS_ECDSA_DETERMINISTIC', |
| 299 | '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED', |
| 300 | '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED', |
| 301 | '-MBEDTLS_ECJPAKE_C', |
| 302 | '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'], |
| 303 | 'MBEDTLS_ARIA_C': ['-MBEDTLS_CMAC_C'], |
| 304 | 'MBEDTLS_CAMELLIA_C': ['-MBEDTLS_CMAC_C'], |
| 305 | 'MBEDTLS_CHACHA20_C': ['-MBEDTLS_CMAC_C', '-MBEDTLS_CCM_C', '-MBEDTLS_GCM_C'], |
| 306 | 'MBEDTLS_DES_C': ['-MBEDTLS_CCM_C', |
| 307 | '-MBEDTLS_GCM_C', |
| 308 | '-MBEDTLS_SSL_TICKET_C', |
| 309 | '-MBEDTLS_SSL_CONTEXT_SERIALIZATION'], |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 310 | } |
| 311 | def handle_exclusive_groups(config_settings, symbol): |
| 312 | """For every symbol tested in an exclusive group check if there are other |
| 313 | defines to be altered. """ |
Andrzej Kurek | 202932f | 2022-10-04 16:22:22 -0400 | [diff] [blame] | 314 | for dep in EXCLUSIVE_GROUPS.get(symbol, []): |
Andrzej Kurek | 65b2ac1 | 2022-10-14 08:09:16 -0400 | [diff] [blame] | 315 | unset = dep.startswith('-') |
| 316 | dep = dep[1:] |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 317 | config_settings[dep] = not unset |
| 318 | |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 319 | def turn_off_dependencies(config_settings): |
| 320 | """For every option turned off config_settings, also turn off what depends on it. |
| 321 | An option O is turned off if config_settings[O] is False.""" |
| 322 | for key, value in sorted(config_settings.items()): |
| 323 | if value is not False: |
| 324 | continue |
Andrzej Kurek | 202932f | 2022-10-04 16:22:22 -0400 | [diff] [blame] | 325 | for dep in REVERSE_DEPENDENCIES.get(key, []): |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 326 | config_settings[dep] = False |
| 327 | |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 328 | class BaseDomain: # pylint: disable=too-few-public-methods, unused-argument |
| 329 | """A base class for all domains.""" |
| 330 | def __init__(self, symbols, commands, exclude): |
| 331 | """Initialize the jobs container""" |
| 332 | self.jobs = [] |
| 333 | |
| 334 | class ExclusiveDomain(BaseDomain): # pylint: disable=too-few-public-methods |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 335 | """A domain consisting of a set of conceptually-equivalent settings. |
| 336 | Establish a list of configuration symbols. For each symbol, run a test job |
Andrzej Kurek | fe46949 | 2022-10-06 16:57:38 -0400 | [diff] [blame] | 337 | with this symbol set and the others unset.""" |
Gilles Peskine | b1284cf | 2019-01-29 18:56:03 +0100 | [diff] [blame] | 338 | def __init__(self, symbols, commands, exclude=None): |
| 339 | """Build a domain for the specified list of configuration symbols. |
Andrzej Kurek | fe46949 | 2022-10-06 16:57:38 -0400 | [diff] [blame] | 340 | The domain contains a set of jobs that enable one of the elements |
| 341 | of symbols and disable the others. |
Gilles Peskine | b1284cf | 2019-01-29 18:56:03 +0100 | [diff] [blame] | 342 | Each job runs the specified commands. |
| 343 | If exclude is a regular expression, skip generated jobs whose description |
| 344 | would match this regular expression.""" |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 345 | super().__init__(symbols, commands, exclude) |
Andrzej Kurek | fe46949 | 2022-10-06 16:57:38 -0400 | [diff] [blame] | 346 | base_config_settings = {} |
| 347 | for symbol in symbols: |
| 348 | base_config_settings[symbol] = False |
| 349 | for symbol in symbols: |
| 350 | description = symbol |
| 351 | if exclude and re.match(exclude, description): |
| 352 | continue |
| 353 | config_settings = base_config_settings.copy() |
| 354 | config_settings[symbol] = True |
| 355 | handle_exclusive_groups(config_settings, symbol) |
| 356 | turn_off_dependencies(config_settings) |
| 357 | job = Job(description, config_settings, commands) |
| 358 | self.jobs.append(job) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 359 | |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 360 | class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 361 | """A domain consisting of a set of loosely-related settings. |
| 362 | Establish a list of configuration symbols. For each symbol, run a test job |
Andrzej Kurek | a0cb4fa | 2022-10-14 07:06:43 -0400 | [diff] [blame] | 363 | with this symbol unset. |
| 364 | If exclude is a regular expression, skip generated jobs whose description |
| 365 | would match this regular expression.""" |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 366 | def __init__(self, symbols, commands, exclude=None): |
Gilles Peskine | b1284cf | 2019-01-29 18:56:03 +0100 | [diff] [blame] | 367 | """Build a domain for the specified list of configuration symbols. |
| 368 | Each job in the domain disables one of the specified symbols. |
| 369 | Each job runs the specified commands.""" |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 370 | super().__init__(symbols, commands, exclude) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 371 | for symbol in symbols: |
| 372 | description = '!' + symbol |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 373 | if exclude and re.match(exclude, description): |
| 374 | continue |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 375 | config_settings = {symbol: False} |
| 376 | turn_off_dependencies(config_settings) |
| 377 | job = Job(description, config_settings, commands) |
| 378 | self.jobs.append(job) |
| 379 | |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 380 | class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods |
Andrzej Kurek | a0cb4fa | 2022-10-14 07:06:43 -0400 | [diff] [blame] | 381 | """A domain that contains both the ExclusiveDomain and BaseDomain tests. |
Andrzej Kurek | f4b1867 | 2022-10-14 07:57:00 -0400 | [diff] [blame] | 382 | Both parent class __init__ calls are performed in any order and |
Andrzej Kurek | a0cb4fa | 2022-10-14 07:06:43 -0400 | [diff] [blame] | 383 | each call adds respective jobs. The job array initialization is done once in |
| 384 | BaseDomain, before the parent __init__ calls.""" |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 385 | |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 386 | class CipherInfo: # pylint: disable=too-few-public-methods |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 387 | """Collect data about cipher.h.""" |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 388 | def __init__(self): |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 389 | self.base_symbols = set() |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 390 | with open('include/mbedtls/cipher.h', encoding="utf-8") as fh: |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 391 | for line in fh: |
| 392 | m = re.match(r' *MBEDTLS_CIPHER_ID_(\w+),', line) |
| 393 | if m and m.group(1) not in ['NONE', 'NULL', '3DES']: |
| 394 | self.base_symbols.add('MBEDTLS_' + m.group(1) + '_C') |
| 395 | |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 396 | class DomainData: |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 397 | """A container for domains and jobs, used to structurize testing.""" |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 398 | def config_symbols_matching(self, regexp): |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 399 | """List the mbedtls_config.h settings matching regexp.""" |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 400 | return [symbol for symbol in self.all_config_symbols |
| 401 | if re.match(regexp, symbol)] |
| 402 | |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 403 | def __init__(self, options, conf): |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 404 | """Gather data about the library and establish a list of domains to test.""" |
| 405 | build_command = [options.make_command, 'CFLAGS=-Werror'] |
| 406 | build_and_test = [build_command, [options.make_command, 'test']] |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 407 | self.all_config_symbols = set(conf.settings.keys()) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 408 | # Find hash modules by name. |
| 409 | hash_symbols = self.config_symbols_matching(r'MBEDTLS_(MD|RIPEMD|SHA)[0-9]+_C\Z') |
| 410 | # Find elliptic curve enabling macros by name. |
| 411 | curve_symbols = self.config_symbols_matching(r'MBEDTLS_ECP_DP_\w+_ENABLED\Z') |
| 412 | # Find key exchange enabling macros by name. |
| 413 | key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z') |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 414 | # Find cipher IDs (block permutations and stream ciphers --- chaining |
| 415 | # and padding modes are exercised separately) information by parsing |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 416 | # cipher.h, as the information is not readily available in mbedtls_config.h. |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 417 | cipher_info = CipherInfo() |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 418 | # Find block cipher chaining and padding mode enabling macros by name. |
| 419 | cipher_chaining_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_MODE_\w+\Z') |
| 420 | cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z') |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 421 | self.domains = { |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 422 | # Cipher IDs, chaining modes and padding modes. Run the test suites. |
| 423 | 'cipher_id': ExclusiveDomain(cipher_info.base_symbols, |
| 424 | build_and_test), |
| 425 | 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols, |
| 426 | build_and_test), |
| 427 | 'cipher_padding': ExclusiveDomain(cipher_padding_symbols, |
| 428 | build_and_test), |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 429 | # Elliptic curves. Run the test suites. |
| 430 | 'curves': ExclusiveDomain(curve_symbols, build_and_test), |
Andrzej Kurek | a0cb4fa | 2022-10-14 07:06:43 -0400 | [diff] [blame] | 431 | # Hash algorithms. Exclude three groups: |
| 432 | # - Exclusive domain of MD, RIPEMD, SHA1 (obsolete); |
| 433 | # - Exclusive domain of SHA224 (tested with and depends on SHA256); |
| 434 | # - Complementary domain of SHA224 and SHA384 - tested with and depend |
| 435 | # on SHA256 and SHA512, respectively. |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 436 | 'hashes': DualDomain(hash_symbols, build_and_test, |
Andrzej Kurek | a0cb4fa | 2022-10-14 07:06:43 -0400 | [diff] [blame] | 437 | exclude=r'MBEDTLS_(MD|RIPEMD|SHA1_)' \ |
| 438 | '|MBEDTLS_SHA224_'\ |
| 439 | '|!MBEDTLS_(SHA224_|SHA384_)'), |
Gilles Peskine | c3b4dee | 2019-01-29 19:33:05 +0100 | [diff] [blame] | 440 | # Key exchange types. Only build the library and the sample |
| 441 | # programs. |
| 442 | 'kex': ExclusiveDomain(key_exchange_symbols, |
| 443 | [build_command + ['lib'], |
| 444 | build_command + ['-C', 'programs']]), |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 445 | '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. |
| 460 | A 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 Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 466 | def run(options, job, conf, colors=NO_COLORS): |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 467 | """Run the specified job (a Job instance).""" |
| 468 | subprocess.check_call([options.make_command, 'clean']) |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 469 | job.announce(colors, None) |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 470 | if not job.configure(conf, options, colors): |
| 471 | job.announce(colors, False) |
| 472 | return False |
| 473 | conf.write() |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 474 | success = job.test(options) |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 475 | job.announce(colors, success) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 476 | return success |
| 477 | |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 478 | def run_tests(options, domain_data, conf): |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 479 | """Run the desired jobs. |
| 480 | domain_data should be a DomainData instance that describes the available |
| 481 | domains and jobs. |
Andrzej Kurek | b8a97e7 | 2022-10-17 08:39:09 -0400 | [diff] [blame] | 482 | Run the jobs listed in options.tasks.""" |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 483 | if not hasattr(options, 'config_backup'): |
| 484 | options.config_backup = options.config + '.bak' |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 485 | colors = Colors(options) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 486 | jobs = [] |
| 487 | failures = [] |
| 488 | successes = [] |
Andrzej Kurek | b8a97e7 | 2022-10-17 08:39:09 -0400 | [diff] [blame] | 489 | for name in options.tasks: |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 490 | jobs += domain_data.get_jobs(name) |
| 491 | backup_config(options) |
| 492 | try: |
| 493 | for job in jobs: |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 494 | success = run(options, job, conf, colors=colors) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 495 | 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 Peskine | bf7537d | 2019-01-29 18:52:16 +0100 | [diff] [blame] | 502 | 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 Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 507 | if options.keep_going: |
Gilles Peskine | bf7537d | 2019-01-29 18:52:16 +0100 | [diff] [blame] | 508 | restore_config(options) |
| 509 | raise |
Gilles Peskine | e85163b | 2019-01-29 18:50:03 +0100 | [diff] [blame] | 510 | if successes: |
| 511 | log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 512 | if failures: |
Gilles Peskine | e85163b | 2019-01-29 18:50:03 +0100 | [diff] [blame] | 513 | log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 514 | return False |
| 515 | else: |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 516 | return True |
| 517 | |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 518 | def main(): |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 519 | try: |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 520 | 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 Kurek | 629c412 | 2022-10-17 08:34:40 -0400 | [diff] [blame] | 525 | r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA256_C""\n" |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 526 | "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n" |
| 527 | "./tests/scripts/depends.py cipher_id cipher_chaining\n") |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 528 | parser.add_argument('--color', metavar='WHEN', |
| 529 | help='Colorize the output (always/auto/never)', |
| 530 | choices=['always', 'auto', 'never'], default='auto') |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 531 | parser.add_argument('-c', '--config', metavar='FILE', |
| 532 | help='Configuration file to modify', |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 533 | default='include/mbedtls/mbedtls_config.h') |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 534 | 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 Kurek | 2c7993c | 2022-10-24 10:41:20 -0400 | [diff] [blame] | 552 | 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 Kurek | b8a97e7 | 2022-10-17 08:39:09 -0400 | [diff] [blame] | 555 | parser.add_argument('tasks', metavar='TASKS', nargs='*', |
| 556 | help='The domain(s) or job(s) to test (default: all).', |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 557 | default=True) |
| 558 | options = parser.parse_args() |
| 559 | os.chdir(options.directory) |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 560 | conf = config.ConfigFile(options.config) |
| 561 | domain_data = DomainData(options, conf) |
| 562 | |
Andrzej Kurek | b8a97e7 | 2022-10-17 08:39:09 -0400 | [diff] [blame] | 563 | if options.tasks is True: |
| 564 | options.tasks = sorted(domain_data.domains.keys()) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 565 | if options.list: |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 566 | 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 Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 570 | else: |
Andrzej Kurek | 3f93012 | 2022-10-26 08:08:26 -0400 | [diff] [blame] | 571 | sys.exit(0 if run_tests(options, domain_data, conf) else 1) |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 572 | except Exception: # pylint: disable=broad-except |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 573 | traceback.print_exc() |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 574 | sys.exit(3) |
| 575 | |
| 576 | if __name__ == '__main__': |
| 577 | main() |