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 # Write the modify sid's file and pass the taken ruleaction.
374 &IDS
::write_modify_sids_file
();
376 # Call subfunction to download the ruleset.
377 if(&IDS
::downloadruleset
()) {
378 $errormessage = $Lang::tr
{'could not download latest updates'};
380 # Call function to store the errormessage.
381 &IDS
::_store_error_message
($errormessage);
383 # Call subfunction to launch oinkmaster.
387 # Check if the IDS is running.
388 if(&IDS
::ids_is_running
()) {
389 # Call suricatactrl to stop the IDS - because of the changed
390 # ruleset - the use has to configure it before suricata can be
392 &IDS
::call_suricatactrl
("stop");
395 # Perform a reload of the page.
402 } elsif ($cgiparams{'RULESET'} eq $Lang::tr
{'ids apply'}) {
403 # Arrays to store which rulefiles have been enabled and will be used.
404 my @enabled_rulefiles;
406 # Hash to store the user-enabled and disabled sids.
407 my %enabled_disabled_sids;
409 # Loop through the hash of idsrules.
410 foreach my $rulefile(keys %idsrules) {
411 # Check if the rulefile is enabled.
412 if ($cgiparams{$rulefile} eq "on") {
413 # Add rulefile to the array of enabled rulefiles.
414 push(@enabled_rulefiles, $rulefile);
416 # Drop item from cgiparams hash.
417 delete $cgiparams{$rulefile};
421 # Read-in the files for enabled/disabled sids.
422 # This will be done by calling the read_enabled_disabled_sids_file function two times
423 # and merge the returned hashes together into the enabled_disabled_sids hash.
424 %enabled_disabled_sids = (
425 &read_enabled_disabled_sids_file
($IDS::disabled_sids_file
),
426 &read_enabled_disabled_sids_file
($IDS::enabled_sids_file
));
428 # Loop through the hash of idsrules.
429 foreach my $rulefile (keys %idsrules) {
430 # Loop through the single rules of the rulefile.
431 foreach my $sid (keys %{$idsrules{$rulefile}}) {
432 # Skip the current sid if it is not numeric.
433 next unless ($sid =~ /\d+/ );
435 # Check if there exists a key in the cgiparams hash for this sid.
436 if (exists($cgiparams{$sid})) {
437 # Look if the rule is disabled.
438 if ($idsrules{$rulefile}{$sid}{'State'} eq "off") {
439 # Check if the state has been set to 'on'.
440 if ($cgiparams{$sid} eq "on") {
441 # Add/Modify the sid to/in the enabled_disabled_sids hash.
442 $enabled_disabled_sids{$sid} = "enabled";
444 # Drop item from cgiparams hash.
445 delete $cgiparams{$rulefile}{$sid};
449 # Look if the rule is enabled.
450 if ($idsrules{$rulefile}{$sid}{'State'} eq "on") {
451 # Check if the state is 'on' and should be disabled.
452 # In this case there is no entry
453 # for the sid in the cgiparams hash.
454 # Add/Modify it to/in the enabled_disabled_sids hash.
455 $enabled_disabled_sids{$sid} = "disabled";
457 # Drop item from cgiparams hash.
458 delete $cgiparams{$rulefile}{$sid};
464 # Open enabled sid's file for writing.
465 open(ENABLED_FILE
, ">$IDS::enabled_sids_file") or die "Could not write to $IDS::enabled_sids_file. $!\n";
467 # Open disabled sid's file for writing.
468 open(DISABLED_FILE
, ">$IDS::disabled_sids_file") or die "Could not write to $IDS::disabled_sids_file. $!\n";
470 # Write header to the files.
471 print ENABLED_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
472 print DISABLED_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
474 # Check if the hash for enabled/disabled files contains any entries.
475 if (%enabled_disabled_sids) {
476 # Loop through the hash.
477 foreach my $sid (keys %enabled_disabled_sids) {
478 # Check if the sid is enabled.
479 if ($enabled_disabled_sids{$sid} eq "enabled") {
480 # Print the sid to the enabled_sids file.
481 print ENABLED_FILE
"enablesid $sid\n";
482 # Check if the sid is disabled.
483 } elsif ($enabled_disabled_sids{$sid} eq "disabled") {
484 # Print the sid to the disabled_sids file.
485 print DISABLED_FILE
"disablesid $sid\n";
486 # Something strange happende - skip the current sid.
493 # Close file for enabled_sids after writing.
496 # Close file for disabled_sids after writing.
497 close(DISABLED_FILE
);
499 # Call function to generate and write the used rulefiles file.
500 &IDS
::write_used_rulefiles_file
(@enabled_rulefiles);
502 # Lock the webpage and print message.
503 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
505 # Call oinkmaster to alter the ruleset.
508 # Check if the IDS is running.
509 if(&IDS
::ids_is_running
()) {
510 # Call suricatactrl to perform a reload.
511 &IDS
::call_suricatactrl
("reload");
517 # Download new ruleset.
518 } elsif ($cgiparams{'RULESET'} eq $Lang::tr
{'update ruleset'}) {
519 # Check if the red device is active.
520 unless (-e
"${General::swroot}/red/active") {
521 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
524 # Check if enought free disk space is availabe.
525 if(&IDS
::checkdiskspace
()) {
526 $errormessage = "$Lang::tr{'not enough disk space'}";
529 # Check if any errors happend.
530 unless ($errormessage) {
531 # Lock the webpage and print notice about downloading
533 &working_notice
("$Lang::tr{'ids download new ruleset'}");
535 # Call subfunction to download the ruleset.
536 if(&IDS
::downloadruleset
()) {
537 $errormessage = $Lang::tr
{'could not download latest updates'};
539 # Call function to store the errormessage.
540 &IDS
::_store_error_message
($errormessage);
542 # Preform a reload of the page.
545 # Call subfunction to launch oinkmaster.
548 # Check if the IDS is running.
549 if(&IDS
::ids_is_running
()) {
550 # Call suricatactrl to perform a reload.
551 &IDS
::call_suricatactrl
("reload");
554 # Perform a reload of the page.
559 } elsif ($cgiparams{'IDS'} eq $Lang::tr
{'save'}) {
562 my $monitored_zones = 0;
564 # Read-in current (old) IDS settings.
565 &General
::readhash
("$IDS::ids_settings_file", \
%oldidssettings);
567 # Prevent form name from been stored in conf file.
568 delete $cgiparams{'IDS'};
570 # Check if the IDS should be enabled.
571 if ($cgiparams{'ENABLE_IDS'} eq "on") {
572 # Check if any ruleset is available. Otherwise abort and display an error.
574 $errormessage = $Lang::tr
{'ids no ruleset available'};
577 # Loop through the array of available interfaces.
578 foreach my $zone (@network_zones) {
579 # Convert interface name into upper case.
580 my $zone_upper = uc($zone);
582 # Check if the IDS is enabled for this interaces.
583 if ($cgiparams{"ENABLE_IDS_$zone_upper"}) {
589 # Check if at least one zone should be monitored, or show an error.
590 unless ($monitored_zones >= 1) {
591 $errormessage = $Lang::tr
{'ids no network zone'};
595 # Go on if there are no error messages.
596 if (!$errormessage) {
597 # Store settings into settings file.
598 &General
::writehash
("$IDS::ids_settings_file", \
%cgiparams);
601 # Generate file to store the home net.
602 &IDS
::generate_home_net_file
();
604 # Write the modify sid's file and pass the taken ruleaction.
605 &IDS
::write_modify_sids_file
();
607 # Check if "MONITOR_TRAFFIC_ONLY" has been changed.
608 if($cgiparams{'MONITOR_TRAFFIC_ONLY'} ne $oldidssettings{'MONITOR_TRAFFIC_ONLY'}) {
609 # Check if a ruleset exists.
611 # Lock the webpage and print message.
612 &working_notice
("$Lang::tr{'ids working'}");
614 # Call oinkmaster to alter the ruleset.
617 # Set reload_page to "True".
622 # Check if the IDS currently is running.
623 if(&IDS
::ids_is_running
()) {
624 # Check if ENABLE_IDS is set to on.
625 if($cgiparams{'ENABLE_IDS'} eq "on") {
626 # Call suricatactrl to perform a reload of suricata.
627 &IDS
::call_suricatactrl
("reload");
629 # Call suricatactrl to stop suricata.
630 &IDS
::call_suricatactrl
("stop");
633 # Call suricatactrl to start suricata.
634 &IDS
::call_suricatactrl
("start");
637 # Check if the page should be reloaded.
639 # Perform a reload of the page.
644 # Read-in idssettings and rulesetsettings
645 &General
::readhash
("$IDS::ids_settings_file", \
%idssettings);
646 &General
::readhash
("$IDS::rules_settings_file", \
%rulessettings);
648 # If no autoupdate intervall has been configured yet, set default value.
649 unless(exists($rulessettings{'AUTOUPDATE_INTERVAL'})) {
650 # Set default to "weekly".
651 $rulessettings{'AUTOUPDATE_INTERVAL'} = 'weekly';
654 # Read-in ignored hosts.
655 &General
::readhasharray
("$IDS::settingsdir/ignored", \
%ignored);
657 $checked{'ENABLE_IDS'}{'off'} = '';
658 $checked{'ENABLE_IDS'}{'on'} = '';
659 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
660 $checked{'MONITOR_TRAFFIC_ONLY'}{'off'} = '';
661 $checked{'MONITOR_TRAFFIC_ONLY'}{'on'} = '';
662 $checked{'MONITOR_TRAFFIC_ONLY'}{$idssettings{'MONITOR_TRAFFIC_ONLY'}} = "checked='checked'";
663 $selected{'RULES'}{'nothing'} = '';
664 $selected{'RULES'}{'community'} = '';
665 $selected{'RULES'}{'emerging'} = '';
666 $selected{'RULES'}{'registered'} = '';
667 $selected{'RULES'}{'subscripted'} = '';
668 $selected{'RULES'}{$rulessettings{'RULES'}} = "selected='selected'";
669 $selected{'AUTOUPDATE_INTERVAL'}{'off'} = '';
670 $selected{'AUTOUPDATE_INTERVAL'}{'daily'} = '';
671 $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} = '';
672 $selected{'AUTOUPDATE_INTERVAL'}{$rulessettings{'AUTOUPDATE_INTERVAL'}} = "selected='selected'";
674 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
679 # Java script variable declaration for show and hide.
680 print"var show = \"$Lang::tr{'ids show'}\"\;\n";
681 print"var hide = \"$Lang::tr{'ids hide'}\"\;\n";
684 // Java Script function to show/hide the text input field for
685 // Oinkcode/Subscription code.
686 var update_code = function() {
687 if(\$('#RULES').val() == 'registered') {
689 } else if(\$('#RULES').val() == 'subscripted') {
691 } else if(\$('#RULES').val() == 'emerging_pro') {
698 // JQuery function to call corresponding function when
699 // the ruleset is changed or the page is loaded for showing/hiding
701 \$(document).ready(function() {
702 \$('#RULES').change(update_code);
706 // Tiny java script function to show/hide the rules
707 // of a given category.
708 function showhide(tblname) {
709 \$("#" + tblname).toggle();
711 // Get current content of the span element.
712 var content = document.getElementById("span_" + tblname);
714 if (content.innerHTML === show) {
715 content.innerHTML = hide;
717 content.innerHTML = show;
724 &Header
::openbigbox
('100%', 'left', '', $errormessage);
727 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
728 print "<class name='base'>$errormessage\n";
729 print " </class>\n";
733 # Draw current state of the IDS
734 &Header
::openbox
('100%', 'left', $Lang::tr
{'intrusion detection system'});
736 # Check if the IDS is running and obtain the process-id.
737 my $pid = &IDS
::ids_is_running
();
739 # Display some useful information, if suricata daemon is running.
741 # Gather used memory.
742 my $memory = &get_memory_usage
($pid);
745 <table width='95%' cellspacing='0' class='tbl'>
747 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
751 <td class='base'>$Lang::tr{'guardian daemon'}</td>
752 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
756 <td class='base'></td>
757 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
758 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
762 <td class='base'></td>
763 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
764 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
769 # Otherwise display a hint that the service is not launched.
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' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
784 # Only show this area, if a ruleset is present.
789 <br><br><h2>$Lang::tr{'settings'}</h2>
791 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
792 <table width='100%' border='0'>
794 <td class='base' colspan='2'>
795 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}> $Lang::tr{'ids enable'}
798 <td class='base' colspan='2'>
799 <input type='checkbox' name='MONITOR_TRAFFIC_ONLY' $checked{'MONITOR_TRAFFIC_ONLY'}{'on'}> $Lang::tr{'ids monitor traffic only'}
811 <td colspan='4'><b>$Lang::tr{'ids monitored interfaces'}</b><br></td>
818 # Loop through the array of available networks and print config options.
819 foreach my $zone (@network_zones) {
823 # Convert current zone name to upper case.
824 my $zone_upper = uc($zone);
827 my $zone_name = $zone;
829 # Dirty hack to get the correct language string for the red zone.
830 if ($zone eq "red") {
834 # Grab checkbox status from settings hash.
835 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
836 $checked_input = "checked = 'checked'";
839 print "<td class='base' width='25%'>\n";
840 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>\n";
841 print " $Lang::tr{'enabled on'}<font color='$colourhash{$zone}'> $Lang::tr{$zone_name}</font>\n";
853 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
864 # Draw elements for ruleset configuration.
865 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ruleset settings'});
868 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
869 <table width='100%' border='0'>
871 <td><b>$Lang::tr{'ids rules update'}</b></td>
872 <td><b>$Lang::tr{'ids automatic rules update'}</b></td>
876 <td><select name='RULES' id='RULES'>
877 <option value='emerging' $selected{'RULES'}{'emerging'} >$Lang::tr{'emerging rules'}</option>
878 <option value='emerging_pro' $selected{'RULES'}{'emerging_pro'} >$Lang::tr{'emerging pro rules'}</option>
879 <option value='community' $selected{'RULES'}{'community'} >$Lang::tr{'community rules'}</option>
880 <option value='registered' $selected{'RULES'}{'registered'} >$Lang::tr{'registered user rules'}</option>
881 <option value='subscripted' $selected{'RULES'}{'subscripted'} >$Lang::tr{'subscripted user rules'}</option>
886 <select name='AUTOUPDATE_INTERVAL'>
887 <option value='off' $selected{'AUTOUPDATE_INTERVAL'}{'off'} >- $Lang::tr{'Disabled'} -</option>
888 <option value='daily' $selected{'AUTOUPDATE_INTERVAL'}{'daily'} >$Lang::tr{'Daily'}</option>
889 <option value='weekly' $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} >$Lang::tr{'Weekly'}</option>
895 <td colspan='2'><br><br></td>
898 <tr style='display:none' id='code'>
899 <td colspan='2'>Oinkcode: <input type='text' size='40' name='OINKCODE' value='$rulessettings{'OINKCODE'}'></td>
908 # Show the "Update Ruleset"-Button only if a ruleset has been downloaded yet and automatic updates are disabled.
909 if ((%idsrules) && ($rulessettings{'AUTOUPDATE_INTERVAL'} eq "off")) {
910 # Display button to update the ruleset.
911 print"<input type='submit' name='RULESET' value='$Lang::tr{'update ruleset'}'>\n";
914 <input type='submit' name='RULESET' value='$Lang::tr{'save'}'>
926 # Whitelist / Ignorelist
928 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ignored hosts'});
933 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
934 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
935 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
938 # Check if some hosts have been added to be ignored.
939 if (keys (%ignored)) {
942 # Loop through all entries of the hash.
943 while( (my $key) = each %ignored) {
944 # Assign data array positions to some nice variable names.
945 my $address = $ignored{$key}[0];
946 my $remark = $ignored{$key}[1];
947 my $status = $ignored{$key}[2];
949 # Check if the key (id) number is even or not.
950 if ($cgiparams{'ID'} eq $key) {
951 $col="bgcolor='${Header::colouryellow}'";
953 $col="bgcolor='$color{'color22'}'";
955 $col="bgcolor='$color{'color20'}'";
958 # Choose icon for the checkbox.
962 # Check if the status is enabled and select the correct image and description.
963 if ($status eq 'enabled' ) {
965 $gdesc = $Lang::tr
{'click to disable'};
968 $gdesc = $Lang::tr
{'click to enable'};
973 <td width='20%' class='base' $col>$address</td>
974 <td width='65%' class='base' $col>$remark</td>
976 <td align='center' $col>
977 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
978 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}' />
979 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc' />
980 <input type='hidden' name='ID' value='$key' />
984 <td align='center' $col>
985 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
986 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}' />
987 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}' />
988 <input type='hidden' name='ID' value='$key' />
992 <td align='center' $col>
993 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
994 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
995 <input type='hidden' name='ID' value='$key'>
996 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
1003 # Print notice that currently no hosts are ignored.
1005 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1011 # Section to add new elements or edit existing ones.
1017 <div align='center'>
1018 <table width='100%'>
1021 # Assign correct headline and button text.
1026 # Check if an ID (key) has been given, in this case an existing entry should be edited.
1027 if ($cgiparams{'ID'} ne '') {
1028 $buttontext = $Lang::tr
{'update'};
1029 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
1031 # Grab address and remark for the given key.
1032 $entry_address = $ignored{$cgiparams{'ID'}}[0];
1033 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
1035 $buttontext = $Lang::tr
{'add'};
1036 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
1040 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1041 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1043 <td width='30%'>$Lang::tr{'ip address'}: </td>
1044 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
1046 <td width='30%'>$Lang::tr{'remark'}: </td>
1047 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
1048 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
1055 &Header
::closebox
();
1057 # Only show the section for configuring the ruleset if one is present.
1059 # Load neccessary perl modules for file stat and to format the timestamp.
1061 use POSIX
qw( strftime );
1063 # Call stat on the rulestarball.
1064 my $stat = stat("$IDS::rulestarball");
1066 # Get timestamp the file creation.
1067 my $mtime = $stat->mtime;
1069 # Convert into human read-able format.
1070 my $rulesdate = strftime
('%Y-%m-%d %H:%M:%S', localtime($mtime));
1072 &Header
::openbox
('100%', 'LEFT', "$Lang::tr{'intrusion detection system rules'} ($rulesdate)" );
1074 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
1076 # Output display table for rule files
1077 print "<table width='100%'>\n";
1079 # Loop over each rule file
1080 foreach my $rulefile (sort keys(%idsrules)) {
1081 my $rulechecked = '';
1083 # Check if rule file is enabled
1084 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
1085 $rulechecked = 'CHECKED';
1088 # Convert rulefile name into category name.
1089 my $categoryname = &_rulefile_to_category
($rulefile);
1091 # Table and rows for the rule files.
1093 print"<td class='base' width='5%'>\n";
1094 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
1096 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
1097 print"<td class='base' width='5%' align='right'>\n";
1098 print"<a href=\"javascript:showhide('$categoryname')\"><span id='span_$categoryname'>$Lang::tr{'ids show'}</span></a>\n";
1102 # Rows which will be hidden per default and will contain the single rules.
1103 print"<tr style='display:none' id='$categoryname'>\n";
1104 print"<td colspan='3'>\n";
1111 # New table for the single rules.
1112 print "<table width='100%'>\n";
1114 # Loop over rule file rules
1115 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
1117 my $ruledefchecked = '';
1119 # Skip rulefile itself.
1120 next if ($sid eq "Rulefile");
1122 # If 2 rules have been displayed, start a new row
1123 if (($lines % 2) == 0) {
1124 print "</tr><tr>\n";
1126 # Increase rows by once.
1132 $col="bgcolor='$color{'color20'}'";
1134 $col="bgcolor='$color{'color22'}'";
1138 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
1139 $ruledefchecked = 'CHECKED';
1142 # Create rule checkbox and display rule description
1143 print "<td class='base' width='5%' align='right' $col>\n";
1144 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
1146 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1148 # Increment rule count
1152 # If do not have a second rule for row, create empty cell
1153 if (($lines % 2) != 0) {
1154 print "<td class='base'></td>";
1157 # Close display table
1158 print "</tr></table></td></tr>";
1161 # Close display table
1165 <table width='100%'>
1167 <td width='100%' align='right'><input type='submit' name='RULESET' value='$Lang::tr{'ids apply'}'></td>
1173 &Header
::closebox
();
1176 &Header
::closebigbox
();
1177 &Header
::closepage
();
1180 ## A function to display a notice, to lock the webpage and
1181 ## tell the user which action currently will be performed.
1183 sub working_notice
($) {
1186 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
1187 &Header
::openbigbox
('100%', 'left', '', $errormessage);
1188 &Header
::openbox
( 'Waiting', 1,);
1192 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
1197 &Header
::closebox
();
1198 &Header
::closebigbox
();
1199 &Header
::closepage
();
1203 ## A tiny function to perform a reload of the webpage after one second.
1206 print "<meta http-equiv='refresh' content='1'>\n";
1213 ## Private function to read-in and parse rules of a given rulefile.
1215 ## The given file will be read, parsed and all valid rules will be stored by ID,
1216 ## message/description and it's state in the idsrules hash.
1218 sub readrulesfile
($) {
1219 my $rulefile = shift;
1221 # Open rule file and read in contents
1222 open(RULEFILE
, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
1224 # Store file content in an array.
1225 my @lines = <RULEFILE
>;
1230 # Loop over rule file contents
1231 foreach my $line (@lines) {
1232 # Remove whitespaces.
1236 next if ($line =~ /^\s*$/);
1242 # Gather rule sid and message from the ruleline.
1243 if ($line =~ m/.*msg:\"(.*?)\"\; .* sid:(.*?); /) {
1247 # Check if a rule has been found.
1249 # Add rule to the idsrules hash.
1250 $idsrules{$rulefile}{$sid}{'Description'} = $msg;
1252 # Grab status of the rule. Check if ruleline starts with a "dash".
1253 if ($line =~ /^\#/) {
1254 # If yes, the rule is disabled.
1255 $idsrules{$rulefile}{$sid}{'State'} = "off";
1257 # Otherwise the rule is enabled.
1258 $idsrules{$rulefile}{$sid}{'State'} = "on";
1266 ## Function to get the used memory of a given process-id.
1268 sub get_memory_usage
($) {
1273 # Try to open the status file for the given process-id on the pseudo
1275 if (open(FILE
, "/proc/$pid/status")) {
1276 # Loop through the entire file.
1278 # Splitt current line content and store them into variables.
1279 my ($key, $value) = split(":", $_, 2);
1281 # Check if the current key is the one which contains the memory usage.
1282 # The wanted one is VmRSS which contains the Real-memory (resident set)
1283 # of the entire process.
1284 if ($key eq "VmRSS") {
1285 # Found the memory usage add it to the memory variable.
1293 # Close file handle.
1296 # Return memory usage.
1300 # If the file could not be open, return nothing.
1305 ## Function to read-in the given enabled or disables sids file.
1307 sub read_enabled_disabled_sids_file
($) {
1310 # Temporary hash to store the sids and their state. It will be
1311 # returned at the end of this function.
1314 # Open the given filename.
1315 open(FILE
, "$file") or die "Could not open $file. $!\n";
1317 # Loop through the file.
1323 next if ($_ =~ /^\s*$/);
1326 next if ($_ =~ /^\#/);
1328 # Splitt line into sid and state part.
1329 my ($state, $sid) = split(" ", $_);
1331 # Skip line if the sid is not numeric.
1332 next unless ($sid =~ /\d+/ );
1334 # Check if the sid was enabled.
1335 if ($state eq "enablesid") {
1336 # Add the sid and its state as enabled to the temporary hash.
1337 $temphash{$sid} = "enabled";
1338 # Check if the sid was disabled.
1339 } elsif ($state eq "disablesid") {
1340 # Add the sid and its state as disabled to the temporary hash.
1341 $temphash{$sid} = "disabled";
1342 # Invalid state - skip the current sid and state.
1356 ## Private function to convert a given rulefile to a category name.
1357 ## ( No file extension anymore and if the name contained a dot, it
1358 ## would be replaced by a underline sign.)
1360 sub _rulefile_to_category
($) {
1361 my ($filename) = @_;
1363 # Splitt the filename into single chunks and store them in a
1365 my @parts = split(/\./, $filename);
1367 # Return / Remove last element of the temporary array.
1368 # This removes the file extension.
1371 # Join together the single elements of the temporary array.
1372 # If these are more than one, use a "underline" for joining.
1373 my $category = join '_', @parts;
1375 # Return the converted filename.