Blame tools/rules-updater.pl.in

Packit 284210
#!@PERL@
Packit 284210
#
Packit 284210
# Fetches the latest ModSecurity Ruleset
Packit 284210
#
Packit 284210
Packit 284210
use strict;
Packit 284210
use Sys::Hostname;
Packit 284210
use LWP::UserAgent ();
Packit 284210
use LWP::Debug qw(-);
Packit 284210
use URI ();
Packit 284210
use HTTP::Date ();
Packit 284210
use Cwd qw(getcwd);
Packit 284210
use Getopt::Std;
Packit 284210
Packit 284210
my $VERSION = "0.0.1";
Packit 284210
my($SCRIPT) = ($0 =~ m/([^\/\\]+)$/);
Packit 284210
my $CRLFRE = qr/\015?\012/;
Packit 284210
my $HOST = Sys::Hostname::hostname();
Packit 284210
my $UNZIP = [qw(unzip -a)];
Packit 284210
my $SENDMAIL = [qw(/usr/lib/sendmail -oi -t)];
Packit 284210
my $HAVE_GNUPG = 0;
Packit 284210
my %PREFIX_MAP = (
Packit 284210
	-dev => 0,
Packit 284210
	-rc => 1,
Packit 284210
	"" => 9,
Packit 284210
);
Packit 284210
my %GPG_TRUST = ();
Packit 284210
my $REQUIRED_SIG_TRUST;
Packit 284210
Packit 284210
eval "use GnuPG qw(:trust)";
Packit 284210
if ($@) {
Packit 284210
	warn "Could not load GnuPG module - cannot verify ruleset signatures\n";
Packit 284210
}
Packit 284210
else {
Packit 284210
	$HAVE_GNUPG = 1;
Packit 284210
	%GPG_TRUST = (
Packit 284210
		&TRUST_UNDEFINED    => "not",
Packit 284210
		&TRUST_NEVER        => "not",
Packit 284210
		&TRUST_MARGINAL     => "marginally",
Packit 284210
		&TRUST_FULLY        => "fully",
Packit 284210
		&TRUST_ULTIMATE     => "ultimatly",
Packit 284210
	);
Packit 284210
	$REQUIRED_SIG_TRUST = &TRUST_FULLY;
Packit 284210
}
Packit 284210
Packit 284210
################################################################################
Packit 284210
################################################################################
Packit 284210
Packit 284210
my @fetched = ();
Packit 284210
my %opt = ();
Packit 284210
getopts('c:r:p:s:v:t:e:f:EuS:D:R:U:F:L:ldh', \%opt);
Packit 284210
Packit 284210
usage(1) if(defined $opt{h});
Packit 284210
usage(1) if(@ARGV > 1);
Packit 284210
Packit 284210
# Make sure we have an action
Packit 284210
if (! grep { defined } @opt{qw(S D R U F L l)}) {
Packit 284210
	usage(1, "Action required.");
Packit 284210
}
Packit 284210
Packit 284210
# Merge config with commandline opts
Packit 284210
if ($opt{c}) {
Packit 284210
	%opt = parse_config($opt{c}, \%opt);
Packit 284210
}
Packit 284210
Packit 284210
LWP::Debug::level("+") if ($opt{d});
Packit 284210
Packit 284210
# Make the version into a regex
Packit 284210
if (defined $opt{v}) {
Packit 284210
	my($a,$b,$c,$d) = ($opt{v} =~ m/^(\d+)\.?(\d+)?\.?(\d+)?(?:-(\D+\d+$)|($))/);
Packit 284210
	if (defined $d) {
Packit 284210
		(my $key = $d) =~ s/^(\D+)\d+$/-$1/;
Packit 284210
		unless (exists $PREFIX_MAP{$key}) {
Packit 284210
			usage(1, "Invalid version (bad suffix \"$d\"): $opt{v}");
Packit 284210
		}
Packit 284210
		$opt{v} = qr/^$a\.$b\.$c-$d$/;
Packit 284210
	}
Packit 284210
	elsif (defined $c) {
Packit 284210
		$opt{v} = qr/^$a\.$b\.$c(?:-|$)/;
Packit 284210
	}
Packit 284210
	elsif (defined $b) {
Packit 284210
		$opt{v} = qr/^$a\.$b\./;
Packit 284210
	}
Packit 284210
	elsif (defined $a) {
Packit 284210
		$opt{v} = qr/^$a\./;
Packit 284210
	}
Packit 284210
	else {
Packit 284210
		usage(1, "Invalid version: $opt{v}");
Packit 284210
	}
Packit 284210
	if ($opt{d}) {
Packit 284210
		print STDERR "Using version regex: $opt{v}\n";
Packit 284210
	}
Packit 284210
}
Packit 284210
else {
Packit 284210
	$opt{v} = qr/^/;
Packit 284210
}
Packit 284210
Packit 284210
# Remove trailing slashes from uri and path
Packit 284210
$opt{r} =~ s/\/+$//;
Packit 284210
$opt{p} =~ s/\/+$//;
Packit 284210
Packit 284210
# Required opts
Packit 284210
usage(1, "Repository (-r) required.") unless(defined $opt{r});
Packit 284210
usage(1, "Local path (-p) required.") unless(defined $opt{p} or defined $opt{l});
Packit 284210
Packit 284210
my $ua = LWP::UserAgent->new(
Packit 284210
	agent => "ModSecurity Updator/$VERSION",
Packit 284210
	keep_alive => 1,
Packit 284210
	env_proxy => 1,
Packit 284210
	max_redirect => 5,
Packit 284210
	requests_redirectable => [qw(GET HEAD)],
Packit 284210
	timeout => ($opt{t} || 600),
Packit 284210
);
Packit 284210
Packit 284210
sub usage {
Packit 284210
	my $rc = defined($$_[0]) ? $_[0] : 0;
Packit 284210
	my $msg = defined($_[1]) ? "\n$_[1]\n\n" : "";
Packit 284210
Packit 284210
	print STDERR << "EOT";
Packit 284210
${msg}Usage: $SCRIPT [-c config_file] [[options] [action]
Packit 284210
Packit 284210
 Options (commandline will override config file):
Packit 284210
  -r uri   RepositoryURI   Repository URI.
Packit 284210
  -p path  LocalRepository Local repository path to use as base for downloads.
Packit 284210
  -s path  LocalRules      Local rules base path to use for unpacking.
Packit 284210
  -v text  Version         Full/partial version (EX: 1, 1.5, 1.5.2, 1.5.2-dev3)
Packit 284210
  -t secs  Timeout         Timeout for fetching data in seconds (default 600).
Packit 284210
  -e addr  NotifyEmail     Notify via email on update (comma separated list).
Packit 284210
  -f addr  NotifyEmailFrom From address for notification email.
Packit 284210
  -u       Unpack          Unpack into LocalRules/version path.
Packit 284210
  -d       Debug           Print out lots of debugging.
Packit 284210
Packit 284210
 Actions:
Packit 284210
  -S name    Fetch the latest stable ruleset, "name"
Packit 284210
  -D name    Fetch the latest development ruleset, "name"
Packit 284210
  -R name    Fetch the latest release candidate ruleset, "name"
Packit 284210
  -U name    Fetch the latest unstable (non-stable) ruleset, "name"
Packit 284210
  -F name    Fetch the latest ruleset, "name"
Packit 284210
  -l         Print listing of what is available
Packit 284210
Packit 284210
 Misc:
Packit 284210
  -c         Specify a config file for options.
Packit 284210
  -h         This help
Packit 284210
Packit 284210
Examples:
Packit 284210
Packit 284210
# Get a list of what the repository contains:
Packit 284210
$SCRIPT -rhttp://host/repo/ -l
Packit 284210
Packit 284210
# Get a partial list of versions 1.5.x:
Packit 284210
$SCRIPT -rhttp://host/repo/ -v1.5 -l
Packit 284210
Packit 284210
# Get the latest stable version of "breach_ModSecurityCoreRules":
Packit 284210
$SCRIPT -rhttp://host/repo/ -p/my/repo -Sbreach_ModSecurityCoreRules
Packit 284210
Packit 284210
# Get the latest stable 1.5 release of "breach_ModSecurityCoreRules":
Packit 284210
$SCRIPT -rhttp://host/repo/ -p/my/repo -v1.5 -Sbreach_ModSecurityCoreRules
Packit 284210
EOT
Packit 284210
	exit $rc;
Packit 284210
}
Packit 284210
Packit 284210
sub sort_versions {
Packit 284210
	(my $A = $a) =~ s/^(\d+)\.(\d+)\.(\d+)(-[^-\d]+|)(\d*)$/sprintf("%03d%03d%03d%03d%03d", $1, $2, $3, $PREFIX_MAP{$4}, $5)/e;
Packit 284210
	(my $B = $b) =~ s/^(\d+)\.(\d+)\.(\d+)(-[^-\d]+|)(\d*)$/sprintf("%03d%03d%03d%03d%03d", $1, $2, $3, $PREFIX_MAP{$4}, $5)/e;
Packit 284210
	return $A cmp $B;
Packit 284210
}
Packit 284210
Packit 284210
sub parse_config {
Packit 284210
	my($file,$clo) = @_;
Packit 284210
	my %cfg = ();
Packit 284210
Packit 284210
	print STDERR "Parsing config: $file\n" if ($opt{d});
Packit 284210
	open(CFG, "<$file") or die "Failed to open config \"$file\": $!\n";
Packit 284210
	while(<CFG>) {
Packit 284210
		# Skip comments and empty lines
Packit 284210
		next if (/^\s*(?:#|$)/);
Packit 284210
Packit 284210
		# Parse
Packit 284210
		chomp;
Packit 284210
		my($var,$q1,$val,$q2) = (m/^\s*(\S+)\s+(['"]?)(.*)(\2)\s*$/);
Packit 284210
Packit 284210
		# Fixup values
Packit 284210
		$var = lc($var);
Packit 284210
		if ($val =~ m/^(?:true|on)$/i) { $val = 1 };
Packit 284210
		if ($val =~ m/^(?:false|off)$/i) { $val = 0 };
Packit 284210
Packit 284210
		# Set opts
Packit 284210
		if    ($var eq "repositoryuri")       { $cfg{r} = $val }
Packit 284210
		elsif ($var eq "localrepository")        { $cfg{p} = $val }
Packit 284210
		elsif ($var eq "localrules")       { $cfg{s} = $val }
Packit 284210
		elsif ($var eq "version")          { $cfg{v} = $val }
Packit 284210
		elsif ($var eq "timeout")          { $cfg{t} = $val }
Packit 284210
		elsif ($var eq "notifyemail")      { $cfg{e} = $val }
Packit 284210
		elsif ($var eq "notifyemailfrom")  { $cfg{f} = $val }
Packit 284210
		elsif ($var eq "notifyemaildiff")  { $cfg{E} = $val }
Packit 284210
		elsif ($var eq "unpack")           { $cfg{u} = $val }
Packit 284210
		elsif ($var eq "debug")            { $cfg{d} = $val }
Packit 284210
		else { die "Invalid config directive: $var\n" }
Packit 284210
	}
Packit 284210
	close CFG;
Packit 284210
Packit 284210
	my($k, $v);
Packit 284210
	while (($k, $v) = each %{$clo || {}}) {
Packit 284210
		$cfg{$k} = $v if (defined $v);
Packit 284210
	}
Packit 284210
Packit 284210
	return %cfg;
Packit 284210
}
Packit 284210
Packit 284210
sub repository_dump {
Packit 284210
	my @replist = repository_listing();
Packit 284210
Packit 284210
	print STDERR "\nRepository: $opt{r}\n\n";
Packit 284210
	unless (@replist) {
Packit 284210
		print STDERR "No matching entries.\n";
Packit 284210
		return;
Packit 284210
	}
Packit 284210
Packit 284210
	for my $repo (@replist) {
Packit 284210
		print "$repo {\n";
Packit 284210
		my @versions = ruleset_available_versions($repo);
Packit 284210
		for my $version (@versions) {
Packit 284210
			if ($version =~ m/$opt{v}/) {
Packit 284210
				printf "%15s: %s_%s.zip\n", $version, $repo, $version;
Packit 284210
			}
Packit 284210
			elsif ($opt{d}) {
Packit 284210
				print STDERR "Skipping version: $version\n";
Packit 284210
			}
Packit 284210
		}
Packit 284210
		print "}\n";
Packit 284210
	}
Packit 284210
}
Packit 284210
Packit 284210
sub repository_listing {
Packit 284210
	my $res = $ua->get("$opt{r}/.listing");
Packit 284210
	unless ($res->is_success()) {
Packit 284210
		die "Failed to get repository listing \"$opt{r}/.listing\": ".$res->status_line()."\n";
Packit 284210
	}
Packit 284210
	return grep(/\S/, split(/$CRLFRE/, $res->content)) ;
Packit 284210
}
Packit 284210
Packit 284210
sub ruleset_listing {
Packit 284210
	my $res = $ua->get("$opt{r}/$_[0]/.listing");
Packit 284210
	unless ($res->is_success()) {
Packit 284210
		die "Failed to get ruleset listing \"$opt{r}/$_[0]/.listing\": ".$res->status_line()."\n";
Packit 284210
	}
Packit 284210
	return grep(/\S/, split(/$CRLFRE/, $res->content)) ;
Packit 284210
}
Packit 284210
Packit 284210
sub ruleset_available_versions {
Packit 284210
	return sort sort_versions map { m/_([^_]+)\.zip.*$/; $1 } ruleset_listing($_[0]);
Packit 284210
}
Packit 284210
Packit 284210
sub ruleset_fetch {
Packit 284210
	my($repo, $version) = @_;
Packit 284210
Packit 284210
	# Create paths
Packit 284210
	if (! -e "$opt{p}" ) {
Packit 284210
		mkdir "$opt{p}" or die "Failed to create \"$opt{p}\": $!\n";
Packit 284210
	}
Packit 284210
	if (! -e "$opt{p}/$repo" ) {
Packit 284210
		mkdir "$opt{p}/$repo" or die "Failed to create \"$opt{p}/$repo\": $!\n";
Packit 284210
	}
Packit 284210
Packit 284210
	my $fn = "${repo}_$version.zip";
Packit 284210
	my $ruleset = "$repo/$fn";
Packit 284210
	my $ruleset_sig = "$repo/$fn.sig";
Packit 284210
Packit 284210
	if (-e "$opt{p}/$ruleset") {
Packit 284210
		die "Refused to overwrite ruleset \"$opt{p}/$ruleset\".\n";
Packit 284210
	}
Packit 284210
Packit 284210
	# Fetch the ruleset
Packit 284210
	print STDERR "Fetching: $ruleset ...\n";
Packit 284210
	my $res = $ua->get(
Packit 284210
		"$opt{r}/$ruleset",
Packit 284210
		":content_file" => "$opt{p}/$ruleset",
Packit 284210
	);
Packit 284210
	die "Failed to retrieve ruleset $ruleset: ".$res->status_line()."\n" unless ($res->is_success());
Packit 284210
Packit 284210
	# Fetch the ruleset signature
Packit 284210
	if (-e "$opt{p}/$ruleset_sig") {
Packit 284210
		die "Refused to overwrite ruleset signature \"$opt{p}/$ruleset_sig\".\n";
Packit 284210
	}
Packit 284210
	$res = $ua->get(
Packit 284210
		"$opt{r}/$ruleset_sig",
Packit 284210
		":content_file" => "$opt{p}/$ruleset_sig",
Packit 284210
	);
Packit 284210
Packit 284210
	# Verify the signature if we can
Packit 284210
	if ($HAVE_GNUPG) {
Packit 284210
		die "Failed to retrieve ruleset signature $ruleset_sig: ".$res->status_line()."\n" unless ($res->is_success());
Packit 284210
Packit 284210
		ruleset_verifysig("$opt{p}/$ruleset", "$opt{p}/$ruleset_sig");
Packit 284210
	}
Packit 284210
	push @fetched, [$repo, $version, $ruleset, undef];
Packit 284210
}
Packit 284210
Packit 284210
sub ruleset_unpack {
Packit 284210
	my($repo, $version, $ruleset) = @{ $_[0] || [] };
Packit 284210
	my $fn = "$opt{p}/$ruleset";
Packit 284210
Packit 284210
	if (! -e "$fn" ) {
Packit 284210
		die "Internal Error: No ruleset to unpack - \"$fn\"\n";
Packit 284210
	}
Packit 284210
Packit 284210
	# Create paths
Packit 284210
	if (! -e "$opt{s}" ) {
Packit 284210
		mkdir "$opt{s}" or die "Failed to create \"$opt{p}\": $!\n";
Packit 284210
	}
Packit 284210
	if (! -e "$opt{s}/$repo" ) {
Packit 284210
		mkdir "$opt{s}/$repo" or die "Failed to create \"$opt{p}/$repo\": $!\n";
Packit 284210
	}
Packit 284210
	if (! -e "$opt{s}/$repo/$version" ) {
Packit 284210
		mkdir "$opt{s}/$repo/$version" or die "Failed to create \"$opt{p}/$repo/$version\": $!\n";
Packit 284210
	}
Packit 284210
	else {
Packit 284210
		die "Refused to overwrite previously unpacked \"$opt{s}/$repo/$version\".\n";
Packit 284210
	}
Packit 284210
Packit 284210
	# TODO: Verify sig
Packit 284210
Packit 284210
	my $pwd = getcwd();
Packit 284210
	my $unpackdir = "$opt{s}/$repo/$version";
Packit 284210
	chdir "$unpackdir";
Packit 284210
	if ($@) {
Packit 284210
		my $err = $!;
Packit 284210
		chdir $pwd;
Packit 284210
		die "Failed to chdir to \"$unpackdir\": $err\n";
Packit 284210
	}
Packit 284210
	undef $!;
Packit 284210
	system(@$UNZIP, $fn);
Packit 284210
	if ($? != 0) {
Packit 284210
		my $err = $!;
Packit 284210
		chdir $pwd;
Packit 284210
		die "Failed to unpack \"$unpackdir\"".($err?": $err":".")."\n";
Packit 284210
	}
Packit 284210
	chdir $pwd;
Packit 284210
Packit 284210
	# Add where we unpacked it
Packit 284210
	$_->[3] = $unpackdir;
Packit 284210
Packit 284210
	return 0;
Packit 284210
}
Packit 284210
Packit 284210
sub ruleset_fetch_latest {
Packit 284210
	my($repo, @type) = @_;
Packit 284210
	my @versions = ruleset_available_versions($repo);
Packit 284210
	my $verre = defined($opt{v}) ? qr/^$opt{v}/ : qr/^/;
Packit 284210
	my $typere = undef;
Packit 284210
	
Packit 284210
	# Figure out what to look for
Packit 284210
	if (@type == 1 and $type[0] ne "") {
Packit 284210
        my $type = $type[0];
Packit 284210
		if ($type eq "UNSTABLE") {
Packit 284210
			$typere = qr/\d-\D+\d+$/;
Packit 284210
		}
Packit 284210
		else {
Packit 284210
			$typere = qr/\d-$type\d+$/;
Packit 284210
		}
Packit 284210
	}
Packit 284210
	elsif (@type > 1) {
Packit 284210
        my $type;
Packit 284210
        for (@type) {
Packit 284210
            if ($_ eq "") {
Packit 284210
                $type .= ($type?"|":"").qr/\.\d+$/;
Packit 284210
            }
Packit 284210
            elsif ($_ eq "UNSTABLE") {
Packit 284210
                $type .= ($type?"|":"").qr/\d-\D+\d+$/;
Packit 284210
            }
Packit 284210
            else {
Packit 284210
                $type .= ($type?"|":"").qr/\d-$_\d+$/;
Packit 284210
            }
Packit 284210
        }
Packit 284210
Packit 284210
        $typere = qr/$type/;
Packit 284210
    }
Packit 284210
    else {
Packit 284210
		$typere = qr/\.\d+$/;
Packit 284210
    }
Packit 284210
Packit 284210
    if ($opt{d}) {
Packit 284210
        print STDERR "REPO: $repo\n";
Packit 284210
        print STDERR "TYPES: ".join(", ", @type)."\n";
Packit 284210
        print STDERR "VERSIONS: ".join(", ", @versions)."\n";
Packit 284210
        print STDERR "REGEX: version=$opt{v} type=$typere\n";
Packit 284210
    }
Packit 284210
Packit 284210
	while (@versions) {
Packit 284210
		my $last = pop(@versions);
Packit 284210
		# Check REs on version
Packit 284210
		if ($last =~ m/$opt{v}/ and (!defined($typere) || $last =~ m/$typere/)) {
Packit 284210
			return ruleset_fetch($repo, $last);
Packit 284210
		}
Packit 284210
		if ($opt{d}) {
Packit 284210
			print STDERR "Skipping version: $last\n";
Packit 284210
		}
Packit 284210
	}
Packit 284210
Packit 284210
	die "No '".join("' or '", @type)."' ruleset found.\n";
Packit 284210
}
Packit 284210
Packit 284210
sub notify_email {
Packit 284210
	my $version_text = join("\n", map { "$_->[0] v$_->[1]".(defined($_->[3])?": $_->[3]":"") } @_);
Packit 284210
	my $from = $opt{f} ? "From: $opt{f}\n" : "";
Packit 284210
	my $body = << "EOT";
Packit 284210
ModSecurity rulesets updated and ready to install on host $HOST:
Packit 284210
Packit 284210
$version_text
Packit 284210
Packit 284210
ModSecurity - http://www.modsecurity.org/
Packit 284210
EOT
Packit 284210
Packit 284210
	# TODO: Diffs
Packit 284210
Packit 284210
	open(SM, "|-", @$SENDMAIL) or die "Failed to send mail: $!\n";
Packit 284210
	print STDERR "Sending notification email to: $opt{e}\n";
Packit 284210
	print SM << "EOT";
Packit 284210
${from}To: $opt{e}
Packit 284210
Subject: [$HOST] ModSecurity Ruleset Update Notification
Packit 284210
Packit 284210
$body
Packit 284210
EOT
Packit 284210
	close SM;
Packit 284210
}
Packit 284210
Packit 284210
sub ruleset_verifysig {
Packit 284210
	my($fn, $sigfn) = @_;
Packit 284210
Packit 284210
	print STDERR "Verifying \"$fn\" with signature \"$sigfn\"\n";
Packit 284210
	my $gpg = new GnuPG();
Packit 284210
	my $sig = eval { $gpg->verify( signature => $sigfn, file => $fn ) };
Packit 284210
	if (defined $sig) {
Packit 284210
		print STDERR sig2str($sig)."\n"; 
Packit 284210
	}
Packit 284210
	if (!defined($sig)) {
Packit 284210
		die "Signature validation failed.\n";
Packit 284210
	}
Packit 284210
	if ( $sig->{trust} < $REQUIRED_SIG_TRUST ) {
Packit 284210
		die "Signature is not trusted ".$GPG_TRUST{$REQUIRED_SIG_TRUST}.".\n";
Packit 284210
	}
Packit 284210
Packit 284210
	return;
Packit 284210
}
Packit 284210
Packit 284210
sub sig2str {
Packit 284210
	my %sig = %{ $_[0] || {} };
Packit 284210
	"Signature made ".localtime($sig{timestamp})." by $sig{user} (ID: $sig{keyid}) and is $GPG_TRUST{$sig{trust}} trusted.";
Packit 284210
}
Packit 284210
Packit 284210
################################################################################
Packit 284210
################################################################################
Packit 284210
Packit 284210
# List what is there
Packit 284210
if ($opt{l}) { repository_dump(); exit 0 }
Packit 284210
# Latest stable
Packit 284210
elsif (defined($opt{S})) { ruleset_fetch_latest($opt{S}, "") }
Packit 284210
# Latest development
Packit 284210
elsif (defined($opt{D})) { ruleset_fetch_latest($opt{D}, "dev") }
Packit 284210
# Latest release candidate
Packit 284210
elsif (defined($opt{R})) { ruleset_fetch_latest($opt{R}, "rc") }
Packit 284210
# Latest unstable
Packit 284210
elsif (defined($opt{U})) { ruleset_fetch_latest($opt{U}, "UNSTABLE") }
Packit 284210
# Latest release candidate or stable
Packit 284210
elsif (defined($opt{L})) { ruleset_fetch_latest($opt{R}, "rc", "") }
Packit 284210
# Latest (any type)
Packit 284210
elsif (defined($opt{F})) { ruleset_fetch_latest($opt{F}, undef) }
Packit 284210
Packit 284210
# Unpack
Packit 284210
if ($opt{u}) {
Packit 284210
	if (! defined $opt{s} ) { usage(1, "LocalRules is required for unpacking.") }
Packit 284210
	for (@fetched) {
Packit 284210
		ruleset_unpack($_);
Packit 284210
	}
Packit 284210
}
Packit 284210
Packit 284210
# Unpack
Packit 284210
if ($opt{e}) {
Packit 284210
	notify_email(@fetched);
Packit 284210
}