]> git.ipfire.org Git - ipfire-2.x.git/blobdiff - html/cgi-bin/ids.cgi
ids.cgi: Display if the IDS is running
[ipfire-2.x.git] / html / cgi-bin / ids.cgi
index 1d61d9119e7ba0a533af189b059657fd606aad23..0a814f1a113bf3b2c2b32a08a27cfc3cb477feff 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        #
@@ -32,9 +32,8 @@ require "${General::swroot}/ids-functions.pl";
 
 my %color = ();
 my %mainsettings = ();
-my %netsettings = ();
-my %snortrules = ();
-my %snortsettings=();
+my %idsrules = ();
+my %idssettings=();
 my %rulesetsources = ();
 my %cgiparams=();
 my %checked=();
@@ -44,34 +43,18 @@ my %selected=();
 &General::readhash("${General::swroot}/main/settings", \%mainsettings);
 &General::readhash("/srv/web/ipfire/html/themes/".$mainsettings{'THEME'}."/include/colors.txt", \%color);
 
-# Get netsettings.
-&General::readhash("${General::swroot}/ethernet/settings", \%netsettings);
+# Get the available network zones, based on the config type of the system and store
+# the list of zones in an array.
+my @network_zones = &IDS::get_available_network_zones();
 
-my $snortrulepath = "/etc/snort/rules";
-my $snortusedrulefilesfile = "${General::swroot}/snort/snort-used-rulefiles.conf";
+my $idsusedrulefilesfile = "$IDS::settingsdir/suricata-used-rulefiles.yaml";
 my $errormessage;
 
 &Header::showhttpheaders();
 
-# Default settings for snort.
-$snortsettings{'ENABLE_SNORT'} = 'off';
-$snortsettings{'ENABLE_SNORT_GREEN'} = 'off';
-$snortsettings{'ENABLE_SNORT_BLUE'} = 'off';
-$snortsettings{'ENABLE_SNORT_ORANGE'} = 'off';
-$snortsettings{'RULES'} = '';
-$snortsettings{'OINKCODE'} = '';
-
 #Get GUI values
 &Header::getcgihash(\%cgiparams);
 
-# Try to determine if oinkmaster is running.
-my $oinkmaster_pid = `pidof oinkmaster.pl -x`;
-
-# If oinkmaster is running display output.
-if ($oinkmaster_pid) {
-       &working("$Lang::tr{'snort working'}");
-}
-
 # Check if any error has been stored.
 if (-e $IDS::storederrorfile) {
         # Open file to read in the stored error message.
@@ -88,27 +71,27 @@ if (-e $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 $!;
+opendir(DIR, $IDS::rulespath) or die $!;
        # Loop through the direcory.
        while (my $file = readdir(DIR)) {
 
                # We only want files.
-               next unless (-f "$snortrulepath/$file");
+               next unless (-f "$IDS::rulespath/$file");
 
                # Ignore empty files.
-               next if (-z "$snortrulepath/$file");
+               next if (-z "$IDS::rulespath/$file");
 
                # Use a regular expression to find files ending in .rules
                next unless ($file =~ m/\.rules$/);
 
                # Ignore files which are not read-able.
-               next unless (-R "$snortrulepath/$file");
+               next unless (-R "$IDS::rulespath/$file");
 
                # Call subfunction to read-in rulefile and add rules to
-               # the snortrules hash.
+               # the idsrules hash.
                &readrulesfile("$file");
        }
 
@@ -117,9 +100,9 @@ closedir(DIR);
 # Gather used rulefiles.
 #
 # Check if the file for activated rulefiles is not empty.
-if(-f $snortusedrulefilesfile) {
+if(-f $idsusedrulefilesfile) {
        # Open the file for used rulefile and read-in content.
-       open(FILE, $snortusedrulefilesfile) or die "Could not open $snortusedrulefilesfile. $!\n";
+       open(FILE, $idsusedrulefilesfile) or die "Could not open $idsusedrulefilesfile. $!\n";
 
        # Read-in content.
        my @lines = <FILE>;
@@ -139,27 +122,27 @@ if(-f $snortusedrulefilesfile) {
                next if ($line =~ /^\s*$/);
 
                # Gather rule sid and message from the ruleline.
-               if ($line =~ /.*include \$RULE_PATH\/(.*)/) {
+               if ($line =~ /.*(.*)/) {
                        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";
                }
        }
 }
 
 # Save ruleset.
 if ($cgiparams{'RULESET'} eq $Lang::tr{'update'}) {
-       my $enabled_sids_file = "${General::swroot}/snort/oinkmaster-enabled-sids.conf";
-       my $disabled_sids_file = "${General::swroot}/snort/oinkmaster-disabled-sids.conf";
+       my $enabled_sids_file = "$IDS::settingsdir/oinkmaster-enabled-sids.conf";
+       my $disabled_sids_file = "$IDS::settingsdir/oinkmaster-disabled-sids.conf";
 
        # Arrays to store sid which should be added to the corresponding files.
        my @enabled_sids;
        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.
@@ -170,17 +153,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.
@@ -192,7 +175,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.
@@ -241,7 +224,11 @@ if ($cgiparams{'RULESET'} eq $Lang::tr{'update'}) {
        close(FILE);
 
        # Open file for used rulefiles.
-       open (FILE, ">$snortusedrulefilesfile") or die "Could not write to $snortusedrulefilesfile. $!\n";
+       open (FILE, ">$idsusedrulefilesfile") or die "Could not write to $idsusedrulefilesfile. $!\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";
@@ -250,15 +237,21 @@ if ($cgiparams{'RULESET'} eq $Lang::tr{'update'}) {
        if (@enabled_rulefiles) {
                # Loop through the array of rulefiles which should be loaded and write the to the file.
                foreach my $file (@enabled_rulefiles) {
-                       print FILE "include \$RULE_PATH/$file\n";
+                       print FILE " - $file\n";
                }
        }
 
        # 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'}) {
@@ -268,32 +261,22 @@ if ($cgiparams{'RULESET'} eq $Lang::tr{'update'}) {
        }
 
        # Check if enought free disk space is availabe.
-       $errormessage = &IDS::checkdiskspace();
+       if(&IDS::checkdiskspace()) {
+               $errormessage = "$Lang::tr{'not enough disk space'}";
+       }
 
        # Check if any errors happend.
        unless ($errormessage) {
-               &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>$Lang::tr{'snort working'}</td>
-                                       </tr>
-                               </table>
-END
-               &Header::closebox();
-               &Header::closebigbox();
-               &Header::closepage();
+               # Lock the webpage and print notice about downloading
+               # a new ruleset.
+               &working_notice("$Lang::tr{'snort working'}");
 
                # Call subfunction to download the ruleset.
-               $errormessage = &IDS::downloadruleset();
+               if(&IDS::downloadruleset()) {
+                       $errormessage = $Lang::tr{'could not download latest updates'};
 
-               # Check if the downloader returned an error.
-               if ($errormessage) {
                        # Call function to store the errormessage.
-                       &IDS::log_error($errormessage);
+                       &IDS::_store_error_message($errormessage);
 
                        # Preform a reload of the page.
                        &reload();
@@ -321,34 +304,25 @@ END
        # Go on if there are no error messages.
        if (!$errormessage) {
                # Store settings into settings file.
-               &General::writehash("${General::swroot}/snort/settings", \%cgiparams);
+               &General::writehash("$IDS::settingsdir/settings", \%cgiparams);
 
-               # Call snortctrl to restart snort
-               system('/usr/local/bin/snortctrl restart >/dev/null');
+               # Call suricatactrl to restart the IDS
+               system('/usr/local/bin/suricatactrl restart >/dev/null');
        }
 }
 
-# Read-in snortsettings
-&General::readhash("${General::swroot}/snort/settings", \%snortsettings);
-
-$checked{'ENABLE_SNORT'}{'off'} = '';
-$checked{'ENABLE_SNORT'}{'on'} = '';
-$checked{'ENABLE_SNORT'}{$snortsettings{'ENABLE_SNORT'}} = "checked='checked'";
-$checked{'ENABLE_SNORT_GREEN'}{'off'} = '';
-$checked{'ENABLE_SNORT_GREEN'}{'on'} = '';
-$checked{'ENABLE_SNORT_GREEN'}{$snortsettings{'ENABLE_SNORT_GREEN'}} = "checked='checked'";
-$checked{'ENABLE_SNORT_BLUE'}{'off'} = '';
-$checked{'ENABLE_SNORT_BLUE'}{'on'} = '';
-$checked{'ENABLE_SNORT_BLUE'}{$snortsettings{'ENABLE_SNORT_BLUE'}} = "checked='checked'";
-$checked{'ENABLE_SNORT_ORANGE'}{'off'} = '';
-$checked{'ENABLE_SNORT_ORANGE'}{'on'} = '';
-$checked{'ENABLE_SNORT_ORANGE'}{$snortsettings{'ENABLE_SNORT_ORANGE'}} = "checked='checked'";
+# Read-in idssettings
+&General::readhash("$IDS::settingsdir/settings", \%idssettings);
+
+$checked{'ENABLE_IDS'}{'off'} = '';
+$checked{'ENABLE_IDS'}{'on'} = '';
+$checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
 $selected{'RULES'}{'nothing'} = '';
 $selected{'RULES'}{'community'} = '';
 $selected{'RULES'}{'emerging'} = '';
 $selected{'RULES'}{'registered'} = '';
 $selected{'RULES'}{'subscripted'} = '';
-$selected{'RULES'}{$snortsettings{'RULES'}} = "selected='selected'";
+$selected{'RULES'}{$idssettings{'RULES'}} = "selected='selected'";
 
 &Header::openpage($Lang::tr{'intrusion detection system'}, 1, '');
 
@@ -373,8 +347,63 @@ if ($errormessage) {
        &Header::closebox();
 }
 
+# Draw current state of the IDS
 &Header::openbox('100%', 'left', $Lang::tr{'intrusion detection system'});
 
+# Check if the IDS is running and obtain the process-id.
+my $pid = &IDS::ids_is_running();
+
+# Display some useful information, if suricata daemon is running.
+if ($pid) {
+       # Gather used memory.
+       my $memory = &get_memory_usage($pid);
+
+       print <<END;
+               <table width='95%' cellspacing='0' class='tbl'>
+                       <tr>
+                               <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
+                       </tr>
+
+                       <tr>
+                               <td class='base'>$Lang::tr{'guardian daemon'}</td>
+                               <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
+                       </tr>
+
+                       <tr>
+                               <td class='base'></td>
+                               <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
+                               <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
+                       </tr>
+
+                       <tr>
+                               <td class='base'></td>
+                               <td bgcolor='$color{'color22'}' align='center'>$pid</td>
+                               <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
+                       </tr>
+               </table>
+END
+} else {
+       # Otherwise display a hint that the service is not launched.
+       print <<END;
+               <table width='95%' cellspacing='0' class='tbl'>
+                       <tr>
+                               <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
+                       </tr>
+
+                       <tr>
+                               <td class='base'>$Lang::tr{'guardian daemon'}</td>
+                               <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
+                       </tr>
+               </table>
+
+               <br>br>
+END
+}
+&Header::closebox();
+
+# Draw elements for IDS configuration.
+&Header::openbox('100%', 'center', $Lang::tr{'settings'});
+
 my $rulesdate;
 
 # Check if a ruleset allready has been downloaded.
@@ -391,33 +420,60 @@ print <<END
        <table width='100%' border='0'>
                <tr>
                        <td class='base' width='25%'>
-                               <input type='checkbox' name='ENABLE_SNORT' $checked{'ENABLE_SNORT'}{'on'}>RED Snort
+                               <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}>$Lang::tr{'ids activate'} $Lang::tr{'intrusion detection system'}
+                       </td>
+
+                       <td class='base' width='25%'>
+                               &nbsp
                        </td>
+               </tr>
+
+               <tr>
+                       <td colspan='2'><br><br>
+               </tr>
 
+               <tr>
                        <td class='base' width='25%'>
-                               <input type='checkbox' name='ENABLE_SNORT_GREEN' $checked{'ENABLE_SNORT_GREEN'}{'on'}>GREEN Snort
+                               <b>$Lang::tr{'ids analyze incomming traffic'}</b>
                        </td>
 
                        <td class='base' width='25%'>
+                               <b>$Lang::tr{'ids analyze routing traffic'}</b>
+                       </td>
+               </tr>
 END
 ;
 
-# Check if a blue device is configured.
-if ($netsettings{'BLUE_DEV'}) {
-  print "<input type='checkbox' name='ENABLE_SNORT_BLUE' $checked{'ENABLE_SNORT_BLUE'}{'on'} />BLUE Snort\n";
-}
+# Loop through the array of available networks and print config options.
+foreach my $zone (@network_zones) {
+       my $checked_input;
+       my $checked_forward;
+
+       # Convert current zone name to upper case.
+       my $zone_upper = uc($zone);
 
-print "</td>\n";
+       # Grab checkbox status from settings hash.
+       if ($idssettings{"ENABLE_IDS_INPUT_$zone_upper"} eq "on") {
+               $checked_input = "checked = 'checked'";
+       }
+
+       # Do the same for the forward setting.
+       if ($idssettings{"ENABLE_IDS_FORWARD_$zone_upper"} eq "on") {
+               $checked_forward = "checked = 'checked'";
+       }
 
-print "<td width='25%'>\n";
+       print "<tr>\n";
+       print "<td class='base' width='25%'>\n";
+       print "<input type='checkbox' name='ENABLE_IDS_INPUT_$zone_upper' $checked_input>$Lang::tr{'ids active on'} $Lang::tr{$zone}\n";
+       print "</td>\n";
 
-# Check if an orange device is configured.
-if ($netsettings{'ORANGE_DEV'}) {
-  print "<input type='checkbox' name='ENABLE_SNORT_ORANGE' $checked{'ENABLE_SNORT_ORANGE'}{'on'} />ORANGE Snort\n";
+       print "<td class='base' width='25%'>\n";
+       print "<input type='checkbox' name='ENABLE_IDS_FORWARD_$zone_upper' $checked_forward>$Lang::tr{'ids active on'} $Lang::tr{$zone}\n";
+       print "</td>\n";
+       print "</tr>\n";
 }
 
 print <<END
-                       </td>
                </tr>
 
                <tr>
@@ -447,7 +503,7 @@ print <<END
                </tr>
 
                <tr>
-                       <td colspan='4' nowrap='nowrap'>Oinkcode:&nbsp;<input type='text' size='40' name='OINKCODE' value='$snortsettings{'OINKCODE'}'></td>
+                       <td colspan='4' nowrap='nowrap'>Oinkcode:&nbsp;<input type='text' size='40' name='OINKCODE' value='$idssettings{'OINKCODE'}'></td>
                </tr>
 
                <tr>
@@ -482,11 +538,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';
                }
 
@@ -514,7 +570,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 = '';
 
@@ -537,7 +593,7 @@ END
                        }
 
                        # Set rule state
-                       if ($snortrules{$rulefile}{$sid}{'State'} eq 'on') {
+                       if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
                                $ruledefchecked = 'CHECKED';
                        }
 
@@ -545,7 +601,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++;
@@ -581,6 +637,29 @@ END
 &Header::closebigbox();
 &Header::closepage();
 
+#
+## 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();
+}
+
 #
 ## A tiny function to perform a reload of the webpage after one second.
 #
@@ -595,13 +674,13 @@ sub reload () {
 ## 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 snortrules hash.
+## message/description and it's state in the idsrules hash.
 #
 sub readrulesfile ($) {
        my $rulefile = shift;
 
        # Open rule file and read in contents
-       open(RULEFILE, "$snortrulepath/$rulefile") or die "Unable to read $rulefile!";
+       open(RULEFILE, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
 
        # Store file content in an array.
        my @lines = <RULEFILE>;
@@ -628,18 +707,48 @@ 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";
                                }
                        }
                }
         }
 }
+
+# Function to get the used memory of a given process-id.
+sub get_memory_usage($) {
+       my $pid = @_;
+
+       my $memory=0;
+
+       # Try to open statm file for the given process-id on the pseudo
+       # file system proc.
+        if (open(FILE, "/proc/$pid/statm")) {
+               # Read file content.
+                my $temp = <FILE>;
+
+               # Splitt file content and store in an array.
+                my @memory = split(/ /,$temp);
+
+               # Close file handle.
+                close(FILE);
+
+               # Calculate memory usage.
+               $memory+=$memory[0];
+
+               # Return memory usage.
+               return $memory;
+        }
+
+       # If the file could not be open, return nothing.
+       return;
+}
+