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 # Gather ruleset details.
254 if ($cgiparams{'RULESET'}) {
255 ## Grab all available rules and store them in the idsrules hash.
257 # Open rules directory and do a directory listing.
258 opendir(DIR
, $IDS::rulespath
) or die $!;
259 # Loop through the direcory.
260 while (my $file = readdir(DIR
)) {
262 # We only want files.
263 next unless (-f
"$IDS::rulespath/$file");
265 # Ignore empty files.
266 next if (-z
"$IDS::rulespath/$file");
268 # Use a regular expression to find files ending in .rules
269 next unless ($file =~ m/\.rules$/);
271 # Ignore files which are not read-able.
272 next unless (-R
"$IDS::rulespath/$file");
274 # Skip whitelist rules file.
275 next if( $file eq "whitelist.rules");
277 # Call subfunction to read-in rulefile and add rules to
279 &readrulesfile
("$file");
284 # Gather used rulefiles.
286 # Check if the file for activated rulefiles is not empty.
287 if(-f
$IDS::used_rulefiles_file
) {
288 # Open the file for used rulefile and read-in content.
289 open(FILE
, $IDS::used_rulefiles_file
) or die "Could not open $IDS::used_rulefiles_file. $!\n";
297 # Loop through the array.
298 foreach my $line (@lines) {
303 next if ($line =~ /\#/);
306 next if ($line =~ /^\s*$/);
308 # Gather rule sid and message from the ruleline.
309 if ($line =~ /.*- (.*)/) {
312 # Check if the current rulefile exists in the %idsrules hash.
313 # If not, the file probably does not exist anymore or contains
315 if($idsrules{$rulefile}) {
316 # Add the rulefile state to the %idsrules hash.
317 $idsrules{$rulefile}{'Rulefile'}{'State'} = "on";
324 # Save ruleset configuration.
325 if ($cgiparams{'RULESET'} eq $Lang::tr
{'save'}) {
328 # Read-in current (old) IDS settings.
329 &General
::readhash
("$IDS::rules_settings_file", \
%oldsettings);
331 # Prevent form name from been stored in conf file.
332 delete $cgiparams{'RULESET'};
334 # Check if the choosen vendor (URL) requires an subscription/oinkcode.
335 if ($IDS::Ruleset
::Providers
{$cgiparams{'RULES'}}{'requires_subscription'} eq "True") {
336 # Check if an subscription/oinkcode has been provided.
337 if ($cgiparams{'OINKCODE'}) {
338 # Check if the oinkcode contains unallowed chars.
339 unless ($cgiparams{'OINKCODE'} =~ /^[a-z0-9]+$/) {
340 $errormessage = $Lang::tr
{'invalid input for oink code'};
343 # Print an error message, that an subsription/oinkcode is required for this
345 $errormessage = $Lang::tr
{'ids oinkcode required'};
349 # Go on if there are no error messages.
350 if (!$errormessage) {
351 # Store settings into settings file.
352 &General
::writehash
("$IDS::rules_settings_file", \
%cgiparams);
354 # Check if the the automatic rule update hass been touched.
355 if($cgiparams{'AUTOUPDATE_INTERVAL'} ne $oldsettings{'AUTOUPDATE_INTERVAL'}) {
356 # Call suricatactrl to set the new interval.
357 &IDS
::call_suricatactrl
("cron", $cgiparams{'AUTOUPDATE_INTERVAL'});
360 # Check if a ruleset is present - if not or the source has been changed download it.
361 if((! %idsrules) || ($oldsettings{'RULES'} ne $cgiparams{'RULES'})) {
362 # Check if the red device is active.
363 unless (-e
"${General::swroot}/red/active") {
364 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
367 # Check if enough free disk space is availabe.
368 if(&IDS
::checkdiskspace
()) {
369 $errormessage = "$Lang::tr{'not enough disk space'}";
372 # Check if any errors happend.
373 unless ($errormessage) {
374 # Lock the webpage and print notice about downloading
376 &working_notice
("$Lang::tr{'ids working'}");
378 # Write the modify sid's file and pass the taken ruleaction.
379 &IDS
::write_modify_sids_file
();
381 # Call subfunction to download the ruleset.
382 if(&IDS
::downloadruleset
()) {
383 $errormessage = $Lang::tr
{'could not download latest updates'};
385 # Call function to store the errormessage.
386 &IDS
::_store_error_message
($errormessage);
388 # Call subfunction to launch oinkmaster.
392 # Check if the IDS is running.
393 if(&IDS
::ids_is_running
()) {
394 # Call suricatactrl to stop the IDS - because of the changed
395 # ruleset - the use has to configure it before suricata can be
397 &IDS
::call_suricatactrl
("stop");
400 # Perform a reload of the page.
407 } elsif ($cgiparams{'RULESET'} eq $Lang::tr
{'ids apply'}) {
408 # Arrays to store which rulefiles have been enabled and will be used.
409 my @enabled_rulefiles;
411 # Hash to store the user-enabled and disabled sids.
412 my %enabled_disabled_sids;
414 # Store if a restart of suricata is required.
415 my $suricata_restart_required;
417 # Loop through the hash of idsrules.
418 foreach my $rulefile(keys %idsrules) {
419 # Check if the state of the rulefile has been changed.
420 unless ($cgiparams{$rulefile} eq $idsrules{$rulefile}{'Rulefile'}{'State'}) {
421 # A restart of suricata is required to apply the changes of the used rulefiles.
422 $suricata_restart_required = 1;
425 # Check if the rulefile is enabled.
426 if ($cgiparams{$rulefile} eq "on") {
427 # Add rulefile to the array of enabled rulefiles.
428 push(@enabled_rulefiles, $rulefile);
430 # Drop item from cgiparams hash.
431 delete $cgiparams{$rulefile};
435 # Read-in the files for enabled/disabled sids.
436 # This will be done by calling the read_enabled_disabled_sids_file function two times
437 # and merge the returned hashes together into the enabled_disabled_sids hash.
438 %enabled_disabled_sids = (
439 &read_enabled_disabled_sids_file
($IDS::disabled_sids_file
),
440 &read_enabled_disabled_sids_file
($IDS::enabled_sids_file
));
442 # Loop through the hash of idsrules.
443 foreach my $rulefile (keys %idsrules) {
444 # Loop through the single rules of the rulefile.
445 foreach my $sid (keys %{$idsrules{$rulefile}}) {
446 # Skip the current sid if it is not numeric.
447 next unless ($sid =~ /\d+/ );
449 # Check if there exists a key in the cgiparams hash for this sid.
450 if (exists($cgiparams{$sid})) {
451 # Look if the rule is disabled.
452 if ($idsrules{$rulefile}{$sid}{'State'} eq "off") {
453 # Check if the state has been set to 'on'.
454 if ($cgiparams{$sid} eq "on") {
455 # Add/Modify the sid to/in the enabled_disabled_sids hash.
456 $enabled_disabled_sids{$sid} = "enabled";
458 # Drop item from cgiparams hash.
459 delete $cgiparams{$rulefile}{$sid};
463 # Look if the rule is enabled.
464 if ($idsrules{$rulefile}{$sid}{'State'} eq "on") {
465 # Check if the state is 'on' and should be disabled.
466 # In this case there is no entry
467 # for the sid in the cgiparams hash.
468 # Add/Modify it to/in the enabled_disabled_sids hash.
469 $enabled_disabled_sids{$sid} = "disabled";
471 # Drop item from cgiparams hash.
472 delete $cgiparams{$rulefile}{$sid};
478 # Open enabled sid's file for writing.
479 open(ENABLED_FILE
, ">$IDS::enabled_sids_file") or die "Could not write to $IDS::enabled_sids_file. $!\n";
481 # Open disabled sid's file for writing.
482 open(DISABLED_FILE
, ">$IDS::disabled_sids_file") or die "Could not write to $IDS::disabled_sids_file. $!\n";
484 # Write header to the files.
485 print ENABLED_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
486 print DISABLED_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
488 # Check if the hash for enabled/disabled files contains any entries.
489 if (%enabled_disabled_sids) {
490 # Loop through the hash.
491 foreach my $sid (keys %enabled_disabled_sids) {
492 # Check if the sid is enabled.
493 if ($enabled_disabled_sids{$sid} eq "enabled") {
494 # Print the sid to the enabled_sids file.
495 print ENABLED_FILE
"enablesid $sid\n";
496 # Check if the sid is disabled.
497 } elsif ($enabled_disabled_sids{$sid} eq "disabled") {
498 # Print the sid to the disabled_sids file.
499 print DISABLED_FILE
"disablesid $sid\n";
500 # Something strange happende - skip the current sid.
507 # Close file for enabled_sids after writing.
510 # Close file for disabled_sids after writing.
511 close(DISABLED_FILE
);
513 # Call function to generate and write the used rulefiles file.
514 &IDS
::write_used_rulefiles_file
(@enabled_rulefiles);
516 # Lock the webpage and print message.
517 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
519 # Call oinkmaster to alter the ruleset.
522 # Check if the IDS is running.
523 if(&IDS
::ids_is_running
()) {
524 # Check if a restart of suricata is required.
525 if ($suricata_restart_required) {
526 # Call suricatactrl to perform the restart.
527 &IDS
::call_suricatactrl
("restart");
529 # Call suricatactrl to perform a reload.
530 &IDS
::call_suricatactrl
("reload");
537 # Download new ruleset.
538 } elsif ($cgiparams{'RULESET'} eq $Lang::tr
{'update ruleset'}) {
539 # Check if the red device is active.
540 unless (-e
"${General::swroot}/red/active") {
541 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
544 # Check if enought free disk space is availabe.
545 if(&IDS
::checkdiskspace
()) {
546 $errormessage = "$Lang::tr{'not enough disk space'}";
549 # Check if any errors happend.
550 unless ($errormessage) {
551 # Lock the webpage and print notice about downloading
553 &working_notice
("$Lang::tr{'ids download new ruleset'}");
555 # Call subfunction to download the ruleset.
556 if(&IDS
::downloadruleset
()) {
557 $errormessage = $Lang::tr
{'could not download latest updates'};
559 # Call function to store the errormessage.
560 &IDS
::_store_error_message
($errormessage);
562 # Preform a reload of the page.
565 # Call subfunction to launch oinkmaster.
568 # Check if the IDS is running.
569 if(&IDS
::ids_is_running
()) {
570 # Call suricatactrl to perform a reload.
571 &IDS
::call_suricatactrl
("reload");
574 # Perform a reload of the page.
579 } elsif ($cgiparams{'IDS'} eq $Lang::tr
{'save'}) {
582 my $monitored_zones = 0;
584 # Read-in current (old) IDS settings.
585 &General
::readhash
("$IDS::ids_settings_file", \
%oldidssettings);
587 # Prevent form name from been stored in conf file.
588 delete $cgiparams{'IDS'};
590 # Check if the IDS should be enabled.
591 if ($cgiparams{'ENABLE_IDS'} eq "on") {
592 # Check if any ruleset is available. Otherwise abort and display an error.
594 $errormessage = $Lang::tr
{'ids no ruleset available'};
597 # Loop through the array of available interfaces.
598 foreach my $zone (@network_zones) {
599 # Convert interface name into upper case.
600 my $zone_upper = uc($zone);
602 # Check if the IDS is enabled for this interaces.
603 if ($cgiparams{"ENABLE_IDS_$zone_upper"}) {
609 # Check if at least one zone should be monitored, or show an error.
610 unless ($monitored_zones >= 1) {
611 $errormessage = $Lang::tr
{'ids no network zone'};
615 # Go on if there are no error messages.
616 if (!$errormessage) {
617 # Store settings into settings file.
618 &General
::writehash
("$IDS::ids_settings_file", \
%cgiparams);
621 # Generate file to store the home net.
622 &IDS
::generate_home_net_file
();
624 # Generate file to the store the DNS servers.
625 &IDS
::generate_dns_servers_file
();
627 # Generate file to store the HTTP ports.
628 &IDS
::generate_http_ports_file
();
630 # Write the modify sid's file and pass the taken ruleaction.
631 &IDS
::write_modify_sids_file
();
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 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
672 &Header
::openbigbox
('100%', 'left', '', $errormessage);
674 &show_display_error_message
();
676 if ($cgiparams{'RULESET'} eq "$Lang::tr{'ids customize ruleset'}" ) {
677 &show_customize_ruleset
();
682 &Header
::closebigbox
();
683 &Header
::closepage
();
686 ## Tiny function to show if a error message happened.
688 sub show_display_error_message
() {
690 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
691 print "<class name='base'>$errormessage\n";
692 print " </class>\n";
698 ## Function to display the main IDS page.
700 sub show_mainpage
() {
701 # Read-in idssettings and rulesetsettings
702 &General
::readhash
("$IDS::ids_settings_file", \
%idssettings);
703 &General
::readhash
("$IDS::rules_settings_file", \
%rulessettings);
705 # If no autoupdate intervall has been configured yet, set default value.
706 unless(exists($rulessettings{'AUTOUPDATE_INTERVAL'})) {
707 # Set default to "weekly".
708 $rulessettings{'AUTOUPDATE_INTERVAL'} = 'weekly';
711 # Read-in ignored hosts.
712 &General
::readhasharray
("$IDS::settingsdir/ignored", \
%ignored);
714 $checked{'ENABLE_IDS'}{'off'} = '';
715 $checked{'ENABLE_IDS'}{'on'} = '';
716 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
717 $checked{'MONITOR_TRAFFIC_ONLY'}{'off'} = '';
718 $checked{'MONITOR_TRAFFIC_ONLY'}{'on'} = '';
719 $checked{'MONITOR_TRAFFIC_ONLY'}{$idssettings{'MONITOR_TRAFFIC_ONLY'}} = "checked='checked'";
720 $selected{'RULES'}{'nothing'} = '';
721 $selected{'RULES'}{$rulessettings{'RULES'}} = "selected='selected'";
722 $selected{'AUTOUPDATE_INTERVAL'}{'off'} = '';
723 $selected{'AUTOUPDATE_INTERVAL'}{'daily'} = '';
724 $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} = '';
725 $selected{'AUTOUPDATE_INTERVAL'}{$rulessettings{'AUTOUPDATE_INTERVAL'}} = "selected='selected'";
730 // Java Script function to show/hide the text input field for
731 // Oinkcode/Subscription code.
732 var update_code = function() {
733 if(\$('#RULES').val() == 'registered') {
735 } else if(\$('#RULES').val() == 'subscripted') {
737 } else if(\$('#RULES').val() == 'emerging_pro') {
744 // JQuery function to call corresponding function when
745 // the ruleset is changed or the page is loaded for showing/hiding
747 \$(document).ready(function() {
748 \$('#RULES').change(update_code);
755 # Draw current state of the IDS
756 &Header
::openbox
('100%', 'left', $Lang::tr
{'intrusion detection system'});
758 # Check if the IDS is running and obtain the process-id.
759 my $pid = &IDS
::ids_is_running
();
761 # Display some useful information, if suricata daemon is running.
763 # Gather used memory.
764 my $memory = &get_memory_usage
($pid);
767 <table width='95%' cellspacing='0' class='tbl'>
769 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
773 <td class='base'>$Lang::tr{'guardian daemon'}</td>
774 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
778 <td class='base'></td>
779 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
780 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
784 <td class='base'></td>
785 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
786 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
791 # Otherwise display a hint that the service is not launched.
793 <table width='95%' cellspacing='0' class='tbl'>
795 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
799 <td class='base'>$Lang::tr{'guardian daemon'}</td>
800 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
806 # Only show this area, if a ruleset is present.
811 <br><br><h2>$Lang::tr{'settings'}</h2>
813 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
814 <table width='100%' border='0'>
816 <td class='base' colspan='2'>
817 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}> $Lang::tr{'ids enable'}
820 <td class='base' colspan='2'>
821 <input type='checkbox' name='MONITOR_TRAFFIC_ONLY' $checked{'MONITOR_TRAFFIC_ONLY'}{'on'}> $Lang::tr{'ids monitor traffic only'}
833 <td colspan='4'><b>$Lang::tr{'ids monitored interfaces'}</b><br></td>
840 # Loop through the array of available networks and print config options.
841 foreach my $zone (@network_zones) {
845 # Convert current zone name to upper case.
846 my $zone_upper = uc($zone);
849 my $zone_name = $zone;
851 # Dirty hack to get the correct language string for the red zone.
852 if ($zone eq "red") {
856 # Grab checkbox status from settings hash.
857 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
858 $checked_input = "checked = 'checked'";
861 print "<td class='base' width='20%'>\n";
862 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>\n";
863 print " $Lang::tr{'enabled on'}<font color='$colourhash{$zone}'> $Lang::tr{$zone_name}</font>\n";
875 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
886 # Draw elements for ruleset configuration.
887 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ruleset settings'});
890 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
891 <table width='100%' border='0'>
893 <td><b>$Lang::tr{'ids rules update'}</b></td>
894 <td><b>$Lang::tr{'ids automatic rules update'}</b></td>
898 <td><select name='RULES' id='RULES'>
901 # Get all available ruleset providers.
902 my @ruleset_providers = &IDS
::get_ruleset_providers
();
904 # Loop throgh the list of providers.
905 foreach my $provider (@ruleset_providers) {
906 # Call get_provider_name function to obtain the provider name.
907 my $option_string = &get_provider_name
($provider);
910 print "<option value='$provider' $selected{'RULES'}{$provider}>$option_string</option>\n";
917 <select name='AUTOUPDATE_INTERVAL'>
918 <option value='off' $selected{'AUTOUPDATE_INTERVAL'}{'off'} >- $Lang::tr{'Disabled'} -</option>
919 <option value='daily' $selected{'AUTOUPDATE_INTERVAL'}{'daily'} >$Lang::tr{'Daily'}</option>
920 <option value='weekly' $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} >$Lang::tr{'Weekly'}</option>
926 <td colspan='2'><br><br></td>
929 <tr style='display:none' id='code'>
930 <td colspan='2'>Oinkcode: <input type='text' size='40' name='OINKCODE' value='$rulessettings{'OINKCODE'}'></td>
939 # Show the "Update Ruleset"-Button only if a ruleset has been downloaded yet and automatic updates are disabled.
940 if ((%idsrules) && ($rulessettings{'AUTOUPDATE_INTERVAL'} eq "off")) {
941 # Display button to update the ruleset.
942 print"<input type='submit' name='RULESET' value='$Lang::tr{'update ruleset'}'>\n";
945 <input type='submit' name='RULESET' value='$Lang::tr{'ids customize ruleset'}'>
946 <input type='submit' name='RULESET' value='$Lang::tr{'save'}'>
958 # Whitelist / Ignorelist
960 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ignored hosts'});
965 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
966 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
967 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
970 # Check if some hosts have been added to be ignored.
971 if (keys (%ignored)) {
974 # Loop through all entries of the hash.
975 while( (my $key) = each %ignored) {
976 # Assign data array positions to some nice variable names.
977 my $address = $ignored{$key}[0];
978 my $remark = $ignored{$key}[1];
979 my $status = $ignored{$key}[2];
981 # Check if the key (id) number is even or not.
982 if ($cgiparams{'ID'} eq $key) {
983 $col="bgcolor='${Header::colouryellow}'";
985 $col="bgcolor='$color{'color22'}'";
987 $col="bgcolor='$color{'color20'}'";
990 # Choose icon for the checkbox.
994 # Check if the status is enabled and select the correct image and description.
995 if ($status eq 'enabled' ) {
997 $gdesc = $Lang::tr
{'click to disable'};
1000 $gdesc = $Lang::tr
{'click to enable'};
1005 <td width='20%' class='base' $col>$address</td>
1006 <td width='65%' class='base' $col>$remark</td>
1008 <td align='center' $col>
1009 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1010 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}' />
1011 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc' />
1012 <input type='hidden' name='ID' value='$key' />
1016 <td align='center' $col>
1017 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1018 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}' />
1019 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}' />
1020 <input type='hidden' name='ID' value='$key' />
1024 <td align='center' $col>
1025 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
1026 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1027 <input type='hidden' name='ID' value='$key'>
1028 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
1035 # Print notice that currently no hosts are ignored.
1037 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1043 # Section to add new elements or edit existing ones.
1049 <div align='center'>
1050 <table width='100%'>
1053 # Assign correct headline and button text.
1058 # Check if an ID (key) has been given, in this case an existing entry should be edited.
1059 if ($cgiparams{'ID'} ne '') {
1060 $buttontext = $Lang::tr
{'update'};
1061 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
1063 # Grab address and remark for the given key.
1064 $entry_address = $ignored{$cgiparams{'ID'}}[0];
1065 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
1067 $buttontext = $Lang::tr
{'add'};
1068 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
1072 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1073 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1075 <td width='30%'>$Lang::tr{'ip address'}: </td>
1076 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
1078 <td width='30%'>$Lang::tr{'remark'}: </td>
1079 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
1080 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
1087 &Header
::closebox
();
1091 ## Function to show the customize ruleset section.
1093 sub show_customize_ruleset
() {
1097 # Java script variable declaration for show and hide.
1098 print"var show = \"$Lang::tr{'ids show'}\"\;\n";
1099 print"var hide = \"$Lang::tr{'ids hide'}\"\;\n";
1102 // Tiny java script function to show/hide the rules
1103 // of a given category.
1104 function showhide(tblname) {
1105 \$("#" + tblname).toggle();
1107 // Get current content of the span element.
1108 var content = document.getElementById("span_" + tblname);
1110 if (content.innerHTML === show) {
1111 content.innerHTML = hide;
1113 content.innerHTML = show;
1119 # Load neccessary perl modules for file stat and to format the timestamp.
1121 use POSIX
qw( strftime );
1123 # Call stat on the rulestarball.
1124 my $stat = stat("$IDS::rulestarball");
1126 if (defined $stat) {
1127 # Get timestamp the file creation.
1128 my $mtime = $stat->mtime;
1130 # Convert into human read-able format.
1131 my $rulesdate = strftime
('%Y-%m-%d %H:%M:%S', localtime($mtime));
1133 &Header
::openbox
('100%', 'LEFT', "$Lang::tr{'intrusion detection system rules'} ($rulesdate)" );
1135 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
1137 # Output display table for rule files
1138 print "<table width='100%'>\n";
1140 # Loop over each rule file
1141 foreach my $rulefile (sort keys(%idsrules)) {
1142 my $rulechecked = '';
1144 # Check if rule file is enabled
1145 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
1146 $rulechecked = 'CHECKED';
1149 # Convert rulefile name into category name.
1150 my $categoryname = &_rulefile_to_category
($rulefile);
1152 # Table and rows for the rule files.
1154 print"<td class='base' width='5%'>\n";
1155 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
1157 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
1158 print"<td class='base' width='5%' align='right'>\n";
1159 print"<a href=\"javascript:showhide('$categoryname')\"><span id='span_$categoryname'>$Lang::tr{'ids show'}</span></a>\n";
1163 # Rows which will be hidden per default and will contain the single rules.
1164 print"<tr style='display:none' id='$categoryname'>\n";
1165 print"<td colspan='3'>\n";
1172 # New table for the single rules.
1173 print "<table width='100%'>\n";
1175 # Loop over rule file rules
1176 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
1178 my $ruledefchecked = '';
1180 # Skip rulefile itself.
1181 next if ($sid eq "Rulefile");
1183 # If 2 rules have been displayed, start a new row
1184 if (($lines % 2) == 0) {
1185 print "</tr><tr>\n";
1187 # Increase rows by once.
1193 $col="bgcolor='$color{'color20'}'";
1195 $col="bgcolor='$color{'color22'}'";
1199 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
1200 $ruledefchecked = 'CHECKED';
1203 # Create rule checkbox and display rule description
1204 print "<td class='base' width='5%' align='right' $col>\n";
1205 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
1207 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1209 # Increment rule count
1213 # If do not have a second rule for row, create empty cell
1214 if (($lines % 2) != 0) {
1215 print "<td class='base'></td>";
1218 # Close display table
1219 print "</tr></table></td></tr>";
1222 # Close display table
1226 <table width='100%'>
1228 <td width='100%' align='right'><input type='submit' name='RULESET' value='$Lang::tr{'ids apply'}'></td>
1234 &Header
::closebox
();
1239 ## A function to display a notice, to lock the webpage and
1240 ## tell the user which action currently will be performed.
1242 sub working_notice
($) {
1245 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
1246 &Header
::openbigbox
('100%', 'left', '', $errormessage);
1247 &Header
::openbox
( 'Waiting', 1,);
1251 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
1256 &Header
::closebox
();
1257 &Header
::closebigbox
();
1258 &Header
::closepage
();
1262 ## A tiny function to perform a reload of the webpage after one second.
1265 print "<meta http-equiv='refresh' content='1'>\n";
1272 ## Private function to read-in and parse rules of a given rulefile.
1274 ## The given file will be read, parsed and all valid rules will be stored by ID,
1275 ## message/description and it's state in the idsrules hash.
1277 sub readrulesfile
($) {
1278 my $rulefile = shift;
1280 # Open rule file and read in contents
1281 open(RULEFILE
, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
1283 # Store file content in an array.
1284 my @lines = <RULEFILE
>;
1289 # Loop over rule file contents
1290 foreach my $line (@lines) {
1291 # Remove whitespaces.
1295 next if ($line =~ /^\s*$/);
1301 # Gather rule sid and message from the ruleline.
1302 if ($line =~ m/.*msg:\"(.*?)\"\; .* sid:(.*?); /) {
1306 # Check if a rule has been found.
1308 # Add rule to the idsrules hash.
1309 $idsrules{$rulefile}{$sid}{'Description'} = $msg;
1311 # Grab status of the rule. Check if ruleline starts with a "dash".
1312 if ($line =~ /^\#/) {
1313 # If yes, the rule is disabled.
1314 $idsrules{$rulefile}{$sid}{'State'} = "off";
1316 # Otherwise the rule is enabled.
1317 $idsrules{$rulefile}{$sid}{'State'} = "on";
1325 ## Function to get the used memory of a given process-id.
1327 sub get_memory_usage
($) {
1332 # Try to open the status file for the given process-id on the pseudo
1334 if (open(FILE
, "/proc/$pid/status")) {
1335 # Loop through the entire file.
1337 # Splitt current line content and store them into variables.
1338 my ($key, $value) = split(":", $_, 2);
1340 # Check if the current key is the one which contains the memory usage.
1341 # The wanted one is VmRSS which contains the Real-memory (resident set)
1342 # of the entire process.
1343 if ($key eq "VmRSS") {
1344 # Found the memory usage add it to the memory variable.
1352 # Close file handle.
1355 # Return memory usage.
1359 # If the file could not be open, return nothing.
1364 ## Function to read-in the given enabled or disables sids file.
1366 sub read_enabled_disabled_sids_file
($) {
1369 # Temporary hash to store the sids and their state. It will be
1370 # returned at the end of this function.
1373 # Open the given filename.
1374 open(FILE
, "$file") or die "Could not open $file. $!\n";
1376 # Loop through the file.
1382 next if ($_ =~ /^\s*$/);
1385 next if ($_ =~ /^\#/);
1387 # Splitt line into sid and state part.
1388 my ($state, $sid) = split(" ", $_);
1390 # Skip line if the sid is not numeric.
1391 next unless ($sid =~ /\d+/ );
1393 # Check if the sid was enabled.
1394 if ($state eq "enablesid") {
1395 # Add the sid and its state as enabled to the temporary hash.
1396 $temphash{$sid} = "enabled";
1397 # Check if the sid was disabled.
1398 } elsif ($state eq "disablesid") {
1399 # Add the sid and its state as disabled to the temporary hash.
1400 $temphash{$sid} = "disabled";
1401 # Invalid state - skip the current sid and state.
1415 ## Function to get the provider name from the language file or providers file for a given handle.
1417 sub get_provider_name
($) {
1421 # Get the required translation string for the given provider handle.
1422 my $tr_string = $IDS::Ruleset
::Providers
{$handle}{'tr_string'};
1424 # Check if the translation string is available in the language files.
1425 if ($Lang::tr
{$tr_string}) {
1426 # Use the translated string from the language file.
1427 $provider_name = $Lang::tr
{$tr_string};
1429 # Fallback and use the provider summary from the providers file.
1430 $provider_name = $IDS::Ruleset
::Providers
{$handle}{'summary'};
1433 # Return the obtained provider name.
1434 return $provider_name;
1438 ## Private function to convert a given rulefile to a category name.
1439 ## ( No file extension anymore and if the name contained a dot, it
1440 ## would be replaced by a underline sign.)
1442 sub _rulefile_to_category
($) {
1443 my ($filename) = @_;
1445 # Splitt the filename into single chunks and store them in a
1447 my @parts = split(/\./, $filename);
1449 # Return / Remove last element of the temporary array.
1450 # This removes the file extension.
1453 # Join together the single elements of the temporary array.
1454 # If these are more than one, use a "underline" for joining.
1455 my $category = join '_', @parts;
1457 # Return the converted filename.