From ef83b839d0902be6c3e6d03fe038b42519459188 Mon Sep 17 00:00:00 2001 From: Tom Cosgrove Date: Mon, 25 Jul 2022 11:42:38 +0100 Subject: [PATCH 1/4] Tidy up generate_query_config.pl in preparation for further work Output is unchanged. Signed-off-by: Tom Cosgrove --- scripts/generate_query_config.pl | 60 +++++++++++++++++++------------- 1 file changed, 35 insertions(+), 25 deletions(-) diff --git a/scripts/generate_query_config.pl b/scripts/generate_query_config.pl index b2ce8fc4c..a6bc3da99 100755 --- a/scripts/generate_query_config.pl +++ b/scripts/generate_query_config.pl @@ -15,7 +15,7 @@ # function by using the template in scripts/data_files/query_config.fmt. # # Usage: scripts/generate_query_config.pl without arguments, or -# generate_query_config.pl config_file template_file output_file +# generate_query_config.pl mbedtls_config_file template_file output_file # # Copyright The Mbed TLS Contributors # SPDX-License-Identifier: Apache-2.0 @@ -34,22 +34,26 @@ use strict; -my ($config_file, $query_config_format_file, $query_config_file); +my ($mbedtls_config_file, $query_config_format_file, $query_config_file); + +my $default_mbedtls_config_file = "./include/mbedtls/mbedtls_config.h"; +my $default_query_config_format_file = "./scripts/data_files/query_config.fmt"; +my $default_query_config_file = "./programs/test/query_config.c"; if( @ARGV ) { die "Invalid number of arguments - usage: $0 [CONFIG_FILE TEMPLATE_FILE OUTPUT_FILE]" if scalar @ARGV != 3; - ($config_file, $query_config_format_file, $query_config_file) = @ARGV; + ($mbedtls_config_file, $query_config_format_file, $query_config_file) = @ARGV; - -f $config_file or die "No such file: $config_file"; + -f $mbedtls_config_file or die "No such file: $mbedtls_config_file"; -f $query_config_format_file or die "No such file: $query_config_format_file"; } else { - $config_file = "./include/mbedtls/mbedtls_config.h"; - $query_config_format_file = "./scripts/data_files/query_config.fmt"; - $query_config_file = "./programs/test/query_config.c"; + $mbedtls_config_file = $default_mbedtls_config_file; + $query_config_format_file = $default_query_config_format_file; + $query_config_file = $default_query_config_file; - unless( -f $config_file && -f $query_config_format_file ) { + unless( -f $mbedtls_config_file && -f $query_config_format_file ) { chdir '..' or die; - -f $config_file && -f $query_config_format_file + -f $mbedtls_config_file && -f $query_config_format_file or die "No arguments supplied, must be run from project root or a first-level subdirectory\n"; } } @@ -63,13 +67,13 @@ MBEDTLS_SSL_CIPHERSUITES ); my $excluded_re = join '|', @excluded; -open(CONFIG_FILE, "$config_file") or die "Opening config file '$config_file': $!"; - # This variable will contain the string to replace in the CHECK_CONFIG of the # format file my $config_check = ""; my $list_config = ""; +open(CONFIG_FILE, "<", $mbedtls_config_file) or die "Opening config file '$mbedtls_config_file': $!"; + while (my $line = ) { if ($line =~ /^(\/\/)?\s*#\s*define\s+(MBEDTLS_\w+).*/) { my $name = $2; @@ -77,25 +81,31 @@ while (my $line = ) { # Skip over the macro if it is in the ecluded list next if $name =~ /$excluded_re/; - $config_check .= "#if defined($name)\n"; - $config_check .= " if( strcmp( \"$name\", config ) == 0 )\n"; - $config_check .= " {\n"; - $config_check .= " MACRO_EXPANSION_TO_STR( $name );\n"; - $config_check .= " return( 0 );\n"; - $config_check .= " }\n"; - $config_check .= "#endif /* $name */\n"; - $config_check .= "\n"; + $config_check .= <; close(FORMAT_FILE); @@ -104,6 +114,6 @@ $query_config_format =~ s/CHECK_CONFIG/$config_check/g; $query_config_format =~ s/LIST_CONFIG/$list_config/g; # Rewrite the query_config.c file -open(QUERY_CONFIG_FILE, ">$query_config_file") or die "Opening destination file '$query_config_file': $!"; +open(QUERY_CONFIG_FILE, ">", $query_config_file) or die "Opening destination file '$query_config_file': $!"; print QUERY_CONFIG_FILE $query_config_format; close(QUERY_CONFIG_FILE); From ff3c6c1a1a02fbed0889e5d6bad0ec5a3fa3e400 Mon Sep 17 00:00:00 2001 From: Tom Cosgrove Date: Mon, 25 Jul 2022 12:19:35 +0100 Subject: [PATCH 2/4] Add parsing of psa/crypto_config.h for PSA_WANT_xxx to query_compile_time_config Fixes #6131 Signed-off-by: Tom Cosgrove --- ...-query_compile_time_config-to-psa_want.txt | 2 + scripts/data_files/query_config.fmt | 2 + scripts/generate_query_config.pl | 40 ++++++++++++------- 3 files changed, 30 insertions(+), 14 deletions(-) create mode 100644 ChangeLog.d/extend-query_compile_time_config-to-psa_want.txt diff --git a/ChangeLog.d/extend-query_compile_time_config-to-psa_want.txt b/ChangeLog.d/extend-query_compile_time_config-to-psa_want.txt new file mode 100644 index 000000000..b268fd4f0 --- /dev/null +++ b/ChangeLog.d/extend-query_compile_time_config-to-psa_want.txt @@ -0,0 +1,2 @@ +Changes + * Add the ability to query PSA_WANT_xxx macros to query_compile_time_config diff --git a/scripts/data_files/query_config.fmt b/scripts/data_files/query_config.fmt index fa124f0da..4c892fe51 100644 --- a/scripts/data_files/query_config.fmt +++ b/scripts/data_files/query_config.fmt @@ -90,6 +90,8 @@ #include "mbedtls/x509_crt.h" #include "mbedtls/x509_csr.h" +#include "psa/crypto_config.h" + #include /* diff --git a/scripts/generate_query_config.pl b/scripts/generate_query_config.pl index a6bc3da99..6e9896594 100755 --- a/scripts/generate_query_config.pl +++ b/scripts/generate_query_config.pl @@ -15,7 +15,7 @@ # function by using the template in scripts/data_files/query_config.fmt. # # Usage: scripts/generate_query_config.pl without arguments, or -# generate_query_config.pl mbedtls_config_file template_file output_file +# generate_query_config.pl mbedtls_config_file template_file output_file [psa_crypto_config_file] # # Copyright The Mbed TLS Contributors # SPDX-License-Identifier: Apache-2.0 @@ -34,11 +34,12 @@ use strict; -my ($mbedtls_config_file, $query_config_format_file, $query_config_file); +my ($mbedtls_config_file, $query_config_format_file, $query_config_file, $psa_crypto_config_file); my $default_mbedtls_config_file = "./include/mbedtls/mbedtls_config.h"; my $default_query_config_format_file = "./scripts/data_files/query_config.fmt"; my $default_query_config_file = "./programs/test/query_config.c"; +my $default_psa_crypto_config_file = "./include/psa/crypto_config.h"; if( @ARGV ) { die "Invalid number of arguments - usage: $0 [CONFIG_FILE TEMPLATE_FILE OUTPUT_FILE]" if scalar @ARGV != 3; @@ -46,14 +47,20 @@ if( @ARGV ) { -f $mbedtls_config_file or die "No such file: $mbedtls_config_file"; -f $query_config_format_file or die "No such file: $query_config_format_file"; + if (defined($psa_crypto_config_file) && length($psa_crypto_config_file)) { + -f $psa_crypto_config_file or die "No such file: $psa_crypto_config_file"; + } else { + $psa_crypto_config_file = (-d $default_psa_crypto_config_file) ? $default_psa_crypto_config_file : undef; + } } else { $mbedtls_config_file = $default_mbedtls_config_file; $query_config_format_file = $default_query_config_format_file; $query_config_file = $default_query_config_file; + $psa_crypto_config_file = $default_psa_crypto_config_file; - unless( -f $mbedtls_config_file && -f $query_config_format_file ) { + unless(-f $mbedtls_config_file && -f $query_config_format_file && -f $psa_crypto_config_file) { chdir '..' or die; - -f $mbedtls_config_file && -f $query_config_format_file + -f $mbedtls_config_file && -f $query_config_format_file && -f $psa_crypto_config_file or die "No arguments supplied, must be run from project root or a first-level subdirectory\n"; } } @@ -72,16 +79,20 @@ my $excluded_re = join '|', @excluded; my $config_check = ""; my $list_config = ""; -open(CONFIG_FILE, "<", $mbedtls_config_file) or die "Opening config file '$mbedtls_config_file': $!"; +for my $config_file ($mbedtls_config_file, $psa_crypto_config_file) { -while (my $line = ) { - if ($line =~ /^(\/\/)?\s*#\s*define\s+(MBEDTLS_\w+).*/) { - my $name = $2; + next unless defined($config_file); # we might not have been given a PSA crypto config file - # Skip over the macro if it is in the ecluded list - next if $name =~ /$excluded_re/; + open(CONFIG_FILE, "<", $config_file) or die "Opening config file '$config_file': $!"; - $config_check .= <) { + if ($line =~ /^(\/\/)?\s*#\s*define\s+(MBEDTLS_\w+|PSA_WANT_\w+).*/) { + my $name = $2; + + # Skip over the macro if it is in the ecluded list + next if $name =~ /$excluded_re/; + + $config_check .= <) { EOT - $list_config .= < Date: Tue, 26 Jul 2022 11:54:08 +0100 Subject: [PATCH 3/4] Correctly include psa/crypto.h in query_config.fmt Signed-off-by: Tom Cosgrove --- scripts/data_files/query_config.fmt | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/scripts/data_files/query_config.fmt b/scripts/data_files/query_config.fmt index 4c892fe51..59eb16897 100644 --- a/scripts/data_files/query_config.fmt +++ b/scripts/data_files/query_config.fmt @@ -30,8 +30,12 @@ /* * Include all the headers with public APIs in case they define a macro to its - * default value when that configuration is not set in the mbedtls_config.h. + * default value when that configuration is not set in mbedtls_config.h, or + * for PSA_WANT macros, in case they're auto-defined based on mbedtls_config.h + * rather than defined directly in crypto_config.h. */ +#include "psa/crypto.h" + #include "mbedtls/aes.h" #include "mbedtls/aria.h" #include "mbedtls/asn1.h" @@ -90,8 +94,6 @@ #include "mbedtls/x509_crt.h" #include "mbedtls/x509_csr.h" -#include "psa/crypto_config.h" - #include /* From 5900c1d4058f269354127a78de746533a17734ab Mon Sep 17 00:00:00 2001 From: Tom Cosgrove Date: Wed, 27 Jul 2022 08:55:03 +0100 Subject: [PATCH 4/4] Fix stupid mistake (s/-d/-f/) and typo found by mpg review - thanks Signed-off-by: Tom Cosgrove --- scripts/generate_query_config.pl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/generate_query_config.pl b/scripts/generate_query_config.pl index 6e9896594..ddbebfa44 100755 --- a/scripts/generate_query_config.pl +++ b/scripts/generate_query_config.pl @@ -50,7 +50,7 @@ if( @ARGV ) { if (defined($psa_crypto_config_file) && length($psa_crypto_config_file)) { -f $psa_crypto_config_file or die "No such file: $psa_crypto_config_file"; } else { - $psa_crypto_config_file = (-d $default_psa_crypto_config_file) ? $default_psa_crypto_config_file : undef; + $psa_crypto_config_file = (-f $default_psa_crypto_config_file) ? $default_psa_crypto_config_file : undef; } } else { $mbedtls_config_file = $default_mbedtls_config_file; @@ -89,7 +89,7 @@ for my $config_file ($mbedtls_config_file, $psa_crypto_config_file) { if ($line =~ /^(\/\/)?\s*#\s*define\s+(MBEDTLS_\w+|PSA_WANT_\w+).*/) { my $name = $2; - # Skip over the macro if it is in the ecluded list + # Skip over the macro if it is in the excluded list next if $name =~ /$excluded_re/; $config_check .= <