Refactor file writing - introduce template driven file writing
apps/CA.pl and tools/c_rehash are built from template files. So far,
this was done by Configure, which created its own problems as it
forced everyone to reconfigure just because one of the template files
had changed.
Instead, have those files created as part of the normal build in apps/
and in tools/.
Furthermore, this prepares for a future where Configure may produce
entirely other build files than Makefile, and the latter can't be
guaranteed to be the holder of all information for other scripts.
Instead, configdata.pm (described below) becomes the center of
configuration information.
This introduces a few new things:
%config a hash table to hold all kinds of configuration data
that can be used by any other script.
configdata.pm a perl module that Configure writes. It currently
holds the hash tables %config and %target.
util/dofile.pl a script that takes a template on STDIN and outputs
the result after applying configuration data on it.
It's supposed to be called like this:
perl -I$(TOP) -Mconfigdata < template > result
or
perl -I$(TOP) -Mconfigdata templ1 templ2 ... > result
Note: util/dofile.pl requires Text::Template.
As part of this changed, remove a number of variables that are really
just copies of entries in %target, and use %target directly. The
exceptions are $target{cflags} and $target{lflags}, they do get copied
to $cflags and $lflags. The reason for this is that those variable
potentially go through a lot of changes and would rather deserve a
place in %config. That, however, is for another commit.
Reviewed-by: Rich Salz <rsalz@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-05-18 20:35:23 +00:00
|
|
|
#!{- $config{perl} -}
|
2000-05-18 00:33:00 +00:00
|
|
|
|
2016-01-25 20:19:59 +00:00
|
|
|
# {- join("\n# ", @autowarntext) -}
|
|
|
|
|
2000-05-18 00:33:00 +00:00
|
|
|
# Perl c_rehash script, scan all files in a directory
|
|
|
|
# and add symbolic links to their hash values.
|
|
|
|
|
Refactor file writing - introduce template driven file writing
apps/CA.pl and tools/c_rehash are built from template files. So far,
this was done by Configure, which created its own problems as it
forced everyone to reconfigure just because one of the template files
had changed.
Instead, have those files created as part of the normal build in apps/
and in tools/.
Furthermore, this prepares for a future where Configure may produce
entirely other build files than Makefile, and the latter can't be
guaranteed to be the holder of all information for other scripts.
Instead, configdata.pm (described below) becomes the center of
configuration information.
This introduces a few new things:
%config a hash table to hold all kinds of configuration data
that can be used by any other script.
configdata.pm a perl module that Configure writes. It currently
holds the hash tables %config and %target.
util/dofile.pl a script that takes a template on STDIN and outputs
the result after applying configuration data on it.
It's supposed to be called like this:
perl -I$(TOP) -Mconfigdata < template > result
or
perl -I$(TOP) -Mconfigdata templ1 templ2 ... > result
Note: util/dofile.pl requires Text::Template.
As part of this changed, remove a number of variables that are really
just copies of entries in %target, and use %target directly. The
exceptions are $target{cflags} and $target{lflags}, they do get copied
to $cflags and $lflags. The reason for this is that those variable
potentially go through a lot of changes and would rather deserve a
place in %config. That, however, is for another commit.
Reviewed-by: Rich Salz <rsalz@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-05-18 20:35:23 +00:00
|
|
|
my $dir = {- quotify1($config{openssldir}) -};
|
|
|
|
my $prefix = {- quotify1($config{prefix}) -};
|
2000-05-18 00:33:00 +00:00
|
|
|
|
2015-09-10 15:46:13 +00:00
|
|
|
my $errorcount = 0;
|
2014-09-07 22:45:02 +00:00
|
|
|
my $openssl = $ENV{OPENSSL} || "openssl";
|
|
|
|
my $pwd;
|
|
|
|
my $x509hash = "-subject_hash";
|
|
|
|
my $crlhash = "-hash";
|
|
|
|
my $verbose = 0;
|
|
|
|
my $symlink_exists=eval {symlink("",""); 1};
|
|
|
|
my $removelinks = 1;
|
|
|
|
|
|
|
|
## Parse flags.
|
2015-06-02 11:41:35 +00:00
|
|
|
while ( $ARGV[0] =~ /^-/ ) {
|
2014-09-07 22:45:02 +00:00
|
|
|
my $flag = shift @ARGV;
|
|
|
|
last if ( $flag eq '--');
|
2015-06-02 11:41:35 +00:00
|
|
|
if ( $flag eq '-old') {
|
2014-09-07 22:45:02 +00:00
|
|
|
$x509hash = "-subject_hash_old";
|
|
|
|
$crlhash = "-hash_old";
|
2015-06-02 11:41:35 +00:00
|
|
|
} elsif ( $flag eq '-h') {
|
2014-09-07 22:45:02 +00:00
|
|
|
help();
|
|
|
|
} elsif ( $flag eq '-n' ) {
|
|
|
|
$removelinks = 0;
|
|
|
|
} elsif ( $flag eq '-v' ) {
|
|
|
|
$verbose++;
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
print STDERR "Usage error; try -help.\n";
|
|
|
|
exit 1;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
sub help {
|
|
|
|
print "Usage: c_rehash [-old] [-h] [-v] [dirs...]\n";
|
|
|
|
print " -old use old-style digest\n";
|
|
|
|
print " -h print this help text\n";
|
|
|
|
print " -v print files removed and linked\n";
|
|
|
|
exit 0;
|
2000-05-18 00:33:00 +00:00
|
|
|
}
|
|
|
|
|
2006-10-26 10:52:12 +00:00
|
|
|
eval "require Cwd";
|
|
|
|
if (defined(&Cwd::getcwd)) {
|
|
|
|
$pwd=Cwd::getcwd();
|
|
|
|
} else {
|
2014-09-07 22:45:02 +00:00
|
|
|
$pwd=`pwd`;
|
|
|
|
chomp($pwd);
|
2006-10-26 10:52:12 +00:00
|
|
|
}
|
2006-10-21 16:28:03 +00:00
|
|
|
|
2014-09-07 22:45:02 +00:00
|
|
|
# DOS/Win32 or Unix delimiter? Prefix our installdir, then search.
|
|
|
|
my $path_delim = ($pwd =~ /^[a-z]\:/i) ? ';' : ':';
|
|
|
|
$ENV{PATH} = "$prefix/bin" . ($ENV{PATH} ? $path_delim . $ENV{PATH} : "");
|
2000-05-18 00:33:00 +00:00
|
|
|
|
2015-09-08 02:21:38 +00:00
|
|
|
if (! -x $openssl) {
|
2000-05-18 00:33:00 +00:00
|
|
|
my $found = 0;
|
2006-10-21 16:28:03 +00:00
|
|
|
foreach (split /$path_delim/, $ENV{PATH}) {
|
2015-09-08 02:21:38 +00:00
|
|
|
if (-x "$_/$openssl") {
|
2000-05-18 00:33:00 +00:00
|
|
|
$found = 1;
|
2009-04-23 16:32:42 +00:00
|
|
|
$openssl = "$_/$openssl";
|
2000-05-18 00:33:00 +00:00
|
|
|
last;
|
|
|
|
}
|
|
|
|
}
|
2015-09-08 02:21:38 +00:00
|
|
|
if ($found == 0) {
|
2000-05-18 00:33:00 +00:00
|
|
|
print STDERR "c_rehash: rehashing skipped ('openssl' program not available)\n";
|
|
|
|
exit 0;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-09-08 02:21:38 +00:00
|
|
|
if (@ARGV) {
|
2000-05-18 00:33:00 +00:00
|
|
|
@dirlist = @ARGV;
|
2015-09-08 02:21:38 +00:00
|
|
|
} elsif ($ENV{SSL_CERT_DIR}) {
|
2006-10-21 16:28:03 +00:00
|
|
|
@dirlist = split /$path_delim/, $ENV{SSL_CERT_DIR};
|
2000-05-18 00:33:00 +00:00
|
|
|
} else {
|
|
|
|
$dirlist[0] = "$dir/certs";
|
|
|
|
}
|
|
|
|
|
2006-10-21 16:28:03 +00:00
|
|
|
if (-d $dirlist[0]) {
|
|
|
|
chdir $dirlist[0];
|
|
|
|
$openssl="$pwd/$openssl" if (!-x $openssl);
|
|
|
|
chdir $pwd;
|
|
|
|
}
|
2000-05-18 00:33:00 +00:00
|
|
|
|
|
|
|
foreach (@dirlist) {
|
2015-09-08 02:21:38 +00:00
|
|
|
if (-d $_ ) {
|
|
|
|
if ( -w $_) {
|
2000-05-18 00:33:00 +00:00
|
|
|
hash_dir($_);
|
2015-09-08 02:21:38 +00:00
|
|
|
} else {
|
|
|
|
print "Skipping $_, can't write\n";
|
2015-09-10 15:46:13 +00:00
|
|
|
$errorcount++;
|
2015-09-08 02:21:38 +00:00
|
|
|
}
|
2000-05-18 00:33:00 +00:00
|
|
|
}
|
|
|
|
}
|
2015-09-10 15:46:13 +00:00
|
|
|
exit($errorcount);
|
2000-05-18 00:33:00 +00:00
|
|
|
|
|
|
|
sub hash_dir {
|
|
|
|
my %hashlist;
|
|
|
|
print "Doing $_[0]\n";
|
|
|
|
chdir $_[0];
|
2014-09-11 17:08:30 +00:00
|
|
|
opendir(DIR, ".");
|
|
|
|
my @flist = readdir(DIR);
|
|
|
|
closedir DIR;
|
2014-09-07 22:45:02 +00:00
|
|
|
if ( $removelinks ) {
|
|
|
|
# Delete any existing symbolic links
|
|
|
|
foreach (grep {/^[\da-f]+\.r{0,1}\d+$/} @flist) {
|
2015-09-08 02:21:38 +00:00
|
|
|
if (-l $_) {
|
2014-09-07 22:45:02 +00:00
|
|
|
print "unlink $_" if $verbose;
|
2015-09-08 02:21:38 +00:00
|
|
|
unlink $_ || warn "Can't unlink $_, $!\n";
|
2014-09-07 22:45:02 +00:00
|
|
|
}
|
2000-05-18 00:33:00 +00:00
|
|
|
}
|
|
|
|
}
|
2014-09-07 22:45:02 +00:00
|
|
|
FILE: foreach $fname (grep {/\.(pem)|(crt)|(cer)|(crl)$/} @flist) {
|
2000-05-18 00:33:00 +00:00
|
|
|
# Check to see if certificates and/or CRLs present.
|
|
|
|
my ($cert, $crl) = check_file($fname);
|
2015-09-08 02:21:38 +00:00
|
|
|
if (!$cert && !$crl) {
|
2000-05-18 00:33:00 +00:00
|
|
|
print STDERR "WARNING: $fname does not contain a certificate or CRL: skipping\n";
|
|
|
|
next;
|
|
|
|
}
|
2015-09-08 02:21:38 +00:00
|
|
|
link_hash_cert($fname) if ($cert);
|
|
|
|
link_hash_crl($fname) if ($crl);
|
2000-05-18 00:33:00 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
sub check_file {
|
|
|
|
my ($is_cert, $is_crl) = (0,0);
|
|
|
|
my $fname = $_[0];
|
|
|
|
open IN, $fname;
|
|
|
|
while(<IN>) {
|
2015-09-08 02:21:38 +00:00
|
|
|
if (/^-----BEGIN (.*)-----/) {
|
2000-05-18 00:33:00 +00:00
|
|
|
my $hdr = $1;
|
2015-09-08 02:21:38 +00:00
|
|
|
if ($hdr =~ /^(X509 |TRUSTED |)CERTIFICATE$/) {
|
2000-05-18 00:33:00 +00:00
|
|
|
$is_cert = 1;
|
2015-09-08 02:21:38 +00:00
|
|
|
last if ($is_crl);
|
|
|
|
} elsif ($hdr eq "X509 CRL") {
|
2000-05-18 00:33:00 +00:00
|
|
|
$is_crl = 1;
|
2015-09-08 02:21:38 +00:00
|
|
|
last if ($is_cert);
|
2000-05-18 00:33:00 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
close IN;
|
|
|
|
return ($is_cert, $is_crl);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
# Link a certificate to its subject name hash value, each hash is of
|
|
|
|
# the form <hash>.<n> where n is an integer. If the hash value already exists
|
|
|
|
# then we need to up the value of n, unless its a duplicate in which
|
|
|
|
# case we skip the link. We check for duplicates by comparing the
|
|
|
|
# certificate fingerprints
|
|
|
|
|
|
|
|
sub link_hash_cert {
|
|
|
|
my $fname = $_[0];
|
2002-10-11 11:34:20 +00:00
|
|
|
$fname =~ s/'/'\\''/g;
|
2014-09-07 22:45:02 +00:00
|
|
|
my ($hash, $fprint) = `"$openssl" x509 $x509hash -fingerprint -noout -in "$fname"`;
|
2000-05-18 00:33:00 +00:00
|
|
|
chomp $hash;
|
|
|
|
chomp $fprint;
|
|
|
|
$fprint =~ s/^.*=//;
|
|
|
|
$fprint =~ tr/://d;
|
|
|
|
my $suffix = 0;
|
|
|
|
# Search for an unused hash filename
|
|
|
|
while(exists $hashlist{"$hash.$suffix"}) {
|
|
|
|
# Hash matches: if fingerprint matches its a duplicate cert
|
2015-09-08 02:21:38 +00:00
|
|
|
if ($hashlist{"$hash.$suffix"} eq $fprint) {
|
2000-05-18 00:33:00 +00:00
|
|
|
print STDERR "WARNING: Skipping duplicate certificate $fname\n";
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
$suffix++;
|
|
|
|
}
|
|
|
|
$hash .= ".$suffix";
|
2001-04-04 15:50:30 +00:00
|
|
|
if ($symlink_exists) {
|
2014-09-07 22:45:02 +00:00
|
|
|
print "link $fname -> $hash\n" if $verbose;
|
2015-09-08 02:21:38 +00:00
|
|
|
symlink $fname, $hash || warn "Can't symlink, $!";
|
2001-04-04 15:50:30 +00:00
|
|
|
} else {
|
2014-09-07 22:45:02 +00:00
|
|
|
print "copy $fname -> $hash\n" if $verbose;
|
2015-09-08 02:21:38 +00:00
|
|
|
if (open($in, "<", $fname)) {
|
|
|
|
if (open($out,">", $hash)) {
|
|
|
|
print $out $_ while (<$in>);
|
|
|
|
close $out;
|
|
|
|
} else {
|
|
|
|
warn "can't open $hash for write, $!";
|
|
|
|
}
|
|
|
|
close $in;
|
|
|
|
} else {
|
|
|
|
warn "can't open $fname for read, $!";
|
|
|
|
}
|
2001-04-04 15:50:30 +00:00
|
|
|
}
|
2000-05-18 00:33:00 +00:00
|
|
|
$hashlist{$hash} = $fprint;
|
|
|
|
}
|
|
|
|
|
|
|
|
# Same as above except for a CRL. CRL links are of the form <hash>.r<n>
|
|
|
|
|
|
|
|
sub link_hash_crl {
|
|
|
|
my $fname = $_[0];
|
2002-10-11 20:28:23 +00:00
|
|
|
$fname =~ s/'/'\\''/g;
|
2014-09-07 22:45:02 +00:00
|
|
|
my ($hash, $fprint) = `"$openssl" crl $crlhash -fingerprint -noout -in '$fname'`;
|
2000-05-18 00:33:00 +00:00
|
|
|
chomp $hash;
|
|
|
|
chomp $fprint;
|
|
|
|
$fprint =~ s/^.*=//;
|
|
|
|
$fprint =~ tr/://d;
|
|
|
|
my $suffix = 0;
|
|
|
|
# Search for an unused hash filename
|
|
|
|
while(exists $hashlist{"$hash.r$suffix"}) {
|
|
|
|
# Hash matches: if fingerprint matches its a duplicate cert
|
2015-09-08 02:21:38 +00:00
|
|
|
if ($hashlist{"$hash.r$suffix"} eq $fprint) {
|
2000-05-18 00:33:00 +00:00
|
|
|
print STDERR "WARNING: Skipping duplicate CRL $fname\n";
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
$suffix++;
|
|
|
|
}
|
|
|
|
$hash .= ".r$suffix";
|
2001-04-04 15:50:30 +00:00
|
|
|
if ($symlink_exists) {
|
2014-09-07 22:45:02 +00:00
|
|
|
print "link $fname -> $hash\n" if $verbose;
|
2015-09-08 02:21:38 +00:00
|
|
|
symlink $fname, $hash || warn "Can't symlink, $!";
|
2001-04-04 15:50:30 +00:00
|
|
|
} else {
|
2014-09-07 22:45:02 +00:00
|
|
|
print "cp $fname -> $hash\n" if $verbose;
|
2015-09-08 02:21:38 +00:00
|
|
|
system ("cp", $fname, $hash);
|
|
|
|
warn "Can't copy, $!" if ($? >> 8) != 0;
|
2001-04-04 15:50:30 +00:00
|
|
|
}
|
2000-05-18 00:33:00 +00:00
|
|
|
$hashlist{$hash} = $fprint;
|
|
|
|
}
|