ids-functions.pl: Add function to create empty files

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

diff --git a/config/cfgroot/ids-functions.pl b/config/cfgroot/ids-functions.pl
index 647aa1f4c83d7afe3c4ed3c9470821b40d3f768a..6f7f3ee7ef7eb07857a5982607c13fdf734a70b6 100644 (file)
--- a/config/cfgroot/ids-functions.pl
+++ b/config/cfgroot/ids-functions.pl
@@ -26,16 +26,29 @@ package IDS;
 require '/var/ipfire/general-functions.pl';
 
 # Location where all config and settings files are stored.
-our $settingsdir = "${General::swroot}/snort";
+our $settingsdir = "${General::swroot}/suricata";
 
 # Location and name of the tarball which contains the ruleset.
-our $rulestarball = "/var/tmp/snortrules.tar.gz";
+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/snort/rules";
+our $rulespath = "/etc/suricata/rules";
+
+# File which contains a list of all supported ruleset sources.
+# (Sourcefire, Emergingthreads, etc..)
+our $rulesetsourcesfile = "$settingsdir/ruleset-sources";
+
+# The pidfile of the IDS.
+our $idspidfile = "/var/run/suricata.pid";
+
+# Location of suricatactrl.
+my $suricatactrl = "/usr/local/bin/suricatactrl";
+
+# Array with allowed commands of suricatactrl.
+my @suricatactrl_cmds = ( 'start', 'stop', 'restart', 'reload' );
 
 #
 ## Function for checking if at least 300MB of free disk space are available
@@ -87,7 +100,7 @@ sub downloadruleset {
 
        # Get all available ruleset locations.
        my %rulesetsources=();
-       &General::readhash("$settingsdir/ruleset-sources.list", \%rulesetsources);
+       &General::readhash($rulesetsourcesfile, \%rulesetsources);
 
        # Read proxysettings.
        my %proxysettings=();
@@ -151,8 +164,11 @@ sub downloadruleset {
 
        # Check if there was any error.
        unless ($response->is_success) {
+               # Obtain error.
+               my $error = $response->content;
+
                # Log error message.
-               &_log_to_syslog("Unable to download the ruleset. $response->status_line");
+               &_log_to_syslog("Unable to download the ruleset. \($error\)");
 
                # Return "1" - false.
                return 1;
@@ -173,7 +189,7 @@ sub oinkmaster () {
        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|");
+       open(OINKMASTER, "/usr/local/bin/oinkmaster.pl -v -s -u file://$rulestarball -C $settingsdir/oinkmaster.conf -o $rulespath|") or die "Could not execute oinkmaster $!\n";
 
        # Log output of oinkmaster to syslog.
        while(<OINKMASTER>) {
@@ -250,4 +266,115 @@ sub _store_error_message ($) {
         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;
+}
+
+#
+## Function to check if the IDS is running.
+#
+sub ids_is_running () {
+       if(-f $idspidfile) {
+               # Open PID file for reading.
+               open(PIDFILE, "$idspidfile") or die "Could not open $idspidfile. $!\n";
+
+               # Grab the process-id.
+               my $pid = <PIDFILE>;
+
+               # Close filehandle.
+               close(PIDFILE);
+
+               # Remove any newline.
+               chomp($pid);
+
+               # Check if a directory for the process-id exists in proc.
+               if(-d "/proc/$pid") {
+                       # The IDS daemon is running return the process id.
+                       return $pid;
+               }
+       }
+
+       # Return nothing - IDS is not running.
+       return;
+}
+
+#
+## Function to call suricatactrl binary with a given command.
+#
+sub call_suricatactrl ($) {
+       # Get called option.
+       my ($option) = @_;
+
+       # Loop through the array of supported commands and check if
+       # the given one is part of it.
+       foreach my $cmd (@suricatactrl_cmds) {
+               # Skip current command unless the given one has been found.
+               next unless($cmd eq $option);
+
+               # Call the suricatactrl binary and pass the requrested
+               # option to it.
+               system("$suricatactrl $option &>/dev/null");
+
+               # Return "1" - True.
+               return 1;
+       }
+
+       # Command not found - return nothing.
+       return;
+}
+
+#
+## Function to create a new empty file.
+#
+sub create_empty_file($) {
+       my ($file) = @_;
+
+       # Check if the given file exists.
+       if(-e $file) {
+               # Do nothing to prevent from overwriting existing files.
+               return;
+       }
+
+       # Open the file for writing.
+       open(FILE, ">$file") or die "Could not write to $file. $!\n";
+
+       # Close file handle.
+       close(FILE);
+
+       # Return true.
+       return 1;
+}
+
 1;