2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2007-2020 IPFire Team <info@ipfire.org> #
7 # This program is free software: you can redistribute it and/or modify #
8 # it under the terms of the GNU General Public License as published by #
9 # the Free Software Foundation, either version 3 of the License, or #
10 # (at your option) any later version. #
12 # This program is distributed in the hope that it will be useful, #
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of #
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
15 # GNU General Public License for more details. #
17 # You should have received a copy of the GNU General Public License #
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. #
20 ###############################################################################
24 # enable only the following on debugging purpose
26 #use CGI::Carp 'fatalsToBrowser';
28 require '/var/ipfire/general-functions.pl';
29 require "${General::swroot}/lang.pl";
30 require "${General::swroot}/header.pl";
31 require "${General::swroot}/ids-functions.pl";
32 require "${General::swroot}/network-functions.pl";
34 # Import ruleset providers file.
35 require "$IDS::rulesetsourcesfile";
38 my %mainsettings = ();
41 my %used_providers=();
47 # Read-in main settings, for language, theme and colors.
48 &General
::readhash
("${General::swroot}/main/settings", \
%mainsettings);
49 &General
::readhash
("/srv/web/ipfire/html/themes/ipfire/include/colors.txt", \
%color);
51 # Get the available network zones, based on the config type of the system and store
52 # the list of zones in an array.
53 my @network_zones = &Network
::get_available_network_zones
();
55 # Check if openvpn is started and add it to the array of network zones.
56 if ( -e
"/var/run/openvpn.pid") {
57 push(@network_zones, "ovpn");
62 # Create files if they does not exist yet.
63 &IDS
::check_and_create_filelayout
();
65 # Hash which contains the colour code of a network zone.
67 'red' => $Header::colourred
,
68 'green' => $Header::colourgreen
,
69 'blue' => $Header::colourblue
,
70 'orange' => $Header::colourorange
,
71 'ovpn' => $Header::colourovpn
74 &Header
::showhttpheaders
();
77 &Header
::getcgihash
(\
%cgiparams);
79 ## Add/edit an entry to the ignore file.
81 if (($cgiparams{'WHITELIST'} eq $Lang::tr
{'add'}) || ($cgiparams{'WHITELIST'} eq $Lang::tr
{'update'})) {
83 # Check if any input has been performed.
84 if ($cgiparams{'IGNORE_ENTRY_ADDRESS'} ne '') {
86 # Check if the given input is no valid IP-address or IP-address with subnet, display an error message.
87 if ((!&General
::validip
($cgiparams{'IGNORE_ENTRY_ADDRESS'})) && (!&General
::validipandmask
($cgiparams{'IGNORE_ENTRY_ADDRESS'}))) {
88 $errormessage = "$Lang::tr{'guardian invalid address or subnet'}";
91 $errormessage = "$Lang::tr{'guardian empty input'}";
94 # Go further if there was no error.
95 if ($errormessage eq '') {
100 # Assign hash values.
101 my $new_entry_address = $cgiparams{'IGNORE_ENTRY_ADDRESS'};
102 my $new_entry_remark = $cgiparams{'IGNORE_ENTRY_REMARK'};
104 # Read-in ignoredfile.
105 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
107 # Check if we should edit an existing entry and got an ID.
108 if (($cgiparams{'WHITELIST'} eq $Lang::tr
{'update'}) && ($cgiparams{'ID'})) {
109 # Assin the provided id.
110 $id = $cgiparams{'ID'};
112 # Undef the given ID.
113 undef($cgiparams{'ID'});
115 # Grab the configured status of the corresponding entry.
116 $status = $ignored{$id}[2];
118 # Each newly added entry automatically should be enabled.
121 # Generate the ID for the new entry.
123 # Sort the keys by their ID and store them in an array.
124 my @keys = sort { $a <=> $b } keys %ignored;
126 # Reverse the key array.
127 my @reversed = reverse(@keys);
129 # Obtain the last used id.
130 my $last_id = @reversed[0];
132 # Increase the last id by one and use it as id for the new entry.
136 # Add/Modify the entry to/in the ignored hash.
137 $ignored{$id} = ["$new_entry_address", "$new_entry_remark", "$status"];
139 # Write the changed ignored hash to the ignored file.
140 &General
::writehasharray
($IDS::ignored_file
, \
%ignored);
142 # Regenerate the ignore file.
143 &IDS
::generate_ignore_file
();
146 # Check if the IDS is running.
147 if(&IDS
::ids_is_running
()) {
148 # Call suricatactrl to perform a reload.
149 &IDS
::call_suricatactrl
("reload");
152 ## Toggle Enabled/Disabled for an existing entry on the ignore list.
155 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr
{'toggle enable disable'}) {
158 # Only go further, if an ID has been passed.
159 if ($cgiparams{'ID'}) {
160 # Assign the given ID.
161 my $id = $cgiparams{'ID'};
163 # Undef the given ID.
164 undef($cgiparams{'ID'});
166 # Read-in ignoredfile.
167 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
169 # Grab the configured status of the corresponding entry.
170 my $status = $ignored{$id}[2];
173 if ($status eq "disabled") {
176 $status = "disabled";
179 # Modify the status of the existing entry.
180 $ignored{$id} = ["$ignored{$id}[0]", "$ignored{$id}[1]", "$status"];
182 # Write the changed ignored hash to the ignored file.
183 &General
::writehasharray
($IDS::ignored_file
, \
%ignored);
185 # Regenerate the ignore file.
186 &IDS
::generate_ignore_file
();
188 # Check if the IDS is running.
189 if(&IDS
::ids_is_running
()) {
190 # Call suricatactrl to perform a reload.
191 &IDS
::call_suricatactrl
("reload");
195 ## Remove entry from ignore list.
197 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr
{'remove'}) {
200 # Read-in ignoredfile.
201 &General
::readhasharray
($IDS::ignored_file
, \
%ignored);
203 # Drop entry from the hash.
204 delete($ignored{$cgiparams{'ID'}});
206 # Undef the given ID.
207 undef($cgiparams{'ID'});
209 # Write the changed ignored hash to the ignored file.
210 &General
::writehasharray
($IDS::ignored_file
, \
%ignored);
212 # Regenerate the ignore file.
213 &IDS
::generate_ignore_file
();
215 # Check if the IDS is running.
216 if(&IDS
::ids_is_running
()) {
217 # Call suricatactrl to perform a reload.
218 &IDS
::call_suricatactrl
("reload");
222 # Check if the page is locked, in this case, the ids_page_lock_file exists.
223 if (-e
$IDS::ids_page_lock_file
) {
224 # Lock the webpage and print notice about autoupgrade of the ruleset
226 &working_notice
("$Lang::tr{'ids ruleset autoupdate in progress'}");
228 # Loop and check if the file still exists.
229 while(-e
$IDS::ids_page_lock_file
) {
230 # Sleep for a second and re-check.
234 # Page has been unlocked, perform a reload.
238 # Check if any error has been stored.
239 if (-e
$IDS::storederrorfile
) {
240 # Open file to read in the stored error message.
241 open(FILE
, "<$IDS::storederrorfile") or die "Could not open $IDS::storederrorfile. $!\n";
243 # Read the stored error message.
244 $errormessage = <FILE
>;
249 # Delete the file, which is now not longer required.
250 unlink($IDS::storederrorfile
);
253 # Gather ruleset details.
254 if ($cgiparams{'RULESET'}) {
255 ## Grab all available rules and store them in the idsrules hash.
258 # Get enabled providers.
259 my @enabled_providers = &IDS
::get_enabled_providers
();
261 # Open rules directory and do a directory listing.
262 opendir(DIR
, $IDS::rulespath
) or die $!;
263 # Loop through the direcory.
264 while (my $file = readdir(DIR
)) {
266 # We only want files.
267 next unless (-f
"$IDS::rulespath/$file");
269 # Ignore empty files.
270 next if (-z
"$IDS::rulespath/$file");
272 # Use a regular expression to find files ending in .rules
273 next unless ($file =~ m/\.rules$/);
275 # Ignore files which are not read-able.
276 next unless (-R
"$IDS::rulespath/$file");
278 # Skip whitelist rules file.
279 next if( $file eq "whitelist.rules");
281 # Splitt vendor from filename.
282 my @filename_parts = split(/-/, $file);
284 # Assign vendor name for easy processing.
285 my $vendor = @filename_parts[0];
287 # Skip rulefile if the provider is disabled.
288 next unless ($vendor ~~ @enabled_providers);
290 # Call subfunction to read-in rulefile and add rules to
292 &readrulesfile
("$file");
297 # Loop through the array of used providers.
298 foreach my $provider (@enabled_providers) {
299 # Gather used rulefiles.
300 my @used_rulesfiles = &IDS
::read_used_provider_rulesfiles
($provider);
302 # Loop through the array of used rulesfiles.
303 foreach my $rulefile (@used_rulesfiles) {
304 # Check if the current rulefile exists in the %idsrules hash.
305 # If not, the file probably does not exist anymore or contains
307 if($idsrules{$rulefile}) {
308 # Add the rulefile state to the %idsrules hash.
309 $idsrules{$rulefile}{'Rulefile'}{'State'} = "on";
315 # Save ruleset configuration.
316 if ($cgiparams{'RULESET'} eq $Lang::tr
{'save'}) {
319 # Read-in current (old) IDS settings.
320 &General
::readhash
("$IDS::rules_settings_file", \
%oldsettings);
322 # Prevent form name from been stored in conf file.
323 delete $cgiparams{'RULESET'};
325 # Check if the choosen vendor (URL) requires an subscription/oinkcode.
326 if ($IDS::Ruleset
::Providers
{$cgiparams{'RULES'}}{'requires_subscription'} eq "True") {
327 # Check if an subscription/oinkcode has been provided.
328 if ($cgiparams{'OINKCODE'}) {
329 # Check if the oinkcode contains unallowed chars.
330 unless ($cgiparams{'OINKCODE'} =~ /^[a-z0-9]+$/) {
331 $errormessage = $Lang::tr
{'invalid input for oink code'};
334 # Print an error message, that an subsription/oinkcode is required for this
336 $errormessage = $Lang::tr
{'ids oinkcode required'};
340 # Go on if there are no error messages.
341 if (!$errormessage) {
342 # Store settings into settings file.
343 &General
::writehash
("$IDS::rules_settings_file", \
%cgiparams);
345 # Check if a ruleset is present - if not or the source has been changed download it.
346 if((! %idsrules) || ($oldsettings{'RULES'} ne $cgiparams{'RULES'})) {
347 # Check if the red device is active.
348 unless (-e
"${General::swroot}/red/active") {
349 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
352 # Check if enough free disk space is availabe.
353 if(&IDS
::checkdiskspace
()) {
354 $errormessage = "$Lang::tr{'not enough disk space'}";
357 # Check if any errors happend.
358 unless ($errormessage) {
359 # Lock the webpage and print notice about downloading
361 &working_notice
("$Lang::tr{'ids working'}");
363 # Write the modify sid's file and pass the taken ruleaction.
364 &IDS
::write_modify_sids_file
();
366 # Call subfunction to download the ruleset.
367 if(&IDS
::downloadruleset
()) {
368 $errormessage = $Lang::tr
{'could not download latest updates'};
370 # Call function to store the errormessage.
371 &IDS
::_store_error_message
($errormessage);
373 # Call subfunction to launch oinkmaster.
377 # Check if the IDS is running.
378 if(&IDS
::ids_is_running
()) {
379 # Call suricatactrl to stop the IDS - because of the changed
380 # ruleset - the use has to configure it before suricata can be
382 &IDS
::call_suricatactrl
("stop");
385 # Perform a reload of the page.
392 } elsif ($cgiparams{'RULESET'} eq $Lang::tr
{'ids apply'}) {
393 # Arrays to store which rulefiles have been enabled and will be used.
394 my @enabled_rulefiles;
396 # Hash to store the user-enabled and disabled sids.
397 my %enabled_disabled_sids;
399 # Store if a restart of suricata is required.
400 my $suricata_restart_required;
402 # Loop through the hash of idsrules.
403 foreach my $rulefile(keys %idsrules) {
404 # Check if the state of the rulefile has been changed.
405 unless ($cgiparams{$rulefile} eq $idsrules{$rulefile}{'Rulefile'}{'State'}) {
406 # A restart of suricata is required to apply the changes of the used rulefiles.
407 $suricata_restart_required = 1;
410 # Check if the rulefile is enabled.
411 if ($cgiparams{$rulefile} eq "on") {
412 # Add rulefile to the array of enabled rulefiles.
413 push(@enabled_rulefiles, $rulefile);
415 # Drop item from cgiparams hash.
416 delete $cgiparams{$rulefile};
420 # Read-in the files for enabled/disabled sids.
421 # This will be done by calling the read_enabled_disabled_sids_file function two times
422 # and merge the returned hashes together into the enabled_disabled_sids hash.
423 %enabled_disabled_sids = (
424 &read_enabled_disabled_sids_file
($IDS::disabled_sids_file
),
425 &read_enabled_disabled_sids_file
($IDS::enabled_sids_file
));
427 # Loop through the hash of idsrules.
428 foreach my $rulefile (keys %idsrules) {
429 # Loop through the single rules of the rulefile.
430 foreach my $sid (keys %{$idsrules{$rulefile}}) {
431 # Skip the current sid if it is not numeric.
432 next unless ($sid =~ /\d+/ );
434 # Check if there exists a key in the cgiparams hash for this sid.
435 if (exists($cgiparams{$sid})) {
436 # Look if the rule is disabled.
437 if ($idsrules{$rulefile}{$sid}{'State'} eq "off") {
438 # Check if the state has been set to 'on'.
439 if ($cgiparams{$sid} eq "on") {
440 # Add/Modify the sid to/in the enabled_disabled_sids hash.
441 $enabled_disabled_sids{$sid} = "enabled";
443 # Drop item from cgiparams hash.
444 delete $cgiparams{$rulefile}{$sid};
448 # Look if the rule is enabled.
449 if ($idsrules{$rulefile}{$sid}{'State'} eq "on") {
450 # Check if the state is 'on' and should be disabled.
451 # In this case there is no entry
452 # for the sid in the cgiparams hash.
453 # Add/Modify it to/in the enabled_disabled_sids hash.
454 $enabled_disabled_sids{$sid} = "disabled";
456 # Drop item from cgiparams hash.
457 delete $cgiparams{$rulefile}{$sid};
463 # Open enabled sid's file for writing.
464 open(ENABLED_FILE
, ">$IDS::enabled_sids_file") or die "Could not write to $IDS::enabled_sids_file. $!\n";
466 # Open disabled sid's file for writing.
467 open(DISABLED_FILE
, ">$IDS::disabled_sids_file") or die "Could not write to $IDS::disabled_sids_file. $!\n";
469 # Write header to the files.
470 print ENABLED_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
471 print DISABLED_FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
473 # Check if the hash for enabled/disabled files contains any entries.
474 if (%enabled_disabled_sids) {
475 # Loop through the hash.
476 foreach my $sid (keys %enabled_disabled_sids) {
477 # Check if the sid is enabled.
478 if ($enabled_disabled_sids{$sid} eq "enabled") {
479 # Print the sid to the enabled_sids file.
480 print ENABLED_FILE
"enablesid $sid\n";
481 # Check if the sid is disabled.
482 } elsif ($enabled_disabled_sids{$sid} eq "disabled") {
483 # Print the sid to the disabled_sids file.
484 print DISABLED_FILE
"disablesid $sid\n";
485 # Something strange happende - skip the current sid.
492 # Close file for enabled_sids after writing.
495 # Close file for disabled_sids after writing.
496 close(DISABLED_FILE
);
498 # Handle enabled / disabled rulefiles.
500 # Get enabled providers.
501 my @enabled_providers = &IDS
::get_enabled_providers
();
503 # Loop through the array of enabled providers.
504 foreach my $provider(@enabled_providers) {
505 # Array to store the rulefiles which belong to the current processed provider.
506 my @provider_rulefiles = ();
508 # Loop through the array of enabled rulefiles.
509 foreach my $rulesfile (@enabled_rulefiles) {
510 # Split the rulefile name.
511 my @filename_parts = split(/-/, "$rulesfile");
513 # Assign vendor name for easy processings.
514 my $vendor = @filename_parts[0];
516 # Check if the rulesvendor is our current processed enabled provider.
517 if ("$vendor" eq "$provider") {
518 # Add the rulesfile to the array of provider rulesfiles.
519 push(@provider_rulefiles, $rulesfile);
522 # Check if any rulesfiles have been found for this provider.
523 if (@provider_rulefiles) {
524 # Call function and write the providers used rulesfile file.
525 &IDS
::write_used_provider_rulefiles_file
($provider, @provider_rulefiles);
530 # Call function to generate and write the used rulefiles file.
531 &IDS
::write_main_used_rulefiles_file
(@enabled_providers);
533 # Lock the webpage and print message.
534 &working_notice
("$Lang::tr{'ids apply ruleset changes'}");
536 # Call oinkmaster to alter the ruleset.
539 # Check if the IDS is running.
540 if(&IDS
::ids_is_running
()) {
541 # Check if a restart of suricata is required.
542 if ($suricata_restart_required) {
543 # Call suricatactrl to perform the restart.
544 &IDS
::call_suricatactrl
("restart");
546 # Call suricatactrl to perform a reload.
547 &IDS
::call_suricatactrl
("reload");
554 # Download new ruleset.
555 } elsif ($cgiparams{'RULESET'} eq $Lang::tr
{'update ruleset'}) {
556 # Check if the red device is active.
557 unless (-e
"${General::swroot}/red/active") {
558 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
561 # Check if enought free disk space is availabe.
562 if(&IDS
::checkdiskspace
()) {
563 $errormessage = "$Lang::tr{'not enough disk space'}";
566 # Check if any errors happend.
567 unless ($errormessage) {
568 # Lock the webpage and print notice about downloading
570 &working_notice
("$Lang::tr{'ids download new ruleset'}");
572 # Call subfunction to download the ruleset.
573 if(&IDS
::downloadruleset
()) {
574 $errormessage = $Lang::tr
{'could not download latest updates'};
576 # Call function to store the errormessage.
577 &IDS
::_store_error_message
($errormessage);
579 # Preform a reload of the page.
582 # Call subfunction to launch oinkmaster.
585 # Check if the IDS is running.
586 if(&IDS
::ids_is_running
()) {
587 # Call suricatactrl to perform a reload.
588 &IDS
::call_suricatactrl
("reload");
591 # Perform a reload of the page.
596 } elsif ($cgiparams{'IDS'} eq $Lang::tr
{'save'}) {
599 my $monitored_zones = 0;
601 # Read-in current (old) IDS settings.
602 &General
::readhash
("$IDS::ids_settings_file", \
%oldidssettings);
604 # Prevent form name from been stored in conf file.
605 delete $cgiparams{'IDS'};
607 # Check if the IDS should be enabled.
608 if ($cgiparams{'ENABLE_IDS'} eq "on") {
609 # Check if any ruleset is available. Otherwise abort and display an error.
610 unless(%used_providers) {
611 $errormessage = $Lang::tr
{'ids no ruleset available'};
614 # Loop through the array of available interfaces.
615 foreach my $zone (@network_zones) {
616 # Convert interface name into upper case.
617 my $zone_upper = uc($zone);
619 # Check if the IDS is enabled for this interaces.
620 if ($cgiparams{"ENABLE_IDS_$zone_upper"}) {
626 # Check if at least one zone should be monitored, or show an error.
627 unless ($monitored_zones >= 1) {
628 $errormessage = $Lang::tr
{'ids no network zone'};
632 # Go on if there are no error messages.
633 if (!$errormessage) {
634 # Store settings into settings file.
635 &General
::writehash
("$IDS::ids_settings_file", \
%cgiparams);
638 # Check if the the automatic rule update hass been touched.
639 if($cgiparams{'AUTOUPDATE_INTERVAL'} ne $oldidssettings{'AUTOUPDATE_INTERVAL'}) {
640 # Call suricatactrl to set the new interval.
641 &IDS
::call_suricatactrl
("cron", $cgiparams{'AUTOUPDATE_INTERVAL'});
644 # Generate file to store the home net.
645 &IDS
::generate_home_net_file
();
647 # Generate file to the store the DNS servers.
648 &IDS
::generate_dns_servers_file
();
650 # Generate file to store the HTTP ports.
651 &IDS
::generate_http_ports_file
();
653 # Write the modify sid's file and pass the taken ruleaction.
654 &IDS
::write_modify_sids_file
();
656 # Check if "MONITOR_TRAFFIC_ONLY" has been changed.
657 if($cgiparams{'MONITOR_TRAFFIC_ONLY'} ne $oldidssettings{'MONITOR_TRAFFIC_ONLY'}) {
658 # Check if a ruleset exists.
659 if (%used_providers) {
660 # Lock the webpage and print message.
661 &working_notice
("$Lang::tr{'ids working'}");
663 # Call oinkmaster to alter the ruleset.
666 # Set reload_page to "True".
671 # Check if the IDS currently is running.
672 if(&IDS
::ids_is_running
()) {
673 # Check if ENABLE_IDS is set to on.
674 if($cgiparams{'ENABLE_IDS'} eq "on") {
675 # Call suricatactrl to perform a reload of suricata.
676 &IDS
::call_suricatactrl
("reload");
678 # Call suricatactrl to stop suricata.
679 &IDS
::call_suricatactrl
("stop");
682 # Call suricatactrl to start suricata.
683 &IDS
::call_suricatactrl
("start");
686 # Check if the page should be reloaded.
688 # Perform a reload of the page.
692 # Toggle Enable/Disable autoupdate for a provider
693 } elsif ($cgiparams{'AUTOUPDATE'} eq $Lang::tr
{'toggle enable disable'}) {
694 my %used_providers = ();
696 # Only go further, if an ID has been passed.
697 if ($cgiparams{'ID'}) {
698 # Assign the given ID.
699 my $id = $cgiparams{'ID'};
701 # Undef the given ID.
702 undef($cgiparams{'ID'});
704 # Read-in providers settings file.
705 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
707 # Grab the configured status of the corresponding entry.
708 my $status_autoupdate = $used_providers{$id}[2];
711 if ($status_autoupdate eq "disabled") {
712 $status_autoupdate = "enabled";
714 $status_autoupdate = "disabled";
717 # Modify the status of the existing entry.
718 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$status_autoupdate", "$used_providers{$id}[3]"];
720 # Write the changed hash to the providers settings file.
721 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
724 # Add/Edit a provider to the list of used providers.
726 } elsif (($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") || ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'update'}")) {
727 my %used_providers = ();
729 # Read-in providers settings file.
730 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
732 # Assign some nice human-readable values.
733 my $provider = $cgiparams{'PROVIDER'};
734 my $subscription_code = $cgiparams{'SUBSCRIPTION_CODE'};
735 my $status_autoupdate;
737 # Handle autoupdate checkbox.
738 if ($cgiparams{'ENABLE_AUTOUPDATE'} eq "on") {
739 $status_autoupdate = "enabled";
741 $status_autoupdate = "disabled";
744 # Check if we are going to add a new provider.
745 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") {
746 # Loop through the hash of used providers.
747 foreach my $id ( keys %used_providers) {
748 # Check if the choosen provider is already in use.
749 if ($used_providers{$id}[0] eq "$provider") {
750 # XXX - add to language file.
751 # Assign error message.
752 $errormessage = "The choosen provider is already in use.";
757 # Check if the provider requires a subscription code.
758 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
759 # Check if an subscription code has been provided.
760 if ($subscription_code) {
761 # Check if the code contains unallowed chars.
762 unless ($subscription_code =~ /^[a-z0-9]+$/) {
763 $errormessage = $Lang::tr
{'invalid input for subscription code'};
766 # Print an error message, that an subsription code is required for this
768 $errormessage = $Lang::tr
{'ids subscription code required'};
772 # Go further if there was no error.
773 if ($errormessage eq '') {
777 # Check if we should edit an existing entry and got an ID.
778 if (($cgiparams{'PROVIDERS'} eq $Lang::tr
{'update'}) && ($cgiparams{'ID'})) {
779 # Assin the provided id.
780 $id = $cgiparams{'ID'};
782 # Undef the given ID.
783 undef($cgiparams{'ID'});
785 # Grab the configured status of the corresponding entry.
786 $status = $used_providers{$id}[3];
788 # Each newly added entry automatically should be enabled.
791 # Generate the ID for the new entry.
793 # Sort the keys by their ID and store them in an array.
794 my @keys = sort { $a <=> $b } keys %used_providers;
796 # Reverse the key array.
797 my @reversed = reverse(@keys);
799 # Obtain the last used id.
800 my $last_id = @reversed[0];
802 # Increase the last id by one and use it as id for the new entry.
806 # Add/Modify the entry to/in the used providers hash..
807 $used_providers{$id} = ["$provider", "$subscription_code", "$status_autoupdate", "$status"];
809 # Write the changed hash to the providers settings file.
810 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
812 # Check if a new provider will be added.
813 if ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'add'}) {
814 # Lock the webpage and print notice about downloading
816 &working_notice
("$Lang::tr{'ids working'}");
818 # Download the ruleset.
819 &IDS
::downloadruleset
($provider);
821 # Extract the ruleset
822 &IDS
::extractruleset
($provider);
825 &IDS
::move_tmp_ruleset
();
827 # Cleanup temporary directory.
828 &IDS
::cleanup_tmp_directory
();
830 # Create new empty file for used rulefiles
832 &IDS
::write_used_provider_rulefiles_file
($provider);
834 # Perform a reload of the page.
838 # Undefine providers flag.
839 undef($cgiparams{'PROVIDERS'});
842 ## Toggle Enabled/Disabled for an existing provider.
844 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'toggle enable disable'}) {
845 my %used_providers = ();
847 # Only go further, if an ID has been passed.
848 if ($cgiparams{'ID'}) {
849 # Assign the given ID.
850 my $id = $cgiparams{'ID'};
852 # Undef the given ID.
853 undef($cgiparams{'ID'});
855 # Read-in file which contains the provider settings.
856 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
858 # Grab the configured status of the corresponding entry.
859 my $status = $used_providers{$id}[3];
862 if ($status eq "enabled") {
863 $status = "disabled";
868 # Modify the status of the existing entry.
869 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$used_providers{$id}[2]", "$status"];
871 # Write the changed hash to the providers settings file.
872 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
874 # Get all enabled providers.
875 my @enabled_providers = &IDS
::get_enabled_providers
();
877 # Write the main providers include file.
878 &IDS
::write_main_used_rulefiles_file
(@enabled_providers);
880 # Check if the IDS is running.
881 if(&IDS
::ids_is_running
()) {
882 # Gather the amount of enabled providers (elements in the array).
883 my $amount = @enabled_providers;
885 # Check if there are still enabled ruleset providers.
887 # Call suricatactrl to perform a restart.
888 &IDS
::call_suricatactrl
("restart");
890 # No active ruleset provider, suricata has to be stopped.
893 &IDS
::call_suricatactrl
("stop");
897 # Undefine providers flag.
898 undef($cgiparams{'PROVIDERS'});
901 ## Remove provider from the list of used providers.
903 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr
{'remove'}) {
904 my %used_providers = ();
906 # Read-in provider settings file.
907 &General
::readhasharray
($IDS::providers_settings_file
, \
%used_providers);
909 # Grab the provider name bevore deleting it from hash.
910 my $provider = $used_providers{$cgiparams{'ID'}}[0];
912 # Drop entry from the hash.
913 delete($used_providers{$cgiparams{'ID'}});
915 # Undef the given ID.
916 undef($cgiparams{'ID'});
918 # Write the changed hash to the provide settings file.
919 &General
::writehasharray
($IDS::providers_settings_file
, \
%used_providers);
921 # Drop the stored ruleset file.
922 &IDS
::drop_dl_rulesfile
($provider);
924 # Get the name of the provider rulessets include file.
925 my $provider_used_rulefile = &get_used_provider_rulesfile_file
($provider);
927 # Drop the file, it is not longer needed.
928 unlink("$provider_used_rulefile");
930 # Regenerate ruleset.
933 # Gather all enabled providers.
934 my @enabled_providers = &IDS
::get_enabled_providers
();
936 # Regenerate main providers include file.
937 &IDS
::write_main_used_rulefiles_file
(@enabled_providers);
939 # Check if the IDS is running.
940 if(&IDS
::ids_is_running
()) {
941 # Get amount of enabled providers.
942 my $amount = @enabled_providers;
944 # Check if at least one enabled provider remains.
946 # Call suricatactrl to perform a reload.
947 &IDS
::call_suricatactrl
("restart");
949 # Stop suricata if no enabled provider remains.
951 # Call suricatactrel to perform the stop.
952 &IDS
::call_suricatactrl
("stop");
956 # Undefine providers flag.
957 undef($cgiparams{'PROVIDERS'});
960 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
962 &Header
::openbigbox
('100%', 'left', '', $errormessage);
964 &show_display_error_message
();
966 if ($cgiparams{'RULESET'} eq "$Lang::tr{'ids customize ruleset'}" ) {
967 &show_customize_ruleset
();
968 } elsif ($cgiparams{'PROVIDERS'} ne "") {
969 &show_add_provider
();
974 &Header
::closebigbox
();
975 &Header
::closepage
();
978 ## Tiny function to show if a error message happened.
980 sub show_display_error_message
() {
982 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
983 print "<class name='base'>$errormessage\n";
984 print " </class>\n";
990 ## Function to display the main IDS page.
992 sub show_mainpage
() {
993 # Read-in idssettings and provider settings.
994 &General
::readhash
("$IDS::ids_settings_file", \
%idssettings);
995 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
997 # If no autoupdate intervall has been configured yet, set default value.
998 unless(exists($idssettings{'AUTOUPDATE_INTERVAL'})) {
999 # Set default to "weekly".
1000 $idssettings{'AUTOUPDATE_INTERVAL'} = 'weekly';
1003 # Read-in ignored hosts.
1004 &General
::readhasharray
("$IDS::settingsdir/ignored", \
%ignored);
1006 $checked{'ENABLE_IDS'}{'off'} = '';
1007 $checked{'ENABLE_IDS'}{'on'} = '';
1008 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
1009 $checked{'MONITOR_TRAFFIC_ONLY'}{'off'} = '';
1010 $checked{'MONITOR_TRAFFIC_ONLY'}{'on'} = '';
1011 $checked{'MONITOR_TRAFFIC_ONLY'}{$idssettings{'MONITOR_TRAFFIC_ONLY'}} = "checked='checked'";
1012 $selected{'AUTOUPDATE_INTERVAL'}{'off'} = '';
1013 $selected{'AUTOUPDATE_INTERVAL'}{'daily'} = '';
1014 $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} = '';
1015 $selected{'AUTOUPDATE_INTERVAL'}{$idssettings{'AUTOUPDATE_INTERVAL'}} = "selected='selected'";
1017 # Draw current state of the IDS
1018 &Header
::openbox
('100%', 'left', $Lang::tr
{'intrusion detection system'});
1020 # Check if the IDS is running and obtain the process-id.
1021 my $pid = &IDS
::ids_is_running
();
1023 # Display some useful information, if suricata daemon is running.
1025 # Gather used memory.
1026 my $memory = &get_memory_usage
($pid);
1029 <table width='95%' cellspacing='0' class='tbl'>
1031 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1035 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1036 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
1040 <td class='base'></td>
1041 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
1042 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
1046 <td class='base'></td>
1047 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
1048 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
1053 # Otherwise display a hint that the service is not launched.
1055 <table width='95%' cellspacing='0' class='tbl'>
1057 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1061 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1062 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
1068 # Only show this area, if at least one ruleset provider is configured.
1069 if (%used_providers) {
1073 <br><br><h2>$Lang::tr{'settings'}</h2>
1075 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1076 <table width='100%' border='0'>
1078 <td class='base' colspan='2'>
1079 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}> $Lang::tr{'ids enable'}
1082 <td class='base' colspan='2'>
1083 <input type='checkbox' name='MONITOR_TRAFFIC_ONLY' $checked{'MONITOR_TRAFFIC_ONLY'}{'on'}> $Lang::tr{'ids monitor traffic only'}
1095 <td colspan='4'><b>$Lang::tr{'ids monitored interfaces'}</b><br></td>
1102 # Loop through the array of available networks and print config options.
1103 foreach my $zone (@network_zones) {
1105 my $checked_forward;
1107 # Convert current zone name to upper case.
1108 my $zone_upper = uc($zone);
1111 my $zone_name = $zone;
1113 # Dirty hack to get the correct language string for the red zone.
1114 if ($zone eq "red") {
1115 $zone_name = "red1";
1118 # Grab checkbox status from settings hash.
1119 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
1120 $checked_input = "checked = 'checked'";
1123 print "<td class='base' width='20%'>\n";
1124 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>\n";
1125 print " $Lang::tr{'enabled on'}<font color='$colourhash{$zone}'> $Lang::tr{$zone_name}</font>\n";
1140 <td colspan='4'><b>$Lang::tr{'ids automatic rules update'}</b></td>
1145 <select name='AUTOUPDATE_INTERVAL'>
1146 <option value='off' $selected{'AUTOUPDATE_INTERVAL'}{'off'} >- $Lang::tr{'Disabled'} -</option>
1147 <option value='daily' $selected{'AUTOUPDATE_INTERVAL'}{'daily'} >$Lang::tr{'Daily'}</option>
1148 <option value='weekly' $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} >$Lang::tr{'Weekly'}</option>
1156 <table width='100%'>
1158 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
1167 &Header
::closebox
();
1170 # Used Ruleset Providers section.
1172 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ruleset settings'});
1175 <table width='100%' border='0'>
1177 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ids provider'}</b></td>
1178 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'date'}</b></td>
1179 <td class='base' bgcolor='$color{'color20'}' align='center'><b>$Lang::tr{'ids autoupdates'}</b></td>
1180 <td class='base' bgcolor='$color{'color20'}'></td>
1181 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1184 # Check if some providers has been configured.
1185 if (keys (%used_providers)) {
1188 # Loop through all entries of the hash.
1189 foreach my $id (sort keys(%used_providers)) {
1190 # Assign data array positions to some nice variable names.
1191 my $provider = $used_providers{$id}[0];
1192 my $provider_name = &get_provider_name
($provider);
1194 #XXX my $rulesdate = &IDS::get_ruleset_date($provider);
1197 my $subscription_code = $used_providers{$id}[1];
1198 my $autoupdate_status = $used_providers{$id}[2];
1199 my $status = $used_providers{$id}[3];
1201 # Check if the item number is even or not.
1203 $col="bgcolor='$color{'color22'}'";
1205 $col="bgcolor='$color{'color20'}'";
1208 # Choose icons for the checkboxes.
1211 my $autoupdate_status_gif;
1212 my $autoupdate_status_gdesc;
1214 # Check if the status is enabled and select the correct image and description.
1215 if ($status eq 'enabled' ) {
1216 $status_gif = 'on.gif';
1217 $status_gdesc = $Lang::tr
{'click to disable'};
1219 $status_gif = 'off.gif';
1220 $status_gdesc = $Lang::tr
{'click to enable'};
1223 # Check if the autoupdate status is enabled and select the correct image and description.
1224 if ($autoupdate_status eq 'enabled') {
1225 $autoupdate_status_gif = 'on.gif';
1226 $autoupdate_status_gdesc = $Lang::tr
{'click to disable'};
1228 $autoupdate_status_gif = 'off.gif';
1229 $autoupdate_status_gdesc = $Lang::tr
{'click to enable'};
1234 <td width='33%' class='base' $col>$provider_name</td>
1235 <td width='30%' class='base' $col>$rulesdate</td>
1237 <td align='center' $col>
1238 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1239 <input type='hidden' name='AUTOUPDATE' value='$Lang::tr{'toggle enable disable'}' />
1240 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$autoupdate_status_gif' alt='$autoupdate_status_gdesc' title='$autoupdate_status_gdesc' />
1241 <input type='hidden' name='ID' value='$id' />
1245 <td align='center' $col>
1246 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1247 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'toggle enable disable'}'>
1248 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$status_gif' alt='$status_gdesc' title='$status_gdesc'>
1249 <input type='hidden' name='ID' value='$id'>
1253 <td align='center' $col>
1254 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1255 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'edit'}'>
1256 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1257 <input type='hidden' name='ID' value='$id'>
1261 <td align='center' $col>
1262 <form method='post' name='$provider' action='$ENV{'SCRIPT_NAME'}'>
1263 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1264 <input type='hidden' name='ID' value='$id'>
1265 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'remove'}'>
1273 # Print notice that currently no hosts are ignored.
1275 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1281 # Section to add new elements or edit existing ones.
1288 <table width='100%'>
1289 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1293 # Only show this button if a ruleset provider is configured.
1294 if (%used_providers) {
1295 print "<input type='submit' name='RULESET' value='$Lang::tr{'ids customize ruleset'}'>\n";
1298 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids add provider'}'>
1305 &Header
::closebox
();
1308 # Whitelist / Ignorelist
1310 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids ignored hosts'});
1313 <table width='100%'>
1315 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
1316 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
1317 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1320 # Check if some hosts have been added to be ignored.
1321 if (keys (%ignored)) {
1324 # Loop through all entries of the hash.
1325 while( (my $key) = each %ignored) {
1326 # Assign data array positions to some nice variable names.
1327 my $address = $ignored{$key}[0];
1328 my $remark = $ignored{$key}[1];
1329 my $status = $ignored{$key}[2];
1331 # Check if the key (id) number is even or not.
1332 if ($cgiparams{'ID'} eq $key) {
1333 $col="bgcolor='${Header::colouryellow}'";
1334 } elsif ($key % 2) {
1335 $col="bgcolor='$color{'color22'}'";
1337 $col="bgcolor='$color{'color20'}'";
1340 # Choose icon for the checkbox.
1344 # Check if the status is enabled and select the correct image and description.
1345 if ($status eq 'enabled' ) {
1347 $gdesc = $Lang::tr
{'click to disable'};
1350 $gdesc = $Lang::tr
{'click to enable'};
1355 <td width='20%' class='base' $col>$address</td>
1356 <td width='65%' class='base' $col>$remark</td>
1358 <td align='center' $col>
1359 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1360 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}'>
1361 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc'>
1362 <input type='hidden' name='ID' value='$key'>
1366 <td align='center' $col>
1367 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1368 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}'>
1369 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1370 <input type='hidden' name='ID' value='$key'>
1374 <td align='center' $col>
1375 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
1376 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1377 <input type='hidden' name='ID' value='$key'>
1378 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
1385 # Print notice that currently no hosts are ignored.
1387 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1393 # Section to add new elements or edit existing ones.
1399 <div align='center'>
1400 <table width='100%'>
1403 # Assign correct headline and button text.
1408 # Check if an ID (key) has been given, in this case an existing entry should be edited.
1409 if ($cgiparams{'ID'} ne '') {
1410 $buttontext = $Lang::tr
{'update'};
1411 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
1413 # Grab address and remark for the given key.
1414 $entry_address = $ignored{$cgiparams{'ID'}}[0];
1415 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
1417 $buttontext = $Lang::tr
{'add'};
1418 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
1422 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1423 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1425 <td width='30%'>$Lang::tr{'ip address'}: </td>
1426 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
1428 <td width='30%'>$Lang::tr{'remark'}: </td>
1429 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
1430 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
1437 &Header
::closebox
();
1441 ## Function to show the customize ruleset section.
1443 sub show_customize_ruleset
() {
1447 # Java script variable declaration for show and hide.
1448 print"var show = \"$Lang::tr{'ids show'}\"\;\n";
1449 print"var hide = \"$Lang::tr{'ids hide'}\"\;\n";
1452 // Tiny java script function to show/hide the rules
1453 // of a given category.
1454 function showhide(tblname) {
1455 \$("#" + tblname).toggle();
1457 // Get current content of the span element.
1458 var content = document.getElementById("span_" + tblname);
1460 if (content.innerHTML === show) {
1461 content.innerHTML = hide;
1463 content.innerHTML = show;
1469 &Header
::openbox
('100%', 'LEFT', "$Lang::tr{'intrusion detection system rules'}" );
1470 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
1472 # Output display table for rule files
1473 print "<table width='100%'>\n";
1475 # Loop over each rule file
1476 foreach my $rulefile (sort keys(%idsrules)) {
1477 my $rulechecked = '';
1479 # Check if rule file is enabled
1480 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
1481 $rulechecked = 'CHECKED';
1484 # Convert rulefile name into category name.
1485 my $categoryname = &_rulefile_to_category
($rulefile);
1487 # Table and rows for the rule files.
1489 print"<td class='base' width='5%'>\n";
1490 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
1492 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
1493 print"<td class='base' width='5%' align='right'>\n";
1494 print"<a href=\"javascript:showhide('$categoryname')\"><span id='span_$categoryname'>$Lang::tr{'ids show'}</span></a>\n";
1498 # Rows which will be hidden per default and will contain the single rules.
1499 print"<tr style='display:none' id='$categoryname'>\n";
1500 print"<td colspan='3'>\n";
1507 # New table for the single rules.
1508 print "<table width='100%'>\n";
1510 # Loop over rule file rules
1511 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
1513 my $ruledefchecked = '';
1515 # Skip rulefile itself.
1516 next if ($sid eq "Rulefile");
1518 # If 2 rules have been displayed, start a new row
1519 if (($lines % 2) == 0) {
1520 print "</tr><tr>\n";
1522 # Increase rows by once.
1528 $col="bgcolor='$color{'color20'}'";
1530 $col="bgcolor='$color{'color22'}'";
1534 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
1535 $ruledefchecked = 'CHECKED';
1538 # Create rule checkbox and display rule description
1539 print "<td class='base' width='5%' align='right' $col>\n";
1540 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
1542 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1544 # Increment rule count
1548 # If do not have a second rule for row, create empty cell
1549 if (($lines % 2) != 0) {
1550 print "<td class='base'></td>";
1553 # Close display table
1554 print "</tr></table></td></tr>";
1557 # Close display table
1561 <table width='100%'>
1563 <td width='100%' align='right'>
1564 <input type='submit' value='$Lang::tr{'fwhost back'}'>
1565 <input type='submit' name='RULESET' value='$Lang::tr{'ids apply'}'>
1572 &Header
::closebox
();
1577 ## Function to show section for add/edit a provider.
1579 sub show_add_provider
() {
1580 my %used_providers = ();
1581 my @subscription_providers;
1583 # Read -in providers settings file.
1584 &General
::readhasharray
("$IDS::providers_settings_file", \
%used_providers);
1586 # Get all supported ruleset providers.
1587 my @ruleset_providers = &IDS
::get_ruleset_providers
();
1592 # Generate Java Script Object which contains the URL of the providers.
1593 print "\t// Object, which contains the webpages of the ruleset providers.\n";
1594 print "\tvar url = {\n";
1596 # Loop through the array of supported providers.
1597 foreach my $provider (@ruleset_providers) {
1598 # Check if the provider requires a subscription.
1599 if ($IDS::Ruleset
::Providers
{$provider}{'requires_subscription'} eq "True") {
1600 # Add the provider to the array of subscription_providers.
1601 push(@subscription_providers, $provider);
1604 # Grab the URL for the provider.
1605 my $url = $IDS::Ruleset
::Providers
{$provider}{'website'};
1607 # Print the URL to the Java Script Object.
1608 print "\t\t$provider: \"$url\"\,\n";
1611 # Close the Java Script Object declaration.
1614 # Generate Java Script Array which contains the provider that requires a subscription.
1616 $line = join("', '", @subscription_providers);
1618 print "\t// Array which contains the providers that requires a subscription.\n";
1619 print "\tsubscription_provider = ['$line']\;\n\n";
1622 // Java Script function to swap the text input field for
1623 // entering a subscription code.
1624 var update_provider = function() {
1625 if(inArray(\$('#PROVIDER').val(), subscription_provider)) {
1626 \$('.subscription_code').show();
1628 \$('.subscription_code').hide();
1631 // Call function to change the website url.
1632 change_url(\$('#PROVIDER').val());
1635 // Java Script function to check if a given value is part of
1637 function inArray(value,array) {
1638 var count=array.length;
1640 for(var i=0;i<count;i++) {
1641 if(array[i]===value){
1649 // Tiny function to change the website url based on the selected element in the "PROVIDERS"
1651 function change_url(provider) {
1652 // Get and change the href to the corresponding url.
1653 document.getElementById("website").href = url[provider];
1656 // JQuery function to call corresponding function when
1657 // the ruleset provider is changed or the page is loaded for showing/hiding
1658 // the subscription_code area.
1659 \$(document).ready(function() {
1660 \$('#PROVIDER').change(update_provider);
1668 &Header
::openbox
('100%', 'center', $Lang::tr
{'ids provider settings'});
1670 # Check if an existing provider should be edited.
1671 if($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1672 # Check if autoupdate is enabled for this provider.
1673 if ($used_providers{$cgiparams{'ID'}}[2] eq "enabled") {
1674 # Set the checkbox to be checked.
1675 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1677 } elsif ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'ids add provider'}") {
1678 # Set the autoupdate to true as default.
1679 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1683 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1684 <table width='100%' border='0'>
1686 <td colspan='2'><b>$Lang::tr{'ids provider'}</b></td>
1691 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1692 <select name='PROVIDER' id='PROVIDER'>
1695 # Loop through the array of ruleset providers.
1696 foreach my $provider (@ruleset_providers) {
1697 # Get the provider name.
1698 my $provider_name = &get_provider_name
($provider);
1700 # Pre-select the provider if one is given.
1701 if (($used_providers{$cgiparams{'ID'}}[0] eq "$provider") || ($cgiparams{'PROVIDER'} eq "$provider")) {
1702 $selected{$provider} = "selected='selected'";
1705 # Add the provider to the dropdown menu.
1706 print "<option value='$provider' $selected{$provider}>$provider_name</option>\n";
1713 <b><a id="website" target="_blank" href="#">$Lang::tr{'ids visit provider website'}</a></b>
1718 <td colspan='2'><br><br></td>
1721 <tr class='subscription_code' style='display:none' id='subscription_code'>
1726 <b>$Lang::tr{'subscription code'}</b>
1732 <input type='text' size='40' name='SUBSCRIPTION_CODE' value='$used_providers{$cgiparams{'ID'}}[1]'>
1745 <input type='checkbox' name='ENABLE_AUTOUPDATE' $checked{'ENABLE_AUTOUPDATE'}> $Lang::tr{'ids enable automatic updates'}
1750 <td colspan='2' align='right'>
1751 <input type='submit' value='$Lang::tr{'back'}'>
1754 # Check if a provider should be added or edited.
1755 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1756 # Display button for updating the existing provider.
1757 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'update'}'>\n";
1759 # Display button to add the new provider.
1760 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'add'}'>\n";
1769 &Header
::closebox
();
1773 ## A function to display a notice, to lock the webpage and
1774 ## tell the user which action currently will be performed.
1776 sub working_notice
($) {
1779 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
1780 &Header
::openbigbox
('100%', 'left', '', $errormessage);
1781 &Header
::openbox
( 'Waiting', 1,);
1785 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
1790 &Header
::closebox
();
1791 &Header
::closebigbox
();
1792 &Header
::closepage
();
1796 ## A tiny function to perform a reload of the webpage after one second.
1799 print "<meta http-equiv='refresh' content='1'>\n";
1806 ## Private function to read-in and parse rules of a given rulefile.
1808 ## The given file will be read, parsed and all valid rules will be stored by ID,
1809 ## message/description and it's state in the idsrules hash.
1811 sub readrulesfile
($) {
1812 my $rulefile = shift;
1814 # Open rule file and read in contents
1815 open(RULEFILE
, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
1817 # Store file content in an array.
1818 my @lines = <RULEFILE
>;
1823 # Loop over rule file contents
1824 foreach my $line (@lines) {
1825 # Remove whitespaces.
1829 next if ($line =~ /^\s*$/);
1835 # Gather rule sid and message from the ruleline.
1836 if ($line =~ m/.*msg:\"(.*?)\"\; .* sid:(.*?); /) {
1840 # Check if a rule has been found.
1842 # Add rule to the idsrules hash.
1843 $idsrules{$rulefile}{$sid}{'Description'} = $msg;
1845 # Grab status of the rule. Check if ruleline starts with a "dash".
1846 if ($line =~ /^\#/) {
1847 # If yes, the rule is disabled.
1848 $idsrules{$rulefile}{$sid}{'State'} = "off";
1850 # Otherwise the rule is enabled.
1851 $idsrules{$rulefile}{$sid}{'State'} = "on";
1859 ## Function to get the used memory of a given process-id.
1861 sub get_memory_usage
($) {
1866 # Try to open the status file for the given process-id on the pseudo
1868 if (open(FILE
, "/proc/$pid/status")) {
1869 # Loop through the entire file.
1871 # Splitt current line content and store them into variables.
1872 my ($key, $value) = split(":", $_, 2);
1874 # Check if the current key is the one which contains the memory usage.
1875 # The wanted one is VmRSS which contains the Real-memory (resident set)
1876 # of the entire process.
1877 if ($key eq "VmRSS") {
1878 # Found the memory usage add it to the memory variable.
1886 # Close file handle.
1889 # Return memory usage.
1893 # If the file could not be open, return nothing.
1898 ## Function to read-in the given enabled or disables sids file.
1900 sub read_enabled_disabled_sids_file
($) {
1903 # Temporary hash to store the sids and their state. It will be
1904 # returned at the end of this function.
1907 # Open the given filename.
1908 open(FILE
, "$file") or die "Could not open $file. $!\n";
1910 # Loop through the file.
1916 next if ($_ =~ /^\s*$/);
1919 next if ($_ =~ /^\#/);
1921 # Splitt line into sid and state part.
1922 my ($state, $sid) = split(" ", $_);
1924 # Skip line if the sid is not numeric.
1925 next unless ($sid =~ /\d+/ );
1927 # Check if the sid was enabled.
1928 if ($state eq "enablesid") {
1929 # Add the sid and its state as enabled to the temporary hash.
1930 $temphash{$sid} = "enabled";
1931 # Check if the sid was disabled.
1932 } elsif ($state eq "disablesid") {
1933 # Add the sid and its state as disabled to the temporary hash.
1934 $temphash{$sid} = "disabled";
1935 # Invalid state - skip the current sid and state.
1949 ## Function to get the provider name from the language file or providers file for a given handle.
1951 sub get_provider_name
($) {
1955 # Get the required translation string for the given provider handle.
1956 my $tr_string = $IDS::Ruleset
::Providers
{$handle}{'tr_string'};
1958 # Check if the translation string is available in the language files.
1959 if ($Lang::tr
{$tr_string}) {
1960 # Use the translated string from the language file.
1961 $provider_name = $Lang::tr
{$tr_string};
1963 # Fallback and use the provider summary from the providers file.
1964 $provider_name = $IDS::Ruleset
::Providers
{$handle}{'summary'};
1967 # Return the obtained provider name.
1968 return $provider_name;
1972 ## Private function to convert a given rulefile to a category name.
1973 ## ( No file extension anymore and if the name contained a dot, it
1974 ## would be replaced by a underline sign.)
1976 sub _rulefile_to_category
($) {
1977 my ($filename) = @_;
1979 # Splitt the filename into single chunks and store them in a
1981 my @parts = split(/\./, $filename);
1983 # Return / Remove last element of the temporary array.
1984 # This removes the file extension.
1987 # Join together the single elements of the temporary array.
1988 # If these are more than one, use a "underline" for joining.
1989 my $category = join '_', @parts;
1991 # Return the converted filename.