blob: 5bf27859a87f3ad43e54d8dfa4804d479d94e98d [file] [log] [blame]
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +02001#!/usr/bin/perl
SimonB60f2cf92016-04-03 14:16:08 +01002#
3# This file is part of mbed TLS (https://tls.mbed.org)
4#
5# Copyright (c) 2014-2016, ARM Limited, All Rights Reserved
6#
7# Purpose
8#
9# Comments and uncomments #define lines in the given header file and optionally
Simon Butcher4ae86912016-06-21 10:09:25 +010010# sets their value or can get the value. This is to provide scripting control of
11# what preprocessor symbols, and therefore what build time configuration flags
12# are set in the 'config.h' file.
SimonB60f2cf92016-04-03 14:16:08 +010013#
14# Usage: config.pl [-f <file> | --file <file>] [-o | --force]
Simon Butcher4ae86912016-06-21 10:09:25 +010015# [set <symbol> <value> | unset <symbol> | get <symbol> |
16# full | realfull]
SimonB60f2cf92016-04-03 14:16:08 +010017#
18# Full usage description provided below.
19#
Hanno Becker7c0f17d2017-09-28 11:49:46 +010020# The following options are disabled instead of enabled with "full".
SimonB60f2cf92016-04-03 14:16:08 +010021#
Simon Butcherab5df402016-06-11 02:31:21 +010022# MBEDTLS_TEST_NULL_ENTROPY
SimonB60f2cf92016-04-03 14:16:08 +010023# MBEDTLS_DEPRECATED_REMOVED
24# MBEDTLS_HAVE_SSE2
25# MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
26# MBEDTLS_ECP_DP_M221_ENABLED
27# MBEDTLS_ECP_DP_M383_ENABLED
28# MBEDTLS_ECP_DP_M511_ENABLED
29# MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
30# MBEDTLS_NO_PLATFORM_ENTROPY
31# MBEDTLS_REMOVE_ARC4_CIPHERSUITES
32# MBEDTLS_SSL_HW_RECORD_ACCEL
Hanno Becker7c0f17d2017-09-28 11:49:46 +010033# MBEDTLS_RSA_NO_CRT
SimonB60f2cf92016-04-03 14:16:08 +010034# MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
35# MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
36# - this could be enabled if the respective tests were adapted
37# MBEDTLS_ZLIB_SUPPORT
38# MBEDTLS_PKCS11_C
39# and any symbol beginning _ALT
40#
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +020041
42use warnings;
43use strict;
44
SimonB60f2cf92016-04-03 14:16:08 +010045my $config_file = "include/mbedtls/config.h";
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +020046my $usage = <<EOU;
SimonB60f2cf92016-04-03 14:16:08 +010047$0 [-f <file> | --file <file>] [-o | --force]
Simon Butcher4ae86912016-06-21 10:09:25 +010048 [set <symbol> <value> | unset <symbol> | get <symbol> |
Azim Khanc3c3a682017-12-21 15:19:53 +000049 full | realfull | baremetal]
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +020050
SimonB60f2cf92016-04-03 14:16:08 +010051Commands
Simon Butcher4ae86912016-06-21 10:09:25 +010052 set <symbol> [<value>] - Uncomments or adds a #define for the <symbol> to
SimonB60f2cf92016-04-03 14:16:08 +010053 the configuration file, and optionally making it
54 of <value>.
55 If the symbol isn't present in the file an error
56 is returned.
Simon Butcher4ae86912016-06-21 10:09:25 +010057 unset <symbol> - Comments out the #define for the given symbol if
58 present in the configuration file.
59 get <symbol> - Finds the #define for the given symbol, returning
Gilles Peskined98e9e82017-10-09 16:56:18 +020060 an exitcode of 0 if the symbol is found, and 1 if
Simon Butcher4ae86912016-06-21 10:09:25 +010061 not. The value of the symbol is output if one is
62 specified in the configuration file.
SimonB60f2cf92016-04-03 14:16:08 +010063 full - Uncomments all #define's in the configuration file
Simon Butcher4ae86912016-06-21 10:09:25 +010064 excluding some reserved symbols, until the
SimonB60f2cf92016-04-03 14:16:08 +010065 'Module configuration options' section
66 realfull - Uncomments all #define's with no exclusions
Azim Khanc3c3a682017-12-21 15:19:53 +000067 baremetal - Sets full configuration suitable for baremetal build.
SimonB60f2cf92016-04-03 14:16:08 +010068
69Options
70 -f | --file <filename> - The file or file path for the configuration file
71 to edit. When omitted, the following default is
72 used:
73 $config_file
74 -o | --force - If the symbol isn't present in the configuration
Brian J Murray2adecba2016-11-06 04:45:15 -080075 file when setting its value, a #define is
SimonB60f2cf92016-04-03 14:16:08 +010076 appended to the end of the file.
77
78EOU
79
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +020080my @excluded = qw(
Simon Butcherab5df402016-06-11 02:31:21 +010081MBEDTLS_TEST_NULL_ENTROPY
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020082MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020083MBEDTLS_HAVE_SSE2
84MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
85MBEDTLS_ECP_DP_M221_ENABLED
86MBEDTLS_ECP_DP_M383_ENABLED
87MBEDTLS_ECP_DP_M511_ENABLED
88MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
89MBEDTLS_NO_PLATFORM_ENTROPY
Hanno Becker7c0f17d2017-09-28 11:49:46 +010090MBEDTLS_RSA_NO_CRT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020091MBEDTLS_REMOVE_ARC4_CIPHERSUITES
92MBEDTLS_SSL_HW_RECORD_ACCEL
93MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
94MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
95MBEDTLS_ZLIB_SUPPORT
96MBEDTLS_PKCS11_C
Azim Khanc4e96942017-12-21 15:22:37 +000097MBEDTLS_NO_UDBL_DIVISION
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +020098_ALT\s*$
99);
100
Azim Khan0d445732017-12-21 09:28:39 +0000101# Things that should be disabled in "baremetal"
102my @excluded_baremetal = qw(
103MBEDTLS_NET_C
104MBEDTLS_TIMING_C
105MBEDTLS_FS_IO
106MBEDTLS_ENTROPY_NV_SEED
107MBEDTLS_HAVE_TIME
108MBEDTLS_HAVE_TIME_DATE
109MBEDTLS_DEPRECATED_WARNING
110MBEDTLS_HAVEGE_C
111MBEDTLS_THREADING_C
112MBEDTLS_THREADING_PTHREAD
113MBEDTLS_MEMORY_BACKTRACE
114MBEDTLS_MEMORY_BUFFER_ALLOC_C
115MBEDTLS_PLATFORM_TIME_ALT
116MBEDTLS_PLATFORM_FPRINTF_ALT
117);
118
Manuel Pégourié-Gonnardb7527152015-06-03 09:59:06 +0100119# Things that should be enabled in "full" even if they match @excluded
120my @non_excluded = qw(
121PLATFORM_[A-Z0-9]+_ALT
122);
123
Azim Khan0d445732017-12-21 09:28:39 +0000124# Things that should be enabled in "baremetal"
125my @non_excluded_baremetal = qw(
126MBEDTLS_NO_PLATFORM_ENTROPY
127);
128
SimonB60f2cf92016-04-03 14:16:08 +0100129# Process the command line arguments
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200130
SimonB60f2cf92016-04-03 14:16:08 +0100131my $force_option = 0;
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200132
SimonB60f2cf92016-04-03 14:16:08 +0100133my ($arg, $name, $value, $action);
134
SimonB73883c12016-04-04 13:49:10 +0100135while ($arg = shift) {
SimonB60f2cf92016-04-03 14:16:08 +0100136
137 # Check if the argument is an option
SimonB73883c12016-04-04 13:49:10 +0100138 if ($arg eq "-f" || $arg eq "--file") {
SimonB60f2cf92016-04-03 14:16:08 +0100139 $config_file = shift;
140
141 -f $config_file or die "No such file: $config_file\n";
142
143 }
SimonB73883c12016-04-04 13:49:10 +0100144 elsif ($arg eq "-o" || $arg eq "--force") {
SimonB60f2cf92016-04-03 14:16:08 +0100145 $force_option = 1;
146
147 }
148 else
149 {
150 # ...else assume it's a command
151 $action = $arg;
152
Azim Khan0d445732017-12-21 09:28:39 +0000153 if ($action eq "full" || $action eq "realfull" || $action eq "baremetal" ) {
SimonB60f2cf92016-04-03 14:16:08 +0100154 # No additional parameters
155 die $usage if @ARGV;
156
157 }
Simon Butcher4ae86912016-06-21 10:09:25 +0100158 elsif ($action eq "unset" || $action eq "get") {
SimonB60f2cf92016-04-03 14:16:08 +0100159 die $usage unless @ARGV;
160 $name = shift;
161
162 }
163 elsif ($action eq "set") {
164 die $usage unless @ARGV;
165 $name = shift;
166 $value = shift if @ARGV;
167
168 }
169 else {
170 die "Command '$action' not recognised.\n\n".$usage;
171 }
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200172 }
173}
174
Simon Butcher3d265132016-06-23 21:57:06 +0100175# If no command was specified, exit...
176if ( not defined($action) ){ die $usage; }
177
SimonB60f2cf92016-04-03 14:16:08 +0100178# Check the config file is present
179if (! -f $config_file) {
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200180
SimonB60f2cf92016-04-03 14:16:08 +0100181 chdir '..' or die;
182
183 # Confirm this is the project root directory and try again
184 if ( !(-d 'scripts' && -d 'include' && -d 'library' && -f $config_file) ) {
185 die "If no file specified, must be run from the project root or scripts directory.\n";
186 }
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200187}
SimonB60f2cf92016-04-03 14:16:08 +0100188
189
190# Now read the file and process the contents
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200191
192open my $config_read, '<', $config_file or die "read $config_file: $!\n";
193my @config_lines = <$config_read>;
194close $config_read;
195
Azim Khan0d445732017-12-21 09:28:39 +0000196# Add required baremetal symbols to the list that is included.
197if ( $action eq "baremetal" ) {
198 @non_excluded = ( @non_excluded, @non_excluded_baremetal );
199}
200
201my ($exclude_re, $no_exclude_re, $exclude_baremetal_re);
Manuel Pégourié-Gonnard1989caf2016-01-04 12:57:32 +0100202if ($action eq "realfull") {
203 $exclude_re = qr/^$/;
204 $no_exclude_re = qr/./;
205} else {
206 $exclude_re = join '|', @excluded;
207 $no_exclude_re = join '|', @non_excluded;
208}
Azim Khan0d445732017-12-21 09:28:39 +0000209if ( $action eq "baremetal" ) {
210 $exclude_baremetal_re = join '|', @excluded_baremetal;
211}
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200212
Gilles Peskine01f57e32017-10-09 16:54:28 +0200213my $config_write = undef;
214if ($action ne "get") {
215 open $config_write, '>', $config_file or die "write $config_file: $!\n";
216}
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200217
218my $done;
219for my $line (@config_lines) {
Azim Khan0d445732017-12-21 09:28:39 +0000220 if ($action eq "full" || $action eq "realfull" || $action eq "baremetal" ) {
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200221 if ($line =~ /name SECTION: Module configuration options/) {
222 $done = 1;
223 }
224
Manuel Pégourié-Gonnardb7527152015-06-03 09:59:06 +0100225 if (!$done && $line =~ m!^//\s?#define! &&
Azim Khan0d445732017-12-21 09:28:39 +0000226 ( $line !~ /$exclude_re/ || $line =~ /$no_exclude_re/ ) &&
227 ( $action ne "baremetal" || ( $line !~ /$exclude_baremetal_re/ ) ) ) {
Manuel Pégourié-Gonnardea0920f2015-03-24 09:50:15 +0100228 $line =~ s!^//\s?!!;
229 }
Manuel Pégourié-Gonnard7ee5ddd2015-06-03 10:33:55 +0100230 if (!$done && $line =~ m!^\s?#define! &&
Azim Khan0d445732017-12-21 09:28:39 +0000231 ! ( ( $line !~ /$exclude_re/ || $line =~ /$no_exclude_re/ ) &&
232 ( $action ne "baremetal" || ( $line !~ /$exclude_baremetal_re/ ) ) ) ) {
Manuel Pégourié-Gonnardea0920f2015-03-24 09:50:15 +0100233 $line =~ s!^!//!;
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200234 }
235 } elsif ($action eq "unset") {
Manuel Pégourié-Gonnard7f9049b2015-06-23 17:42:51 +0200236 if (!$done && $line =~ /^\s*#define\s*$name\b/) {
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200237 $line = '//' . $line;
238 $done = 1;
239 }
240 } elsif (!$done && $action eq "set") {
Manuel Pégourié-Gonnard7f9049b2015-06-23 17:42:51 +0200241 if ($line =~ m!^(?://)?\s*#define\s*$name\b!) {
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200242 $line = "#define $name";
243 $line .= " $value" if defined $value && $value ne "";
244 $line .= "\n";
245 $done = 1;
246 }
Simon Butcher4ae86912016-06-21 10:09:25 +0100247 } elsif (!$done && $action eq "get") {
Gilles Peskinef0f55cc2017-10-09 16:51:24 +0200248 if ($line =~ /^\s*#define\s*$name(?:\s+(.*?))\s*(?:$|\/\*|\/\/)/) {
Simon Butcher4ae86912016-06-21 10:09:25 +0100249 $value = $1;
250 $done = 1;
251 }
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200252 }
253
Gilles Peskine01f57e32017-10-09 16:54:28 +0200254 if (defined $config_write) {
Gilles Peskine8ca0e8f2017-10-10 11:26:45 +0200255 print $config_write $line or die "write $config_file: $!\n";
Gilles Peskine01f57e32017-10-09 16:54:28 +0200256 }
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200257}
258
SimonB60f2cf92016-04-03 14:16:08 +0100259# Did the set command work?
Gilles Peskined98e9e82017-10-09 16:56:18 +0200260if ($action eq "set" && $force_option && !$done) {
SimonB60f2cf92016-04-03 14:16:08 +0100261
262 # If the force option was set, append the symbol to the end of the file
263 my $line = "#define $name";
264 $line .= " $value" if defined $value && $value ne "";
265 $line .= "\n";
266 $done = 1;
267
Gilles Peskine01f57e32017-10-09 16:54:28 +0200268 print $config_write $line or die "write $config_file: $!\n";
SimonB60f2cf92016-04-03 14:16:08 +0100269}
270
Gilles Peskine01f57e32017-10-09 16:54:28 +0200271if (defined $config_write) {
272 close $config_write or die "close $config_file: $!\n";
273}
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200274
Simon Butcherdd9895d2016-06-21 15:12:00 +0100275if ($action eq "get") {
Gilles Peskined98e9e82017-10-09 16:56:18 +0200276 if ($done) {
Simon Butcherdd9895d2016-06-21 15:12:00 +0100277 if ($value ne '') {
Gilles Peskined98e9e82017-10-09 16:56:18 +0200278 print "$value\n";
Simon Butcherdd9895d2016-06-21 15:12:00 +0100279 }
280 exit 0;
281 } else {
282 # If the symbol was not found, return an error
Gilles Peskined98e9e82017-10-09 16:56:18 +0200283 exit 1;
Simon Butcher4ae86912016-06-21 10:09:25 +0100284 }
Simon Butcher4ae86912016-06-21 10:09:25 +0100285}
286
SimonB60f2cf92016-04-03 14:16:08 +0100287if ($action eq "full" && !$done) {
288 die "Configuration section was not found in $config_file\n";
289
290}
291
292if ($action ne "full" && $action ne "unset" && !$done) {
293 die "A #define for the symbol $name was not found in $config_file\n";
294}
Manuel Pégourié-Gonnardab3d8622014-07-12 03:19:18 +0200295
296__END__