CryptoPkg/Library/OpensslLib/process_files.pl

   1 #!/usr/bin/perl -w
   2 #
   3 # This script runs the OpenSSL Configure script, then processes the
   4 # resulting file list into our local OpensslLib[Crypto].inf and also
   5 # takes copies of opensslconf.h and dso_conf.h.
   6 #
   7 # This only needs to be done once by a developer when updating to a
   8 # new version of OpenSSL (or changing options, etc.). Normal users
   9 # do not need to do this, since the results are stored in the EDK2
  10 # git repository for them.
  11 #
  12 use strict;
  13 use Cwd;
  14 use File::Copy;
  15
  16 #
  17 # Find the openssl directory name for use lib. We have to do this
  18 # inside of BEGIN. The variables we create here, however, don't seem
  19 # to be available to the main script, so we have to repeat the
  20 # exercise.
  21 #
  22 my $inf_file;
  23 my $OPENSSL_PATH;
  24 my @inf;
  25
  26 BEGIN {
  27     $inf_file = "OpensslLib.inf";
  28
  29     # Read the contents of the inf file
  30     open( FD, "<" . $inf_file ) ||
  31         die "Cannot open \"" . $inf_file . "\"!";
  32     @inf = (<FD>);
  33     close(FD) ||
  34         die "Cannot close \"" . $inf_file . "\"!";
  35
  36     foreach (@inf) {
  37         if (/DEFINE\s+OPENSSL_PATH\s*=\s*([a-z]+)/) {
  38
  39             # We need to run Configure before we can include its result...
  40             $OPENSSL_PATH = $1;
  41
  42             my $basedir = getcwd();
  43
  44             chdir($OPENSSL_PATH) ||
  45                 die "Cannot change to OpenSSL directory \"" . $OPENSSL_PATH . "\"";
  46
  47             # Configure UEFI
  48             system(
  49                 "./Configure",
  50                 "UEFI",
  51                 "no-afalgeng",
  52                 "no-asm",
  53                 "no-async",
  54                 "no-autoerrinit",
  55                 "no-autoload-config",
  56                 "no-bf",
  57                 "no-blake2",
  58                 "no-camellia",
  59                 "no-capieng",
  60                 "no-cast",
  61                 "no-chacha",
  62                 "no-cms",
  63                 "no-ct",
  64                 "no-deprecated",
  65                 "no-des",
  66                 "no-dgram",
  67                 "no-dsa",
  68                 "no-dynamic-engine",
  69                 "no-ec",
  70                 "no-ec2m",
  71                 "no-engine",
  72                 "no-err",
  73                 "no-filenames",
  74                 "no-gost",
  75                 "no-hw",
  76                 "no-idea",
  77                 "no-md4",
  78                 "no-mdc2",
  79                 "no-pic",
  80                 "no-ocb",
  81                 "no-poly1305",
  82                 "no-posix-io",
  83                 "no-rc2",
  84                 "no-rc4",
  85                 "no-rfc3779",
  86                 "no-rmd160",
  87                 "no-scrypt",
  88                 "no-seed",
  89                 "no-sock",
  90                 "no-srp",
  91                 "no-ssl",
  92                 "no-stdio",
  93                 "no-threads",
  94                 "no-ts",
  95                 "no-ui",
  96                 "no-whirlpool",
  97                 # OpenSSL1_1_1b doesn't support default rand-seed-os for UEFI
  98                 # UEFI only support --with-rand-seed=none
  99                 "--with-rand-seed=none"
 100                 ) == 0 ||
 101                     die "OpenSSL Configure failed!\n";
 102
 103             # Generate opensslconf.h per config data
 104             system(
 105                 "perl -I. -Mconfigdata util/dofile.pl " .
 106                 "include/openssl/opensslconf.h.in " .
 107                 "> include/openssl/opensslconf.h"
 108                 ) == 0 ||
 109                     die "Failed to generate opensslconf.h!\n";
 110
 111             # Generate dso_conf.h per config data
 112             system(
 113                 "perl -I. -Mconfigdata util/dofile.pl " .
 114                 "crypto/include/internal/dso_conf.h.in " .
 115                 "> include/internal/dso_conf.h"
 116                 ) == 0 ||
 117                     die "Failed to generate dso_conf.h!\n";
 118
 119             chdir($basedir) ||
 120                 die "Cannot change to base directory \"" . $basedir . "\"";
 121
 122             push @INC, $1;
 123             last;
 124         }
 125     }
 126 }
 127
 128 #
 129 # Retrieve file lists from OpenSSL configdata
 130 #
 131 use configdata qw/%unified_info/;
 132
 133 my @cryptofilelist = ();
 134 my @sslfilelist = ();
 135 foreach my $product ((@{$unified_info{libraries}},
 136                       @{$unified_info{engines}})) {
 137     foreach my $o (@{$unified_info{sources}->{$product}}) {
 138         foreach my $s (@{$unified_info{sources}->{$o}}) {
 139             next if ($unified_info{generate}->{$s});
 140             next if $s =~ "crypto/bio/b_print.c";
 141
 142             # No need to add unused files in UEFI.
 143             # So it can reduce porting time, compile time, library size.
 144             next if $s =~ "crypto/rand/randfile.c";
 145             next if $s =~ "crypto/store/";
 146             next if $s =~ "crypto/err/err_all.c";
 147             next if $s =~ "crypto/aes/aes_ecb.c";
 148
 149             if ($product =~ "libssl") {
 150                 push @sslfilelist, '  $(OPENSSL_PATH)/' . $s . "\r\n";
 151                 next;
 152             }
 153             push @cryptofilelist, '  $(OPENSSL_PATH)/' . $s . "\r\n";
 154         }
 155     }
 156 }
 157
 158
 159 #
 160 # Update the perl script to generate the missing header files
 161 #
 162 my @dir_list = ();
 163 for (sort keys %{$unified_info{dirinfo}}){
 164   push @dir_list,$_;
 165 }
 166
 167 my $dir = getcwd();
 168 my @files = ();
 169 my @headers = ();
 170 chdir ("openssl");
 171 foreach(@dir_list){
 172   @files = glob($_."/*.h");
 173   push @headers, @files;
 174 }
 175 chdir ($dir);
 176
 177 foreach (@headers){
 178   if(/ssl/){
 179     push @sslfilelist, '  $(OPENSSL_PATH)/' . $_ . "\r\n";
 180     next;
 181   }
 182   push @cryptofilelist, '  $(OPENSSL_PATH)/' . $_ . "\r\n";
 183 }
 184
 185
 186 #
 187 # Update OpensslLib.inf with autogenerated file list
 188 #
 189 my @new_inf = ();
 190 my $subbing = 0;
 191 print "\n--> Updating OpensslLib.inf ... ";
 192 foreach (@inf) {
 193     if ( $_ =~ "# Autogenerated files list starts here" ) {
 194         push @new_inf, $_, @cryptofilelist, @sslfilelist;
 195         $subbing = 1;
 196         next;
 197     }
 198     if ( $_ =~ "# Autogenerated files list ends here" ) {
 199         push @new_inf, $_;
 200         $subbing = 0;
 201         next;
 202     }
 203
 204     push @new_inf, $_
 205         unless ($subbing);
 206 }
 207
 208 my $new_inf_file = $inf_file . ".new";
 209 open( FD, ">" . $new_inf_file ) ||
 210     die $new_inf_file;
 211 print( FD @new_inf ) ||
 212     die $new_inf_file;
 213 close(FD) ||
 214     die $new_inf_file;
 215 rename( $new_inf_file, $inf_file ) ||
 216     die "rename $inf_file";
 217 print "Done!";
 218
 219 #
 220 # Update OpensslLibCrypto.inf with auto-generated file list (no libssl)
 221 #
 222 $inf_file = "OpensslLibCrypto.inf";
 223
 224 # Read the contents of the inf file
 225 @inf = ();
 226 @new_inf = ();
 227 open( FD, "<" . $inf_file ) ||
 228     die "Cannot open \"" . $inf_file . "\"!";
 229 @inf = (<FD>);
 230 close(FD) ||
 231     die "Cannot close \"" . $inf_file . "\"!";
 232
 233 $subbing = 0;
 234 print "\n--> Updating OpensslLibCrypto.inf ... ";
 235 foreach (@inf) {
 236     if ( $_ =~ "# Autogenerated files list starts here" ) {
 237         push @new_inf, $_, @cryptofilelist;
 238         $subbing = 1;
 239         next;
 240     }
 241     if ( $_ =~ "# Autogenerated files list ends here" ) {
 242         push @new_inf, $_;
 243         $subbing = 0;
 244         next;
 245     }
 246
 247     push @new_inf, $_
 248         unless ($subbing);
 249 }
 250
 251 $new_inf_file = $inf_file . ".new";
 252 open( FD, ">" . $new_inf_file ) ||
 253     die $new_inf_file;
 254 print( FD @new_inf ) ||
 255     die $new_inf_file;
 256 close(FD) ||
 257     die $new_inf_file;
 258 rename( $new_inf_file, $inf_file ) ||
 259     die "rename $inf_file";
 260 print "Done!";
 261
 262 #
 263 # Copy opensslconf.h and dso_conf.h generated from OpenSSL Configuration
 264 #
 265 print "\n--> Duplicating opensslconf.h into Include/openssl ... ";
 266 copy($OPENSSL_PATH . "/include/openssl/opensslconf.h",
 267      $OPENSSL_PATH . "/../../Include/openssl/") ||
 268    die "Cannot copy opensslconf.h!";
 269 print "Done!";
 270 print "\n--> Duplicating dso_conf.h into Include/internal ... ";
 271 copy($OPENSSL_PATH . "/include/internal/dso_conf.h",
 272      $OPENSSL_PATH . "/../../Include/internal/") ||
 273    die "Cannot copy dso_conf.h!";
 274 print "Done!\n";
 275
 276 print "\nProcessing Files Done!\n";
 277
 278 exit(0);
 279