1#!/usr/bin/env perl 2 3# depends-pkalgs.pl 4# 5# Copyright The Mbed TLS Contributors 6# SPDX-License-Identifier: Apache-2.0 7# 8# Licensed under the Apache License, Version 2.0 (the "License"); you may 9# not use this file except in compliance with the License. 10# You may obtain a copy of the License at 11# 12# http://www.apache.org/licenses/LICENSE-2.0 13# 14# Unless required by applicable law or agreed to in writing, software 15# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 16# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 17# See the License for the specific language governing permissions and 18# limitations under the License. 19# 20# Purpose 21# 22# To test the code dependencies on individual PK algs (those that can be used 23# from the PK layer, so currently signature and encryption but not key 24# exchange) in each test suite. This is a verification step to ensure we don't 25# ship test suites that do not work for some build options. 26# 27# The process is: 28# for each possible PK alg 29# build the library and test suites with that alg disabled 30# execute the test suites 31# 32# And any test suite with the wrong dependencies will fail. 33# 34# Usage: tests/scripts/depends-pkalgs.pl 35# 36# This script should be executed from the root of the project directory. 37# 38# For best effect, run either with cmake disabled, or cmake enabled in a mode 39# that includes -Werror. 40 41use warnings; 42use strict; 43 44-d 'library' && -d 'include' && -d 'tests' or die "Must be run from root\n"; 45 46my $config_h = 'include/mbedtls/mbedtls_config.h'; 47 48# Some algorithms can't be disabled on their own as others depend on them, so 49# we list those reverse-dependencies here to keep check_config.h happy. 50my %algs = ( 51 'MBEDTLS_ECDSA_C' => ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED', 52 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'], 53 'MBEDTLS_ECP_C' => ['MBEDTLS_ECDSA_C', 54 'MBEDTLS_ECDH_C', 55 'MBEDTLS_ECJPAKE_C', 56 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED', 57 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED', 58 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED', 59 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED', 60 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED'], 61 'MBEDTLS_X509_RSASSA_PSS_SUPPORT' => [], 62 'MBEDTLS_PKCS1_V21' => ['MBEDTLS_X509_RSASSA_PSS_SUPPORT'], 63 'MBEDTLS_PKCS1_V15' => ['MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED', 64 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED', 65 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED', 66 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'], 67 'MBEDTLS_RSA_C' => ['MBEDTLS_X509_RSASSA_PSS_SUPPORT', 68 'MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED', 69 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED', 70 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED', 71 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED', 72 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'], 73); 74 75system( "cp $config_h $config_h.bak" ) and die; 76sub abort { 77 system( "mv $config_h.bak $config_h" ) and warn "$config_h not restored\n"; 78 # use an exit code between 1 and 124 for git bisect (die returns 255) 79 warn $_[0]; 80 exit 1; 81} 82 83while( my ($alg, $extras) = each %algs ) { 84 system( "cp $config_h.bak $config_h" ) and die "$config_h not restored\n"; 85 system( "make clean" ) and die; 86 87 print "\n******************************************\n"; 88 print "* Testing without alg: $alg\n"; 89 print "******************************************\n"; 90 $ENV{MBEDTLS_TEST_CONFIGURATION} = "-$alg"; 91 92 system( "scripts/config.py unset $alg" ) 93 and abort "Failed to disable $alg\n"; 94 for my $opt (@$extras) { 95 system( "scripts/config.py unset $opt" ) 96 and abort "Failed to disable $opt\n"; 97 } 98 99 system( "CFLAGS='-Werror -Wall -Wextra' make lib" ) 100 and abort "Failed to build lib: $alg\n"; 101 system( "cd tests && make" ) and abort "Failed to build tests: $alg\n"; 102 system( "make test" ) and abort "Failed test suite: $alg\n"; 103} 104 105system( "mv $config_h.bak $config_h" ) and die "$config_h not restored\n"; 106system( "make clean" ) and die; 107exit 0; 108