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 # Check if any rulesfiles have been found for this provider.
467 if (@provider_rulefiles) {
468 # Call function and write the providers used rulesfile file.
469 &IDS
::write_used_provider_rulefiles_file
($provider, @provider_rulefiles);
474 # Call function to generate and write the used rulefiles file.
475 &IDS
::write_main_used_rulefiles_file
(@enabled_providers);
477 # Lock the webpage and print message.
478 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
480 # Call oinkmaster to alter the ruleset.
483 # Check if the IDS is running.
484 if(&IDS
::ids_is_running
()) {
485 # Check if a restart of suricata is required.
486 if ($suricata_restart_required) {
487 # Call suricatactrl to perform the restart.
488 &IDS
::call_suricatactrl
("restart");
490 # Call suricatactrl to perform a reload.
491 &IDS
::call_suricatactrl
("reload");
498 # Download new ruleset.
499 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'ids force ruleset update'}) {
500 # Assign given provider handle.
501 my $provider = $cgiparams{'PROVIDER'};
503 # Check if the red device is active.
504 unless (-e
"${General::swroot}/red/active") {
505 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
508 # Check if enought free disk space is availabe.
509 if(&IDS
::checkdiskspace
()) {
510 $errormessage = "$Lang::tr{'not enough disk space'}";
513 # Check if any errors happend.
514 unless ($errormessage) {
515 # Lock the webpage and print notice about downloading
517 &working_notice
("$Lang::tr{'ids download new ruleset'}");
519 # Call subfunction to download the ruleset.
520 if(&IDS
::downloadruleset
($provider)) {
521 $errormessage = $Lang::tr
{'could not download latest updates'};
523 # Call function to store the errormessage.
524 &IDS
::_store_error_message
($errormessage);
526 # Preform a reload of the page.
529 # Call subfunction to launch oinkmaster.
532 # Check if the IDS is running.
533 if(&IDS
::ids_is_running
()) {
534 # Call suricatactrl to perform a reload.
535 &IDS
::call_suricatactrl
("reload");
538 # Perform a reload of the page.
543 # Reset a provider to it's defaults.
544 } elsif ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'ids reset provider'}") {
545 # Grab provider handle from cgihash.
546 my $provider = $cgiparams{'PROVIDER'};
548 # Lock the webpage and print message.
549 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
551 # Create new empty file for used rulefiles
553 &IDS
::write_used_provider_rulefiles_file
($provider);
555 # Call function to get the path and name for the given providers
556 # oinkmaster modified sids file.
557 my $provider_modified_sids_file = &IDS
::get_oinkmaster_provider_modified_sids_file
($provider);
559 # Check if the file exists.
560 if (-f
$provider_modified_sids_file) {
561 # Remove the file, as requested.
562 unlink("$provider_modified_sids_file");
565 # Alter the oinkmaster provider includes file and remove the provider.
566 &IDS
::alter_oinkmaster_provider_includes_file
("remove", $provider);
568 # Regenerate ruleset.
571 # Check if the IDS is running.
572 if(&IDS
::ids_is_running
()) {
573 # Get enabled providers.
574 my @enabled_providers = &IDS
::get_enabled_providers
();
576 # Get amount of enabled providers.
577 my $amount = @enabled_providers;
579 # Check if at least one enabled provider remains.
581 # Call suricatactrl to perform a reload.
582 &IDS
::call_suricatactrl
("restart");
584 # Stop suricata if no enabled provider remains.
586 # Call suricatactrel to perform the stop.
587 &IDS
::call_suricatactrl
("stop");
591 # Undefine providers flag.
592 undef($cgiparams{'PROVIDERS'});
598 } elsif ($cgiparams{'IDS'} eq $Lang::tr
{'save'}) {
601 my $monitored_zones = 0;
603 # Read-in current (old) IDS settings.
604 &General
::readhash
("$IDS::ids_settings_file", \
%oldidssettings);
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 # Get enabled providers.
612 my @enabled_providers = &IDS
::get_enabled_providers
();
614 # Check if any ruleset is available. Otherwise abort and display an error.
615 unless(@enabled_providers) {
616 $errormessage = $Lang::tr
{'ids no enabled ruleset provider'};
619 # Loop through the array of available interfaces.
620 foreach my $zone (@network_zones) {
621 # Convert interface name into upper case.
622 my $zone_upper = uc($zone);
624 # Check if the IDS is enabled for this interaces.
625 if ($cgiparams{"ENABLE_IDS_$zone_upper"}) {
631 # Check if at least one zone should be monitored, or show an error.
632 unless ($monitored_zones >= 1) {
633 $errormessage = $Lang::tr
{'ids no network zone'};
637 # Go on if there are no error messages.
638 if (!$errormessage) {
639 # Store settings into settings file.
640 &General
::writehash
("$IDS::ids_settings_file", \
%cgiparams);
643 # Check if the the automatic rule update hass been touched.
644 if($cgiparams{'AUTOUPDATE_INTERVAL'} ne $oldidssettings{'AUTOUPDATE_INTERVAL'}) {
645 # Call suricatactrl to set the new interval.
646 &IDS
::call_suricatactrl
("cron", $cgiparams{'AUTOUPDATE_INTERVAL'});
649 # Generate file to store the home net.
650 &IDS
::generate_home_net_file
();
652 # Generate file to the store the DNS servers.
653 &IDS
::generate_dns_servers_file
();
655 # Generate file to store the HTTP ports.
656 &IDS
::generate_http_ports_file
();
658 # Write the modify sid's file and pass the taken ruleaction.
659 &IDS
::write_modify_sids_file
();
661 # Check if "MONITOR_TRAFFIC_ONLY" has been changed.
662 if($cgiparams{'MONITOR_TRAFFIC_ONLY'} ne $oldidssettings{'MONITOR_TRAFFIC_ONLY'}) {
663 # Check if a ruleset exists.
664 if (%used_providers) {
665 # Lock the webpage and print message.
666 &working_notice
("$Lang::tr{'ids working'}");
668 # Call oinkmaster to alter the ruleset.
671 # Set reload_page to "True".
676 # Check if the IDS currently is running.
677 if(&IDS
::ids_is_running
()) {
678 # Check if ENABLE_IDS is set to on.
679 if($cgiparams{'ENABLE_IDS'} eq "on") {
680 # Call suricatactrl to perform a reload of suricata.
681 &IDS
::call_suricatactrl
("reload");
683 # Call suricatactrl to stop suricata.
684 &IDS
::call_suricatactrl
("stop");
687 # Call suricatactrl to start suricata.
688 &IDS
::call_suricatactrl
("start");
691 # Check if the page should be reloaded.
693 # Perform a reload of the page.
697 # Toggle Enable/Disable autoupdate for a provider
698 } elsif ($cgiparams{'AUTOUPDATE'} eq $Lang::tr
{'toggle enable disable'}) {
699 my %used_providers = ();
701 # Only go further, if an ID has been passed.
702 if ($cgiparams{'ID'}) {
703 # Assign the given ID.
704 my $id = $cgiparams{'ID'};
706 # Undef the given ID.
707 undef($cgiparams{'ID'});
709 # Read-in providers settings file.
710 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
712 # Grab the configured status of the corresponding entry.
713 my $status_autoupdate = $used_providers{$id}[2];
716 if ($status_autoupdate eq "disabled") {
717 $status_autoupdate = "enabled";
719 $status_autoupdate = "disabled";
722 # Modify the status of the existing entry.
723 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$status_autoupdate", "$used_providers{$id}[3]"];
725 # Write the changed hash to the providers settings file.
726 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
729 # Add/Edit a provider to the list of used providers.
731 } elsif (($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") || ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'update'}")) {
732 my %used_providers = ();
734 # Read-in providers settings file.
735 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
737 # Assign some nice human-readable values.
738 my $provider = $cgiparams{'PROVIDER'};
739 my $subscription_code = $cgiparams{'SUBSCRIPTION_CODE'};
740 my $status_autoupdate;
742 # Handle autoupdate checkbox.
743 if ($cgiparams{'ENABLE_AUTOUPDATE'} eq "on") {
744 $status_autoupdate = "enabled";
746 $status_autoupdate = "disabled";
749 # Check if we are going to add a new provider.
750 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") {
751 # Loop through the hash of used providers.
752 foreach my $id ( keys %used_providers) {
753 # Check if the choosen provider is already in use.
754 if ($used_providers{$id}[0] eq "$provider") {
755 # Assign error message.
756 $errormessage = "$Lang::tr{'ids the choosen provider is already in use'}";
761 # Check if the provider requires a subscription code.
762 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
763 # Check if an subscription code has been provided.
764 if ($subscription_code) {
765 # Check if the code contains unallowed chars.
766 unless ($subscription_code =~ /^[a-z0-9]+$/) {
767 $errormessage = $Lang::tr
{'invalid input for subscription code'};
770 # Print an error message, that an subsription code is required for this
772 $errormessage = $Lang::tr
{'ids subscription code required'};
776 # Go further if there was no error.
777 if ($errormessage eq '') {
781 # Check if we should edit an existing entry and got an ID.
782 if (($cgiparams{'PROVIDERS'} eq $Lang::tr
{'update'}) && ($cgiparams{'ID'})) {
783 # Assin the provided id.
784 $id = $cgiparams{'ID'};
786 # Undef the given ID.
787 undef($cgiparams{'ID'});
789 # Grab the configured status of the corresponding entry.
790 $status = $used_providers{$id}[3];
792 # Each newly added entry automatically should be enabled.
795 # Generate the ID for the new entry.
797 # Sort the keys by their ID and store them in an array.
798 my @keys = sort { $a <=> $b } keys %used_providers;
800 # Reverse the key array.
801 my @reversed = reverse(@keys);
803 # Obtain the last used id.
804 my $last_id = @reversed[0];
806 # Increase the last id by one and use it as id for the new entry.
810 # Add/Modify the entry to/in the used providers hash..
811 $used_providers{$id} = ["$provider", "$subscription_code", "$status_autoupdate", "$status"];
813 # Write the changed hash to the providers settings file.
814 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
816 # Check if a new provider will be added.
817 if ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'add'}) {
818 # Lock the webpage and print notice about downloading
820 &working_notice
("$Lang::tr{'ids working'}");
822 # Download the ruleset.
823 &IDS
::downloadruleset
($provider);
825 # Extract the ruleset
826 &IDS
::extractruleset
($provider);
829 &IDS
::move_tmp_ruleset
();
831 # Cleanup temporary directory.
832 &IDS
::cleanup_tmp_directory
();
834 # Create new empty file for used rulefiles
836 &IDS
::write_used_provider_rulefiles_file
($provider);
838 # Perform a reload of the page.
842 # Undefine providers flag.
843 undef($cgiparams{'PROVIDERS'});
846 ## Toggle Enabled/Disabled for an existing provider.
848 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'toggle enable disable'}) {
849 my %used_providers = ();
850 my $provider_includes_action;
852 # Only go further, if an ID has been passed.
853 if ($cgiparams{'ID'}) {
854 # Assign the given ID.
855 my $id = $cgiparams{'ID'};
857 # Undef the given ID.
858 undef($cgiparams{'ID'});
860 # Read-in file which contains the provider settings.
861 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
863 # Grab the configured status of the corresponding entry.
864 my $status = $used_providers{$id}[3];
866 # Grab the provider handle.
867 my $provider_handle = $used_providers{$id}[0];
870 if ($status eq "enabled") {
871 $status = "disabled";
873 # Set the provider includes action to "remove" for removing the entry.
874 $provider_includes_action = "remove";
878 # Set the provider includes action to "add".
879 $provider_includes_action = "add";
882 # Modify the status of the existing entry.
883 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$used_providers{$id}[2]", "$status"];
885 # Write the changed hash to the providers settings file.
886 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
888 # Get all enabled providers.
889 my @enabled_providers = &IDS
::get_enabled_providers
();
891 # Write the main providers include file.
892 &IDS
::write_main_used_rulefiles_file
(@enabled_providers);
894 # Call function to alter the oinkmasters provider includes file and
895 # add or remove the provider.
896 &IDS
::alter_oinkmaster_provider_includes_file
($provider_includes_action, $provider_handle);
898 # Check if the IDS is running.
899 if(&IDS
::ids_is_running
()) {
900 # Gather the amount of enabled providers (elements in the array).
901 my $amount = @enabled_providers;
903 # Check if there are still enabled ruleset providers.
905 # Call suricatactrl to perform a restart.
906 &IDS
::call_suricatactrl
("restart");
908 # No active ruleset provider, suricata has to be stopped.
911 &IDS
::call_suricatactrl
("stop");
915 # Undefine providers flag.
916 undef($cgiparams{'PROVIDERS'});
919 ## Remove provider from the list of used providers.
921 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'remove'}) {
922 my %used_providers = ();
924 # Read-in provider settings file.
925 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
927 # Grab the provider name bevore deleting it from hash.
928 my $provider = $used_providers{$cgiparams{'ID'}}[0];
930 # Drop entry from the hash.
931 delete($used_providers{$cgiparams{'ID'}});
933 # Undef the given ID.
934 undef($cgiparams{'ID'});
936 # Write the changed hash to the provide settings file.
937 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
939 # Lock the webpage and print message.
940 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
942 # Drop the stored ruleset file.
943 &IDS
::drop_dl_rulesfile
($provider);
945 # Get the name of the provider rulessets include file.
946 my $provider_used_rulefile = &IDS
::get_used_provider_rulesfile_file
($provider);
948 # Drop the file, it is not longer needed.
949 unlink("$provider_used_rulefile");
951 # Call function to get the path and name for the given providers
952 # oinkmaster modified sids file.
953 my $provider_modified_sids_file = &IDS
::get_oinkmaster_provider_modified_sids_file
($provider);
955 # Check if the file exists.
956 if (-f
$provider_modified_sids_file) {
957 # Remove the file, which is not longer needed.
958 unlink("$provider_modified_sids_file");
961 # Alter the oinkmaster provider includes file and remove the provider.
962 &IDS
::alter_oinkmaster_provider_includes_file
("remove", $provider);
964 # Regenerate ruleset.
967 # Gather all enabled providers.
968 my @enabled_providers = &IDS
::get_enabled_providers
();
970 # Regenerate main providers include file.
971 &IDS
::write_main_used_rulefiles_file
(@enabled_providers);
973 # Check if the IDS is running.
974 if(&IDS
::ids_is_running
()) {
975 # Get amount of enabled providers.
976 my $amount = @enabled_providers;
978 # Check if at least one enabled provider remains.
980 # Call suricatactrl to perform a reload.
981 &IDS
::call_suricatactrl
("restart");
983 # Stop suricata if no enabled provider remains.
985 # Call suricatactrel to perform the stop.
986 &IDS
::call_suricatactrl
("stop");
990 # Undefine providers flag.
991 undef($cgiparams{'PROVIDERS'});
997 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
999 &Header
::openbigbox
('100%', 'left', '', $errormessage);
1001 &show_display_error_message
();
1003 if ($cgiparams{'RULESET'} eq "$Lang::tr{'ids customize ruleset'}" ) {
1004 &show_customize_ruleset
();
1005 } elsif ($cgiparams{'PROVIDERS'} ne "") {
1006 &show_add_provider
();
1011 &Header
::closebigbox
();
1012 &Header
::closepage
();
1015 ## Tiny function to show if a error message happened.
1017 sub show_display_error_message
() {
1018 if ($errormessage) {
1019 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
1020 print "<class name='base'>$errormessage\n";
1021 print " </class>\n";
1022 &Header
::closebox
();
1027 ## Function to display the main IDS page.
1029 sub show_mainpage
() {
1030 # Read-in idssettings and provider settings.
1031 &General
::readhash
("$IDS::ids_settings_file", \
%idssettings);
1032 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
1034 # If no autoupdate intervall has been configured yet, set default value.
1035 unless(exists($idssettings{'AUTOUPDATE_INTERVAL'})) {
1036 # Set default to "weekly".
1037 $idssettings{'AUTOUPDATE_INTERVAL'} = 'weekly';
1040 # Read-in ignored hosts.
1041 &General
::readhasharray
("$IDS::settingsdir/ignored", \
%ignored);
1043 $checked{'ENABLE_IDS'}{'off'} = '';
1044 $checked{'ENABLE_IDS'}{'on'} = '';
1045 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
1046 $checked{'MONITOR_TRAFFIC_ONLY'}{'off'} = '';
1047 $checked{'MONITOR_TRAFFIC_ONLY'}{'on'} = '';
1048 $checked{'MONITOR_TRAFFIC_ONLY'}{$idssettings{'MONITOR_TRAFFIC_ONLY'}} = "checked='checked'";
1049 $selected{'AUTOUPDATE_INTERVAL'}{'off'} = '';
1050 $selected{'AUTOUPDATE_INTERVAL'}{'daily'} = '';
1051 $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} = '';
1052 $selected{'AUTOUPDATE_INTERVAL'}{$idssettings{'AUTOUPDATE_INTERVAL'}} = "selected='selected'";
1054 # Draw current state of the IDS
1055 &Header
::openbox
('100%', 'left', $Lang::tr
{'intrusion detection system'});
1057 # Check if the IDS is running and obtain the process-id.
1058 my $pid = &IDS
::ids_is_running
();
1060 # Display some useful information, if suricata daemon is running.
1062 # Gather used memory.
1063 my $memory = &get_memory_usage
($pid);
1066 <table width='95%' cellspacing='0' class='tbl'>
1068 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1072 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1073 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
1077 <td class='base'></td>
1078 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
1079 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
1083 <td class='base'></td>
1084 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
1085 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
1090 # Otherwise display a hint that the service is not launched.
1092 <table width='95%' cellspacing='0' class='tbl'>
1094 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1098 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1099 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
1105 # Only show this area, if at least one ruleset provider is configured.
1106 if (%used_providers) {
1110 <br><br><h2>$Lang::tr{'settings'}</h2>
1112 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1113 <table width='100%' border='0'>
1115 <td class='base' colspan='2'>
1116 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}> $Lang::tr{'ids enable'}
1119 <td class='base' colspan='2'>
1120 <input type='checkbox' name='MONITOR_TRAFFIC_ONLY' $checked{'MONITOR_TRAFFIC_ONLY'}{'on'}> $Lang::tr{'ids monitor traffic only'}
1132 <td colspan='4'><b>$Lang::tr{'ids monitored interfaces'}</b><br></td>
1139 # Loop through the array of available networks and print config options.
1140 foreach my $zone (@network_zones) {
1142 my $checked_forward;
1144 # Convert current zone name to upper case.
1145 my $zone_upper = uc($zone);
1148 my $zone_name = $zone;
1150 # Dirty hack to get the correct language string for the red zone.
1151 if ($zone eq "red") {
1152 $zone_name = "red1";
1155 # Grab checkbox status from settings hash.
1156 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
1157 $checked_input = "checked = 'checked'";
1160 print "<td class='base' width='20%'>\n";
1161 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>\n";
1162 print " $Lang::tr{'enabled on'}<font color='$colourhash{$zone}'> $Lang::tr{$zone_name}</font>\n";
1177 <td colspan='4'><b>$Lang::tr{'ids automatic rules update'}</b></td>
1182 <select name='AUTOUPDATE_INTERVAL'>
1183 <option value='off' $selected{'AUTOUPDATE_INTERVAL'}{'off'} >- $Lang::tr{'Disabled'} -</option>
1184 <option value='daily' $selected{'AUTOUPDATE_INTERVAL'}{'daily'} >$Lang::tr{'Daily'}</option>
1185 <option value='weekly' $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} >$Lang::tr{'Weekly'}</option>
1193 <table width='100%'>
1195 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
1204 &Header
::closebox
();
1207 # Used Ruleset Providers section.
1209 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ruleset settings'});
1212 <table width='100%' border='0'>
1214 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ids provider'}</b></td>
1215 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'date'}</b></td>
1216 <td class='base' bgcolor='$color{'color20'}' align='center'><b>$Lang::tr{'ids autoupdates'}</b></td>
1217 <td class='base' bgcolor='$color{'color20'}'></td>
1218 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1223 # Check if some providers has been configured.
1224 if (keys (%used_providers)) {
1227 # Loop through all entries of the hash.
1228 foreach my $id (sort keys(%used_providers)) {
1229 # Assign data array positions to some nice variable names.
1230 my $provider = $used_providers{$id}[0];
1231 my $provider_name = &get_provider_name
($provider);
1232 my $rulesetdate = &IDS
::get_ruleset_date
($provider);
1234 my $subscription_code = $used_providers{$id}[1];
1235 my $autoupdate_status = $used_providers{$id}[2];
1236 my $status = $used_providers{$id}[3];
1238 # Check if the item number is even or not.
1240 $col="bgcolor='$color{'color22'}'";
1242 $col="bgcolor='$color{'color20'}'";
1245 # Choose icons for the checkboxes.
1248 my $autoupdate_status_gif;
1249 my $autoupdate_status_gdesc;
1251 # Check if the status is enabled and select the correct image and description.
1252 if ($status eq 'enabled' ) {
1253 $status_gif = 'on.gif';
1254 $status_gdesc = $Lang::tr
{'click to disable'};
1256 $status_gif = 'off.gif';
1257 $status_gdesc = $Lang::tr
{'click to enable'};
1260 # Check if the autoupdate status is enabled and select the correct image and description.
1261 if ($autoupdate_status eq 'enabled') {
1262 $autoupdate_status_gif = 'on.gif';
1263 $autoupdate_status_gdesc = $Lang::tr
{'click to disable'};
1265 $autoupdate_status_gif = 'off.gif';
1266 $autoupdate_status_gdesc = $Lang::tr
{'click to enable'};
1271 <td width='33%' class='base' $col>$provider_name</td>
1272 <td width='30%' class='base' $col>$rulesetdate</td>
1274 <td align='center' $col>
1275 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1276 <input type='hidden' name='AUTOUPDATE' value='$Lang::tr{'toggle enable disable'}' />
1277 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$autoupdate_status_gif' alt='$autoupdate_status_gdesc' title='$autoupdate_status_gdesc' />
1278 <input type='hidden' name='ID' value='$id' />
1282 <td align='center' $col>
1283 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1284 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'toggle enable disable'}'>
1285 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$status_gif' alt='$status_gdesc' title='$status_gdesc'>
1286 <input type='hidden' name='ID' value='$id'>
1290 <td align='center' $col>
1291 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1292 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'edit'}'>
1293 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1294 <input type='hidden' name='ID' value='$id'>
1298 <td align='center' $col>
1299 <form method='post' name='$provider' action='$ENV{'SCRIPT_NAME'}'>
1300 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1301 <input type='hidden' name='ID' value='$id'>
1302 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'remove'}'>
1307 # Increment lines value.
1313 # Print notice that currently no hosts are ignored.
1315 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1321 # Section to add new elements or edit existing ones.
1328 <table width='100%'>
1329 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1333 # Only show this button if a ruleset provider is configured.
1334 if (%used_providers) {
1335 print "<input type='submit' name='RULESET' value='$Lang::tr{'ids customize ruleset'}'>\n";
1338 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids add provider'}'>
1345 &Header
::closebox
();
1348 # Whitelist / Ignorelist
1350 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ignored hosts'});
1353 <table width='100%'>
1355 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
1356 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
1357 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1360 # Check if some hosts have been added to be ignored.
1361 if (keys (%ignored)) {
1364 # Loop through all entries of the hash.
1365 while( (my $key) = each %ignored) {
1366 # Assign data array positions to some nice variable names.
1367 my $address = $ignored{$key}[0];
1368 my $remark = $ignored{$key}[1];
1369 my $status = $ignored{$key}[2];
1371 # Check if the key (id) number is even or not.
1372 if ($cgiparams{'ID'} eq $key) {
1373 $col="bgcolor='${Header::colouryellow}'";
1374 } elsif ($key % 2) {
1375 $col="bgcolor='$color{'color22'}'";
1377 $col="bgcolor='$color{'color20'}'";
1380 # Choose icon for the checkbox.
1384 # Check if the status is enabled and select the correct image and description.
1385 if ($status eq 'enabled' ) {
1387 $gdesc = $Lang::tr
{'click to disable'};
1390 $gdesc = $Lang::tr
{'click to enable'};
1395 <td width='20%' class='base' $col>$address</td>
1396 <td width='65%' class='base' $col>$remark</td>
1398 <td align='center' $col>
1399 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1400 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}'>
1401 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc'>
1402 <input type='hidden' name='ID' value='$key'>
1406 <td align='center' $col>
1407 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1408 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}'>
1409 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1410 <input type='hidden' name='ID' value='$key'>
1414 <td align='center' $col>
1415 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
1416 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1417 <input type='hidden' name='ID' value='$key'>
1418 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
1425 # Print notice that currently no hosts are ignored.
1427 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1433 # Section to add new elements or edit existing ones.
1439 <div align='center'>
1440 <table width='100%'>
1443 # Assign correct headline and button text.
1448 # Check if an ID (key) has been given, in this case an existing entry should be edited.
1449 if ($cgiparams{'ID'} ne '') {
1450 $buttontext = $Lang::tr
{'update'};
1451 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
1453 # Grab address and remark for the given key.
1454 $entry_address = $ignored{$cgiparams{'ID'}}[0];
1455 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
1457 $buttontext = $Lang::tr
{'add'};
1458 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
1462 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1463 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1465 <td width='30%'>$Lang::tr{'ip address'}: </td>
1466 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
1468 <td width='30%'>$Lang::tr{'remark'}: </td>
1469 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
1470 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
1477 &Header
::closebox
();
1481 ## Function to show the customize ruleset section.
1483 sub show_customize_ruleset
() {
1487 # Java script variable declaration for show and hide.
1488 print"var show = \"$Lang::tr{'ids show'}\"\;\n";
1489 print"var hide = \"$Lang::tr{'ids hide'}\"\;\n";
1492 // Tiny java script function to show/hide the rules
1493 // of a given category.
1494 function showhide(tblname) {
1495 \$("#" + tblname).toggle();
1497 // Get current content of the span element.
1498 var content = document.getElementById("span_" + tblname);
1500 if (content.innerHTML === show) {
1501 content.innerHTML = hide;
1503 content.innerHTML = show;
1509 &Header
::openbox
('100%', 'LEFT', "$Lang::tr{'intrusion detection system rules'}" );
1510 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
1512 # Output display table for rule files
1513 print "<table width='100%'>\n";
1515 # Loop over each rule file
1516 foreach my $rulefile (sort keys(%idsrules)) {
1517 my $rulechecked = '';
1519 # Check if rule file is enabled
1520 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
1521 $rulechecked = 'CHECKED';
1524 # Convert rulefile name into category name.
1525 my $categoryname = &_rulefile_to_category
($rulefile);
1527 # Table and rows for the rule files.
1529 print"<td class='base' width='5%'>\n";
1530 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
1532 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
1533 print"<td class='base' width='5%' align='right'>\n";
1534 print"<a href=\"javascript:showhide('$categoryname')\"><span id='span_$categoryname'>$Lang::tr{'ids show'}</span></a>\n";
1538 # Rows which will be hidden per default and will contain the single rules.
1539 print"<tr style='display:none' id='$categoryname'>\n";
1540 print"<td colspan='3'>\n";
1547 # New table for the single rules.
1548 print "<table width='100%'>\n";
1550 # Loop over rule file rules
1551 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
1553 my $ruledefchecked = '';
1555 # Skip rulefile itself.
1556 next if ($sid eq "Rulefile");
1558 # If 2 rules have been displayed, start a new row
1559 if (($lines % 2) == 0) {
1560 print "</tr><tr>\n";
1562 # Increase rows by once.
1568 $col="bgcolor='$color{'color20'}'";
1570 $col="bgcolor='$color{'color22'}'";
1574 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
1575 $ruledefchecked = 'CHECKED';
1578 # Create rule checkbox and display rule description
1579 print "<td class='base' width='5%' align='right' $col>\n";
1580 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
1582 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1584 # Increment rule count
1588 # If do not have a second rule for row, create empty cell
1589 if (($lines % 2) != 0) {
1590 print "<td class='base'></td>";
1593 # Close display table
1594 print "</tr></table></td></tr>";
1597 # Close display table
1601 <table width='100%'>
1603 <td width='100%' align='right'>
1604 <input type='submit' value='$Lang::tr{'fwhost back'}'>
1605 <input type='submit' name='RULESET' value='$Lang::tr{'ids apply'}'>
1612 &Header
::closebox
();
1617 ## Function to show section for add/edit a provider.
1619 sub show_add_provider
() {
1620 my %used_providers = ();
1621 my @subscription_providers;
1623 # Read -in providers settings file.
1624 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
1626 # Get all supported ruleset providers.
1627 my @ruleset_providers = &IDS
::get_ruleset_providers
();
1632 # Generate Java Script Object which contains the URL of the providers.
1633 print "\t// Object, which contains the webpages of the ruleset providers.\n";
1634 print "\tvar url = {\n";
1636 # Loop through the array of supported providers.
1637 foreach my $provider (@ruleset_providers) {
1638 # Check if the provider requires a subscription.
1639 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
1640 # Add the provider to the array of subscription_providers.
1641 push(@subscription_providers, $provider);
1644 # Grab the URL for the provider.
1645 my $url = $IDS::Ruleset
::Providers
{$provider}{'website'};
1647 # Print the URL to the Java Script Object.
1648 print "\t\t$provider: \"$url\"\,\n";
1651 # Close the Java Script Object declaration.
1654 # Generate Java Script Array which contains the provider that requires a subscription.
1656 $line = join("', '", @subscription_providers);
1658 print "\t// Array which contains the providers that requires a subscription.\n";
1659 print "\tsubscription_provider = ['$line']\;\n\n";
1662 // Java Script function to swap the text input field for
1663 // entering a subscription code.
1664 var update_provider = function() {
1665 if(inArray(\$('#PROVIDER').val(), subscription_provider)) {
1666 \$('.subscription_code').show();
1668 \$('.subscription_code').hide();
1671 // Call function to change the website url.
1672 change_url(\$('#PROVIDER').val());
1675 // Java Script function to check if a given value is part of
1677 function inArray(value,array) {
1678 var count=array.length;
1680 for(var i=0;i<count;i++) {
1681 if(array[i]===value){
1689 // Tiny function to change the website url based on the selected element in the "PROVIDERS"
1691 function change_url(provider) {
1692 // Get and change the href to the corresponding url.
1693 document.getElementById("website").href = url[provider];
1696 // JQuery function to call corresponding function when
1697 // the ruleset provider is changed or the page is loaded for showing/hiding
1698 // the subscription_code area.
1699 \$(document).ready(function() {
1700 \$('#PROVIDER').change(update_provider);
1708 # Check if an existing provider should be edited.
1709 if($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1710 # Check if autoupdate is enabled for this provider.
1711 if ($used_providers{$cgiparams{'ID'}}[2] eq "enabled") {
1712 # Set the checkbox to be checked.
1713 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1716 # Display section to force an rules update and to reset the provider.
1717 &show_additional_provider_actions
();
1719 } elsif ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'ids add provider'}") {
1720 # Set the autoupdate to true as default.
1721 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1724 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids provider settings'});
1727 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1728 <table width='100%' border='0'>
1730 <td colspan='2'><b>$Lang::tr{'ids provider'}</b></td>
1735 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1738 # Value to allow disabling the dropdown menu.
1741 # Check if we are in edit mode.
1742 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1743 $disabled = "disabled";
1745 # Add hidden input with the provider because the disable select does not provider
1747 print "<input type='hidden' name='PROVIDER' value='$used_providers{$cgiparams{'ID'}}[0]'>\n";
1750 print "<select name='PROVIDER' id='PROVIDER' $disabled>\n";
1751 # Loop through the array of ruleset providers.
1752 foreach my $provider (@ruleset_providers) {
1753 # Get the provider name.
1754 my $provider_name = &get_provider_name
($provider);
1756 # Pre-select the provider if one is given.
1757 if (($used_providers{$cgiparams{'ID'}}[0] eq "$provider") || ($cgiparams{'PROVIDER'} eq "$provider")) {
1758 $selected{$provider} = "selected='selected'";
1761 # Add the provider to the dropdown menu.
1762 print "<option value='$provider' $selected{$provider}>$provider_name</option>\n";
1769 <b><a id="website" target="_blank" href="#">$Lang::tr{'ids visit provider website'}</a></b>
1774 <td colspan='2'><br><br></td>
1777 <tr class='subscription_code' style='display:none' id='subscription_code'>
1782 <b>$Lang::tr{'subscription code'}</b>
1788 <input type='text' size='40' name='SUBSCRIPTION_CODE' value='$used_providers{$cgiparams{'ID'}}[1]'>
1801 <input type='checkbox' name='ENABLE_AUTOUPDATE' $checked{'ENABLE_AUTOUPDATE'}> $Lang::tr{'ids enable automatic updates'}
1806 <td colspan='2' align='right'>
1807 <input type='submit' value='$Lang::tr{'back'}'>
1810 # Check if a provider should be added or edited.
1811 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1812 # Display button for updating the existing provider.
1813 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'update'}'>\n";
1815 # Display button to add the new provider.
1816 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'add'}'>\n";
1825 &Header
::closebox
();
1829 ## Function to show the area where additional provider actions can be done.
1831 sub show_additional_provider_actions
() {
1833 my %used_providers = ();
1835 # Read-in providers settings file.
1836 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
1838 # Assign variable for provider handle.
1839 my $provider = "$used_providers{$cgiparams{'ID'}}[0]";
1841 # Call function to get the path and name for the given providers
1842 # oinkmaster modified sids file.
1843 my $provider_modified_sids_file = &IDS
::get_oinkmaster_provider_modified_sids_file
($provider);
1845 # Disable the reset provider button if no provider modified sids file exists.
1846 unless (-f
$provider_modified_sids_file) {
1847 $disabled = "disabled";
1850 &Header
::openbox
('100%', 'center', "");
1852 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1853 <table width='100%' border="0">
1856 <input type='hidden' name='PROVIDER' value='$provider'>
1857 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids reset provider'}' $disabled>
1858 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids force ruleset update'}'>
1865 &Header
::closebox
();
1869 ## A function to display a notice, to lock the webpage and
1870 ## tell the user which action currently will be performed.
1872 sub working_notice
($) {
1875 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
1876 &Header
::openbigbox
('100%', 'left', '', $errormessage);
1877 &Header
::openbox
( 'Waiting', 1,);
1881 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
1886 &Header
::closebox
();
1887 &Header
::closebigbox
();
1888 &Header
::closepage
();
1892 ## A tiny function to perform a reload of the webpage after one second.
1895 print "<meta http-equiv='refresh' content='1'>\n";
1902 ## Private function to read-in and parse rules of a given rulefile.
1904 ## The given file will be read, parsed and all valid rules will be stored by ID,
1905 ## message/description and it's state in the idsrules hash.
1907 sub readrulesfile
($) {
1908 my $rulefile = shift;
1910 # Open rule file and read in contents
1911 open(RULEFILE
, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
1913 # Store file content in an array.
1914 my @lines = <RULEFILE
>;
1919 # Loop over rule file contents
1920 foreach my $line (@lines) {
1921 # Remove whitespaces.
1925 next if ($line =~ /^\s*$/);
1931 # Gather rule sid and message from the ruleline.
1932 if ($line =~ m/.*msg:\"(.*?)\"\; .* sid:(.*?); /) {
1936 # Check if a rule has been found.
1938 # Add rule to the idsrules hash.
1939 $idsrules{$rulefile}{$sid}{'Description'} = $msg;
1941 # Grab status of the rule. Check if ruleline starts with a "dash".
1942 if ($line =~ /^\#/) {
1943 # If yes, the rule is disabled.
1944 $idsrules{$rulefile}{$sid}{'State'} = "off";
1946 # Otherwise the rule is enabled.
1947 $idsrules{$rulefile}{$sid}{'State'} = "on";
1955 ## Function to get the used memory of a given process-id.
1957 sub get_memory_usage
($) {
1962 # Try to open the status file for the given process-id on the pseudo
1964 if (open(FILE
, "/proc/$pid/status")) {
1965 # Loop through the entire file.
1967 # Splitt current line content and store them into variables.
1968 my ($key, $value) = split(":", $_, 2);
1970 # Check if the current key is the one which contains the memory usage.
1971 # The wanted one is VmRSS which contains the Real-memory (resident set)
1972 # of the entire process.
1973 if ($key eq "VmRSS") {
1974 # Found the memory usage add it to the memory variable.
1982 # Close file handle.
1985 # Return memory usage.
1989 # If the file could not be open, return nothing.
1994 ## Function to get the provider name from the language file or providers file for a given handle.
1996 sub get_provider_name
($) {
2000 # Get the required translation string for the given provider handle.
2001 my $tr_string = $IDS::Ruleset
::Providers
{$handle}{'tr_string'};
2003 # Check if the translation string is available in the language files.
2004 if ($Lang::tr
{$tr_string}) {
2005 # Use the translated string from the language file.
2006 $provider_name = $Lang::tr
{$tr_string};
2008 # Fallback and use the provider summary from the providers file.
2009 $provider_name = $IDS::Ruleset
::Providers
{$handle}{'summary'};
2012 # Return the obtained provider name.
2013 return $provider_name;
2017 ## Private function to convert a given rulefile to a category name.
2018 ## ( No file extension anymore and if the name contained a dot, it
2019 ## would be replaced by a underline sign.)
2021 sub _rulefile_to_category
($) {
2022 my ($filename) = @_;
2024 # Splitt the filename into single chunks and store them in a
2026 my @parts = split(/\./, $filename);
2028 # Return / Remove last element of the temporary array.
2029 # This removes the file extension.
2032 # Join together the single elements of the temporary array.
2033 # If these are more than one, use a "underline" for joining.
2034 my $category = join '_', @parts;
2036 # Return the converted filename.