third_party/mbedtls/repo/scripts/generate_errors.pl

   1 #!/usr/bin/env perl
   2
   3 # Generate error.c
   4 #
   5 # Usage: ./generate_errors.pl or scripts/generate_errors.pl without arguments,
   6 # or generate_errors.pl include_dir data_dir error_file include_crypto
   7 # include_crypto can be either 0 (don't include) or 1 (include). On by default.
   8
   9 use strict;
  10
  11 my ($include_dir, $data_dir, $error_file, $include_crypto);
  12 my $crypto_dir = "crypto";
  13
  14 if( @ARGV ) {
  15     die "Invalid number of arguments" if scalar @ARGV != 4;
  16     ($include_dir, $data_dir, $error_file, $include_crypto) = @ARGV;
  17
  18     -d $include_dir or die "No such directory: $include_dir\n";
  19     -d $data_dir or die "No such directory: $data_dir\n";
  20 } else {
  21     $include_dir = 'include/mbedtls';
  22     $data_dir = 'scripts/data_files';
  23     $error_file = 'library/error.c';
  24     $include_crypto = 1;
  25
  26     unless( -d $include_dir && -d $data_dir ) {
  27         chdir '..' or die;
  28         -d $include_dir && -d $data_dir
  29             or die "Without arguments, must be run from root or scripts\n"
  30     }
  31 }
  32
  33 if( $include_crypto ) {
  34     -d $crypto_dir or die "Crypto submodule not present\n";
  35 }
  36
  37 my $error_format_file = $data_dir.'/error.fmt';
  38
  39 my @low_level_modules = qw( AES ARC4 ARIA ASN1 BASE64 BIGNUM BLOWFISH
  40                             CAMELLIA CCM CHACHA20 CHACHAPOLY CMAC CTR_DRBG DES
  41                             ENTROPY GCM HKDF HMAC_DRBG MD2 MD4 MD5
  42                             NET OID PADLOCK PBKDF2 PLATFORM POLY1305 RIPEMD160
  43                             SHA1 SHA256 SHA512 THREADING XTEA );
  44 my @high_level_modules = qw( CIPHER DHM ECP MD
  45                              PEM PK PKCS12 PKCS5
  46                              RSA SSL X509 );
  47
  48 my $line_separator = $/;
  49 undef $/;
  50
  51 open(FORMAT_FILE, "$error_format_file") or die "Opening error format file '$error_format_file': $!";
  52 my $error_format = <FORMAT_FILE>;
  53 close(FORMAT_FILE);
  54
  55 $/ = $line_separator;
  56
  57 my @headers = ();
  58 if ($include_crypto) {
  59     @headers = <$crypto_dir/$include_dir/*.h>;
  60     foreach my $header (<$include_dir/*.h>) {
  61         my $basename = $header; $basename =~ s!.*/!!;
  62         push @headers, $header unless -e "$crypto_dir/$include_dir/$basename";
  63     }
  64 } else {
  65      @headers = <$include_dir/*.h>;
  66 }
  67
  68 my @matches;
  69 foreach my $file (@headers) {
  70     open(FILE, "$file");
  71     my @grep_res = grep(/^\s*#define\s+MBEDTLS_ERR_\w+\s+\-0x[0-9A-Fa-f]+/, <FILE>);
  72     push(@matches, @grep_res);
  73     close FILE;
  74 }
  75
  76 my $ll_old_define = "";
  77 my $hl_old_define = "";
  78
  79 my $ll_code_check = "";
  80 my $hl_code_check = "";
  81
  82 my $headers = "";
  83
  84 my %error_codes_seen;
  85
  86
  87 foreach my $line (@matches)
  88 {
  89     next if ($line =~ /compat-1.2.h/);
  90     my ($error_name, $error_code) = $line =~ /(MBEDTLS_ERR_\w+)\s+\-(0x\w+)/;
  91     my ($description) = $line =~ /\/\*\*< (.*?)\.? \*\//;
  92
  93     if( $error_codes_seen{$error_code}++ ) {
  94         die "Duplicated error code: $error_code ($error_name)\n";
  95     }
  96
  97     $description =~ s/\\/\\\\/g;
  98     if ($description eq "") {
  99         $description = "DESCRIPTION MISSING";
 100         warn "Missing description for $error_name\n";
 101     }
 102
 103     my ($module_name) = $error_name =~ /^MBEDTLS_ERR_([^_]+)/;
 104
 105     # Fix faulty ones
 106     $module_name = "BIGNUM" if ($module_name eq "MPI");
 107     $module_name = "CTR_DRBG" if ($module_name eq "CTR");
 108     $module_name = "HMAC_DRBG" if ($module_name eq "HMAC");
 109
 110     my $define_name = $module_name;
 111     $define_name = "X509_USE,X509_CREATE" if ($define_name eq "X509");
 112     $define_name = "ASN1_PARSE" if ($define_name eq "ASN1");
 113     $define_name = "SSL_TLS" if ($define_name eq "SSL");
 114     $define_name = "PEM_PARSE,PEM_WRITE" if ($define_name eq "PEM");
 115
 116     my $include_name = $module_name;
 117     $include_name =~ tr/A-Z/a-z/;
 118     $include_name = "" if ($include_name eq "asn1");
 119
 120     # Fix faulty ones
 121     $include_name = "net_sockets" if ($module_name eq "NET");
 122
 123     my $found_ll = grep $_ eq $module_name, @low_level_modules;
 124     my $found_hl = grep $_ eq $module_name, @high_level_modules;
 125     if (!$found_ll && !$found_hl)
 126     {
 127         printf("Error: Do not know how to handle: $module_name\n");
 128         exit 1;
 129     }
 130
 131     my $code_check;
 132     my $old_define;
 133     my $white_space;
 134     my $first;
 135
 136     if ($found_ll)
 137     {
 138         $code_check = \$ll_code_check;
 139         $old_define = \$ll_old_define;
 140         $white_space = '    ';
 141     }
 142     else
 143     {
 144         $code_check = \$hl_code_check;
 145         $old_define = \$hl_old_define;
 146         $white_space = '        ';
 147     }
 148
 149     if ($define_name ne ${$old_define})
 150     {
 151         if (${$old_define} ne "")
 152         {
 153             ${$code_check} .= "#endif /* ";
 154             $first = 0;
 155             foreach my $dep (split(/,/, ${$old_define}))
 156             {
 157                 ${$code_check} .= " || " if ($first++);
 158                 ${$code_check} .= "MBEDTLS_${dep}_C";
 159             }
 160             ${$code_check} .= " */\n\n";
 161         }
 162
 163         ${$code_check} .= "#if ";
 164         $headers .= "#if " if ($include_name ne "");
 165         $first = 0;
 166         foreach my $dep (split(/,/, ${define_name}))
 167         {
 168             ${$code_check} .= " || " if ($first);
 169             $headers       .= " || " if ($first++);
 170
 171             ${$code_check} .= "defined(MBEDTLS_${dep}_C)";
 172             $headers       .= "defined(MBEDTLS_${dep}_C)" if
 173                                                     ($include_name ne "");
 174         }
 175         ${$code_check} .= "\n";
 176         $headers .= "\n#include \"mbedtls/${include_name}.h\"\n".
 177                     "#endif\n\n" if ($include_name ne "");
 178         ${$old_define} = $define_name;
 179     }
 180
 181     if ($error_name eq "MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE")
 182     {
 183         ${$code_check} .= "${white_space}if( use_ret == -($error_name) )\n".
 184                           "${white_space}\{\n".
 185                           "${white_space}    mbedtls_snprintf( buf, buflen, \"$module_name - $description\" );\n".
 186                           "${white_space}    return;\n".
 187                           "${white_space}}\n"
 188     }
 189     else
 190     {
 191         ${$code_check} .= "${white_space}if( use_ret == -($error_name) )\n".
 192                           "${white_space}    mbedtls_snprintf( buf, buflen, \"$module_name - $description\" );\n"
 193     }
 194 };
 195
 196 if ($ll_old_define ne "")
 197 {
 198     $ll_code_check .= "#endif /* ";
 199     my $first = 0;
 200     foreach my $dep (split(/,/, $ll_old_define))
 201     {
 202         $ll_code_check .= " || " if ($first++);
 203         $ll_code_check .= "MBEDTLS_${dep}_C";
 204     }
 205     $ll_code_check .= " */\n";
 206 }
 207 if ($hl_old_define ne "")
 208 {
 209     $hl_code_check .= "#endif /* ";
 210     my $first = 0;
 211     foreach my $dep (split(/,/, $hl_old_define))
 212     {
 213         $hl_code_check .= " || " if ($first++);
 214         $hl_code_check .= "MBEDTLS_${dep}_C";
 215     }
 216     $hl_code_check .= " */\n";
 217 }
 218
 219 $error_format =~ s/HEADER_INCLUDED\n/$headers/g;
 220 $error_format =~ s/LOW_LEVEL_CODE_CHECKS\n/$ll_code_check/g;
 221 $error_format =~ s/HIGH_LEVEL_CODE_CHECKS\n/$hl_code_check/g;
 222
 223 open(ERROR_FILE, ">$error_file") or die "Opening destination file '$error_file': $!";
 224 print ERROR_FILE $error_format;
 225 close(ERROR_FILE);