[ipfire-2.x.git] / config / cfgroot / ids-functions.pl

#!/usr/bin/perl -w
############################################################################
#                                                                          #
# This file is part of the IPFire Firewall.                                #
#                                                                          #
# IPFire is free software; you can redistribute it and/or modify           #
# it under the terms of the GNU General Public License as published by     #
# the Free Software Foundation; either version 2 of the License, or        #
# (at your option) any later version.                                      #
#                                                                          #
# IPFire is distributed in the hope that it will be useful,                #
# but WITHOUT ANY WARRANTY; without even the implied warranty of           #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            #
# GNU General Public License for more details.                             #
#                                                                          #
# You should have received a copy of the GNU General Public License        #
# along with IPFire; if not, write to the Free Software                    #
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA #
#                                                                          #
# Copyright (C) 2018 IPFire Team <info@ipfire.org>.                        #
#                                                                          #
############################################################################

package IDS;

require '/var/ipfire/general-functions.pl';

# Location where all config and settings files are stored.
our $settingsdir = "${General::swroot}/suricata";

# Location and name of the tarball which contains the ruleset.
our $rulestarball = "/var/tmp/idsrules.tar.gz";

# File to store any errors, which also will be read and displayed by the wui.
our $storederrorfile = "/tmp/ids_storederror";

# Location where the rulefiles are stored.
our $rulespath = "/etc/suricata/rules";

# File which contains a list of all supported ruleset sources.
# (Sourcefire, Emergingthreads, etc..)
our $rulesetsourcesfile = "$settingsdir/ruleset-sources";

#
## Function for checking if at least 300MB of free disk space are available
## on the "/var" partition.
#
sub checkdiskspace () {
	# Call diskfree to gather the free disk space of /var.
	my @df = `/bin/df -B M /var`;

	# Loop through the output.
	foreach my $line (@df) {
		# Ignore header line.
		next if $line =~ m/^Filesystem/;

		# Search for a line with the device information.
		if ($line =~ m/dev/ ) {
			# Split the line into single pieces.
			my @values = split(' ', $line);
			my ($filesystem, $blocks, $used, $available, $used_perenctage, $mounted_on) = @values;

			# Check if the available disk space is more than 300MB.
			if ($available < 300) {
				# Log error to syslog.
				&_log_to_syslog("Not enough free disk space on /var. Only $available MB from 300 MB available.");

				# Exit function and return "1" - False.
				return 1;
			}
		}
	}

	# Everything okay, return nothing.
	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("$settingsdir/settings", \%snortsettings);

	# Get all available ruleset locations.
	my %rulesetsources=();
	&General::readhash($rulesetsourcesfile, \%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 {
			# Log error message and break.
			&_log_to_syslog("Could not proper configure the proxy server access.");

			# Return "1" - false.
			return 1;
		}

		# 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) {
		# Log error and abort.
		&_log_to_syslog("Unable to gather a download URL for the selected ruleset.");
		return 1;
	}

	# 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) {
		# Log error message.
		&_log_to_syslog("Unable to download the ruleset. $response->status_line");

		# Return "1" - false.
		return 1;
	}

	# If we got here, everything worked fine. Return nothing.
	return;
}

#
## A tiny wrapper function to call the oinkmaster script.
#
sub oinkmaster () {
	# Load perl module to talk to the kernel syslog.
	use Sys::Syslog qw(:DEFAULT setlogsock);

	# Establish the connection to the syslog service.
	openlog('oinkmaster', 'cons,pid', 'user');

	# Call oinkmaster to generate ruleset.
	open(OINKMASTER, "/usr/local/bin/oinkmaster.pl -v -s -u file://$rulestarball -C $settingsdir/oinkmaster.conf -o $rulespath|");

	# Log output of oinkmaster to syslog.
	while(<OINKMASTER>) {
		# The syslog function works best with an array based input,
		# so generate one before passing the message details to syslog.
		my @syslog = ("INFO", "$_");

		# Send the log message.
		syslog(@syslog);
	}

	# Close the pipe to oinkmaster process.
	close(OINKMASTER);

	# Close the log handle.
	closelog();
}

#
## Function to do all the logging stuff if the downloading or updating of the ruleset fails.
#
sub log_error ($) {
	my ($error) = @_;

	# Remove any newline.
	chomp($error);

	# Call private function to log the error message to syslog.
	&_log_to_syslog($error);

	# Call private function to write/store the error message in the storederrorfile.
	&_store_error_message($error);
}

#
## Function to log a given error message to the kernel syslog.
#
sub _log_to_syslog ($) {
	my ($message) = @_;

	# Load perl module to talk to the kernel syslog.
	use Sys::Syslog qw(:DEFAULT setlogsock);

	# The syslog function works best with an array based input,
	# so generate one before passing the message details to syslog.
	my @syslog = ("ERR", "<ERROR> $message");

	# Establish the connection to the syslog service.
	openlog('oinkmaster', 'cons,pid', 'user');

	# Send the log message.
	syslog(@syslog);

	# Close the log handle.
	closelog();
}

#
## Private function to write a given error message to the storederror file.
#
sub _store_error_message ($) {
        my ($message) = @_;

	# Remove any newline.
	chomp($message);

        # Open file for writing.
        open (ERRORFILE, ">$storederrorfile") or die "Could not write to $storederrorfile. $!\n";

        # Write error to file.
        print ERRORFILE "$message\n";

        # Close file.
        close (ERRORFILE);
}

#
## Function to get a list of all available network zones.
#
sub get_available_network_zones () {
	# Get netsettings.
	my %netsettings = ();
	&General::readhash("${General::swroot}/ethernet/settings", \%netsettings);

	# Obtain the configuration type from the netsettings hash.
	my $config_type = $netsettings{'CONFIG_TYPE'};

	# Hash which contains the conversation from the config mode
	# to the existing network interface names. They are stored like
	# an array.
	#
	# Mode "0" red is a modem and green
	# Mode "1" red is a netdev and green
	# Mode "2" red, green and orange
	# Mode "3" red, green and blue
	# Mode "4" red, green, blue, orange
	my %config_type_to_interfaces = (
		"0" => [ "red", "green" ],
		"1" => [ "red", "green" ],
		"2" => [ "red", "green", "orange" ],
		"3" => [ "red", "green", "blue" ],
		"4" => [ "red", "green", "blue", "orange" ]
	);

	# Obtain and dereference the corresponding network interaces based on the read
	# network config type.
	my @network_zones = @{ $config_type_to_interfaces{$config_type} };

	# Return them.
	return @network_zones;
}

1;
Commit	Line	Data
8dcebe53 SS	1	#!/usr/bin/perl -w
	2	############################################################################
	3	# #
	4	# This file is part of the IPFire Firewall. #
	5	# #
	6	# IPFire is free software; you can redistribute it and/or modify #
	7	# it under the terms of the GNU General Public License as published by #
	8	# the Free Software Foundation; either version 2 of the License, or #
	9	# (at your option) any later version. #
	10	# #
	11	# IPFire is distributed in the hope that it will be useful, #
	12	# but WITHOUT ANY WARRANTY; without even the implied warranty of #
	13	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
	14	# GNU General Public License for more details. #
	15	# #
	16	# You should have received a copy of the GNU General Public License #
	17	# along with IPFire; if not, write to the Free Software #
	18	# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA #
	19	# #
	20	# Copyright (C) 2018 IPFire Team <info@ipfire.org>. #
	21	# #
	22	############################################################################
	23
	24	package IDS;
	25
	26	require '/var/ipfire/general-functions.pl';
8dcebe53	27
02844177	28	# Location where all config and settings files are stored.
164eab66	29	our $settingsdir = "${General::swroot}/suricata";
02844177	30
eea2670b	31	# Location and name of the tarball which contains the ruleset.
164eab66	32	our $rulestarball = "/var/tmp/idsrules.tar.gz";
eea2670b	33
3983aebd	34	# File to store any errors, which also will be read and displayed by the wui.
77910792	35	our $storederrorfile = "/tmp/ids_storederror";
3983aebd	36
298ef5ba	37	# Location where the rulefiles are stored.
164eab66	38	our $rulespath = "/etc/suricata/rules";
298ef5ba	39
bce84f39 SS	40	# File which contains a list of all supported ruleset sources.
	41	# (Sourcefire, Emergingthreads, etc..)
	42	our $rulesetsourcesfile = "$settingsdir/ruleset-sources";
	43
8dcebe53 SS	44	#
	45	## Function for checking if at least 300MB of free disk space are available
	46	## on the "/var" partition.
	47	#
	48	sub checkdiskspace () {
	49	# Call diskfree to gather the free disk space of /var.
	50	my @df = `/bin/df -B M /var`;
	51
	52	# Loop through the output.
	53	foreach my $line (@df) {
	54	# Ignore header line.
	55	next if $line =~ m/^Filesystem/;
	56
	57	# Search for a line with the device information.
	58	if ($line =~ m/dev/ ) {
	59	# Split the line into single pieces.
	60	my @values = split(' ', $line);
	61	my ($filesystem, $blocks, $used, $available, $used_perenctage, $mounted_on) = @values;
	62
	63	# Check if the available disk space is more than 300MB.
	64	if ($available < 300) {
434001d0 SS	65	# Log error to syslog.
434001d0 SS	66	&_log_to_syslog("Not enough free disk space on /var. Only $available MB from 300 MB available.");
8dcebe53	67
434001d0 SS	68	# Exit function and return "1" - False.
434001d0 SS	69	return 1;
8dcebe53 SS	70	}
	71	}
	72	}
	73
	74	# Everything okay, return nothing.
	75	return;
	76	}
	77
eea2670b SS	78	#
	79	## This function is responsible for downloading the configured snort ruleset.
	80	##
	81	## * At first it obtains from the stored snortsettings which ruleset should be downloaded.
	82	## * The next step is to get the download locations for all available rulesets.
	83	## * After that, the function will check if an upstream proxy should be used and grab the settings.
	84	## * The last step will be to generate the final download url, by obtaining the URL for the desired
	85	## ruleset, add the settings for the upstream proxy and final grab the rules tarball from the server.
	86	#
	87	sub downloadruleset {
	88	# Get snort settings.
	89	my %snortsettings=();
02844177	90	&General::readhash("$settingsdir/settings", \%snortsettings);
eea2670b SS	91
	92	# Get all available ruleset locations.
	93	my %rulesetsources=();
bce84f39	94	&General::readhash($rulesetsourcesfile, \%rulesetsources);
eea2670b SS	95
	96	# Read proxysettings.
	97	my %proxysettings=();
	98	&General::readhash("${General::swroot}/proxy/settings", \%proxysettings);
	99
	100	# Load required perl module to handle the download.
	101	use LWP::UserAgent;
	102
	103	# Init the download module.
	104	my $downloader = LWP::UserAgent->new;
	105
	106	# Set timeout to 10 seconds.
	107	$downloader->timeout(10);
	108
	109	# Check if an upstream proxy is configured.
	110	if ($proxysettings{'UPSTREAM_PROXY'}) {
	111	my ($peer, $peerport) = (/^(?:[a-zA-Z ]+\:\/\/)?(?:[A-Za-z0-9\_\.\-]?(?:\:[A-Za-z0-9\_\.\-]?)?\@)?([a-zA-Z0-9\.\_\-]?)(?:\:([0-9]{1,5}))?(?:\/.?)?$/);
	112	my $proxy_url;
	113
	114	# Check if we got a peer.
	115	if ($peer) {
	116	$proxy_url = "http://";
	117
	118	# Check if the proxy requires authentication.
	119	if (($proxysettings{'UPSTREAM_USER'}) && ($proxysettings{'UPSTREAM_PASSWORD'})) {
	120	$proxy_url .= "$proxysettings{'UPSTREAM_USER'}\:$proxysettings{'UPSTREAM_PASSWORD'}\@";
	121	}
	122
	123	# Add proxy server address and port.
	124	$proxy_url .= "$peer\:$peerport";
	125	} else {
434001d0 SS	126	# Log error message and break.
	127	&_log_to_syslog("Could not proper configure the proxy server access.");
	128
	129	# Return "1" - false.
	130	return 1;
eea2670b SS	131	}
	132
	133	# Setup proxy settings.
	134	$downloader->proxy('http', $proxy_url);
	135	}
	136
	137	# Grab the right url based on the configured vendor.
	138	my $url = $rulesetsources{$snortsettings{'RULES'}};
	139
	140	# Check if the vendor requires an oinkcode and add it if needed.
	141	$url =~ s/\<oinkcode\>/$snortsettings{'OINKCODE'}/g;
	142
	143	# Abort if no url could be determined for the vendor.
	144	unless ($url) {
434001d0 SS	145	# Log error and abort.
	146	&_log_to_syslog("Unable to gather a download URL for the selected ruleset.");
	147	return 1;
eea2670b SS	148	}
	149
	150	# Pass the requested url to the downloader.
	151	my $request = HTTP::Request->new(GET => $url);
	152
	153	# Perform the request and save the output into the "$rulestarball" file.
	154	my $response = $downloader->request($request, $rulestarball);
	155
	156	# Check if there was any error.
	157	unless ($response->is_success) {
434001d0 SS	158	# Log error message.
	159	&_log_to_syslog("Unable to download the ruleset. $response->status_line");
	160
	161	# Return "1" - false.
	162	return 1;
eea2670b SS	163	}
	164
	165	# If we got here, everything worked fine. Return nothing.
	166	return;
	167	}
8dcebe53	168
25f5cb0d SS	169	#
	170	## A tiny wrapper function to call the oinkmaster script.
	171	#
	172	sub oinkmaster () {
0e40e1e7 SS	173	# Load perl module to talk to the kernel syslog.
	174	use Sys::Syslog qw(:DEFAULT setlogsock);
	175
	176	# Establish the connection to the syslog service.
	177	openlog('oinkmaster', 'cons,pid', 'user');
	178
25f5cb0d	179	# Call oinkmaster to generate ruleset.
02844177	180	open(OINKMASTER, "/usr/local/bin/oinkmaster.pl -v -s -u file://$rulestarball -C $settingsdir/oinkmaster.conf -o $rulespath\|");
0e40e1e7 SS	181
	182	# Log output of oinkmaster to syslog.
	183	while(<OINKMASTER>) {
	184	# The syslog function works best with an array based input,
	185	# so generate one before passing the message details to syslog.
	186	my @syslog = ("INFO", "$_");
	187
	188	# Send the log message.
	189	syslog(@syslog);
	190	}
	191
	192	# Close the pipe to oinkmaster process.
	193	close(OINKMASTER);
	194
	195	# Close the log handle.
	196	closelog();
25f5cb0d SS	197	}
25f5cb0d SS	198
3983aebd SS	199	#
	200	## Function to do all the logging stuff if the downloading or updating of the ruleset fails.
	201	#
	202	sub log_error ($) {
	203	my ($error) = @_;
	204
	205	# Remove any newline.
	206	chomp($error);
	207
eb5592c1 SS	208	# Call private function to log the error message to syslog.
	209	&_log_to_syslog($error);
	210
3983aebd SS	211	# Call private function to write/store the error message in the storederrorfile.
	212	&_store_error_message($error);
	213	}
	214
eb5592c1 SS	215	#
	216	## Function to log a given error message to the kernel syslog.
	217	#
	218	sub _log_to_syslog ($) {
	219	my ($message) = @_;
	220
	221	# Load perl module to talk to the kernel syslog.
	222	use Sys::Syslog qw(:DEFAULT setlogsock);
	223
	224	# The syslog function works best with an array based input,
	225	# so generate one before passing the message details to syslog.
	226	my @syslog = ("ERR", "<ERROR> $message");
	227
	228	# Establish the connection to the syslog service.
	229	openlog('oinkmaster', 'cons,pid', 'user');
	230
	231	# Send the log message.
	232	syslog(@syslog);
	233
	234	# Close the log handle.
	235	closelog();
	236	}
	237
3983aebd SS	238	#
	239	## Private function to write a given error message to the storederror file.
	240	#
	241	sub _store_error_message ($) {
	242	my ($message) = @_;
	243
	244	# Remove any newline.
	245	chomp($message);
	246
	247	# Open file for writing.
	248	open (ERRORFILE, ">$storederrorfile") or die "Could not write to $storederrorfile. $!\n";
	249
	250	# Write error to file.
	251	print ERRORFILE "$message\n";
	252
	253	# Close file.
	254	close (ERRORFILE);
	255	}
	256
1cae702c SS	257	#
	258	## Function to get a list of all available network zones.
	259	#
	260	sub get_available_network_zones () {
	261	# Get netsettings.
	262	my %netsettings = ();
	263	&General::readhash("${General::swroot}/ethernet/settings", \%netsettings);
	264
	265	# Obtain the configuration type from the netsettings hash.
	266	my $config_type = $netsettings{'CONFIG_TYPE'};
	267
	268	# Hash which contains the conversation from the config mode
	269	# to the existing network interface names. They are stored like
	270	# an array.
	271	#
	272	# Mode "0" red is a modem and green
	273	# Mode "1" red is a netdev and green
	274	# Mode "2" red, green and orange
	275	# Mode "3" red, green and blue
	276	# Mode "4" red, green, blue, orange
	277	my %config_type_to_interfaces = (
	278	"0" => [ "red", "green" ],
	279	"1" => [ "red", "green" ],
	280	"2" => [ "red", "green", "orange" ],
	281	"3" => [ "red", "green", "blue" ],
	282	"4" => [ "red", "green", "blue", "orange" ]
	283	);
	284
	285	# Obtain and dereference the corresponding network interaces based on the read
	286	# network config type.
	287	my @network_zones = @{ $config_type_to_interfaces{$config_type} };
	288
	289	# Return them.
	290	return @network_zones;
	291	}
	292
8dcebe53	293	1;