1#!/usr/bin/env perl 2 3# depends-hashes.pl 4# 5# Copyright The Mbed TLS Contributors 6# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later 7# 8# This file is provided under the Apache License 2.0, or the 9# GNU General Public License v2.0 or later. 10# 11# ********** 12# Apache License 2.0: 13# 14# Licensed under the Apache License, Version 2.0 (the "License"); you may 15# not use this file except in compliance with the License. 16# You may obtain a copy of the License at 17# 18# http://www.apache.org/licenses/LICENSE-2.0 19# 20# Unless required by applicable law or agreed to in writing, software 21# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 22# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 23# See the License for the specific language governing permissions and 24# limitations under the License. 25# 26# ********** 27# 28# ********** 29# GNU General Public License v2.0 or later: 30# 31# This program is free software; you can redistribute it and/or modify 32# it under the terms of the GNU General Public License as published by 33# the Free Software Foundation; either version 2 of the License, or 34# (at your option) any later version. 35# 36# This program is distributed in the hope that it will be useful, 37# but WITHOUT ANY WARRANTY; without even the implied warranty of 38# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 39# GNU General Public License for more details. 40# 41# You should have received a copy of the GNU General Public License along 42# with this program; if not, write to the Free Software Foundation, Inc., 43# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 44# 45# ********** 46# 47# Purpose 48# 49# To test the code dependencies on individual hashes in each test suite. This 50# is a verification step to ensure we don't ship test suites that do not work 51# for some build options. 52# 53# The process is: 54# for each possible hash 55# build the library and test suites with the hash disabled 56# execute the test suites 57# 58# And any test suite with the wrong dependencies will fail. 59# 60# Usage: tests/scripts/depends-hashes.pl 61# 62# This script should be executed from the root of the project directory. 63# 64# For best effect, run either with cmake disabled, or cmake enabled in a mode 65# that includes -Werror. 66 67use warnings; 68use strict; 69 70-d 'library' && -d 'include' && -d 'tests' or die "Must be run from root\n"; 71 72my $config_h = 'include/mbedtls/config.h'; 73 74# as many SSL options depend on specific hashes, 75# and SSL is not in the test suites anyways, 76# disable it to avoid dependcies issues 77my $ssl_sed_cmd = 's/^#define \(MBEDTLS_SSL.*\)/\1/p'; 78my @ssl = split( /\s+/, `sed -n -e '$ssl_sed_cmd' $config_h` ); 79 80# for md we want to catch MD5_C but not MD_C, hence the extra dot 81my $mdx_sed_cmd = 's/^#define \(MBEDTLS_MD..*_C\)/\1/p'; 82my $sha_sed_cmd = 's/^#define \(MBEDTLS_SHA.*_C\)/\1/p'; 83my @hashes = split( /\s+/, 84 `sed -n -e '$mdx_sed_cmd' -e '$sha_sed_cmd' $config_h` ); 85system( "cp $config_h $config_h.bak" ) and die; 86sub abort { 87 system( "mv $config_h.bak $config_h" ) and warn "$config_h not restored\n"; 88 # use an exit code between 1 and 124 for git bisect (die returns 255) 89 warn $_[0]; 90 exit 1; 91} 92 93for my $hash (@hashes) { 94 system( "cp $config_h.bak $config_h" ) and die "$config_h not restored\n"; 95 system( "make clean" ) and die; 96 97 print "\n******************************************\n"; 98 print "* Testing without hash: $hash\n"; 99 print "******************************************\n"; 100 101 system( "scripts/config.pl unset $hash" ) 102 and abort "Failed to disable $hash\n"; 103 104 for my $opt (@ssl) { 105 system( "scripts/config.pl unset $opt" ) 106 and abort "Failed to disable $opt\n"; 107 } 108 109 system( "CFLAGS='-Werror -Wall -Wextra' make lib" ) 110 and abort "Failed to build lib: $hash\n"; 111 system( "cd tests && make" ) and abort "Failed to build tests: $hash\n"; 112 system( "make test" ) and abort "Failed test suite: $hash\n"; 113} 114 115system( "mv $config_h.bak $config_h" ) and die "$config_h not restored\n"; 116system( "make clean" ) and die; 117exit 0; 118