]> git.ipfire.org Git - ipfire-2.x.git/blobdiff - config/cfgroot/ids-functions.pl
ids-functions.pl: Introduce function write_modify_sids_file()
[ipfire-2.x.git] / config / cfgroot / ids-functions.pl
index a621c8fa4c99cb0534ab2552c34a05d77b8f692c..55786c157c80695c2f40cf5735c5912be79b08e2 100644 (file)
@@ -28,6 +28,30 @@ require '/var/ipfire/general-functions.pl';
 # Location where all config and settings files are stored.
 our $settingsdir = "${General::swroot}/suricata";
 
+# File where the used rulefiles are stored.
+our $used_rulefiles_file = "$settingsdir/suricata-used-rulefiles.yaml";
+
+# File where the addresses of the homenet are stored.
+our $homenet_file = "$settingsdir/suricata-homenet.yaml";
+
+# File which contains the enabled sids.
+our $enabled_sids_file = "$settingsdir/oinkmaster-enabled-sids.conf";
+
+# File which contains the disabled sids.
+our $disabled_sids_file = "$settingsdir/oinkmaster-disabled-sids.conf";
+
+# File which contains wheater the rules should be changed.
+our $modify_sids_file = "$settingsdir/oinkmaster-modify-sids.conf";
+
+# File which stores the configured IPS settings.
+our $ids_settings_file = "$settingsdir/settings";
+
+# File which stores the configured rules-settings.
+our $rules_settings_file = "$settingsdir/rules-settings";
+
+# File which stores the configured settings for whitelisted addresses.
+our $ignored_file = "$settingsdir/ignored";
+
 # Location and name of the tarball which contains the ruleset.
 our $rulestarball = "/var/tmp/idsrules.tar.gz";
 
@@ -37,6 +61,9 @@ our $storederrorfile = "/tmp/ids_storederror";
 # Location where the rulefiles are stored.
 our $rulespath = "/var/lib/suricata";
 
+# File which contains the rules to whitelist addresses on suricata.
+our $whitelist_file = "$rulespath/whitelist.rules";
+
 # File which contains a list of all supported ruleset sources.
 # (Sourcefire, Emergingthreads, etc..)
 our $rulesetsourcesfile = "$settingsdir/ruleset-sources";
@@ -53,6 +80,21 @@ my @suricatactrl_cmds = ( 'start', 'stop', 'restart', 'reload', 'fix-rules-dir',
 # Array with supported cron intervals.
 my @cron_intervals = ('off', 'daily', 'weekly' );
 
+#
+## Function to check and create all IDS related files, if the does not exist.
+#
+sub check_and_create_filelayout() {
+       # Check if the files exist and if not, create them.
+       unless (-f "$enabled_sids_file") { &create_empty_file($enabled_sids_file); }
+       unless (-f "$disabled_sids_file") { &create_empty_file($disabled_sids_file); }
+       unless (-f "$modify_sids_file") { &create_empty_file($modify_sids_file); }
+       unless (-f "$used_rulefiles_file") { &create_empty_file($used_rulefiles_file); }
+       unless (-f "$ids_settings_file") { &create_empty_file($ids_settings_file); }
+       unless (-f "$rules_settings_file") { &create_empty_file($rules_settings_file); }
+       unless (-f "$ignored_file") { &create_empty_file($ignored_file); }
+       unless (-f "$whitelist_file" ) { &create_empty_file($whitelist_file); }
+}
+
 #
 ## Function for checking if at least 300MB of free disk space are available
 ## on the "/var" partition.
@@ -168,11 +210,46 @@ sub downloadruleset {
                return 1;
        }
 
+       # Pass the requrested url to the downloader.
+       my $request = HTTP::Request->new(HEAD => $url);
+
+       # Accept the html header.
+       $request->header('Accept' => 'text/html');
+
+       # Perform the request and fetch the html header.
+       my $response = $downloader->request($request);
+
+       # 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. \($error\)");
+
+               # Return "1" - false.
+               return 1;
+       }
+
+       # Assign the fetched header object.
+       my $header = $response->headers;
+
+       # Grab the remote file size from the object and store it in the
+       # variable.
+       my $remote_filesize = $header->content_length;
+
+       # Load perl module to deal with temporary files.
+       use File::Temp;
+
+       # Generate temporay file name, located in "/var/tmp" and with a suffix of ".tar.gz".
+       my $tmp = File::Temp->new( SUFFIX => ".tar.gz", DIR => "/var/tmp/", UNLINK => 0 );
+       my $tmpfile = $tmp->filename();
+
        # 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);
+       # Perform the request and save the output into the tmpfile.
+       my $response = $downloader->request($request, $tmpfile);
 
        # Check if there was any error.
        unless ($response->is_success) {
@@ -186,6 +263,34 @@ sub downloadruleset {
                return 1;
        }
 
+       # Load perl stat module.
+       use File::stat;
+
+       # Perform stat on the tmpfile.
+       my $stat = stat($tmpfile);
+
+       # Grab the local filesize of the downloaded tarball.
+       my $local_filesize = $stat->size;
+
+       # Check if both file sizes match.
+       unless ($remote_filesize eq $local_filesize) {
+               # Log error message.
+               &_log_to_syslog("Unable to completely download the ruleset. ");
+               &_log_to_syslog("Only got $local_filesize Bytes instead of $remote_filesize Bytes. ");
+
+               # Delete temporary file.
+               unlink("$tmpfile");
+
+               # Return "1" - false.
+               return 1;
+       }
+
+       # Load file copy module, which contains the move() function.
+       use File::Copy;
+
+       # Overwrite existing rules tarball with the new downloaded one.
+       move("$tmpfile", "$rulestarball");
+
        # If we got here, everything worked fine. Return nothing.
        return;
 }
@@ -451,18 +556,157 @@ sub _check_rulesdir_permissions() {
 ## the IDS rules, before extracting and modifing the new ruleset.
 #
 sub _cleanup_rulesdir() {
-       # Loop through the rules-directory.
-       while ($item = glob($rulespath/*)) {
-               # Skip element if it is a directory.
-               next if -d $item;
+       # Open rules directory and do a directory listing.
+       opendir(DIR, $rulespath) or die $!;
 
-               # Delete the current processed item, if not, exit this function
+       # Loop through the direcory.
+       while (my $file = readdir(DIR)) {
+               # We only want files.
+               next unless (-f "$rulespath/$file");
+
+               # Skip element if it has config as file extension.
+               next if ($file =~ m/\.config$/);
+
+               # Delete the current processed file, if not, exit this function
                # and return an error message.
-               unlink($item) or return "Could not delete $item. $!\n";
+               unlink("$rulespath/$file") or return "Could not delete $rulespath/$file. $!\n";
        }
 
-       # Return noting;
+       # Return nothing;
        return;
 }
 
+#
+## Function to generate the file which contains the home net information.
+#
+sub generate_home_net_file() {
+       my %netsettings;
+
+       # Read-in network settings.
+       &General::readhash("${General::swroot}/ethernet/settings", \%netsettings);
+
+       # Get available network zones.
+       my @network_zones = &get_available_network_zones();
+
+       # Temporary array to store network address and prefix of the configured
+       # networks.
+       my @networks;
+
+       # Loop through the array of available network zones.
+       foreach my $zone (@network_zones) {
+               # Skip the red network - It never can be part to the home_net!
+               next if($zone eq "red");
+
+               # Convert current zone name into upper case.
+               $zone = uc($zone);
+
+               # Generate key to access the required data from the netsettings hash.
+               my $zone_netaddress = $zone . "_NETADDRESS";
+               my $zone_netmask = $zone . "_NETMASK";
+
+               # Obtain the settings from the netsettings hash.
+               my $netaddress = $netsettings{$zone_netaddress};
+               my $netmask = $netsettings{$zone_netmask};
+
+               # Convert the subnetmask into prefix notation.
+               my $prefix = &Network::convert_netmask2prefix($netmask);
+
+               # Generate full network string.
+               my $network = join("/", $netaddress,$prefix);
+
+               # Check if the network is valid.
+               if(&Network::check_subnet($network)) {
+                       # Add the generated network to the array of networks.
+                       push(@networks, $network);
+               }
+       }
+
+       # Format home net declaration.
+       my $line = "\"\[";
+
+       # Loop through the array of networks.
+       foreach my $network (@networks) {
+               # Add the network to the line.
+               $line = "$line" . "$network";
+
+               # Check if the current network was the last in the array.
+               if ($network eq $networks[-1]) {
+                       # Close the line.
+                       $line = "$line" . "\]\"";
+               } else {
+                       # Add "," for the next network.
+                       $line = "$line" . "\,";
+               }
+       }
+
+       # Open file to store the addresses of the home net.
+       open(FILE, ">$homenet_file") or die "Could not open $homenet_file. $!\n";
+
+       # Print yaml header.
+       print FILE "%YAML 1.1\n";
+       print FILE "---\n\n";
+
+       # Print notice about autogenerated file.
+       print FILE "#Autogenerated file. Any custom changes will be overwritten!\n";
+
+       # Print the generated and required HOME_NET declaration to the file.
+       print FILE "HOME_NET:\t$line\n";
+
+       # Close file handle.
+       close(FILE);
+}
+
+#
+## Function to generate and write the file for used rulefiles.
+#
+sub write_used_rulefiles_file(@) {
+       my @files = @_;
+
+       # Open file for used rulefiles.
+       open (FILE, ">$used_rulefiles_file") or die "Could not write to $used_rulefiles_file. $!\n";
+
+       # Write yaml header to the file.
+       print FILE "%YAML 1.1\n";
+       print FILE "---\n\n";
+
+       # Write header to file.
+       print FILE "#Autogenerated file. Any custom changes will be overwritten!\n";
+
+       # Allways use the whitelist.
+       print FILE " - whitelist.rules\n";
+
+       # Loop through the array of given files.
+       foreach my $file (@files) {
+               # Check if the given filename exists and write it to the file of used rulefiles.
+               if(-f "$rulespath/$file") {
+                       print FILE " - $file\n";
+               }
+       }
+
+       # Close file after writing.
+       close(FILE);
+}
+
+#
+## Function to generate and write the file for modify the ruleset.
+#
+sub write_modify_sids_file($) {
+       my ($ruleaction) = @_;
+
+       # Open modify sid's file for writing.
+       open(FILE, ">$IDS::modify_sids_file") or die "Could not write to $IDS::modify_sids_file. $!\n";
+
+       # Write file header.
+       print FILE "#Autogenerated file. Any custom changes will be overwritten!\n";
+
+       # Check if the traffic only should be monitored.
+       unless($ruleaction eq "alert") {
+               # Tell oinkmaster to switch all rules from alert to drop.
+               print FILE "modifysid \* \"alert\" \| \"drop\"\n";
+       }
+
+       # Close file handle.
+       close(FILE);
+}
+
 1;