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