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 = ();
41 my %used_providers=();
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.
258 # Get enabled providers.
259 my @enabled_providers = &IDS
::get_enabled_providers
();
261 # Open rules directory and do a directory listing.
262 opendir(DIR
, $IDS::rulespath
) or die $!;
263 # Loop through the direcory.
264 while (my $file = readdir(DIR
)) {
266 # We only want files.
267 next unless (-f
"$IDS::rulespath/$file");
269 # Ignore empty files.
270 next if (-z
"$IDS::rulespath/$file");
272 # Use a regular expression to find files ending in .rules
273 next unless ($file =~ m/\.rules$/);
275 # Ignore files which are not read-able.
276 next unless (-R
"$IDS::rulespath/$file");
278 # Skip whitelist rules file.
279 next if( $file eq "whitelist.rules");
281 # Splitt vendor from filename.
282 my @filename_parts = split(/-/, $file);
284 # Assign vendor name for easy processing.
285 my $vendor = @filename_parts[0];
287 # Skip rulefile if the provider is disabled.
288 next unless ($vendor ~~ @enabled_providers);
290 # Call subfunction to read-in rulefile and add rules to
292 &readrulesfile
("$file");
297 # Loop through the array of used providers.
298 foreach my $provider (@enabled_providers) {
299 # Gather used rulefiles.
300 my @used_rulesfiles = &IDS
::read_used_provider_rulesfiles
($provider);
302 # Loop through the array of used rulesfiles.
303 foreach my $rulefile (@used_rulesfiles) {
304 # Check if the current rulefile exists in the %idsrules hash.
305 # If not, the file probably does not exist anymore or contains
307 if($idsrules{$rulefile}) {
308 # Add the rulefile state to the %idsrules hash.
309 $idsrules{$rulefile}{'Rulefile'}{'State'} = "on";
316 if ($cgiparams{'RULESET'} eq $Lang::tr
{'ids apply'}) {
317 # Arrays to store which rulefiles have been enabled and will be used.
318 my @enabled_rulefiles;
320 # Store if a restart of suricata is required.
321 my $suricata_restart_required;
323 # Loop through the hash of idsrules.
324 foreach my $rulefile(keys %idsrules) {
325 # Check if the state of the rulefile has been changed.
326 unless ($cgiparams{$rulefile} eq $idsrules{$rulefile}{'Rulefile'}{'State'}) {
327 # A restart of suricata is required to apply the changes of the used rulefiles.
328 $suricata_restart_required = 1;
331 # Check if the rulefile is enabled.
332 if ($cgiparams{$rulefile} eq "on") {
333 # Add rulefile to the array of enabled rulefiles.
334 push(@enabled_rulefiles, $rulefile);
336 # Drop item from cgiparams hash.
337 delete $cgiparams{$rulefile};
341 # Open oinkmaster main include file for provider modifications.
342 open(OINKM_INCL_FILE
, ">", "$IDS::oinkmaster_provider_includes_file") or die "Could not open $IDS::oinkmaster_provider_includes_file. $!\n";
344 # Print file header and notice about autogenerated file.
345 print OINKM_INCL_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
347 # Get enabled providers.
348 my @enabled_providers = &IDS
::get_enabled_providers
();
350 # Loop through the array of enabled providers.
351 foreach my $provider (@enabled_providers) {
352 # Hash to store the used-enabled and disabled sids.
353 my %enabled_disabled_sids;
355 # Generate modified sids file name for the current processed provider.
356 my $providers_modified_sids_file = &IDS
::get_oinkmaster_provider_modified_sids_file
($provider);
358 # Check if a modified sids file for this provider exists.
359 if (-f
$providers_modified_sids_file) {
360 # Read-in the file for enabled/disabled sids.
361 %enabled_disabled_sids = &IDS
::read_enabled_disabled_sids_file
($providers_modified_sids_file);
364 # Loop through the hash of idsrules.
365 foreach my $rulefile (keys %idsrules) {
366 # Split the rulefile to get the vendor.
367 my @filename_parts = split(/-/, $rulefile);
369 # Assign rulefile vendor.
370 my $rulefile_vendor = @filename_parts[0];
372 # Skip the rulefile if the vendor is not our current processed provider.
373 next unless ($rulefile_vendor eq $provider);
375 # Loop through the single rules of the rulefile.
376 foreach my $sid (keys %{$idsrules{$rulefile}}) {
377 # Skip the current sid if it is not numeric.
378 next unless ($sid =~ /\d+/ );
380 # Check if there exists a key in the cgiparams hash for this sid.
381 if (exists($cgiparams{$sid})) {
382 # Look if the rule is disabled.
383 if ($idsrules{$rulefile}{$sid}{'State'} eq "off") {
384 # Check if the state has been set to 'on'.
385 if ($cgiparams{$sid} eq "on") {
386 # Add/Modify the sid to/in the enabled_disabled_sids hash.
387 $enabled_disabled_sids{$sid} = "enabled";
389 # Drop item from cgiparams hash.
390 delete $cgiparams{$rulefile}{$sid};
394 # Look if the rule is enabled.
395 if ($idsrules{$rulefile}{$sid}{'State'} eq "on") {
396 # Check if the state is 'on' and should be disabled.
397 # In this case there is no entry
398 # for the sid in the cgiparams hash.
399 # Add/Modify it to/in the enabled_disabled_sids hash.
400 $enabled_disabled_sids{$sid} = "disabled";
402 # Drop item from cgiparams hash.
403 delete $cgiparams{$rulefile}{$sid};
409 # Check if the hash for enabled/disabled sids contains any entries.
410 if (%enabled_disabled_sids) {
411 # Open providers modified sids file for writing.
412 open(PROVIDER_MOD_FILE
, ">$providers_modified_sids_file") or die "Could not write to $providers_modified_sids_file. $!\n";
414 # Write header to the files.
415 print PROVIDER_MOD_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
417 # Loop through the hash.
418 foreach my $sid (keys %enabled_disabled_sids) {
419 # Check if the sid is enabled.
420 if ($enabled_disabled_sids{$sid} eq "enabled") {
421 # Print the sid to the enabled_sids file.
422 print PROVIDER_MOD_FILE
"enablesid $sid\n";
423 # Check if the sid is disabled.
424 } elsif ($enabled_disabled_sids{$sid} eq "disabled") {
425 # Print the sid to the disabled_sids file.
426 print PROVIDER_MOD_FILE
"disablesid $sid\n";
427 # Something strange happende - skip the current sid.
433 # Close file handle for the providers modified sids file.
434 close(PROVIDER_MOD_FILE
);
436 # Add the file to the oinkmasters include file.
437 print OINKM_INCL_FILE
"include $providers_modified_sids_file\n";
441 # Close the file handle after writing.
442 close(OINKM_INCL_FILE
);
444 # Handle enabled / disabled rulefiles.
447 # Loop through the array of enabled providers.
448 foreach my $provider(@enabled_providers) {
449 # Array to store the rulefiles which belong to the current processed provider.
450 my @provider_rulefiles = ();
452 # Loop through the array of enabled rulefiles.
453 foreach my $rulesfile (@enabled_rulefiles) {
454 # Split the rulefile name.
455 my @filename_parts = split(/-/, "$rulesfile");
457 # Assign vendor name for easy processings.
458 my $vendor = @filename_parts[0];
460 # Check if the rulesvendor is our current processed enabled provider.
461 if ("$vendor" eq "$provider") {
462 # Add the rulesfile to the array of provider rulesfiles.
463 push(@provider_rulefiles, $rulesfile);
466 # Call function and write the providers used rulesfile file.
467 &IDS
::write_used_provider_rulefiles_file
($provider, @provider_rulefiles);
471 # Call function to generate and write the used rulefiles file.
472 &IDS
::write_main_used_rulefiles_file
(@enabled_providers);
474 # Lock the webpage and print message.
475 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
477 # Call oinkmaster to alter the ruleset.
480 # Check if the IDS is running.
481 if(&IDS
::ids_is_running
()) {
482 # Check if a restart of suricata is required.
483 if ($suricata_restart_required) {
484 # Call suricatactrl to perform the restart.
485 &IDS
::call_suricatactrl
("restart");
487 # Call suricatactrl to perform a reload.
488 &IDS
::call_suricatactrl
("reload");
495 # Download new ruleset.
496 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'ids force ruleset update'}) {
497 # Assign given provider handle.
498 my $provider = $cgiparams{'PROVIDER'};
500 # Check if the red device is active.
501 unless (-e
"${General::swroot}/red/active") {
502 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
505 # Check if enought free disk space is availabe.
506 if(&IDS
::checkdiskspace
()) {
507 $errormessage = "$Lang::tr{'not enough disk space'}";
510 # Check if any errors happend.
511 unless ($errormessage) {
512 # Lock the webpage and print notice about downloading
514 &working_notice
("$Lang::tr{'ids download new ruleset'}");
516 # Call subfunction to download the ruleset.
517 if(&IDS
::downloadruleset
($provider)) {
518 $errormessage = "$provider - $Lang::tr{'could not download latest updates'}";
520 # Call function to store the errormessage.
521 &IDS
::_store_error_message
($errormessage);
523 # Preform a reload of the page.
526 # Call subfunction to launch oinkmaster.
529 # Check if the IDS is running.
530 if(&IDS
::ids_is_running
()) {
531 # Call suricatactrl to perform a reload.
532 &IDS
::call_suricatactrl
("reload");
535 # Perform a reload of the page.
540 # Reset a provider to it's defaults.
541 } elsif ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'ids reset provider'}") {
542 # Grab provider handle from cgihash.
543 my $provider = $cgiparams{'PROVIDER'};
545 # Lock the webpage and print message.
546 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
548 # Create new empty file for used rulefiles
550 &IDS
::write_used_provider_rulefiles_file
($provider);
552 # Call function to get the path and name for the given providers
553 # oinkmaster modified sids file.
554 my $provider_modified_sids_file = &IDS
::get_oinkmaster_provider_modified_sids_file
($provider);
556 # Check if the file exists.
557 if (-f
$provider_modified_sids_file) {
558 # Remove the file, as requested.
559 unlink("$provider_modified_sids_file");
562 # Alter the oinkmaster provider includes file and remove the provider.
563 &IDS
::alter_oinkmaster_provider_includes_file
("remove", $provider);
565 # Regenerate ruleset.
568 # Check if the IDS is running.
569 if(&IDS
::ids_is_running
()) {
570 # Get enabled providers.
571 my @enabled_providers = &IDS
::get_enabled_providers
();
573 # Get amount of enabled providers.
574 my $amount = @enabled_providers;
576 # Check if at least one enabled provider remains.
578 # Call suricatactrl to perform a reload.
579 &IDS
::call_suricatactrl
("restart");
581 # Stop suricata if no enabled provider remains.
583 # Call suricatactrel to perform the stop.
584 &IDS
::call_suricatactrl
("stop");
588 # Undefine providers flag.
589 undef($cgiparams{'PROVIDERS'});
595 } elsif ($cgiparams{'IDS'} eq $Lang::tr
{'save'}) {
598 my $monitored_zones = 0;
600 # Read-in current (old) IDS settings.
601 &General
::readhash
("$IDS::ids_settings_file", \
%oldidssettings);
603 # Get enabled providers.
604 my @enabled_providers = &IDS
::get_enabled_providers
();
606 # Prevent form name from been stored in conf file.
607 delete $cgiparams{'IDS'};
609 # Check if the IDS should be enabled.
610 if ($cgiparams{'ENABLE_IDS'} eq "on") {
611 # Check if at least one provider is enabled. Otherwise abort and display an error.
612 unless(@enabled_providers) {
613 $errormessage = $Lang::tr
{'ids no enabled ruleset provider'};
616 # Loop through the array of available interfaces.
617 foreach my $zone (@network_zones) {
618 # Convert interface name into upper case.
619 my $zone_upper = uc($zone);
621 # Check if the IDS is enabled for this interaces.
622 if ($cgiparams{"ENABLE_IDS_$zone_upper"}) {
628 # Check if at least one zone should be monitored, or show an error.
629 unless ($monitored_zones >= 1) {
630 $errormessage = $Lang::tr
{'ids no network zone'};
634 # Go on if there are no error messages.
635 if (!$errormessage) {
636 # Store settings into settings file.
637 &General
::writehash
("$IDS::ids_settings_file", \
%cgiparams);
640 # Check if the the automatic rule update hass been touched.
641 if($cgiparams{'AUTOUPDATE_INTERVAL'} ne $oldidssettings{'AUTOUPDATE_INTERVAL'}) {
642 # Call suricatactrl to set the new interval.
643 &IDS
::call_suricatactrl
("cron", $cgiparams{'AUTOUPDATE_INTERVAL'});
646 # Generate file to store the home net.
647 &IDS
::generate_home_net_file
();
649 # Generate file to the store the DNS servers.
650 &IDS
::generate_dns_servers_file
();
652 # Generate file to store the HTTP ports.
653 &IDS
::generate_http_ports_file
();
655 # Write the modify sid's file and pass the taken ruleaction.
656 &IDS
::write_modify_sids_file
();
658 # Check if "MONITOR_TRAFFIC_ONLY" has been changed.
659 if($cgiparams{'MONITOR_TRAFFIC_ONLY'} ne $oldidssettings{'MONITOR_TRAFFIC_ONLY'}) {
660 # Check if at least one provider is enabled.
661 if (@enabled_providers) {
662 # Lock the webpage and print message.
663 &working_notice
("$Lang::tr{'ids working'}");
665 # Call oinkmaster to alter the ruleset.
668 # Set reload_page to "True".
673 # Check if the IDS currently is running.
674 if(&IDS
::ids_is_running
()) {
675 # Check if ENABLE_IDS is set to on.
676 if($cgiparams{'ENABLE_IDS'} eq "on") {
677 # Call suricatactrl to perform a reload of suricata.
678 &IDS
::call_suricatactrl
("reload");
680 # Call suricatactrl to stop suricata.
681 &IDS
::call_suricatactrl
("stop");
684 # Call suricatactrl to start suricata.
685 &IDS
::call_suricatactrl
("start");
688 # Check if the page should be reloaded.
690 # Perform a reload of the page.
694 # Toggle Enable/Disable autoupdate for a provider
695 } elsif ($cgiparams{'AUTOUPDATE'} eq $Lang::tr
{'toggle enable disable'}) {
696 my %used_providers = ();
698 # Only go further, if an ID has been passed.
699 if ($cgiparams{'ID'}) {
700 # Assign the given ID.
701 my $id = $cgiparams{'ID'};
703 # Undef the given ID.
704 undef($cgiparams{'ID'});
706 # Read-in providers settings file.
707 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
709 # Grab the configured status of the corresponding entry.
710 my $status_autoupdate = $used_providers{$id}[2];
713 if ($status_autoupdate eq "disabled") {
714 $status_autoupdate = "enabled";
716 $status_autoupdate = "disabled";
719 # Modify the status of the existing entry.
720 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$status_autoupdate", "$used_providers{$id}[3]"];
722 # Write the changed hash to the providers settings file.
723 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
726 # Add/Edit a provider to the list of used providers.
728 } elsif (($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") || ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'update'}")) {
729 my %used_providers = ();
731 # Read-in providers settings file.
732 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
734 # Assign some nice human-readable values.
735 my $provider = $cgiparams{'PROVIDER'};
736 my $subscription_code = $cgiparams{'SUBSCRIPTION_CODE'};
737 my $status_autoupdate;
739 # Handle autoupdate checkbox.
740 if ($cgiparams{'ENABLE_AUTOUPDATE'} eq "on") {
741 $status_autoupdate = "enabled";
743 $status_autoupdate = "disabled";
746 # Check if we are going to add a new provider.
747 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") {
748 # Loop through the hash of used providers.
749 foreach my $id ( keys %used_providers) {
750 # Check if the choosen provider is already in use.
751 if ($used_providers{$id}[0] eq "$provider") {
752 # Assign error message.
753 $errormessage = "$Lang::tr{'ids the choosen provider is already in use'}";
758 # Check if the provider requires a subscription code.
759 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
760 # Check if an subscription code has been provided.
761 if ($subscription_code) {
762 # Check if the code contains unallowed chars.
763 unless ($subscription_code =~ /^[a-z0-9]+$/) {
764 $errormessage = $Lang::tr
{'invalid input for subscription code'};
767 # Print an error message, that an subsription code is required for this
769 $errormessage = $Lang::tr
{'ids subscription code required'};
773 # Go further if there was no error.
774 if ($errormessage eq '') {
778 # Check if we should edit an existing entry and got an ID.
779 if (($cgiparams{'PROVIDERS'} eq $Lang::tr
{'update'}) && ($cgiparams{'ID'})) {
780 # Assin the provided id.
781 $id = $cgiparams{'ID'};
783 # Undef the given ID.
784 undef($cgiparams{'ID'});
786 # Grab the configured status of the corresponding entry.
787 $status = $used_providers{$id}[3];
789 # Each newly added entry automatically should be enabled.
792 # Generate the ID for the new entry.
794 # Sort the keys by their ID and store them in an array.
795 my @keys = sort { $a <=> $b } keys %used_providers;
797 # Reverse the key array.
798 my @reversed = reverse(@keys);
800 # Obtain the last used id.
801 my $last_id = @reversed[0];
803 # Increase the last id by one and use it as id for the new entry.
807 # Add/Modify the entry to/in the used providers hash..
808 $used_providers{$id} = ["$provider", "$subscription_code", "$status_autoupdate", "$status"];
810 # Write the changed hash to the providers settings file.
811 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
813 # Check if a new provider will be added.
814 if ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'add'}) {
815 # Check if the red device is active.
816 unless (-e
"${General::swroot}/red/active") {
817 $errormessage = "$Lang::tr{'ids could not add provider'} - $Lang::tr{'system is offline'}";
820 # Check if enough free disk space is availabe.
821 if(&IDS
::checkdiskspace
()) {
822 $errormessage = "$Lang::tr{'ids could not add provider'} - $Lang::tr{'not enough disk space'}";
825 # Check if any errors happend.
826 unless ($errormessage) {
827 # Lock the webpage and print notice about downloading
829 &working_notice
("$Lang::tr{'ids working'}");
831 # Download the ruleset.
832 if(&IDS
::downloadruleset
($provider)) {
833 $errormessage = "$Lang::tr{'ids could not add provider'} - $Lang::tr{'ids unable to download the ruleset'}";
835 # Call function to store the errormessage.
836 &IDS
::_store_error_message
($errormessage);
838 # Remove the configured provider again.
839 &remove_provider
($id);
841 # Extract the ruleset
842 &IDS
::extractruleset
($provider);
845 &IDS
::move_tmp_ruleset
();
847 # Cleanup temporary directory.
848 &IDS
::cleanup_tmp_directory
();
850 # Create new empty file for used rulefiles
852 &IDS
::write_used_provider_rulefiles_file
($provider);
855 # Perform a reload of the page.
862 # Undefine providers flag.
863 undef($cgiparams{'PROVIDERS'});
865 ## Toggle Enabled/Disabled for an existing provider.
867 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'toggle enable disable'}) {
868 my %used_providers = ();
869 my $provider_includes_action;
871 # Value if oinkmaster has to be executed.
872 my $oinkmaster = "False";
874 # Only go further, if an ID has been passed.
875 if ($cgiparams{'ID'}) {
876 # Assign the given ID.
877 my $id = $cgiparams{'ID'};
879 # Undef the given ID.
880 undef($cgiparams{'ID'});
882 # Read-in file which contains the provider settings.
883 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
885 # Grab the configured status of the corresponding entry.
886 my $status = $used_providers{$id}[3];
888 # Grab the provider handle.
889 my $provider_handle = $used_providers{$id}[0];
892 if ($status eq "enabled") {
893 $status = "disabled";
895 # Set the provider includes action to "remove" for removing the entry.
896 $provider_includes_action = "remove";
900 # Set the provider includes action to "add".
901 $provider_includes_action = "add";
903 # This operation requires to launch oinkmaster.
904 $oinkmaster = "True";
907 # Modify the status of the existing entry.
908 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$used_providers{$id}[2]", "$status"];
910 # Write the changed hash to the providers settings file.
911 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
913 # Get all enabled providers.
914 my @enabled_providers = &IDS
::get_enabled_providers
();
916 # Write the main providers include file.
917 &IDS
::write_main_used_rulefiles_file
(@enabled_providers);
919 # Call function to alter the oinkmasters provider includes file and
920 # add or remove the provider.
921 &IDS
::alter_oinkmaster_provider_includes_file
($provider_includes_action, $provider_handle);
923 # Check if oinkmaster has to be executed.
924 if ($oinkmaster eq "True") {
925 # Lock the webpage and print message.
926 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
932 # Check if the IDS is running.
933 if(&IDS
::ids_is_running
()) {
934 # Gather the amount of enabled providers (elements in the array).
935 my $amount = @enabled_providers;
937 # Check if there are still enabled ruleset providers.
939 # Call suricatactrl to perform a restart.
940 &IDS
::call_suricatactrl
("restart");
942 # No active ruleset provider, suricata has to be stopped.
945 &IDS
::call_suricatactrl
("stop");
949 # Undefine providers flag.
950 undef($cgiparams{'PROVIDERS'});
956 ## Remove provider from the list of used providers.
958 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'remove'}) {
959 # Assign a nice human-readable variable.
960 my $id = $cgiparams{'ID'};
962 # Grab the provider name bevore deleting.
963 my $provider = &get_provider_handle
($id);
965 # Remove the provider.
966 &remove_provider
($id);
968 # Undef the given ID.
969 undef($cgiparams{'ID'});
971 # Lock the webpage and print message.
972 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
974 # Drop the stored ruleset file.
975 &IDS
::drop_dl_rulesfile
($provider);
977 # Get the name of the provider rulessets include file.
978 my $provider_used_rulefile = &IDS
::get_used_provider_rulesfile_file
($provider);
980 # Drop the file, it is not longer needed.
981 unlink("$provider_used_rulefile");
983 # Call function to get the path and name for the given providers
984 # oinkmaster modified sids file.
985 my $provider_modified_sids_file = &IDS
::get_oinkmaster_provider_modified_sids_file
($provider);
987 # Check if the file exists.
988 if (-f
$provider_modified_sids_file) {
989 # Remove the file, which is not longer needed.
990 unlink("$provider_modified_sids_file");
993 # Alter the oinkmaster provider includes file and remove the provider.
994 &IDS
::alter_oinkmaster_provider_includes_file
("remove", $provider);
996 # Regenerate ruleset.
999 # Gather all enabled providers.
1000 my @enabled_providers = &IDS
::get_enabled_providers
();
1002 # Regenerate main providers include file.
1003 &IDS
::write_main_used_rulefiles_file
(@enabled_providers);
1005 # Check if the IDS is running.
1006 if(&IDS
::ids_is_running
()) {
1007 # Get amount of enabled providers.
1008 my $amount = @enabled_providers;
1010 # Check if at least one enabled provider remains.
1012 # Call suricatactrl to perform a reload.
1013 &IDS
::call_suricatactrl
("restart");
1015 # Stop suricata if no enabled provider remains.
1017 # Call suricatactrel to perform the stop.
1018 &IDS
::call_suricatactrl
("stop");
1022 # Undefine providers flag.
1023 undef($cgiparams{'PROVIDERS'});
1029 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
1031 &Header
::openbigbox
('100%', 'left', '', $errormessage);
1033 &show_display_error_message
();
1035 if ($cgiparams{'RULESET'} eq "$Lang::tr{'ids customize ruleset'}" ) {
1036 &show_customize_ruleset
();
1037 } elsif ($cgiparams{'PROVIDERS'} ne "") {
1038 &show_add_provider
();
1043 &Header
::closebigbox
();
1044 &Header
::closepage
();
1047 ## Tiny function to show if a error message happened.
1049 sub show_display_error_message
() {
1050 if ($errormessage) {
1051 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
1052 print "<class name='base'>$errormessage\n";
1053 print " </class>\n";
1054 &Header
::closebox
();
1059 ## Function to display the main IDS page.
1061 sub show_mainpage
() {
1062 # Read-in idssettings and provider settings.
1063 &General
::readhash
("$IDS::ids_settings_file", \
%idssettings);
1064 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
1066 # If no autoupdate intervall has been configured yet, set default value.
1067 unless(exists($idssettings{'AUTOUPDATE_INTERVAL'})) {
1068 # Set default to "weekly".
1069 $idssettings{'AUTOUPDATE_INTERVAL'} = 'weekly';
1072 # Read-in ignored hosts.
1073 &General
::readhasharray
("$IDS::settingsdir/ignored", \
%ignored);
1075 $checked{'ENABLE_IDS'}{'off'} = '';
1076 $checked{'ENABLE_IDS'}{'on'} = '';
1077 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
1078 $checked{'MONITOR_TRAFFIC_ONLY'}{'off'} = '';
1079 $checked{'MONITOR_TRAFFIC_ONLY'}{'on'} = '';
1080 $checked{'MONITOR_TRAFFIC_ONLY'}{$idssettings{'MONITOR_TRAFFIC_ONLY'}} = "checked='checked'";
1081 $selected{'AUTOUPDATE_INTERVAL'}{'off'} = '';
1082 $selected{'AUTOUPDATE_INTERVAL'}{'daily'} = '';
1083 $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} = '';
1084 $selected{'AUTOUPDATE_INTERVAL'}{$idssettings{'AUTOUPDATE_INTERVAL'}} = "selected='selected'";
1086 # Draw current state of the IDS
1087 &Header
::openbox
('100%', 'left', $Lang::tr
{'intrusion detection system'});
1089 # Check if the IDS is running and obtain the process-id.
1090 my $pid = &IDS
::ids_is_running
();
1092 # Display some useful information, if suricata daemon is running.
1094 # Gather used memory.
1095 my $memory = &get_memory_usage
($pid);
1098 <table width='95%' cellspacing='0' class='tbl'>
1100 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1104 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1105 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
1109 <td class='base'></td>
1110 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
1111 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
1115 <td class='base'></td>
1116 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
1117 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
1122 # Otherwise display a hint that the service is not launched.
1124 <table width='95%' cellspacing='0' class='tbl'>
1126 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1130 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1131 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
1137 # Only show this area, if at least one ruleset provider is configured.
1138 if (%used_providers) {
1142 <br><br><h2>$Lang::tr{'settings'}</h2>
1144 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1145 <table width='100%' border='0'>
1147 <td class='base' colspan='2'>
1148 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}> $Lang::tr{'ids enable'}
1151 <td class='base' colspan='2'>
1152 <input type='checkbox' name='MONITOR_TRAFFIC_ONLY' $checked{'MONITOR_TRAFFIC_ONLY'}{'on'}> $Lang::tr{'ids monitor traffic only'}
1164 <td colspan='4'><b>$Lang::tr{'ids monitored interfaces'}</b><br></td>
1171 # Loop through the array of available networks and print config options.
1172 foreach my $zone (@network_zones) {
1174 my $checked_forward;
1176 # Convert current zone name to upper case.
1177 my $zone_upper = uc($zone);
1180 my $zone_name = $zone;
1182 # Dirty hack to get the correct language string for the red zone.
1183 if ($zone eq "red") {
1184 $zone_name = "red1";
1187 # Grab checkbox status from settings hash.
1188 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
1189 $checked_input = "checked = 'checked'";
1192 print "<td class='base' width='20%'>\n";
1193 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>\n";
1194 print " $Lang::tr{'enabled on'}<font color='$colourhash{$zone}'> $Lang::tr{$zone_name}</font>\n";
1209 <td colspan='4'><b>$Lang::tr{'ids automatic rules update'}</b></td>
1214 <select name='AUTOUPDATE_INTERVAL'>
1215 <option value='off' $selected{'AUTOUPDATE_INTERVAL'}{'off'} >- $Lang::tr{'Disabled'} -</option>
1216 <option value='daily' $selected{'AUTOUPDATE_INTERVAL'}{'daily'} >$Lang::tr{'Daily'}</option>
1217 <option value='weekly' $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} >$Lang::tr{'Weekly'}</option>
1225 <table width='100%'>
1227 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
1236 &Header
::closebox
();
1239 # Used Ruleset Providers section.
1241 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ruleset settings'});
1244 <table width='100%' border='0'>
1246 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ids provider'}</b></td>
1247 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'date'}</b></td>
1248 <td class='base' bgcolor='$color{'color20'}' align='center'><b>$Lang::tr{'ids autoupdates'}</b></td>
1249 <td class='base' bgcolor='$color{'color20'}'></td>
1250 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1255 # Check if some providers has been configured.
1256 if (keys (%used_providers)) {
1259 # Loop through all entries of the hash.
1260 foreach my $id (sort keys(%used_providers)) {
1261 # Assign data array positions to some nice variable names.
1262 my $provider = $used_providers{$id}[0];
1263 my $provider_name = &get_provider_name
($provider);
1264 my $rulesetdate = &IDS
::get_ruleset_date
($provider);
1266 my $subscription_code = $used_providers{$id}[1];
1267 my $autoupdate_status = $used_providers{$id}[2];
1268 my $status = $used_providers{$id}[3];
1270 # Check if the item number is even or not.
1272 $col="bgcolor='$color{'color22'}'";
1274 $col="bgcolor='$color{'color20'}'";
1277 # Choose icons for the checkboxes.
1280 my $autoupdate_status_gif;
1281 my $autoupdate_status_gdesc;
1283 # Check if the status is enabled and select the correct image and description.
1284 if ($status eq 'enabled' ) {
1285 $status_gif = 'on.gif';
1286 $status_gdesc = $Lang::tr
{'click to disable'};
1288 $status_gif = 'off.gif';
1289 $status_gdesc = $Lang::tr
{'click to enable'};
1292 # Check if the autoupdate status is enabled and select the correct image and description.
1293 if ($autoupdate_status eq 'enabled') {
1294 $autoupdate_status_gif = 'on.gif';
1295 $autoupdate_status_gdesc = $Lang::tr
{'click to disable'};
1297 $autoupdate_status_gif = 'off.gif';
1298 $autoupdate_status_gdesc = $Lang::tr
{'click to enable'};
1303 <td width='33%' class='base' $col>$provider_name</td>
1304 <td width='30%' class='base' $col>$rulesetdate</td>
1306 <td align='center' $col>
1307 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1308 <input type='hidden' name='AUTOUPDATE' value='$Lang::tr{'toggle enable disable'}' />
1309 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$autoupdate_status_gif' alt='$autoupdate_status_gdesc' title='$autoupdate_status_gdesc' />
1310 <input type='hidden' name='ID' value='$id' />
1314 <td align='center' $col>
1315 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1316 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'toggle enable disable'}'>
1317 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$status_gif' alt='$status_gdesc' title='$status_gdesc'>
1318 <input type='hidden' name='ID' value='$id'>
1322 <td align='center' $col>
1323 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1324 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'edit'}'>
1325 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1326 <input type='hidden' name='ID' value='$id'>
1330 <td align='center' $col>
1331 <form method='post' name='$provider' action='$ENV{'SCRIPT_NAME'}'>
1332 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1333 <input type='hidden' name='ID' value='$id'>
1334 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'remove'}'>
1339 # Increment lines value.
1345 # Print notice that currently no hosts are ignored.
1347 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1353 # Section to add new elements or edit existing ones.
1360 <table width='100%'>
1361 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1365 # Only show this button if a ruleset provider is configured.
1366 if (%used_providers) {
1367 print "<input type='submit' name='RULESET' value='$Lang::tr{'ids customize ruleset'}'>\n";
1370 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids add provider'}'>
1377 &Header
::closebox
();
1380 # Whitelist / Ignorelist
1382 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ignored hosts'});
1385 <table width='100%'>
1387 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
1388 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
1389 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1392 # Check if some hosts have been added to be ignored.
1393 if (keys (%ignored)) {
1396 # Loop through all entries of the hash.
1397 while( (my $key) = each %ignored) {
1398 # Assign data array positions to some nice variable names.
1399 my $address = $ignored{$key}[0];
1400 my $remark = $ignored{$key}[1];
1401 my $status = $ignored{$key}[2];
1403 # Check if the key (id) number is even or not.
1404 if ($cgiparams{'ID'} eq $key) {
1405 $col="bgcolor='${Header::colouryellow}'";
1406 } elsif ($key % 2) {
1407 $col="bgcolor='$color{'color22'}'";
1409 $col="bgcolor='$color{'color20'}'";
1412 # Choose icon for the checkbox.
1416 # Check if the status is enabled and select the correct image and description.
1417 if ($status eq 'enabled' ) {
1419 $gdesc = $Lang::tr
{'click to disable'};
1422 $gdesc = $Lang::tr
{'click to enable'};
1427 <td width='20%' class='base' $col>$address</td>
1428 <td width='65%' class='base' $col>$remark</td>
1430 <td align='center' $col>
1431 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1432 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}'>
1433 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc'>
1434 <input type='hidden' name='ID' value='$key'>
1438 <td align='center' $col>
1439 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1440 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}'>
1441 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1442 <input type='hidden' name='ID' value='$key'>
1446 <td align='center' $col>
1447 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
1448 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1449 <input type='hidden' name='ID' value='$key'>
1450 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
1457 # Print notice that currently no hosts are ignored.
1459 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1465 # Section to add new elements or edit existing ones.
1471 <div align='center'>
1472 <table width='100%'>
1475 # Assign correct headline and button text.
1480 # Check if an ID (key) has been given, in this case an existing entry should be edited.
1481 if ($cgiparams{'ID'} ne '') {
1482 $buttontext = $Lang::tr
{'update'};
1483 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
1485 # Grab address and remark for the given key.
1486 $entry_address = $ignored{$cgiparams{'ID'}}[0];
1487 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
1489 $buttontext = $Lang::tr
{'add'};
1490 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
1494 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1495 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1497 <td width='30%'>$Lang::tr{'ip address'}: </td>
1498 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
1500 <td width='30%'>$Lang::tr{'remark'}: </td>
1501 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
1502 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
1509 &Header
::closebox
();
1513 ## Function to show the customize ruleset section.
1515 sub show_customize_ruleset
() {
1519 # Java script variable declaration for show and hide.
1520 print"var show = \"$Lang::tr{'ids show'}\"\;\n";
1521 print"var hide = \"$Lang::tr{'ids hide'}\"\;\n";
1524 // Tiny java script function to show/hide the rules
1525 // of a given category.
1526 function showhide(tblname) {
1527 \$("#" + tblname).toggle();
1529 // Get current content of the span element.
1530 var content = document.getElementById("span_" + tblname);
1532 if (content.innerHTML === show) {
1533 content.innerHTML = hide;
1535 content.innerHTML = show;
1541 &Header
::openbox
('100%', 'LEFT', "$Lang::tr{'intrusion detection system rules'}" );
1542 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
1544 # Output display table for rule files
1545 print "<table width='100%'>\n";
1547 # Loop over each rule file
1548 foreach my $rulefile (sort keys(%idsrules)) {
1549 my $rulechecked = '';
1551 # Check if rule file is enabled
1552 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
1553 $rulechecked = 'CHECKED';
1556 # Convert rulefile name into category name.
1557 my $categoryname = &_rulefile_to_category
($rulefile);
1559 # Table and rows for the rule files.
1561 print"<td class='base' width='5%'>\n";
1562 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
1564 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
1565 print"<td class='base' width='5%' align='right'>\n";
1566 print"<a href=\"javascript:showhide('$categoryname')\"><span id='span_$categoryname'>$Lang::tr{'ids show'}</span></a>\n";
1570 # Rows which will be hidden per default and will contain the single rules.
1571 print"<tr style='display:none' id='$categoryname'>\n";
1572 print"<td colspan='3'>\n";
1579 # New table for the single rules.
1580 print "<table width='100%'>\n";
1582 # Loop over rule file rules
1583 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
1585 my $ruledefchecked = '';
1587 # Skip rulefile itself.
1588 next if ($sid eq "Rulefile");
1590 # If 2 rules have been displayed, start a new row
1591 if (($lines % 2) == 0) {
1592 print "</tr><tr>\n";
1594 # Increase rows by once.
1600 $col="bgcolor='$color{'color20'}'";
1602 $col="bgcolor='$color{'color22'}'";
1606 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
1607 $ruledefchecked = 'CHECKED';
1610 # Create rule checkbox and display rule description
1611 print "<td class='base' width='5%' align='right' $col>\n";
1612 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
1614 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1616 # Increment rule count
1620 # If do not have a second rule for row, create empty cell
1621 if (($lines % 2) != 0) {
1622 print "<td class='base'></td>";
1625 # Close display table
1626 print "</tr></table></td></tr>";
1629 # Close display table
1633 <table width='100%'>
1635 <td width='100%' align='right'>
1636 <input type='submit' value='$Lang::tr{'fwhost back'}'>
1637 <input type='submit' name='RULESET' value='$Lang::tr{'ids apply'}'>
1644 &Header
::closebox
();
1649 ## Function to show section for add/edit a provider.
1651 sub show_add_provider
() {
1652 my %used_providers = ();
1653 my @subscription_providers;
1655 # Read -in providers settings file.
1656 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
1658 # Get all supported ruleset providers.
1659 my @ruleset_providers = &IDS
::get_ruleset_providers
();
1664 # Generate Java Script Object which contains the URL of the providers.
1665 print "\t// Object, which contains the webpages of the ruleset providers.\n";
1666 print "\tvar url = {\n";
1668 # Loop through the array of supported providers.
1669 foreach my $provider (@ruleset_providers) {
1670 # Check if the provider requires a subscription.
1671 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
1672 # Add the provider to the array of subscription_providers.
1673 push(@subscription_providers, $provider);
1676 # Grab the URL for the provider.
1677 my $url = $IDS::Ruleset
::Providers
{$provider}{'website'};
1679 # Print the URL to the Java Script Object.
1680 print "\t\t$provider: \"$url\"\,\n";
1683 # Close the Java Script Object declaration.
1686 # Generate Java Script Array which contains the provider that requires a subscription.
1688 $line = join("', '", @subscription_providers);
1690 print "\t// Array which contains the providers that requires a subscription.\n";
1691 print "\tsubscription_provider = ['$line']\;\n\n";
1694 // Java Script function to swap the text input field for
1695 // entering a subscription code.
1696 var update_provider = function() {
1697 if(inArray(\$('#PROVIDER').val(), subscription_provider)) {
1698 \$('.subscription_code').show();
1700 \$('.subscription_code').hide();
1703 // Call function to change the website url.
1704 change_url(\$('#PROVIDER').val());
1707 // Java Script function to check if a given value is part of
1709 function inArray(value,array) {
1710 var count=array.length;
1712 for(var i=0;i<count;i++) {
1713 if(array[i]===value){
1721 // Tiny function to change the website url based on the selected element in the "PROVIDERS"
1723 function change_url(provider) {
1724 // Get and change the href to the corresponding url.
1725 document.getElementById("website").href = url[provider];
1728 // JQuery function to call corresponding function when
1729 // the ruleset provider is changed or the page is loaded for showing/hiding
1730 // the subscription_code area.
1731 \$(document).ready(function() {
1732 \$('#PROVIDER').change(update_provider);
1740 # Check if an existing provider should be edited.
1741 if($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1742 # Check if autoupdate is enabled for this provider.
1743 if ($used_providers{$cgiparams{'ID'}}[2] eq "enabled") {
1744 # Set the checkbox to be checked.
1745 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1748 # Display section to force an rules update and to reset the provider.
1749 &show_additional_provider_actions
();
1751 } elsif ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'ids add provider'}") {
1752 # Set the autoupdate to true as default.
1753 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1756 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids provider settings'});
1759 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1760 <table width='100%' border='0'>
1762 <td colspan='2'><b>$Lang::tr{'ids provider'}</b></td>
1767 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1770 # Value to allow disabling the dropdown menu.
1773 # Check if we are in edit mode.
1774 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1775 $disabled = "disabled";
1777 # Add hidden input with the provider because the disable select does not provider
1779 print "<input type='hidden' name='PROVIDER' value='$used_providers{$cgiparams{'ID'}}[0]'>\n";
1782 print "<select name='PROVIDER' id='PROVIDER' $disabled>\n";
1783 # Temporary hash to store the provier names and their handles.
1786 # Loop through the array of ruleset providers.
1787 foreach my $handle (@ruleset_providers) {
1788 # Get the provider name.
1789 my $name = &get_provider_name
($handle);
1791 # Add the grabbed provider name and handle to the
1793 $tmphash{$name} = "$handle";
1796 # Sort and loop through the temporary hash.
1797 foreach my $provider_name ( sort keys %tmphash ) {
1798 # Grab the provider handle.
1799 my $provider = $tmphash{$provider_name};
1801 # Pre-select the provider if one is given.
1802 if (($used_providers{$cgiparams{'ID'}}[0] eq "$provider") || ($cgiparams{'PROVIDER'} eq "$provider")) {
1803 $selected{$provider} = "selected='selected'";
1806 # Add the provider to the dropdown menu.
1807 print "<option value='$provider' $selected{$provider}>$provider_name</option>\n";
1814 <b><a id="website" target="_blank" href="#">$Lang::tr{'ids visit provider website'}</a></b>
1819 <td colspan='2'><br><br></td>
1822 <tr class='subscription_code' style='display:none' id='subscription_code'>
1827 <b>$Lang::tr{'subscription code'}</b>
1833 <input type='text' size='40' name='SUBSCRIPTION_CODE' value='$used_providers{$cgiparams{'ID'}}[1]'>
1846 <input type='checkbox' name='ENABLE_AUTOUPDATE' $checked{'ENABLE_AUTOUPDATE'}> $Lang::tr{'ids enable automatic updates'}
1851 <td colspan='2' align='right'>
1852 <input type='submit' value='$Lang::tr{'back'}'>
1855 # Check if a provider should be added or edited.
1856 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1857 # Display button for updating the existing provider.
1858 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'update'}'>\n";
1860 # Display button to add the new provider.
1861 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'add'}'>\n";
1870 &Header
::closebox
();
1874 ## Function to show the area where additional provider actions can be done.
1876 sub show_additional_provider_actions
() {
1878 my %used_providers = ();
1880 # Read-in providers settings file.
1881 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
1883 # Assign variable for provider handle.
1884 my $provider = "$used_providers{$cgiparams{'ID'}}[0]";
1886 # Call function to get the path and name for the given providers
1887 # oinkmaster modified sids file.
1888 my $provider_modified_sids_file = &IDS
::get_oinkmaster_provider_modified_sids_file
($provider);
1890 # Disable the reset provider button if no provider modified sids file exists.
1891 unless (-f
$provider_modified_sids_file) {
1892 $disabled = "disabled";
1895 &Header
::openbox
('100%', 'center', "");
1897 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1898 <table width='100%' border="0">
1901 <input type='hidden' name='PROVIDER' value='$provider'>
1902 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids reset provider'}' $disabled>
1903 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids force ruleset update'}'>
1910 &Header
::closebox
();
1914 ## A function to display a notice, to lock the webpage and
1915 ## tell the user which action currently will be performed.
1917 sub working_notice
($) {
1920 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
1921 &Header
::openbigbox
('100%', 'left', '', $errormessage);
1922 &Header
::openbox
( 'Waiting', 1,);
1926 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
1931 &Header
::closebox
();
1932 &Header
::closebigbox
();
1933 &Header
::closepage
();
1937 ## A tiny function to perform a reload of the webpage after one second.
1940 print "<meta http-equiv='refresh' content='1'>\n";
1947 ## Private function to read-in and parse rules of a given rulefile.
1949 ## The given file will be read, parsed and all valid rules will be stored by ID,
1950 ## message/description and it's state in the idsrules hash.
1952 sub readrulesfile
($) {
1953 my $rulefile = shift;
1955 # Open rule file and read in contents
1956 open(RULEFILE
, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
1958 # Store file content in an array.
1959 my @lines = <RULEFILE
>;
1964 # Loop over rule file contents
1965 foreach my $line (@lines) {
1966 # Remove whitespaces.
1970 next if ($line =~ /^\s*$/);
1976 # Gather rule sid and message from the ruleline.
1977 if ($line =~ m/.*msg:\s*\"(.*?)\"\;.*sid:\s*(.*?); /) {
1981 # Check if a rule has been found.
1983 # Add rule to the idsrules hash.
1984 $idsrules{$rulefile}{$sid}{'Description'} = $msg;
1986 # Grab status of the rule. Check if ruleline starts with a "dash".
1987 if ($line =~ /^\#/) {
1988 # If yes, the rule is disabled.
1989 $idsrules{$rulefile}{$sid}{'State'} = "off";
1991 # Otherwise the rule is enabled.
1992 $idsrules{$rulefile}{$sid}{'State'} = "on";
2000 ## Function to get the used memory of a given process-id.
2002 sub get_memory_usage
($) {
2007 # Try to open the status file for the given process-id on the pseudo
2009 if (open(FILE
, "/proc/$pid/status")) {
2010 # Loop through the entire file.
2012 # Splitt current line content and store them into variables.
2013 my ($key, $value) = split(":", $_, 2);
2015 # Check if the current key is the one which contains the memory usage.
2016 # The wanted one is VmRSS which contains the Real-memory (resident set)
2017 # of the entire process.
2018 if ($key eq "VmRSS") {
2019 # Found the memory usage add it to the memory variable.
2027 # Close file handle.
2030 # Return memory usage.
2034 # If the file could not be open, return nothing.
2039 ## Function to get the provider handle by a given ID.
2041 sub get_provider_handle
($) {
2044 my %used_providers = ();
2046 # Read-in provider settings file.
2047 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
2049 # Obtain the provider handle for the given ID.
2050 my $provider_handle = $used_providers{$cgiparams{'ID'}}[0];
2052 # Return the handle.
2053 return $provider_handle;
2057 ## Function to get the provider name from the language file or providers file for a given handle.
2059 sub get_provider_name
($) {
2063 # Get the required translation string for the given provider handle.
2064 my $tr_string = $IDS::Ruleset
::Providers
{$handle}{'tr_string'};
2066 # Check if the translation string is available in the language files.
2067 if ($Lang::tr
{$tr_string}) {
2068 # Use the translated string from the language file.
2069 $provider_name = $Lang::tr
{$tr_string};
2071 # Fallback and use the provider summary from the providers file.
2072 $provider_name = $IDS::Ruleset
::Providers
{$handle}{'summary'};
2075 # Return the obtained provider name.
2076 return $provider_name;
2080 ## Function to remove a provider by a given ID.
2082 sub remove_provider
($) {
2085 my %used_providers = ();
2087 # Read-in provider settings file.
2088 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
2090 # Drop entry from the hash.
2091 delete($used_providers{$id});
2093 # Write the changed hash to the provider settings file.
2094 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
2098 ## Private function to convert a given rulefile to a category name.
2099 ## ( No file extension anymore and if the name contained a dot, it
2100 ## would be replaced by a underline sign.)
2102 sub _rulefile_to_category
($) {
2103 my ($filename) = @_;
2105 # Splitt the filename into single chunks and store them in a
2107 my @parts = split(/\./, $filename);
2109 # Return / Remove last element of the temporary array.
2110 # This removes the file extension.
2113 # Join together the single elements of the temporary array.
2114 # If these are more than one, use a "underline" for joining.
2115 my $category = join '_', @parts;
2117 # Return the converted filename.