2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2007-2020 IPFire Team <info@ipfire.org> #
7 # This program is free software: you can redistribute it and/or modify #
8 # it under the terms of the GNU General Public License as published by #
9 # the Free Software Foundation, either version 3 of the License, or #
10 # (at your option) any later version. #
12 # This program is distributed in the hope that it will be useful, #
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of #
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
15 # GNU General Public License for more details. #
17 # You should have received a copy of the GNU General Public License #
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. #
20 ###############################################################################
24 # enable only the following on debugging purpose
26 #use CGI::Carp 'fatalsToBrowser';
28 require '/var/ipfire/general-functions.pl';
29 require "${General::swroot}/lang.pl";
30 require "${General::swroot}/header.pl";
31 require "${General::swroot}/ids-functions.pl";
32 require "${General::swroot}/network-functions.pl";
34 # Import ruleset providers file.
35 require "$IDS::rulesetsourcesfile";
38 my %mainsettings = ();
47 # Read-in main settings, for language, theme and colors.
48 &General
::readhash
("${General::swroot}/main/settings", \
%mainsettings);
49 &General
::readhash
("/srv/web/ipfire/html/themes/ipfire/include/colors.txt", \
%color);
51 # Get the available network zones, based on the config type of the system and store
52 # the list of zones in an array.
53 my @network_zones = &Network
::get_available_network_zones
();
55 # Check if openvpn is started and add it to the array of network zones.
56 if ( -e
"/var/run/openvpn.pid") {
57 push(@network_zones, "ovpn");
62 # Create files if they does not exist yet.
63 &IDS
::check_and_create_filelayout
();
65 # Hash which contains the colour code of a network zone.
67 'red' => $Header::colourred
,
68 'green' => $Header::colourgreen
,
69 'blue' => $Header::colourblue
,
70 'orange' => $Header::colourorange
,
71 'ovpn' => $Header::colourovpn
74 &Header
::showhttpheaders
();
77 &Header
::getcgihash
(\
%cgiparams);
79 ## Add/edit an entry to the ignore file.
81 if (($cgiparams{'WHITELIST'} eq $Lang::tr
{'add'}) || ($cgiparams{'WHITELIST'} eq $Lang::tr
{'update'})) {
83 # Check if any input has been performed.
84 if ($cgiparams{'IGNORE_ENTRY_ADDRESS'} ne '') {
86 # Check if the given input is no valid IP-address or IP-address with subnet, display an error message.
87 if ((!&General
::validip
($cgiparams{'IGNORE_ENTRY_ADDRESS'})) && (!&General
::validipandmask
($cgiparams{'IGNORE_ENTRY_ADDRESS'}))) {
88 $errormessage = "$Lang::tr{'guardian invalid address or subnet'}";
91 $errormessage = "$Lang::tr{'guardian empty input'}";
94 # Go further if there was no error.
95 if ($errormessage eq '') {
100 # Assign hash values.
101 my $new_entry_address = $cgiparams{'IGNORE_ENTRY_ADDRESS'};
102 my $new_entry_remark = $cgiparams{'IGNORE_ENTRY_REMARK'};
104 # Read-in ignoredfile.
105 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
107 # Check if we should edit an existing entry and got an ID.
108 if (($cgiparams{'WHITELIST'} eq $Lang::tr
{'update'}) && ($cgiparams{'ID'})) {
109 # Assin the provided id.
110 $id = $cgiparams{'ID'};
112 # Undef the given ID.
113 undef($cgiparams{'ID'});
115 # Grab the configured status of the corresponding entry.
116 $status = $ignored{$id}[2];
118 # Each newly added entry automatically should be enabled.
121 # Generate the ID for the new entry.
123 # Sort the keys by their ID and store them in an array.
124 my @keys = sort { $a <=> $b } keys %ignored;
126 # Reverse the key array.
127 my @reversed = reverse(@keys);
129 # Obtain the last used id.
130 my $last_id = @reversed[0];
132 # Increase the last id by one and use it as id for the new entry.
136 # Add/Modify the entry to/in the ignored hash.
137 $ignored{$id} = ["$new_entry_address", "$new_entry_remark", "$status"];
139 # Write the changed ignored hash to the ignored file.
140 &General
::writehasharray
($IDS::ignored_file
, \
%ignored);
142 # Regenerate the ignore file.
143 &IDS
::generate_ignore_file
();
146 # Check if the IDS is running.
147 if(&IDS
::ids_is_running
()) {
148 # Call suricatactrl to perform a reload.
149 &IDS
::call_suricatactrl
("reload");
152 ## Toggle Enabled/Disabled for an existing entry on the ignore list.
155 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr
{'toggle enable disable'}) {
158 # Only go further, if an ID has been passed.
159 if ($cgiparams{'ID'}) {
160 # Assign the given ID.
161 my $id = $cgiparams{'ID'};
163 # Undef the given ID.
164 undef($cgiparams{'ID'});
166 # Read-in ignoredfile.
167 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
169 # Grab the configured status of the corresponding entry.
170 my $status = $ignored{$id}[2];
173 if ($status eq "disabled") {
176 $status = "disabled";
179 # Modify the status of the existing entry.
180 $ignored{$id} = ["$ignored{$id}[0]", "$ignored{$id}[1]", "$status"];
182 # Write the changed ignored hash to the ignored file.
183 &General
::writehasharray
($IDS::ignored_file
, \
%ignored);
185 # Regenerate the ignore file.
186 &IDS
::generate_ignore_file
();
188 # Check if the IDS is running.
189 if(&IDS
::ids_is_running
()) {
190 # Call suricatactrl to perform a reload.
191 &IDS
::call_suricatactrl
("reload");
195 ## Remove entry from ignore list.
197 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr
{'remove'}) {
200 # Read-in ignoredfile.
201 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
203 # Drop entry from the hash.
204 delete($ignored{$cgiparams{'ID'}});
206 # Undef the given ID.
207 undef($cgiparams{'ID'});
209 # Write the changed ignored hash to the ignored file.
210 &General
::writehasharray
($IDS::ignored_file
, \
%ignored);
212 # Regenerate the ignore file.
213 &IDS
::generate_ignore_file
();
215 # Check if the IDS is running.
216 if(&IDS
::ids_is_running
()) {
217 # Call suricatactrl to perform a reload.
218 &IDS
::call_suricatactrl
("reload");
222 # Check if the page is locked, in this case, the ids_page_lock_file exists.
223 if (-e
$IDS::ids_page_lock_file
) {
224 # Lock the webpage and print notice about autoupgrade of the ruleset
226 &working_notice
("$Lang::tr{'ids ruleset autoupdate in progress'}");
228 # Loop and check if the file still exists.
229 while(-e
$IDS::ids_page_lock_file
) {
230 # Sleep for a second and re-check.
234 # Page has been unlocked, perform a reload.
238 # Check if any error has been stored.
239 if (-e
$IDS::storederrorfile
) {
240 # Open file to read in the stored error message.
241 open(FILE
, "<$IDS::storederrorfile") or die "Could not open $IDS::storederrorfile. $!\n";
243 # Read the stored error message.
244 $errormessage = <FILE
>;
249 # Delete the file, which is now not longer required.
250 unlink($IDS::storederrorfile
);
253 ## Grab all available rules and store them in the idsrules hash.
255 # Open rules directory and do a directory listing.
256 opendir(DIR
, $IDS::rulespath
) or die $!;
257 # Loop through the direcory.
258 while (my $file = readdir(DIR
)) {
260 # We only want files.
261 next unless (-f
"$IDS::rulespath/$file");
263 # Ignore empty files.
264 next if (-z
"$IDS::rulespath/$file");
266 # Use a regular expression to find files ending in .rules
267 next unless ($file =~ m/\.rules$/);
269 # Ignore files which are not read-able.
270 next unless (-R
"$IDS::rulespath/$file");
272 # Skip whitelist rules file.
273 next if( $file eq "whitelist.rules");
275 # Call subfunction to read-in rulefile and add rules to
277 &readrulesfile
("$file");
282 # Gather used rulefiles.
284 # Check if the file for activated rulefiles is not empty.
285 if(-f
$IDS::used_rulefiles_file
) {
286 # Open the file for used rulefile and read-in content.
287 open(FILE
, $IDS::used_rulefiles_file
) or die "Could not open $IDS::used_rulefiles_file. $!\n";
295 # Loop through the array.
296 foreach my $line (@lines) {
301 next if ($line =~ /\#/);
304 next if ($line =~ /^\s*$/);
306 # Gather rule sid and message from the ruleline.
307 if ($line =~ /.*- (.*)/) {
310 # Check if the current rulefile exists in the %idsrules hash.
311 # If not, the file probably does not exist anymore or contains
313 if($idsrules{$rulefile}) {
314 # Add the rulefile state to the %idsrules hash.
315 $idsrules{$rulefile}{'Rulefile'}{'State'} = "on";
321 # Save ruleset configuration.
322 if ($cgiparams{'RULESET'} eq $Lang::tr
{'save'}) {
325 # Read-in current (old) IDS settings.
326 &General
::readhash
("$IDS::rules_settings_file", \
%oldsettings);
328 # Prevent form name from been stored in conf file.
329 delete $cgiparams{'RULESET'};
331 # Check if the choosen vendor (URL) requires an subscription/oinkcode.
332 if ($IDS::Ruleset
::Providers
{$cgiparams{'RULES'}}{'requires_subscription'} eq "True") {
333 # Check if an subscription/oinkcode has been provided.
334 if ($cgiparams{'OINKCODE'}) {
335 # Check if the oinkcode contains unallowed chars.
336 unless ($cgiparams{'OINKCODE'} =~ /^[a-z0-9]+$/) {
337 $errormessage = $Lang::tr
{'invalid input for oink code'};
340 # Print an error message, that an subsription/oinkcode is required for this
342 $errormessage = $Lang::tr
{'ids oinkcode required'};
346 # Go on if there are no error messages.
347 if (!$errormessage) {
348 # Store settings into settings file.
349 &General
::writehash
("$IDS::rules_settings_file", \
%cgiparams);
351 # Check if the the automatic rule update hass been touched.
352 if($cgiparams{'AUTOUPDATE_INTERVAL'} ne $oldsettings{'AUTOUPDATE_INTERVAL'}) {
353 # Call suricatactrl to set the new interval.
354 &IDS
::call_suricatactrl
("cron", $cgiparams{'AUTOUPDATE_INTERVAL'});
357 # Check if a ruleset is present - if not or the source has been changed download it.
358 if((! %idsrules) || ($oldsettings{'RULES'} ne $cgiparams{'RULES'})) {
359 # Check if the red device is active.
360 unless (-e
"${General::swroot}/red/active") {
361 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
364 # Check if enough free disk space is availabe.
365 if(&IDS
::checkdiskspace
()) {
366 $errormessage = "$Lang::tr{'not enough disk space'}";
369 # Check if any errors happend.
370 unless ($errormessage) {
371 # Lock the webpage and print notice about downloading
373 &working_notice
("$Lang::tr{'ids working'}");
375 # Write the modify sid's file and pass the taken ruleaction.
376 &IDS
::write_modify_sids_file
();
378 # Call subfunction to download the ruleset.
379 if(&IDS
::downloadruleset
()) {
380 $errormessage = $Lang::tr
{'could not download latest updates'};
382 # Call function to store the errormessage.
383 &IDS
::_store_error_message
($errormessage);
385 # Call subfunction to launch oinkmaster.
389 # Check if the IDS is running.
390 if(&IDS
::ids_is_running
()) {
391 # Call suricatactrl to stop the IDS - because of the changed
392 # ruleset - the use has to configure it before suricata can be
394 &IDS
::call_suricatactrl
("stop");
397 # Perform a reload of the page.
404 } elsif ($cgiparams{'RULESET'} eq $Lang::tr
{'ids apply'}) {
405 # Arrays to store which rulefiles have been enabled and will be used.
406 my @enabled_rulefiles;
408 # Hash to store the user-enabled and disabled sids.
409 my %enabled_disabled_sids;
411 # Store if a restart of suricata is required.
412 my $suricata_restart_required;
414 # Loop through the hash of idsrules.
415 foreach my $rulefile(keys %idsrules) {
416 # Check if the state of the rulefile has been changed.
417 unless ($cgiparams{$rulefile} eq $idsrules{$rulefile}{'Rulefile'}{'State'}) {
418 # A restart of suricata is required to apply the changes of the used rulefiles.
419 $suricata_restart_required = 1;
422 # Check if the rulefile is enabled.
423 if ($cgiparams{$rulefile} eq "on") {
424 # Add rulefile to the array of enabled rulefiles.
425 push(@enabled_rulefiles, $rulefile);
427 # Drop item from cgiparams hash.
428 delete $cgiparams{$rulefile};
432 # Read-in the files for enabled/disabled sids.
433 # This will be done by calling the read_enabled_disabled_sids_file function two times
434 # and merge the returned hashes together into the enabled_disabled_sids hash.
435 %enabled_disabled_sids = (
436 &read_enabled_disabled_sids_file
($IDS::disabled_sids_file
),
437 &read_enabled_disabled_sids_file
($IDS::enabled_sids_file
));
439 # Loop through the hash of idsrules.
440 foreach my $rulefile (keys %idsrules) {
441 # Loop through the single rules of the rulefile.
442 foreach my $sid (keys %{$idsrules{$rulefile}}) {
443 # Skip the current sid if it is not numeric.
444 next unless ($sid =~ /\d+/ );
446 # Check if there exists a key in the cgiparams hash for this sid.
447 if (exists($cgiparams{$sid})) {
448 # Look if the rule is disabled.
449 if ($idsrules{$rulefile}{$sid}{'State'} eq "off") {
450 # Check if the state has been set to 'on'.
451 if ($cgiparams{$sid} eq "on") {
452 # Add/Modify the sid to/in the enabled_disabled_sids hash.
453 $enabled_disabled_sids{$sid} = "enabled";
455 # Drop item from cgiparams hash.
456 delete $cgiparams{$rulefile}{$sid};
460 # Look if the rule is enabled.
461 if ($idsrules{$rulefile}{$sid}{'State'} eq "on") {
462 # Check if the state is 'on' and should be disabled.
463 # In this case there is no entry
464 # for the sid in the cgiparams hash.
465 # Add/Modify it to/in the enabled_disabled_sids hash.
466 $enabled_disabled_sids{$sid} = "disabled";
468 # Drop item from cgiparams hash.
469 delete $cgiparams{$rulefile}{$sid};
475 # Open enabled sid's file for writing.
476 open(ENABLED_FILE
, ">$IDS::enabled_sids_file") or die "Could not write to $IDS::enabled_sids_file. $!\n";
478 # Open disabled sid's file for writing.
479 open(DISABLED_FILE
, ">$IDS::disabled_sids_file") or die "Could not write to $IDS::disabled_sids_file. $!\n";
481 # Write header to the files.
482 print ENABLED_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
483 print DISABLED_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
485 # Check if the hash for enabled/disabled files contains any entries.
486 if (%enabled_disabled_sids) {
487 # Loop through the hash.
488 foreach my $sid (keys %enabled_disabled_sids) {
489 # Check if the sid is enabled.
490 if ($enabled_disabled_sids{$sid} eq "enabled") {
491 # Print the sid to the enabled_sids file.
492 print ENABLED_FILE
"enablesid $sid\n";
493 # Check if the sid is disabled.
494 } elsif ($enabled_disabled_sids{$sid} eq "disabled") {
495 # Print the sid to the disabled_sids file.
496 print DISABLED_FILE
"disablesid $sid\n";
497 # Something strange happende - skip the current sid.
504 # Close file for enabled_sids after writing.
507 # Close file for disabled_sids after writing.
508 close(DISABLED_FILE
);
510 # Call function to generate and write the used rulefiles file.
511 &IDS
::write_used_rulefiles_file
(@enabled_rulefiles);
513 # Lock the webpage and print message.
514 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
516 # Call oinkmaster to alter the ruleset.
519 # Check if the IDS is running.
520 if(&IDS
::ids_is_running
()) {
521 # Check if a restart of suricata is required.
522 if ($suricata_restart_required) {
523 # Call suricatactrl to perform the restart.
524 &IDS
::call_suricatactrl
("restart");
526 # Call suricatactrl to perform a reload.
527 &IDS
::call_suricatactrl
("reload");
534 # Download new ruleset.
535 } elsif ($cgiparams{'RULESET'} eq $Lang::tr
{'update ruleset'}) {
536 # Check if the red device is active.
537 unless (-e
"${General::swroot}/red/active") {
538 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
541 # Check if enought free disk space is availabe.
542 if(&IDS
::checkdiskspace
()) {
543 $errormessage = "$Lang::tr{'not enough disk space'}";
546 # Check if any errors happend.
547 unless ($errormessage) {
548 # Lock the webpage and print notice about downloading
550 &working_notice
("$Lang::tr{'ids download new ruleset'}");
552 # Call subfunction to download the ruleset.
553 if(&IDS
::downloadruleset
()) {
554 $errormessage = $Lang::tr
{'could not download latest updates'};
556 # Call function to store the errormessage.
557 &IDS
::_store_error_message
($errormessage);
559 # Preform a reload of the page.
562 # Call subfunction to launch oinkmaster.
565 # Check if the IDS is running.
566 if(&IDS
::ids_is_running
()) {
567 # Call suricatactrl to perform a reload.
568 &IDS
::call_suricatactrl
("reload");
571 # Perform a reload of the page.
576 } elsif ($cgiparams{'IDS'} eq $Lang::tr
{'save'}) {
579 my $monitored_zones = 0;
581 # Read-in current (old) IDS settings.
582 &General
::readhash
("$IDS::ids_settings_file", \
%oldidssettings);
584 # Prevent form name from been stored in conf file.
585 delete $cgiparams{'IDS'};
587 # Check if the IDS should be enabled.
588 if ($cgiparams{'ENABLE_IDS'} eq "on") {
589 # Check if any ruleset is available. Otherwise abort and display an error.
591 $errormessage = $Lang::tr
{'ids no ruleset available'};
594 # Loop through the array of available interfaces.
595 foreach my $zone (@network_zones) {
596 # Convert interface name into upper case.
597 my $zone_upper = uc($zone);
599 # Check if the IDS is enabled for this interaces.
600 if ($cgiparams{"ENABLE_IDS_$zone_upper"}) {
606 # Check if at least one zone should be monitored, or show an error.
607 unless ($monitored_zones >= 1) {
608 $errormessage = $Lang::tr
{'ids no network zone'};
612 # Go on if there are no error messages.
613 if (!$errormessage) {
614 # Store settings into settings file.
615 &General
::writehash
("$IDS::ids_settings_file", \
%cgiparams);
618 # Generate file to store the home net.
619 &IDS
::generate_home_net_file
();
621 # Generate file to the store the DNS servers.
622 &IDS
::generate_dns_servers_file
();
624 # Generate file to store the HTTP ports.
625 &IDS
::generate_http_ports_file
();
627 # Write the modify sid's file and pass the taken ruleaction.
628 &IDS
::write_modify_sids_file
();
630 # Check if "MONITOR_TRAFFIC_ONLY" has been changed.
631 if($cgiparams{'MONITOR_TRAFFIC_ONLY'} ne $oldidssettings{'MONITOR_TRAFFIC_ONLY'}) {
632 # Check if a ruleset exists.
634 # Lock the webpage and print message.
635 &working_notice
("$Lang::tr{'ids working'}");
637 # Call oinkmaster to alter the ruleset.
640 # Set reload_page to "True".
645 # Check if the IDS currently is running.
646 if(&IDS
::ids_is_running
()) {
647 # Check if ENABLE_IDS is set to on.
648 if($cgiparams{'ENABLE_IDS'} eq "on") {
649 # Call suricatactrl to perform a reload of suricata.
650 &IDS
::call_suricatactrl
("reload");
652 # Call suricatactrl to stop suricata.
653 &IDS
::call_suricatactrl
("stop");
656 # Call suricatactrl to start suricata.
657 &IDS
::call_suricatactrl
("start");
660 # Check if the page should be reloaded.
662 # Perform a reload of the page.
667 # Read-in idssettings and rulesetsettings
668 &General
::readhash
("$IDS::ids_settings_file", \
%idssettings);
669 &General
::readhash
("$IDS::rules_settings_file", \
%rulessettings);
671 # If no autoupdate intervall has been configured yet, set default value.
672 unless(exists($rulessettings{'AUTOUPDATE_INTERVAL'})) {
673 # Set default to "weekly".
674 $rulessettings{'AUTOUPDATE_INTERVAL'} = 'weekly';
677 # Read-in ignored hosts.
678 &General
::readhasharray
("$IDS::settingsdir/ignored", \
%ignored);
680 $checked{'ENABLE_IDS'}{'off'} = '';
681 $checked{'ENABLE_IDS'}{'on'} = '';
682 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
683 $checked{'MONITOR_TRAFFIC_ONLY'}{'off'} = '';
684 $checked{'MONITOR_TRAFFIC_ONLY'}{'on'} = '';
685 $checked{'MONITOR_TRAFFIC_ONLY'}{$idssettings{'MONITOR_TRAFFIC_ONLY'}} = "checked='checked'";
686 $selected{'RULES'}{'nothing'} = '';
687 $selected{'RULES'}{$rulessettings{'RULES'}} = "selected='selected'";
688 $selected{'AUTOUPDATE_INTERVAL'}{'off'} = '';
689 $selected{'AUTOUPDATE_INTERVAL'}{'daily'} = '';
690 $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} = '';
691 $selected{'AUTOUPDATE_INTERVAL'}{$rulessettings{'AUTOUPDATE_INTERVAL'}} = "selected='selected'";
693 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
698 # Java script variable declaration for show and hide.
699 print"var show = \"$Lang::tr{'ids show'}\"\;\n";
700 print"var hide = \"$Lang::tr{'ids hide'}\"\;\n";
703 // Java Script function to show/hide the text input field for
704 // Oinkcode/Subscription code.
705 var update_code = function() {
706 if(\$('#RULES').val() == 'registered') {
708 } else if(\$('#RULES').val() == 'subscripted') {
710 } else if(\$('#RULES').val() == 'emerging_pro') {
717 // JQuery function to call corresponding function when
718 // the ruleset is changed or the page is loaded for showing/hiding
720 \$(document).ready(function() {
721 \$('#RULES').change(update_code);
725 // Tiny java script function to show/hide the rules
726 // of a given category.
727 function showhide(tblname) {
728 \$("#" + tblname).toggle();
730 // Get current content of the span element.
731 var content = document.getElementById("span_" + tblname);
733 if (content.innerHTML === show) {
734 content.innerHTML = hide;
736 content.innerHTML = show;
743 &Header
::openbigbox
('100%', 'left', '', $errormessage);
746 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
747 print "<class name='base'>$errormessage\n";
748 print " </class>\n";
752 # Draw current state of the IDS
753 &Header
::openbox
('100%', 'left', $Lang::tr
{'intrusion detection system'});
755 # Check if the IDS is running and obtain the process-id.
756 my $pid = &IDS
::ids_is_running
();
758 # Display some useful information, if suricata daemon is running.
760 # Gather used memory.
761 my $memory = &get_memory_usage
($pid);
764 <table width='95%' cellspacing='0' class='tbl'>
766 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
770 <td class='base'>$Lang::tr{'guardian daemon'}</td>
771 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
775 <td class='base'></td>
776 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
777 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
781 <td class='base'></td>
782 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
783 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
788 # Otherwise display a hint that the service is not launched.
790 <table width='95%' cellspacing='0' class='tbl'>
792 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
796 <td class='base'>$Lang::tr{'guardian daemon'}</td>
797 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
803 # Only show this area, if a ruleset is present.
808 <br><br><h2>$Lang::tr{'settings'}</h2>
810 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
811 <table width='100%' border='0'>
813 <td class='base' colspan='2'>
814 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}> $Lang::tr{'ids enable'}
817 <td class='base' colspan='2'>
818 <input type='checkbox' name='MONITOR_TRAFFIC_ONLY' $checked{'MONITOR_TRAFFIC_ONLY'}{'on'}> $Lang::tr{'ids monitor traffic only'}
830 <td colspan='4'><b>$Lang::tr{'ids monitored interfaces'}</b><br></td>
837 # Loop through the array of available networks and print config options.
838 foreach my $zone (@network_zones) {
842 # Convert current zone name to upper case.
843 my $zone_upper = uc($zone);
846 my $zone_name = $zone;
848 # Dirty hack to get the correct language string for the red zone.
849 if ($zone eq "red") {
853 # Grab checkbox status from settings hash.
854 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
855 $checked_input = "checked = 'checked'";
858 print "<td class='base' width='20%'>\n";
859 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>\n";
860 print " $Lang::tr{'enabled on'}<font color='$colourhash{$zone}'> $Lang::tr{$zone_name}</font>\n";
872 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
883 # Draw elements for ruleset configuration.
884 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ruleset settings'});
887 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
888 <table width='100%' border='0'>
890 <td><b>$Lang::tr{'ids rules update'}</b></td>
891 <td><b>$Lang::tr{'ids automatic rules update'}</b></td>
895 <td><select name='RULES' id='RULES'>
898 # Get all available ruleset providers.
899 my @ruleset_providers = &IDS
::get_ruleset_providers
();
901 # Loop throgh the list of providers.
902 foreach my $provider (@ruleset_providers) {
903 # Call get_provider_name function to obtain the provider name.
904 my $option_string = &get_provider_name
($provider);
907 print "<option value='$provider' $selected{'RULES'}{$provider}>$option_string</option>\n";
914 <select name='AUTOUPDATE_INTERVAL'>
915 <option value='off' $selected{'AUTOUPDATE_INTERVAL'}{'off'} >- $Lang::tr{'Disabled'} -</option>
916 <option value='daily' $selected{'AUTOUPDATE_INTERVAL'}{'daily'} >$Lang::tr{'Daily'}</option>
917 <option value='weekly' $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} >$Lang::tr{'Weekly'}</option>
923 <td colspan='2'><br><br></td>
926 <tr style='display:none' id='code'>
927 <td colspan='2'>Oinkcode: <input type='text' size='40' name='OINKCODE' value='$rulessettings{'OINKCODE'}'></td>
936 # Show the "Update Ruleset"-Button only if a ruleset has been downloaded yet and automatic updates are disabled.
937 if ((%idsrules) && ($rulessettings{'AUTOUPDATE_INTERVAL'} eq "off")) {
938 # Display button to update the ruleset.
939 print"<input type='submit' name='RULESET' value='$Lang::tr{'update ruleset'}'>\n";
942 <input type='submit' name='RULESET' value='$Lang::tr{'ids customize ruleset'}'>
943 <input type='submit' name='RULESET' value='$Lang::tr{'save'}'>
955 # Whitelist / Ignorelist
957 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ignored hosts'});
962 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
963 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
964 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
967 # Check if some hosts have been added to be ignored.
968 if (keys (%ignored)) {
971 # Loop through all entries of the hash.
972 while( (my $key) = each %ignored) {
973 # Assign data array positions to some nice variable names.
974 my $address = $ignored{$key}[0];
975 my $remark = $ignored{$key}[1];
976 my $status = $ignored{$key}[2];
978 # Check if the key (id) number is even or not.
979 if ($cgiparams{'ID'} eq $key) {
980 $col="bgcolor='${Header::colouryellow}'";
982 $col="bgcolor='$color{'color22'}'";
984 $col="bgcolor='$color{'color20'}'";
987 # Choose icon for the checkbox.
991 # Check if the status is enabled and select the correct image and description.
992 if ($status eq 'enabled' ) {
994 $gdesc = $Lang::tr
{'click to disable'};
997 $gdesc = $Lang::tr
{'click to enable'};
1002 <td width='20%' class='base' $col>$address</td>
1003 <td width='65%' class='base' $col>$remark</td>
1005 <td align='center' $col>
1006 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1007 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}' />
1008 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc' />
1009 <input type='hidden' name='ID' value='$key' />
1013 <td align='center' $col>
1014 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1015 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}' />
1016 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}' />
1017 <input type='hidden' name='ID' value='$key' />
1021 <td align='center' $col>
1022 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
1023 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1024 <input type='hidden' name='ID' value='$key'>
1025 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
1032 # Print notice that currently no hosts are ignored.
1034 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1040 # Section to add new elements or edit existing ones.
1046 <div align='center'>
1047 <table width='100%'>
1050 # Assign correct headline and button text.
1055 # Check if an ID (key) has been given, in this case an existing entry should be edited.
1056 if ($cgiparams{'ID'} ne '') {
1057 $buttontext = $Lang::tr
{'update'};
1058 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
1060 # Grab address and remark for the given key.
1061 $entry_address = $ignored{$cgiparams{'ID'}}[0];
1062 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
1064 $buttontext = $Lang::tr
{'add'};
1065 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
1069 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1070 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1072 <td width='30%'>$Lang::tr{'ip address'}: </td>
1073 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
1075 <td width='30%'>$Lang::tr{'remark'}: </td>
1076 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
1077 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
1084 &Header
::closebox
();
1086 # Only show the section for configuring the ruleset if one is present.
1088 &show_customize_ruleset
();
1091 &Header
::closebigbox
();
1092 &Header
::closepage
();
1095 ## Function to show the customize ruleset section.
1097 sub show_customize_ruleset
() {
1098 # Load neccessary perl modules for file stat and to format the timestamp.
1100 use POSIX
qw( strftime );
1102 # Call stat on the rulestarball.
1103 my $stat = stat("$IDS::rulestarball");
1105 if (defined $stat) {
1106 # Get timestamp the file creation.
1107 my $mtime = $stat->mtime;
1109 # Convert into human read-able format.
1110 my $rulesdate = strftime
('%Y-%m-%d %H:%M:%S', localtime($mtime));
1112 &Header
::openbox
('100%', 'LEFT', "$Lang::tr{'intrusion detection system rules'} ($rulesdate)" );
1114 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
1116 # Output display table for rule files
1117 print "<table width='100%'>\n";
1119 # Loop over each rule file
1120 foreach my $rulefile (sort keys(%idsrules)) {
1121 my $rulechecked = '';
1123 # Check if rule file is enabled
1124 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
1125 $rulechecked = 'CHECKED';
1128 # Convert rulefile name into category name.
1129 my $categoryname = &_rulefile_to_category
($rulefile);
1131 # Table and rows for the rule files.
1133 print"<td class='base' width='5%'>\n";
1134 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
1136 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
1137 print"<td class='base' width='5%' align='right'>\n";
1138 print"<a href=\"javascript:showhide('$categoryname')\"><span id='span_$categoryname'>$Lang::tr{'ids show'}</span></a>\n";
1142 # Rows which will be hidden per default and will contain the single rules.
1143 print"<tr style='display:none' id='$categoryname'>\n";
1144 print"<td colspan='3'>\n";
1151 # New table for the single rules.
1152 print "<table width='100%'>\n";
1154 # Loop over rule file rules
1155 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
1157 my $ruledefchecked = '';
1159 # Skip rulefile itself.
1160 next if ($sid eq "Rulefile");
1162 # If 2 rules have been displayed, start a new row
1163 if (($lines % 2) == 0) {
1164 print "</tr><tr>\n";
1166 # Increase rows by once.
1172 $col="bgcolor='$color{'color20'}'";
1174 $col="bgcolor='$color{'color22'}'";
1178 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
1179 $ruledefchecked = 'CHECKED';
1182 # Create rule checkbox and display rule description
1183 print "<td class='base' width='5%' align='right' $col>\n";
1184 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
1186 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1188 # Increment rule count
1192 # If do not have a second rule for row, create empty cell
1193 if (($lines % 2) != 0) {
1194 print "<td class='base'></td>";
1197 # Close display table
1198 print "</tr></table></td></tr>";
1201 # Close display table
1205 <table width='100%'>
1207 <td width='100%' align='right'><input type='submit' name='RULESET' value='$Lang::tr{'ids apply'}'></td>
1213 &Header
::closebox
();
1218 ## A function to display a notice, to lock the webpage and
1219 ## tell the user which action currently will be performed.
1221 sub working_notice
($) {
1224 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
1225 &Header
::openbigbox
('100%', 'left', '', $errormessage);
1226 &Header
::openbox
( 'Waiting', 1,);
1230 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
1235 &Header
::closebox
();
1236 &Header
::closebigbox
();
1237 &Header
::closepage
();
1241 ## A tiny function to perform a reload of the webpage after one second.
1244 print "<meta http-equiv='refresh' content='1'>\n";
1251 ## Private function to read-in and parse rules of a given rulefile.
1253 ## The given file will be read, parsed and all valid rules will be stored by ID,
1254 ## message/description and it's state in the idsrules hash.
1256 sub readrulesfile
($) {
1257 my $rulefile = shift;
1259 # Open rule file and read in contents
1260 open(RULEFILE
, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
1262 # Store file content in an array.
1263 my @lines = <RULEFILE
>;
1268 # Loop over rule file contents
1269 foreach my $line (@lines) {
1270 # Remove whitespaces.
1274 next if ($line =~ /^\s*$/);
1280 # Gather rule sid and message from the ruleline.
1281 if ($line =~ m/.*msg:\"(.*?)\"\; .* sid:(.*?); /) {
1285 # Check if a rule has been found.
1287 # Add rule to the idsrules hash.
1288 $idsrules{$rulefile}{$sid}{'Description'} = $msg;
1290 # Grab status of the rule. Check if ruleline starts with a "dash".
1291 if ($line =~ /^\#/) {
1292 # If yes, the rule is disabled.
1293 $idsrules{$rulefile}{$sid}{'State'} = "off";
1295 # Otherwise the rule is enabled.
1296 $idsrules{$rulefile}{$sid}{'State'} = "on";
1304 ## Function to get the used memory of a given process-id.
1306 sub get_memory_usage
($) {
1311 # Try to open the status file for the given process-id on the pseudo
1313 if (open(FILE
, "/proc/$pid/status")) {
1314 # Loop through the entire file.
1316 # Splitt current line content and store them into variables.
1317 my ($key, $value) = split(":", $_, 2);
1319 # Check if the current key is the one which contains the memory usage.
1320 # The wanted one is VmRSS which contains the Real-memory (resident set)
1321 # of the entire process.
1322 if ($key eq "VmRSS") {
1323 # Found the memory usage add it to the memory variable.
1331 # Close file handle.
1334 # Return memory usage.
1338 # If the file could not be open, return nothing.
1343 ## Function to read-in the given enabled or disables sids file.
1345 sub read_enabled_disabled_sids_file
($) {
1348 # Temporary hash to store the sids and their state. It will be
1349 # returned at the end of this function.
1352 # Open the given filename.
1353 open(FILE
, "$file") or die "Could not open $file. $!\n";
1355 # Loop through the file.
1361 next if ($_ =~ /^\s*$/);
1364 next if ($_ =~ /^\#/);
1366 # Splitt line into sid and state part.
1367 my ($state, $sid) = split(" ", $_);
1369 # Skip line if the sid is not numeric.
1370 next unless ($sid =~ /\d+/ );
1372 # Check if the sid was enabled.
1373 if ($state eq "enablesid") {
1374 # Add the sid and its state as enabled to the temporary hash.
1375 $temphash{$sid} = "enabled";
1376 # Check if the sid was disabled.
1377 } elsif ($state eq "disablesid") {
1378 # Add the sid and its state as disabled to the temporary hash.
1379 $temphash{$sid} = "disabled";
1380 # Invalid state - skip the current sid and state.
1394 ## Function to get the provider name from the language file or providers file for a given handle.
1396 sub get_provider_name
($) {
1400 # Get the required translation string for the given provider handle.
1401 my $tr_string = $IDS::Ruleset
::Providers
{$handle}{'tr_string'};
1403 # Check if the translation string is available in the language files.
1404 if ($Lang::tr
{$tr_string}) {
1405 # Use the translated string from the language file.
1406 $provider_name = $Lang::tr
{$tr_string};
1408 # Fallback and use the provider summary from the providers file.
1409 $provider_name = $IDS::Ruleset
::Providers
{$handle}{'summary'};
1412 # Return the obtained provider name.
1413 return $provider_name;
1417 ## Private function to convert a given rulefile to a category name.
1418 ## ( No file extension anymore and if the name contained a dot, it
1419 ## would be replaced by a underline sign.)
1421 sub _rulefile_to_category
($) {
1422 my ($filename) = @_;
1424 # Splitt the filename into single chunks and store them in a
1426 my @parts = split(/\./, $filename);
1428 # Return / Remove last element of the temporary array.
1429 # This removes the file extension.
1432 # Join together the single elements of the temporary array.
1433 # If these are more than one, use a "underline" for joining.
1434 my $category = join '_', @parts;
1436 # Return the converted filename.