Various updates to mkdef.pl to cope with new aes
[openssl.git] / util / mkdef.pl
index 706073dd74e0906952bd143f9598e88d110cc6f7..bcf875f546fd2256be49c394bc7ef0bca6cfb79a 100755 (executable)
 #   symbol name replacements for platforms where the names are too long for the
 #   compiler or linker, or if the systems is case insensitive and there is a
 #   clash.  This script assumes those redefinitions are place in the file
-#   crypto/idhacks.h.
+#   crypto/symhacks.h.
+#   The semantics for the platforms list is a bit complicated.  The rule of
+#   thumb is that the list is exclusive, but it seems to mean different things.
+#   So, if the list is all negatives (like "!VMS,!WIN16"), the symbol exists
+#   on all platforms except those listed.  If the list is all positives (like
+#   "VMS,WIN16"), the symbol exists only on those platforms and nowhere else.
+#   The combination of positives and negatives will act as if the positives
+#   weren't there.
 # - "kind" is "FUNCTION" or "VARIABLE".  The meaning of that is obvious.
 # - "algorithms" is a comma-separated list of algorithm names.  This helps
 #   exclude symbols that are part of an algorithm that some user wants to
@@ -56,7 +63,7 @@ my $do_crypto = 0;
 my $do_ssl = 0;
 my $do_ctest = 0;
 my $do_ctestall = 0;
-my $rsaref = 0;
+my $do_checkexist = 0;
 
 my $VMS=0;
 my $W32=0;
@@ -68,8 +75,16 @@ my $safe_stack_def = 0;
 my @known_platforms = ( "__FreeBSD__", "VMS", "WIN16", "WIN32",
                        "WINNT", "PERL5", "NeXT" );
 my @known_algorithms = ( "RC2", "RC4", "RC5", "IDEA", "DES", "BF",
-                        "CAST", "MD2", "MD4", "MD5", "SHA", "RIPEMD",
-                        "MDC2", "RSA", "DSA", "DH", "HMAC", "FP_API" );
+                        "CAST", "MD2", "MD4", "MD5", "SHA", "SHA0", "SHA1",
+                        "RIPEMD",
+                        "MDC2", "RSA", "DSA", "DH", "HMAC", "AES",
+                        # Envelope "algorithms"
+                        "EVP", "X509", "ASN1_TYPEDEFS",
+                        # Helper "algorithms"
+                        "BIO", "COMP", "BUFFER", "LHASH", "STACK", "ERR",
+                        "LOCKING",
+                        # External "algorithms"
+                        "FP_API", "STDIO", "SOCK", "KRB5" );
 
 my $options="";
 open(IN,"<Makefile.ssl") || die "unable to open Makefile.ssl!\n";
@@ -84,7 +99,7 @@ close(IN);
 my $no_rc2; my $no_rc4; my $no_rc5; my $no_idea; my $no_des; my $no_bf;
 my $no_cast;
 my $no_md2; my $no_md4; my $no_md5; my $no_sha; my $no_ripemd; my $no_mdc2;
-my $no_rsa; my $no_dsa; my $no_dh; my $no_hmac=0;
+my $no_rsa; my $no_dsa; my $no_dh; my $no_hmac=0; my $no_aes;
 my $no_fp_api;
 
 foreach (@ARGV, split(/ /, $options))
@@ -96,6 +111,7 @@ foreach (@ARGV, split(/ /, $options))
                $NT = 1;
        }
        $VMS=1 if $_ eq "VMS";
+
        $do_ssl=1 if $_ eq "ssleay";
        $do_ssl=1 if $_ eq "ssl";
        $do_crypto=1 if $_ eq "libeay";
@@ -104,14 +120,14 @@ foreach (@ARGV, split(/ /, $options))
        $do_rewrite=1 if $_ eq "rewrite";
        $do_ctest=1 if $_ eq "ctest";
        $do_ctestall=1 if $_ eq "ctestall";
-       $rsaref=1 if $_ eq "rsaref";
+       $do_checkexist=1 if $_ eq "exist";
        #$safe_stack_def=1 if $_ eq "-DDEBUG_SAFESTACK";
 
        if    (/^no-rc2$/)      { $no_rc2=1; }
        elsif (/^no-rc4$/)      { $no_rc4=1; }
        elsif (/^no-rc5$/)      { $no_rc5=1; }
        elsif (/^no-idea$/)     { $no_idea=1; }
-       elsif (/^no-des$/)      { $no_des=1; }
+       elsif (/^no-des$/)      { $no_des=1; $no_mdc2=1; }
        elsif (/^no-bf$/)       { $no_bf=1; }
        elsif (/^no-cast$/)     { $no_cast=1; }
        elsif (/^no-md2$/)      { $no_md2=1; }
@@ -124,6 +140,16 @@ foreach (@ARGV, split(/ /, $options))
        elsif (/^no-dsa$/)      { $no_dsa=1; }
        elsif (/^no-dh$/)       { $no_dh=1; }
        elsif (/^no-hmac$/)     { $no_hmac=1; }
+       elsif (/^no-aes$/)      { $no_aes=1; }
+       elsif (/^no-evp$/)      { $no_evp=1; }
+       elsif (/^no-lhash$/)    { $no_lhash=1; }
+       elsif (/^no-stack$/)    { $no_stack=1; }
+       elsif (/^no-err$/)      { $no_err=1; }
+       elsif (/^no-buffer$/)   { $no_buffer=1; }
+       elsif (/^no-bio$/)      { $no_bio=1; }
+       #elsif (/^no-locking$/) { $no_locking=1; }
+       elsif (/^no-comp$/)     { $no_comp=1; }
+       elsif (/^no-dso$/)      { $no_dso=1; }
        }
 
 
@@ -139,7 +165,7 @@ if ($W16) {
 
 if (!$do_ssl && !$do_crypto)
        {
-       print STDERR "usage: $0 ( ssl | crypto ) [ 16 | 32 | NT ] [rsaref]\n";
+       print STDERR "usage: $0 ( ssl | crypto ) [ 16 | 32 | NT ]\n";
        exit(1);
        }
 
@@ -149,6 +175,7 @@ $max_ssl = $max_num;
 $max_crypto = $max_num;
 
 my $ssl="ssl/ssl.h";
+$ssl.=" ssl/kssl.h";
 
 my $crypto ="crypto/crypto.h";
 $crypto.=" crypto/des/des.h" unless $no_des;
@@ -164,6 +191,8 @@ $crypto.=" crypto/md5/md5.h" unless $no_md5;
 $crypto.=" crypto/mdc2/mdc2.h" unless $no_mdc2;
 $crypto.=" crypto/sha/sha.h" unless $no_sha;
 $crypto.=" crypto/ripemd/ripemd.h" unless $no_ripemd;
+$crypto.=" crypto/rijndael/rijndael.h" unless $no_aes;
+$crypto.=" crypto/rijndael/rd_fst.h" unless $no_aes;
 
 $crypto.=" crypto/bn/bn.h";
 $crypto.=" crypto/rsa/rsa.h" unless $no_rsa;
@@ -171,28 +200,31 @@ $crypto.=" crypto/dsa/dsa.h" unless $no_dsa;
 $crypto.=" crypto/dh/dh.h" unless $no_dh;
 $crypto.=" crypto/hmac/hmac.h" unless $no_hmac;
 
-$crypto.=" crypto/stack/stack.h";
-$crypto.=" crypto/buffer/buffer.h";
-$crypto.=" crypto/bio/bio.h";
-$crypto.=" crypto/dso/dso.h";
-$crypto.=" crypto/lhash/lhash.h";
+$crypto.=" crypto/engine/engine.h";
+$crypto.=" crypto/stack/stack.h" unless $no_stack;
+$crypto.=" crypto/buffer/buffer.h" unless $no_buffer;
+$crypto.=" crypto/bio/bio.h" unless $no_bio;
+$crypto.=" crypto/dso/dso.h" unless $no_dso;
+$crypto.=" crypto/lhash/lhash.h" unless $no_lhash;
 $crypto.=" crypto/conf/conf.h";
 $crypto.=" crypto/txt_db/txt_db.h";
 
-$crypto.=" crypto/evp/evp.h";
+$crypto.=" crypto/evp/evp.h" unless $no_evp;
 $crypto.=" crypto/objects/objects.h";
 $crypto.=" crypto/pem/pem.h";
 #$crypto.=" crypto/meth/meth.h";
 $crypto.=" crypto/asn1/asn1.h";
+$crypto.=" crypto/asn1/asn1t.h";
 $crypto.=" crypto/asn1/asn1_mac.h";
-$crypto.=" crypto/err/err.h";
+$crypto.=" crypto/err/err.h" unless $no_err;
 $crypto.=" crypto/pkcs7/pkcs7.h";
 $crypto.=" crypto/pkcs12/pkcs12.h";
 $crypto.=" crypto/x509/x509.h";
 $crypto.=" crypto/x509/x509_vfy.h";
 $crypto.=" crypto/x509v3/x509v3.h";
 $crypto.=" crypto/rand/rand.h";
-$crypto.=" crypto/comp/comp.h";
+$crypto.=" crypto/comp/comp.h" unless $no_comp;
+$crypto.=" crypto/ocsp/ocsp.h";
 $crypto.=" crypto/tmdiff.h";
 
 my $symhacks="crypto/symhacks.h";
@@ -229,6 +261,11 @@ if($do_crypto == 1) {
        close OUT;
 } 
 
+} elsif ($do_checkexist) {
+       &check_existing(*ssl_list, @ssl_symbols)
+               if $do_ssl == 1;
+       &check_existing(*crypto_list, @crypto_symbols)
+               if $do_crypto == 1;
 } elsif ($do_ctest || $do_ctestall) {
 
        print <<"EOF";
@@ -270,6 +307,7 @@ sub do_defs
        my %algorithm;          # For anything undefined, we assume ""
        my %rename;
        my $cpp;
+       my %unknown_algorithms = ();
 
        foreach $file (split(/\s+/,$symhacksfile." ".$files))
                {
@@ -305,16 +343,17 @@ sub do_defs
 
                        s/\/\*.*?\*\///gs;                   # ignore comments
                        s/{[^{}]*}//gs;                      # ignore {} blocks
-                       if (/^\#\s*ifndef (.*)/) {
+                       #print STDERR "DEBUG: \$_=\"$_\"\n";
+                       if (/^\#\s*ifndef\s+(.*)/) {
                                push(@tag,$1);
                                $tag{$1}=-1;
-                       } elsif (/^\#\s*if !defined\(([^\)]+)\)/) {
+                       } elsif (/^\#\s*if\s+!defined\(([^\)]+)\)/) {
                                push(@tag,$1);
                                $tag{$1}=-1;
-                       } elsif (/^\#\s*ifdef (.*)/) {
+                       } elsif (/^\#\s*ifdef\s+(.*)/) {
                                push(@tag,$1);
                                $tag{$1}=1;
-                       } elsif (/^\#\s*if defined\(([^\)]+)\)/) {
+                       } elsif (/^\#\s*if\s+defined\(([^\)]+)\)/) {
                                push(@tag,$1);
                                $tag{$1}=1;
                        } elsif (/^\#\s*error\s+(\w+) is disabled\./) {
@@ -322,12 +361,24 @@ sub do_defs
                                        $tag{$tag[$#tag]}=2;
                                }
                        } elsif (/^\#\s*endif/) {
+                               my $oldtag=$tag[$#tag];
+                               #print STDERR "DEBUG: \$oldtag=\"$oldtag\"\n";
                                if ($tag{$tag[$#tag]}==2) {
                                        $tag{$tag[$#tag]}=-1;
                                } else {
                                        $tag{$tag[$#tag]}=0;
                                }
                                pop(@tag);
+                               if ($oldtag =~ /^NO_([A-Z0-9_]+)$/) {
+                                       $oldtag=$1;
+                               } else {
+                                       $oldtag="";
+                               }
+                               if ($oldtag ne ""
+                                   && !grep(/^$oldtag$/, @known_algorithms)) {
+                                       $unknown_algorithms{$oldtag} = 1;
+                                       #print STDERR "DEBUG: Added as unknown algorithm: $oldtag\n";
+                               }
                        } elsif (/^\#\s*else/) {
                                my $t=$tag[$#tag];
                                $tag{$t}= -$tag{$t};
@@ -362,6 +413,46 @@ sub do_defs
                        }
                        if (/^\s*DECLARE_STACK_OF\s*\(\s*(\w*)\s*\)/) {
                                next;
+                       } elsif (/^\s*DECLARE_ASN1_ENCODE_FUNCTIONS\s*\(\s*(\w*)\s*,\s*(\w*)\s*,\s*(\w*)\s*\)/) {
+                               $syms{"d2i_$3"} = 1;
+                               $syms{"i2d_$3"} = 1;
+                               $syms{"$2_it"} = 1;
+                               $kind{"$2_it"} = "VARIABLE";
+                               next;
+                       } elsif (/^\s*DECLARE_ASN1_FUNCTIONS_fname\s*\(\s*(\w*)\s*,\s*(\w*)\s*,\s*(\w*)\s*\)/) {
+                               $syms{"d2i_$3"} = 1;
+                               $syms{"i2d_$3"} = 1;
+                               $syms{"$3_new"} = 1;
+                               $syms{"$3_free"} = 1;
+                               $syms{"$2_it"} = 1;
+                               $kind{"$2_it"} = "VARIABLE";
+                       } elsif (/^\s*DECLARE_ASN1_FUNCTIONS\s*\(\s*(\w*)\s*\)/ ||
+                               /^\s*DECLARE_ASN1_FUNCTIONS_const\s*\(\s*(\w*)\s*\)/) {
+                               $syms{"d2i_$1"} = 1;
+                               $syms{"i2d_$1"} = 1;
+                               $syms{"$1_new"} = 1;
+                               $syms{"$1_free"} = 1;
+                               $syms{"$1_it"} = 1;
+                               $kind{"$1_it"} = "VARIABLE";
+                               next;
+                       } elsif (/^\s*DECLARE_ASN1_ENCODE_FUNCTIONS_const\s*\(\s*(\w*)\s*,\s*(\w*)\s*\)/) {
+                               $syms{"d2i_$2"} = 1;
+                               $syms{"i2d_$2"} = 1;
+                               $syms{"$2_it"} = 1;
+                               $kind{"$2_it"} = "VARIABLE";
+                               next;
+                       } elsif (/^\s*DECLARE_ASN1_FUNCTIONS_name\s*\(\s*(\w*)\s*,\s*(\w*)\s*\)/) {
+                               $syms{"d2i_$2"} = 1;
+                               $syms{"i2d_$2"} = 1;
+                               $syms{"$2_new"} = 1;
+                               $syms{"$2_free"} = 1;
+                               $syms{"$2_it"} = 1;
+                               $kind{"$2_it"} = "VARIABLE";
+                               next;
+                       } elsif (/^\s*DECLARE_ASN1_ITEM\s*\(\s*(\w*)\s*,(\w*)\s*\)/) {
+                               $syms{"$1_it"} = 1;
+                               $kind{"$1_it"} = "VARIABLE";
+                               next;
                        } elsif (/^\s*DECLARE_PKCS12_STACK_OF\s*\(\s*(\w*)\s*\)/) {
                                next;
                        } elsif (/^\s*DECLARE_ASN1_SET_OF\s*\(\s*(\w*)\s*\)/) {
@@ -543,14 +634,15 @@ sub do_defs
 
        # Info we know about
 
-       $platform{"RSA_PKCS1_RSAref"} = "RSAREF";
-       $algorithm{"RSA_PKCS1_RSAref"} = "RSA";
-
        push @ret, map { $_."\\".&info_string($_,"EXIST",
                                              $platform{$_},
                                              $kind{$_},
                                              $algorithm{$_}) } keys %syms;
 
+       if (keys %unknown_algorithms) {
+               print STDERR "WARNING: mkdef.pl doesn't know the following algorithms:\n";
+               print STDERR "\t",join("\n\t",keys %unknown_algorithms),"\n";
+       }
        return(@ret);
 }
 
@@ -598,6 +690,7 @@ sub maybe_add_info {
        (my $name, *nums, my @symbols) = @_;
        my $sym;
        my $new_info = 0;
+       my %syms=();
 
        print STDERR "Updating $name info\n";
        foreach $sym (@symbols) {
@@ -611,9 +704,22 @@ sub maybe_add_info {
                                #print STDERR "DEBUG: maybe_add_info for $s: \"$dummy\" => \"$i\"\n";
                        }
                }
+               $syms{sym} = 1;
+       }
+
+       my @s=sort { &parse_number($nums{$a},"n") <=> &parse_number($nums{$b},"n") } keys %nums;
+       foreach $sym (@s) {
+               (my $n, my $i) = split /\\/, $nums{$sym};
+               if (!defined($syms{sym})) {
+                       $new_info++;
+                       #print STDERR "DEBUG: maybe_add_info for $sym: -> undefined\n";
+               }
        }
        if ($new_info) {
                print STDERR "$new_info old symbols got an info update\n";
+               if (!$do_rewrite) {
+                       print STDERR "You should do a rewrite to fix this.\n";
+               }
        } else {
                print STDERR "No old symbols needed info update\n";
        }
@@ -647,7 +753,7 @@ sub print_test_file
 sub print_def_file
 {
        (*OUT,my $name,*nums,my @symbols)=@_;
-       my $n = 1; my @e; my @r;
+       my $n = 1; my @e; my @r; my @v;
 
        if ($W32)
                { $name.="32"; }
@@ -682,25 +788,80 @@ EOF
 
        (@e)=grep(/^SSLeay\\.*?:.*?:FUNCTION/,@symbols);
        (@r)=grep(/^\w+\\.*?:.*?:FUNCTION/ && !/^SSLeay\\.*?:.*?:FUNCTION/,@symbols);
-       @symbols=((sort @e),(sort @r));
+       (@v)=grep(/^\w+\\.*?:.*?:VARIABLE/,@symbols);
+       @symbols=((sort @e),(sort @r), (sort @v));
 
 
        foreach $sym (@symbols) {
                (my $s, my $i) = $sym =~ /^(.*?)\\(.*)$/;
+               my $v = 0;
+               $v = 1 if $sym=~ /^\w+\\.*?:.*?:VARIABLE/;
                if (!defined($nums{$s})) {
                        printf STDERR "Warning: $s does not have a number assigned\n"
                                        if(!$do_update);
                } else {
                        (my $n, my $i) = split /\\/, $nums{$s};
-                       my @p = split(/,/, ($i =~ /^.*?:(.*?):/,$1));
+                       my %pf = ();
+                       my @p = split(/,/, ($i =~ /^[^:]*:([^:]*):/,$1));
+                       my @a = split(/,/, ($i =~ /^[^:]*:[^:]*:[^:]*:([^:]*)/,$1));
+                       # @p_purged must contain hardware platforms only
+                       my @p_purged = ();
+                       foreach $ptmp (@p) {
+                               push @p_purged, $ptmp;
+                       }
+                       my $negatives = !!grep(/^!/,@p);
                        # It is very important to check NT before W32
-                       if (($NT && (!@p || (grep(/^WINNT$/,@p)
-                                            || !grep(/^!WINNT$/,@p))))
-                           || ($W32 && (!@p || (grep(/^WIN32$/,@p)
-                                                || !grep(/^!WIN32$/,@p))))
-                           || ($W16 && (!@p || (grep(/^WIN16$/,@p)
-                                                || !grep(/^!WIN16$/,@p))))) {
-                               printf OUT "    %s%-40s@%d\n",($W32)?"":"_",$s,$n;
+                       if ((($NT && (!@p_purged
+                                     || (!$negatives && grep(/^WINNT$/,@p))
+                                     || ($negatives && !grep(/^!WINNT$/,@p))))
+                            || ($W32 && (!@p_purged
+                                         || (!$negatives && grep(/^WIN32$/,@p))
+                                         || ($negatives && !grep(/^!WIN32$/,@p))))
+                            || ($W16 && (!@p_purged
+                                         || (!$negatives && grep(/^WIN16$/,@p))
+                                         || ($negatives && !grep(/^!WIN16$/,@p)))))
+                           && (!@a || (!$no_rc2 || !grep(/^RC2$/,@a)))
+                           && (!@a || (!$no_rc4 || !grep(/^RC4$/,@a)))
+                           && (!@a || (!$no_rc5 || !grep(/^RC5$/,@a)))
+                           && (!@a || (!$no_idea || !grep(/^IDEA$/,@a)))
+                           && (!@a || (!$no_des || !grep(/^DES$/,@a)))
+                           && (!@a || (!$no_bf || !grep(/^BF$/,@a)))
+                           && (!@a || (!$no_cast || !grep(/^CAST$/,@a)))
+                           && (!@a || (!$no_md2 || !grep(/^MD2$/,@a)))
+                           && (!@a || (!$no_md4 || !grep(/^MD4$/,@a)))
+                           && (!@a || (!$no_md5 || !grep(/^MD5$/,@a)))
+                           && (!@a || (!$no_sha || !grep(/^SHA$/,@a)))
+                           && (!@a || (!$no_ripemd || !grep(/^RIPEMD$/,@a)))
+                           && (!@a || (!$no_mdc2 || !grep(/^MDC2$/,@a)))
+                           && (!@a || (!$no_rsa || !grep(/^RSA$/,@a)))
+                           && (!@a || (!$no_dsa || !grep(/^DSA$/,@a)))
+                           && (!@a || (!$no_dh || !grep(/^DH$/,@a)))
+                           && (!@a || (!$no_hmac || !grep(/^HMAC$/,@a)))
+                           && (!@a || (!$no_aes || !grep(/^AES$/,@a)))
+                           && (!@a || (!$no_fp_api || !grep(/^FP_API$/,@a)))
+                           ) {
+                               if($v) {
+                                       printf OUT "    %s%-40s@%-8d DATA\n",($W32)?"":"_",$s,$n;
+                               } else {
+                                       printf OUT "    %s%-40s@%d\n",($W32)?"":"_",$s,$n;
+                               }
+#                      } else {
+#                              print STDERR "DEBUG: \"$sym\" (@p):",
+#                              " rsaref:", !!(!@p
+#                                             || (!$negatives
+#                                                 && ($rsaref || !grep(/^RSAREF$/,@p)))
+#                                             || ($negatives
+#                                                 && (!$rsaref || !grep(/^!RSAREF$/,@p))))?1:0,
+#                              " 16:", !!($W16 && (!@p_purged
+#                                                  || (!$negatives && grep(/^WIN16$/,@p))
+#                                                  || ($negatives && !grep(/^!WIN16$/,@p)))),
+#                              " 32:", !!($W32 && (!@p_purged
+#                                                  || (!$negatives && grep(/^WIN32$/,@p))
+#                                                  || ($negatives && !grep(/^!WIN32$/,@p)))),
+#                              " NT:", !!($NT && (!@p_purged
+#                                                 || (!$negatives && grep(/^WINNT$/,@p))
+#                                                 || ($negatives && !grep(/^!WINNT$/,@p)))),
+#                              "\n";
                        }
                }
        }
@@ -782,12 +943,19 @@ sub rewrite_numbers
                $rsyms{$s} = 1;
        }
 
+       my %syms = ();
+       foreach $_ (@symbols) {
+               (my $n, my $i) = split /\\/;
+               $syms{$n} = 1;
+       }
+
        my @s=sort { &parse_number($nums{$a},"n") <=> &parse_number($nums{$b},"n") } keys %nums;
        foreach $sym (@s) {
                (my $n, my $i) = split /\\/, $nums{$sym};
                next if defined($i) && $i =~ /^.*?:.*?:\w+\(\w+\)/;
                next if defined($rsyms{$sym});
-               $i="NOEXIST::FUNCTION:" if !defined($i) || $i eq "";
+               $i="NOEXIST::FUNCTION:"
+                       if !defined($i) || $i eq "" || !defined($syms{$sym});
                printf OUT "%s%-40s%d\t%s\n","",$sym,$n,$i;
                if (exists $r{$sym}) {
                        (my $s, $i) = split /\\/,$r{$sym};
@@ -823,7 +991,7 @@ sub update_numbers
                        $new_syms++;
                        printf OUT "%s%-40s%d\t%s\n","",$s, ++$start_num,$i;
                        if (exists $r{$s}) {
-                               ($s, $i) = split /\\/,$r{$sym};
+                               ($s, $i) = split /\\/,$r{$s};
                                printf OUT "%s%-40s%d\t%s\n","",$s, $start_num,$i;
                        }
                }