2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2007-2018 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";
34 my %mainsettings = ();
38 my %rulesetsources = ();
44 # Read-in main settings, for language, theme and colors.
45 &General
::readhash
("${General::swroot}/main/settings", \
%mainsettings);
46 &General
::readhash
("/srv/web/ipfire/html/themes/".$mainsettings{'THEME'}."/include/colors.txt", \
%color);
48 # Get the available network zones, based on the config type of the system and store
49 # the list of zones in an array.
50 my @network_zones = &IDS
::get_available_network_zones
();
54 # Create files if they does not exist yet.
55 &IDS
::check_and_create_filelayout
();
57 # Hash which contains the colour code of a network zone.
59 'red' => $Header::colourred
,
60 'green' => $Header::colourgreen
,
61 'blue' => $Header::colourblue
,
62 'orange' => $Header::colourorange
65 &Header
::showhttpheaders
();
68 &Header
::getcgihash
(\
%cgiparams);
70 ## Add/edit an entry to the ignore file.
72 if (($cgiparams{'WHITELIST'} eq $Lang::tr
{'add'}) || ($cgiparams{'WHITELIST'} eq $Lang::tr
{'update'})) {
74 # Check if any input has been performed.
75 if ($cgiparams{'IGNORE_ENTRY_ADDRESS'} ne '') {
77 # Check if the given input is no valid IP-address or IP-address with subnet, display an error message.
78 if ((!&General
::validip
($cgiparams{'IGNORE_ENTRY_ADDRESS'})) && (!&General
::validipandmask
($cgiparams{'IGNORE_ENTRY_ADDRESS'}))) {
79 $errormessage = "$Lang::tr{'guardian invalid address or subnet'}";
82 $errormessage = "$Lang::tr{'guardian empty input'}";
85 # Go further if there was no error.
86 if ($errormessage eq '') {
92 my $new_entry_address = $cgiparams{'IGNORE_ENTRY_ADDRESS'};
93 my $new_entry_remark = $cgiparams{'IGNORE_ENTRY_REMARK'};
95 # Read-in ignoredfile.
96 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
98 # Check if we should edit an existing entry and got an ID.
99 if (($cgiparams{'WHITELIST'} eq $Lang::tr
{'update'}) && ($cgiparams{'ID'})) {
100 # Assin the provided id.
101 $id = $cgiparams{'ID'};
103 # Undef the given ID.
104 undef($cgiparams{'ID'});
106 # Grab the configured status of the corresponding entry.
107 $status = $ignored{$id}[2];
109 # Each newly added entry automatically should be enabled.
112 # Generate the ID for the new entry.
114 # Sort the keys by their ID and store them in an array.
115 my @keys = sort { $a <=> $b } keys %ignored;
117 # Reverse the key array.
118 my @reversed = reverse(@keys);
120 # Obtain the last used id.
121 my $last_id = @reversed[0];
123 # Increase the last id by one and use it as id for the new entry.
127 # Add/Modify the entry to/in the ignored hash.
128 $ignored{$id} = ["$new_entry_address", "$new_entry_remark", "$status"];
130 # Write the changed ignored hash to the ignored file.
131 &General
::writehasharray
($IDS::ignored_file
, \
%ignored);
133 # Regenerate the ignore file.
134 &IDS
::generate_ignore_file
();
137 # Check if the IDS is running.
138 if(&IDS
::ids_is_running
()) {
139 # Call suricatactrl to perform a reload.
140 &IDS
::call_suricatactrl
("reload");
143 ## Toggle Enabled/Disabled for an existing entry on the ignore list.
146 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr
{'toggle enable disable'}) {
149 # Only go further, if an ID has been passed.
150 if ($cgiparams{'ID'}) {
151 # Assign the given ID.
152 my $id = $cgiparams{'ID'};
154 # Undef the given ID.
155 undef($cgiparams{'ID'});
157 # Read-in ignoredfile.
158 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
160 # Grab the configured status of the corresponding entry.
161 my $status = $ignored{$id}[2];
164 if ($status eq "disabled") {
167 $status = "disabled";
170 # Modify the status of the existing entry.
171 $ignored{$id} = ["$ignored{$id}[0]", "$ignored{$id}[1]", "$status"];
173 # Write the changed ignored hash to the ignored file.
174 &General
::writehasharray
($IDS::ignored_file
, \
%ignored);
176 # Regenerate the ignore file.
177 &IDS
::generate_ignore_file
();
179 # Check if the IDS is running.
180 if(&IDS
::ids_is_running
()) {
181 # Call suricatactrl to perform a reload.
182 &IDS
::call_suricatactrl
("reload");
186 ## Remove entry from ignore list.
188 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr
{'remove'}) {
191 # Read-in ignoredfile.
192 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
194 # Drop entry from the hash.
195 delete($ignored{$cgiparams{'ID'}});
197 # Undef the given ID.
198 undef($cgiparams{'ID'});
200 # Write the changed ignored hash to the ignored file.
201 &General
::writehasharray
($IDS::ignored_file
, \
%ignored);
203 # Regenerate the ignore file.
204 &IDS
::generate_ignore_file
();
206 # Check if the IDS is running.
207 if(&IDS
::ids_is_running
()) {
208 # Call suricatactrl to perform a reload.
209 &IDS
::call_suricatactrl
("reload");
213 # Check if the page is locked, in this case, the ids_page_lock_file exists.
214 if (-e
$IDS::ids_page_lock_file
) {
215 # Lock the webpage and print notice about autoupgrade of the ruleset
217 &working_notice
("$Lang::tr{'ids ruleset autoupdate in progress'}");
219 # Loop and check if the file still exists.
220 while(-e
$IDS::ids_page_lock_file
) {
221 # Sleep for a second and re-check.
225 # Page has been unlocked, perform a reload.
229 # Check if any error has been stored.
230 if (-e
$IDS::storederrorfile
) {
231 # Open file to read in the stored error message.
232 open(FILE
, "<$IDS::storederrorfile") or die "Could not open $IDS::storederrorfile. $!\n";
234 # Read the stored error message.
235 $errormessage = <FILE
>;
240 # Delete the file, which is now not longer required.
241 unlink($IDS::storederrorfile
);
244 ## Grab all available rules and store them in the idsrules hash.
246 # Open rules directory and do a directory listing.
247 opendir(DIR
, $IDS::rulespath
) or die $!;
248 # Loop through the direcory.
249 while (my $file = readdir(DIR
)) {
251 # We only want files.
252 next unless (-f
"$IDS::rulespath/$file");
254 # Ignore empty files.
255 next if (-z
"$IDS::rulespath/$file");
257 # Use a regular expression to find files ending in .rules
258 next unless ($file =~ m/\.rules$/);
260 # Ignore files which are not read-able.
261 next unless (-R
"$IDS::rulespath/$file");
263 # Skip whitelist rules file.
264 next if( $file eq "whitelist.rules");
266 # Call subfunction to read-in rulefile and add rules to
268 &readrulesfile
("$file");
273 # Gather used rulefiles.
275 # Check if the file for activated rulefiles is not empty.
276 if(-f
$IDS::used_rulefiles_file
) {
277 # Open the file for used rulefile and read-in content.
278 open(FILE
, $IDS::used_rulefiles_file
) or die "Could not open $IDS::used_rulefiles_file. $!\n";
286 # Loop through the array.
287 foreach my $line (@lines) {
292 next if ($line =~ /\#/);
295 next if ($line =~ /^\s*$/);
297 # Gather rule sid and message from the ruleline.
298 if ($line =~ /.*- (.*)/) {
301 # Check if the current rulefile exists in the %idsrules hash.
302 # If not, the file probably does not exist anymore or contains
304 if($idsrules{$rulefile}) {
305 # Add the rulefile state to the %idsrules hash.
306 $idsrules{$rulefile}{'Rulefile'}{'State'} = "on";
312 # Save ruleset configuration.
313 if ($cgiparams{'RULESET'} eq $Lang::tr
{'save'}) {
317 # Read-in current (old) IDS settings.
318 &General
::readhash
("$IDS::rules_settings_file", \
%oldsettings);
320 # Get all available ruleset locations.
321 &General
::readhash
("$IDS::rulesetsourcesfile", \
%rulesetsources);
323 # Prevent form name from been stored in conf file.
324 delete $cgiparams{'RULESET'};
326 # Grab the URL based on the choosen vendor.
327 my $url = $rulesetsources{$cgiparams{'RULES'}};
329 # Check if the choosen vendor (URL) requires an subscription/oinkcode.
330 if ($url =~ /\<oinkcode\>/ ) {
331 # Check if an subscription/oinkcode has been provided.
332 if ($cgiparams{'OINKCODE'}) {
333 # Check if the oinkcode contains unallowed chars.
334 unless ($cgiparams{'OINKCODE'} =~ /^[a-z0-9]+$/) {
335 $errormessage = $Lang::tr
{'invalid input for oink code'};
338 # Print an error message, that an subsription/oinkcode is required for this
340 $errormessage = $Lang::tr
{'ids oinkcode required'};
344 # Go on if there are no error messages.
345 if (!$errormessage) {
346 # Store settings into settings file.
347 &General
::writehash
("$IDS::rules_settings_file", \
%cgiparams);
349 # Check if the the automatic rule update hass been touched.
350 if($cgiparams{'AUTOUPDATE_INTERVAL'} ne $oldsettings{'AUTOUPDATE_INTERVAL'}) {
351 # Call suricatactrl to set the new interval.
352 &IDS
::call_suricatactrl
("cron", $cgiparams{'AUTOUPDATE_INTERVAL'});
355 # Check if a ruleset is present - if not or the source has been changed download it.
356 if((! %idsrules) || ($oldsettings{'RULES'} ne $cgiparams{'RULES'})) {
357 # Check if the red device is active.
358 unless (-e
"${General::swroot}/red/active") {
359 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
362 # Check if enough free disk space is availabe.
363 if(&IDS
::checkdiskspace
()) {
364 $errormessage = "$Lang::tr{'not enough disk space'}";
367 # Check if any errors happend.
368 unless ($errormessage) {
369 # Lock the webpage and print notice about downloading
371 &working_notice
("$Lang::tr{'ids working'}");
373 &General
::readhash
("$IDS::ids_settings_file", \
%idssettings);
375 # Temporary variable to set the ruleaction.
376 # Default is "drop" to use suricata as IPS.
377 my $ruleaction="drop";
379 # Check if the traffic only should be monitored.
380 if($idssettings{'MONITOR_TRAFFIC_ONLY'} eq 'on') {
381 # Switch the ruleaction to "alert".
382 # Suricata acts as an IDS only.
386 # Write the modify sid's file and pass the taken ruleaction.
387 &IDS
::write_modify_sids_file
($ruleaction, $cgiparams{'RULES'});
389 # Call subfunction to download the ruleset.
390 if(&IDS
::downloadruleset
()) {
391 $errormessage = $Lang::tr
{'could not download latest updates'};
393 # Call function to store the errormessage.
394 &IDS
::_store_error_message
($errormessage);
396 # Call subfunction to launch oinkmaster.
400 # Check if the IDS is running.
401 if(&IDS
::ids_is_running
()) {
402 # Call suricatactrl to stop the IDS - because of the changed
403 # ruleset - the use has to configure it before suricata can be
405 &IDS
::call_suricatactrl
("stop");
408 # Perform a reload of the page.
415 } elsif ($cgiparams{'RULESET'} eq $Lang::tr
{'ids apply'}) {
416 # Arrays to store which rulefiles have been enabled and will be used.
417 my @enabled_rulefiles;
419 # Hash to store the user-enabled and disabled sids.
420 my %enabled_disabled_sids;
422 # Loop through the hash of idsrules.
423 foreach my $rulefile(keys %idsrules) {
424 # Check if the rulefile is enabled.
425 if ($cgiparams{$rulefile} eq "on") {
426 # Add rulefile to the array of enabled rulefiles.
427 push(@enabled_rulefiles, $rulefile);
429 # Drop item from cgiparams hash.
430 delete $cgiparams{$rulefile};
434 # Read-in the files for enabled/disabled sids.
435 # This will be done by calling the read_enabled_disabled_sids_file function two times
436 # and merge the returned hashes together into the enabled_disabled_sids hash.
437 %enabled_disabled_sids = (
438 &read_enabled_disabled_sids_file
($IDS::disabled_sids_file
),
439 &read_enabled_disabled_sids_file
($IDS::enabled_sids_file
));
441 # Loop through the hash of idsrules.
442 foreach my $rulefile (keys %idsrules) {
443 # Loop through the single rules of the rulefile.
444 foreach my $sid (keys %{$idsrules{$rulefile}}) {
445 # Skip the current sid if it is not numeric.
446 next unless ($sid =~ /\d+/ );
448 # Check if there exists a key in the cgiparams hash for this sid.
449 if (exists($cgiparams{$sid})) {
450 # Look if the rule is disabled.
451 if ($idsrules{$rulefile}{$sid}{'State'} eq "off") {
452 # Check if the state has been set to 'on'.
453 if ($cgiparams{$sid} eq "on") {
454 # Add/Modify the sid to/in the enabled_disabled_sids hash.
455 $enabled_disabled_sids{$sid} = "enabled";
457 # Drop item from cgiparams hash.
458 delete $cgiparams{$rulefile}{$sid};
462 # Look if the rule is enabled.
463 if ($idsrules{$rulefile}{$sid}{'State'} eq "on") {
464 # Check if the state is 'on' and should be disabled.
465 # In this case there is no entry
466 # for the sid in the cgiparams hash.
467 # Add/Modify it to/in the enabled_disabled_sids hash.
468 $enabled_disabled_sids{$sid} = "disabled";
470 # Drop item from cgiparams hash.
471 delete $cgiparams{$rulefile}{$sid};
477 # Open enabled sid's file for writing.
478 open(ENABLED_FILE
, ">$IDS::enabled_sids_file") or die "Could not write to $IDS::enabled_sids_file. $!\n";
480 # Open disabled sid's file for writing.
481 open(DISABLED_FILE
, ">$IDS::disabled_sids_file") or die "Could not write to $IDS::disabled_sids_file. $!\n";
483 # Write header to the files.
484 print ENABLED_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
485 print DISABLED_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
487 # Check if the hash for enabled/disabled files contains any entries.
488 if (%enabled_disabled_sids) {
489 # Loop through the hash.
490 foreach my $sid (keys %enabled_disabled_sids) {
491 # Check if the sid is enabled.
492 if ($enabled_disabled_sids{$sid} eq "enabled") {
493 # Print the sid to the enabled_sids file.
494 print ENABLED_FILE
"enablesid $sid\n";
495 # Check if the sid is disabled.
496 } elsif ($enabled_disabled_sids{$sid} eq "disabled") {
497 # Print the sid to the disabled_sids file.
498 print DISABLED_FILE
"disablesid $sid\n";
499 # Something strange happende - skip the current sid.
506 # Close file for enabled_sids after writing.
509 # Close file for disabled_sids after writing.
510 close(DISABLED_FILE
);
512 # Call function to generate and write the used rulefiles file.
513 &IDS
::write_used_rulefiles_file
(@enabled_rulefiles);
515 # Lock the webpage and print message.
516 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
518 # Call oinkmaster to alter the ruleset.
521 # Check if the IDS is running.
522 if(&IDS
::ids_is_running
()) {
523 # Call suricatactrl to perform a reload.
524 &IDS
::call_suricatactrl
("reload");
530 # Download new ruleset.
531 } elsif ($cgiparams{'RULESET'} eq $Lang::tr
{'update ruleset'}) {
532 # Check if the red device is active.
533 unless (-e
"${General::swroot}/red/active") {
534 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
537 # Check if enought free disk space is availabe.
538 if(&IDS
::checkdiskspace
()) {
539 $errormessage = "$Lang::tr{'not enough disk space'}";
542 # Check if any errors happend.
543 unless ($errormessage) {
544 # Lock the webpage and print notice about downloading
546 &working_notice
("$Lang::tr{'ids download new ruleset'}");
548 # Call subfunction to download the ruleset.
549 if(&IDS
::downloadruleset
()) {
550 $errormessage = $Lang::tr
{'could not download latest updates'};
552 # Call function to store the errormessage.
553 &IDS
::_store_error_message
($errormessage);
555 # Preform a reload of the page.
558 # Call subfunction to launch oinkmaster.
561 # Check if the IDS is running.
562 if(&IDS
::ids_is_running
()) {
563 # Call suricatactrl to perform a reload.
564 &IDS
::call_suricatactrl
("reload");
567 # Perform a reload of the page.
572 } elsif ($cgiparams{'IDS'} eq $Lang::tr
{'save'}) {
575 my $monitored_zones = 0;
577 # Read-in current (old) IDS settings.
578 &General
::readhash
("$IDS::ids_settings_file", \
%oldidssettings);
580 # Prevent form name from been stored in conf file.
581 delete $cgiparams{'IDS'};
583 # Check if the IDS should be enabled.
584 if ($cgiparams{'ENABLE_IDS'} eq "on") {
585 # Check if any ruleset is available. Otherwise abort and display an error.
587 $errormessage = $Lang::tr
{'ids no ruleset available'};
590 # Loop through the array of available interfaces.
591 foreach my $zone (@network_zones) {
592 # Convert interface name into upper case.
593 my $zone_upper = uc($zone);
595 # Check if the IDS is enabled for this interaces.
596 if ($cgiparams{"ENABLE_IDS_$zone_upper"}) {
602 # Check if at least one zone should be monitored, or show an error.
603 unless ($monitored_zones >= 1) {
604 $errormessage = $Lang::tr
{'ids no network zone'};
608 # Go on if there are no error messages.
609 if (!$errormessage) {
610 # Store settings into settings file.
611 &General
::writehash
("$IDS::ids_settings_file", \
%cgiparams);
614 # Generate file to store the home net.
615 &IDS
::generate_home_net_file
();
617 # Temporary variable to set the ruleaction.
618 # Default is "drop" to use suricata as IPS.
619 my $ruleaction="drop";
621 # Check if the traffic only should be monitored.
622 if($cgiparams{'MONITOR_TRAFFIC_ONLY'} eq 'on') {
623 # Switch the ruleaction to "alert".
624 # Suricata acts as an IDS only.
628 &General
::readhash
("$IDS::rules_settings_file", \
%rulessettings);
630 # Write the modify sid's file and pass the taken ruleaction.
631 &IDS
::write_modify_sids_file
($ruleaction, $rulessettings{'RULES'});
633 # Check if "MONITOR_TRAFFIC_ONLY" has been changed.
634 if($cgiparams{'MONITOR_TRAFFIC_ONLY'} ne $oldidssettings{'MONITOR_TRAFFIC_ONLY'}) {
635 # Check if a ruleset exists.
637 # Lock the webpage and print message.
638 &working_notice
("$Lang::tr{'ids working'}");
640 # Call oinkmaster to alter the ruleset.
643 # Set reload_page to "True".
648 # Check if the IDS currently is running.
649 if(&IDS
::ids_is_running
()) {
650 # Check if ENABLE_IDS is set to on.
651 if($cgiparams{'ENABLE_IDS'} eq "on") {
652 # Call suricatactrl to perform a reload of suricata.
653 &IDS
::call_suricatactrl
("reload");
655 # Call suricatactrl to stop suricata.
656 &IDS
::call_suricatactrl
("stop");
659 # Call suricatactrl to start suricata.
660 &IDS
::call_suricatactrl
("start");
663 # Check if the page should be reloaded.
665 # Perform a reload of the page.
670 # Read-in idssettings and rulesetsettings
671 &General
::readhash
("$IDS::ids_settings_file", \
%idssettings);
672 &General
::readhash
("$IDS::rules_settings_file", \
%rulessettings);
674 # If no autoupdate intervall has been configured yet, set default value.
675 unless(exists($rulessettings{'AUTOUPDATE_INTERVAL'})) {
676 # Set default to "weekly".
677 $rulessettings{'AUTOUPDATE_INTERVAL'} = 'weekly';
680 # Read-in ignored hosts.
681 &General
::readhasharray
("$IDS::settingsdir/ignored", \
%ignored);
683 $checked{'ENABLE_IDS'}{'off'} = '';
684 $checked{'ENABLE_IDS'}{'on'} = '';
685 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
686 $checked{'MONITOR_TRAFFIC_ONLY'}{'off'} = '';
687 $checked{'MONITOR_TRAFFIC_ONLY'}{'on'} = '';
688 $checked{'MONITOR_TRAFFIC_ONLY'}{$idssettings{'MONITOR_TRAFFIC_ONLY'}} = "checked='checked'";
689 $selected{'RULES'}{'nothing'} = '';
690 $selected{'RULES'}{'community'} = '';
691 $selected{'RULES'}{'emerging'} = '';
692 $selected{'RULES'}{'registered'} = '';
693 $selected{'RULES'}{'subscripted'} = '';
694 $selected{'RULES'}{$rulessettings{'RULES'}} = "selected='selected'";
695 $selected{'AUTOUPDATE_INTERVAL'}{'off'} = '';
696 $selected{'AUTOUPDATE_INTERVAL'}{'daily'} = '';
697 $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} = '';
698 $selected{'AUTOUPDATE_INTERVAL'}{$rulessettings{'AUTOUPDATE_INTERVAL'}} = "selected='selected'";
700 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
705 # Java script variable declaration for show and hide.
706 print"var show = \"$Lang::tr{'ids show'}\"\;\n";
707 print"var hide = \"$Lang::tr{'ids hide'}\"\;\n";
710 // Java Script function to show/hide the text input field for
711 // Oinkcode/Subscription code.
712 var update_code = function() {
713 if(\$('#RULES').val() == 'registered') {
715 } else if(\$('#RULES').val() == 'subscripted') {
717 } else if(\$('#RULES').val() == 'emerging_pro') {
724 // JQuery function to call corresponding function when
725 // the ruleset is changed or the page is loaded for showing/hiding
727 \$(document).ready(function() {
728 \$('#RULES').change(update_code);
732 // Tiny java script function to show/hide the rules
733 // of a given category.
734 function showhide(tblname) {
735 \$("#" + tblname).toggle();
737 // Get current content of the span element.
738 var content = document.getElementById("span_" + tblname);
740 if (content.innerHTML === show) {
741 content.innerHTML = hide;
743 content.innerHTML = show;
750 &Header
::openbigbox
('100%', 'left', '', $errormessage);
753 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
754 print "<class name='base'>$errormessage\n";
755 print " </class>\n";
759 # Draw current state of the IDS
760 &Header
::openbox
('100%', 'left', $Lang::tr
{'intrusion detection system'});
762 # Check if the IDS is running and obtain the process-id.
763 my $pid = &IDS
::ids_is_running
();
765 # Display some useful information, if suricata daemon is running.
767 # Gather used memory.
768 my $memory = &get_memory_usage
($pid);
771 <table width='95%' cellspacing='0' class='tbl'>
773 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
777 <td class='base'>$Lang::tr{'guardian daemon'}</td>
778 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
782 <td class='base'></td>
783 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
784 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
788 <td class='base'></td>
789 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
790 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
795 # Otherwise display a hint that the service is not launched.
797 <table width='95%' cellspacing='0' class='tbl'>
799 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
803 <td class='base'>$Lang::tr{'guardian daemon'}</td>
804 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
810 # Only show this area, if a ruleset is present.
815 <br><br><h2>$Lang::tr{'settings'}</h2>
817 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
818 <table width='100%' border='0'>
820 <td class='base' colspan='2'>
821 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}> $Lang::tr{'ids enable'}
824 <td class='base' colspan='2'>
825 <input type='checkbox' name='MONITOR_TRAFFIC_ONLY' $checked{'MONITOR_TRAFFIC_ONLY'}{'on'}> $Lang::tr{'ids monitor traffic only'}
837 <td colspan='4'><b>$Lang::tr{'ids monitored interfaces'}</b><br></td>
844 # Loop through the array of available networks and print config options.
845 foreach my $zone (@network_zones) {
849 # Convert current zone name to upper case.
850 my $zone_upper = uc($zone);
853 my $zone_name = $zone;
855 # Dirty hack to get the correct language string for the red zone.
856 if ($zone eq "red") {
860 # Grab checkbox status from settings hash.
861 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
862 $checked_input = "checked = 'checked'";
865 print "<td class='base' width='25%'>\n";
866 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>\n";
867 print " $Lang::tr{'enabled on'}<font color='$colourhash{$zone}'> $Lang::tr{$zone_name}</font>\n";
879 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
890 # Draw elements for ruleset configuration.
891 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ruleset settings'});
894 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
895 <table width='100%' border='0'>
897 <td><b>$Lang::tr{'ids rules update'}</b></td>
898 <td><b>$Lang::tr{'ids automatic rules update'}</b></td>
902 <td><select name='RULES' id='RULES'>
903 <option value='emerging' $selected{'RULES'}{'emerging'} >$Lang::tr{'emerging rules'}</option>
904 <option value='emerging_pro' $selected{'RULES'}{'emerging_pro'} >$Lang::tr{'emerging pro rules'}</option>
905 <option value='community' $selected{'RULES'}{'community'} >$Lang::tr{'community rules'}</option>
906 <option value='registered' $selected{'RULES'}{'registered'} >$Lang::tr{'registered user rules'}</option>
907 <option value='subscripted' $selected{'RULES'}{'subscripted'} >$Lang::tr{'subscripted user rules'}</option>
912 <select name='AUTOUPDATE_INTERVAL'>
913 <option value='off' $selected{'AUTOUPDATE_INTERVAL'}{'off'} >- $Lang::tr{'Disabled'} -</option>
914 <option value='daily' $selected{'AUTOUPDATE_INTERVAL'}{'daily'} >$Lang::tr{'Daily'}</option>
915 <option value='weekly' $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} >$Lang::tr{'Weekly'}</option>
921 <td colspan='2'><br><br></td>
924 <tr style='display:none' id='code'>
925 <td colspan='2'>Oinkcode: <input type='text' size='40' name='OINKCODE' value='$rulessettings{'OINKCODE'}'></td>
934 # Show the "Update Ruleset"-Button only if a ruleset has been downloaded yet and automatic updates are disabled.
935 if ((%idsrules) && ($rulessettings{'AUTOUPDATE_INTERVAL'} eq "off")) {
936 # Display button to update the ruleset.
937 print"<input type='submit' name='RULESET' value='$Lang::tr{'update ruleset'}'>\n";
940 <input type='submit' name='RULESET' value='$Lang::tr{'save'}'>
952 # Whitelist / Ignorelist
954 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ignored hosts'});
959 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
960 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
961 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
964 # Check if some hosts have been added to be ignored.
965 if (keys (%ignored)) {
968 # Loop through all entries of the hash.
969 while( (my $key) = each %ignored) {
970 # Assign data array positions to some nice variable names.
971 my $address = $ignored{$key}[0];
972 my $remark = $ignored{$key}[1];
973 my $status = $ignored{$key}[2];
975 # Check if the key (id) number is even or not.
976 if ($cgiparams{'ID'} eq $key) {
977 $col="bgcolor='${Header::colouryellow}'";
979 $col="bgcolor='$color{'color22'}'";
981 $col="bgcolor='$color{'color20'}'";
984 # Choose icon for the checkbox.
988 # Check if the status is enabled and select the correct image and description.
989 if ($status eq 'enabled' ) {
991 $gdesc = $Lang::tr
{'click to disable'};
994 $gdesc = $Lang::tr
{'click to enable'};
999 <td width='20%' class='base' $col>$address</td>
1000 <td width='65%' class='base' $col>$remark</td>
1002 <td align='center' $col>
1003 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1004 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}' />
1005 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc' />
1006 <input type='hidden' name='ID' value='$key' />
1010 <td align='center' $col>
1011 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1012 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}' />
1013 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}' />
1014 <input type='hidden' name='ID' value='$key' />
1018 <td align='center' $col>
1019 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
1020 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1021 <input type='hidden' name='ID' value='$key'>
1022 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
1029 # Print notice that currently no hosts are ignored.
1031 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1037 # Section to add new elements or edit existing ones.
1043 <div align='center'>
1044 <table width='100%'>
1047 # Assign correct headline and button text.
1052 # Check if an ID (key) has been given, in this case an existing entry should be edited.
1053 if ($cgiparams{'ID'} ne '') {
1054 $buttontext = $Lang::tr
{'update'};
1055 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
1057 # Grab address and remark for the given key.
1058 $entry_address = $ignored{$cgiparams{'ID'}}[0];
1059 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
1061 $buttontext = $Lang::tr
{'add'};
1062 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
1066 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1067 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1069 <td width='30%'>$Lang::tr{'ip address'}: </td>
1070 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
1072 <td width='30%'>$Lang::tr{'remark'}: </td>
1073 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
1074 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
1081 &Header
::closebox
();
1083 # Only show the section for configuring the ruleset if one is present.
1085 # Load neccessary perl modules for file stat and to format the timestamp.
1087 use POSIX
qw( strftime );
1089 # Call stat on the rulestarball.
1090 my $stat = stat("$IDS::rulestarball");
1092 # Get timestamp the file creation.
1093 my $mtime = $stat->mtime;
1095 # Convert into human read-able format.
1096 my $rulesdate = strftime
('%Y-%m-%d %H:%M:%S', localtime($mtime));
1098 &Header
::openbox
('100%', 'LEFT', "$Lang::tr{'intrusion detection system rules'} ($rulesdate)" );
1100 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
1102 # Output display table for rule files
1103 print "<table width='100%'>\n";
1105 # Loop over each rule file
1106 foreach my $rulefile (sort keys(%idsrules)) {
1107 my $rulechecked = '';
1109 # Check if rule file is enabled
1110 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
1111 $rulechecked = 'CHECKED';
1114 # Convert rulefile name into category name.
1115 my $categoryname = &_rulefile_to_category
($rulefile);
1117 # Table and rows for the rule files.
1119 print"<td class='base' width='5%'>\n";
1120 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
1122 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
1123 print"<td class='base' width='5%' align='right'>\n";
1124 print"<a href=\"javascript:showhide('$categoryname')\"><span id='span_$categoryname'>$Lang::tr{'ids show'}</span></a>\n";
1128 # Rows which will be hidden per default and will contain the single rules.
1129 print"<tr style='display:none' id='$categoryname'>\n";
1130 print"<td colspan='3'>\n";
1137 # New table for the single rules.
1138 print "<table width='100%'>\n";
1140 # Loop over rule file rules
1141 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
1143 my $ruledefchecked = '';
1145 # Skip rulefile itself.
1146 next if ($sid eq "Rulefile");
1148 # If 2 rules have been displayed, start a new row
1149 if (($lines % 2) == 0) {
1150 print "</tr><tr>\n";
1152 # Increase rows by once.
1158 $col="bgcolor='$color{'color20'}'";
1160 $col="bgcolor='$color{'color22'}'";
1164 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
1165 $ruledefchecked = 'CHECKED';
1168 # Create rule checkbox and display rule description
1169 print "<td class='base' width='5%' align='right' $col>\n";
1170 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
1172 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1174 # Increment rule count
1178 # If do not have a second rule for row, create empty cell
1179 if (($lines % 2) != 0) {
1180 print "<td class='base'></td>";
1183 # Close display table
1184 print "</tr></table></td></tr>";
1187 # Close display table
1191 <table width='100%'>
1193 <td width='100%' align='right'><input type='submit' name='RULESET' value='$Lang::tr{'ids apply'}'></td>
1199 &Header
::closebox
();
1202 &Header
::closebigbox
();
1203 &Header
::closepage
();
1206 ## A function to display a notice, to lock the webpage and
1207 ## tell the user which action currently will be performed.
1209 sub working_notice
($) {
1212 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
1213 &Header
::openbigbox
('100%', 'left', '', $errormessage);
1214 &Header
::openbox
( 'Waiting', 1,);
1218 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
1223 &Header
::closebox
();
1224 &Header
::closebigbox
();
1225 &Header
::closepage
();
1229 ## A tiny function to perform a reload of the webpage after one second.
1232 print "<meta http-equiv='refresh' content='1'>\n";
1239 ## Private function to read-in and parse rules of a given rulefile.
1241 ## The given file will be read, parsed and all valid rules will be stored by ID,
1242 ## message/description and it's state in the idsrules hash.
1244 sub readrulesfile
($) {
1245 my $rulefile = shift;
1247 # Open rule file and read in contents
1248 open(RULEFILE
, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
1250 # Store file content in an array.
1251 my @lines = <RULEFILE
>;
1256 # Loop over rule file contents
1257 foreach my $line (@lines) {
1258 # Remove whitespaces.
1262 next if ($line =~ /^\s*$/);
1268 # Gather rule sid and message from the ruleline.
1269 if ($line =~ m/.*msg:\"(.*?)\"\; .* sid:(.*?); /) {
1273 # Check if a rule has been found.
1275 # Add rule to the idsrules hash.
1276 $idsrules{$rulefile}{$sid}{'Description'} = $msg;
1278 # Grab status of the rule. Check if ruleline starts with a "dash".
1279 if ($line =~ /^\#/) {
1280 # If yes, the rule is disabled.
1281 $idsrules{$rulefile}{$sid}{'State'} = "off";
1283 # Otherwise the rule is enabled.
1284 $idsrules{$rulefile}{$sid}{'State'} = "on";
1292 ## Function to get the used memory of a given process-id.
1294 sub get_memory_usage
($) {
1299 # Try to open the status file for the given process-id on the pseudo
1301 if (open(FILE
, "/proc/$pid/status")) {
1302 # Loop through the entire file.
1304 # Splitt current line content and store them into variables.
1305 my ($key, $value) = split(":", $_, 2);
1307 # Check if the current key is the one which contains the memory usage.
1308 # The wanted one is VmRSS which contains the Real-memory (resident set)
1309 # of the entire process.
1310 if ($key eq "VmRSS") {
1311 # Found the memory usage add it to the memory variable.
1319 # Close file handle.
1322 # Return memory usage.
1326 # If the file could not be open, return nothing.
1331 ## Function to read-in the given enabled or disables sids file.
1333 sub read_enabled_disabled_sids_file
($) {
1336 # Temporary hash to store the sids and their state. It will be
1337 # returned at the end of this function.
1340 # Open the given filename.
1341 open(FILE
, "$file") or die "Could not open $file. $!\n";
1343 # Loop through the file.
1349 next if ($_ =~ /^\s*$/);
1352 next if ($_ =~ /^\#/);
1354 # Splitt line into sid and state part.
1355 my ($state, $sid) = split(" ", $_);
1357 # Skip line if the sid is not numeric.
1358 next unless ($sid =~ /\d+/ );
1360 # Check if the sid was enabled.
1361 if ($state eq "enablesid") {
1362 # Add the sid and its state as enabled to the temporary hash.
1363 $temphash{$sid} = "enabled";
1364 # Check if the sid was disabled.
1365 } elsif ($state eq "disablesid") {
1366 # Add the sid and its state as disabled to the temporary hash.
1367 $temphash{$sid} = "disabled";
1368 # Invalid state - skip the current sid and state.
1382 ## Private function to convert a given rulefile to a category name.
1383 ## ( No file extension anymore and if the name contained a dot, it
1384 ## would be replaced by a underline sign.)
1386 sub _rulefile_to_category
($) {
1387 my ($filename) = @_;
1389 # Splitt the filename into single chunks and store them in a
1391 my @parts = split(/\./, $filename);
1393 # Return / Remove last element of the temporary array.
1394 # This removes the file extension.
1397 # Join together the single elements of the temporary array.
1398 # If these are more than one, use a "underline" for joining.
1399 my $category = join '_', @parts;
1401 # Return the converted filename.