util/mkdef.pl

   1 #!/usr/local/bin/perl -w
   2 #
   3 # generate a .def file
   4 #
   5 # It does this by parsing the header files and looking for the
   6 # prototyped functions: it then prunes the output.
   7 #
   8
   9 my $crypto_num="util/libeay.num";
  10 my $ssl_num=   "util/ssleay.num";
  11
  12 my $do_update = 0;
  13 my $do_crypto = 0;
  14 my $do_ssl = 0;
  15 my $do_ctest = 0;
  16 my $rsaref = 0;
  17
  18 my $W32=1;
  19 my $NT=0;
  20 # Set this to make typesafe STACK definitions appear in DEF
  21 my $safe_stack_def = 0;
  22
  23 my $options="";
  24 open(IN,"<Makefile.ssl") || die "unable to open Makefile.ssl!\n";
  25 while(<IN>) {
  26     $options=$1 if (/^OPTIONS=(.*)$/);
  27 }
  28 close(IN);
  29
  30 # The following ciphers may be excluded (by Configure). This means functions
  31 # defined with ifndef(NO_XXX) are not included in the .def file, and everything
  32 # in directory xxx is ignored.
  33 my $no_rc2; my $no_rc4; my $no_rc5; my $no_idea; my $no_des; my $no_bf;
  34 my $no_cast;
  35 my $no_md2; my $no_md4; my $no_md5; my $no_sha; my $no_ripemd; my $no_mdc2;
  36 my $no_rsa; my $no_dsa; my $no_dh; my $no_hmac=0;
  37
  38 foreach (@ARGV, split(/ /, $options))
  39         {
  40         $W32=1 if $_ eq "32";
  41         $W32=0 if $_ eq "16";
  42         if($_ eq "NT") {
  43                 $W32 = 1;
  44                 $NT = 1;
  45         }
  46         $do_ssl=1 if $_ eq "ssleay";
  47         $do_ssl=1 if $_ eq "ssl";
  48         $do_crypto=1 if $_ eq "libeay";
  49         $do_crypto=1 if $_ eq "crypto";
  50         $do_update=1 if $_ eq "update";
  51         $do_ctest=1 if $_ eq "ctest";
  52         $rsaref=1 if $_ eq "rsaref";
  53         #$safe_stack_def=1 if $_ eq "-DDEBUG_SAFESTACK";
  54
  55         if    (/^no-rc2$/)      { $no_rc2=1; }
  56         elsif (/^no-rc4$/)      { $no_rc4=1; }
  57         elsif (/^no-rc5$/)      { $no_rc5=1; }
  58         elsif (/^no-idea$/)     { $no_idea=1; }
  59         elsif (/^no-des$/)      { $no_des=1; }
  60         elsif (/^no-bf$/)       { $no_bf=1; }
  61         elsif (/^no-cast$/)     { $no_cast=1; }
  62         elsif (/^no-md2$/)      { $no_md2=1; }
  63         elsif (/^no-md4$/)      { $no_md4=1; }
  64         elsif (/^no-md5$/)      { $no_md5=1; }
  65         elsif (/^no-sha$/)      { $no_sha=1; }
  66         elsif (/^no-ripemd$/)   { $no_ripemd=1; }
  67         elsif (/^no-mdc2$/)     { $no_mdc2=1; }
  68         elsif (/^no-rsa$/)      { $no_rsa=1; }
  69         elsif (/^no-dsa$/)      { $no_dsa=1; }
  70         elsif (/^no-dh$/)       { $no_dh=1; }
  71         elsif (/^no-hmac$/)     { $no_hmac=1; }
  72         }
  73
  74
  75 if (!$do_ssl && !$do_crypto)
  76         {
  77         print STDERR "usage: $0 ( ssl | crypto ) [ 16 | 32 | NT ] [rsaref]\n";
  78         exit(1);
  79         }
  80
  81 %ssl_list=&load_numbers($ssl_num);
  82 $max_ssl = $max_num;
  83 %crypto_list=&load_numbers($crypto_num);
  84 $max_crypto = $max_num;
  85
  86 my $ssl="ssl/ssl.h";
  87
  88 my $crypto ="crypto/crypto.h";
  89 $crypto.=" crypto/des/des.h" unless $no_des;
  90 $crypto.=" crypto/idea/idea.h" unless $no_idea;
  91 $crypto.=" crypto/rc4/rc4.h" unless $no_rc4;
  92 $crypto.=" crypto/rc5/rc5.h" unless $no_rc5;
  93 $crypto.=" crypto/rc2/rc2.h" unless $no_rc2;
  94 $crypto.=" crypto/bf/blowfish.h" unless $no_bf;
  95 $crypto.=" crypto/cast/cast.h" unless $no_cast;
  96 $crypto.=" crypto/md2/md2.h" unless $no_md2;
  97 $crypto.=" crypto/md4/md4.h" unless $no_md4;
  98 $crypto.=" crypto/md5/md5.h" unless $no_md5;
  99 $crypto.=" crypto/mdc2/mdc2.h" unless $no_mdc2;
 100 $crypto.=" crypto/sha/sha.h" unless $no_sha;
 101 $crypto.=" crypto/ripemd/ripemd.h" unless $no_ripemd;
 102
 103 $crypto.=" crypto/bn/bn.h";
 104 $crypto.=" crypto/rsa/rsa.h" unless $no_rsa;
 105 $crypto.=" crypto/dsa/dsa.h" unless $no_dsa;
 106 $crypto.=" crypto/dh/dh.h" unless $no_dh;
 107 $crypto.=" crypto/hmac/hmac.h" unless $no_hmac;
 108
 109 $crypto.=" crypto/stack/stack.h";
 110 $crypto.=" crypto/buffer/buffer.h";
 111 $crypto.=" crypto/bio/bio.h";
 112 $crypto.=" crypto/dso/dso.h";
 113 $crypto.=" crypto/lhash/lhash.h";
 114 $crypto.=" crypto/conf/conf.h";
 115 $crypto.=" crypto/txt_db/txt_db.h";
 116
 117 $crypto.=" crypto/evp/evp.h";
 118 $crypto.=" crypto/objects/objects.h";
 119 $crypto.=" crypto/pem/pem.h";
 120 #$crypto.=" crypto/meth/meth.h";
 121 $crypto.=" crypto/asn1/asn1.h";
 122 $crypto.=" crypto/asn1/asn1_mac.h";
 123 $crypto.=" crypto/err/err.h";
 124 $crypto.=" crypto/pkcs7/pkcs7.h";
 125 $crypto.=" crypto/pkcs12/pkcs12.h";
 126 $crypto.=" crypto/x509/x509.h";
 127 $crypto.=" crypto/x509/x509_vfy.h";
 128 $crypto.=" crypto/x509v3/x509v3.h";
 129 $crypto.=" crypto/rand/rand.h";
 130 $crypto.=" crypto/comp/comp.h";
 131 $crypto.=" crypto/tmdiff.h";
 132
 133 my @ssl_func = &do_defs("SSLEAY", $ssl);
 134 my @crypto_func = &do_defs("LIBEAY", $crypto);
 135
 136
 137 if ($do_update) {
 138
 139 if ($do_ssl == 1) {
 140         open(OUT, ">>$ssl_num");
 141         &update_numbers(*OUT,"SSLEAY",*ssl_list,$max_ssl, @ssl_func);
 142         close OUT;
 143 }
 144
 145 if($do_crypto == 1) {
 146         open(OUT, ">>$crypto_num");
 147         &update_numbers(*OUT,"LIBEAY",*crypto_list,$max_crypto, @crypto_func);
 148         close OUT;
 149 }
 150
 151 } elsif ($do_ctest) {
 152
 153         print <<"EOF";
 154
 155 /* Test file to check all DEF file symbols are present by trying
 156  * to link to all of them. This is *not* intended to be run!
 157  */
 158
 159 int main()
 160 {
 161 EOF
 162         &print_test_file(*STDOUT,"SSLEAY",*ssl_list,@ssl_func)
 163                 if $do_ssl == 1;
 164
 165         &print_test_file(*STDOUT,"LIBEAY",*crypto_list,@crypto_func)
 166                 if $do_crypto == 1;
 167
 168         print "}\n";
 169
 170 } else {
 171
 172         &print_def_file(*STDOUT,"SSLEAY",*ssl_list,@ssl_func)
 173                 if $do_ssl == 1;
 174
 175         &print_def_file(*STDOUT,"LIBEAY",*crypto_list,@crypto_func)
 176                 if $do_crypto == 1;
 177
 178 }
 179
 180
 181 sub do_defs
 182 {
 183         my($name,$files)=@_;
 184         my $file;
 185         my @ret;
 186         my %funcs;
 187         my $cpp;
 188
 189         foreach $file (split(/\s+/,$files))
 190                 {
 191                 open(IN,"<$file") || die "unable to open $file:$!\n";
 192                 my $line = "", my $def= "";
 193                 my %tag = (
 194                         FreeBSD         => 0,
 195                         NOPROTO         => 0,
 196                         WIN16           => 0,
 197                         PERL5           => 0,
 198                         _WINDLL         => 0,
 199                         NO_FP_API       => 0,
 200                         CONST_STRICT    => 0,
 201                         TRUE            => 1,
 202                         NO_RC2          => 0,
 203                         NO_RC4          => 0,
 204                         NO_RC5          => 0,
 205                         NO_IDEA         => 0,
 206                         NO_DES          => 0,
 207                         NO_BF           => 0,
 208                         NO_CAST         => 0,
 209                         NO_MD2          => 0,
 210                         NO_MD4          => 0,
 211                         NO_MD5          => 0,
 212                         NO_SHA          => 0,
 213                         NO_RIPEMD       => 0,
 214                         NO_MDC2         => 0,
 215                         NO_RSA          => 0,
 216                         NO_DSA          => 0,
 217                         NO_DH           => 0,
 218                         NO_HMAC         => 0,
 219                 );
 220                 while(<IN>) {
 221                         last if (/BEGIN ERROR CODES/);
 222                         if ($line ne '') {
 223                                 $_ = $line . $_;
 224                                 $line = '';
 225                         }
 226
 227                         if (/\\$/) {
 228                                 $line = $_;
 229                                 next;
 230                         }
 231
 232                         $cpp = 1 if /^#.*ifdef.*cplusplus/;
 233                         if ($cpp) {
 234                                 $cpp = 0 if /^#.*endif/;
 235                                 next;
 236                         }
 237
 238                         s/\/\*.*?\*\///gs;                   # ignore comments
 239                         s/{[^{}]*}//gs;                      # ignore {} blocks
 240                         if (/^\#\s*ifndef (.*)/) {
 241                                 push(@tag,$1);
 242                                 $tag{$1}=-1;
 243                                 next;
 244                         } elsif (/^\#\s*if !defined\(([^\)]+)\)/) {
 245                                 push(@tag,$1);
 246                                 $tag{$1}=-1;
 247                                 next;
 248                         } elsif (/^\#\s*ifdef (.*)/) {
 249                                 push(@tag,$1);
 250                                 $tag{$1}=1;
 251                                 next;
 252                         } elsif (/^\#\s*if defined(.*)/) {
 253                                 push(@tag,$1);
 254                                 $tag{$1}=1;
 255                                 next;
 256                         } elsif (/^\#\s*endif/) {
 257                                 $tag{$tag[$#tag]}=0;
 258                                 pop(@tag);
 259                                 next;
 260                         } elsif (/^\#\s*else/) {
 261                                 my $t=$tag[$#tag];
 262                                 $tag{$t}= -$tag{$t};
 263                                 next;
 264                         } elsif (/^\#\s*if\s+1/) {
 265                                 # Dummy tag
 266                                 push(@tag,"TRUE");
 267                                 $tag{"TRUE"}=1;
 268                                 next;
 269                         } elsif (/^\#\s*if\s+0/) {
 270                                 # Dummy tag
 271                                 push(@tag,"TRUE");
 272                                 $tag{"TRUE"}=-1;
 273                                 next;
 274                         } elsif (/^\#/) {
 275                                 next;
 276                         }
 277                         if (/^\s*DECLARE_STACK_OF\s*\(\s*(\w*)\s*\)/) {
 278                                 next;
 279                         } elsif (/^\s*DECLARE_ASN1_SET_OF\s*\(\s*(\w*)\s*\)/) {
 280                                 next;
 281                         } elsif (/^DECLARE_PEM_rw\s*\(\s*(\w*)\s*,/ ||
 282                                      /^DECLARE_PEM_rw_cb\s*\(\s*(\w*)\s*,/ ) {
 283                                 if (!($no_rsa && ($1 eq "RSAPrivateKey" ||
 284                                                   $1 eq "RSAPublicKey" ||
 285                                                   $1 eq "RSA_PUBKEY"))) {
 286                                         if($W32) {
 287                                                 $funcs{"PEM_read_${1}"} = 1;
 288                                                 $funcs{"PEM_write_${1}"} = 1;
 289                                         }
 290                                         $funcs{"PEM_read_bio_${1}"} = 1;
 291                                         $funcs{"PEM_write_bio_${1}"} = 1;
 292                                 }
 293                         } elsif (/^DECLARE_PEM_write\s*\(\s*(\w*)\s*,/ ||
 294                                      /^DECLARE_PEM_write_cb\s*\(\s*(\w*)\s*,/ ) {
 295                                 if (!($no_rsa && ($1 eq "RSAPrivateKey" ||
 296                                                   $1 eq "RSAPublicKey" ||
 297                                                   $1 eq "RSA_PUBKEY"))) {
 298                                         if($W32) {
 299                                                 $funcs{"PEM_write_${1}"} = 1;
 300                                         }
 301                                         $funcs{"PEM_write_bio_${1}"} = 1;
 302                                 }
 303                         } elsif (/^DECLARE_PEM_read\s*\(\s*(\w*)\s*,/ ||
 304                                      /^DECLARE_PEM_read_cb\s*\(\s*(\w*)\s*,/ ) {
 305                                 if($W32) {
 306                                         $funcs{"PEM_read_${1}"} = 1;
 307                                 }
 308                                 $funcs{"PEM_read_bio_${1}"} = 1;
 309                         } elsif (
 310                                 ($tag{'TRUE'} != -1) &&
 311                                 ($tag{'FreeBSD'} != 1) &&
 312                                 ($tag{'CONST_STRICT'} != 1) &&
 313                                 (($W32 && ($tag{'WIN16'} != 1)) ||
 314                                  (!$W32 && ($tag{'WIN16'} != -1))) &&
 315                                 ($tag{'PERL5'} != 1) &&
 316 #                               ($tag{'_WINDLL'} != -1) &&
 317                                 ((!$W32 && $tag{'_WINDLL'} != -1) ||
 318                                  ($W32 && $tag{'_WINDLL'} != 1)) &&
 319                                 ((($tag{'NO_FP_API'} != 1) && $W32) ||
 320                                  (($tag{'NO_FP_API'} != -1) && !$W32)) &&
 321                                 ($tag{'NO_RC2'} == 0  || !$no_rc2) &&
 322                                 ($tag{'NO_RC4'} == 0  || !$no_rc4) &&
 323                                 ($tag{'NO_RC5'} == 0  || !$no_rc5) &&
 324                                 ($tag{'NO_IDEA'} == 0 || !$no_idea) &&
 325                                 ($tag{'NO_DES'} == 0  || !$no_des) &&
 326                                 ($tag{'NO_BF'} == 0   || !$no_bf) &&
 327                                 ($tag{'NO_CAST'} == 0 || !$no_cast) &&
 328                                 ($tag{'NO_MD2'} == 0  || !$no_md2) &&
 329                                 ($tag{'NO_MD4'} == 0  || !$no_md4) &&
 330                                 ($tag{'NO_MD5'} == 0  || !$no_md5) &&
 331                                 ($tag{'NO_SHA'} == 0  || !$no_sha) &&
 332                                 ($tag{'NO_RIPEMD'} == 0 || !$no_ripemd) &&
 333                                 ($tag{'NO_MDC2'} == 0 || !$no_mdc2) &&
 334                                 ($tag{'NO_RSA'} == 0  || !$no_rsa) &&
 335                                 ($tag{'NO_DSA'} == 0  || !$no_dsa) &&
 336                                 ($tag{'NO_DH'} == 0   || !$no_dh) &&
 337                                 ($tag{'NO_HMAC'} == 0 || !$no_hmac))
 338                                 {
 339                                         if (/{|\/\*/) { # }
 340                                                 $line = $_;
 341                                         } else {
 342                                                 $def .= $_;
 343                                         }
 344                                 }
 345                         }
 346                 close(IN);
 347
 348                 foreach (split /;/, $def) {
 349                         s/^[\n\s]*//g;
 350                         s/[\n\s]*$//g;
 351                         next if(/#define/);
 352                         next if(/typedef\W/);
 353                         next if(/EVP_bf/ and $no_bf);
 354                         next if(/EVP_cast/ and $no_cast);
 355                         next if(/EVP_des/ and $no_des);
 356                         next if(/EVP_dss/ and $no_dsa);
 357                         next if(/EVP_idea/ and $no_idea);
 358                         next if(/EVP_md2/ and $no_md2);
 359                         next if(/EVP_md4/ and $no_md4);
 360                         next if(/EVP_md5/ and $no_md5);
 361                         next if(/EVP_rc2/ and $no_rc2);
 362                         next if(/EVP_rc4/ and $no_rc4);
 363                         next if(/EVP_rc5/ and $no_rc5);
 364                         next if(/EVP_ripemd/ and $no_ripemd);
 365                         next if(/EVP_sha/ and $no_sha);
 366                         next if(/EVP_(Open|Seal)(Final|Init)/ and $no_rsa);
 367                         next if(/PEM_Seal(Final|Init|Update)/ and $no_rsa);
 368                         next if(/RSAPrivateKey/ and $no_rsa);
 369                         next if(/SSLv23?_((client|server)_)?method/ and $no_rsa);
 370
 371                         if (/\(\*(\w*)\([^\)]+/) {
 372                                 $funcs{$1} = 1;
 373                         } elsif (/\w+\W+(\w+)\W*\(\s*\)$/s) {
 374                                 # K&R C
 375                                 next;
 376                         } elsif (/\w+\W+\w+\W*\(.*\)$/s) {
 377                                 while (not /\(\)$/s) {
 378                                         s/[^\(\)]*\)$/\)/s;
 379                                         s/\([^\(\)]*\)\)$/\)/s;
 380                                 }
 381                                 s/\(void\)//;
 382                                 /(\w+)\W*\(\)/s;
 383                                 $funcs{$1} = 1;
 384                         } elsif (/\(/ and not (/=/)) {
 385                                 print STDERR "File $file: cannot parse: $_;\n";
 386                         }
 387                 }
 388         }
 389
 390         # Prune the returned functions
 391
 392         delete $funcs{"SSL_add_dir_cert_subjects_to_stack"};
 393         delete $funcs{"RSA_PKCS1_RSAref"} unless $rsaref;
 394         delete $funcs{"bn_dump1"};
 395
 396         if($W32) {
 397                 delete $funcs{"BIO_s_file_internal"};
 398                 delete $funcs{"BIO_new_file_internal"};
 399                 delete $funcs{"BIO_new_fp_internal"};
 400         } else {
 401                 if(exists $funcs{"ERR_load_CRYPTO_strings"}) {
 402                         delete $funcs{"ERR_load_CRYPTO_strings"};
 403                         $funcs{"ERR_load_CRYPTOlib_strings"} = 1;
 404                 }
 405                 delete $funcs{"BIO_s_file"};
 406                 delete $funcs{"BIO_new_file"};
 407                 delete $funcs{"BIO_new_fp"};
 408         }
 409         if (!$NT) {
 410                 delete $funcs{"BIO_s_log"};
 411         }
 412
 413         push @ret, keys %funcs;
 414
 415         return(@ret);
 416 }
 417
 418 sub print_test_file
 419 {
 420         (*OUT,my $name,*nums,my @functions)=@_;
 421         my $n = 1; my @e; my @r;
 422         my $func;
 423
 424         (@e)=grep(/^SSLeay/,@functions);
 425         (@r)=grep(!/^SSLeay/,@functions);
 426         @functions=((sort @e),(sort @r));
 427
 428         foreach $func (@functions) {
 429                 if (!defined($nums{$func})) {
 430                         printf STDERR "$func does not have a number assigned\n"
 431                                         if(!$do_update);
 432                 } else {
 433                         $n=$nums{$func};
 434                         print OUT "\t$func();\n";
 435                 }
 436         }
 437 }
 438
 439 sub print_def_file
 440 {
 441         (*OUT,my $name,*nums,my @functions)=@_;
 442         my $n = 1; my @e; my @r;
 443
 444         if ($W32)
 445                 { $name.="32"; }
 446         else
 447                 { $name.="16"; }
 448
 449         print OUT <<"EOF";
 450 ;
 451 ; Definition file for the DLL version of the $name library from OpenSSL
 452 ;
 453
 454 LIBRARY         $name
 455
 456 DESCRIPTION     'OpenSSL $name - http://www.openssl.org/'
 457
 458 EOF
 459
 460         if (!$W32) {
 461                 print <<"EOF";
 462 CODE            PRELOAD MOVEABLE
 463 DATA            PRELOAD MOVEABLE SINGLE
 464
 465 EXETYPE         WINDOWS
 466
 467 HEAPSIZE        4096
 468 STACKSIZE       8192
 469
 470 EOF
 471         }
 472
 473         print "EXPORTS\n";
 474
 475
 476         (@e)=grep(/^SSLeay/,@functions);
 477         (@r)=grep(!/^SSLeay/,@functions);
 478         @functions=((sort @e),(sort @r));
 479
 480         foreach $func (@functions) {
 481                 if (!defined($nums{$func})) {
 482                         printf STDERR "$func does not have a number assigned\n"
 483                                         if(!$do_update);
 484                 } else {
 485                         $n=$nums{$func};
 486                         printf OUT "    %s%-40s@%d\n",($W32)?"":"_",$func,$n;
 487                 }
 488         }
 489         printf OUT "\n";
 490 }
 491
 492 sub load_numbers
 493 {
 494         my($name)=@_;
 495         my(@a,%ret);
 496
 497         $max_num = 0;
 498
 499         open(IN,"<$name") || die "unable to open $name:$!\n";
 500         while (<IN>) {
 501                 chop;
 502                 s/#.*$//;
 503                 next if /^\s*$/;
 504                 @a=split;
 505                 $ret{$a[0]}=$a[1];
 506                 $max_num = $a[1] if $a[1] > $max_num;
 507         }
 508         close(IN);
 509         return(%ret);
 510 }
 511
 512 sub update_numbers
 513 {
 514         (*OUT,$name,*nums,my $start_num, my @functions)=@_;
 515         my $new_funcs = 0;
 516         print STDERR "Updating $name\n";
 517         foreach $func (@functions) {
 518                 if (!exists $nums{$func}) {
 519                         $new_funcs++;
 520                         printf OUT "%s%-40s%d\n","",$func, ++$start_num;
 521                 }
 522         }
 523         if($new_funcs) {
 524                 print STDERR "$new_funcs New Functions added\n";
 525         } else {
 526                 print STDERR "No New Functions Added\n";
 527         }
 528 }