Update the TLSv1.3 draft version indicators to draft 22
[openssl.git] / util / mkdef.pl
index 41992f57c27c8eac1ca33a301ad169a6b08f62c9..828ddc0f156fd66dcfde9744ce94b8daf773e709 100755 (executable)
@@ -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.
 use lib ".";
 use configdata;
 use File::Spec::Functions;
+use File::Basename;
+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;
 
@@ -66,6 +122,7 @@ my $do_checkexist = 0;
 my $VMS=0;
 my $W32=0;
 my $NT=0;
+my $UNIX=0;
 my $linux=0;
 # Set this to make typesafe STACK definitions appear in DEF
 my $safe_stack_def = 0;
@@ -73,14 +130,14 @@ my $safe_stack_def = 0;
 my @known_platforms = ( "__FreeBSD__", "PERL5",
                        "EXPORT_VAR_AS_FUNCTION", "ZLIB", "_WIN32"
                        );
-my @known_ossl_platforms = ( "VMS", "WIN32", "WINNT", "OS2" );
+my @known_ossl_platforms = ( "UNIX", "VMS", "WIN32", "WINNT", "OS2" );
 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"
@@ -124,7 +181,7 @@ my @known_algorithms = ( "RC2", "RC4", "RC5", "IDEA", "DES", "BF",
                         # Unit testing
                         "UNIT_TEST",
                         # User Interface
-                        "UI",
+                        "UI_CONSOLE",
                         #
                         "TS",
                         # OCB mode
@@ -142,6 +199,14 @@ foreach (@known_algorithms) {
 # disabled by default
 $disabled_algorithms{"STATIC_ENGINE"} = 1;
 
+my $apiv = sprintf "%x%02x%02x", split(/\./, $config{api});
+foreach (keys %disabled_algorithms) {
+       if (/^DEPRECATEDIN_(\d+)_(\d+)_(\d+)$/) {
+               my $depv = sprintf "%x%02x%02x", $1, $2, $3;
+               $disabled_algorithms{$_} = 1 if $apiv ge $depv;
+       }
+}
+
 my $zlib;
 
 foreach (@ARGV, split(/ /, $config{options}))
@@ -155,6 +220,7 @@ foreach (@ARGV, split(/ /, $config{options}))
        }
        if ($_ eq "linux") {
                $linux=1;
+               $UNIX=1;
        }
        $VMS=1 if $_ eq "VMS";
        if ($_ eq "zlib" || $_ eq "enable-zlib" || $_ eq "zlib-dynamic"
@@ -162,46 +228,25 @@ 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";
        $do_ctestall=1 if $_ eq "ctestall";
        $do_checkexist=1 if $_ eq "exist";
-       if (/^--api=(\d+)\.(\d+)\.(\d+)$/) {
-               my $apiv = sprintf "%x%02x%02x", $1, $2, $3;
-               foreach (keys %disabled_algorithms) {
-                       if (/^DEPRECATEDIN_(\d+)_(\d+)_(\d+)$/) {
-                               my $depv = sprintf "%x%02x%02x", $1, $2, $3;
-                               $disabled_algorithms{$_} = 1 if $apiv ge $depv;
-                       }
-               }
-       }
-       if (/^no-deprecated$/) {
-               foreach (keys %disabled_algorithms) {
-                       if (/^DEPRECATEDIN_/) {
-                               $disabled_algorithms{$_} = 1;
-                       }
-               }
-       }
-       elsif (/^(enable|disable|no)-(.*)$/) {
+       if (/^(enable|disable|no)-(.*)$/) {
                my $alg = uc $2;
-        $alg =~ tr/-/_/;
+               $alg =~ tr/-/_/;
                if (exists $disabled_algorithms{$alg}) {
                        $disabled_algorithms{$alg} = $1 eq "enable" ? 0 : 1;
                }
        }
 
        }
+$libname = $unified_info{sharednames}->{libcrypto} if $do_crypto;
+$libname = $unified_info{sharednames}->{libssl} if $do_ssl;
 
 if (!$libname) {
        if ($do_ssl) {
@@ -231,74 +276,30 @@ $max_ssl = $max_num;
 $max_crypto = $max_num;
 
 my $ssl="include/openssl/ssl.h";
+$ssl.=" include/openssl/sslerr.h";
 $ssl.=" include/openssl/tls1.h";
 $ssl.=" include/openssl/srtp.h";
 
+# When scanning include/openssl, skip all SSL files and some internal ones.
+my %skipthese;
+foreach my $f ( split(/\s+/, $ssl) ) {
+    $skipthese{$f} = 1;
+}
+$skipthese{'include/openssl/conf_api.h'} = 1;
+$skipthese{'include/openssl/ebcdic.h'} = 1;
+$skipthese{'include/openssl/opensslconf.h'} = 1;
+
 # We use headers found in include/openssl and include/internal only.
 # The latter is needed so libssl.so/.dll/.exe can link properly.
-my $crypto ="include/openssl/crypto.h";
+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/openssl/des.h" ; # unless $no_des;
-$crypto.=" include/openssl/idea.h" ; # unless $no_idea;
-$crypto.=" include/openssl/rc4.h" ; # unless $no_rc4;
-$crypto.=" include/openssl/rc5.h" ; # unless $no_rc5;
-$crypto.=" include/openssl/rc2.h" ; # unless $no_rc2;
-$crypto.=" include/openssl/blowfish.h" ; # unless $no_bf;
-$crypto.=" include/openssl/cast.h" ; # unless $no_cast;
-$crypto.=" include/openssl/whrlpool.h" ;
-$crypto.=" include/openssl/md2.h" ; # unless $no_md2;
-$crypto.=" include/openssl/md4.h" ; # unless $no_md4;
-$crypto.=" include/openssl/md5.h" ; # unless $no_md5;
-$crypto.=" include/openssl/mdc2.h" ; # unless $no_mdc2;
-$crypto.=" include/openssl/sha.h" ; # unless $no_sha;
-$crypto.=" include/openssl/ripemd.h" ; # unless $no_ripemd;
-$crypto.=" include/openssl/aes.h" ; # unless $no_aes;
-$crypto.=" include/openssl/camellia.h" ; # unless $no_camellia;
-$crypto.=" include/openssl/seed.h"; # unless $no_seed;
-
-$crypto.=" include/openssl/bn.h";
-$crypto.=" include/openssl/rsa.h" ; # unless $no_rsa;
-$crypto.=" include/openssl/dsa.h" ; # unless $no_dsa;
-$crypto.=" include/openssl/dh.h" ; # unless $no_dh;
-$crypto.=" include/openssl/ec.h" ; # unless $no_ec;
-$crypto.=" include/openssl/hmac.h" ; # unless $no_hmac;
-$crypto.=" include/openssl/cmac.h" ;
-
-$crypto.=" include/openssl/engine.h"; # unless $no_engine;
-$crypto.=" include/openssl/stack.h" ; # unless $no_stack;
-$crypto.=" include/openssl/buffer.h" ; # unless $no_buffer;
-$crypto.=" include/openssl/bio.h" ; # unless $no_bio;
-$crypto.=" include/internal/dso.h" ; # unless $no_dso;
-$crypto.=" include/openssl/lhash.h" ; # unless $no_lhash;
-$crypto.=" include/openssl/conf.h";
-$crypto.=" include/openssl/txt_db.h";
-
-$crypto.=" include/openssl/evp.h" ; # unless $no_evp;
-$crypto.=" include/openssl/objects.h";
-$crypto.=" include/openssl/pem.h";
-#$crypto.=" include/openssl/meth.h";
-$crypto.=" include/openssl/asn1.h";
-$crypto.=" include/openssl/asn1t.h";
-$crypto.=" include/openssl/err.h" ; # unless $no_err;
-$crypto.=" include/openssl/pkcs7.h";
-$crypto.=" include/openssl/pkcs12.h";
-$crypto.=" include/openssl/x509.h";
-$crypto.=" include/openssl/x509_vfy.h";
-$crypto.=" include/openssl/x509v3.h";
-$crypto.=" include/openssl/ts.h";
-$crypto.=" include/openssl/rand.h";
-$crypto.=" include/openssl/comp.h" ; # unless $no_comp;
-$crypto.=" include/openssl/ocsp.h";
-$crypto.=" include/openssl/ui.h";
-#$crypto.=" include/openssl/store.h";
-$crypto.=" include/openssl/cms.h";
-$crypto.=" include/openssl/srp.h";
-$crypto.=" include/openssl/modes.h";
-$crypto.=" include/openssl/async.h";
-$crypto.=" include/openssl/ct.h";
-$crypto.=" include/openssl/kdf.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$@;
+}
 
 my $symhacks="include/openssl/symhacks.h";
 
@@ -388,7 +389,7 @@ sub do_defs
                {
                my $fn = catfile($config{sourcedir},$file);
                print STDERR "DEBUG: starting on $fn:\n" if $debug;
-               open(IN,"<$fn") || die "unable to open $fn:$!\n";
+               open(IN,"<$fn") || die "Can't open $fn, $!,";
                my $line = "", my $def= "";
                my %tag = (
                        (map { $_ => 0 } @known_platforms),
@@ -458,10 +459,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) {
@@ -487,7 +488,7 @@ sub do_defs
                        }
 
                        if(/\/\*/) {
-                               if (not /\*\//) {       # multiline comment...
+                               if (not /\*\//) {       # multi-line comment...
                                        $line = $_;     # ... just accumulate
                                        next;
                                } else {
@@ -572,7 +573,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--;
                                }
@@ -671,7 +672,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:"
@@ -683,7 +684,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",
@@ -695,7 +696,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:"
@@ -707,7 +708,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",
@@ -720,7 +721,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:"
@@ -732,7 +733,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",
@@ -742,7 +743,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:"
@@ -754,7 +755,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",
@@ -770,7 +771,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:"
@@ -782,7 +783,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",
@@ -790,7 +791,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:"
@@ -802,7 +803,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",
@@ -868,7 +869,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:"
@@ -880,7 +881,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",
@@ -893,7 +894,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;
                                        }
@@ -1115,6 +1115,7 @@ sub is_valid
 
                if ($platforms) {
                        # platforms
+                       if ($keyword eq "UNIX" && $UNIX) { return 1; }
                        if ($keyword eq "VMS" && $VMS) { return 1; }
                        if ($keyword eq "WIN32" && $W32) { return 1; }
                        if ($keyword eq "_WIN32" && $W32) { return 1; }
@@ -1204,9 +1205,6 @@ sub print_def_file
         my $prevnum = 0;
         my $symvtextcount = 0;
 
-       if ($W32)
-               { $libname.="32"; }
-
         if ($W32)
                 {
                 print OUT <<"EOF";
@@ -1223,6 +1221,7 @@ EOF
         elsif ($VMS)
                 {
                 print OUT <<"EOF";
+IDENTIFICATION=$version
 CASE_SENSITIVE=YES
 SYMBOL_VECTOR=(-
 EOF
@@ -1261,7 +1260,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);
@@ -1274,16 +1272,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;
                                                }
@@ -1329,10 +1328,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";
                }
@@ -1678,7 +1677,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;