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 my $return = &IDS
::downloadruleset
($provider);
441 # Check if the download function gives a return code.
443 # Handle different return codes.
444 if ($return eq "not modified") {
445 $errormessage = "$provider - $Lang::tr{'ids ruleset is up to date'}";
447 $errormessage = "$provider - $Lang::tr{'could not download latest updates'}: $return";
450 # Call function to store the errormessage.
451 &IDS
::_store_error_message
($errormessage);
453 # Preform a reload of the page.
456 # Call subfunction to launch oinkmaster.
459 # Check if the IDS is running.
460 if(&IDS
::ids_is_running
()) {
461 # Call suricatactrl to perform a reload.
462 &IDS
::call_suricatactrl
("reload");
465 # Perform a reload of the page.
470 # Reset a provider to it's defaults.
471 } elsif ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'ids reset provider'}") {
472 # Get enabled providers.
473 my @enabled_providers = &IDS
::get_enabled_providers
();
475 # Grab provider handle from cgihash.
476 my $provider = $cgiparams{'PROVIDER'};
478 # Lock the webpage and print message.
479 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
481 # Get the name of the file which contains the used rulefiles for this provider.
482 my $used_rulefiles_file = &IDS
::get_provider_used_rulesfiles_file
($provider);
484 # Remove the file if it exists.
485 unlink("$used_rulefiles_file") if (-f
"$used_rulefiles_file");
487 # Call function to get the path and name for file which holds the ruleset modifications
488 # for the given provider.
489 my $modifications_file = &IDS
::get_provider_ruleset_modifications_file
($provider);
491 # Check if the file exists.
492 if (-f
$modifications_file) {
493 # Remove the file, as requested.
494 unlink("$modifications_file");
497 # Write used rulesfiles file.
498 &IDS
::write_used_rulefiles_file
(@enabled_providers);
500 # Regenerate ruleset.
503 # Check if the IDS is running.
504 if(&IDS
::ids_is_running
()) {
505 # Get amount of enabled providers.
506 my $amount = @enabled_providers;
508 # Check if at least one enabled provider remains.
510 # Call suricatactrl to perform a reload.
511 &IDS
::call_suricatactrl
("reload");
513 # Stop suricata if no enabled provider remains.
515 # Call suricatactrel to perform the stop.
516 &IDS
::call_suricatactrl
("stop");
520 # Undefine providers flag.
521 undef($cgiparams{'PROVIDERS'});
527 } elsif ($cgiparams{'IDS'} eq $Lang::tr
{'save'}) {
530 my $monitored_zones = 0;
532 # Read-in current (old) IDS settings.
533 &General
::readhash
("$IDS::ids_settings_file", \
%oldidssettings);
535 # Get enabled providers.
536 my @enabled_providers = &IDS
::get_enabled_providers
();
538 # Prevent form name from been stored in conf file.
539 delete $cgiparams{'IDS'};
541 # Check if the IDS should be enabled.
542 if ($cgiparams{'ENABLE_IDS'} eq "on") {
543 # Check if at least one provider is enabled. Otherwise abort and display an error.
544 unless(@enabled_providers) {
545 $errormessage = $Lang::tr
{'ids no enabled ruleset provider'};
548 # Loop through the array of available interfaces.
549 foreach my $zone (@network_zones) {
550 # Convert interface name into upper case.
551 my $zone_upper = uc($zone);
553 # Check if the IDS is enabled for these interfaces.
554 if ($cgiparams{"ENABLE_IDS_$zone_upper"}) {
560 # Check if at least one zone should be monitored, or show an error.
561 unless ($monitored_zones >= 1) {
562 $errormessage = $Lang::tr
{'ids no network zone'};
566 # Go on if there are no error messages.
567 if (!$errormessage) {
568 # Store settings into settings file.
569 &General
::writehash
("$IDS::ids_settings_file", \
%cgiparams);
572 # Generate file to store the home net.
573 &IDS
::generate_home_net_file
();
575 # Generate file to the store the DNS servers.
576 &IDS
::generate_dns_servers_file
();
578 # Generate file to store the HTTP ports.
579 &IDS
::generate_http_ports_file
();
581 # Check if the IDS currently is running.
582 if(&IDS
::ids_is_running
()) {
583 # Check if ENABLE_IDS is set to on.
584 if($cgiparams{'ENABLE_IDS'} eq "on") {
585 # Call suricatactrl to perform a reload of suricata.
586 &IDS
::call_suricatactrl
("reload");
588 # Call suricatactrl to stop suricata.
589 &IDS
::call_suricatactrl
("stop");
592 # Call suricatactrl to start suricata.
593 &IDS
::call_suricatactrl
("start");
596 # Check if the page should be reloaded.
598 # Perform a reload of the page.
602 # Toggle Enable/Disable autoupdate for a provider
603 } elsif ($cgiparams{'AUTOUPDATE'} eq $Lang::tr
{'toggle enable disable'}) {
604 my %used_providers = ();
606 # Only go further, if an ID has been passed.
607 if ($cgiparams{'ID'}) {
608 # Assign the given ID.
609 my $id = $cgiparams{'ID'};
611 # Undef the given ID.
612 undef($cgiparams{'ID'});
614 # Read-in providers settings file.
615 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
617 # Grab the configured status of the corresponding entry.
618 my $status_autoupdate = $used_providers{$id}[2];
621 if ($status_autoupdate eq "disabled") {
622 $status_autoupdate = "enabled";
624 $status_autoupdate = "disabled";
627 # Modify the status of the existing entry.
628 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$status_autoupdate", "$used_providers{$id}[3]", "$used_providers{$id}[4]"];
630 # Write the changed hash to the providers settings file.
631 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
634 # Add/Edit a provider to the list of used providers.
636 } elsif (($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") || ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'update'}")) {
637 my %used_providers = ();
639 # Read-in providers settings file.
640 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
642 # Assign some nice human-readable values.
643 my $provider = $cgiparams{'PROVIDER'};
644 my $subscription_code = $cgiparams{'SUBSCRIPTION_CODE'};
645 my $status_autoupdate;
647 my $regenerate_ruleset_required;
649 # Handle autoupdate checkbox.
650 if ($cgiparams{'ENABLE_AUTOUPDATE'} eq "on") {
651 $status_autoupdate = "enabled";
653 $status_autoupdate = "disabled";
656 # Handle monitor traffic only checkbox.
657 if ($cgiparams{'MONITOR_TRAFFIC_ONLY'} eq "on") {
663 # Check if we are going to add a new provider.
664 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") {
665 # Loop through the hash of used providers.
666 foreach my $id ( keys %used_providers) {
667 # Check if the choosen provider is already in use.
668 if ($used_providers{$id}[0] eq "$provider") {
669 # Assign error message.
670 $errormessage = "$Lang::tr{'ids the choosen provider is already in use'}";
675 # Check if the provider requires a subscription code.
676 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
677 # Check if an subscription code has been provided.
678 if ($subscription_code) {
679 # Check if the code contains unallowed chars.
680 unless ($subscription_code =~ /^[a-z0-9]+$/) {
681 $errormessage = $Lang::tr
{'invalid input for subscription code'};
684 # Print an error message, that an subsription code is required for this
686 $errormessage = $Lang::tr
{'ids subscription code required'};
690 # Go further if there was no error.
691 if ($errormessage eq '') {
695 # Check if we should edit an existing entry and got an ID.
696 if (($cgiparams{'PROVIDERS'} eq $Lang::tr
{'update'}) && ($cgiparams{'ID'})) {
697 # Assin the provided id.
698 $id = $cgiparams{'ID'};
700 # Undef the given ID.
701 undef($cgiparams{'ID'});
703 # Grab the configured mode.
704 my $stored_mode = $used_providers{$id}[4];
706 # Check if the ruleset action (mode) has been changed.
707 if ($stored_mode ne $mode) {
708 # It has been changed, so the ruleset needs to be regenerated.
709 $regenerate_ruleset_required = "1";
712 # Grab the configured status of the corresponding entry.
713 $status = $used_providers{$id}[3];
715 # Each newly added entry automatically should be enabled.
718 # Generate the ID for the new entry.
720 # Sort the keys by their ID and store them in an array.
721 my @keys = sort { $a <=> $b } keys %used_providers;
723 # Reverse the key array.
724 my @reversed = reverse(@keys);
726 # Obtain the last used id.
727 my $last_id = @reversed[0];
729 # Increase the last id by one and use it as id for the new entry.
733 # Add/Modify the entry to/in the used providers hash..
734 $used_providers{$id} = ["$provider", "$subscription_code", "$status_autoupdate", "$status", "$mode"];
736 # Write the changed hash to the providers settings file.
737 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
739 # Check if a new provider will be added.
740 if ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'add'}) {
741 # Check if the red device is active.
742 unless (-e
"${General::swroot}/red/active") {
743 $errormessage = "$Lang::tr{'ids could not add provider'} - $Lang::tr{'system is offline'}";
746 # Check if enough free disk space is availabe.
747 if(&IDS
::checkdiskspace
()) {
748 $errormessage = "$Lang::tr{'ids could not add provider'} - $Lang::tr{'not enough disk space'}";
751 # Check if any errors happend.
752 unless ($errormessage) {
753 # Lock the webpage and print notice about downloading
755 &working_notice
("$Lang::tr{'ids working'}");
757 # Download the ruleset.
758 my $return = &IDS
::downloadruleset
($provider);
760 # Check if the downloader returned a code.
762 $errormessage = "$Lang::tr{'ids could not add provider'} - $Lang::tr{'ids unable to download the ruleset'}: $return";
764 # Call function to store the errormessage.
765 &IDS
::_store_error_message
($errormessage);
767 # Remove the configured provider again.
768 &remove_provider
($id);
770 # Extract the ruleset
771 &IDS
::extractruleset
($provider);
774 &IDS
::move_tmp_ruleset
();
776 # Cleanup temporary directory.
777 &IDS
::cleanup_tmp_directory
();
780 # Perform a reload of the page.
783 # Remove the configured provider again.
784 &remove_provider
($id);
788 # Check if the ruleset has to be regenerated.
789 if ($regenerate_ruleset_required) {
790 # Call oinkmaster web function.
793 # Perform a reload of the page.
798 # Undefine providers flag.
799 undef($cgiparams{'PROVIDERS'});
801 ## Toggle Enabled/Disabled for an existing provider.
803 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'toggle enable disable'}) {
804 my %used_providers = ();
805 my $provider_includes_action;
807 # Value if oinkmaster has to be executed.
808 my $oinkmaster = "False";
810 # Only go further, if an ID has been passed.
811 if ($cgiparams{'ID'}) {
812 # Assign the given ID.
813 my $id = $cgiparams{'ID'};
815 # Undef the given ID.
816 undef($cgiparams{'ID'});
818 # Read-in file which contains the provider settings.
819 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
821 # Grab the configured status of the corresponding entry.
822 my $status = $used_providers{$id}[3];
824 # Grab the provider handle.
825 my $provider_handle = $used_providers{$id}[0];
828 if ($status eq "enabled") {
829 $status = "disabled";
831 # Set the provider includes action to "remove" for removing the entry.
832 $provider_includes_action = "remove";
836 # Set the provider includes action to "add".
837 $provider_includes_action = "add";
839 # This operation requires to launch oinkmaster.
840 $oinkmaster = "True";
843 # Modify the status of the existing entry.
844 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$used_providers{$id}[2]", "$status", "$used_providers{$id}[4]"];
846 # Write the changed hash to the providers settings file.
847 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
849 # Get all enabled providers.
850 my @enabled_providers = &IDS
::get_enabled_providers
();
852 # Write the main providers include file.
853 &IDS
::write_used_rulefiles_file
(@enabled_providers);
855 # Check if oinkmaster has to be executed.
856 if ($oinkmaster eq "True") {
861 # Check if the IDS is running.
862 if(&IDS
::ids_is_running
()) {
863 # Gather the amount of enabled providers (elements in the array).
864 my $amount = @enabled_providers;
866 # Check if there are still enabled ruleset providers.
868 # Call suricatactrl to perform a restart.
869 &IDS
::call_suricatactrl
("restart");
871 # No active ruleset provider, suricata has to be stopped.
874 &IDS
::call_suricatactrl
("stop");
878 # Undefine providers flag.
879 undef($cgiparams{'PROVIDERS'});
885 ## Remove provider from the list of used providers.
887 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'remove'}) {
888 # Assign a nice human-readable variable.
889 my $id = $cgiparams{'ID'};
891 # Grab the provider name bevore deleting.
892 my $provider = &get_provider_handle
($id);
894 # Remove the provider.
895 &remove_provider
($id);
897 # Undef the given ID.
898 undef($cgiparams{'ID'});
900 # Drop the stored ruleset file.
901 &IDS
::drop_dl_rulesfile
($provider);
903 # Get the name of the provider rulessets include file.
904 my $provider_used_rulefile = &IDS
::get_provider_used_rulesfiles_file
($provider);
906 # Drop the file, it is not longer needed.
907 unlink("$provider_used_rulefile");
909 # Call function to get the path and name for the given providers
910 # ruleset modifications file..
911 my $modifications_file = &IDS
::get_provider_ruleset_modifications_file
($provider);
913 # Check if the file exists.
914 if (-f
$modifications_file) {
915 # Remove the file, which is not longer needed.
916 unlink("$modifications_file");
919 # Regenerate ruleset.
922 # Gather all enabled providers.
923 my @enabled_providers = &IDS
::get_enabled_providers
();
925 # Regenerate main providers include file.
926 &IDS
::write_used_rulefiles_file
(@enabled_providers);
928 # Check if the IDS is running.
929 if(&IDS
::ids_is_running
()) {
930 # Get amount of enabled providers.
931 my $amount = @enabled_providers;
933 # Check if at least one enabled provider remains.
935 # Call suricatactrl to perform a reload.
936 &IDS
::call_suricatactrl
("restart");
938 # Stop suricata if no enabled provider remains.
940 # Call suricatactrel to perform the stop.
941 &IDS
::call_suricatactrl
("stop");
945 # Undefine providers flag.
946 undef($cgiparams{'PROVIDERS'});
952 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
954 &Header
::openbigbox
('100%', 'left', '', $errormessage);
956 &show_display_error_message
();
958 if ($cgiparams{'RULESET'} eq "$Lang::tr{'ids customize ruleset'}" ) {
959 &show_customize_ruleset
();
960 } elsif ($cgiparams{'PROVIDERS'} ne "") {
961 &show_add_provider
();
966 &Header
::closebigbox
();
967 &Header
::closepage
();
970 ## Tiny function to show if a error message happened.
972 sub show_display_error_message
() {
974 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
975 print "<class name='base'>$errormessage\n";
976 print " </class>\n";
982 ## Function to display the main IDS page.
984 sub show_mainpage
() {
985 # Read-in idssettings and provider settings.
986 &General
::readhash
("$IDS::ids_settings_file", \
%idssettings);
987 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
989 # Read-in ignored hosts.
990 &General
::readhasharray
("$IDS::ignored_file", \
%ignored) if (-e
$IDS::ignored_file
);
992 $checked{'ENABLE_IDS'}{'off'} = '';
993 $checked{'ENABLE_IDS'}{'on'} = '';
994 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
996 # Draw current state of the IDS
997 &Header
::openbox
('100%', 'left', $Lang::tr
{'intrusion detection system'});
999 # Check if the IDS is running and obtain the process-id.
1000 my $pid = &IDS
::ids_is_running
();
1002 # Display some useful information, if suricata daemon is running.
1004 # Gather used memory.
1005 my $memory = &get_memory_usage
($pid);
1008 <table width='95%' cellspacing='0' class='tbl'>
1010 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1014 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1015 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
1019 <td class='base'></td>
1020 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
1021 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
1025 <td class='base'></td>
1026 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
1027 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
1032 # Otherwise display a hint that the service is not launched.
1034 <table width='95%' cellspacing='0' class='tbl'>
1036 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1040 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1041 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
1047 # Only show this area, if at least one ruleset provider is configured.
1048 if (%used_providers) {
1052 <br><br><h2>$Lang::tr{'settings'}</h2>
1054 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1055 <table width='100%' border='0'>
1057 <td class='base' colspan='2'>
1058 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}> $Lang::tr{'ids enable'}
1072 <td colspan='4'><b>$Lang::tr{'ids monitored interfaces'}</b><br></td>
1079 # Loop through the array of available networks and print config options.
1080 foreach my $zone (@network_zones) {
1082 my $checked_forward;
1084 # Convert current zone name to upper case.
1085 my $zone_upper = uc($zone);
1088 my $zone_name = $zone;
1090 # Dirty hack to get the correct language string for the red zone.
1091 if ($zone eq "red") {
1092 $zone_name = "red1";
1095 # Grab checkbox status from settings hash.
1096 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
1097 $checked_input = "checked = 'checked'";
1100 print "<td class='base' width='20%'>\n";
1101 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>\n";
1102 print " $Lang::tr{'enabled on'}<font color='$colourhash{$zone}'> $Lang::tr{$zone_name}</font>\n";
1112 <table width='100%'>
1114 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
1123 &Header
::closebox
();
1126 # Used Ruleset Providers section.
1128 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ruleset settings'});
1131 <table width='100%' border='0'>
1133 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ids provider'}</b></td>
1134 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'date'}</b></td>
1135 <td class='base' bgcolor='$color{'color20'}' align='center'><b>$Lang::tr{'ids autoupdates'}</b></td>
1136 <td class='base' bgcolor='$color{'color20'}' align='center'><b>$Lang::tr{'action'}</b></td>
1137 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1142 # Check if some providers has been configured.
1143 if (keys (%used_providers)) {
1146 # Loop through all entries of the hash.
1147 foreach my $id (sort keys(%used_providers)) {
1148 # Assign data array positions to some nice variable names.
1149 my $provider = $used_providers{$id}[0];
1150 my $provider_name = &get_provider_name
($provider);
1151 my $rulesetdate = &IDS
::get_ruleset_date
($provider);
1153 my $subscription_code = $used_providers{$id}[1];
1154 my $autoupdate_status = $used_providers{$id}[2];
1155 my $status = $used_providers{$id}[3];
1157 # Check if the item number is even or not.
1159 $col="bgcolor='$color{'color22'}'";
1161 $col="bgcolor='$color{'color20'}'";
1164 # Handle providers which are not longer supported.
1165 unless ($provider_name) {
1166 # Set the provider name to the provider handle
1167 # to display something helpful.
1168 $provider_name = $provider;
1170 # Assign background color
1171 $col="bgcolor='#FF4D4D'";
1174 # Choose icons for the checkboxes.
1177 my $autoupdate_status_gif;
1178 my $autoupdate_status_gdesc;
1180 # Check if the status is enabled and select the correct image and description.
1181 if ($status eq 'enabled' ) {
1182 $status_gif = 'on.gif';
1183 $status_gdesc = $Lang::tr
{'click to disable'};
1185 $status_gif = 'off.gif';
1186 $status_gdesc = $Lang::tr
{'click to enable'};
1189 # Check if the autoupdate status is enabled and select the correct image and description.
1190 if ($autoupdate_status eq 'enabled') {
1191 $autoupdate_status_gif = 'on.gif';
1192 $autoupdate_status_gdesc = $Lang::tr
{'click to disable'};
1194 $autoupdate_status_gif = 'off.gif';
1195 $autoupdate_status_gdesc = $Lang::tr
{'click to enable'};
1200 <td width='33%' class='base' $col>$provider_name</td>
1201 <td width='30%' class='base' $col>$rulesetdate</td>
1203 <td align='center' $col>
1204 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1205 <input type='hidden' name='AUTOUPDATE' value='$Lang::tr{'toggle enable disable'}' />
1206 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$autoupdate_status_gif' alt='$autoupdate_status_gdesc' title='$autoupdate_status_gdesc' />
1207 <input type='hidden' name='ID' value='$id' />
1211 <td align='center' $col>
1212 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1213 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'toggle enable disable'}'>
1214 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$status_gif' alt='$status_gdesc' title='$status_gdesc'>
1215 <input type='hidden' name='ID' value='$id'>
1219 <td align='center' $col>
1220 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1221 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'edit'}'>
1222 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1223 <input type='hidden' name='ID' value='$id'>
1227 <td align='center' $col>
1228 <form method='post' name='$provider' action='$ENV{'SCRIPT_NAME'}'>
1229 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1230 <input type='hidden' name='ID' value='$id'>
1231 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'remove'}'>
1236 # Increment lines value.
1242 # Print notice that currently no hosts are ignored.
1244 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1250 # Section to add new elements or edit existing ones.
1257 <table width='100%'>
1258 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1262 # Only show this button if a ruleset provider is configured.
1263 if (%used_providers) {
1264 print "<input type='submit' name='RULESET' value='$Lang::tr{'ids customize ruleset'}'>\n";
1267 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids add provider'}'>
1274 &Header
::closebox
();
1277 # Whitelist / Ignorelist
1279 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ignored hosts'});
1282 <table width='100%'>
1284 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
1285 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
1286 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1289 # Check if some hosts have been added to be ignored.
1290 if (keys (%ignored)) {
1293 # Loop through all entries of the hash.
1294 while( (my $key) = each %ignored) {
1295 # Assign data array positions to some nice variable names.
1296 my $address = $ignored{$key}[0];
1297 my $remark = $ignored{$key}[1];
1298 my $status = $ignored{$key}[2];
1300 # Check if the key (id) number is even or not.
1301 if ($cgiparams{'ID'} eq $key) {
1302 $col="bgcolor='${Header::colouryellow}'";
1303 } elsif ($key % 2) {
1304 $col="bgcolor='$color{'color22'}'";
1306 $col="bgcolor='$color{'color20'}'";
1309 # Choose icon for the checkbox.
1313 # Check if the status is enabled and select the correct image and description.
1314 if ($status eq 'enabled' ) {
1316 $gdesc = $Lang::tr
{'click to disable'};
1319 $gdesc = $Lang::tr
{'click to enable'};
1324 <td width='20%' class='base' $col>$address</td>
1325 <td width='65%' class='base' $col>$remark</td>
1327 <td align='center' $col>
1328 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1329 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}'>
1330 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc'>
1331 <input type='hidden' name='ID' value='$key'>
1335 <td align='center' $col>
1336 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1337 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}'>
1338 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1339 <input type='hidden' name='ID' value='$key'>
1343 <td align='center' $col>
1344 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
1345 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1346 <input type='hidden' name='ID' value='$key'>
1347 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
1354 # Print notice that currently no hosts are ignored.
1356 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1362 # Section to add new elements or edit existing ones.
1368 <div align='center'>
1369 <table width='100%'>
1372 # Assign correct headline and button text.
1377 # Check if an ID (key) has been given, in this case an existing entry should be edited.
1378 if ($cgiparams{'ID'} ne '') {
1379 $buttontext = $Lang::tr
{'update'};
1380 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
1382 # Grab address and remark for the given key.
1383 $entry_address = $ignored{$cgiparams{'ID'}}[0];
1384 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
1386 $buttontext = $Lang::tr
{'add'};
1387 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
1391 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1392 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1394 <td width='30%'>$Lang::tr{'ip address'}: </td>
1395 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
1397 <td width='30%'>$Lang::tr{'remark'}: </td>
1398 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
1399 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
1406 &Header
::closebox
();
1410 ## Function to show the customize ruleset section.
1412 sub show_customize_ruleset
() {
1416 # Java script variable declaration for show and hide.
1417 print"var show = \"$Lang::tr{'ids show'}\"\;\n";
1418 print"var hide = \"$Lang::tr{'ids hide'}\"\;\n";
1421 // Tiny javascript function to show/hide the rules
1422 // of a given category.
1423 function showhide(tblname) {
1424 \$("#" + tblname).toggle();
1426 // Get current content of the span element.
1427 var content = document.getElementById("span_" + tblname);
1429 if (content.innerHTML === show) {
1430 content.innerHTML = hide;
1432 content.innerHTML = show;
1438 &Header
::openbox
('100%', 'LEFT', "$Lang::tr{'intrusion detection system rules'}" );
1439 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
1441 # Output display table for rule files
1442 print "<table width='100%'>\n";
1444 # Loop over each rule file
1445 foreach my $rulefile (sort keys(%idsrules)) {
1446 my $rulechecked = '';
1448 # Check if rule file is enabled
1449 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
1450 $rulechecked = 'CHECKED';
1453 # Convert rulefile name into category name.
1454 my $categoryname = &_rulefile_to_category
($rulefile);
1456 # Table and rows for the rule files.
1458 print"<td class='base' width='5%'>\n";
1459 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
1461 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
1462 print"<td class='base' width='5%' align='right'>\n";
1463 print"<a href=\"javascript:showhide('$categoryname')\"><span id='span_$categoryname'>$Lang::tr{'ids show'}</span></a>\n";
1467 # Rows which will be hidden per default and will contain the single rules.
1468 print"<tr style='display:none' id='$categoryname'>\n";
1469 print"<td colspan='3'>\n";
1476 # New table for the single rules.
1477 print "<table width='100%'>\n";
1479 # Loop over rule file rules
1480 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
1482 my $ruledefchecked = '';
1484 # Skip rulefile itself.
1485 next if ($sid eq "Rulefile");
1487 # If 2 rules have been displayed, start a new row
1488 if (($lines % 2) == 0) {
1489 print "</tr><tr>\n";
1491 # Increase rows by once.
1497 $col="bgcolor='$color{'color20'}'";
1499 $col="bgcolor='$color{'color22'}'";
1503 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
1504 $ruledefchecked = 'CHECKED';
1507 # Create rule checkbox and display rule description
1508 print "<td class='base' width='5%' align='right' $col>\n";
1509 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
1511 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1513 # Increment rule count
1517 # If do not have a second rule for row, create empty cell
1518 if (($lines % 2) != 0) {
1519 print "<td class='base'></td>";
1522 # Close display table
1523 print "</tr></table></td></tr>";
1526 # Close display table
1530 <table width='100%'>
1532 <td width='100%' align='right'>
1533 <input type='submit' value='$Lang::tr{'fwhost back'}'>
1534 <input type='submit' name='RULESET' value='$Lang::tr{'ids apply'}'>
1541 &Header
::closebox
();
1545 ## Function to show section for add/edit a provider.
1547 sub show_add_provider
() {
1548 my %used_providers = ();
1549 my @subscription_providers;
1551 # Read -in providers settings file.
1552 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
1554 # Get all supported ruleset providers.
1555 my @ruleset_providers = &IDS
::get_ruleset_providers
();
1560 # Generate Java Script Object which contains the URL of the providers.
1561 print "\t// Object, which contains the webpages of the ruleset providers.\n";
1562 print "\tvar url = {\n";
1564 # Loop through the array of supported providers.
1565 foreach my $provider (@ruleset_providers) {
1566 # Check if the provider requires a subscription.
1567 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
1568 # Add the provider to the array of subscription_providers.
1569 push(@subscription_providers, $provider);
1572 # Grab the URL for the provider.
1573 my $url = $IDS::Ruleset
::Providers
{$provider}{'website'};
1575 # Print the URL to the Java Script Object.
1576 print "\t\t$provider: \"$url\"\,\n";
1579 # Close the Java Script Object declaration.
1582 # Generate Java Script Array which contains the provider that requires a subscription.
1584 $line = join("', '", @subscription_providers);
1586 print "\t// Array which contains the providers that requires a subscription.\n";
1587 print "\tsubscription_provider = ['$line']\;\n\n";
1590 // Java Script function to swap the text input field for
1591 // entering a subscription code.
1592 var update_provider = function() {
1593 if(inArray(\$('#PROVIDER').val(), subscription_provider)) {
1594 \$('.subscription_code').show();
1596 \$('.subscription_code').hide();
1599 // Call function to change the website url.
1600 change_url(\$('#PROVIDER').val());
1603 // Java Script function to check if a given value is part of
1605 function inArray(value,array) {
1606 var count=array.length;
1608 for(var i=0;i<count;i++) {
1609 if(array[i]===value){
1617 // Tiny function to change the website url based on the selected element in the "PROVIDERS"
1619 function change_url(provider) {
1620 // Get and change the href to the corresponding url.
1621 document.getElementById("website").href = url[provider];
1624 // JQuery function to call corresponding function when
1625 // the ruleset provider is changed or the page is loaded for showing/hiding
1626 // the subscription_code area.
1627 \$(document).ready(function() {
1628 \$('#PROVIDER').change(update_provider);
1636 # Check if an existing provider should be edited.
1637 if($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1638 # Check if autoupdate is enabled for this provider.
1639 if ($used_providers{$cgiparams{'ID'}}[2] eq "enabled") {
1640 # Set the checkbox to be checked.
1641 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1644 # Check if the monitor traffic only mode is set for this provider.
1645 if ($used_providers{$cgiparams{'ID'}}[4] eq "IDS") {
1646 # Set the checkbox to be checked.
1647 $checked{'MONITOR_TRAFFIC_ONLY'} = "checked='checked'";
1650 # Display section to force an rules update and to reset the provider.
1651 &show_additional_provider_actions
();
1653 } elsif ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'ids add provider'}") {
1654 # Set the autoupdate to true as default.
1655 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1658 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids provider settings'});
1661 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1662 <table width='100%' border='0'>
1664 <td colspan='2'><b>$Lang::tr{'ids provider'}</b></td>
1669 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1672 # Value to allow disabling the dropdown menu.
1675 # Check if we are in edit mode.
1676 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1677 $disabled = "disabled";
1679 # Add hidden input with the provider because the disable select does not provider
1681 print "<input type='hidden' name='PROVIDER' value='$used_providers{$cgiparams{'ID'}}[0]'>\n";
1684 print "<select name='PROVIDER' id='PROVIDER' $disabled>\n";
1685 # Temporary hash to store the provier names and their handles.
1688 # Loop through the array of ruleset providers.
1689 foreach my $handle (@ruleset_providers) {
1690 # Get the provider name.
1691 my $name = &get_provider_name
($handle);
1693 # Add the grabbed provider name and handle to the
1695 $tmphash{$name} = "$handle";
1698 # Sort and loop through the temporary hash.
1699 foreach my $provider_name ( sort keys %tmphash ) {
1700 # Grab the provider handle.
1701 my $provider = $tmphash{$provider_name};
1703 # Pre-select the provider if one is given.
1704 if (($used_providers{$cgiparams{'ID'}}[0] eq "$provider") || ($cgiparams{'PROVIDER'} eq "$provider")) {
1705 $selected{$provider} = "selected='selected'";
1708 # Add the provider to the dropdown menu.
1709 print "<option value='$provider' $selected{$provider}>$provider_name</option>\n";
1716 <b><a id="website" target="_blank" href="#">$Lang::tr{'ids visit provider website'}</a></b>
1721 <td colspan='2'><br><br></td>
1724 <tr class='subscription_code' style='display:none' id='subscription_code'>
1729 <b>$Lang::tr{'subscription code'}</b>
1735 <input type='text' size='40' name='SUBSCRIPTION_CODE' value='$used_providers{$cgiparams{'ID'}}[1]'>
1748 <input type='checkbox' name='ENABLE_AUTOUPDATE' $checked{'ENABLE_AUTOUPDATE'}> $Lang::tr{'ids enable automatic updates'}
1752 <input type='checkbox' name='MONITOR_TRAFFIC_ONLY' $checked{'MONITOR_TRAFFIC_ONLY'}> $Lang::tr{'ids monitor traffic only'}
1757 <td colspan='2' align='right'>
1758 <input type='submit' value='$Lang::tr{'back'}'>
1761 # Check if a provider should be added or edited.
1762 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1763 # Display button for updating the existing provider.
1764 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'update'}'>\n";
1766 # Display button to add the new provider.
1767 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'add'}'>\n";
1776 &Header
::closebox
();
1780 ## Function to show the area where additional provider actions can be done.
1782 sub show_additional_provider_actions
() {
1784 my $disabled_update;
1785 my %used_providers = ();
1787 # Read-in providers settings file.
1788 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
1790 # Assign variable for provider handle.
1791 my $provider = "$used_providers{$cgiparams{'ID'}}[0]";
1793 # Call function to get the path and name for the given provider
1794 # ruleset modifications file.
1795 my $modifications_file = &IDS
::get_provider_ruleset_modifications_file
($provider);
1797 # Disable the reset provider button if no provider modified sids file exists.
1798 unless (-f
$modifications_file) {
1799 $disabled_reset = "disabled";
1802 # Disable the manual update button if the provider is not longer supported.
1803 unless ($IDS::Ruleset
::Providers
{$provider}) {
1804 $disabled_update = "disabled";
1807 &Header
::openbox
('100%', 'center', "");
1809 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1810 <table width='100%' border="0">
1813 <input type='hidden' name='PROVIDER' value='$provider'>
1814 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids reset provider'}' $disabled_reset>
1815 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids force ruleset update'}' $disabled_update>
1822 &Header
::closebox
();
1826 ## A function to display a notice, to lock the webpage and
1827 ## tell the user which action currently will be performed.
1829 sub working_notice
($) {
1832 &_open_working_notice
($message);
1833 &_close_working_notice
();
1837 ## Private function to lock the page and tell the user what is going on.
1839 sub _open_working_notice
($) {
1842 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
1843 &Header
::openbigbox
('100%', 'left', '', $errormessage);
1844 &Header
::openbox
( 'Waiting', 1,);
1848 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
1855 ## Private function to close a working notice.
1857 sub _close_working_notice
() {
1860 &Header
::closebox
();
1861 &Header
::closebigbox
();
1862 &Header
::closepage
();
1866 ## Function which locks the webpage and basically does the same as the
1867 ## oinkmaster function, but provides a lot of HTML formated status output.
1869 sub oinkmaster_web
() {
1870 my @enabled_providers = &IDS
::get_enabled_providers
();
1872 # Lock the webpage and print message.
1873 &_open_working_notice
("$Lang::tr{'ids apply ruleset changes'}");
1875 # Check if the files in rulesdir have the correct permissions.
1876 &IDS
::_check_rulesdir_permissions
();
1878 print "<tr><td><br><br></td></tr>\n";
1880 # Cleanup the rules directory before filling it with the new rulests.
1881 &_add_to_notice
("$Lang::tr{'ids remove rule structures'}");
1882 &IDS
::_cleanup_rulesdir
();
1884 # Loop through the array of enabled providers.
1885 foreach my $provider (@enabled_providers) {
1886 &_add_to_notice
("$Lang::tr{'ids extract ruleset'} $provider");
1887 # Call the extractruleset function.
1888 &IDS
::extractruleset
($provider);
1891 # Call function to process the ruleset and do all modifications.
1892 &_add_to_notice
("$Lang::tr{'ids adjust ruleset'}");
1893 &IDS
::process_ruleset
(@enabled_providers);
1895 # Call function to merge the classification files.
1896 &_add_to_notice
("$Lang::tr{'ids merge classifications'}");
1897 &IDS
::merge_classifications
(@enabled_providers);
1899 # Call function to merge the sid to message mapping files.
1900 &_add_to_notice
("$Lang::tr{'ids merge sid files'}");
1901 &IDS
::merge_sid_msg
(@enabled_providers);
1903 # Cleanup temporary directory.
1904 &_add_to_notice
("$Lang::tr{'ids cleanup tmp dir'}");
1905 &IDS
::cleanup_tmp_directory
();
1907 # Finished - print a notice.
1908 &_add_to_notice
("$Lang::tr{'ids finished'}");
1910 # Close the working notice.
1911 &_close_working_notice
();
1915 ## Tiny private function to add a given message to a notice table.
1917 sub _add_to_notice
($) {
1920 print "<tr><td colspan='2'><li><b>$message</b></li></td></tr>\n";
1924 ## A tiny function to perform a reload of the webpage after one second.
1927 print "<meta http-equiv='refresh' content='1'>\n";
1934 ## Private function to read-in and parse rules of a given rulefile.
1936 ## The given file will be read, parsed and all valid rules will be stored by ID,
1937 ## message/description and it's state in the idsrules hash.
1939 sub readrulesfile
($) {
1940 my $rulefile = shift;
1942 # Open rule file and read in contents
1943 open(RULEFILE
, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
1945 # Store file content in an array.
1946 my @lines = <RULEFILE
>;
1951 # Loop over rule file contents
1952 foreach my $line (@lines) {
1953 # Remove whitespaces.
1957 next if ($line =~ /^\s*$/);
1963 # Gather rule sid and message from the ruleline.
1964 if ($line =~ m/.*msg:\s*\"(.*?)\"\;.*sid:\s*(.*?); /) {
1968 # Check if a rule has been found.
1970 # Add rule to the idsrules hash.
1971 $idsrules{$rulefile}{$sid}{'Description'} = $msg;
1973 # Grab status of the rule. Check if ruleline starts with a "dash".
1974 if ($line =~ /^\#/) {
1975 # If yes, the rule is disabled.
1976 $idsrules{$rulefile}{$sid}{'State'} = "off";
1978 # Otherwise the rule is enabled.
1979 $idsrules{$rulefile}{$sid}{'State'} = "on";
1987 ## Function to get the used memory of a given process-id.
1989 sub get_memory_usage
($) {
1994 # Try to open the status file for the given process-id on the pseudo
1996 if (open(FILE
, "/proc/$pid/status")) {
1997 # Loop through the entire file.
1999 # Splitt current line content and store them into variables.
2000 my ($key, $value) = split(":", $_, 2);
2002 # Check if the current key is the one which contains the memory usage.
2003 # The wanted one is VmRSS which contains the Real-memory (resident set)
2004 # of the entire process.
2005 if ($key eq "VmRSS") {
2006 # Found the memory usage add it to the memory variable.
2014 # Close file handle.
2017 # Return memory usage.
2021 # If the file could not be open, return nothing.
2026 ## Function to get the provider handle by a given ID.
2028 sub get_provider_handle
($) {
2031 my %used_providers = ();
2033 # Read-in provider settings file.
2034 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
2036 # Obtain the provider handle for the given ID.
2037 my $provider_handle = $used_providers{$cgiparams{'ID'}}[0];
2039 # Return the handle.
2040 return $provider_handle;
2044 ## Function to get the provider name from the language file or providers file for a given handle.
2046 sub get_provider_name
($) {
2050 # Early exit if the given provider does not longer exist.
2051 return unless ($IDS::Ruleset
::Providers
{$handle});
2053 # Get the required translation string for the given provider handle.
2054 my $tr_string = $IDS::Ruleset
::Providers
{$handle}{'tr_string'};
2056 # Check if the translation string is available in the language files.
2057 if ($Lang::tr
{$tr_string}) {
2058 # Use the translated string from the language file.
2059 $provider_name = $Lang::tr
{$tr_string};
2061 # Fallback and use the provider summary from the providers file.
2062 $provider_name = $IDS::Ruleset
::Providers
{$handle}{'summary'};
2065 # Return the obtained provider name.
2066 return $provider_name;
2070 ## Function to remove a provider by a given ID.
2072 sub remove_provider
($) {
2075 my %used_providers = ();
2077 # Read-in provider settings file.
2078 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
2080 # Drop entry from the hash.
2081 delete($used_providers{$id});
2083 # Write the changed hash to the provider settings file.
2084 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
2088 ## Private function to convert a given rulefile to a category name.
2089 ## ( No file extension anymore and if the name contained a dot, it
2090 ## would be replaced by a underline sign.)
2092 sub _rulefile_to_category
($) {
2093 my ($filename) = @_;
2095 # Splitt the filename into single chunks and store them in a
2097 my @parts = split(/\./, $filename);
2099 # Return / Remove last element of the temporary array.
2100 # This removes the file extension.
2103 # Join together the single elements of the temporary array.
2104 # If these are more than one, use a "underline" for joining.
2105 my $category = join '_', @parts;
2107 # Return the converted filename.