4ae869139a
Adds 'get' command to indicate if the option is enabled in the given configuration file, and to returns it's value if one has been set.
246 lines
7.2 KiB
Perl
Executable file
246 lines
7.2 KiB
Perl
Executable file
#!/usr/bin/perl
|
|
#
|
|
# This file is part of mbed TLS (https://tls.mbed.org)
|
|
#
|
|
# Copyright (c) 2014-2016, ARM Limited, All Rights Reserved
|
|
#
|
|
# Purpose
|
|
#
|
|
# Comments and uncomments #define lines in the given header file and optionally
|
|
# sets their value or can get the value. This is to provide scripting control of
|
|
# what preprocessor symbols, and therefore what build time configuration flags
|
|
# are set in the 'config.h' file.
|
|
#
|
|
# Usage: config.pl [-f <file> | --file <file>] [-o | --force]
|
|
# [set <symbol> <value> | unset <symbol> | get <symbol> |
|
|
# full | realfull]
|
|
#
|
|
# Full usage description provided below.
|
|
#
|
|
# Things that shouldn't be enabled with "full".
|
|
#
|
|
# MBEDTLS_TEST_NULL_ENTROPY
|
|
# MBEDTLS_DEPRECATED_REMOVED
|
|
# MBEDTLS_HAVE_SSE2
|
|
# MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
|
|
# MBEDTLS_ECP_DP_M221_ENABLED
|
|
# MBEDTLS_ECP_DP_M383_ENABLED
|
|
# MBEDTLS_ECP_DP_M511_ENABLED
|
|
# MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
|
|
# MBEDTLS_NO_PLATFORM_ENTROPY
|
|
# MBEDTLS_REMOVE_ARC4_CIPHERSUITES
|
|
# MBEDTLS_SSL_HW_RECORD_ACCEL
|
|
# MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
|
|
# MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
|
|
# - this could be enabled if the respective tests were adapted
|
|
# MBEDTLS_ZLIB_SUPPORT
|
|
# MBEDTLS_PKCS11_C
|
|
# and any symbol beginning _ALT
|
|
#
|
|
|
|
use warnings;
|
|
use strict;
|
|
|
|
my $config_file = "include/mbedtls/config.h";
|
|
my $usage = <<EOU;
|
|
$0 [-f <file> | --file <file>] [-o | --force]
|
|
[set <symbol> <value> | unset <symbol> | get <symbol> |
|
|
full | realfull]
|
|
|
|
Commands
|
|
set <symbol> [<value>] - Uncomments or adds a #define for the <symbol> to
|
|
the configuration file, and optionally making it
|
|
of <value>.
|
|
If the symbol isn't present in the file an error
|
|
is returned.
|
|
unset <symbol> - Comments out the #define for the given symbol if
|
|
present in the configuration file.
|
|
get <symbol> - Finds the #define for the given symbol, returning
|
|
an exitcode of 0 if the symbol is found, and -1 if
|
|
not. The value of the symbol is output if one is
|
|
specified in the configuration file.
|
|
full - Uncomments all #define's in the configuration file
|
|
excluding some reserved symbols, until the
|
|
'Module configuration options' section
|
|
realfull - Uncomments all #define's with no exclusions
|
|
|
|
Options
|
|
-f | --file <filename> - The file or file path for the configuration file
|
|
to edit. When omitted, the following default is
|
|
used:
|
|
$config_file
|
|
-o | --force - If the symbol isn't present in the configuration
|
|
file when setting it's value, a #define is
|
|
appended to the end of the file.
|
|
|
|
EOU
|
|
|
|
my @excluded = qw(
|
|
MBEDTLS_TEST_NULL_ENTROPY
|
|
MBEDTLS_DEPRECATED_REMOVED
|
|
MBEDTLS_HAVE_SSE2
|
|
MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
|
|
MBEDTLS_ECP_DP_M221_ENABLED
|
|
MBEDTLS_ECP_DP_M383_ENABLED
|
|
MBEDTLS_ECP_DP_M511_ENABLED
|
|
MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
|
|
MBEDTLS_NO_PLATFORM_ENTROPY
|
|
MBEDTLS_REMOVE_ARC4_CIPHERSUITES
|
|
MBEDTLS_SSL_HW_RECORD_ACCEL
|
|
MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
|
|
MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
|
|
MBEDTLS_ZLIB_SUPPORT
|
|
MBEDTLS_PKCS11_C
|
|
_ALT\s*$
|
|
);
|
|
|
|
# Things that should be enabled in "full" even if they match @excluded
|
|
my @non_excluded = qw(
|
|
PLATFORM_[A-Z0-9]+_ALT
|
|
);
|
|
|
|
# Process the command line arguments
|
|
|
|
my $force_option = 0;
|
|
|
|
my ($arg, $name, $value, $action);
|
|
|
|
while ($arg = shift) {
|
|
|
|
# Check if the argument is an option
|
|
if ($arg eq "-f" || $arg eq "--file") {
|
|
$config_file = shift;
|
|
|
|
-f $config_file or die "No such file: $config_file\n";
|
|
|
|
}
|
|
elsif ($arg eq "-o" || $arg eq "--force") {
|
|
$force_option = 1;
|
|
|
|
}
|
|
else
|
|
{
|
|
# ...else assume it's a command
|
|
$action = $arg;
|
|
|
|
if ($action eq "full" || $action eq "realfull") {
|
|
# No additional parameters
|
|
die $usage if @ARGV;
|
|
|
|
}
|
|
elsif ($action eq "unset" || $action eq "get") {
|
|
die $usage unless @ARGV;
|
|
$name = shift;
|
|
|
|
}
|
|
elsif ($action eq "set") {
|
|
die $usage unless @ARGV;
|
|
$name = shift;
|
|
$value = shift if @ARGV;
|
|
|
|
}
|
|
else {
|
|
die "Command '$action' not recognised.\n\n".$usage;
|
|
}
|
|
}
|
|
}
|
|
|
|
# Check the config file is present
|
|
if (! -f $config_file) {
|
|
|
|
chdir '..' or die;
|
|
|
|
# Confirm this is the project root directory and try again
|
|
if ( !(-d 'scripts' && -d 'include' && -d 'library' && -f $config_file) ) {
|
|
die "If no file specified, must be run from the project root or scripts directory.\n";
|
|
}
|
|
}
|
|
|
|
|
|
# Now read the file and process the contents
|
|
|
|
open my $config_read, '<', $config_file or die "read $config_file: $!\n";
|
|
my @config_lines = <$config_read>;
|
|
close $config_read;
|
|
|
|
my ($exclude_re, $no_exclude_re);
|
|
if ($action eq "realfull") {
|
|
$exclude_re = qr/^$/;
|
|
$no_exclude_re = qr/./;
|
|
} else {
|
|
$exclude_re = join '|', @excluded;
|
|
$no_exclude_re = join '|', @non_excluded;
|
|
}
|
|
|
|
open my $config_write, '>', $config_file or die "write $config_file: $!\n";
|
|
|
|
my $done;
|
|
for my $line (@config_lines) {
|
|
if ($action eq "full" || $action eq "realfull") {
|
|
if ($line =~ /name SECTION: Module configuration options/) {
|
|
$done = 1;
|
|
}
|
|
|
|
if (!$done && $line =~ m!^//\s?#define! &&
|
|
( $line !~ /$exclude_re/ || $line =~ /$no_exclude_re/ ) ) {
|
|
$line =~ s!^//\s?!!;
|
|
}
|
|
if (!$done && $line =~ m!^\s?#define! &&
|
|
! ( $line !~ /$exclude_re/ || $line =~ /$no_exclude_re/ ) ) {
|
|
$line =~ s!^!//!;
|
|
}
|
|
} elsif ($action eq "unset") {
|
|
if (!$done && $line =~ /^\s*#define\s*$name\b/) {
|
|
$line = '//' . $line;
|
|
$done = 1;
|
|
}
|
|
} elsif (!$done && $action eq "set") {
|
|
if ($line =~ m!^(?://)?\s*#define\s*$name\b!) {
|
|
$line = "#define $name";
|
|
$line .= " $value" if defined $value && $value ne "";
|
|
$line .= "\n";
|
|
$done = 1;
|
|
}
|
|
} elsif (!$done && $action eq "get") {
|
|
if ($line =~ /^\s*#define\s*$name\s*(.*)\s*\b/) {
|
|
$value = $1;
|
|
$done = 1;
|
|
}
|
|
}
|
|
|
|
print $config_write $line;
|
|
}
|
|
|
|
# Did the set command work?
|
|
if ($action eq "set"&& $force_option && !$done) {
|
|
|
|
# If the force option was set, append the symbol to the end of the file
|
|
my $line = "#define $name";
|
|
$line .= " $value" if defined $value && $value ne "";
|
|
$line .= "\n";
|
|
$done = 1;
|
|
|
|
print $config_write $line;
|
|
}
|
|
|
|
close $config_write;
|
|
|
|
if ($action eq "get" && $done) {
|
|
if ($value ne '') {
|
|
print $value;
|
|
}
|
|
exit 0;
|
|
} else {
|
|
exit -1;
|
|
}
|
|
|
|
if ($action eq "full" && !$done) {
|
|
die "Configuration section was not found in $config_file\n";
|
|
|
|
}
|
|
|
|
if ($action ne "full" && $action ne "unset" && !$done) {
|
|
die "A #define for the symbol $name was not found in $config_file\n";
|
|
}
|
|
|
|
__END__
|