include source root directory via -I for libnonfips.a
[oweals/openssl.git] / apps / progs.pl
index 7a69fc7b18dc54690293a4f3435b0ad9de9726f2..3ddb71323825af091663375f4857bfe2e6c8c41a 100644 (file)
-#!/usr/local/bin/perl
+#! /usr/bin/env perl
+# Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
+#
+# Licensed under the Apache License 2.0 (the "License").  You may not use
+# this file except in compliance with the License.  You can obtain a copy
+# in the file LICENSE in the source distribution or at
+# https://www.openssl.org/source/license.html
 
-print "/* This file was generated by progs.pl. */\n\n";
+# Generate progs.h file by looking for command mains in list of C files
+# passed on the command line.
 
-grep(s/^asn1pars$/asn1parse/,@ARGV);
+use strict;
+use warnings;
+use lib '.';
+use configdata qw/@disablables %unified_info/;
 
-foreach (@ARGV)
-       { printf "extern int %s_main(int argc,char *argv[]);\n",$_; }
+my $opt          = shift @ARGV;
+die "Unrecognised option, must be -C or -H\n"
+    unless ($opt eq '-H' || $opt eq '-C');
 
-print <<'EOF';
+my %commands     = ();
+my $cmdre        = qr/^\s*int\s+([a-z_][a-z0-9_]*)_main\(\s*int\s+argc\s*,/;
+my $apps_openssl = shift @ARGV;
+my $YEAR         = [localtime()]->[5] + 1900;
 
-#ifdef SSLEAY_SRC  /* Defined only in openssl.c. */
+# because the program apps/openssl has object files as sources, and
+# they then have the corresponding C files as source, we need to chain
+# the lookups in %unified_info
+my @openssl_source =
+    map { @{$unified_info{sources}->{$_}} }
+    grep { /\.o$/ }
+        @{$unified_info{sources}->{$apps_openssl}};
 
-#define FUNC_TYPE_GENERAL      1
-#define FUNC_TYPE_MD           2
-#define FUNC_TYPE_CIPHER       3
+foreach my $filename (@openssl_source) {
+    open F, $filename or die "Couldn't open $filename: $!\n";
+    foreach ( grep /$cmdre/, <F> ) {
+        my @foo = /$cmdre/;
+        $commands{$1} = 1;
+    }
+    close F;
+}
 
-typedef struct {
-       int type;
-       char *name;
-       int (*func)();
-       } FUNCTION;
+@ARGV = sort keys %commands;
+
+if ($opt eq '-H') {
+    print <<"EOF";
+/*
+ * WARNING: do not edit!
+ * Generated by apps/progs.pl
+ *
+ * Copyright 1995-$YEAR The OpenSSL Project Authors. All Rights Reserved.
+ *
+ * Licensed under the Apache License 2.0 (the "License").  You may not use
+ * this file except in compliance with the License.  You can obtain a copy
+ * in the file LICENSE in the source distribution or at
+ * https://www.openssl.org/source/license.html
+ */
+
+#include "function.h"
 
-FUNCTION functions[] = {
 EOF
 
-foreach (@ARGV)
-       {
-       push(@files,$_);
-       $str="\t{FUNC_TYPE_GENERAL,\"$_\",${_}_main},\n";
-       if (($_ =~ /^s_/) || ($_ =~ /^ciphers$/))
-               { print "#if !defined(NO_SOCK) && !(defined(NO_SSL2) && defined(O_SSL3))\n${str}#endif\n"; } 
-       elsif ( ($_ =~ /^rsa$/) || ($_ =~ /^genrsa$/) ) 
-               { print "#ifndef NO_RSA\n${str}#endif\n";  }
-       elsif ( ($_ =~ /^dsa$/) || ($_ =~ /^gendsa$/) || ($_ =~ /^dsaparam$/))
-               { print "#ifndef NO_DSA\n${str}#endif\n"; }
-       elsif ( ($_ =~ /^dh$/) || ($_ =~ /^gendh$/))
-               { print "#ifndef NO_DH\n${str}#endif\n"; }
-       else
-               { print $str; }
-       }
-
-foreach ("md2","md5","sha","sha1","mdc2","rmd160")
-       {
-       push(@files,$_);
-       printf "\t{FUNC_TYPE_MD,\"%s\",dgst_main},\n",$_;
-       }
-
-foreach (
-       "base64",
-       "des", "des3", "desx", "idea", "rc4", "rc2","bf","cast","rc5",
-       "des-ecb", "des-ede",    "des-ede3",
-       "des-cbc", "des-ede-cbc","des-ede3-cbc",
-       "des-cfb", "des-ede-cfb","des-ede3-cfb",
-       "des-ofb", "des-ede-ofb","des-ede3-ofb",
-       "idea-cbc","idea-ecb",   "idea-cfb", "idea-ofb",
-       "rc2-cbc", "rc2-ecb",    "rc2-cfb",  "rc2-ofb",
-       "bf-cbc",  "bf-ecb",     "bf-cfb",   "bf-ofb",
-       "cast5-cbc","cast5-ecb", "cast5-cfb","cast5-ofb",
-       "cast-cbc", "rc5-cbc",   "rc5-ecb",  "rc5-cfb",  "rc5-ofb")
-       {
-       push(@files,$_);
-
-       $t=sprintf("\t{FUNC_TYPE_CIPHER,\"%s\",enc_main},\n",$_);
-       if    ($_ =~ /des/)  { $t="#ifndef NO_DES\n${t}#endif\n"; }
-       elsif ($_ =~ /idea/) { $t="#ifndef NO_IDEA\n${t}#endif\n"; }
-       elsif ($_ =~ /rc4/)  { $t="#ifndef NO_RC4\n${t}#endif\n"; }
-       elsif ($_ =~ /rc2/)  { $t="#ifndef NO_RC2\n${t}#endif\n"; }
-       elsif ($_ =~ /bf/)   { $t="#ifndef NO_BF\n${t}#endif\n"; }
-       elsif ($_ =~ /cast/) { $t="#ifndef NO_CAST\n${t}#endif\n"; }
-       elsif ($_ =~ /rc5/)  { $t="#ifndef NO_RC5\n${t}#endif\n"; }
-       print $t;
-       }
-
-print "\t{0,NULL,NULL}\n\t};\n";
-print "#endif\n\n";
+    foreach (@ARGV) {
+        printf "extern int %s_main(int argc, char *argv[]);\n", $_;
+    }
+    print "\n";
+
+    foreach (@ARGV) {
+        printf "extern const OPTIONS %s_options[];\n", $_;
+    }
+    print "\n";
+    print "extern FUNCTION functions[];\n";
+}
+
+if ($opt eq '-C') {
+    print <<"EOF";
+/*
+ * WARNING: do not edit!
+ * Generated by apps/progs.pl
+ *
+ * Copyright 1995-$YEAR The OpenSSL Project Authors. All Rights Reserved.
+ *
+ * Licensed under the Apache License 2.0 (the "License").  You may not use
+ * this file except in compliance with the License.  You can obtain a copy
+ * in the file LICENSE in the source distribution or at
+ * https://www.openssl.org/source/license.html
+ */
+
+#include "progs.h"
+
+EOF
+
+    my %cmd_disabler = (
+        ciphers  => "sock",
+        genrsa   => "rsa",
+        gendsa   => "dsa",
+        dsaparam => "dsa",
+        gendh    => "dh",
+        dhparam  => "dh",
+        ecparam  => "ec",
+        pkcs12   => "des",
+    );
+    my %cmd_deprecated = (
+# The format of this table is:
+#   [0] = alternative command to use instead
+#   [1] = deprecented in this version
+#   [2] = preprocessor conditional for exclusing irrespective of deprecation
+#        rsa      => [ "pkey",      "3_0", "rsa" ],
+#        genrsa   => [ "genpkey",   "3_0", "rsa" ],
+        rsautl   => [ "pkeyutl",   "3_0", "rsa" ],
+#        dhparam  => [ "pkeyparam", "3_0", "dh"  ],
+#        dsaparam => [ "pkeyparam", "3_0", "dsa" ],
+#        dsa      => [ "pkey",      "3_0", "dsa" ],
+#        gendsa   => [ "genpkey",   "3_0", "dsa" ],
+#        ec       => [ "pkey",      "3_0", "ec"  ],
+#        ecparam  => [ "pkeyparam", "3_0", "ec"  ],
+    );
+
+    print "FUNCTION functions[] = {\n";
+    foreach my $cmd ( @ARGV ) {
+        my $str =
+            "    {FT_general, \"$cmd\", ${cmd}_main, ${cmd}_options, NULL, NULL},\n";
+        if ($cmd =~ /^s_/) {
+            print "#ifndef OPENSSL_NO_SOCK\n${str}#endif\n";
+        } elsif (my $deprecated = $cmd_deprecated{$cmd}) {
+            my @dep = @{$deprecated};
+            my $daltprg = $dep[0];
+            my $dver = $dep[1];
+            my $dsys = $dep[2];
+            print "#if !defined(OPENSSL_NO_DEPRECATED_" . $dver . ")";
+            if ($dsys) {
+                print " && !defined(OPENSSL_NO_" . uc($dsys) . ")";
+            }
+            $dver =~ s/_/./g;
+            my $dalt = "\"" . $daltprg . "\", \"" . $dver . "\"";
+            $str =~ s/NULL, NULL/$dalt/;
+            print "\n${str}#endif\n";
+        } elsif (grep { $cmd eq $_ } @disablables) {
+            print "#ifndef OPENSSL_NO_" . uc($cmd) . "\n${str}#endif\n";
+        } elsif (my $disabler = $cmd_disabler{$cmd}) {
+            print "#ifndef OPENSSL_NO_" . uc($disabler) . "\n${str}#endif\n";
+        } else {
+            print $str;
+        }
+    }
+
+    my %md_disabler = (
+        blake2b512 => "blake2",
+        blake2s256 => "blake2",
+    );
+    foreach my $cmd (
+        "md2", "md4", "md5",
+        "gost",
+        "sha1", "sha224", "sha256", "sha384",
+        "sha512", "sha512-224", "sha512-256",
+        "sha3-224", "sha3-256", "sha3-384", "sha3-512",
+        "shake128", "shake256",
+        "mdc2", "rmd160", "blake2b512", "blake2s256",
+        "sm3"
+    ) {
+        my $str = "    {FT_md, \"$cmd\", dgst_main, NULL, NULL},\n";
+        if (grep { $cmd eq $_ } @disablables) {
+            print "#ifndef OPENSSL_NO_" . uc($cmd) . "\n${str}#endif\n";
+        } elsif (my $disabler = $md_disabler{$cmd}) {
+            print "#ifndef OPENSSL_NO_" . uc($disabler) . "\n${str}#endif\n";
+        } else {
+            print $str;
+        }
+    }
+
+    my %cipher_disabler = (
+        des3  => "des",
+        desx  => "des",
+        cast5 => "cast",
+    );
+    foreach my $cmd (
+        "aes-128-cbc", "aes-128-ecb",
+        "aes-192-cbc", "aes-192-ecb",
+        "aes-256-cbc", "aes-256-ecb",
+        "aria-128-cbc", "aria-128-cfb",
+        "aria-128-ctr", "aria-128-ecb", "aria-128-ofb",
+        "aria-128-cfb1", "aria-128-cfb8",
+        "aria-192-cbc", "aria-192-cfb",
+        "aria-192-ctr", "aria-192-ecb", "aria-192-ofb",
+        "aria-192-cfb1", "aria-192-cfb8",
+        "aria-256-cbc", "aria-256-cfb",
+        "aria-256-ctr", "aria-256-ecb", "aria-256-ofb",
+        "aria-256-cfb1", "aria-256-cfb8",
+        "camellia-128-cbc", "camellia-128-ecb",
+        "camellia-192-cbc", "camellia-192-ecb",
+        "camellia-256-cbc", "camellia-256-ecb",
+        "base64", "zlib",
+        "des", "des3", "desx", "idea", "seed", "rc4", "rc4-40",
+        "rc2", "bf", "cast", "rc5",
+        "des-ecb", "des-ede", "des-ede3",
+        "des-cbc", "des-ede-cbc","des-ede3-cbc",
+        "des-cfb", "des-ede-cfb","des-ede3-cfb",
+        "des-ofb", "des-ede-ofb","des-ede3-ofb",
+        "idea-cbc","idea-ecb", "idea-cfb", "idea-ofb",
+        "seed-cbc","seed-ecb", "seed-cfb", "seed-ofb",
+        "rc2-cbc", "rc2-ecb", "rc2-cfb","rc2-ofb", "rc2-64-cbc", "rc2-40-cbc",
+        "bf-cbc", "bf-ecb", "bf-cfb", "bf-ofb",
+        "cast5-cbc","cast5-ecb", "cast5-cfb","cast5-ofb",
+        "cast-cbc", "rc5-cbc", "rc5-ecb", "rc5-cfb", "rc5-ofb",
+        "sm4-cbc", "sm4-ecb", "sm4-cfb", "sm4-ofb", "sm4-ctr"
+    ) {
+        my $str = "    {FT_cipher, \"$cmd\", enc_main, enc_options, NULL},\n";
+        (my $algo = $cmd) =~ s/-.*//g;
+        if ($cmd eq "zlib") {
+            print "#ifdef ZLIB\n${str}#endif\n";
+        } elsif (grep { $algo eq $_ } @disablables) {
+            print "#ifndef OPENSSL_NO_" . uc($algo) . "\n${str}#endif\n";
+        } elsif (my $disabler = $cipher_disabler{$algo}) {
+            print "#ifndef OPENSSL_NO_" . uc($disabler) . "\n${str}#endif\n";
+        } else {
+            print $str;
+        }
+    }
 
+    print "    {0, NULL, NULL, NULL, NULL}\n};\n";
+}