Add -rsigopt option to ocsp command
[openssl.git] / util / mkdef.pl
index dc39be42b83540278a426d4d1cda4fcbbc11f42a..98cdae537c45cbdbc64b9f9b4cac43e58919c480 100755 (executable)
@@ -1,5 +1,5 @@
 #! /usr/bin/env perl
-# Copyright 1995-2017 The OpenSSL Project Authors. All Rights Reserved.
+# Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
 #
 # Licensed under the OpenSSL license (the "License").  You may not use
 # this file except in compliance with the License.  You can obtain a copy
@@ -36,7 +36,7 @@
 #   The semantics for the platforms is that every item is checked against the
 #   environment.  For the negative items ("!FOO"), if any of them is false
 #   (i.e. "FOO" is true) in the environment, the corresponding symbol can't be
-#   used.  For the positive itms, if all of them are false in the environment,
+#   used.  For the positive items, if all of them are false in the environment,
 #   the corresponding symbol can't be used.  Any combination of positive and
 #   negative items are possible, and of course leave room for some redundancy.
 # - "kind" is "FUNCTION" or "VARIABLE".  The meaning of that is obvious.
@@ -49,9 +49,65 @@ use lib ".";
 use configdata;
 use File::Spec::Functions;
 use File::Basename;
-use if $^O ne "VMS", 'File::Glob' => qw/glob/;
+use FindBin;
+use lib "$FindBin::Bin/perl";
+use OpenSSL::Glob;
+
+# When building a "variant" shared library, with a custom SONAME, also customize
+# all the symbol versions.  This produces a shared object that can coexist
+# without conflict in the same address space as a default build, or an object
+# with a different variant tag.
+#
+# For example, with a target definition that includes:
+#
+#         shlib_variant => "-opt",
+#
+# we build the following objects:
+#
+# $ perl -le '
+#     for (@ARGV) {
+#         if ($l = readlink) {
+#             printf "%s -> %s\n", $_, $l
+#         } else {
+#             print
+#         }
+#     }' *.so*
+# libcrypto-opt.so.1.1
+# libcrypto.so -> libcrypto-opt.so.1.1
+# libssl-opt.so.1.1
+# libssl.so -> libssl-opt.so.1.1
+#
+# whose SONAMEs and dependencies are:
+#
+# $ for l in *.so; do
+#     echo $l
+#     readelf -d $l | egrep 'SONAME|NEEDED.*(ssl|crypto)'
+#   done
+# libcrypto.so
+#  0x000000000000000e (SONAME)             Library soname: [libcrypto-opt.so.1.1]
+# libssl.so
+#  0x0000000000000001 (NEEDED)             Shared library: [libcrypto-opt.so.1.1]
+#  0x000000000000000e (SONAME)             Library soname: [libssl-opt.so.1.1]
+#
+# We case-fold the variant tag to upper case and replace all non-alnum
+# characters with "_".  This yields the following symbol versions:
+#
+# $ nm libcrypto.so | grep -w A
+# 0000000000000000 A OPENSSL_OPT_1_1_0
+# 0000000000000000 A OPENSSL_OPT_1_1_0a
+# 0000000000000000 A OPENSSL_OPT_1_1_0c
+# 0000000000000000 A OPENSSL_OPT_1_1_0d
+# 0000000000000000 A OPENSSL_OPT_1_1_0f
+# 0000000000000000 A OPENSSL_OPT_1_1_0g
+# $ nm libssl.so | grep -w A
+# 0000000000000000 A OPENSSL_OPT_1_1_0
+# 0000000000000000 A OPENSSL_OPT_1_1_0d
+#
+(my $SO_VARIANT = qq{\U$target{"shlib_variant"}}) =~ s/\W/_/g;
 
 my $debug=0;
+my $trace=0;
+my $verbose=0;
 
 my $crypto_num= catfile($config{sourcedir},"util","libcrypto.num");
 my $ssl_num=    catfile($config{sourcedir},"util","libssl.num");
@@ -81,9 +137,9 @@ my @known_algorithms = ( "RC2", "RC4", "RC5", "IDEA", "DES", "BF",
                         "CAST", "MD2", "MD4", "MD5", "SHA", "SHA0", "SHA1",
                         "SHA256", "SHA512", "RMD160",
                         "MDC2", "WHIRLPOOL", "RSA", "DSA", "DH", "EC", "EC2M",
-                        "HMAC", "AES", "CAMELLIA", "SEED", "GOST", "ARIA",
+                        "HMAC", "AES", "CAMELLIA", "SEED", "GOST", "ARIA", "SM4",
                          "SCRYPT", "CHACHA", "POLY1305", "BLAKE2",
-                        "SIPHASH",
+                        "SIPHASH", "SM3",
                         # EC_NISTP_64_GCC_128
                         "EC_NISTP_64_GCC_128",
                         # Envelope "algorithms"
@@ -127,7 +183,7 @@ my @known_algorithms = ( "RC2", "RC4", "RC5", "IDEA", "DES", "BF",
                         # Unit testing
                         "UNIT_TEST",
                         # User Interface
-                        "UI",
+                        "UI_CONSOLE",
                         #
                         "TS",
                         # OCB mode
@@ -158,6 +214,8 @@ my $zlib;
 foreach (@ARGV, split(/ /, $config{options}))
        {
        $debug=1 if $_ eq "debug";
+       $trace=1 if $_ eq "trace";
+       $verbose=1 if $_ eq "verbose";
        $W32=1 if $_ eq "32";
        die "win16 not supported" if $_ eq "16";
        if($_ eq "NT") {
@@ -174,16 +232,9 @@ foreach (@ARGV, split(/ /, $config{options}))
                $zlib = 1;
        }
 
-       $do_ssl=1 if $_ eq "libssl";
-       if ($_ eq "ssl") {
-               $do_ssl=1;
-               $libname=$_
-       }
-       $do_crypto=1 if $_ eq "libcrypto";
-       if ($_ eq "crypto") {
-               $do_crypto=1;
-               $libname=$_;
-       }
+       $do_crypto=1 if $_ eq "libcrypto" || $_ eq "crypto";
+       $do_ssl=1 if $_ eq "libssl" || $_ eq "ssl";
+
        $do_update=1 if $_ eq "update";
        $do_rewrite=1 if $_ eq "rewrite";
        $do_ctest=1 if $_ eq "ctest";
@@ -198,6 +249,8 @@ foreach (@ARGV, split(/ /, $config{options}))
        }
 
        }
+$libname = $unified_info{sharednames}->{libcrypto} if $do_crypto;
+$libname = $unified_info{sharednames}->{libssl} if $do_ssl;
 
 if (!$libname) {
        if ($do_ssl) {
@@ -246,6 +299,7 @@ my $crypto ="include/internal/dso.h";
 $crypto.=" include/internal/o_dir.h";
 $crypto.=" include/internal/o_str.h";
 $crypto.=" include/internal/err.h";
+$crypto.=" include/internal/rand.h";
 foreach my $f ( glob(catfile($config{sourcedir},'include/openssl/*.h')) ) {
     my $fn = "include/openssl/" . lc(basename($f));
     $crypto .= " $fn" if !defined $skipthese{$fn} && $f !~ m@/[a-z]+err\.h$@;
@@ -339,6 +393,7 @@ sub do_defs
                {
                my $fn = catfile($config{sourcedir},$file);
                print STDERR "DEBUG: starting on $fn:\n" if $debug;
+               print STDERR "TRACE: start reading $fn\n" if $trace;
                open(IN,"<$fn") || die "Can't open $fn, $!,";
                my $line = "", my $def= "";
                my %tag = (
@@ -409,10 +464,10 @@ sub do_defs
 
                print STDERR "DEBUG: parsing ----------\n" if $debug;
                while(<IN>) {
+                       s|\R$||; # Better chomp
                        if($parens > 0) {
                                #Inside a DEPRECATEDIN
                                $stored_multiline .= $_;
-                               $stored_multiline =~ s|\R$||; # Better chomp
                                print STDERR "DEBUG: Continuing multiline DEPRECATEDIN: $stored_multiline\n" if $debug;
                                $parens = count_parens($stored_multiline);
                                if ($parens == 0) {
@@ -438,7 +493,7 @@ sub do_defs
                        }
 
                        if(/\/\*/) {
-                               if (not /\*\//) {       # multiline comment...
+                               if (not /\*\//) {       # multi-line comment...
                                        $line = $_;     # ... just accumulate
                                        next;
                                } else {
@@ -479,19 +534,19 @@ sub do_defs
                                push(@tag,$1);
                                $tag{$1}=-1;
                                print STDERR "DEBUG: $file: found tag $1 = -1\n" if $debug;
-                       } elsif (/^\#\s*if\s+!defined\(([^\)]+)\)/) {
+                       } elsif (/^\#\s*if\s+!defined\s*\(([^\)]+)\)/) {
                                push(@tag,"-");
-                               if (/^\#\s*if\s+(!defined\(([^\)]+)\)(\s+\&\&\s+!defined\(([^\)]+)\))*)$/) {
+                               if (/^\#\s*if\s+(!defined\s*\(([^\)]+)\)(\s+\&\&\s+!defined\s*\(([^\)]+)\))*)$/) {
                                        my $tmp_1 = $1;
                                        my $tmp_;
                                        foreach $tmp_ (split '\&\&',$tmp_1) {
-                                               $tmp_ =~ /!defined\(([^\)]+)\)/;
+                                               $tmp_ =~ /!defined\s*\(([^\)]+)\)/;
                                                print STDERR "DEBUG: $file: found tag $1 = -1\n" if $debug;
                                                push(@tag,$1);
                                                $tag{$1}=-1;
                                        }
                                } else {
-                                       print STDERR "Warning: $file: complicated expression: $_" if $debug; # because it is O...
+                                       print STDERR "Warning: $file: taking only '!defined($1)' of complicated expression: $_" if $verbose; # because it is O...
                                        print STDERR "DEBUG: $file: found tag $1 = -1\n" if $debug;
                                        push(@tag,$1);
                                        $tag{$1}=-1;
@@ -501,19 +556,19 @@ sub do_defs
                                push(@tag,$1);
                                $tag{$1}=1;
                                print STDERR "DEBUG: $file: found tag $1 = 1\n" if $debug;
-                       } elsif (/^\#\s*if\s+defined\(([^\)]+)\)/) {
+                       } elsif (/^\#\s*if\s+defined\s*\(([^\)]+)\)/) {
                                push(@tag,"-");
-                               if (/^\#\s*if\s+(defined\(([^\)]+)\)(\s+\|\|\s+defined\(([^\)]+)\))*)$/) {
+                               if (/^\#\s*if\s+(defined\s*\(([^\)]+)\)(\s+\|\|\s+defined\s*\(([^\)]+)\))*)$/) {
                                        my $tmp_1 = $1;
                                        my $tmp_;
                                        foreach $tmp_ (split '\|\|',$tmp_1) {
-                                               $tmp_ =~ /defined\(([^\)]+)\)/;
+                                               $tmp_ =~ /defined\s*\(([^\)]+)\)/;
                                                print STDERR "DEBUG: $file: found tag $1 = 1\n" if $debug;
                                                push(@tag,$1);
                                                $tag{$1}=1;
                                        }
                                } else {
-                                       print STDERR "Warning: $file: complicated expression: $_\n" if $debug; # because it is O...
+                                       print STDERR "Warning: $file: taking only 'defined($1)' of complicated expression: $_\n" if $verbose; # because it is O...
                                        print STDERR "DEBUG: $file: found tag $1 = 1\n" if $debug;
                                        push(@tag,$1);
                                        $tag{$1}=1;
@@ -523,7 +578,7 @@ sub do_defs
                                while($tag[$tag_i] ne "-") {
                                        if ($tag[$tag_i] eq "OPENSSL_NO_".$1) {
                                                $tag{$tag[$tag_i]}=2;
-                                               print STDERR "DEBUG: $file: chaged tag $1 = 2\n" if $debug;
+                                               print STDERR "DEBUG: $file: changed tag $1 = 2\n" if $debug;
                                        }
                                        $tag_i--;
                                }
@@ -578,6 +633,7 @@ sub do_defs
                        } elsif (/^\#\s*if\s+/) {
                                #Some other unrecognized "if" style
                                push(@tag,"-");
+                               print STDERR "Warning: $file: ignoring unrecognized expression: $_\n" if $verbose; # because it is O...
                        } elsif (/^\#\s*define\s+(\w+)\s+(\w+)/
                                 && $symhacking && $tag{'TRUE'} != -1) {
                                # This is for aliasing.  When we find an alias,
@@ -622,7 +678,7 @@ sub do_defs
                                        $def .= "int d2i_$3(void);";
                                        $def .= "int i2d_$3(void);";
                                        # Variant for platforms that do not
-                                       # have to access globale variables
+                                       # have to access global variables
                                        # in shared libraries through functions
                                        $def .=
                                            "#INFO:"
@@ -634,7 +690,7 @@ sub do_defs
                                                .join(',',@current_platforms).":"
                                                    .join(',',@current_algorithms).";";
                                        # Variant for platforms that have to
-                                       # access globale variables in shared
+                                       # access global variables in shared
                                        # libraries through functions
                                        &$make_variant("$2_it","$2_it",
                                                      "EXPORT_VAR_AS_FUNCTION",
@@ -646,7 +702,7 @@ sub do_defs
                                        $def .= "int $3_free(void);";
                                        $def .= "int $3_new(void);";
                                        # Variant for platforms that do not
-                                       # have to access globale variables
+                                       # have to access global variables
                                        # in shared libraries through functions
                                        $def .=
                                            "#INFO:"
@@ -658,7 +714,7 @@ sub do_defs
                                                .join(',',@current_platforms).":"
                                                    .join(',',@current_algorithms).";";
                                        # Variant for platforms that have to
-                                       # access globale variables in shared
+                                       # access global variables in shared
                                        # libraries through functions
                                        &$make_variant("$2_it","$2_it",
                                                      "EXPORT_VAR_AS_FUNCTION",
@@ -671,7 +727,7 @@ sub do_defs
                                        $def .= "int $1_free(void);";
                                        $def .= "int $1_new(void);";
                                        # Variant for platforms that do not
-                                       # have to access globale variables
+                                       # have to access global variables
                                        # in shared libraries through functions
                                        $def .=
                                            "#INFO:"
@@ -683,7 +739,7 @@ sub do_defs
                                                .join(',',@current_platforms).":"
                                                    .join(',',@current_algorithms).";";
                                        # Variant for platforms that have to
-                                       # access globale variables in shared
+                                       # access global variables in shared
                                        # libraries through functions
                                        &$make_variant("$1_it","$1_it",
                                                      "EXPORT_VAR_AS_FUNCTION",
@@ -693,7 +749,7 @@ sub do_defs
                                        $def .= "int d2i_$2(void);";
                                        $def .= "int i2d_$2(void);";
                                        # Variant for platforms that do not
-                                       # have to access globale variables
+                                       # have to access global variables
                                        # in shared libraries through functions
                                        $def .=
                                            "#INFO:"
@@ -705,7 +761,7 @@ sub do_defs
                                                .join(',',@current_platforms).":"
                                                    .join(',',@current_algorithms).";";
                                        # Variant for platforms that have to
-                                       # access globale variables in shared
+                                       # access global variables in shared
                                        # libraries through functions
                                        &$make_variant("$2_it","$2_it",
                                                      "EXPORT_VAR_AS_FUNCTION",
@@ -721,7 +777,7 @@ sub do_defs
                                        $def .= "int $2_free(void);";
                                        $def .= "int $2_new(void);";
                                        # Variant for platforms that do not
-                                       # have to access globale variables
+                                       # have to access global variables
                                        # in shared libraries through functions
                                        $def .=
                                            "#INFO:"
@@ -733,7 +789,7 @@ sub do_defs
                                                .join(',',@current_platforms).":"
                                                    .join(',',@current_algorithms).";";
                                        # Variant for platforms that have to
-                                       # access globale variables in shared
+                                       # access global variables in shared
                                        # libraries through functions
                                        &$make_variant("$2_it","$2_it",
                                                      "EXPORT_VAR_AS_FUNCTION",
@@ -741,7 +797,7 @@ sub do_defs
                                        next;
                                } elsif (/^\s*DECLARE_ASN1_ITEM\s*\(\s*(\w*)\s*\)/) {
                                        # Variant for platforms that do not
-                                       # have to access globale variables
+                                       # have to access global variables
                                        # in shared libraries through functions
                                        $def .=
                                            "#INFO:"
@@ -753,7 +809,7 @@ sub do_defs
                                                .join(',',@current_platforms).":"
                                                    .join(',',@current_algorithms).";";
                                        # Variant for platforms that have to
-                                       # access globale variables in shared
+                                       # access global variables in shared
                                        # libraries through functions
                                        &$make_variant("$1_it","$1_it",
                                                      "EXPORT_VAR_AS_FUNCTION",
@@ -819,7 +875,7 @@ sub do_defs
                                        next;
                                } elsif (/^OPENSSL_DECLARE_GLOBAL\s*\(\s*(\w*)\s*,\s*(\w*)\s*\)/) {
                                        # Variant for platforms that do not
-                                       # have to access globale variables
+                                       # have to access global variables
                                        # in shared libraries through functions
                                        $def .=
                                            "#INFO:"
@@ -831,7 +887,7 @@ sub do_defs
                                                .join(',',@current_platforms).":"
                                                    .join(',',@current_algorithms).";";
                                        # Variant for platforms that have to
-                                       # access globale variables in shared
+                                       # access global variables in shared
                                        # libraries through functions
                                        &$make_variant("_shadow_$2","_shadow_$2",
                                                      "EXPORT_VAR_AS_FUNCTION",
@@ -844,7 +900,6 @@ sub do_defs
                                                        \@current_algorithms);
                                        } else {
                                                $stored_multiline = $_;
-                                               $stored_multiline =~ s|\R$||;
                                                print STDERR "DEBUG: Found multiline DEPRECATEDIN starting with: $stored_multiline\n" if $debug;
                                                next;
                                        }
@@ -872,11 +927,13 @@ sub do_defs
                        next if(/typedef\W/);
                        next if(/\#define/);
 
+                       print STDERR "TRACE: processing $_\n" if $trace && !/^\#INFO:/;
                        # Reduce argument lists to empty ()
                        # fold round brackets recursively: (t(*v)(t),t) -> (t{}{},t) -> {}
-                       while(/\(.*\)/s) {
-                               s/\([^\(\)]+\)/\{\}/gs;
-                               s/\(\s*\*\s*(\w+)\s*\{\}\s*\)/$1/gs;    #(*f{}) -> f
+                       my $nsubst = 1; # prevent infinite loop, e.g., on  int fn()
+                       while($nsubst && /\(.*\)/s) {
+                               $nsubst = s/\([^\(\)]+\)/\{\}/gs;
+                               $nsubst+= s/\(\s*\*\s*(\w+)\s*\{\}\s*\)/$1/gs;  #(*f{}) -> f
                        }
                        # pretend as we didn't use curly braces: {} -> ()
                        s/\{\}/\(\)/gs;
@@ -1156,9 +1213,6 @@ sub print_def_file
         my $prevnum = 0;
         my $symvtextcount = 0;
 
-       if ($W32)
-               { $libname.="32"; }
-
         if ($W32)
                 {
                 print OUT <<"EOF";
@@ -1175,6 +1229,7 @@ EOF
         elsif ($VMS)
                 {
                 print OUT <<"EOF";
+IDENTIFICATION=$version
 CASE_SENSITIVE=YES
 SYMBOL_VECTOR=(-
 EOF
@@ -1213,7 +1268,6 @@ EOF
                                        if(!$do_update);
                        } else {
                                (my $n, my $symversion, my $dummy) = split /\\/, $nums{$s};
-                               next if $symversion ne $thisversion;
                                my %pf = ();
                                my $p = ($i =~ /^[^:]*:([^:]*):/,$1);
                                my $a = ($i =~ /^[^:]*:[^:]*:[^:]*:([^:]*)/,$1);
@@ -1226,16 +1280,17 @@ EOF
                                        }
                                        $prev = $s2;    # To warn about duplicates...
                                        if($linux) {
+                                               next if $symversion ne $thisversion;
                                                if ($symversion ne $prevsymversion) {
                                                        if ($prevsymversion ne "") {
                                                                if ($prevprevsymversion ne "") {
-                                                                       print OUT "} OPENSSL_"
+                                                                       print OUT "} OPENSSL${SO_VARIANT}_"
                                                                                                ."$prevprevsymversion;\n\n";
                                                                } else {
                                                                        print OUT "};\n\n";
                                                                }
                                                        }
-                                                       print OUT "OPENSSL_$symversion {\n    global:\n";
+                                                       print OUT "OPENSSL${SO_VARIANT}_$symversion {\n    global:\n";
                                                        $prevprevsymversion = $prevsymversion;
                                                        $prevsymversion = $symversion;
                                                }
@@ -1281,10 +1336,10 @@ EOF
                                }
                        }
                }
-       } while ($thisversion ne $currversion);
+       } while ($linux && $thisversion ne $currversion);
        if ($linux) {
                if ($prevprevsymversion ne "") {
-                       print OUT "    local: *;\n} OPENSSL_$prevprevsymversion;\n\n";
+                       print OUT "    local: *;\n} OPENSSL${SO_VARIANT}_$prevprevsymversion;\n\n";
                } else {
                        print OUT "    local: *;\n};\n\n";
                }
@@ -1353,9 +1408,9 @@ sub load_numbers
                $prev=$a[0];
        }
        if ($num_noinfo) {
-               print STDERR "Warning: $num_noinfo symbols were without info.";
+               print STDERR "Warning: $num_noinfo symbols were without info." if $verbose || !$do_rewrite;
                if ($do_rewrite) {
-                       printf STDERR "  The rewrite will fix this.\n";
+                       printf STDERR "  The rewrite will fix this.\n" if $verbose;
                } else {
                        printf STDERR "  You should do a rewrite to fix this.\n";
                }
@@ -1630,7 +1685,7 @@ sub do_deprecated()
 {
        my ($decl, $plats, $algs) = @_;
        $decl =~ /^\s*(DEPRECATEDIN_\d+_\d+_\d+)\s*\((.*)\)\s*$/
-            or die "Bad DEPRECTEDIN: $decl\n";
+            or die "Bad DEPRECATEDIN: $decl\n";
        my $info1 .= "#INFO:";
        $info1 .= join(',', @{$plats}) . ":";
        my $info2 = $info1;