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 = ();
37 my %rulesetsources = ();
43 # Read-in main settings, for language, theme and colors.
44 &General
::readhash
("${General::swroot}/main/settings", \
%mainsettings);
45 &General
::readhash
("/srv/web/ipfire/html/themes/".$mainsettings{'THEME'}."/include/colors.txt", \
%color);
47 # Get the available network zones, based on the config type of the system and store
48 # the list of zones in an array.
49 my @network_zones = &IDS
::get_available_network_zones
();
51 # File where the used rulefiles are stored.
52 my $idsusedrulefilesfile = "$IDS::settingsdir/suricata-used-rulefiles.yaml";
54 # File where the addresses of the homenet are stored.
55 my $idshomenetfile = "$IDS::settingsdir/suricata-homenet.yaml";
57 # File which contains the enabled sids.
58 my $enabled_sids_file = "$IDS::settingsdir/oinkmaster-enabled-sids.conf";
60 # File which contains the disabled sids.
61 my $disabled_sids_file = "$IDS::settingsdir/oinkmaster-disabled-sids.conf";
63 # File which contains wheater the rules should be changed.
64 my $modify_sids_file = "$IDS::settingsdir/oinkmaster-modify-sids.conf";
66 # File which stores the configured settings for whitelisted addresses.
67 my $ignoredfile = "$IDS::settingsdir/ignored";
69 # File which contains the rules to whitelist addresses on suricata.
70 my $whitelistfile = "$IDS::rulespath/whitelist.rules";
74 # Create files if they does not exist yet.
75 unless (-f
"$enabled_sids_file") { &IDS
::create_empty_file
($enabled_sids_file); }
76 unless (-f
"$disabled_sids_file") { &IDS
::create_empty_file
($disabled_sids_file); }
77 unless (-f
"$modify_sids_file") { &IDS
::create_empty_file
($modify_sids_file); }
78 unless (-f
"$idsusedrulefilesfile") { &IDS
::create_empty_file
($idsusedrulefilesfile); }
79 unless (-f
"$ignoredfile") { &IDS
::create_empty_file
($ignoredfile); }
80 unless (-f
"$whitelistfile" ) { &IDS
::create_empty_file
($whitelistfile); }
82 &Header
::showhttpheaders
();
85 &Header
::getcgihash
(\
%cgiparams);
87 ## Add/edit an entry to the ignore file.
89 if (($cgiparams{'WHITELIST'} eq $Lang::tr
{'add'}) || ($cgiparams{'WHITELIST'} eq $Lang::tr
{'update'})) {
91 # Check if any input has been performed.
92 if ($cgiparams{'IGNORE_ENTRY_ADDRESS'} ne '') {
94 # Check if the given input is no valid IP-address or IP-address with subnet, display an error message.
95 if ((!&General
::validip
($cgiparams{'IGNORE_ENTRY_ADDRESS'})) && (!&General
::validipandmask
($cgiparams{'IGNORE_ENTRY_ADDRESS'}))) {
96 $errormessage = "$Lang::tr{'guardian invalid address or subnet'}";
99 $errormessage = "$Lang::tr{'guardian empty input'}";
102 # Go further if there was no error.
103 if ($errormessage eq '') {
108 # Assign hash values.
109 my $new_entry_address = $cgiparams{'IGNORE_ENTRY_ADDRESS'};
110 my $new_entry_remark = $cgiparams{'IGNORE_ENTRY_REMARK'};
112 # Read-in ignoredfile.
113 &General
::readhasharray
($ignoredfile, \
%ignored);
115 # Check if we should edit an existing entry and got an ID.
116 if (($cgiparams{'WHITELIST'} eq $Lang::tr
{'update'}) && ($cgiparams{'ID'})) {
117 # Assin the provided id.
118 $id = $cgiparams{'ID'};
120 # Undef the given ID.
121 undef($cgiparams{'ID'});
123 # Grab the configured status of the corresponding entry.
124 $status = $ignored{$id}[2];
126 # Each newly added entry automatically should be enabled.
129 # Generate the ID for the new entry.
131 # Sort the keys by their ID and store them in an array.
132 my @keys = sort { $a <=> $b } keys %ignored;
134 # Reverse the key array.
135 my @reversed = reverse(@keys);
137 # Obtain the last used id.
138 my $last_id = @reversed[0];
140 # Increase the last id by one and use it as id for the new entry.
144 # Add/Modify the entry to/in the ignored hash.
145 $ignored{$id} = ["$new_entry_address", "$new_entry_remark", "$status"];
147 # Write the changed ignored hash to the ignored file.
148 &General
::writehasharray
($ignoredfile, \
%ignored);
150 # Regenerate the ignore file.
151 &GenerateIgnoreFile
();
154 # Check if the IDS is running.
155 if(&IDS
::ids_is_running
()) {
156 # Call suricatactrl to perform a reload.
157 &IDS
::call_suricatactrl
("reload");
160 ## Toggle Enabled/Disabled for an existing entry on the ignore list.
163 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr
{'toggle enable disable'}) {
166 # Only go further, if an ID has been passed.
167 if ($cgiparams{'ID'}) {
168 # Assign the given ID.
169 my $id = $cgiparams{'ID'};
171 # Undef the given ID.
172 undef($cgiparams{'ID'});
174 # Read-in ignoredfile.
175 &General
::readhasharray
($ignoredfile, \
%ignored);
177 # Grab the configured status of the corresponding entry.
178 my $status = $ignored{$id}[2];
181 if ($status eq "disabled") {
184 $status = "disabled";
187 # Modify the status of the existing entry.
188 $ignored{$id} = ["$ignored{$id}[0]", "$ignored{$id}[1]", "$status"];
190 # Write the changed ignored hash to the ignored file.
191 &General
::writehasharray
($ignoredfile, \
%ignored);
193 # Regenerate the ignore file.
194 &GenerateIgnoreFile
();
196 # Check if the IDS is running.
197 if(&IDS
::ids_is_running
()) {
198 # Call suricatactrl to perform a reload.
199 &IDS
::call_suricatactrl
("reload");
203 ## Remove entry from ignore list.
205 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr
{'remove'}) {
208 # Read-in ignoredfile.
209 &General
::readhasharray
($ignoredfile, \
%ignored);
211 # Drop entry from the hash.
212 delete($ignored{$cgiparams{'ID'}});
214 # Undef the given ID.
215 undef($cgiparams{'ID'});
217 # Write the changed ignored hash to the ignored file.
218 &General
::writehasharray
($ignoredfile, \
%ignored);
220 # Regenerate the ignore file.
221 &GenerateIgnoreFile
();
223 # Check if the IDS is running.
224 if(&IDS
::ids_is_running
()) {
225 # Call suricatactrl to perform a reload.
226 &IDS
::call_suricatactrl
("reload");
230 # Check if any error has been stored.
231 if (-e
$IDS::storederrorfile
) {
232 # Open file to read in the stored error message.
233 open(FILE
, "<$IDS::storederrorfile") or die "Could not open $IDS::storederrorfile. $!\n";
235 # Read the stored error message.
236 $errormessage = <FILE
>;
241 # Delete the file, which is now not longer required.
242 unlink($IDS::storederrorfile
);
246 ## Grab all available snort rules and store them in the idsrules hash.
248 # Open snort rules directory and do a directory listing.
249 opendir(DIR
, $IDS::rulespath
) or die $!;
250 # Loop through the direcory.
251 while (my $file = readdir(DIR
)) {
253 # We only want files.
254 next unless (-f
"$IDS::rulespath/$file");
256 # Ignore empty files.
257 next if (-z
"$IDS::rulespath/$file");
259 # Use a regular expression to find files ending in .rules
260 next unless ($file =~ m/\.rules$/);
262 # Ignore files which are not read-able.
263 next unless (-R
"$IDS::rulespath/$file");
265 # Skip whitelist rules file.
266 next if( $file eq "whitelist.rules");
268 # Call subfunction to read-in rulefile and add rules to
270 &readrulesfile
("$file");
275 # Gather used rulefiles.
277 # Check if the file for activated rulefiles is not empty.
278 if(-f
$idsusedrulefilesfile) {
279 # Open the file for used rulefile and read-in content.
280 open(FILE
, $idsusedrulefilesfile) or die "Could not open $idsusedrulefilesfile. $!\n";
288 # Loop through the array.
289 foreach my $line (@lines) {
294 next if ($line =~ /\#/);
297 next if ($line =~ /^\s*$/);
299 # Gather rule sid and message from the ruleline.
300 if ($line =~ /.*- (.*)/) {
303 # Add the rulefile to the %idsrules hash.
304 $idsrules{$rulefile}{'Rulefile'}{'State'} = "on";
310 if ($cgiparams{'RULESET'} eq $Lang::tr
{'update'}) {
311 # Arrays to store which rulefiles have been enabled and will be used.
312 my @enabled_rulefiles;
314 # Hash to store the user-enabled and disabled sids.
315 my %enabled_disabled_sids;
317 # Loop through the hash of idsrules.
318 foreach my $rulefile(keys %idsrules) {
319 # Check if the rulefile is enabled.
320 if ($cgiparams{$rulefile} eq "on") {
321 # Add rulefile to the array of enabled rulefiles.
322 push(@enabled_rulefiles, $rulefile);
324 # Drop item from cgiparams hash.
325 delete $cgiparams{$rulefile};
329 # Read-in the files for enabled/disabled sids.
330 # This will be done by calling the read_enabled_disabled_sids_file function two times
331 # and merge the returned hashes together into the enabled_disabled_sids hash.
332 %enabled_disabled_sids = (
333 &read_enabled_disabled_sids_file
($disabled_sids_file),
334 &read_enabled_disabled_sids_file
($enabled_sids_file));
336 # Loop through the hash of idsrules.
337 foreach my $rulefile (keys %idsrules) {
338 # Loop through the single rules of the rulefile.
339 foreach my $sid (keys %{$idsrules{$rulefile}}) {
340 # Skip the current sid if it is not numeric.
341 next unless ($sid =~ /\d+/ );
343 # Check if there exists a key in the cgiparams hash for this sid.
344 if (exists($cgiparams{$sid})) {
345 # Look if the rule is disabled.
346 if ($idsrules{$rulefile}{$sid}{'State'} eq "off") {
347 # Check if the state has been set to 'on'.
348 if ($cgiparams{$sid} eq "on") {
349 # Add/Modify the sid to/in the enabled_disabled_sids hash.
350 $enabled_disabled_sids{$sid} = "enabled";
352 # Drop item from cgiparams hash.
353 delete $cgiparams{$rulefile}{$sid};
357 # Look if the rule is enabled.
358 if ($idsrules{$rulefile}{$sid}{'State'} eq "on") {
359 # Check if the state is 'on' and should be disabled.
360 # In this case there is no entry
361 # for the sid in the cgiparams hash.
362 # Add/Modify it to/in the enabled_disabled_sids hash.
363 $enabled_disabled_sids{$sid} = "disabled";
365 # Drop item from cgiparams hash.
366 delete $cgiparams{$rulefile}{$sid};
372 # Open enabled sid's file for writing.
373 open(ENABLED_FILE
, ">$enabled_sids_file") or die "Could not write to $enabled_sids_file. $!\n";
375 # Open disabled sid's file for writing.
376 open(DISABLED_FILE
, ">$disabled_sids_file") or die "Could not write to $disabled_sids_file. $!\n";
378 # Write header to the files.
379 print ENABLED_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
380 print DISABLED_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
382 # Check if the hash for enabled/disabled files contains any entries.
383 if (%enabled_disabled_sids) {
384 # Loop through the hash.
385 foreach my $sid (keys %enabled_disabled_sids) {
386 # Check if the sid is enabled.
387 if ($enabled_disabled_sids{$sid} eq "enabled") {
388 # Print the sid to the enabled_sids file.
389 print ENABLED_FILE
"enablesid $sid\n";
390 # Check if the sid is disabled.
391 } elsif ($enabled_disabled_sids{$sid} eq "disabled") {
392 # Print the sid to the disabled_sids file.
393 print DISABLED_FILE
"disablesid $sid\n";
394 # Something strange happende - skip the current sid.
401 # Close file for enabled_sids after writing.
404 # Close file for disabled_sids after writing.
405 close(DISABLED_FILE
);
407 # Open file for used rulefiles.
408 open (FILE
, ">$idsusedrulefilesfile") or die "Could not write to $idsusedrulefilesfile. $!\n";
410 # Write yaml header to the file.
411 print FILE
"%YAML 1.1\n";
412 print FILE
"---\n\n";
414 # Write header to file.
415 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
417 # Check if the enabled_rulefiles array contains any entries.
418 if (@enabled_rulefiles) {
419 # Allways load the whitelist.
420 print FILE
" - whitelist.rules\n";
422 # Loop through the array of rulefiles which should be loaded and write them to the file.
423 foreach my $file (@enabled_rulefiles) {
424 print FILE
" - $file\n";
428 # Close file after writing.
431 # Lock the webpage and print message.
432 &working_notice
("$Lang::tr{'snort working'}");
434 # Call oinkmaster to alter the ruleset.
437 # Check if the IDS is running.
438 if(&IDS
::ids_is_running
()) {
439 # Call suricatactrl to perform a reload.
440 &IDS
::call_suricatactrl
("reload");
446 # Download new ruleset.
447 } elsif ($cgiparams{'RULESET'} eq $Lang::tr
{'download new ruleset'}) {
448 # Check if the red device is active.
449 unless (-e
"${General::swroot}/red/active") {
450 $errormessage = $Lang::tr
{'could not download latest updates'};
453 # Check if enought free disk space is availabe.
454 if(&IDS
::checkdiskspace
()) {
455 $errormessage = "$Lang::tr{'not enough disk space'}";
458 # Check if any errors happend.
459 unless ($errormessage) {
460 # Lock the webpage and print notice about downloading
462 &working_notice
("$Lang::tr{'snort working'}");
464 # Call subfunction to download the ruleset.
465 if(&IDS
::downloadruleset
()) {
466 $errormessage = $Lang::tr
{'could not download latest updates'};
468 # Call function to store the errormessage.
469 &IDS
::_store_error_message
($errormessage);
471 # Preform a reload of the page.
474 # Call subfunction to launch oinkmaster.
477 # Check if the IDS is running.
478 if(&IDS
::ids_is_running
()) {
479 # Call suricatactrl to perform a reload.
480 &IDS
::call_suricatactrl
("reload");
483 # Perform a reload of the page.
487 # Save snort settings.
488 } elsif ($cgiparams{'IDS'} eq $Lang::tr
{'save'}) {
492 # Read-in current (old) IDS settings.
493 &General
::readhash
("$IDS::settingsdir/settings", \
%oldidssettings);
495 # Prevent form name from been stored in conf file.
496 delete $cgiparams{'IDS'};
498 # Check if an oinkcode has been provided.
499 if ($cgiparams{'OINKCODE'}) {
500 # Check if the oinkcode contains unallowed chars.
501 unless ($cgiparams{'OINKCODE'} =~ /^[a-z0-9]+$/) {
502 $errormessage = $Lang::tr
{'invalid input for oink code'};
506 # Go on if there are no error messages.
507 if (!$errormessage) {
508 # Store settings into settings file.
509 &General
::writehash
("$IDS::settingsdir/settings", \
%cgiparams);
512 # Generate file to store the home net.
513 &generate_home_net_file
();
515 # Open modify sid's file for writing.
516 open(FILE
, ">$modify_sids_file") or die "Could not write to $modify_sids_file. $!\n";
519 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
521 # Check if the configured runmode is IPS.
522 if ($cgiparams{'RUN_MODE'} eq 'IPS') {
523 # Tell oinkmaster to switch all rules from alert to drop.
524 print FILE
"modifysid \* \"alert\" \| \"drop\"\n";
530 # Check if the runmode has been changed.
531 if($cgiparams{'RUN_MODE'} ne $oldidssettings{'RUN_MODE'}) {
532 # Check if a ruleset exists.
534 # Lock the webpage and print message.
535 &working_notice
("$Lang::tr{'snort working'}");
537 # Call oinkmaster to alter the ruleset.
540 # Set reload_page to "True".
545 # Check if the IDS currently is running.
546 if(&IDS
::ids_is_running
()) {
547 # Check if ENABLE_IDS is set to on.
548 if($cgiparams{'ENABLE_IDS'} eq "on") {
549 # Call suricatactrl to perform a reload of suricata.
550 &IDS
::call_suricatactrl
("reload");
552 # Call suricatactrl to stop suricata.
553 &IDS
::call_suricatactrl
("stop");
556 # Call suricatactrl to start suricata.
557 &IDS
::call_suricatactrl
("start");
560 # Check if the page should be reloaded.
562 # Perform a reload of the page.
567 # Read-in idssettings
568 &General
::readhash
("$IDS::settingsdir/settings", \
%idssettings);
570 # If the runmode has not been configured yet, set default value.
571 unless(exists($idssettings{'RUN_MODE'})) {
572 # Set default to IPS.
573 $idssettings{'RUN_MODE'} = 'IPS';
576 # Read-in ignored hosts.
577 &General
::readhasharray
("$IDS::settingsdir/ignored", \
%ignored);
579 $checked{'ENABLE_IDS'}{'off'} = '';
580 $checked{'ENABLE_IDS'}{'on'} = '';
581 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
582 $checked{'RUN_MODE'}{'IDS'} = '';
583 $checked{'RUN_MODE'}{'IPS'} = '';
584 $checked{'RUN_MODE'}{$idssettings{'RUN_MODE'}} = "checked='checked'";
585 $selected{'RULES'}{'nothing'} = '';
586 $selected{'RULES'}{'community'} = '';
587 $selected{'RULES'}{'emerging'} = '';
588 $selected{'RULES'}{'registered'} = '';
589 $selected{'RULES'}{'subscripted'} = '';
590 $selected{'RULES'}{$idssettings{'RULES'}} = "selected='selected'";
592 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
597 // Tiny java script function to show/hide the rules
598 // of a given category.
599 function showhide(tblname) {
600 \$("#" + tblname).toggle();
606 &Header
::openbigbox
('100%', 'left', '', $errormessage);
609 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
610 print "<class name='base'>$errormessage\n";
611 print " </class>\n";
615 # Draw current state of the IDS
616 &Header
::openbox
('100%', 'left', $Lang::tr
{'intrusion detection system'});
618 # Check if the IDS is running and obtain the process-id.
619 my $pid = &IDS
::ids_is_running
();
621 # Display some useful information, if suricata daemon is running.
623 # Gather used memory.
624 my $memory = &get_memory_usage
($pid);
627 <table width='95%' cellspacing='0' class='tbl'>
629 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
633 <td class='base'>$Lang::tr{'guardian daemon'}</td>
634 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
638 <td class='base'></td>
639 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
640 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
644 <td class='base'></td>
645 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
646 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
651 # Otherwise display a hint that the service is not launched.
653 <table width='95%' cellspacing='0' class='tbl'>
655 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
659 <td class='base'>$Lang::tr{'guardian daemon'}</td>
660 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
667 # Draw elements for IDS configuration.
668 &Header
::openbox
('100%', 'center', $Lang::tr
{'settings'});
672 # Check if a ruleset allready has been downloaded.
673 if ( -f
"$IDS::rulestarball"){
674 # Call stat on the filename to obtain detailed information.
675 my @Info = stat("$IDS::rulestarball");
677 # Grab details about the creation time.
678 $rulesdate = localtime($Info[9]);
682 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
683 <table width='100%' border='0'>
685 <td class='base' colspan='4'>
686 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}>$Lang::tr{'ids activate'} $Lang::tr{'intrusion detection system'}
691 <td colspan='4'><br><br></td>
695 <td class='base' colspan='4'><b>$Lang::tr{'runmode'}</b></td>
699 <td class='base' colspan='4'>
700 <input type='radio' name='RUN_MODE' value='IDS' $checked{'RUN_MODE'}{'IDS'}>$Lang::tr{'intrusion detection system2'}    
701 <input type='radio' name='RUN_MODE' value='IPS' $checked{'RUN_MODE'}{'IPS'}>$Lang::tr{'intrusion prevention system'}
706 <td colspan='4'><br></td>
710 <td colspan='4'><b>$Lang::tr{'ids traffic analyze'}</b><br></td>
717 # Loop through the array of available networks and print config options.
718 foreach my $zone (@network_zones) {
722 # Convert current zone name to upper case.
723 my $zone_upper = uc($zone);
725 # Grab checkbox status from settings hash.
726 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
727 $checked_input = "checked = 'checked'";
730 print "<td class='base' width='25%'>\n";
731 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>$Lang::tr{'enabled on'} $Lang::tr{$zone}\n";
739 <td colspan='4'><br><br></td>
743 <td colspan='4'><b>$Lang::tr{'ids rules update'}</b></td>
747 <td colspan='4'><select name='RULES'>
748 <option value='nothing' $selected{'RULES'}{'nothing'} >$Lang::tr{'no'}</option>
749 <option value='emerging' $selected{'RULES'}{'emerging'} >$Lang::tr{'emerging rules'}</option>
750 <option value='community' $selected{'RULES'}{'community'} >$Lang::tr{'community rules'}</option>
751 <option value='registered' $selected{'RULES'}{'registered'} >$Lang::tr{'registered user rules'}</option>
752 <option value='subscripted' $selected{'RULES'}{'subscripted'} >$Lang::tr{'subscripted user rules'}</option>
759 <br>$Lang::tr{'ids rules license'} <a href='https://www.snort.org/subscribe' target='_blank'>www.snort.org</a>$Lang::tr{'ids rules license1'}</br>
760 <br>$Lang::tr{'ids rules license2'} <a href='https://www.snort.org/account/oinkcode' target='_blank'>Get an Oinkcode</a>, $Lang::tr{'ids rules license3'}</br>
765 <td colspan='4' nowrap='nowrap'>Oinkcode: <input type='text' size='40' name='OINKCODE' value='$idssettings{'OINKCODE'}'></td>
769 <td colspan='4' align='left'><br>
770 <input type='submit' name='RULESET' value='$Lang::tr{'download new ruleset'}'> $Lang::tr{'updates installed'}: $rulesdate
780 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
790 # Whitelist / Ignorelist
792 &Header
::openbox
('100%', 'center', $Lang::tr
{'guardian ignored hosts'});
797 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
798 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
799 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
802 # Check if some hosts have been added to be ignored.
803 if (keys (%ignored)) {
806 # Loop through all entries of the hash.
807 while( (my $key) = each %ignored) {
808 # Assign data array positions to some nice variable names.
809 my $address = $ignored{$key}[0];
810 my $remark = $ignored{$key}[1];
811 my $status = $ignored{$key}[2];
813 # Check if the key (id) number is even or not.
814 if ($cgiparams{'ID'} eq $key) {
815 $col="bgcolor='${Header::colouryellow}'";
817 $col="bgcolor='$color{'color22'}'";
819 $col="bgcolor='$color{'color20'}'";
822 # Choose icon for the checkbox.
826 # Check if the status is enabled and select the correct image and description.
827 if ($status eq 'enabled' ) {
829 $gdesc = $Lang::tr
{'click to disable'};
832 $gdesc = $Lang::tr
{'click to enable'};
837 <td width='20%' class='base' $col>$address</td>
838 <td width='65%' class='base' $col>$remark</td>
840 <td align='center' $col>
841 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
842 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}' />
843 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc' />
844 <input type='hidden' name='ID' value='$key' />
848 <td align='center' $col>
849 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
850 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}' />
851 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}' />
852 <input type='hidden' name='ID' value='$key' />
856 <td align='center' $col>
857 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
858 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
859 <input type='hidden' name='ID' value='$key'>
860 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
867 # Print notice that currently no hosts are ignored.
869 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
875 # Section to add new elements or edit existing ones.
885 # Assign correct headline and button text.
890 # Check if an ID (key) has been given, in this case an existing entry should be edited.
891 if ($cgiparams{'ID'} ne '') {
892 $buttontext = $Lang::tr
{'update'};
893 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
895 # Grab address and remark for the given key.
896 $entry_address = $ignored{$cgiparams{'ID'}}[0];
897 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
899 $buttontext = $Lang::tr
{'add'};
900 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
904 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
905 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
907 <td width='30%'>$Lang::tr{'ip address'}: </td>
908 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
910 <td width='30%'>$Lang::tr{'remark'}: </td>
911 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
912 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
921 # Only show the section for configuring the ruleset if one is present.
923 &Header
::openbox
('100%', 'LEFT', $Lang::tr
{'intrusion detection system rules'});
925 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
927 # Output display table for rule files
928 print "<table width='100%'>\n";
930 # Local variable required for java script to show/hide
931 # rules of a rulefile.
932 my $rulesetcount = 1;
934 # Loop over each rule file
935 foreach my $rulefile (sort keys(%idsrules)) {
936 my $rulechecked = '';
938 # Check if rule file is enabled
939 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
940 $rulechecked = 'CHECKED';
943 # Table and rows for the rule files.
945 print"<td class='base' width='5%'>\n";
946 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
948 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
949 print"<td class='base' width='5%' align='right'>\n";
950 print"<a href=\"javascript:showhide('ruleset$rulesetcount')\">SHOW</a>\n";
954 # Rows which will be hidden per default and will contain the single rules.
955 print"<tr style='display:none' id='ruleset$rulesetcount'>\n";
956 print"<td colspan='3'>\n";
963 # New table for the single rules.
964 print "<table width='100%'>\n";
966 # Loop over rule file rules
967 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
969 my $ruledefchecked = '';
971 # Skip rulefile itself.
972 next if ($sid eq "Rulefile");
974 # If 2 rules have been displayed, start a new row
975 if (($lines % 2) == 0) {
978 # Increase rows by once.
984 $col="bgcolor='$color{'color20'}'";
986 $col="bgcolor='$color{'color22'}'";
990 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
991 $ruledefchecked = 'CHECKED';
994 # Create rule checkbox and display rule description
995 print "<td class='base' width='5%' align='right' $col>\n";
996 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
998 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1000 # Increment rule count
1004 # If do not have a second rule for row, create empty cell
1005 if (($lines % 2) != 0) {
1006 print "<td class='base'></td>";
1009 # Close display table
1010 print "</tr></table></td></tr>";
1012 # Finished whith the rule file, increase count.
1016 # Close display table
1020 <table width='100%'>
1022 <td width='100%' align='right'><input type='submit' name='RULESET' value='$Lang::tr{'update'}'>
1023 <!-- space for future online help link -->
1030 &Header
::closebox
();
1033 &Header
::closebigbox
();
1034 &Header
::closepage
();
1037 ## A function to display a notice, to lock the webpage and
1038 ## tell the user which action currently will be performed.
1040 sub working_notice
($) {
1043 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
1044 &Header
::openbigbox
('100%', 'left', '', $errormessage);
1045 &Header
::openbox
( 'Waiting', 1,);
1049 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
1054 &Header
::closebox
();
1055 &Header
::closebigbox
();
1056 &Header
::closepage
();
1060 ## A tiny function to perform a reload of the webpage after one second.
1063 print "<meta http-equiv='refresh' content='1'>\n";
1070 ## Private function to read-in and parse rules of a given rulefile.
1072 ## The given file will be read, parsed and all valid rules will be stored by ID,
1073 ## message/description and it's state in the idsrules hash.
1075 sub readrulesfile
($) {
1076 my $rulefile = shift;
1078 # Open rule file and read in contents
1079 open(RULEFILE
, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
1081 # Store file content in an array.
1082 my @lines = <RULEFILE
>;
1087 # Loop over rule file contents
1088 foreach my $line (@lines) {
1089 # Remove whitespaces.
1093 next if ($line =~ /^\s*$/);
1099 # Gather rule sid and message from the ruleline.
1100 if ($line =~ m/.*msg:\"(.*?)\"\; .* sid:(.*?); /) {
1104 # Check if a rule has been found.
1106 # Add rule to the idsrules hash.
1107 $idsrules{$rulefile}{$sid}{'Description'} = $msg;
1109 # Grab status of the rule. Check if ruleline starts with a "dash".
1110 if ($line =~ /^\#/) {
1111 # If yes, the rule is disabled.
1112 $idsrules{$rulefile}{$sid}{'State'} = "off";
1114 # Otherwise the rule is enabled.
1115 $idsrules{$rulefile}{$sid}{'State'} = "on";
1123 ## Function to get the used memory of a given process-id.
1125 sub get_memory_usage
($) {
1130 # Try to open the status file for the given process-id on the pseudo
1132 if (open(FILE
, "/proc/$pid/status")) {
1133 # Loop through the entire file.
1135 # Splitt current line content and store them into variables.
1136 my ($key, $value) = split(":", $_, 2);
1138 # Check if the current key is the one which contains the memory usage.
1139 # The wanted one is VmRSS which contains the Real-memory (resident set)
1140 # of the entire process.
1141 if ($key eq "VmRSS") {
1142 # Found the memory usage add it to the memory variable.
1150 # Close file handle.
1153 # Return memory usage.
1157 # If the file could not be open, return nothing.
1162 ## Function to generate the file which contains the home net information.
1164 sub generate_home_net_file
() {
1167 # Read-in network settings.
1168 &General
::readhash
("${General::swroot}/ethernet/settings", \
%netsettings);
1170 # Get available network zones.
1171 my @network_zones = &IDS
::get_available_network_zones
();
1173 # Temporary array to store network address and prefix of the configured
1177 # Loop through the array of available network zones.
1178 foreach my $zone (@network_zones) {
1179 # Skip the red network - It never can be part to the home_net!
1180 next if($zone eq "red");
1182 # Convert current zone name into upper case.
1185 # Generate key to access the required data from the netsettings hash.
1186 my $zone_netaddress = $zone . "_NETADDRESS";
1187 my $zone_netmask = $zone . "_NETMASK";
1189 # Obtain the settings from the netsettings hash.
1190 my $netaddress = $netsettings{$zone_netaddress};
1191 my $netmask = $netsettings{$zone_netmask};
1193 # Convert the subnetmask into prefix notation.
1194 my $prefix = &Network
::convert_netmask2prefix
($netmask);
1196 # Generate full network string.
1197 my $network = join("/", $netaddress,$prefix);
1199 # Check if the network is valid.
1200 if(&Network
::check_subnet
($network)) {
1201 # Add the generated network to the array of networks.
1202 push(@networks, $network);
1206 # Format home net declaration.
1209 # Loop through the array of networks.
1210 foreach my $network (@networks) {
1211 # Add the network to the line.
1212 $line = "$line" . "$network";
1214 # Check if the current network was the last in the array.
1215 if ($network eq $networks[-1]) {
1217 $line = "$line" . "\]\"";
1219 # Add "," for the next network.
1220 $line = "$line" . "\,";
1224 # Open file to store the addresses of the home net.
1225 open(FILE
, ">$idshomenetfile") or die "Could not open $idshomenetfile. $!\n";
1227 # Print yaml header.
1228 print FILE
"%YAML 1.1\n";
1229 print FILE
"---\n\n";
1231 # Print notice about autogenerated file.
1232 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
1234 # Print the generated and required HOME_NET declaration to the file.
1235 print FILE
"HOME_NET:\t$line\n";
1237 # Close file handle.
1243 ## Function to generate the rules file with whitelisted addresses.
1245 sub GenerateIgnoreFile
() {
1248 # SID range 1000000-1999999 Reserved for Local Use
1249 # Put your custom rules in this range to avoid conflicts
1252 # Read-in ignoredfile.
1253 &General
::readhasharray
($ignoredfile, \
%ignored);
1255 # Open ignorefile for writing.
1256 open(FILE
, ">$whitelistfile") or die "Could not write to $whitelistfile. $!\n";
1258 # Config file header.
1259 print FILE
"# Autogenerated file.\n";
1260 print FILE
"# All user modifications will be overwritten.\n\n";
1262 # Add all user defined addresses to the whitelist.
1264 # Check if the hash contains any elements.
1265 if (keys (%ignored)) {
1266 # Loop through the entire hash and write the host/network
1267 # and remark to the ignore file.
1268 while ( (my $key) = each %ignored) {
1269 my $address = $ignored{$key}[0];
1270 my $remark = $ignored{$key}[1];
1271 my $status = $ignored{$key}[2];
1273 # Check if the status of the entry is "enabled".
1274 if ($status eq "enabled") {
1275 # Check if the address/network is valid.
1276 if ((&General
::validip
($address)) || (&General
::validipandmask
($address))) {
1277 # Write rule line to the file to pass any traffic from this IP
1278 print FILE
"pass ip $address any -> any any (msg:\"pass all traffic from/to $address\"\; sid:$sid\;)\n";
1291 ## Function to read-in the given enabled or disables sids file.
1293 sub read_enabled_disabled_sids_file
($) {
1296 # Temporary hash to store the sids and their state. It will be
1297 # returned at the end of this function.
1300 # Open the given filename.
1301 open(FILE
, "$file") or die "Could not open $file. $!\n";
1303 # Loop through the file.
1309 next if ($_ =~ /^\s*$/);
1312 next if ($_ =~ /^\#/);
1314 # Splitt line into sid and state part.
1315 my ($state, $sid) = split(" ", $_);
1317 # Skip line if the sid is not numeric.
1318 next unless ($sid =~ /\d+/ );
1320 # Check if the sid was enabled.
1321 if ($state eq "enablesid") {
1322 # Add the sid and its state as enabled to the temporary hash.
1323 $temphash{$sid} = "enabled";
1324 # Check if the sid was disabled.
1325 } elsif ($state eq "disablesid") {
1326 # Add the sid and its state as disabled to the temporary hash.
1327 $temphash{$sid} = "disabled";
1328 # Invalid state - skip the current sid and state.