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 ###############################################################################
23 use experimental
'smartmatch';
25 # enable only the following on debugging purpose
27 #use CGI::Carp 'fatalsToBrowser';
29 require '/var/ipfire/general-functions.pl';
30 require "${General::swroot}/lang.pl";
31 require "${General::swroot}/header.pl";
32 require "${General::swroot}/ids-functions.pl";
33 require "${General::swroot}/network-functions.pl";
35 # Import ruleset providers file.
36 require "$IDS::rulesetsourcesfile";
39 my %mainsettings = ();
42 my %used_providers=();
48 # Read-in main settings, for language, theme and colors.
49 &General
::readhash
("${General::swroot}/main/settings", \
%mainsettings);
50 &General
::readhash
("/srv/web/ipfire/html/themes/ipfire/include/colors.txt", \
%color);
52 # Get the available network zones, based on the config type of the system and store
53 # the list of zones in an array.
54 my @network_zones = &Network
::get_available_network_zones
();
56 # Check if openvpn is started and add it to the array of network zones.
57 if ( -e
"/var/run/openvpn.pid") {
58 push(@network_zones, "ovpn");
63 # Create files if they does not exist yet.
64 &IDS
::check_and_create_filelayout
();
66 # Hash which contains the colour code of a network zone.
68 'red' => $Header::colourred
,
69 'green' => $Header::colourgreen
,
70 'blue' => $Header::colourblue
,
71 'orange' => $Header::colourorange
,
72 'ovpn' => $Header::colourovpn
75 &Header
::showhttpheaders
();
78 &Header
::getcgihash
(\
%cgiparams);
80 ## Add/edit an entry to the ignore file.
82 if (($cgiparams{'WHITELIST'} eq $Lang::tr
{'add'}) || ($cgiparams{'WHITELIST'} eq $Lang::tr
{'update'})) {
84 # Check if any input has been performed.
85 if ($cgiparams{'IGNORE_ENTRY_ADDRESS'} ne '') {
87 # Check if the given input is no valid IP-address or IP-address with subnet, display an error message.
88 if ((!&General
::validip
($cgiparams{'IGNORE_ENTRY_ADDRESS'})) && (!&General
::validipandmask
($cgiparams{'IGNORE_ENTRY_ADDRESS'}))) {
89 $errormessage = "$Lang::tr{'guardian invalid address or subnet'}";
92 $errormessage = "$Lang::tr{'guardian empty input'}";
95 # Go further if there was no error.
96 if ($errormessage eq '') {
101 # Assign hash values.
102 my $new_entry_address = $cgiparams{'IGNORE_ENTRY_ADDRESS'};
103 my $new_entry_remark = $cgiparams{'IGNORE_ENTRY_REMARK'};
105 # Read-in ignoredfile.
106 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
108 # Check if we should edit an existing entry and got an ID.
109 if (($cgiparams{'WHITELIST'} eq $Lang::tr
{'update'}) && ($cgiparams{'ID'})) {
110 # Assin the provided id.
111 $id = $cgiparams{'ID'};
113 # Undef the given ID.
114 undef($cgiparams{'ID'});
116 # Grab the configured status of the corresponding entry.
117 $status = $ignored{$id}[2];
119 # Each newly added entry automatically should be enabled.
122 # Generate the ID for the new entry.
124 # Sort the keys by their ID and store them in an array.
125 my @keys = sort { $a <=> $b } keys %ignored;
127 # Reverse the key array.
128 my @reversed = reverse(@keys);
130 # Obtain the last used id.
131 my $last_id = @reversed[0];
133 # Increase the last id by one and use it as id for the new entry.
137 # Add/Modify the entry to/in the ignored hash.
138 $ignored{$id} = ["$new_entry_address", "$new_entry_remark", "$status"];
140 # Write the changed ignored hash to the ignored file.
141 &General
::writehasharray
($IDS::ignored_file
, \
%ignored);
143 # Regenerate the ignore file.
144 &IDS
::generate_ignore_file
();
147 # Check if the IDS is running.
148 if(&IDS
::ids_is_running
()) {
149 # Call suricatactrl to perform a reload.
150 &IDS
::call_suricatactrl
("reload");
153 ## Toggle Enabled/Disabled for an existing entry on the ignore list.
156 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr
{'toggle enable disable'}) {
159 # Only go further, if an ID has been passed.
160 if ($cgiparams{'ID'}) {
161 # Assign the given ID.
162 my $id = $cgiparams{'ID'};
164 # Undef the given ID.
165 undef($cgiparams{'ID'});
167 # Read-in ignoredfile.
168 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
170 # Grab the configured status of the corresponding entry.
171 my $status = $ignored{$id}[2];
174 if ($status eq "disabled") {
177 $status = "disabled";
180 # Modify the status of the existing entry.
181 $ignored{$id} = ["$ignored{$id}[0]", "$ignored{$id}[1]", "$status"];
183 # Write the changed ignored hash to the ignored file.
184 &General
::writehasharray
($IDS::ignored_file
, \
%ignored);
186 # Regenerate the ignore file.
187 &IDS
::generate_ignore_file
();
189 # Check if the IDS is running.
190 if(&IDS
::ids_is_running
()) {
191 # Call suricatactrl to perform a reload.
192 &IDS
::call_suricatactrl
("reload");
196 ## Remove entry from ignore list.
198 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr
{'remove'}) {
201 # Read-in ignoredfile.
202 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
204 # Drop entry from the hash.
205 delete($ignored{$cgiparams{'ID'}});
207 # Undef the given ID.
208 undef($cgiparams{'ID'});
210 # Write the changed ignored hash to the ignored file.
211 &General
::writehasharray
($IDS::ignored_file
, \
%ignored);
213 # Regenerate the ignore file.
214 &IDS
::generate_ignore_file
();
216 # Check if the IDS is running.
217 if(&IDS
::ids_is_running
()) {
218 # Call suricatactrl to perform a reload.
219 &IDS
::call_suricatactrl
("reload");
223 # Check if the page is locked, in this case, the ids_page_lock_file exists.
224 if (-e
$IDS::ids_page_lock_file
) {
225 # Lock the webpage and print notice about autoupgrade of the ruleset
227 &working_notice
("$Lang::tr{'ids ruleset autoupdate in progress'}");
229 # Loop and check if the file still exists.
230 while(-e
$IDS::ids_page_lock_file
) {
231 # Sleep for a second and re-check.
235 # Page has been unlocked, perform a reload.
239 # Check if any error has been stored.
240 if (-e
$IDS::storederrorfile
) {
241 # Open file to read in the stored error message.
242 open(FILE
, "<$IDS::storederrorfile") or die "Could not open $IDS::storederrorfile. $!\n";
244 # Read the stored error message.
245 $errormessage = <FILE
>;
250 # Delete the file, which is now not longer required.
251 unlink($IDS::storederrorfile
);
254 # Gather ruleset details.
255 if ($cgiparams{'RULESET'}) {
256 ## Grab all available rules and store them in the idsrules hash.
259 # Get enabled providers.
260 my @enabled_providers = &IDS
::get_enabled_providers
();
262 # Open rules directory and do a directory listing.
263 opendir(DIR
, $IDS::rulespath
) or die $!;
264 # Loop through the direcory.
265 while (my $file = readdir(DIR
)) {
267 # We only want files.
268 next unless (-f
"$IDS::rulespath/$file");
270 # Ignore empty files.
271 next if (-z
"$IDS::rulespath/$file");
273 # Use a regular expression to find files ending in .rules
274 next unless ($file =~ m/\.rules$/);
276 # Ignore files which are not read-able.
277 next unless (-R
"$IDS::rulespath/$file");
279 # Skip whitelist rules file.
280 next if( $file eq "whitelist.rules");
282 # Splitt vendor from filename.
283 my @filename_parts = split(/-/, $file);
285 # Assign vendor name for easy processing.
286 my $vendor = @filename_parts[0];
288 # Skip rulefile if the provider is disabled.
289 next unless ($vendor ~~ @enabled_providers);
291 # Call subfunction to read-in rulefile and add rules to
293 &readrulesfile
("$file");
298 # Loop through the array of used providers.
299 foreach my $provider (@enabled_providers) {
300 # Gather used rulefiles.
301 my @used_rulesfiles = &IDS
::read_used_provider_rulesfiles
($provider);
303 # Loop through the array of used rulesfiles.
304 foreach my $rulefile (@used_rulesfiles) {
305 # Check if the current rulefile exists in the %idsrules hash.
306 # If not, the file probably does not exist anymore or contains
308 if($idsrules{$rulefile}) {
309 # Add the rulefile state to the %idsrules hash.
310 $idsrules{$rulefile}{'Rulefile'}{'State'} = "on";
317 if ($cgiparams{'RULESET'} eq $Lang::tr
{'ids apply'}) {
318 # Arrays to store which rulefiles have been enabled and will be used.
319 my @enabled_rulefiles;
321 # Store if a restart of suricata is required.
322 my $suricata_restart_required;
324 # Loop through the hash of idsrules.
325 foreach my $rulefile(keys %idsrules) {
326 # Check if the state of the rulefile has been changed.
327 unless ($cgiparams{$rulefile} eq $idsrules{$rulefile}{'Rulefile'}{'State'}) {
328 # A restart of suricata is required to apply the changes of the used rulefiles.
329 $suricata_restart_required = 1;
332 # Check if the rulefile is enabled.
333 if ($cgiparams{$rulefile} eq "on") {
334 # Add rulefile to the array of enabled rulefiles.
335 push(@enabled_rulefiles, $rulefile);
337 # Drop item from cgiparams hash.
338 delete $cgiparams{$rulefile};
342 # Open oinkmaster main include file for provider modifications.
343 open(OINKM_INCL_FILE
, ">", "$IDS::oinkmaster_provider_includes_file") or die "Could not open $IDS::oinkmaster_provider_includes_file. $!\n";
345 # Print file header and notice about autogenerated file.
346 print OINKM_INCL_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
348 # Get enabled providers.
349 my @enabled_providers = &IDS
::get_enabled_providers
();
351 # Loop through the array of enabled providers.
352 foreach my $provider (@enabled_providers) {
353 # Hash to store the used-enabled and disabled sids.
354 my %enabled_disabled_sids;
356 # Generate modified sids file name for the current processed provider.
357 my $providers_modified_sids_file = &IDS
::get_oinkmaster_provider_modified_sids_file
($provider);
359 # Check if a modified sids file for this provider exists.
360 if (-f
$providers_modified_sids_file) {
361 # Read-in the file for enabled/disabled sids.
362 %enabled_disabled_sids = &IDS
::read_enabled_disabled_sids_file
($providers_modified_sids_file);
365 # Loop through the hash of idsrules.
366 foreach my $rulefile (keys %idsrules) {
367 # Split the rulefile to get the vendor.
368 my @filename_parts = split(/-/, $rulefile);
370 # Assign rulefile vendor.
371 my $rulefile_vendor = @filename_parts[0];
373 # Skip the rulefile if the vendor is not our current processed provider.
374 next unless ($rulefile_vendor eq $provider);
376 # Loop through the single rules of the rulefile.
377 foreach my $sid (keys %{$idsrules{$rulefile}}) {
378 # Skip the current sid if it is not numeric.
379 next unless ($sid =~ /\d+/ );
381 # Check if there exists a key in the cgiparams hash for this sid.
382 if (exists($cgiparams{$sid})) {
383 # Look if the rule is disabled.
384 if ($idsrules{$rulefile}{$sid}{'State'} eq "off") {
385 # Check if the state has been set to 'on'.
386 if ($cgiparams{$sid} eq "on") {
387 # Add/Modify the sid to/in the enabled_disabled_sids hash.
388 $enabled_disabled_sids{$sid} = "enabled";
390 # Drop item from cgiparams hash.
391 delete $cgiparams{$rulefile}{$sid};
395 # Look if the rule is enabled.
396 if ($idsrules{$rulefile}{$sid}{'State'} eq "on") {
397 # Check if the state is 'on' and should be disabled.
398 # In this case there is no entry
399 # for the sid in the cgiparams hash.
400 # Add/Modify it to/in the enabled_disabled_sids hash.
401 $enabled_disabled_sids{$sid} = "disabled";
403 # Drop item from cgiparams hash.
404 delete $cgiparams{$rulefile}{$sid};
410 # Check if the hash for enabled/disabled sids contains any entries.
411 if (%enabled_disabled_sids) {
412 # Open providers modified sids file for writing.
413 open(PROVIDER_MOD_FILE
, ">$providers_modified_sids_file") or die "Could not write to $providers_modified_sids_file. $!\n";
415 # Write header to the files.
416 print PROVIDER_MOD_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
418 # Loop through the hash.
419 foreach my $sid (keys %enabled_disabled_sids) {
420 # Check if the sid is enabled.
421 if ($enabled_disabled_sids{$sid} eq "enabled") {
422 # Print the sid to the enabled_sids file.
423 print PROVIDER_MOD_FILE
"enablesid $sid\n";
424 # Check if the sid is disabled.
425 } elsif ($enabled_disabled_sids{$sid} eq "disabled") {
426 # Print the sid to the disabled_sids file.
427 print PROVIDER_MOD_FILE
"disablesid $sid\n";
428 # Something strange happende - skip the current sid.
434 # Close file handle for the providers modified sids file.
435 close(PROVIDER_MOD_FILE
);
437 # Add the file to the oinkmasters include file.
438 print OINKM_INCL_FILE
"include $providers_modified_sids_file\n";
442 # Close the file handle after writing.
443 close(OINKM_INCL_FILE
);
445 # Handle enabled / disabled rulefiles.
448 # Loop through the array of enabled providers.
449 foreach my $provider(@enabled_providers) {
450 # Array to store the rulefiles which belong to the current processed provider.
451 my @provider_rulefiles = ();
453 # Loop through the array of enabled rulefiles.
454 foreach my $rulesfile (@enabled_rulefiles) {
455 # Split the rulefile name.
456 my @filename_parts = split(/-/, "$rulesfile");
458 # Assign vendor name for easy processings.
459 my $vendor = @filename_parts[0];
461 # Check if the rulesvendor is our current processed enabled provider.
462 if ("$vendor" eq "$provider") {
463 # Add the rulesfile to the array of provider rulesfiles.
464 push(@provider_rulefiles, $rulesfile);
467 # Call function and write the providers used rulesfile file.
468 &IDS
::write_used_provider_rulefiles_file
($provider, @provider_rulefiles);
472 # Call function to generate and write the used rulefiles file.
473 &IDS
::write_main_used_rulefiles_file
(@enabled_providers);
475 # Lock the webpage and print message.
476 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
478 # Call oinkmaster to alter the ruleset.
481 # Check if the IDS is running.
482 if(&IDS
::ids_is_running
()) {
483 # Check if a restart of suricata is required.
484 if ($suricata_restart_required) {
485 # Call suricatactrl to perform the restart.
486 &IDS
::call_suricatactrl
("restart");
488 # Call suricatactrl to perform a reload.
489 &IDS
::call_suricatactrl
("reload");
496 # Download new ruleset.
497 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'ids force ruleset update'}) {
498 # Assign given provider handle.
499 my $provider = $cgiparams{'PROVIDER'};
501 # Check if the red device is active.
502 unless (-e
"${General::swroot}/red/active") {
503 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
506 # Check if enought free disk space is availabe.
507 if(&IDS
::checkdiskspace
()) {
508 $errormessage = "$Lang::tr{'not enough disk space'}";
511 # Check if any errors happend.
512 unless ($errormessage) {
513 # Lock the webpage and print notice about downloading
515 &working_notice
("$Lang::tr{'ids download new ruleset'}");
517 # Call subfunction to download the ruleset.
518 if(&IDS
::downloadruleset
($provider)) {
519 $errormessage = "$provider - $Lang::tr{'could not download latest updates'}";
521 # Call function to store the errormessage.
522 &IDS
::_store_error_message
($errormessage);
524 # Preform a reload of the page.
527 # Call subfunction to launch oinkmaster.
530 # Check if the IDS is running.
531 if(&IDS
::ids_is_running
()) {
532 # Call suricatactrl to perform a reload.
533 &IDS
::call_suricatactrl
("reload");
536 # Perform a reload of the page.
541 # Reset a provider to it's defaults.
542 } elsif ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'ids reset provider'}") {
543 # Grab provider handle from cgihash.
544 my $provider = $cgiparams{'PROVIDER'};
546 # Lock the webpage and print message.
547 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
549 # Create new empty file for used rulefiles
551 &IDS
::write_used_provider_rulefiles_file
($provider);
553 # Call function to get the path and name for the given providers
554 # oinkmaster modified sids file.
555 my $provider_modified_sids_file = &IDS
::get_oinkmaster_provider_modified_sids_file
($provider);
557 # Check if the file exists.
558 if (-f
$provider_modified_sids_file) {
559 # Remove the file, as requested.
560 unlink("$provider_modified_sids_file");
563 # Alter the oinkmaster provider includes file and remove the provider.
564 &IDS
::alter_oinkmaster_provider_includes_file
("remove", $provider);
566 # Regenerate ruleset.
569 # Check if the IDS is running.
570 if(&IDS
::ids_is_running
()) {
571 # Get enabled providers.
572 my @enabled_providers = &IDS
::get_enabled_providers
();
574 # Get amount of enabled providers.
575 my $amount = @enabled_providers;
577 # Check if at least one enabled provider remains.
579 # Call suricatactrl to perform a reload.
580 &IDS
::call_suricatactrl
("restart");
582 # Stop suricata if no enabled provider remains.
584 # Call suricatactrel to perform the stop.
585 &IDS
::call_suricatactrl
("stop");
589 # Undefine providers flag.
590 undef($cgiparams{'PROVIDERS'});
596 } elsif ($cgiparams{'IDS'} eq $Lang::tr
{'save'}) {
599 my $monitored_zones = 0;
601 # Read-in current (old) IDS settings.
602 &General
::readhash
("$IDS::ids_settings_file", \
%oldidssettings);
604 # Get enabled providers.
605 my @enabled_providers = &IDS
::get_enabled_providers
();
607 # Prevent form name from been stored in conf file.
608 delete $cgiparams{'IDS'};
610 # Check if the IDS should be enabled.
611 if ($cgiparams{'ENABLE_IDS'} eq "on") {
612 # Check if at least one provider is enabled. Otherwise abort and display an error.
613 unless(@enabled_providers) {
614 $errormessage = $Lang::tr
{'ids no enabled ruleset provider'};
617 # Loop through the array of available interfaces.
618 foreach my $zone (@network_zones) {
619 # Convert interface name into upper case.
620 my $zone_upper = uc($zone);
622 # Check if the IDS is enabled for this interaces.
623 if ($cgiparams{"ENABLE_IDS_$zone_upper"}) {
629 # Check if at least one zone should be monitored, or show an error.
630 unless ($monitored_zones >= 1) {
631 $errormessage = $Lang::tr
{'ids no network zone'};
635 # Go on if there are no error messages.
636 if (!$errormessage) {
637 # Store settings into settings file.
638 &General
::writehash
("$IDS::ids_settings_file", \
%cgiparams);
641 # Check if the the automatic rule update hass been touched.
642 if($cgiparams{'AUTOUPDATE_INTERVAL'} ne $oldidssettings{'AUTOUPDATE_INTERVAL'}) {
643 # Call suricatactrl to set the new interval.
644 &IDS
::call_suricatactrl
("cron", $cgiparams{'AUTOUPDATE_INTERVAL'});
647 # Generate file to store the home net.
648 &IDS
::generate_home_net_file
();
650 # Generate file to the store the DNS servers.
651 &IDS
::generate_dns_servers_file
();
653 # Generate file to store the HTTP ports.
654 &IDS
::generate_http_ports_file
();
656 # Write the modify sid's file and pass the taken ruleaction.
657 &IDS
::write_modify_sids_file
();
659 # Check if "MONITOR_TRAFFIC_ONLY" has been changed.
660 if($cgiparams{'MONITOR_TRAFFIC_ONLY'} ne $oldidssettings{'MONITOR_TRAFFIC_ONLY'}) {
661 # Check if at least one provider is enabled.
662 if (@enabled_providers) {
663 # Lock the webpage and print message.
664 &working_notice
("$Lang::tr{'ids working'}");
666 # Call oinkmaster to alter the ruleset.
669 # Set reload_page to "True".
674 # Check if the IDS currently is running.
675 if(&IDS
::ids_is_running
()) {
676 # Check if ENABLE_IDS is set to on.
677 if($cgiparams{'ENABLE_IDS'} eq "on") {
678 # Call suricatactrl to perform a reload of suricata.
679 &IDS
::call_suricatactrl
("reload");
681 # Call suricatactrl to stop suricata.
682 &IDS
::call_suricatactrl
("stop");
685 # Call suricatactrl to start suricata.
686 &IDS
::call_suricatactrl
("start");
689 # Check if the page should be reloaded.
691 # Perform a reload of the page.
695 # Toggle Enable/Disable autoupdate for a provider
696 } elsif ($cgiparams{'AUTOUPDATE'} eq $Lang::tr
{'toggle enable disable'}) {
697 my %used_providers = ();
699 # Only go further, if an ID has been passed.
700 if ($cgiparams{'ID'}) {
701 # Assign the given ID.
702 my $id = $cgiparams{'ID'};
704 # Undef the given ID.
705 undef($cgiparams{'ID'});
707 # Read-in providers settings file.
708 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
710 # Grab the configured status of the corresponding entry.
711 my $status_autoupdate = $used_providers{$id}[2];
714 if ($status_autoupdate eq "disabled") {
715 $status_autoupdate = "enabled";
717 $status_autoupdate = "disabled";
720 # Modify the status of the existing entry.
721 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$status_autoupdate", "$used_providers{$id}[3]"];
723 # Write the changed hash to the providers settings file.
724 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
727 # Add/Edit a provider to the list of used providers.
729 } elsif (($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") || ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'update'}")) {
730 my %used_providers = ();
732 # Read-in providers settings file.
733 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
735 # Assign some nice human-readable values.
736 my $provider = $cgiparams{'PROVIDER'};
737 my $subscription_code = $cgiparams{'SUBSCRIPTION_CODE'};
738 my $status_autoupdate;
740 # Handle autoupdate checkbox.
741 if ($cgiparams{'ENABLE_AUTOUPDATE'} eq "on") {
742 $status_autoupdate = "enabled";
744 $status_autoupdate = "disabled";
747 # Check if we are going to add a new provider.
748 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") {
749 # Loop through the hash of used providers.
750 foreach my $id ( keys %used_providers) {
751 # Check if the choosen provider is already in use.
752 if ($used_providers{$id}[0] eq "$provider") {
753 # Assign error message.
754 $errormessage = "$Lang::tr{'ids the choosen provider is already in use'}";
759 # Check if the provider requires a subscription code.
760 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
761 # Check if an subscription code has been provided.
762 if ($subscription_code) {
763 # Check if the code contains unallowed chars.
764 unless ($subscription_code =~ /^[a-z0-9]+$/) {
765 $errormessage = $Lang::tr
{'invalid input for subscription code'};
768 # Print an error message, that an subsription code is required for this
770 $errormessage = $Lang::tr
{'ids subscription code required'};
774 # Go further if there was no error.
775 if ($errormessage eq '') {
779 # Check if we should edit an existing entry and got an ID.
780 if (($cgiparams{'PROVIDERS'} eq $Lang::tr
{'update'}) && ($cgiparams{'ID'})) {
781 # Assin the provided id.
782 $id = $cgiparams{'ID'};
784 # Undef the given ID.
785 undef($cgiparams{'ID'});
787 # Grab the configured status of the corresponding entry.
788 $status = $used_providers{$id}[3];
790 # Each newly added entry automatically should be enabled.
793 # Generate the ID for the new entry.
795 # Sort the keys by their ID and store them in an array.
796 my @keys = sort { $a <=> $b } keys %used_providers;
798 # Reverse the key array.
799 my @reversed = reverse(@keys);
801 # Obtain the last used id.
802 my $last_id = @reversed[0];
804 # Increase the last id by one and use it as id for the new entry.
808 # Add/Modify the entry to/in the used providers hash..
809 $used_providers{$id} = ["$provider", "$subscription_code", "$status_autoupdate", "$status"];
811 # Write the changed hash to the providers settings file.
812 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
814 # Check if a new provider will be added.
815 if ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'add'}) {
816 # Check if the red device is active.
817 unless (-e
"${General::swroot}/red/active") {
818 $errormessage = "$Lang::tr{'ids could not add provider'} - $Lang::tr{'system is offline'}";
821 # Check if enough free disk space is availabe.
822 if(&IDS
::checkdiskspace
()) {
823 $errormessage = "$Lang::tr{'ids could not add provider'} - $Lang::tr{'not enough disk space'}";
826 # Check if any errors happend.
827 unless ($errormessage) {
828 # Lock the webpage and print notice about downloading
830 &working_notice
("$Lang::tr{'ids working'}");
832 # Download the ruleset.
833 if(&IDS
::downloadruleset
($provider)) {
834 $errormessage = "$Lang::tr{'ids could not add provider'} - $Lang::tr{'ids unable to download the ruleset'}";
836 # Call function to store the errormessage.
837 &IDS
::_store_error_message
($errormessage);
839 # Remove the configured provider again.
840 &remove_provider
($id);
842 # Extract the ruleset
843 &IDS
::extractruleset
($provider);
846 &IDS
::move_tmp_ruleset
();
848 # Cleanup temporary directory.
849 &IDS
::cleanup_tmp_directory
();
851 # Create new empty file for used rulefiles
853 &IDS
::write_used_provider_rulefiles_file
($provider);
856 # Perform a reload of the page.
863 # Undefine providers flag.
864 undef($cgiparams{'PROVIDERS'});
866 ## Toggle Enabled/Disabled for an existing provider.
868 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'toggle enable disable'}) {
869 my %used_providers = ();
870 my $provider_includes_action;
872 # Value if oinkmaster has to be executed.
873 my $oinkmaster = "False";
875 # Only go further, if an ID has been passed.
876 if ($cgiparams{'ID'}) {
877 # Assign the given ID.
878 my $id = $cgiparams{'ID'};
880 # Undef the given ID.
881 undef($cgiparams{'ID'});
883 # Read-in file which contains the provider settings.
884 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
886 # Grab the configured status of the corresponding entry.
887 my $status = $used_providers{$id}[3];
889 # Grab the provider handle.
890 my $provider_handle = $used_providers{$id}[0];
893 if ($status eq "enabled") {
894 $status = "disabled";
896 # Set the provider includes action to "remove" for removing the entry.
897 $provider_includes_action = "remove";
901 # Set the provider includes action to "add".
902 $provider_includes_action = "add";
904 # This operation requires to launch oinkmaster.
905 $oinkmaster = "True";
908 # Modify the status of the existing entry.
909 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$used_providers{$id}[2]", "$status"];
911 # Write the changed hash to the providers settings file.
912 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
914 # Get all enabled providers.
915 my @enabled_providers = &IDS
::get_enabled_providers
();
917 # Write the main providers include file.
918 &IDS
::write_main_used_rulefiles_file
(@enabled_providers);
920 # Call function to alter the oinkmasters provider includes file and
921 # add or remove the provider.
922 &IDS
::alter_oinkmaster_provider_includes_file
($provider_includes_action, $provider_handle);
924 # Check if oinkmaster has to be executed.
925 if ($oinkmaster eq "True") {
926 # Lock the webpage and print message.
927 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
933 # Check if the IDS is running.
934 if(&IDS
::ids_is_running
()) {
935 # Gather the amount of enabled providers (elements in the array).
936 my $amount = @enabled_providers;
938 # Check if there are still enabled ruleset providers.
940 # Call suricatactrl to perform a restart.
941 &IDS
::call_suricatactrl
("restart");
943 # No active ruleset provider, suricata has to be stopped.
946 &IDS
::call_suricatactrl
("stop");
950 # Undefine providers flag.
951 undef($cgiparams{'PROVIDERS'});
957 ## Remove provider from the list of used providers.
959 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'remove'}) {
960 # Assign a nice human-readable variable.
961 my $id = $cgiparams{'ID'};
963 # Grab the provider name bevore deleting.
964 my $provider = &get_provider_handle
($id);
966 # Remove the provider.
967 &remove_provider
($id);
969 # Undef the given ID.
970 undef($cgiparams{'ID'});
972 # Lock the webpage and print message.
973 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
975 # Drop the stored ruleset file.
976 &IDS
::drop_dl_rulesfile
($provider);
978 # Get the name of the provider rulessets include file.
979 my $provider_used_rulefile = &IDS
::get_used_provider_rulesfile_file
($provider);
981 # Drop the file, it is not longer needed.
982 unlink("$provider_used_rulefile");
984 # Call function to get the path and name for the given providers
985 # oinkmaster modified sids file.
986 my $provider_modified_sids_file = &IDS
::get_oinkmaster_provider_modified_sids_file
($provider);
988 # Check if the file exists.
989 if (-f
$provider_modified_sids_file) {
990 # Remove the file, which is not longer needed.
991 unlink("$provider_modified_sids_file");
994 # Alter the oinkmaster provider includes file and remove the provider.
995 &IDS
::alter_oinkmaster_provider_includes_file
("remove", $provider);
997 # Regenerate ruleset.
1000 # Gather all enabled providers.
1001 my @enabled_providers = &IDS
::get_enabled_providers
();
1003 # Regenerate main providers include file.
1004 &IDS
::write_main_used_rulefiles_file
(@enabled_providers);
1006 # Check if the IDS is running.
1007 if(&IDS
::ids_is_running
()) {
1008 # Get amount of enabled providers.
1009 my $amount = @enabled_providers;
1011 # Check if at least one enabled provider remains.
1013 # Call suricatactrl to perform a reload.
1014 &IDS
::call_suricatactrl
("restart");
1016 # Stop suricata if no enabled provider remains.
1018 # Call suricatactrel to perform the stop.
1019 &IDS
::call_suricatactrl
("stop");
1023 # Undefine providers flag.
1024 undef($cgiparams{'PROVIDERS'});
1030 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
1032 &Header
::openbigbox
('100%', 'left', '', $errormessage);
1034 &show_display_error_message
();
1036 if ($cgiparams{'RULESET'} eq "$Lang::tr{'ids customize ruleset'}" ) {
1037 &show_customize_ruleset
();
1038 } elsif ($cgiparams{'PROVIDERS'} ne "") {
1039 &show_add_provider
();
1044 &Header
::closebigbox
();
1045 &Header
::closepage
();
1048 ## Tiny function to show if a error message happened.
1050 sub show_display_error_message
() {
1051 if ($errormessage) {
1052 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
1053 print "<class name='base'>$errormessage\n";
1054 print " </class>\n";
1055 &Header
::closebox
();
1060 ## Function to display the main IDS page.
1062 sub show_mainpage
() {
1063 # Read-in idssettings and provider settings.
1064 &General
::readhash
("$IDS::ids_settings_file", \
%idssettings);
1065 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
1067 # If no autoupdate intervall has been configured yet, set default value.
1068 unless(exists($idssettings{'AUTOUPDATE_INTERVAL'})) {
1069 # Set default to "weekly".
1070 $idssettings{'AUTOUPDATE_INTERVAL'} = 'weekly';
1073 # Read-in ignored hosts.
1074 &General
::readhasharray
("$IDS::settingsdir/ignored", \
%ignored);
1076 $checked{'ENABLE_IDS'}{'off'} = '';
1077 $checked{'ENABLE_IDS'}{'on'} = '';
1078 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
1079 $checked{'MONITOR_TRAFFIC_ONLY'}{'off'} = '';
1080 $checked{'MONITOR_TRAFFIC_ONLY'}{'on'} = '';
1081 $checked{'MONITOR_TRAFFIC_ONLY'}{$idssettings{'MONITOR_TRAFFIC_ONLY'}} = "checked='checked'";
1082 $selected{'AUTOUPDATE_INTERVAL'}{'off'} = '';
1083 $selected{'AUTOUPDATE_INTERVAL'}{'daily'} = '';
1084 $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} = '';
1085 $selected{'AUTOUPDATE_INTERVAL'}{$idssettings{'AUTOUPDATE_INTERVAL'}} = "selected='selected'";
1087 # Draw current state of the IDS
1088 &Header
::openbox
('100%', 'left', $Lang::tr
{'intrusion detection system'});
1090 # Check if the IDS is running and obtain the process-id.
1091 my $pid = &IDS
::ids_is_running
();
1093 # Display some useful information, if suricata daemon is running.
1095 # Gather used memory.
1096 my $memory = &get_memory_usage
($pid);
1099 <table width='95%' cellspacing='0' class='tbl'>
1101 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1105 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1106 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
1110 <td class='base'></td>
1111 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
1112 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
1116 <td class='base'></td>
1117 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
1118 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
1123 # Otherwise display a hint that the service is not launched.
1125 <table width='95%' cellspacing='0' class='tbl'>
1127 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1131 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1132 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
1138 # Only show this area, if at least one ruleset provider is configured.
1139 if (%used_providers) {
1143 <br><br><h2>$Lang::tr{'settings'}</h2>
1145 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1146 <table width='100%' border='0'>
1148 <td class='base' colspan='2'>
1149 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}> $Lang::tr{'ids enable'}
1152 <td class='base' colspan='2'>
1153 <input type='checkbox' name='MONITOR_TRAFFIC_ONLY' $checked{'MONITOR_TRAFFIC_ONLY'}{'on'}> $Lang::tr{'ids monitor traffic only'}
1165 <td colspan='4'><b>$Lang::tr{'ids monitored interfaces'}</b><br></td>
1172 # Loop through the array of available networks and print config options.
1173 foreach my $zone (@network_zones) {
1175 my $checked_forward;
1177 # Convert current zone name to upper case.
1178 my $zone_upper = uc($zone);
1181 my $zone_name = $zone;
1183 # Dirty hack to get the correct language string for the red zone.
1184 if ($zone eq "red") {
1185 $zone_name = "red1";
1188 # Grab checkbox status from settings hash.
1189 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
1190 $checked_input = "checked = 'checked'";
1193 print "<td class='base' width='20%'>\n";
1194 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>\n";
1195 print " $Lang::tr{'enabled on'}<font color='$colourhash{$zone}'> $Lang::tr{$zone_name}</font>\n";
1210 <td colspan='4'><b>$Lang::tr{'ids automatic rules update'}</b></td>
1215 <select name='AUTOUPDATE_INTERVAL'>
1216 <option value='off' $selected{'AUTOUPDATE_INTERVAL'}{'off'} >- $Lang::tr{'Disabled'} -</option>
1217 <option value='daily' $selected{'AUTOUPDATE_INTERVAL'}{'daily'} >$Lang::tr{'Daily'}</option>
1218 <option value='weekly' $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} >$Lang::tr{'Weekly'}</option>
1226 <table width='100%'>
1228 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
1237 &Header
::closebox
();
1240 # Used Ruleset Providers section.
1242 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ruleset settings'});
1245 <table width='100%' border='0'>
1247 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ids provider'}</b></td>
1248 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'date'}</b></td>
1249 <td class='base' bgcolor='$color{'color20'}' align='center'><b>$Lang::tr{'ids autoupdates'}</b></td>
1250 <td class='base' bgcolor='$color{'color20'}'></td>
1251 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1256 # Check if some providers has been configured.
1257 if (keys (%used_providers)) {
1260 # Loop through all entries of the hash.
1261 foreach my $id (sort keys(%used_providers)) {
1262 # Assign data array positions to some nice variable names.
1263 my $provider = $used_providers{$id}[0];
1264 my $provider_name = &get_provider_name
($provider);
1265 my $rulesetdate = &IDS
::get_ruleset_date
($provider);
1267 my $subscription_code = $used_providers{$id}[1];
1268 my $autoupdate_status = $used_providers{$id}[2];
1269 my $status = $used_providers{$id}[3];
1271 # Check if the item number is even or not.
1273 $col="bgcolor='$color{'color22'}'";
1275 $col="bgcolor='$color{'color20'}'";
1278 # Choose icons for the checkboxes.
1281 my $autoupdate_status_gif;
1282 my $autoupdate_status_gdesc;
1284 # Check if the status is enabled and select the correct image and description.
1285 if ($status eq 'enabled' ) {
1286 $status_gif = 'on.gif';
1287 $status_gdesc = $Lang::tr
{'click to disable'};
1289 $status_gif = 'off.gif';
1290 $status_gdesc = $Lang::tr
{'click to enable'};
1293 # Check if the autoupdate status is enabled and select the correct image and description.
1294 if ($autoupdate_status eq 'enabled') {
1295 $autoupdate_status_gif = 'on.gif';
1296 $autoupdate_status_gdesc = $Lang::tr
{'click to disable'};
1298 $autoupdate_status_gif = 'off.gif';
1299 $autoupdate_status_gdesc = $Lang::tr
{'click to enable'};
1304 <td width='33%' class='base' $col>$provider_name</td>
1305 <td width='30%' class='base' $col>$rulesetdate</td>
1307 <td align='center' $col>
1308 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1309 <input type='hidden' name='AUTOUPDATE' value='$Lang::tr{'toggle enable disable'}' />
1310 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$autoupdate_status_gif' alt='$autoupdate_status_gdesc' title='$autoupdate_status_gdesc' />
1311 <input type='hidden' name='ID' value='$id' />
1315 <td align='center' $col>
1316 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1317 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'toggle enable disable'}'>
1318 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$status_gif' alt='$status_gdesc' title='$status_gdesc'>
1319 <input type='hidden' name='ID' value='$id'>
1323 <td align='center' $col>
1324 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1325 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'edit'}'>
1326 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1327 <input type='hidden' name='ID' value='$id'>
1331 <td align='center' $col>
1332 <form method='post' name='$provider' action='$ENV{'SCRIPT_NAME'}'>
1333 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1334 <input type='hidden' name='ID' value='$id'>
1335 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'remove'}'>
1340 # Increment lines value.
1346 # Print notice that currently no hosts are ignored.
1348 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1354 # Section to add new elements or edit existing ones.
1361 <table width='100%'>
1362 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1366 # Only show this button if a ruleset provider is configured.
1367 if (%used_providers) {
1368 print "<input type='submit' name='RULESET' value='$Lang::tr{'ids customize ruleset'}'>\n";
1371 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids add provider'}'>
1378 &Header
::closebox
();
1381 # Whitelist / Ignorelist
1383 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ignored hosts'});
1386 <table width='100%'>
1388 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
1389 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
1390 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1393 # Check if some hosts have been added to be ignored.
1394 if (keys (%ignored)) {
1397 # Loop through all entries of the hash.
1398 while( (my $key) = each %ignored) {
1399 # Assign data array positions to some nice variable names.
1400 my $address = $ignored{$key}[0];
1401 my $remark = $ignored{$key}[1];
1402 my $status = $ignored{$key}[2];
1404 # Check if the key (id) number is even or not.
1405 if ($cgiparams{'ID'} eq $key) {
1406 $col="bgcolor='${Header::colouryellow}'";
1407 } elsif ($key % 2) {
1408 $col="bgcolor='$color{'color22'}'";
1410 $col="bgcolor='$color{'color20'}'";
1413 # Choose icon for the checkbox.
1417 # Check if the status is enabled and select the correct image and description.
1418 if ($status eq 'enabled' ) {
1420 $gdesc = $Lang::tr
{'click to disable'};
1423 $gdesc = $Lang::tr
{'click to enable'};
1428 <td width='20%' class='base' $col>$address</td>
1429 <td width='65%' class='base' $col>$remark</td>
1431 <td align='center' $col>
1432 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1433 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}'>
1434 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc'>
1435 <input type='hidden' name='ID' value='$key'>
1439 <td align='center' $col>
1440 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1441 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}'>
1442 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1443 <input type='hidden' name='ID' value='$key'>
1447 <td align='center' $col>
1448 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
1449 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1450 <input type='hidden' name='ID' value='$key'>
1451 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
1458 # Print notice that currently no hosts are ignored.
1460 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1466 # Section to add new elements or edit existing ones.
1472 <div align='center'>
1473 <table width='100%'>
1476 # Assign correct headline and button text.
1481 # Check if an ID (key) has been given, in this case an existing entry should be edited.
1482 if ($cgiparams{'ID'} ne '') {
1483 $buttontext = $Lang::tr
{'update'};
1484 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
1486 # Grab address and remark for the given key.
1487 $entry_address = $ignored{$cgiparams{'ID'}}[0];
1488 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
1490 $buttontext = $Lang::tr
{'add'};
1491 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
1495 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1496 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1498 <td width='30%'>$Lang::tr{'ip address'}: </td>
1499 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
1501 <td width='30%'>$Lang::tr{'remark'}: </td>
1502 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
1503 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
1510 &Header
::closebox
();
1514 ## Function to show the customize ruleset section.
1516 sub show_customize_ruleset
() {
1520 # Java script variable declaration for show and hide.
1521 print"var show = \"$Lang::tr{'ids show'}\"\;\n";
1522 print"var hide = \"$Lang::tr{'ids hide'}\"\;\n";
1525 // Tiny javascript function to show/hide the rules
1526 // of a given category.
1527 function showhide(tblname) {
1528 \$("#" + tblname).toggle();
1530 // Get current content of the span element.
1531 var content = document.getElementById("span_" + tblname);
1533 if (content.innerHTML === show) {
1534 content.innerHTML = hide;
1536 content.innerHTML = show;
1542 &Header
::openbox
('100%', 'LEFT', "$Lang::tr{'intrusion detection system rules'}" );
1543 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
1545 # Output display table for rule files
1546 print "<table width='100%'>\n";
1548 # Loop over each rule file
1549 foreach my $rulefile (sort keys(%idsrules)) {
1550 my $rulechecked = '';
1552 # Check if rule file is enabled
1553 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
1554 $rulechecked = 'CHECKED';
1557 # Convert rulefile name into category name.
1558 my $categoryname = &_rulefile_to_category
($rulefile);
1560 # Table and rows for the rule files.
1562 print"<td class='base' width='5%'>\n";
1563 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
1565 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
1566 print"<td class='base' width='5%' align='right'>\n";
1567 print"<a href=\"javascript:showhide('$categoryname')\"><span id='span_$categoryname'>$Lang::tr{'ids show'}</span></a>\n";
1571 # Rows which will be hidden per default and will contain the single rules.
1572 print"<tr style='display:none' id='$categoryname'>\n";
1573 print"<td colspan='3'>\n";
1580 # New table for the single rules.
1581 print "<table width='100%'>\n";
1583 # Loop over rule file rules
1584 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
1586 my $ruledefchecked = '';
1588 # Skip rulefile itself.
1589 next if ($sid eq "Rulefile");
1591 # If 2 rules have been displayed, start a new row
1592 if (($lines % 2) == 0) {
1593 print "</tr><tr>\n";
1595 # Increase rows by once.
1601 $col="bgcolor='$color{'color20'}'";
1603 $col="bgcolor='$color{'color22'}'";
1607 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
1608 $ruledefchecked = 'CHECKED';
1611 # Create rule checkbox and display rule description
1612 print "<td class='base' width='5%' align='right' $col>\n";
1613 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
1615 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1617 # Increment rule count
1621 # If do not have a second rule for row, create empty cell
1622 if (($lines % 2) != 0) {
1623 print "<td class='base'></td>";
1626 # Close display table
1627 print "</tr></table></td></tr>";
1630 # Close display table
1634 <table width='100%'>
1636 <td width='100%' align='right'>
1637 <input type='submit' value='$Lang::tr{'fwhost back'}'>
1638 <input type='submit' name='RULESET' value='$Lang::tr{'ids apply'}'>
1645 &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.