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) if (-e
$IDS::ignored_file
);
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) if (-e
$IDS::ignored_file
);
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) if (-e
$IDS::ignored_file
);
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
::get_provider_used_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 # Get enabled providers.
319 my @enabled_providers = &IDS
::get_enabled_providers
();
321 # Loop through the array of enabled providers.
322 foreach my $provider (@enabled_providers) {
323 # Hash to store the used-enabled and disabled sids.
324 my %enabled_disabled_sids;
326 # Hash to store the enabled rulefiles for the current processed provider.
329 # Get name of the file which holds the ruleset modification of the provider.
330 my $modifications_file = &IDS
::get_provider_ruleset_modifications_file
($provider);
332 # Get the name of the file which contains the used rulefiles for this provider.
333 my $used_rulefiles_file = &IDS
::get_provider_used_rulesfiles_file
($provider);
335 # Read-in modifications file, if exists.
336 &General
::readhash
("$modifications_file", \
%enabled_disabled_sids) if (-f
"$modifications_file");
338 # Loop through the hash of idsrules.
339 foreach my $rulefile (keys %idsrules) {
340 # Split the rulefile to get the vendor.
341 my @filename_parts = split(/-/, $rulefile);
343 # Assign rulefile vendor.
344 my $rulefile_vendor = @filename_parts[0];
346 # Skip the rulefile if the vendor is not our current processed provider.
347 next unless ($rulefile_vendor eq $provider);
349 # Check if the rulefile is enabled.
350 if ($cgiparams{$rulefile} eq "on") {
351 # Add the rulefile to the hash of enabled rulefiles of this provider.
352 $used_rulefiles{$rulefile} = "enabled";
354 # Drop item from cgiparams hash.
355 delete $cgiparams{$rulefile};
358 # Loop through the single rules of the rulefile.
359 foreach my $sid (keys %{$idsrules{$rulefile}}) {
360 # Skip the current sid if it is not numeric.
361 next unless ($sid =~ /\d+/ );
363 # Check if there exists a key in the cgiparams hash for this sid.
364 if (exists($cgiparams{$sid})) {
365 # Look if the rule is disabled.
366 if ($idsrules{$rulefile}{$sid}{'State'} eq "off") {
367 # Check if the state has been set to 'on'.
368 if ($cgiparams{$sid} eq "on") {
369 # Add/Modify the sid to/in the enabled_disabled_sids hash.
370 $enabled_disabled_sids{$sid} = "enabled";
372 # Drop item from cgiparams hash.
373 delete $cgiparams{$rulefile}{$sid};
377 # Look if the rule is enabled.
378 if ($idsrules{$rulefile}{$sid}{'State'} eq "on") {
379 # Check if the state is 'on' and should be disabled.
380 # In this case there is no entry
381 # for the sid in the cgiparams hash.
382 # Add/Modify it to/in the enabled_disabled_sids hash.
383 $enabled_disabled_sids{$sid} = "disabled";
385 # Drop item from cgiparams hash.
386 delete $cgiparams{$rulefile}{$sid};
392 # Check if the hash for enabled/disabled sids contains any entries.
393 if (%enabled_disabled_sids) {
394 # Write the modifications file.
395 &General
::writehash
("$modifications_file", \
%enabled_disabled_sids);
398 # Write the used rulefiles file.
399 &General
::writehash
("$used_rulefiles_file", \
%used_rulefiles);
402 # Call function to generate and write the used rulefiles file.
403 &IDS
::write_used_rulefiles_file
(@enabled_providers);
405 # Lock the webpage and print message.
408 # Check if the IDS is running.
409 if(&IDS
::ids_is_running
()) {
410 # Call suricatactrl to perform a reload.
411 &IDS
::call_suricatactrl
("reload");
417 # Download new ruleset.
418 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'ids force ruleset update'}) {
419 # Assign given provider handle.
420 my $provider = $cgiparams{'PROVIDER'};
422 # Check if the red device is active.
423 unless (-e
"${General::swroot}/red/active") {
424 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
427 # Check if enought free disk space is availabe.
428 if(&IDS
::checkdiskspace
()) {
429 $errormessage = "$Lang::tr{'not enough disk space'}";
432 # Check if any errors happend.
433 unless ($errormessage) {
434 # Lock the webpage and print notice about downloading
436 &working_notice
("$Lang::tr{'ids download new ruleset'}");
438 # Call subfunction to download the ruleset.
439 if(&IDS
::downloadruleset
($provider)) {
440 $errormessage = "$provider - $Lang::tr{'could not download latest updates'}";
442 # Call function to store the errormessage.
443 &IDS
::_store_error_message
($errormessage);
445 # Preform a reload of the page.
448 # Call subfunction to launch oinkmaster.
451 # Check if the IDS is running.
452 if(&IDS
::ids_is_running
()) {
453 # Call suricatactrl to perform a reload.
454 &IDS
::call_suricatactrl
("reload");
457 # Perform a reload of the page.
462 # Reset a provider to it's defaults.
463 } elsif ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'ids reset provider'}") {
464 # Get enabled providers.
465 my @enabled_providers = &IDS
::get_enabled_providers
();
467 # Grab provider handle from cgihash.
468 my $provider = $cgiparams{'PROVIDER'};
470 # Lock the webpage and print message.
471 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
473 # Get the name of the file which contains the used rulefiles for this provider.
474 my $used_rulefiles_file = &IDS
::get_provider_used_rulesfiles_file
($provider);
476 # Remove the file if it exists.
477 unlink("$used_rulefiles_file") if (-f
"$used_rulefiles_file");
479 # Call function to get the path and name for file which holds the ruleset modifications
480 # for the given provider.
481 my $modifications_file = &IDS
::get_provider_ruleset_modifications_file
($provider);
483 # Check if the file exists.
484 if (-f
$modifications_file) {
485 # Remove the file, as requested.
486 unlink("$modifications_file");
489 # Write used rulesfiles file.
490 &IDS
::write_used_rulefiles_file
(@enabled_providers);
492 # Regenerate ruleset.
495 # Check if the IDS is running.
496 if(&IDS
::ids_is_running
()) {
497 # Get amount of enabled providers.
498 my $amount = @enabled_providers;
500 # Check if at least one enabled provider remains.
502 # Call suricatactrl to perform a reload.
503 &IDS
::call_suricatactrl
("reload");
505 # Stop suricata if no enabled provider remains.
507 # Call suricatactrel to perform the stop.
508 &IDS
::call_suricatactrl
("stop");
512 # Undefine providers flag.
513 undef($cgiparams{'PROVIDERS'});
519 } elsif ($cgiparams{'IDS'} eq $Lang::tr
{'save'}) {
522 my $monitored_zones = 0;
524 # Read-in current (old) IDS settings.
525 &General
::readhash
("$IDS::ids_settings_file", \
%oldidssettings);
527 # Get enabled providers.
528 my @enabled_providers = &IDS
::get_enabled_providers
();
530 # Prevent form name from been stored in conf file.
531 delete $cgiparams{'IDS'};
533 # Check if the IDS should be enabled.
534 if ($cgiparams{'ENABLE_IDS'} eq "on") {
535 # Check if at least one provider is enabled. Otherwise abort and display an error.
536 unless(@enabled_providers) {
537 $errormessage = $Lang::tr
{'ids no enabled ruleset provider'};
540 # Loop through the array of available interfaces.
541 foreach my $zone (@network_zones) {
542 # Convert interface name into upper case.
543 my $zone_upper = uc($zone);
545 # Check if the IDS is enabled for these interfaces.
546 if ($cgiparams{"ENABLE_IDS_$zone_upper"}) {
552 # Check if at least one zone should be monitored, or show an error.
553 unless ($monitored_zones >= 1) {
554 $errormessage = $Lang::tr
{'ids no network zone'};
558 # Go on if there are no error messages.
559 if (!$errormessage) {
560 # Store settings into settings file.
561 &General
::writehash
("$IDS::ids_settings_file", \
%cgiparams);
564 # Check if the the automatic rule update hass been touched.
565 if($cgiparams{'AUTOUPDATE_INTERVAL'} ne $oldidssettings{'AUTOUPDATE_INTERVAL'}) {
566 # Call suricatactrl to set the new interval.
567 &IDS
::call_suricatactrl
("cron", $cgiparams{'AUTOUPDATE_INTERVAL'});
570 # Generate file to store the home net.
571 &IDS
::generate_home_net_file
();
573 # Generate file to the store the DNS servers.
574 &IDS
::generate_dns_servers_file
();
576 # Generate file to store the HTTP ports.
577 &IDS
::generate_http_ports_file
();
579 # Check if the IDS currently is running.
580 if(&IDS
::ids_is_running
()) {
581 # Check if ENABLE_IDS is set to on.
582 if($cgiparams{'ENABLE_IDS'} eq "on") {
583 # Call suricatactrl to perform a reload of suricata.
584 &IDS
::call_suricatactrl
("reload");
586 # Call suricatactrl to stop suricata.
587 &IDS
::call_suricatactrl
("stop");
590 # Call suricatactrl to start suricata.
591 &IDS
::call_suricatactrl
("start");
594 # Check if the page should be reloaded.
596 # Perform a reload of the page.
600 # Toggle Enable/Disable autoupdate for a provider
601 } elsif ($cgiparams{'AUTOUPDATE'} eq $Lang::tr
{'toggle enable disable'}) {
602 my %used_providers = ();
604 # Only go further, if an ID has been passed.
605 if ($cgiparams{'ID'}) {
606 # Assign the given ID.
607 my $id = $cgiparams{'ID'};
609 # Undef the given ID.
610 undef($cgiparams{'ID'});
612 # Read-in providers settings file.
613 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
615 # Grab the configured status of the corresponding entry.
616 my $status_autoupdate = $used_providers{$id}[2];
619 if ($status_autoupdate eq "disabled") {
620 $status_autoupdate = "enabled";
622 $status_autoupdate = "disabled";
625 # Modify the status of the existing entry.
626 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$status_autoupdate", "$used_providers{$id}[3]", "$used_providers{$id}[4]"];
628 # Write the changed hash to the providers settings file.
629 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
632 # Add/Edit a provider to the list of used providers.
634 } elsif (($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") || ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'update'}")) {
635 my %used_providers = ();
637 # Read-in providers settings file.
638 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
640 # Assign some nice human-readable values.
641 my $provider = $cgiparams{'PROVIDER'};
642 my $subscription_code = $cgiparams{'SUBSCRIPTION_CODE'};
643 my $status_autoupdate;
646 # Handle autoupdate checkbox.
647 if ($cgiparams{'ENABLE_AUTOUPDATE'} eq "on") {
648 $status_autoupdate = "enabled";
650 $status_autoupdate = "disabled";
653 # Handle monitor traffic only checkbox.
654 if ($cgiparams{'MONITOR_TRAFFIC_ONLY'} eq "on") {
660 # Check if we are going to add a new provider.
661 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") {
662 # Loop through the hash of used providers.
663 foreach my $id ( keys %used_providers) {
664 # Check if the choosen provider is already in use.
665 if ($used_providers{$id}[0] eq "$provider") {
666 # Assign error message.
667 $errormessage = "$Lang::tr{'ids the choosen provider is already in use'}";
672 # Check if the provider requires a subscription code.
673 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
674 # Check if an subscription code has been provided.
675 if ($subscription_code) {
676 # Check if the code contains unallowed chars.
677 unless ($subscription_code =~ /^[a-z0-9]+$/) {
678 $errormessage = $Lang::tr
{'invalid input for subscription code'};
681 # Print an error message, that an subsription code is required for this
683 $errormessage = $Lang::tr
{'ids subscription code required'};
687 # Go further if there was no error.
688 if ($errormessage eq '') {
692 # Check if we should edit an existing entry and got an ID.
693 if (($cgiparams{'PROVIDERS'} eq $Lang::tr
{'update'}) && ($cgiparams{'ID'})) {
694 # Assin the provided id.
695 $id = $cgiparams{'ID'};
697 # Undef the given ID.
698 undef($cgiparams{'ID'});
700 # Grab the configured status of the corresponding entry.
701 $status = $used_providers{$id}[3];
703 # Each newly added entry automatically should be enabled.
706 # Generate the ID for the new entry.
708 # Sort the keys by their ID and store them in an array.
709 my @keys = sort { $a <=> $b } keys %used_providers;
711 # Reverse the key array.
712 my @reversed = reverse(@keys);
714 # Obtain the last used id.
715 my $last_id = @reversed[0];
717 # Increase the last id by one and use it as id for the new entry.
721 # Add/Modify the entry to/in the used providers hash..
722 $used_providers{$id} = ["$provider", "$subscription_code", "$status_autoupdate", "$status", "$mode"];
724 # Write the changed hash to the providers settings file.
725 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
727 # Check if a new provider will be added.
728 if ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'add'}) {
729 # Check if the red device is active.
730 unless (-e
"${General::swroot}/red/active") {
731 $errormessage = "$Lang::tr{'ids could not add provider'} - $Lang::tr{'system is offline'}";
734 # Check if enough free disk space is availabe.
735 if(&IDS
::checkdiskspace
()) {
736 $errormessage = "$Lang::tr{'ids could not add provider'} - $Lang::tr{'not enough disk space'}";
739 # Check if any errors happend.
740 unless ($errormessage) {
741 # Lock the webpage and print notice about downloading
743 &working_notice
("$Lang::tr{'ids working'}");
745 # Download the ruleset.
746 if(&IDS
::downloadruleset
($provider)) {
747 $errormessage = "$Lang::tr{'ids could not add provider'} - $Lang::tr{'ids unable to download the ruleset'}";
749 # Call function to store the errormessage.
750 &IDS
::_store_error_message
($errormessage);
752 # Remove the configured provider again.
753 &remove_provider
($id);
755 # Extract the ruleset
756 &IDS
::extractruleset
($provider);
759 &IDS
::move_tmp_ruleset
();
761 # Cleanup temporary directory.
762 &IDS
::cleanup_tmp_directory
();
765 # Perform a reload of the page.
768 # Remove the configured provider again.
769 &remove_provider
($id);
775 # Undefine providers flag.
776 undef($cgiparams{'PROVIDERS'});
778 ## Toggle Enabled/Disabled for an existing provider.
780 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'toggle enable disable'}) {
781 my %used_providers = ();
782 my $provider_includes_action;
784 # Value if oinkmaster has to be executed.
785 my $oinkmaster = "False";
787 # Only go further, if an ID has been passed.
788 if ($cgiparams{'ID'}) {
789 # Assign the given ID.
790 my $id = $cgiparams{'ID'};
792 # Undef the given ID.
793 undef($cgiparams{'ID'});
795 # Read-in file which contains the provider settings.
796 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
798 # Grab the configured status of the corresponding entry.
799 my $status = $used_providers{$id}[3];
801 # Grab the provider handle.
802 my $provider_handle = $used_providers{$id}[0];
805 if ($status eq "enabled") {
806 $status = "disabled";
808 # Set the provider includes action to "remove" for removing the entry.
809 $provider_includes_action = "remove";
813 # Set the provider includes action to "add".
814 $provider_includes_action = "add";
816 # This operation requires to launch oinkmaster.
817 $oinkmaster = "True";
820 # Modify the status of the existing entry.
821 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$used_providers{$id}[2]", "$status", "$used_providers{$id}[4]"];
823 # Write the changed hash to the providers settings file.
824 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
826 # Get all enabled providers.
827 my @enabled_providers = &IDS
::get_enabled_providers
();
829 # Write the main providers include file.
830 &IDS
::write_used_rulefiles_file
(@enabled_providers);
832 # Check if oinkmaster has to be executed.
833 if ($oinkmaster eq "True") {
838 # Check if the IDS is running.
839 if(&IDS
::ids_is_running
()) {
840 # Gather the amount of enabled providers (elements in the array).
841 my $amount = @enabled_providers;
843 # Check if there are still enabled ruleset providers.
845 # Call suricatactrl to perform a restart.
846 &IDS
::call_suricatactrl
("restart");
848 # No active ruleset provider, suricata has to be stopped.
851 &IDS
::call_suricatactrl
("stop");
855 # Undefine providers flag.
856 undef($cgiparams{'PROVIDERS'});
862 ## Remove provider from the list of used providers.
864 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'remove'}) {
865 # Assign a nice human-readable variable.
866 my $id = $cgiparams{'ID'};
868 # Grab the provider name bevore deleting.
869 my $provider = &get_provider_handle
($id);
871 # Remove the provider.
872 &remove_provider
($id);
874 # Undef the given ID.
875 undef($cgiparams{'ID'});
877 # Drop the stored ruleset file.
878 &IDS
::drop_dl_rulesfile
($provider);
880 # Get the name of the provider rulessets include file.
881 my $provider_used_rulefile = &IDS
::get_provider_used_rulesfiles_file
($provider);
883 # Drop the file, it is not longer needed.
884 unlink("$provider_used_rulefile");
886 # Call function to get the path and name for the given providers
887 # ruleset modifications file..
888 my $modifications_file = &IDS
::get_provider_ruleset_modifications_file
($provider);
890 # Check if the file exists.
891 if (-f
$modifications_file) {
892 # Remove the file, which is not longer needed.
893 unlink("$modifications_file");
896 # Regenerate ruleset.
899 # Gather all enabled providers.
900 my @enabled_providers = &IDS
::get_enabled_providers
();
902 # Regenerate main providers include file.
903 &IDS
::write_used_rulefiles_file
(@enabled_providers);
905 # Check if the IDS is running.
906 if(&IDS
::ids_is_running
()) {
907 # Get amount of enabled providers.
908 my $amount = @enabled_providers;
910 # Check if at least one enabled provider remains.
912 # Call suricatactrl to perform a reload.
913 &IDS
::call_suricatactrl
("restart");
915 # Stop suricata if no enabled provider remains.
917 # Call suricatactrel to perform the stop.
918 &IDS
::call_suricatactrl
("stop");
922 # Undefine providers flag.
923 undef($cgiparams{'PROVIDERS'});
929 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
931 &Header
::openbigbox
('100%', 'left', '', $errormessage);
933 &show_display_error_message
();
935 if ($cgiparams{'RULESET'} eq "$Lang::tr{'ids customize ruleset'}" ) {
936 &show_customize_ruleset
();
937 } elsif ($cgiparams{'PROVIDERS'} ne "") {
938 &show_add_provider
();
943 &Header
::closebigbox
();
944 &Header
::closepage
();
947 ## Tiny function to show if a error message happened.
949 sub show_display_error_message
() {
951 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
952 print "<class name='base'>$errormessage\n";
953 print " </class>\n";
959 ## Function to display the main IDS page.
961 sub show_mainpage
() {
962 # Read-in idssettings and provider settings.
963 &General
::readhash
("$IDS::ids_settings_file", \
%idssettings);
964 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
966 # If no autoupdate intervall has been configured yet, set default value.
967 unless(exists($idssettings{'AUTOUPDATE_INTERVAL'})) {
968 # Set default to "weekly".
969 $idssettings{'AUTOUPDATE_INTERVAL'} = 'weekly';
972 # Read-in ignored hosts.
973 &General
::readhasharray
("$IDS::ignored_file", \
%ignored) if (-e
$IDS::ignored_file
);
975 $checked{'ENABLE_IDS'}{'off'} = '';
976 $checked{'ENABLE_IDS'}{'on'} = '';
977 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
978 $selected{'AUTOUPDATE_INTERVAL'}{'off'} = '';
979 $selected{'AUTOUPDATE_INTERVAL'}{'daily'} = '';
980 $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} = '';
981 $selected{'AUTOUPDATE_INTERVAL'}{$idssettings{'AUTOUPDATE_INTERVAL'}} = "selected='selected'";
983 # Draw current state of the IDS
984 &Header
::openbox
('100%', 'left', $Lang::tr
{'intrusion detection system'});
986 # Check if the IDS is running and obtain the process-id.
987 my $pid = &IDS
::ids_is_running
();
989 # Display some useful information, if suricata daemon is running.
991 # Gather used memory.
992 my $memory = &get_memory_usage
($pid);
995 <table width='95%' cellspacing='0' class='tbl'>
997 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1001 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1002 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
1006 <td class='base'></td>
1007 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
1008 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
1012 <td class='base'></td>
1013 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
1014 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
1019 # Otherwise display a hint that the service is not launched.
1021 <table width='95%' cellspacing='0' class='tbl'>
1023 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1027 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1028 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
1034 # Only show this area, if at least one ruleset provider is configured.
1035 if (%used_providers) {
1039 <br><br><h2>$Lang::tr{'settings'}</h2>
1041 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1042 <table width='100%' border='0'>
1044 <td class='base' colspan='2'>
1045 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}> $Lang::tr{'ids enable'}
1059 <td colspan='4'><b>$Lang::tr{'ids monitored interfaces'}</b><br></td>
1066 # Loop through the array of available networks and print config options.
1067 foreach my $zone (@network_zones) {
1069 my $checked_forward;
1071 # Convert current zone name to upper case.
1072 my $zone_upper = uc($zone);
1075 my $zone_name = $zone;
1077 # Dirty hack to get the correct language string for the red zone.
1078 if ($zone eq "red") {
1079 $zone_name = "red1";
1082 # Grab checkbox status from settings hash.
1083 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
1084 $checked_input = "checked = 'checked'";
1087 print "<td class='base' width='20%'>\n";
1088 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>\n";
1089 print " $Lang::tr{'enabled on'}<font color='$colourhash{$zone}'> $Lang::tr{$zone_name}</font>\n";
1104 <td colspan='4'><b>$Lang::tr{'ids automatic rules update'}</b></td>
1109 <select name='AUTOUPDATE_INTERVAL'>
1110 <option value='off' $selected{'AUTOUPDATE_INTERVAL'}{'off'} >- $Lang::tr{'Disabled'} -</option>
1111 <option value='daily' $selected{'AUTOUPDATE_INTERVAL'}{'daily'} >$Lang::tr{'Daily'}</option>
1112 <option value='weekly' $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} >$Lang::tr{'Weekly'}</option>
1120 <table width='100%'>
1122 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
1131 &Header
::closebox
();
1134 # Used Ruleset Providers section.
1136 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ruleset settings'});
1139 <table width='100%' border='0'>
1141 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ids provider'}</b></td>
1142 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'date'}</b></td>
1143 <td class='base' bgcolor='$color{'color20'}' align='center'><b>$Lang::tr{'ids autoupdates'}</b></td>
1144 <td class='base' bgcolor='$color{'color20'}' align='center'><b>$Lang::tr{'action'}</b></td>
1145 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1150 # Check if some providers has been configured.
1151 if (keys (%used_providers)) {
1154 # Loop through all entries of the hash.
1155 foreach my $id (sort keys(%used_providers)) {
1156 # Assign data array positions to some nice variable names.
1157 my $provider = $used_providers{$id}[0];
1158 my $provider_name = &get_provider_name
($provider);
1159 my $rulesetdate = &IDS
::get_ruleset_date
($provider);
1161 my $subscription_code = $used_providers{$id}[1];
1162 my $autoupdate_status = $used_providers{$id}[2];
1163 my $status = $used_providers{$id}[3];
1165 # Check if the item number is even or not.
1167 $col="bgcolor='$color{'color22'}'";
1169 $col="bgcolor='$color{'color20'}'";
1172 # Choose icons for the checkboxes.
1175 my $autoupdate_status_gif;
1176 my $autoupdate_status_gdesc;
1178 # Check if the status is enabled and select the correct image and description.
1179 if ($status eq 'enabled' ) {
1180 $status_gif = 'on.gif';
1181 $status_gdesc = $Lang::tr
{'click to disable'};
1183 $status_gif = 'off.gif';
1184 $status_gdesc = $Lang::tr
{'click to enable'};
1187 # Check if the autoupdate status is enabled and select the correct image and description.
1188 if ($autoupdate_status eq 'enabled') {
1189 $autoupdate_status_gif = 'on.gif';
1190 $autoupdate_status_gdesc = $Lang::tr
{'click to disable'};
1192 $autoupdate_status_gif = 'off.gif';
1193 $autoupdate_status_gdesc = $Lang::tr
{'click to enable'};
1198 <td width='33%' class='base' $col>$provider_name</td>
1199 <td width='30%' class='base' $col>$rulesetdate</td>
1201 <td align='center' $col>
1202 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1203 <input type='hidden' name='AUTOUPDATE' value='$Lang::tr{'toggle enable disable'}' />
1204 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$autoupdate_status_gif' alt='$autoupdate_status_gdesc' title='$autoupdate_status_gdesc' />
1205 <input type='hidden' name='ID' value='$id' />
1209 <td align='center' $col>
1210 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1211 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'toggle enable disable'}'>
1212 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$status_gif' alt='$status_gdesc' title='$status_gdesc'>
1213 <input type='hidden' name='ID' value='$id'>
1217 <td align='center' $col>
1218 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1219 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'edit'}'>
1220 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1221 <input type='hidden' name='ID' value='$id'>
1225 <td align='center' $col>
1226 <form method='post' name='$provider' action='$ENV{'SCRIPT_NAME'}'>
1227 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1228 <input type='hidden' name='ID' value='$id'>
1229 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'remove'}'>
1234 # Increment lines value.
1240 # Print notice that currently no hosts are ignored.
1242 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1248 # Section to add new elements or edit existing ones.
1255 <table width='100%'>
1256 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1260 # Only show this button if a ruleset provider is configured.
1261 if (%used_providers) {
1262 print "<input type='submit' name='RULESET' value='$Lang::tr{'ids customize ruleset'}'>\n";
1265 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids add provider'}'>
1272 &Header
::closebox
();
1275 # Whitelist / Ignorelist
1277 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ignored hosts'});
1280 <table width='100%'>
1282 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
1283 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
1284 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1287 # Check if some hosts have been added to be ignored.
1288 if (keys (%ignored)) {
1291 # Loop through all entries of the hash.
1292 while( (my $key) = each %ignored) {
1293 # Assign data array positions to some nice variable names.
1294 my $address = $ignored{$key}[0];
1295 my $remark = $ignored{$key}[1];
1296 my $status = $ignored{$key}[2];
1298 # Check if the key (id) number is even or not.
1299 if ($cgiparams{'ID'} eq $key) {
1300 $col="bgcolor='${Header::colouryellow}'";
1301 } elsif ($key % 2) {
1302 $col="bgcolor='$color{'color22'}'";
1304 $col="bgcolor='$color{'color20'}'";
1307 # Choose icon for the checkbox.
1311 # Check if the status is enabled and select the correct image and description.
1312 if ($status eq 'enabled' ) {
1314 $gdesc = $Lang::tr
{'click to disable'};
1317 $gdesc = $Lang::tr
{'click to enable'};
1322 <td width='20%' class='base' $col>$address</td>
1323 <td width='65%' class='base' $col>$remark</td>
1325 <td align='center' $col>
1326 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1327 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}'>
1328 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc'>
1329 <input type='hidden' name='ID' value='$key'>
1333 <td align='center' $col>
1334 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1335 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}'>
1336 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1337 <input type='hidden' name='ID' value='$key'>
1341 <td align='center' $col>
1342 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
1343 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1344 <input type='hidden' name='ID' value='$key'>
1345 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
1352 # Print notice that currently no hosts are ignored.
1354 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1360 # Section to add new elements or edit existing ones.
1366 <div align='center'>
1367 <table width='100%'>
1370 # Assign correct headline and button text.
1375 # Check if an ID (key) has been given, in this case an existing entry should be edited.
1376 if ($cgiparams{'ID'} ne '') {
1377 $buttontext = $Lang::tr
{'update'};
1378 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
1380 # Grab address and remark for the given key.
1381 $entry_address = $ignored{$cgiparams{'ID'}}[0];
1382 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
1384 $buttontext = $Lang::tr
{'add'};
1385 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
1389 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1390 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1392 <td width='30%'>$Lang::tr{'ip address'}: </td>
1393 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
1395 <td width='30%'>$Lang::tr{'remark'}: </td>
1396 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
1397 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
1404 &Header
::closebox
();
1408 ## Function to show the customize ruleset section.
1410 sub show_customize_ruleset
() {
1414 # Java script variable declaration for show and hide.
1415 print"var show = \"$Lang::tr{'ids show'}\"\;\n";
1416 print"var hide = \"$Lang::tr{'ids hide'}\"\;\n";
1419 // Tiny javascript function to show/hide the rules
1420 // of a given category.
1421 function showhide(tblname) {
1422 \$("#" + tblname).toggle();
1424 // Get current content of the span element.
1425 var content = document.getElementById("span_" + tblname);
1427 if (content.innerHTML === show) {
1428 content.innerHTML = hide;
1430 content.innerHTML = show;
1436 &Header
::openbox
('100%', 'LEFT', "$Lang::tr{'intrusion detection system rules'}" );
1437 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
1439 # Output display table for rule files
1440 print "<table width='100%'>\n";
1442 # Loop over each rule file
1443 foreach my $rulefile (sort keys(%idsrules)) {
1444 my $rulechecked = '';
1446 # Check if rule file is enabled
1447 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
1448 $rulechecked = 'CHECKED';
1451 # Convert rulefile name into category name.
1452 my $categoryname = &_rulefile_to_category
($rulefile);
1454 # Table and rows for the rule files.
1456 print"<td class='base' width='5%'>\n";
1457 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
1459 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
1460 print"<td class='base' width='5%' align='right'>\n";
1461 print"<a href=\"javascript:showhide('$categoryname')\"><span id='span_$categoryname'>$Lang::tr{'ids show'}</span></a>\n";
1465 # Rows which will be hidden per default and will contain the single rules.
1466 print"<tr style='display:none' id='$categoryname'>\n";
1467 print"<td colspan='3'>\n";
1474 # New table for the single rules.
1475 print "<table width='100%'>\n";
1477 # Loop over rule file rules
1478 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
1480 my $ruledefchecked = '';
1482 # Skip rulefile itself.
1483 next if ($sid eq "Rulefile");
1485 # If 2 rules have been displayed, start a new row
1486 if (($lines % 2) == 0) {
1487 print "</tr><tr>\n";
1489 # Increase rows by once.
1495 $col="bgcolor='$color{'color20'}'";
1497 $col="bgcolor='$color{'color22'}'";
1501 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
1502 $ruledefchecked = 'CHECKED';
1505 # Create rule checkbox and display rule description
1506 print "<td class='base' width='5%' align='right' $col>\n";
1507 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
1509 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1511 # Increment rule count
1515 # If do not have a second rule for row, create empty cell
1516 if (($lines % 2) != 0) {
1517 print "<td class='base'></td>";
1520 # Close display table
1521 print "</tr></table></td></tr>";
1524 # Close display table
1528 <table width='100%'>
1530 <td width='100%' align='right'>
1531 <input type='submit' value='$Lang::tr{'fwhost back'}'>
1532 <input type='submit' name='RULESET' value='$Lang::tr{'ids apply'}'>
1539 &Header
::closebox
();
1543 ## Function to show section for add/edit a provider.
1545 sub show_add_provider
() {
1546 my %used_providers = ();
1547 my @subscription_providers;
1549 # Read -in providers settings file.
1550 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
1552 # Get all supported ruleset providers.
1553 my @ruleset_providers = &IDS
::get_ruleset_providers
();
1558 # Generate Java Script Object which contains the URL of the providers.
1559 print "\t// Object, which contains the webpages of the ruleset providers.\n";
1560 print "\tvar url = {\n";
1562 # Loop through the array of supported providers.
1563 foreach my $provider (@ruleset_providers) {
1564 # Check if the provider requires a subscription.
1565 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
1566 # Add the provider to the array of subscription_providers.
1567 push(@subscription_providers, $provider);
1570 # Grab the URL for the provider.
1571 my $url = $IDS::Ruleset
::Providers
{$provider}{'website'};
1573 # Print the URL to the Java Script Object.
1574 print "\t\t$provider: \"$url\"\,\n";
1577 # Close the Java Script Object declaration.
1580 # Generate Java Script Array which contains the provider that requires a subscription.
1582 $line = join("', '", @subscription_providers);
1584 print "\t// Array which contains the providers that requires a subscription.\n";
1585 print "\tsubscription_provider = ['$line']\;\n\n";
1588 // Java Script function to swap the text input field for
1589 // entering a subscription code.
1590 var update_provider = function() {
1591 if(inArray(\$('#PROVIDER').val(), subscription_provider)) {
1592 \$('.subscription_code').show();
1594 \$('.subscription_code').hide();
1597 // Call function to change the website url.
1598 change_url(\$('#PROVIDER').val());
1601 // Java Script function to check if a given value is part of
1603 function inArray(value,array) {
1604 var count=array.length;
1606 for(var i=0;i<count;i++) {
1607 if(array[i]===value){
1615 // Tiny function to change the website url based on the selected element in the "PROVIDERS"
1617 function change_url(provider) {
1618 // Get and change the href to the corresponding url.
1619 document.getElementById("website").href = url[provider];
1622 // JQuery function to call corresponding function when
1623 // the ruleset provider is changed or the page is loaded for showing/hiding
1624 // the subscription_code area.
1625 \$(document).ready(function() {
1626 \$('#PROVIDER').change(update_provider);
1634 # Check if an existing provider should be edited.
1635 if($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1636 # Check if autoupdate is enabled for this provider.
1637 if ($used_providers{$cgiparams{'ID'}}[2] eq "enabled") {
1638 # Set the checkbox to be checked.
1639 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1642 # Check if the monitor traffic only mode is set for this provider.
1643 if ($used_providers{$cgiparams{'ID'}}[4] eq "IDS") {
1644 # Set the checkbox to be checked.
1645 $checked{'MONITOR_TRAFFIC_ONLY'} = "checked='checked'";
1648 # Display section to force an rules update and to reset the provider.
1649 &show_additional_provider_actions
();
1651 } elsif ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'ids add provider'}") {
1652 # Set the autoupdate to true as default.
1653 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1656 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids provider settings'});
1659 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1660 <table width='100%' border='0'>
1662 <td colspan='2'><b>$Lang::tr{'ids provider'}</b></td>
1667 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1670 # Value to allow disabling the dropdown menu.
1673 # Check if we are in edit mode.
1674 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1675 $disabled = "disabled";
1677 # Add hidden input with the provider because the disable select does not provider
1679 print "<input type='hidden' name='PROVIDER' value='$used_providers{$cgiparams{'ID'}}[0]'>\n";
1682 print "<select name='PROVIDER' id='PROVIDER' $disabled>\n";
1683 # Temporary hash to store the provier names and their handles.
1686 # Loop through the array of ruleset providers.
1687 foreach my $handle (@ruleset_providers) {
1688 # Get the provider name.
1689 my $name = &get_provider_name
($handle);
1691 # Add the grabbed provider name and handle to the
1693 $tmphash{$name} = "$handle";
1696 # Sort and loop through the temporary hash.
1697 foreach my $provider_name ( sort keys %tmphash ) {
1698 # Grab the provider handle.
1699 my $provider = $tmphash{$provider_name};
1701 # Pre-select the provider if one is given.
1702 if (($used_providers{$cgiparams{'ID'}}[0] eq "$provider") || ($cgiparams{'PROVIDER'} eq "$provider")) {
1703 $selected{$provider} = "selected='selected'";
1706 # Add the provider to the dropdown menu.
1707 print "<option value='$provider' $selected{$provider}>$provider_name</option>\n";
1714 <b><a id="website" target="_blank" href="#">$Lang::tr{'ids visit provider website'}</a></b>
1719 <td colspan='2'><br><br></td>
1722 <tr class='subscription_code' style='display:none' id='subscription_code'>
1727 <b>$Lang::tr{'subscription code'}</b>
1733 <input type='text' size='40' name='SUBSCRIPTION_CODE' value='$used_providers{$cgiparams{'ID'}}[1]'>
1746 <input type='checkbox' name='ENABLE_AUTOUPDATE' $checked{'ENABLE_AUTOUPDATE'}> $Lang::tr{'ids enable automatic updates'}
1750 <input type='checkbox' name='MONITOR_TRAFFIC_ONLY' $checked{'MONITOR_TRAFFIC_ONLY'}> $Lang::tr{'ids monitor traffic only'}
1755 <td colspan='2' align='right'>
1756 <input type='submit' value='$Lang::tr{'back'}'>
1759 # Check if a provider should be added or edited.
1760 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1761 # Display button for updating the existing provider.
1762 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'update'}'>\n";
1764 # Display button to add the new provider.
1765 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'add'}'>\n";
1774 &Header
::closebox
();
1778 ## Function to show the area where additional provider actions can be done.
1780 sub show_additional_provider_actions
() {
1782 my %used_providers = ();
1784 # Read-in providers settings file.
1785 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
1787 # Assign variable for provider handle.
1788 my $provider = "$used_providers{$cgiparams{'ID'}}[0]";
1790 # Call function to get the path and name for the given provider
1791 # ruleset modifications file.
1792 my $modifications_file = &IDS
::get_provider_ruleset_modifications_file
($provider);
1794 # Disable the reset provider button if no provider modified sids file exists.
1795 unless (-f
$modifications_file) {
1796 $disabled = "disabled";
1799 &Header
::openbox
('100%', 'center', "");
1801 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1802 <table width='100%' border="0">
1805 <input type='hidden' name='PROVIDER' value='$provider'>
1806 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids reset provider'}' $disabled>
1807 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids force ruleset update'}'>
1814 &Header
::closebox
();
1818 ## A function to display a notice, to lock the webpage and
1819 ## tell the user which action currently will be performed.
1821 sub working_notice
($) {
1824 &_open_working_notice
($message);
1825 &_close_working_notice
();
1829 ## Private function to lock the page and tell the user what is going on.
1831 sub _open_working_notice
($) {
1834 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
1835 &Header
::openbigbox
('100%', 'left', '', $errormessage);
1836 &Header
::openbox
( 'Waiting', 1,);
1840 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
1847 ## Private function to close a working notice.
1849 sub _close_working_notice
() {
1852 &Header
::closebox
();
1853 &Header
::closebigbox
();
1854 &Header
::closepage
();
1858 ## Function which locks the webpage and basically does the same as the
1859 ## oinkmaster function, but provides a lot of HTML formated status output.
1861 sub oinkmaster_web
() {
1862 my @enabled_providers = &IDS
::get_enabled_providers
();
1864 # Lock the webpage and print message.
1865 &_open_working_notice
("$Lang::tr{'ids apply ruleset changes'}");
1867 # Check if the files in rulesdir have the correct permissions.
1868 &IDS
::_check_rulesdir_permissions
();
1870 print "<tr><td><br><br></td></tr>\n";
1872 # Cleanup the rules directory before filling it with the new rulests.
1873 &_add_to_notice
("Remove old rule structures...");
1874 &IDS
::_cleanup_rulesdir
();
1876 # Loop through the array of enabled providers.
1877 foreach my $provider (@enabled_providers) {
1878 &_add_to_notice
("Extracting ruleset for provider: $provider");
1879 # Call the extractruleset function.
1880 &IDS
::extractruleset
($provider);
1883 # Call function to process the ruleset and do all modifications.
1884 &_add_to_notice
("Adjust rules and add user defined customizations...");
1885 &IDS
::process_ruleset
(@enabled_providers);
1887 # Call function to merge the classification files.
1888 &_add_to_notice
("Merging classifications ...");
1889 &IDS
::merge_classifications
(@enabled_providers);
1891 # Call function to merge the sid to message mapping files.
1892 &_add_to_notice
("Merging sid to message files ...");
1893 &IDS
::merge_sid_msg
(@enabled_providers);
1895 # Cleanup temporary directory.
1896 &_add_to_notice
("Cleanup temporary directory ...");
1897 &IDS
::cleanup_tmp_directory
();
1899 # Finished - print a notice.
1900 &_add_to_notice
("Finished...");
1902 # Close the working notice.
1903 &_close_working_notice
();
1907 ## Tiny private function to add a given message to a notice table.
1909 sub _add_to_notice
($) {
1912 print "<tr><td colspan='2'><li><b>$message</b></li></td></tr>\n";
1916 ## A tiny function to perform a reload of the webpage after one second.
1919 print "<meta http-equiv='refresh' content='1'>\n";
1926 ## Private function to read-in and parse rules of a given rulefile.
1928 ## The given file will be read, parsed and all valid rules will be stored by ID,
1929 ## message/description and it's state in the idsrules hash.
1931 sub readrulesfile
($) {
1932 my $rulefile = shift;
1934 # Open rule file and read in contents
1935 open(RULEFILE
, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
1937 # Store file content in an array.
1938 my @lines = <RULEFILE
>;
1943 # Loop over rule file contents
1944 foreach my $line (@lines) {
1945 # Remove whitespaces.
1949 next if ($line =~ /^\s*$/);
1955 # Gather rule sid and message from the ruleline.
1956 if ($line =~ m/.*msg:\s*\"(.*?)\"\;.*sid:\s*(.*?); /) {
1960 # Check if a rule has been found.
1962 # Add rule to the idsrules hash.
1963 $idsrules{$rulefile}{$sid}{'Description'} = $msg;
1965 # Grab status of the rule. Check if ruleline starts with a "dash".
1966 if ($line =~ /^\#/) {
1967 # If yes, the rule is disabled.
1968 $idsrules{$rulefile}{$sid}{'State'} = "off";
1970 # Otherwise the rule is enabled.
1971 $idsrules{$rulefile}{$sid}{'State'} = "on";
1979 ## Function to get the used memory of a given process-id.
1981 sub get_memory_usage
($) {
1986 # Try to open the status file for the given process-id on the pseudo
1988 if (open(FILE
, "/proc/$pid/status")) {
1989 # Loop through the entire file.
1991 # Splitt current line content and store them into variables.
1992 my ($key, $value) = split(":", $_, 2);
1994 # Check if the current key is the one which contains the memory usage.
1995 # The wanted one is VmRSS which contains the Real-memory (resident set)
1996 # of the entire process.
1997 if ($key eq "VmRSS") {
1998 # Found the memory usage add it to the memory variable.
2006 # Close file handle.
2009 # Return memory usage.
2013 # If the file could not be open, return nothing.
2018 ## Function to get the provider handle by a given ID.
2020 sub get_provider_handle
($) {
2023 my %used_providers = ();
2025 # Read-in provider settings file.
2026 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
2028 # Obtain the provider handle for the given ID.
2029 my $provider_handle = $used_providers{$cgiparams{'ID'}}[0];
2031 # Return the handle.
2032 return $provider_handle;
2036 ## Function to get the provider name from the language file or providers file for a given handle.
2038 sub get_provider_name
($) {
2042 # Get the required translation string for the given provider handle.
2043 my $tr_string = $IDS::Ruleset
::Providers
{$handle}{'tr_string'};
2045 # Check if the translation string is available in the language files.
2046 if ($Lang::tr
{$tr_string}) {
2047 # Use the translated string from the language file.
2048 $provider_name = $Lang::tr
{$tr_string};
2050 # Fallback and use the provider summary from the providers file.
2051 $provider_name = $IDS::Ruleset
::Providers
{$handle}{'summary'};
2054 # Return the obtained provider name.
2055 return $provider_name;
2059 ## Function to remove a provider by a given ID.
2061 sub remove_provider
($) {
2064 my %used_providers = ();
2066 # Read-in provider settings file.
2067 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
2069 # Drop entry from the hash.
2070 delete($used_providers{$id});
2072 # Write the changed hash to the provider settings file.
2073 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
2077 ## Private function to convert a given rulefile to a category name.
2078 ## ( No file extension anymore and if the name contained a dot, it
2079 ## would be replaced by a underline sign.)
2081 sub _rulefile_to_category
($) {
2082 my ($filename) = @_;
2084 # Splitt the filename into single chunks and store them in a
2086 my @parts = split(/\./, $filename);
2088 # Return / Remove last element of the temporary array.
2089 # This removes the file extension.
2092 # Join together the single elements of the temporary array.
2093 # If these are more than one, use a "underline" for joining.
2094 my $category = join '_', @parts;
2096 # Return the converted filename.