]> git.ipfire.org Git - people/pmueller/ipfire-2.x.git/blob - html/cgi-bin/ids.cgi
ids.cgi: Handle "Not modified" when forcing an ruleset update.
[people/pmueller/ipfire-2.x.git] / html / cgi-bin / ids.cgi
1 #!/usr/bin/perl
2 ###############################################################################
3 # #
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2007-2020 IPFire Team <info@ipfire.org> #
6 # #
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. #
11 # #
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. #
16 # #
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/>. #
19 # #
20 ###############################################################################
21
22 use strict;
23 use experimental 'smartmatch';
24
25 # enable only the following on debugging purpose
26 #use warnings;
27 #use CGI::Carp 'fatalsToBrowser';
28
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";
34
35 # Import ruleset providers file.
36 require "$IDS::rulesetsourcesfile";
37
38 my %color = ();
39 my %mainsettings = ();
40 my %idsrules = ();
41 my %idssettings=();
42 my %used_providers=();
43 my %cgiparams=();
44 my %checked=();
45 my %selected=();
46 my %ignored=();
47
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);
51
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();
55
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");
59 }
60
61 my $errormessage;
62
63 # Create files if they does not exist yet.
64 &IDS::check_and_create_filelayout();
65
66 # Hash which contains the colour code of a network zone.
67 my %colourhash = (
68 'red' => $Header::colourred,
69 'green' => $Header::colourgreen,
70 'blue' => $Header::colourblue,
71 'orange' => $Header::colourorange,
72 'ovpn' => $Header::colourovpn
73 );
74
75 &Header::showhttpheaders();
76
77 #Get GUI values
78 &Header::getcgihash(\%cgiparams);
79
80 ## Add/edit an entry to the ignore file.
81 #
82 if (($cgiparams{'WHITELIST'} eq $Lang::tr{'add'}) || ($cgiparams{'WHITELIST'} eq $Lang::tr{'update'})) {
83
84 # Check if any input has been performed.
85 if ($cgiparams{'IGNORE_ENTRY_ADDRESS'} ne '') {
86
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'}";
90 }
91 } else {
92 $errormessage = "$Lang::tr{'guardian empty input'}";
93 }
94
95 # Go further if there was no error.
96 if ($errormessage eq '') {
97 my %ignored = ();
98 my $id;
99 my $status;
100
101 # Assign hash values.
102 my $new_entry_address = $cgiparams{'IGNORE_ENTRY_ADDRESS'};
103 my $new_entry_remark = $cgiparams{'IGNORE_ENTRY_REMARK'};
104
105 # Read-in ignoredfile.
106 &General::readhasharray($IDS::ignored_file, \%ignored) if (-e $IDS::ignored_file);
107
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'};
112
113 # Undef the given ID.
114 undef($cgiparams{'ID'});
115
116 # Grab the configured status of the corresponding entry.
117 $status = $ignored{$id}[2];
118 } else {
119 # Each newly added entry automatically should be enabled.
120 $status = "enabled";
121
122 # Generate the ID for the new entry.
123 #
124 # Sort the keys by their ID and store them in an array.
125 my @keys = sort { $a <=> $b } keys %ignored;
126
127 # Reverse the key array.
128 my @reversed = reverse(@keys);
129
130 # Obtain the last used id.
131 my $last_id = @reversed[0];
132
133 # Increase the last id by one and use it as id for the new entry.
134 $id = ++$last_id;
135 }
136
137 # Add/Modify the entry to/in the ignored hash.
138 $ignored{$id} = ["$new_entry_address", "$new_entry_remark", "$status"];
139
140 # Write the changed ignored hash to the ignored file.
141 &General::writehasharray($IDS::ignored_file, \%ignored);
142
143 # Regenerate the ignore file.
144 &IDS::generate_ignore_file();
145 }
146
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");
151 }
152
153 ## Toggle Enabled/Disabled for an existing entry on the ignore list.
154 #
155
156 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr{'toggle enable disable'}) {
157 my %ignored = ();
158
159 # Only go further, if an ID has been passed.
160 if ($cgiparams{'ID'}) {
161 # Assign the given ID.
162 my $id = $cgiparams{'ID'};
163
164 # Undef the given ID.
165 undef($cgiparams{'ID'});
166
167 # Read-in ignoredfile.
168 &General::readhasharray($IDS::ignored_file, \%ignored) if (-e $IDS::ignored_file);
169
170 # Grab the configured status of the corresponding entry.
171 my $status = $ignored{$id}[2];
172
173 # Switch the status.
174 if ($status eq "disabled") {
175 $status = "enabled";
176 } else {
177 $status = "disabled";
178 }
179
180 # Modify the status of the existing entry.
181 $ignored{$id} = ["$ignored{$id}[0]", "$ignored{$id}[1]", "$status"];
182
183 # Write the changed ignored hash to the ignored file.
184 &General::writehasharray($IDS::ignored_file, \%ignored);
185
186 # Regenerate the ignore file.
187 &IDS::generate_ignore_file();
188
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");
193 }
194 }
195
196 ## Remove entry from ignore list.
197 #
198 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr{'remove'}) {
199 my %ignored = ();
200
201 # Read-in ignoredfile.
202 &General::readhasharray($IDS::ignored_file, \%ignored) if (-e $IDS::ignored_file);
203
204 # Drop entry from the hash.
205 delete($ignored{$cgiparams{'ID'}});
206
207 # Undef the given ID.
208 undef($cgiparams{'ID'});
209
210 # Write the changed ignored hash to the ignored file.
211 &General::writehasharray($IDS::ignored_file, \%ignored);
212
213 # Regenerate the ignore file.
214 &IDS::generate_ignore_file();
215
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");
220 }
221 }
222
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
226 # is in progess.
227 &working_notice("$Lang::tr{'ids ruleset autoupdate in progress'}");
228
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.
232 sleep 1;
233 }
234
235 # Page has been unlocked, perform a reload.
236 &reload();
237 }
238
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";
243
244 # Read the stored error message.
245 $errormessage = <FILE>;
246
247 # Close file.
248 close (FILE);
249
250 # Delete the file, which is now not longer required.
251 unlink($IDS::storederrorfile);
252 }
253
254 # Gather ruleset details.
255 if ($cgiparams{'RULESET'}) {
256 ## Grab all available rules and store them in the idsrules hash.
257 #
258
259 # Get enabled providers.
260 my @enabled_providers = &IDS::get_enabled_providers();
261
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)) {
266
267 # We only want files.
268 next unless (-f "$IDS::rulespath/$file");
269
270 # Ignore empty files.
271 next if (-z "$IDS::rulespath/$file");
272
273 # Use a regular expression to find files ending in .rules
274 next unless ($file =~ m/\.rules$/);
275
276 # Ignore files which are not read-able.
277 next unless (-R "$IDS::rulespath/$file");
278
279 # Skip whitelist rules file.
280 next if( $file eq "whitelist.rules");
281
282 # Splitt vendor from filename.
283 my @filename_parts = split(/-/, $file);
284
285 # Assign vendor name for easy processing.
286 my $vendor = @filename_parts[0];
287
288 # Skip rulefile if the provider is disabled.
289 next unless ($vendor ~~ @enabled_providers);
290
291 # Call subfunction to read-in rulefile and add rules to
292 # the idsrules hash.
293 &readrulesfile("$file");
294 }
295
296 closedir(DIR);
297
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);
302
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
307 # no rules.
308 if($idsrules{$rulefile}) {
309 # Add the rulefile state to the %idsrules hash.
310 $idsrules{$rulefile}{'Rulefile'}{'State'} = "on";
311 }
312 }
313 }
314 }
315
316 # Save ruleset.
317 if ($cgiparams{'RULESET'} eq $Lang::tr{'ids apply'}) {
318 # Get enabled providers.
319 my @enabled_providers = &IDS::get_enabled_providers();
320
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;
325
326 # Hash to store the enabled rulefiles for the current processed provider.
327 my %used_rulefiles;
328
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);
331
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);
334
335 # Read-in modifications file, if exists.
336 &General::readhash("$modifications_file", \%enabled_disabled_sids) if (-f "$modifications_file");
337
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);
342
343 # Assign rulefile vendor.
344 my $rulefile_vendor = @filename_parts[0];
345
346 # Skip the rulefile if the vendor is not our current processed provider.
347 next unless ($rulefile_vendor eq $provider);
348
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";
353
354 # Drop item from cgiparams hash.
355 delete $cgiparams{$rulefile};
356 }
357
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+/ );
362
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";
371
372 # Drop item from cgiparams hash.
373 delete $cgiparams{$rulefile}{$sid};
374 }
375 }
376 } else {
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";
384
385 # Drop item from cgiparams hash.
386 delete $cgiparams{$rulefile}{$sid};
387 }
388 }
389 }
390 }
391
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);
396 }
397
398 # Write the used rulefiles file.
399 &General::writehash("$used_rulefiles_file", \%used_rulefiles);
400 }
401
402 # Call function to generate and write the used rulefiles file.
403 &IDS::write_used_rulefiles_file(@enabled_providers);
404
405 # Lock the webpage and print message.
406 &oinkmaster_web();
407
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");
412 }
413
414 # Reload page.
415 &reload();
416
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'};
421
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'}";
425 }
426
427 # Check if enought free disk space is availabe.
428 if(&IDS::checkdiskspace()) {
429 $errormessage = "$Lang::tr{'not enough disk space'}";
430 }
431
432 # Check if any errors happend.
433 unless ($errormessage) {
434 # Lock the webpage and print notice about downloading
435 # a new ruleset.
436 &working_notice("$Lang::tr{'ids download new ruleset'}");
437
438 # Call subfunction to download the ruleset.
439 my $return = &IDS::downloadruleset($provider);
440
441 # Check if the download function gives a return code.
442 if ($return) {
443 # Handle different return codes.
444 if ($return eq "not modified") {
445 $errormessage = "$provider - $Lang::tr{'ids ruleset is up to date'}";
446 } else {
447 $errormessage = "$provider - $Lang::tr{'could not download latest updates'}: $return";
448 }
449
450 # Call function to store the errormessage.
451 &IDS::_store_error_message($errormessage);
452
453 # Preform a reload of the page.
454 &reload();
455 } else {
456 # Call subfunction to launch oinkmaster.
457 &oinkmaster_web();
458
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");
463 }
464
465 # Perform a reload of the page.
466 &reload();
467 }
468 }
469
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();
474
475 # Grab provider handle from cgihash.
476 my $provider = $cgiparams{'PROVIDER'};
477
478 # Lock the webpage and print message.
479 &working_notice("$Lang::tr{'ids apply ruleset changes'}");
480
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);
483
484 # Remove the file if it exists.
485 unlink("$used_rulefiles_file") if (-f "$used_rulefiles_file");
486
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);
490
491 # Check if the file exists.
492 if (-f $modifications_file) {
493 # Remove the file, as requested.
494 unlink("$modifications_file");
495 }
496
497 # Write used rulesfiles file.
498 &IDS::write_used_rulefiles_file(@enabled_providers);
499
500 # Regenerate ruleset.
501 &oinkmaster_web();
502
503 # Check if the IDS is running.
504 if(&IDS::ids_is_running()) {
505 # Get amount of enabled providers.
506 my $amount = @enabled_providers;
507
508 # Check if at least one enabled provider remains.
509 if ($amount >= 1) {
510 # Call suricatactrl to perform a reload.
511 &IDS::call_suricatactrl("reload");
512
513 # Stop suricata if no enabled provider remains.
514 } else {
515 # Call suricatactrel to perform the stop.
516 &IDS::call_suricatactrl("stop");
517 }
518 }
519
520 # Undefine providers flag.
521 undef($cgiparams{'PROVIDERS'});
522
523 # Reload page.
524 &reload();
525
526 # Save IDS settings.
527 } elsif ($cgiparams{'IDS'} eq $Lang::tr{'save'}) {
528 my %oldidssettings;
529 my $reload_page;
530 my $monitored_zones = 0;
531
532 # Read-in current (old) IDS settings.
533 &General::readhash("$IDS::ids_settings_file", \%oldidssettings);
534
535 # Get enabled providers.
536 my @enabled_providers = &IDS::get_enabled_providers();
537
538 # Prevent form name from been stored in conf file.
539 delete $cgiparams{'IDS'};
540
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'};
546 }
547
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);
552
553 # Check if the IDS is enabled for these interfaces.
554 if ($cgiparams{"ENABLE_IDS_$zone_upper"}) {
555 # Increase count.
556 $monitored_zones++;
557 }
558 }
559
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'};
563 }
564 }
565
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);
570 }
571
572 # Generate file to store the home net.
573 &IDS::generate_home_net_file();
574
575 # Generate file to the store the DNS servers.
576 &IDS::generate_dns_servers_file();
577
578 # Generate file to store the HTTP ports.
579 &IDS::generate_http_ports_file();
580
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");
587 } else {
588 # Call suricatactrl to stop suricata.
589 &IDS::call_suricatactrl("stop");
590 }
591 } else {
592 # Call suricatactrl to start suricata.
593 &IDS::call_suricatactrl("start");
594 }
595
596 # Check if the page should be reloaded.
597 if ($reload_page) {
598 # Perform a reload of the page.
599 &reload();
600 }
601
602 # Toggle Enable/Disable autoupdate for a provider
603 } elsif ($cgiparams{'AUTOUPDATE'} eq $Lang::tr{'toggle enable disable'}) {
604 my %used_providers = ();
605
606 # Only go further, if an ID has been passed.
607 if ($cgiparams{'ID'}) {
608 # Assign the given ID.
609 my $id = $cgiparams{'ID'};
610
611 # Undef the given ID.
612 undef($cgiparams{'ID'});
613
614 # Read-in providers settings file.
615 &General::readhasharray($IDS::providers_settings_file, \%used_providers);
616
617 # Grab the configured status of the corresponding entry.
618 my $status_autoupdate = $used_providers{$id}[2];
619
620 # Switch the status.
621 if ($status_autoupdate eq "disabled") {
622 $status_autoupdate = "enabled";
623 } else {
624 $status_autoupdate = "disabled";
625 }
626
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]"];
629
630 # Write the changed hash to the providers settings file.
631 &General::writehasharray($IDS::providers_settings_file, \%used_providers);
632 }
633
634 # Add/Edit a provider to the list of used providers.
635 #
636 } elsif (($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") || ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'update'}")) {
637 my %used_providers = ();
638
639 # Read-in providers settings file.
640 &General::readhasharray("$IDS::providers_settings_file", \%used_providers);
641
642 # Assign some nice human-readable values.
643 my $provider = $cgiparams{'PROVIDER'};
644 my $subscription_code = $cgiparams{'SUBSCRIPTION_CODE'};
645 my $status_autoupdate;
646 my $mode;
647 my $regenerate_ruleset_required;
648
649 # Handle autoupdate checkbox.
650 if ($cgiparams{'ENABLE_AUTOUPDATE'} eq "on") {
651 $status_autoupdate = "enabled";
652 } else {
653 $status_autoupdate = "disabled";
654 }
655
656 # Handle monitor traffic only checkbox.
657 if ($cgiparams{'MONITOR_TRAFFIC_ONLY'} eq "on") {
658 $mode = "IDS";
659 } else {
660 $mode = "IPS";
661 }
662
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'}";
671 }
672 }
673 }
674
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'};
682 }
683 } else {
684 # Print an error message, that an subsription code is required for this
685 # provider.
686 $errormessage = $Lang::tr{'ids subscription code required'};
687 }
688 }
689
690 # Go further if there was no error.
691 if ($errormessage eq '') {
692 my $id;
693 my $status;
694
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'};
699
700 # Undef the given ID.
701 undef($cgiparams{'ID'});
702
703 # Grab the configured mode.
704 my $stored_mode = $used_providers{$id}[4];
705
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";
710 }
711
712 # Grab the configured status of the corresponding entry.
713 $status = $used_providers{$id}[3];
714 } else {
715 # Each newly added entry automatically should be enabled.
716 $status = "enabled";
717
718 # Generate the ID for the new entry.
719 #
720 # Sort the keys by their ID and store them in an array.
721 my @keys = sort { $a <=> $b } keys %used_providers;
722
723 # Reverse the key array.
724 my @reversed = reverse(@keys);
725
726 # Obtain the last used id.
727 my $last_id = @reversed[0];
728
729 # Increase the last id by one and use it as id for the new entry.
730 $id = ++$last_id;
731 }
732
733 # Add/Modify the entry to/in the used providers hash..
734 $used_providers{$id} = ["$provider", "$subscription_code", "$status_autoupdate", "$status", "$mode"];
735
736 # Write the changed hash to the providers settings file.
737 &General::writehasharray($IDS::providers_settings_file, \%used_providers);
738
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'}";
744 }
745
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'}";
749 }
750
751 # Check if any errors happend.
752 unless ($errormessage) {
753 # Lock the webpage and print notice about downloading
754 # a new ruleset.
755 &working_notice("$Lang::tr{'ids working'}");
756
757 # Download the ruleset.
758 if(&IDS::downloadruleset($provider)) {
759 $errormessage = "$Lang::tr{'ids could not add provider'} - $Lang::tr{'ids unable to download the ruleset'}";
760
761 # Call function to store the errormessage.
762 &IDS::_store_error_message($errormessage);
763
764 # Remove the configured provider again.
765 &remove_provider($id);
766 } else {
767 # Extract the ruleset
768 &IDS::extractruleset($provider);
769
770 # Move the ruleset.
771 &IDS::move_tmp_ruleset();
772
773 # Cleanup temporary directory.
774 &IDS::cleanup_tmp_directory();
775 }
776
777 # Perform a reload of the page.
778 &reload();
779 } else {
780 # Remove the configured provider again.
781 &remove_provider($id);
782 }
783 }
784
785 # Check if the ruleset has to be regenerated.
786 if ($regenerate_ruleset_required) {
787 # Call oinkmaster web function.
788 &oinkmaster_web();
789
790 # Perform a reload of the page.
791 &reload();
792 }
793 }
794
795 # Undefine providers flag.
796 undef($cgiparams{'PROVIDERS'});
797
798 ## Toggle Enabled/Disabled for an existing provider.
799 #
800 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr{'toggle enable disable'}) {
801 my %used_providers = ();
802 my $provider_includes_action;
803
804 # Value if oinkmaster has to be executed.
805 my $oinkmaster = "False";
806
807 # Only go further, if an ID has been passed.
808 if ($cgiparams{'ID'}) {
809 # Assign the given ID.
810 my $id = $cgiparams{'ID'};
811
812 # Undef the given ID.
813 undef($cgiparams{'ID'});
814
815 # Read-in file which contains the provider settings.
816 &General::readhasharray($IDS::providers_settings_file, \%used_providers);
817
818 # Grab the configured status of the corresponding entry.
819 my $status = $used_providers{$id}[3];
820
821 # Grab the provider handle.
822 my $provider_handle = $used_providers{$id}[0];
823
824 # Switch the status.
825 if ($status eq "enabled") {
826 $status = "disabled";
827
828 # Set the provider includes action to "remove" for removing the entry.
829 $provider_includes_action = "remove";
830 } else {
831 $status = "enabled";
832
833 # Set the provider includes action to "add".
834 $provider_includes_action = "add";
835
836 # This operation requires to launch oinkmaster.
837 $oinkmaster = "True";
838 }
839
840 # Modify the status of the existing entry.
841 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$used_providers{$id}[2]", "$status", "$used_providers{$id}[4]"];
842
843 # Write the changed hash to the providers settings file.
844 &General::writehasharray($IDS::providers_settings_file, \%used_providers);
845
846 # Get all enabled providers.
847 my @enabled_providers = &IDS::get_enabled_providers();
848
849 # Write the main providers include file.
850 &IDS::write_used_rulefiles_file(@enabled_providers);
851
852 # Check if oinkmaster has to be executed.
853 if ($oinkmaster eq "True") {
854 # Launch oinkmaster.
855 &oinkmaster_web();
856 }
857
858 # Check if the IDS is running.
859 if(&IDS::ids_is_running()) {
860 # Gather the amount of enabled providers (elements in the array).
861 my $amount = @enabled_providers;
862
863 # Check if there are still enabled ruleset providers.
864 if ($amount >= 1) {
865 # Call suricatactrl to perform a restart.
866 &IDS::call_suricatactrl("restart");
867
868 # No active ruleset provider, suricata has to be stopped.
869 } else {
870 # Stop suricata.
871 &IDS::call_suricatactrl("stop");
872 }
873 }
874
875 # Undefine providers flag.
876 undef($cgiparams{'PROVIDERS'});
877
878 # Reload page.
879 &reload();
880 }
881
882 ## Remove provider from the list of used providers.
883 #
884 } elsif ($cgiparams{'PROVIDERS'} eq $Lang::tr{'remove'}) {
885 # Assign a nice human-readable variable.
886 my $id = $cgiparams{'ID'};
887
888 # Grab the provider name bevore deleting.
889 my $provider = &get_provider_handle($id);
890
891 # Remove the provider.
892 &remove_provider($id);
893
894 # Undef the given ID.
895 undef($cgiparams{'ID'});
896
897 # Drop the stored ruleset file.
898 &IDS::drop_dl_rulesfile($provider);
899
900 # Get the name of the provider rulessets include file.
901 my $provider_used_rulefile = &IDS::get_provider_used_rulesfiles_file($provider);
902
903 # Drop the file, it is not longer needed.
904 unlink("$provider_used_rulefile");
905
906 # Call function to get the path and name for the given providers
907 # ruleset modifications file..
908 my $modifications_file = &IDS::get_provider_ruleset_modifications_file($provider);
909
910 # Check if the file exists.
911 if (-f $modifications_file) {
912 # Remove the file, which is not longer needed.
913 unlink("$modifications_file");
914 }
915
916 # Regenerate ruleset.
917 &oinkmaster_web();
918
919 # Gather all enabled providers.
920 my @enabled_providers = &IDS::get_enabled_providers();
921
922 # Regenerate main providers include file.
923 &IDS::write_used_rulefiles_file(@enabled_providers);
924
925 # Check if the IDS is running.
926 if(&IDS::ids_is_running()) {
927 # Get amount of enabled providers.
928 my $amount = @enabled_providers;
929
930 # Check if at least one enabled provider remains.
931 if ($amount >= 1) {
932 # Call suricatactrl to perform a reload.
933 &IDS::call_suricatactrl("restart");
934
935 # Stop suricata if no enabled provider remains.
936 } else {
937 # Call suricatactrel to perform the stop.
938 &IDS::call_suricatactrl("stop");
939 }
940 }
941
942 # Undefine providers flag.
943 undef($cgiparams{'PROVIDERS'});
944
945 # Reload page.
946 &reload();
947 }
948
949 &Header::openpage($Lang::tr{'intrusion detection system'}, 1, '');
950
951 &Header::openbigbox('100%', 'left', '', $errormessage);
952
953 &show_display_error_message();
954
955 if ($cgiparams{'RULESET'} eq "$Lang::tr{'ids customize ruleset'}" ) {
956 &show_customize_ruleset();
957 } elsif ($cgiparams{'PROVIDERS'} ne "") {
958 &show_add_provider();
959 } else {
960 &show_mainpage();
961 }
962
963 &Header::closebigbox();
964 &Header::closepage();
965
966 #
967 ## Tiny function to show if a error message happened.
968 #
969 sub show_display_error_message() {
970 if ($errormessage) {
971 &Header::openbox('100%', 'left', $Lang::tr{'error messages'});
972 print "<class name='base'>$errormessage\n";
973 print "&nbsp;</class>\n";
974 &Header::closebox();
975 }
976 }
977
978 #
979 ## Function to display the main IDS page.
980 #
981 sub show_mainpage() {
982 # Read-in idssettings and provider settings.
983 &General::readhash("$IDS::ids_settings_file", \%idssettings);
984 &General::readhasharray("$IDS::providers_settings_file", \%used_providers);
985
986 # Read-in ignored hosts.
987 &General::readhasharray("$IDS::ignored_file", \%ignored) if (-e $IDS::ignored_file);
988
989 $checked{'ENABLE_IDS'}{'off'} = '';
990 $checked{'ENABLE_IDS'}{'on'} = '';
991 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
992
993 # Draw current state of the IDS
994 &Header::openbox('100%', 'left', $Lang::tr{'intrusion detection system'});
995
996 # Check if the IDS is running and obtain the process-id.
997 my $pid = &IDS::ids_is_running();
998
999 # Display some useful information, if suricata daemon is running.
1000 if ($pid) {
1001 # Gather used memory.
1002 my $memory = &get_memory_usage($pid);
1003
1004 print <<END;
1005 <table width='95%' cellspacing='0' class='tbl'>
1006 <tr>
1007 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1008 </tr>
1009
1010 <tr>
1011 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1012 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
1013 </tr>
1014
1015 <tr>
1016 <td class='base'></td>
1017 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
1018 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
1019 </tr>
1020
1021 <tr>
1022 <td class='base'></td>
1023 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
1024 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
1025 </tr>
1026 </table>
1027 END
1028 } else {
1029 # Otherwise display a hint that the service is not launched.
1030 print <<END;
1031 <table width='95%' cellspacing='0' class='tbl'>
1032 <tr>
1033 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
1034 </tr>
1035
1036 <tr>
1037 <td class='base'>$Lang::tr{'guardian daemon'}</td>
1038 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
1039 </tr>
1040 </table>
1041 END
1042 }
1043
1044 # Only show this area, if at least one ruleset provider is configured.
1045 if (%used_providers) {
1046
1047 print <<END
1048
1049 <br><br><h2>$Lang::tr{'settings'}</h2>
1050
1051 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1052 <table width='100%' border='0'>
1053 <tr>
1054 <td class='base' colspan='2'>
1055 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}>&nbsp;$Lang::tr{'ids enable'}
1056 </td>
1057
1058 </td>
1059 </tr>
1060
1061 <tr>
1062 <td><br><br></td>
1063 <td><br><br></td>
1064 <td><br><br></td>
1065 <td><br><br></td>
1066 </tr>
1067
1068 <tr>
1069 <td colspan='4'><b>$Lang::tr{'ids monitored interfaces'}</b><br></td>
1070 </tr>
1071
1072 <tr>
1073 END
1074 ;
1075
1076 # Loop through the array of available networks and print config options.
1077 foreach my $zone (@network_zones) {
1078 my $checked_input;
1079 my $checked_forward;
1080
1081 # Convert current zone name to upper case.
1082 my $zone_upper = uc($zone);
1083
1084 # Set zone name.
1085 my $zone_name = $zone;
1086
1087 # Dirty hack to get the correct language string for the red zone.
1088 if ($zone eq "red") {
1089 $zone_name = "red1";
1090 }
1091
1092 # Grab checkbox status from settings hash.
1093 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
1094 $checked_input = "checked = 'checked'";
1095 }
1096
1097 print "<td class='base' width='20%'>\n";
1098 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>\n";
1099 print "&nbsp;$Lang::tr{'enabled on'}<font color='$colourhash{$zone}'> $Lang::tr{$zone_name}</font>\n";
1100 print "</td>\n";
1101 }
1102
1103 print <<END
1104 </tr>
1105
1106 <tr>
1107 <td><br><br></td>
1108 <td><br><br></td>
1109 <td><br><br></td>
1110 <td><br><br></td>
1111 </tr>
1112
1113 <tr>
1114 <td colspan='4'><b>$Lang::tr{'ids automatic rules update'}</b></td>
1115 </tr>
1116 </table>
1117
1118 <br><br>
1119
1120 <table width='100%'>
1121 <tr>
1122 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
1123 </tr>
1124 </table>
1125 </form>
1126 END
1127 ;
1128
1129 }
1130
1131 &Header::closebox();
1132
1133 #
1134 # Used Ruleset Providers section.
1135 #
1136 &Header::openbox('100%', 'center', $Lang::tr{'ids ruleset settings'});
1137
1138 print <<END;
1139 <table width='100%' border='0'>
1140 <tr>
1141 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ids provider'}</b></td>
1142 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'date'}</b></td>
1143 <td class='base' bgcolor='$color{'color20'}' align='center'><b>$Lang::tr{'ids autoupdates'}</b></td>
1144 <td class='base' bgcolor='$color{'color20'}' align='center'><b>$Lang::tr{'action'}</b></td>
1145 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1146 </tr>
1147 END
1148 my $line = 1;
1149
1150 # Check if some providers has been configured.
1151 if (keys (%used_providers)) {
1152 my $col = "";
1153
1154 # Loop through all entries of the hash.
1155 foreach my $id (sort keys(%used_providers)) {
1156 # Assign data array positions to some nice variable names.
1157 my $provider = $used_providers{$id}[0];
1158 my $provider_name = &get_provider_name($provider);
1159 my $rulesetdate = &IDS::get_ruleset_date($provider);
1160
1161 my $subscription_code = $used_providers{$id}[1];
1162 my $autoupdate_status = $used_providers{$id}[2];
1163 my $status = $used_providers{$id}[3];
1164
1165 # Check if the item number is even or not.
1166 if ($line % 2) {
1167 $col="bgcolor='$color{'color22'}'";
1168 } else {
1169 $col="bgcolor='$color{'color20'}'";
1170 }
1171
1172 # Choose icons for the checkboxes.
1173 my $status_gif;
1174 my $status_gdesc;
1175 my $autoupdate_status_gif;
1176 my $autoupdate_status_gdesc;
1177
1178 # Check if the status is enabled and select the correct image and description.
1179 if ($status eq 'enabled' ) {
1180 $status_gif = 'on.gif';
1181 $status_gdesc = $Lang::tr{'click to disable'};
1182 } else {
1183 $status_gif = 'off.gif';
1184 $status_gdesc = $Lang::tr{'click to enable'};
1185 }
1186
1187 # Check if the autoupdate status is enabled and select the correct image and description.
1188 if ($autoupdate_status eq 'enabled') {
1189 $autoupdate_status_gif = 'on.gif';
1190 $autoupdate_status_gdesc = $Lang::tr{'click to disable'};
1191 } else {
1192 $autoupdate_status_gif = 'off.gif';
1193 $autoupdate_status_gdesc = $Lang::tr{'click to enable'};
1194 }
1195
1196 print <<END;
1197 <tr>
1198 <td width='33%' class='base' $col>$provider_name</td>
1199 <td width='30%' class='base' $col>$rulesetdate</td>
1200
1201 <td align='center' $col>
1202 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1203 <input type='hidden' name='AUTOUPDATE' value='$Lang::tr{'toggle enable disable'}' />
1204 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$autoupdate_status_gif' alt='$autoupdate_status_gdesc' title='$autoupdate_status_gdesc' />
1205 <input type='hidden' name='ID' value='$id' />
1206 </form>
1207 </td>
1208
1209 <td align='center' $col>
1210 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1211 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'toggle enable disable'}'>
1212 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$status_gif' alt='$status_gdesc' title='$status_gdesc'>
1213 <input type='hidden' name='ID' value='$id'>
1214 </form>
1215 </td>
1216
1217 <td align='center' $col>
1218 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1219 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'edit'}'>
1220 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1221 <input type='hidden' name='ID' value='$id'>
1222 </form>
1223 </td>
1224
1225 <td align='center' $col>
1226 <form method='post' name='$provider' action='$ENV{'SCRIPT_NAME'}'>
1227 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1228 <input type='hidden' name='ID' value='$id'>
1229 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'remove'}'>
1230 </form>
1231 </td>
1232 </tr>
1233 END
1234 # Increment lines value.
1235 $line++;
1236
1237 }
1238
1239 } else {
1240 # Print notice that currently no hosts are ignored.
1241 print "<tr>\n";
1242 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1243 print "</tr>\n";
1244 }
1245
1246 print "</table>\n";
1247
1248 # Section to add new elements or edit existing ones.
1249 print <<END;
1250 <br>
1251 <hr>
1252 <br>
1253
1254 <div align='right'>
1255 <table width='100%'>
1256 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1257 <tr>
1258 END
1259
1260 # Only show this button if a ruleset provider is configured.
1261 if (%used_providers) {
1262 print "<input type='submit' name='RULESET' value='$Lang::tr{'ids customize ruleset'}'>\n";
1263 }
1264 print <<END;
1265 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids add provider'}'>
1266 </tr>
1267 </form>
1268 </table>
1269 </div>
1270 END
1271
1272 &Header::closebox();
1273
1274 #
1275 # Whitelist / Ignorelist
1276 #
1277 &Header::openbox('100%', 'center', $Lang::tr{'ids ignored hosts'});
1278
1279 print <<END;
1280 <table width='100%'>
1281 <tr>
1282 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
1283 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
1284 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1285 </tr>
1286 END
1287 # Check if some hosts have been added to be ignored.
1288 if (keys (%ignored)) {
1289 my $col = "";
1290
1291 # Loop through all entries of the hash.
1292 while( (my $key) = each %ignored) {
1293 # Assign data array positions to some nice variable names.
1294 my $address = $ignored{$key}[0];
1295 my $remark = $ignored{$key}[1];
1296 my $status = $ignored{$key}[2];
1297
1298 # Check if the key (id) number is even or not.
1299 if ($cgiparams{'ID'} eq $key) {
1300 $col="bgcolor='${Header::colouryellow}'";
1301 } elsif ($key % 2) {
1302 $col="bgcolor='$color{'color22'}'";
1303 } else {
1304 $col="bgcolor='$color{'color20'}'";
1305 }
1306
1307 # Choose icon for the checkbox.
1308 my $gif;
1309 my $gdesc;
1310
1311 # Check if the status is enabled and select the correct image and description.
1312 if ($status eq 'enabled' ) {
1313 $gif = 'on.gif';
1314 $gdesc = $Lang::tr{'click to disable'};
1315 } else {
1316 $gif = 'off.gif';
1317 $gdesc = $Lang::tr{'click to enable'};
1318 }
1319
1320 print <<END;
1321 <tr>
1322 <td width='20%' class='base' $col>$address</td>
1323 <td width='65%' class='base' $col>$remark</td>
1324
1325 <td align='center' $col>
1326 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1327 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}'>
1328 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc'>
1329 <input type='hidden' name='ID' value='$key'>
1330 </form>
1331 </td>
1332
1333 <td align='center' $col>
1334 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1335 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}'>
1336 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1337 <input type='hidden' name='ID' value='$key'>
1338 </form>
1339 </td>
1340
1341 <td align='center' $col>
1342 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
1343 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1344 <input type='hidden' name='ID' value='$key'>
1345 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
1346 </form>
1347 </td>
1348 </tr>
1349 END
1350 }
1351 } else {
1352 # Print notice that currently no hosts are ignored.
1353 print "<tr>\n";
1354 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1355 print "</tr>\n";
1356 }
1357
1358 print "</table>\n";
1359
1360 # Section to add new elements or edit existing ones.
1361 print <<END;
1362 <br>
1363 <hr>
1364 <br>
1365
1366 <div align='center'>
1367 <table width='100%'>
1368 END
1369
1370 # Assign correct headline and button text.
1371 my $buttontext;
1372 my $entry_address;
1373 my $entry_remark;
1374
1375 # Check if an ID (key) has been given, in this case an existing entry should be edited.
1376 if ($cgiparams{'ID'} ne '') {
1377 $buttontext = $Lang::tr{'update'};
1378 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
1379
1380 # Grab address and remark for the given key.
1381 $entry_address = $ignored{$cgiparams{'ID'}}[0];
1382 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
1383 } else {
1384 $buttontext = $Lang::tr{'add'};
1385 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
1386 }
1387
1388 print <<END;
1389 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1390 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1391 <tr>
1392 <td width='30%'>$Lang::tr{'ip address'}: </td>
1393 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
1394
1395 <td width='30%'>$Lang::tr{'remark'}: </td>
1396 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
1397 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
1398 </tr>
1399 </form>
1400 </table>
1401 </div>
1402 END
1403
1404 &Header::closebox();
1405 }
1406
1407 #
1408 ## Function to show the customize ruleset section.
1409 #
1410 sub show_customize_ruleset() {
1411 ### Java Script ###
1412 print"<script>\n";
1413
1414 # Java script variable declaration for show and hide.
1415 print"var show = \"$Lang::tr{'ids show'}\"\;\n";
1416 print"var hide = \"$Lang::tr{'ids hide'}\"\;\n";
1417
1418 print <<END
1419 // Tiny javascript function to show/hide the rules
1420 // of a given category.
1421 function showhide(tblname) {
1422 \$("#" + tblname).toggle();
1423
1424 // Get current content of the span element.
1425 var content = document.getElementById("span_" + tblname);
1426
1427 if (content.innerHTML === show) {
1428 content.innerHTML = hide;
1429 } else {
1430 content.innerHTML = show;
1431 }
1432 }
1433 </script>
1434 END
1435 ;
1436 &Header::openbox('100%', 'LEFT', "$Lang::tr{'intrusion detection system rules'}" );
1437 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
1438
1439 # Output display table for rule files
1440 print "<table width='100%'>\n";
1441
1442 # Loop over each rule file
1443 foreach my $rulefile (sort keys(%idsrules)) {
1444 my $rulechecked = '';
1445
1446 # Check if rule file is enabled
1447 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
1448 $rulechecked = 'CHECKED';
1449 }
1450
1451 # Convert rulefile name into category name.
1452 my $categoryname = &_rulefile_to_category($rulefile);
1453
1454 # Table and rows for the rule files.
1455 print"<tr>\n";
1456 print"<td class='base' width='5%'>\n";
1457 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
1458 print"</td>\n";
1459 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
1460 print"<td class='base' width='5%' align='right'>\n";
1461 print"<a href=\"javascript:showhide('$categoryname')\"><span id='span_$categoryname'>$Lang::tr{'ids show'}</span></a>\n";
1462 print"</td>\n";
1463 print"</tr>\n";
1464
1465 # Rows which will be hidden per default and will contain the single rules.
1466 print"<tr style='display:none' id='$categoryname'>\n";
1467 print"<td colspan='3'>\n";
1468
1469 # Local vars
1470 my $lines;
1471 my $rows;
1472 my $col;
1473
1474 # New table for the single rules.
1475 print "<table width='100%'>\n";
1476
1477 # Loop over rule file rules
1478 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
1479 # Local vars
1480 my $ruledefchecked = '';
1481
1482 # Skip rulefile itself.
1483 next if ($sid eq "Rulefile");
1484
1485 # If 2 rules have been displayed, start a new row
1486 if (($lines % 2) == 0) {
1487 print "</tr><tr>\n";
1488
1489 # Increase rows by once.
1490 $rows++;
1491 }
1492
1493 # Colour lines.
1494 if ($rows % 2) {
1495 $col="bgcolor='$color{'color20'}'";
1496 } else {
1497 $col="bgcolor='$color{'color22'}'";
1498 }
1499
1500 # Set rule state
1501 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
1502 $ruledefchecked = 'CHECKED';
1503 }
1504
1505 # Create rule checkbox and display rule description
1506 print "<td class='base' width='5%' align='right' $col>\n";
1507 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
1508 print "</td>\n";
1509 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1510
1511 # Increment rule count
1512 $lines++;
1513 }
1514
1515 # If do not have a second rule for row, create empty cell
1516 if (($lines % 2) != 0) {
1517 print "<td class='base'></td>";
1518 }
1519
1520 # Close display table
1521 print "</tr></table></td></tr>";
1522 }
1523
1524 # Close display table
1525 print "</table>";
1526
1527 print <<END
1528 <table width='100%'>
1529 <tr>
1530 <td width='100%' align='right'>
1531 <input type='submit' value='$Lang::tr{'fwhost back'}'>
1532 <input type='submit' name='RULESET' value='$Lang::tr{'ids apply'}'>
1533 </td>
1534 </tr>
1535 </table>
1536 </form>
1537 END
1538 ;
1539 &Header::closebox();
1540 }
1541
1542 #
1543 ## Function to show section for add/edit a provider.
1544 #
1545 sub show_add_provider() {
1546 my %used_providers = ();
1547 my @subscription_providers;
1548
1549 # Read -in providers settings file.
1550 &General::readhasharray("$IDS::providers_settings_file", \%used_providers);
1551
1552 # Get all supported ruleset providers.
1553 my @ruleset_providers = &IDS::get_ruleset_providers();
1554
1555 ### Java Script ###
1556 print "<script>\n";
1557
1558 # Generate Java Script Object which contains the URL of the providers.
1559 print "\t// Object, which contains the webpages of the ruleset providers.\n";
1560 print "\tvar url = {\n";
1561
1562 # Loop through the array of supported providers.
1563 foreach my $provider (@ruleset_providers) {
1564 # Check if the provider requires a subscription.
1565 if ($IDS::Ruleset::Providers{$provider}{'requires_subscription'} eq "True") {
1566 # Add the provider to the array of subscription_providers.
1567 push(@subscription_providers, $provider);
1568 }
1569
1570 # Grab the URL for the provider.
1571 my $url = $IDS::Ruleset::Providers{$provider}{'website'};
1572
1573 # Print the URL to the Java Script Object.
1574 print "\t\t$provider: \"$url\"\,\n";
1575 }
1576
1577 # Close the Java Script Object declaration.
1578 print "\t}\;\n\n";
1579
1580 # Generate Java Script Array which contains the provider that requires a subscription.
1581 my $line = "";
1582 $line = join("', '", @subscription_providers);
1583
1584 print "\t// Array which contains the providers that requires a subscription.\n";
1585 print "\tsubscription_provider = ['$line']\;\n\n";
1586
1587 print <<END
1588 // Java Script function to swap the text input field for
1589 // entering a subscription code.
1590 var update_provider = function() {
1591 if(inArray(\$('#PROVIDER').val(), subscription_provider)) {
1592 \$('.subscription_code').show();
1593 } else {
1594 \$('.subscription_code').hide();
1595 }
1596
1597 // Call function to change the website url.
1598 change_url(\$('#PROVIDER').val());
1599 };
1600
1601 // Java Script function to check if a given value is part of
1602 // an array.
1603 function inArray(value,array) {
1604 var count=array.length;
1605
1606 for(var i=0;i<count;i++) {
1607 if(array[i]===value){
1608 return true;
1609 }
1610 }
1611
1612 return false;
1613 }
1614
1615 // Tiny function to change the website url based on the selected element in the "PROVIDERS"
1616 // dropdown menu.
1617 function change_url(provider) {
1618 // Get and change the href to the corresponding url.
1619 document.getElementById("website").href = url[provider];
1620 }
1621
1622 // JQuery function to call corresponding function when
1623 // the ruleset provider is changed or the page is loaded for showing/hiding
1624 // the subscription_code area.
1625 \$(document).ready(function() {
1626 \$('#PROVIDER').change(update_provider);
1627 update_provider();
1628 });
1629
1630 </script>
1631 END
1632 ;
1633
1634 # Check if an existing provider should be edited.
1635 if($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1636 # Check if autoupdate is enabled for this provider.
1637 if ($used_providers{$cgiparams{'ID'}}[2] eq "enabled") {
1638 # Set the checkbox to be checked.
1639 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1640 }
1641
1642 # Check if the monitor traffic only mode is set for this provider.
1643 if ($used_providers{$cgiparams{'ID'}}[4] eq "IDS") {
1644 # Set the checkbox to be checked.
1645 $checked{'MONITOR_TRAFFIC_ONLY'} = "checked='checked'";
1646 }
1647
1648 # Display section to force an rules update and to reset the provider.
1649 &show_additional_provider_actions();
1650
1651 } elsif ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'ids add provider'}") {
1652 # Set the autoupdate to true as default.
1653 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1654 }
1655
1656 &Header::openbox('100%', 'center', $Lang::tr{'ids provider settings'});
1657
1658 print <<END
1659 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1660 <table width='100%' border='0'>
1661 <tr>
1662 <td colspan='2'><b>$Lang::tr{'ids provider'}</b></td>
1663 </tr>
1664
1665 <tr>
1666 <td width='40%'>
1667 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1668 END
1669 ;
1670 # Value to allow disabling the dropdown menu.
1671 my $disabled;
1672
1673 # Check if we are in edit mode.
1674 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1675 $disabled = "disabled";
1676
1677 # Add hidden input with the provider because the disable select does not provider
1678 # this.
1679 print "<input type='hidden' name='PROVIDER' value='$used_providers{$cgiparams{'ID'}}[0]'>\n";
1680 }
1681
1682 print "<select name='PROVIDER' id='PROVIDER' $disabled>\n";
1683 # Temporary hash to store the provier names and their handles.
1684 my %tmphash = ();
1685
1686 # Loop through the array of ruleset providers.
1687 foreach my $handle (@ruleset_providers) {
1688 # Get the provider name.
1689 my $name = &get_provider_name($handle);
1690
1691 # Add the grabbed provider name and handle to the
1692 # temporary hash.
1693 $tmphash{$name} = "$handle";
1694 }
1695
1696 # Sort and loop through the temporary hash.
1697 foreach my $provider_name ( sort keys %tmphash ) {
1698 # Grab the provider handle.
1699 my $provider = $tmphash{$provider_name};
1700
1701 # Pre-select the provider if one is given.
1702 if (($used_providers{$cgiparams{'ID'}}[0] eq "$provider") || ($cgiparams{'PROVIDER'} eq "$provider")) {
1703 $selected{$provider} = "selected='selected'";
1704 }
1705
1706 # Add the provider to the dropdown menu.
1707 print "<option value='$provider' $selected{$provider}>$provider_name</option>\n";
1708 }
1709 print <<END
1710 </select>
1711 </td>
1712
1713 <td width='60%'>
1714 <b><a id="website" target="_blank" href="#">$Lang::tr{'ids visit provider website'}</a></b>
1715 </td>
1716 </tr>
1717
1718 <tr>
1719 <td colspan='2'><br><br></td>
1720 </tr>
1721
1722 <tr class='subscription_code' style='display:none' id='subscription_code'>
1723 <td colspan='2'>
1724 <table border='0'>
1725 <tr>
1726 <td>
1727 <b>$Lang::tr{'subscription code'}</b>
1728 </td>
1729 </tr>
1730
1731 <tr>
1732 <td>
1733 <input type='text' size='40' name='SUBSCRIPTION_CODE' value='$used_providers{$cgiparams{'ID'}}[1]'>
1734 </td>
1735 </tr>
1736
1737 <tr>
1738 <td><br><br></td>
1739 </tr>
1740 </table>
1741 </td>
1742 </tr>
1743
1744 <tr>
1745 <td>
1746 <input type='checkbox' name='ENABLE_AUTOUPDATE' $checked{'ENABLE_AUTOUPDATE'}>&nbsp;$Lang::tr{'ids enable automatic updates'}
1747 </td>
1748
1749 <td>
1750 <input type='checkbox' name='MONITOR_TRAFFIC_ONLY' $checked{'MONITOR_TRAFFIC_ONLY'}>&nbsp;$Lang::tr{'ids monitor traffic only'}
1751 </td>
1752 </tr>
1753
1754 <tr>
1755 <td colspan='2' align='right'>
1756 <input type='submit' value='$Lang::tr{'back'}'>
1757 END
1758 ;
1759 # Check if a provider should be added or edited.
1760 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1761 # Display button for updating the existing provider.
1762 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'update'}'>\n";
1763 } else {
1764 # Display button to add the new provider.
1765 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'add'}'>\n";
1766 }
1767 print <<END
1768 </td>
1769 </tr>
1770 </table>
1771 </form>
1772 END
1773 ;
1774 &Header::closebox();
1775 }
1776
1777 #
1778 ## Function to show the area where additional provider actions can be done.
1779 #
1780 sub show_additional_provider_actions() {
1781 my $disabled;
1782 my %used_providers = ();
1783
1784 # Read-in providers settings file.
1785 &General::readhasharray("$IDS::providers_settings_file", \%used_providers);
1786
1787 # Assign variable for provider handle.
1788 my $provider = "$used_providers{$cgiparams{'ID'}}[0]";
1789
1790 # Call function to get the path and name for the given provider
1791 # ruleset modifications file.
1792 my $modifications_file = &IDS::get_provider_ruleset_modifications_file($provider);
1793
1794 # Disable the reset provider button if no provider modified sids file exists.
1795 unless (-f $modifications_file) {
1796 $disabled = "disabled";
1797 }
1798
1799 &Header::openbox('100%', 'center', "");
1800 print <<END
1801 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1802 <table width='100%' border="0">
1803 <tr>
1804 <td align='center'>
1805 <input type='hidden' name='PROVIDER' value='$provider'>
1806 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids reset provider'}' $disabled>
1807 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids force ruleset update'}'>
1808 </td>
1809 </tr>
1810 </table>
1811 </form>
1812 END
1813 ;
1814 &Header::closebox();
1815 }
1816
1817 #
1818 ## A function to display a notice, to lock the webpage and
1819 ## tell the user which action currently will be performed.
1820 #
1821 sub working_notice ($) {
1822 my ($message) = @_;
1823
1824 &_open_working_notice ($message);
1825 &_close_working_notice();
1826 }
1827
1828 #
1829 ## Private function to lock the page and tell the user what is going on.
1830 #
1831 sub _open_working_notice ($) {
1832 my ($message) = @_;
1833
1834 &Header::openpage($Lang::tr{'intrusion detection system'}, 1, '');
1835 &Header::openbigbox('100%', 'left', '', $errormessage);
1836 &Header::openbox( 'Waiting', 1,);
1837 print <<END;
1838 <table>
1839 <tr>
1840 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
1841 <td>$message</td>
1842 </tr>
1843 END
1844 }
1845
1846 #
1847 ## Private function to close a working notice.
1848 #
1849 sub _close_working_notice () {
1850 print "</table>\n";
1851
1852 &Header::closebox();
1853 &Header::closebigbox();
1854 &Header::closepage();
1855 }
1856
1857 #
1858 ## Function which locks the webpage and basically does the same as the
1859 ## oinkmaster function, but provides a lot of HTML formated status output.
1860 #
1861 sub oinkmaster_web () {
1862 my @enabled_providers = &IDS::get_enabled_providers();
1863
1864 # Lock the webpage and print message.
1865 &_open_working_notice("$Lang::tr{'ids apply ruleset changes'}");
1866
1867 # Check if the files in rulesdir have the correct permissions.
1868 &IDS::_check_rulesdir_permissions();
1869
1870 print "<tr><td><br><br></td></tr>\n";
1871
1872 # Cleanup the rules directory before filling it with the new rulests.
1873 &_add_to_notice("$Lang::tr{'ids remove rule structures'}");
1874 &IDS::_cleanup_rulesdir();
1875
1876 # Loop through the array of enabled providers.
1877 foreach my $provider (@enabled_providers) {
1878 &_add_to_notice("$Lang::tr{'ids extract ruleset'} $provider");
1879 # Call the extractruleset function.
1880 &IDS::extractruleset($provider);
1881 }
1882
1883 # Call function to process the ruleset and do all modifications.
1884 &_add_to_notice("$Lang::tr{'ids adjust ruleset'}");
1885 &IDS::process_ruleset(@enabled_providers);
1886
1887 # Call function to merge the classification files.
1888 &_add_to_notice("$Lang::tr{'ids merge classifications'}");
1889 &IDS::merge_classifications(@enabled_providers);
1890
1891 # Call function to merge the sid to message mapping files.
1892 &_add_to_notice("$Lang::tr{'ids merge sid files'}");
1893 &IDS::merge_sid_msg(@enabled_providers);
1894
1895 # Cleanup temporary directory.
1896 &_add_to_notice("$Lang::tr{'ids cleanup tmp dir'}");
1897 &IDS::cleanup_tmp_directory();
1898
1899 # Finished - print a notice.
1900 &_add_to_notice("$Lang::tr{'ids finished'}");
1901
1902 # Close the working notice.
1903 &_close_working_notice();
1904 }
1905
1906 #
1907 ## Tiny private function to add a given message to a notice table.
1908 #
1909 sub _add_to_notice ($) {
1910 my ($message) = @_;
1911
1912 print "<tr><td colspan='2'><li><b>$message</b></li></td></tr>\n";
1913 }
1914
1915 #
1916 ## A tiny function to perform a reload of the webpage after one second.
1917 #
1918 sub reload () {
1919 print "<meta http-equiv='refresh' content='1'>\n";
1920
1921 # Stop the script.
1922 exit;
1923 }
1924
1925 #
1926 ## Private function to read-in and parse rules of a given rulefile.
1927 #
1928 ## The given file will be read, parsed and all valid rules will be stored by ID,
1929 ## message/description and it's state in the idsrules hash.
1930 #
1931 sub readrulesfile ($) {
1932 my $rulefile = shift;
1933
1934 # Open rule file and read in contents
1935 open(RULEFILE, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
1936
1937 # Store file content in an array.
1938 my @lines = <RULEFILE>;
1939
1940 # Close file.
1941 close(RULEFILE);
1942
1943 # Loop over rule file contents
1944 foreach my $line (@lines) {
1945 # Remove whitespaces.
1946 chomp $line;
1947
1948 # Skip blank lines.
1949 next if ($line =~ /^\s*$/);
1950
1951 # Local vars.
1952 my $sid;
1953 my $msg;
1954
1955 # Gather rule sid and message from the ruleline.
1956 if ($line =~ m/.*msg:\s*\"(.*?)\"\;.*sid:\s*(.*?); /) {
1957 $msg = $1;
1958 $sid = $2;
1959
1960 # Check if a rule has been found.
1961 if ($sid && $msg) {
1962 # Add rule to the idsrules hash.
1963 $idsrules{$rulefile}{$sid}{'Description'} = $msg;
1964
1965 # Grab status of the rule. Check if ruleline starts with a "dash".
1966 if ($line =~ /^\#/) {
1967 # If yes, the rule is disabled.
1968 $idsrules{$rulefile}{$sid}{'State'} = "off";
1969 } else {
1970 # Otherwise the rule is enabled.
1971 $idsrules{$rulefile}{$sid}{'State'} = "on";
1972 }
1973 }
1974 }
1975 }
1976 }
1977
1978 #
1979 ## Function to get the used memory of a given process-id.
1980 #
1981 sub get_memory_usage($) {
1982 my ($pid) = @_;
1983
1984 my $memory = 0;
1985
1986 # Try to open the status file for the given process-id on the pseudo
1987 # file system proc.
1988 if (open(FILE, "/proc/$pid/status")) {
1989 # Loop through the entire file.
1990 while (<FILE>) {
1991 # Splitt current line content and store them into variables.
1992 my ($key, $value) = split(":", $_, 2);
1993
1994 # Check if the current key is the one which contains the memory usage.
1995 # The wanted one is VmRSS which contains the Real-memory (resident set)
1996 # of the entire process.
1997 if ($key eq "VmRSS") {
1998 # Found the memory usage add it to the memory variable.
1999 $memory += $value;
2000
2001 # Break the loop.
2002 last;
2003 }
2004 }
2005
2006 # Close file handle.
2007 close(FILE);
2008
2009 # Return memory usage.
2010 return $memory;
2011 }
2012
2013 # If the file could not be open, return nothing.
2014 return;
2015 }
2016
2017 #
2018 ## Function to get the provider handle by a given ID.
2019 #
2020 sub get_provider_handle($) {
2021 my ($id) = @_;
2022
2023 my %used_providers = ();
2024
2025 # Read-in provider settings file.
2026 &General::readhasharray($IDS::providers_settings_file, \%used_providers);
2027
2028 # Obtain the provider handle for the given ID.
2029 my $provider_handle = $used_providers{$cgiparams{'ID'}}[0];
2030
2031 # Return the handle.
2032 return $provider_handle;
2033 }
2034
2035 #
2036 ## Function to get the provider name from the language file or providers file for a given handle.
2037 #
2038 sub get_provider_name($) {
2039 my ($handle) = @_;
2040 my $provider_name;
2041
2042 # Get the required translation string for the given provider handle.
2043 my $tr_string = $IDS::Ruleset::Providers{$handle}{'tr_string'};
2044
2045 # Check if the translation string is available in the language files.
2046 if ($Lang::tr{$tr_string}) {
2047 # Use the translated string from the language file.
2048 $provider_name = $Lang::tr{$tr_string};
2049 } else {
2050 # Fallback and use the provider summary from the providers file.
2051 $provider_name = $IDS::Ruleset::Providers{$handle}{'summary'};
2052 }
2053
2054 # Return the obtained provider name.
2055 return $provider_name;
2056 }
2057
2058 #
2059 ## Function to remove a provider by a given ID.
2060 #
2061 sub remove_provider($) {
2062 my ($id) = @_;
2063
2064 my %used_providers = ();
2065
2066 # Read-in provider settings file.
2067 &General::readhasharray($IDS::providers_settings_file, \%used_providers);
2068
2069 # Drop entry from the hash.
2070 delete($used_providers{$id});
2071
2072 # Write the changed hash to the provider settings file.
2073 &General::writehasharray($IDS::providers_settings_file, \%used_providers);
2074 }
2075
2076 #
2077 ## Private function to convert a given rulefile to a category name.
2078 ## ( No file extension anymore and if the name contained a dot, it
2079 ## would be replaced by a underline sign.)
2080 #
2081 sub _rulefile_to_category($) {
2082 my ($filename) = @_;
2083
2084 # Splitt the filename into single chunks and store them in a
2085 # temorary array.
2086 my @parts = split(/\./, $filename);
2087
2088 # Return / Remove last element of the temporary array.
2089 # This removes the file extension.
2090 pop @parts;
2091
2092 # Join together the single elements of the temporary array.
2093 # If these are more than one, use a "underline" for joining.
2094 my $category = join '_', @parts;
2095
2096 # Return the converted filename.
2097 return $category;
2098 }