]> git.ipfire.org Git - ipfire-2.x.git/blobdiff - html/cgi-bin/ids.cgi
ids.cgi: Rename snortrules hash to idsrules.
[ipfire-2.x.git] / html / cgi-bin / ids.cgi
index 656ed2d9b79d06841025d2237935bb1ae7e92b26..df2bfe5a58b84a3c571350e8bc4ade12ca6c3d0e 100644 (file)
@@ -2,7 +2,7 @@
 ###############################################################################
 #                                                                             #
 # IPFire.org - A linux based firewall                                         #
-# Copyright (C) 2007-2015  IPFire Team  <info@ipfire.org>                     #
+# Copyright (C) 2007-2018  IPFire Team  <info@ipfire.org>                     #
 #                                                                             #
 # This program is free software: you can redistribute it and/or modify        #
 # it under the terms of the GNU General Public License as published by        #
@@ -28,11 +28,12 @@ use strict;
 require '/var/ipfire/general-functions.pl';
 require "${General::swroot}/lang.pl";
 require "${General::swroot}/header.pl";
+require "${General::swroot}/ids-functions.pl";
 
 my %color = ();
 my %mainsettings = ();
 my %netsettings = ();
-my %snortrules = ();
+my %idsrules = ();
 my %snortsettings=();
 my %rulesetsources = ();
 my %cgiparams=();
@@ -46,38 +47,10 @@ 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";
 my $errormessage;
 
-# Hook used to download and update the ruleset,
-# if the cgi got called from command line.
-if ($ENV{"REMOTE_ADDR"} eq "") {
-       # Read snortsettings.
-       &General::readhash("${General::swroot}/snort/settings", \%snortsettings);
-
-       # Download rules tarball.
-       $errormessage = &downloadruleset();
-
-       # Sleep for one second.
-       sleep(1);
-
-       # Check if there was an error message.
-       unless ($errormessage) {
-               # Call oinkmaster.
-               &oinkmaster();
-       } else {
-               # Call logger and log the errormessage.
-               system("logger -t oinkmaster $errormessage");
-       }
-
-exit(0);
-}
-
 &Header::showhttpheaders();
 
 # Default settings for snort.
@@ -91,15 +64,23 @@ $snortsettings{'OINKCODE'} = '';
 #Get GUI values
 &Header::getcgihash(\%cgiparams);
 
-# Try to determine if oinkmaster is running.
-my $oinkmaster_pid = `pidof oinkmaster.pl -x`;
+# Check if any error has been stored.
+if (-e $IDS::storederrorfile) {
+        # Open file to read in the stored error message.
+        open(FILE, "<$IDS::storederrorfile") or die "Could not open $IDS::storederrorfile. $!\n";
+
+        # Read the stored error message.
+        $errormessage = <FILE>;
+
+        # Close file.
+        close (FILE);
 
-# If oinkmaster is running display output.
-if ($oinkmaster_pid) {
-       &working("$Lang::tr{'snort working'}");
+        # Delete the file, which is now not longer required.
+        unlink($IDS::storederrorfile);
 }
 
-## Grab all available snort rules and store them in the snortrules hash.
+
+## Grab all available snort rules and store them in the idsrules hash.
 #
 # Open snort rules directory and do a directory listing.
 opendir(DIR, $snortrulepath) or die $!;
@@ -119,7 +100,7 @@ opendir(DIR, $snortrulepath) or die $!;
                next unless (-R "$snortrulepath/$file");
 
                # Call subfunction to read-in rulefile and add rules to
-               # the snortrules hash.
+               # the idsrules hash.
                &readrulesfile("$file");
        }
 
@@ -153,8 +134,8 @@ if(-f $snortusedrulefilesfile) {
                if ($line =~ /.*include \$RULE_PATH\/(.*)/) {
                        my $rulefile = $1;
 
-                       # Add the rulefile to the %snortrules hash.
-                       $snortrules{$rulefile}{'Rulefile'}{'State'} = "on";
+                       # Add the rulefile to the %idsrules hash.
+                       $idsrules{$rulefile}{'Rulefile'}{'State'} = "on";
                }
        }
 }
@@ -169,8 +150,8 @@ if ($cgiparams{'RULESET'} eq $Lang::tr{'update'}) {
        my @disabled_sids;
        my @enabled_rulefiles;
 
-       # Loop through the hash of snortrules.
-       foreach my $rulefile(keys %snortrules) {
+       # Loop through the hash of idsrules.
+       foreach my $rulefile(keys %idsrules) {
                # Check if the rulefile is enabled.
                if ($cgiparams{$rulefile} eq "on") {
                        # Add rulefile to the array of enabled rulefiles.
@@ -181,17 +162,17 @@ if ($cgiparams{'RULESET'} eq $Lang::tr{'update'}) {
                }
        }
 
-       # Loop through the hash of snortrules.
-       foreach my $rulefile (keys %snortrules) {
+       # Loop through the hash of idsrules.
+       foreach my $rulefile (keys %idsrules) {
                # Loop through the single rules of the rulefile.
-               foreach my $sid (keys %{$snortrules{$rulefile}}) {
+               foreach my $sid (keys %{$idsrules{$rulefile}}) {
                        # Skip the current sid if it is not numeric.
                        next unless ($sid =~ /\d+/ );
 
                        # Check if there exists a key in the cgiparams hash for this sid.
                        if (exists($cgiparams{$sid})) {
                                # Look if the rule is disabled.
-                               if ($snortrules{$rulefile}{$sid}{'State'} eq "off") {
+                               if ($idsrules{$rulefile}{$sid}{'State'} eq "off") {
                                        # Check if the state has been set to 'on'.
                                        if ($cgiparams{$sid} eq "on") {
                                                # Add the sid to the enabled_sids array.
@@ -203,7 +184,7 @@ if ($cgiparams{'RULESET'} eq $Lang::tr{'update'}) {
                                }
                        } else {
                                # Look if the rule is enabled.
-                               if ($snortrules{$rulefile}{$sid}{'State'} eq "on") {
+                               if ($idsrules{$rulefile}{$sid}{'State'} eq "on") {
                                        # Check if the state is 'on' and should be disabled.
                                        # In this case there is no entry
                                        # for the sid in the cgiparams hash.
@@ -268,8 +249,14 @@ if ($cgiparams{'RULESET'} eq $Lang::tr{'update'}) {
        # Close file after writing.
        close(FILE);
 
+       # Lock the webpage and print message.
+       &working_notice("$Lang::tr{'snort working'}");
+
        # Call oinkmaster to alter the ruleset.
-       &oinkmaster();
+       &IDS::oinkmaster();
+
+       # Reload page.
+       &reload();
 
 # Download new ruleset.
 } elsif ($cgiparams{'RULESET'} eq $Lang::tr{'download new ruleset'}) {
@@ -278,47 +265,32 @@ if ($cgiparams{'RULESET'} eq $Lang::tr{'update'}) {
                $errormessage = $Lang::tr{'could not download latest updates'};
        }
 
-       # 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) {
-                               # If there is not enough space, print out an error message.
-                               $errormessage = "$Lang::tr{'not enough disk space'} < 300MB, /var $1MB";
-
-                               # Break loop.
-                               last;
-                       }
-               }
-       }
+       # Check if enought free disk space is availabe.
+       $errormessage = &IDS::checkdiskspace();
 
        # Check if any errors happend.
        unless ($errormessage) {
+               # Lock the webpage and print notice about downloading
+               # a new ruleset.
+               &working_notice("$Lang::tr{'snort working'}");
+
                # Call subfunction to download the ruleset.
-               $errormessage = &downloadruleset();
-       }
+               $errormessage = &IDS::downloadruleset();
 
-       # Sleep for 1 second
-       sleep(1);
+               # Check if the downloader returned an error.
+               if ($errormessage) {
+                       # Call function to store the errormessage.
+                       &IDS::log_error($errormessage);
 
-       # Check if the downloader returend any error message.
-       unless ($errormessage) {
-               # Call subfunction to launch oinkmaster.
-               &oinkmaster();
+                       # Preform a reload of the page.
+                       &reload();
+               } else {
+                       # Call subfunction to launch oinkmaster.
+                       &IDS::oinkmaster();
 
-               # Sleep for 1 seconds.
-               sleep(1);
+                       # Perform a reload of the page.
+                       &reload();
+               }
        }
 # Save snort settings.
 } elsif ($cgiparams{'SNORT'} eq $Lang::tr{'save'}) {
@@ -393,9 +365,9 @@ if ($errormessage) {
 my $rulesdate;
 
 # Check if a ruleset allready has been downloaded.
-if ( -f "$rulestarball"){
+if ( -f "$IDS::rulestarball"){
        # Call stat on the filename to obtain detailed information.
-        my @Info = stat("$rulestarball");
+        my @Info = stat("$IDS::rulestarball");
 
        # Grab details about the creation time.
         $rulesdate = localtime($Info[9]);
@@ -497,11 +469,11 @@ END
        my $rulesetcount = 1;
 
        # Loop over each rule file
-       foreach my $rulefile (sort keys(%snortrules)) {
+       foreach my $rulefile (sort keys(%idsrules)) {
                my $rulechecked = '';
 
                # Check if rule file is enabled
-               if ($snortrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
+               if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
                        $rulechecked = 'CHECKED';
                }
 
@@ -529,7 +501,7 @@ END
                print "<table width='100%'>\n";
 
                # Loop over rule file rules
-               foreach my $sid (sort {$a <=> $b} keys(%{$snortrules{$rulefile}})) {
+               foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
                        # Local vars
                        my $ruledefchecked = '';
 
@@ -552,7 +524,7 @@ END
                        }
 
                        # Set rule state
-                       if ($snortrules{$rulefile}{$sid}{'State'} eq 'on') {
+                       if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
                                $ruledefchecked = 'CHECKED';
                        }
 
@@ -560,7 +532,7 @@ END
                        print "<td class='base' width='5%' align='right' $col>\n";
                        print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
                        print "</td>\n";
-                       print "<td class='base' width='45%' $col>$snortrules{$rulefile}{$sid}{'Description'}</td>";
+                       print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
 
                        # Increment rule count
                        $lines++;
@@ -596,103 +568,45 @@ END
 &Header::closebigbox();
 &Header::closepage();
 
-sub working ($) {
-       my $message = $_[0];
-
-        &Header::openpage($Lang::tr{'intrusion detection system'}, 1, '');
-        &Header::openbigbox('100%', 'left', '', $errormessage);
-        &Header::openbox( 'Waiting', 1, "<meta http-equiv='refresh' content='1'>" );
-        print <<END;
-        <table>
-                <tr>
-                        <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
-                        <td>$message</td>
-                </tr>
-                <tr>
-                        <td colspan='2' align='center'>
-                        <form method='post' action='$ENV{'SCRIPT_NAME'}'>
-                                <input type='image' alt='$Lang::tr{'reload'}' title='$Lang::tr{'reload'}' src='/images/view-refresh.png' />
-                        </form>
-                </tr>
-        </table>
+#
+## A function to display a notice, to lock the webpage and
+## tell the user which action currently will be performed.
+#
+sub working_notice ($) {
+       my ($message) = @_;
+
+       &Header::openpage($Lang::tr{'intrusion detection system'}, 1, '');
+       &Header::openbigbox('100%', 'left', '', $errormessage);
+       &Header::openbox( 'Waiting', 1,);
+               print <<END;
+                       <table>
+                               <tr>
+                                       <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
+                                       <td>$message</td>
+                               </tr>
+                       </table>
 END
-        &Header::closebox();
-        &Header::closebigbox();
-        &Header::closepage();
-        exit;
+       &Header::closebox();
+       &Header::closebigbox();
+       &Header::closepage();
 }
 
-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;
-}
+#
+## A tiny function to perform a reload of the webpage after one second.
+#
+sub reload () {
+       print "<meta http-equiv='refresh' content='1'>\n";
 
-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");
+       # Stop the script.
+       exit;
 }
 
+#
+## Private function to read-in and parse rules of a given rulefile.
+#
+## The given file will be read, parsed and all valid rules will be stored by ID,
+## message/description and it's state in the idsrules hash.
+#
 sub readrulesfile ($) {
        my $rulefile = shift;
 
@@ -724,16 +638,16 @@ sub readrulesfile ($) {
 
                        # Check if a rule has been found.
                        if ($sid && $msg) {
-                               # Add rule to the snortrules hash.
-                               $snortrules{$rulefile}{$sid}{'Description'} = $msg;
+                               # Add rule to the idsrules hash.
+                               $idsrules{$rulefile}{$sid}{'Description'} = $msg;
 
                                # Grab status of the rule. Check if ruleline starts with a "dash".
                                if ($line =~ /^\#/) {
                                        # If yes, the rule is disabled.
-                                       $snortrules{$rulefile}{$sid}{'State'} = "off";
+                                       $idsrules{$rulefile}{$sid}{'State'} = "off";
                                } else {
                                        # Otherwise the rule is enabled.
-                                       $snortrules{$rulefile}{$sid}{'State'} = "on";
+                                       $idsrules{$rulefile}{$sid}{'State'} = "on";
                                }
                        }
                }