From: Stefan Schantl <stefan.schantl@ipfire.org>
Date: Wed, 14 Feb 2018 07:52:21 +0000 (+0100)
Subject: ids.cgi: Move downloader code to ids-functions.pl
X-Git-Tag: suricata-beta3~33^2~39^2~13
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=eea2670b39ee6ba804d534e95b03d27059e45468;p=people%2Fstevee%2Fipfire-2.x.git

ids.cgi: Move downloader code to ids-functions.pl

Signed-off-by: Stefan Schantl <stefan.schantl@ipfire.org>
---

diff --git a/config/cfgroot/ids-functions.pl b/config/cfgroot/ids-functions.pl
index 52825ee427..75f806f2db 100644
--- a/config/cfgroot/ids-functions.pl
+++ b/config/cfgroot/ids-functions.pl
@@ -26,6 +26,9 @@ package IDS;
 require '/var/ipfire/general-functions.pl';
 require "${General::swroot}/lang.pl";
 
+# Location and name of the tarball which contains the ruleset.
+my $rulestarball = "/var/tmp/snortrules.tar.gz";
+
 #
 ## Function for checking if at least 300MB of free disk space are available
 ## on the "/var" partition.
@@ -60,5 +63,88 @@ sub checkdiskspace () {
 	return;
 }
 
+#
+## This function is responsible for downloading the configured snort ruleset.
+##
+## * At first it obtains from the stored snortsettings which ruleset should be downloaded.
+## * The next step is to get the download locations for all available rulesets.
+## * After that, the function will check if an upstream proxy should be used and grab the settings.
+## * The last step will be to generate the final download url, by obtaining the URL for the desired
+##   ruleset, add the settings for the upstream proxy and final grab the rules tarball from the server.
+#
+sub downloadruleset {
+	# Get snort settings.
+	my %snortsettings=();
+	&General::readhash("${General::swroot}/snort/settings", \%snortsettings);
+
+	# Get all available ruleset locations.
+	my %rulesetsources=();
+	&General::readhash("${General::swroot}/snort/ruleset-sources.list", \%rulesetsources);
+
+	# Read proxysettings.
+	my %proxysettings=();
+	&General::readhash("${General::swroot}/proxy/settings", \%proxysettings);
+
+	# Load required perl module to handle the download.
+	use LWP::UserAgent;
+
+	# Init the download module.
+	my $downloader = LWP::UserAgent->new;
+
+	# Set timeout to 10 seconds.
+	$downloader->timeout(10);
+
+	# Check if an upstream proxy is configured.
+	if ($proxysettings{'UPSTREAM_PROXY'}) {
+		my ($peer, $peerport) = (/^(?:[a-zA-Z ]+\:\/\/)?(?:[A-Za-z0-9\_\.\-]*?(?:\:[A-Za-z0-9\_\.\-]*?)?\@)?([a-zA-Z0-9\.\_\-]*?)(?:\:([0-9]{1,5}))?(?:\/.*?)?$/);
+		my $proxy_url;
+
+		# Check if we got a peer.
+		if ($peer) {
+			$proxy_url = "http://";
+
+			# Check if the proxy requires authentication.
+			if (($proxysettings{'UPSTREAM_USER'}) && ($proxysettings{'UPSTREAM_PASSWORD'})) {
+				$proxy_url .= "$proxysettings{'UPSTREAM_USER'}\:$proxysettings{'UPSTREAM_PASSWORD'}\@";
+			}
+
+			# Add proxy server address and port.
+			$proxy_url .= "$peer\:$peerport";
+		} else {
+			# Break and return error message.
+			return "$Lang::tr{'could not download latest updates'}";
+		}
+
+		# Setup proxy settings.
+		$downloader->proxy('http', $proxy_url);
+	}
+
+	# Grab the right url based on the configured vendor.
+	my $url = $rulesetsources{$snortsettings{'RULES'}};
+
+	# Check if the vendor requires an oinkcode and add it if needed.
+	$url =~ s/\<oinkcode\>/$snortsettings{'OINKCODE'}/g;
+
+	# Abort if no url could be determined for the vendor.
+	unless ($url) {
+		# Abort and return errormessage.
+		return "$Lang::tr{'could not download latest updates'}";
+	}
+
+	# Pass the requested url to the downloader.
+	my $request = HTTP::Request->new(GET => $url);
+
+	# Perform the request and save the output into the "$rulestarball" file.
+	my $response = $downloader->request($request, $rulestarball);
+
+	# Check if there was any error.
+	unless ($response->is_success) {
+		# Return error message.
+		return "$response->status_line";
+	}
+
+	# If we got here, everything worked fine. Return nothing.
+	return;
+}
 
 1;
diff --git a/html/cgi-bin/ids.cgi b/html/cgi-bin/ids.cgi
index 926d5adbe2..c7c246ea5e 100644
--- a/html/cgi-bin/ids.cgi
+++ b/html/cgi-bin/ids.cgi
@@ -47,9 +47,6 @@ my %selected=();
 # Get netsettings.
 &General::readhash("${General::swroot}/ethernet/settings", \%netsettings);
 
-# Get all available ruleset locations.
-&General::readhash("${General::swroot}/snort/ruleset-sources.list", \%rulesetsources);
-
 my $rulestarball = "/var/tmp/snortrules.tar.gz";
 my $snortrulepath = "/etc/snort/rules";
 my $snortusedrulefilesfile = "${General::swroot}/snort/snort-used-rulefiles.conf";
@@ -285,7 +282,7 @@ if ($cgiparams{'RULESET'} eq $Lang::tr{'update'}) {
 	# Check if any errors happend.
 	unless ($errormessage) {
 		# Call subfunction to download the ruleset.
-		$errormessage = &downloadruleset();
+		$errormessage = &IDS::downloadruleset();
 	}
 
 	# Sleep for 1 second
@@ -601,72 +598,6 @@ END
         exit;
 }
 
-sub downloadruleset {
-	# Read proxysettings.
-	my %proxysettings=();
-	&General::readhash("${General::swroot}/proxy/settings", \%proxysettings);
-
-	# Load required perl module to handle the download.
-	use LWP::UserAgent;
-
-	# Init the download module.
-	my $downloader = LWP::UserAgent->new;
-
-	# Set timeout to 10 seconds.
-	$downloader->timeout(10);
-
-	# Check if an upstream proxy is configured.
-	if ($proxysettings{'UPSTREAM_PROXY'}) {
-		my ($peer, $peerport) = (/^(?:[a-zA-Z ]+\:\/\/)?(?:[A-Za-z0-9\_\.\-]*?(?:\:[A-Za-z0-9\_\.\-]*?)?\@)?([a-zA-Z0-9\.\_\-]*?)(?:\:([0-9]{1,5}))?(?:\/.*?)?$/);
-		my $proxy_url;
-
-		# Check if we got a peer.
-		if ($peer) {
-			$proxy_url = "http://";
-
-			# Check if the proxy requires authentication.
-			if (($proxysettings{'UPSTREAM_USER'}) && ($proxysettings{'UPSTREAM_PASSWORD'})) {
-				$proxy_url .= "$proxysettings{'UPSTREAM_USER'}\:$proxysettings{'UPSTREAM_PASSWORD'}\@";
-			}
-
-			# Add proxy server address and port.
-			$proxy_url .= "$peer\:$peerport";
-		} else {
-			# Break and return error message.
-			return "$Lang::tr{'could not download latest updates'}";
-		}
-
-		# Setup proxy settings.
-		$downloader->proxy('http', $proxy_url);
-	}
-
-	# Grab the right url based on the configured vendor.
-	my $url = $rulesetsources{$snortsettings{'RULES'}};
-
-        # Check if the vendor requires an oinkcode and add it if needed.
-        $url =~ s/\<oinkcode\>/$snortsettings{'OINKCODE'}/g;
-
-	# Abort if no url could be determined for the vendor.
-	unless ($url) {
-		# Abort and return errormessage.
-		return "$Lang::tr{'could not download latest updates'}";
-	}
-
-	# Pass the requested url to the downloader.
-	my $request = HTTP::Request->new(GET => $url);
-
-	# Perform the request and save the output into the "$rulestarball" file.
-	my $response = $downloader->request($request, $rulestarball);
-
-	# Check if there was any error.
-	unless ($response->is_success) {
-		return "$response->status_line";
-	}
-
-	# If we got here, everything worked fine. Return nothing.
-	return;
-}
-
 sub oinkmaster () {
 	# Call oinkmaster to generate ruleset.
 	system("/usr/local/bin/oinkmaster.pl -v -s -u file://$rulestarball -C /var/ipfire/snort/oinkmaster.conf -o /etc/snort/rules 2>&1 |logger -t oinkmaster");