]> git.ipfire.org Git - people/stevee/ipfire-2.x.git/blame - html/cgi-bin/ids.cgi
ids.cgi: Add code to handle enable/disable autoupdate for a provider.
[people/stevee/ipfire-2.x.git] / html / cgi-bin / ids.cgi
CommitLineData
ac1cfefa 1#!/usr/bin/perl
70df8302
MT
2###############################################################################
3# #
4# IPFire.org - A linux based firewall #
e698090e 5# Copyright (C) 2007-2020 IPFire Team <info@ipfire.org> #
70df8302
MT
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
ac1cfefa
MT
22use strict;
23
24# enable only the following on debugging purpose
90c2e164
CS
25#use warnings;
26#use CGI::Carp 'fatalsToBrowser';
ac1cfefa 27
986e08d9 28require '/var/ipfire/general-functions.pl';
ac1cfefa
MT
29require "${General::swroot}/lang.pl";
30require "${General::swroot}/header.pl";
8dcebe53 31require "${General::swroot}/ids-functions.pl";
abffcc99 32require "${General::swroot}/network-functions.pl";
ac1cfefa 33
3e12c6e6
SS
34# Import ruleset providers file.
35require "$IDS::rulesetsourcesfile";
36
f2fdd0c1
CS
37my %color = ();
38my %mainsettings = ();
9d18656b 39my %idsrules = ();
1286e0d4 40my %idssettings=();
2f252efa 41my %used_providers=();
298723b9 42my %cgiparams=();
ac1cfefa 43my %checked=();
5a3e0dca 44my %selected=();
b7e29743 45my %ignored=();
0b89daee
SS
46
47# Read-in main settings, for language, theme and colors.
48&General::readhash("${General::swroot}/main/settings", \%mainsettings);
8186b372 49&General::readhash("/srv/web/ipfire/html/themes/ipfire/include/colors.txt", \%color);
0b89daee 50
1286e0d4
SS
51# Get the available network zones, based on the config type of the system and store
52# the list of zones in an array.
abffcc99 53my @network_zones = &Network::get_available_network_zones();
ac1cfefa 54
51b63b41
SS
55# Check if openvpn is started and add it to the array of network zones.
56if ( -e "/var/run/openvpn.pid") {
57 push(@network_zones, "ovpn");
58}
59
43263ea6
SS
60my $errormessage;
61
00512a5a 62# Create files if they does not exist yet.
b02e30fd 63&IDS::check_and_create_filelayout();
01ba4be4 64
99b372b5
SS
65# Hash which contains the colour code of a network zone.
66my %colourhash = (
67 'red' => $Header::colourred,
68 'green' => $Header::colourgreen,
69 'blue' => $Header::colourblue,
51b63b41
SS
70 'orange' => $Header::colourorange,
71 'ovpn' => $Header::colourovpn
99b372b5
SS
72);
73
ac1cfefa
MT
74&Header::showhttpheaders();
75
298723b9
SS
76#Get GUI values
77&Header::getcgihash(\%cgiparams);
ac1cfefa 78
b7e29743
SS
79## Add/edit an entry to the ignore file.
80#
81if (($cgiparams{'WHITELIST'} eq $Lang::tr{'add'}) || ($cgiparams{'WHITELIST'} eq $Lang::tr{'update'})) {
82
83 # Check if any input has been performed.
84 if ($cgiparams{'IGNORE_ENTRY_ADDRESS'} ne '') {
85
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'}";
89 }
90 } else {
91 $errormessage = "$Lang::tr{'guardian empty input'}";
92 }
93
94 # Go further if there was no error.
95 if ($errormessage eq '') {
96 my %ignored = ();
97 my $id;
98 my $status;
99
100 # Assign hash values.
101 my $new_entry_address = $cgiparams{'IGNORE_ENTRY_ADDRESS'};
102 my $new_entry_remark = $cgiparams{'IGNORE_ENTRY_REMARK'};
103
104 # Read-in ignoredfile.
b02e30fd 105 &General::readhasharray($IDS::ignored_file, \%ignored);
b7e29743
SS
106
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'};
111
112 # Undef the given ID.
113 undef($cgiparams{'ID'});
114
115 # Grab the configured status of the corresponding entry.
116 $status = $ignored{$id}[2];
117 } else {
118 # Each newly added entry automatically should be enabled.
119 $status = "enabled";
120
121 # Generate the ID for the new entry.
122 #
123 # Sort the keys by their ID and store them in an array.
124 my @keys = sort { $a <=> $b } keys %ignored;
125
126 # Reverse the key array.
127 my @reversed = reverse(@keys);
128
129 # Obtain the last used id.
130 my $last_id = @reversed[0];
131
132 # Increase the last id by one and use it as id for the new entry.
133 $id = ++$last_id;
134 }
135
136 # Add/Modify the entry to/in the ignored hash.
137 $ignored{$id} = ["$new_entry_address", "$new_entry_remark", "$status"];
138
139 # Write the changed ignored hash to the ignored file.
b02e30fd 140 &General::writehasharray($IDS::ignored_file, \%ignored);
b7e29743
SS
141
142 # Regenerate the ignore file.
9283e9b9 143 &IDS::generate_ignore_file();
b7e29743
SS
144 }
145
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");
150 }
151
152## Toggle Enabled/Disabled for an existing entry on the ignore list.
153#
154
155} elsif ($cgiparams{'WHITELIST'} eq $Lang::tr{'toggle enable disable'}) {
156 my %ignored = ();
157
158 # Only go further, if an ID has been passed.
159 if ($cgiparams{'ID'}) {
160 # Assign the given ID.
161 my $id = $cgiparams{'ID'};
162
163 # Undef the given ID.
164 undef($cgiparams{'ID'});
165
166 # Read-in ignoredfile.
b02e30fd 167 &General::readhasharray($IDS::ignored_file, \%ignored);
b7e29743
SS
168
169 # Grab the configured status of the corresponding entry.
170 my $status = $ignored{$id}[2];
171
172 # Switch the status.
173 if ($status eq "disabled") {
174 $status = "enabled";
175 } else {
176 $status = "disabled";
177 }
178
179 # Modify the status of the existing entry.
180 $ignored{$id} = ["$ignored{$id}[0]", "$ignored{$id}[1]", "$status"];
181
182 # Write the changed ignored hash to the ignored file.
b02e30fd 183 &General::writehasharray($IDS::ignored_file, \%ignored);
b7e29743
SS
184
185 # Regenerate the ignore file.
9283e9b9 186 &IDS::generate_ignore_file();
b7e29743
SS
187
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");
192 }
193 }
194
195## Remove entry from ignore list.
196#
197} elsif ($cgiparams{'WHITELIST'} eq $Lang::tr{'remove'}) {
198 my %ignored = ();
199
200 # Read-in ignoredfile.
b02e30fd 201 &General::readhasharray($IDS::ignored_file, \%ignored);
b7e29743
SS
202
203 # Drop entry from the hash.
204 delete($ignored{$cgiparams{'ID'}});
205
206 # Undef the given ID.
207 undef($cgiparams{'ID'});
208
209 # Write the changed ignored hash to the ignored file.
b02e30fd 210 &General::writehasharray($IDS::ignored_file, \%ignored);
b7e29743
SS
211
212 # Regenerate the ignore file.
9283e9b9 213 &IDS::generate_ignore_file();
b7e29743
SS
214
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");
219 }
220}
221
9074e3d7
SS
222# Check if the page is locked, in this case, the ids_page_lock_file exists.
223if (-e $IDS::ids_page_lock_file) {
224 # Lock the webpage and print notice about autoupgrade of the ruleset
225 # is in progess.
226 &working_notice("$Lang::tr{'ids ruleset autoupdate in progress'}");
227
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.
231 sleep 1;
232 }
233
234 # Page has been unlocked, perform a reload.
235 &reload();
236}
237
3983aebd
SS
238# Check if any error has been stored.
239if (-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";
242
243 # Read the stored error message.
244 $errormessage = <FILE>;
245
246 # Close file.
247 close (FILE);
248
249 # Delete the file, which is now not longer required.
250 unlink($IDS::storederrorfile);
251}
252
a468b62b
SS
253# Gather ruleset details.
254if ($cgiparams{'RULESET'}) {
255 ## Grab all available rules and store them in the idsrules hash.
256 #
257 # Open rules directory and do a directory listing.
258 opendir(DIR, $IDS::rulespath) or die $!;
259 # Loop through the direcory.
260 while (my $file = readdir(DIR)) {
422204ff 261
a468b62b
SS
262 # We only want files.
263 next unless (-f "$IDS::rulespath/$file");
422204ff 264
a468b62b
SS
265 # Ignore empty files.
266 next if (-z "$IDS::rulespath/$file");
422204ff 267
a468b62b
SS
268 # Use a regular expression to find files ending in .rules
269 next unless ($file =~ m/\.rules$/);
422204ff 270
a468b62b
SS
271 # Ignore files which are not read-able.
272 next unless (-R "$IDS::rulespath/$file");
395e3b90 273
a468b62b
SS
274 # Skip whitelist rules file.
275 next if( $file eq "whitelist.rules");
b7e29743 276
a468b62b
SS
277 # Call subfunction to read-in rulefile and add rules to
278 # the idsrules hash.
279 &readrulesfile("$file");
280 }
395e3b90 281
a468b62b 282 closedir(DIR);
395e3b90 283
a468b62b
SS
284 # Gather used rulefiles.
285 #
286 # Check if the file for activated rulefiles is not empty.
287 if(-f $IDS::used_rulefiles_file) {
288 # Open the file for used rulefile and read-in content.
289 open(FILE, $IDS::used_rulefiles_file) or die "Could not open $IDS::used_rulefiles_file. $!\n";
290
291 # Read-in content.
292 my @lines = <FILE>;
293
294 # Close file.
295 close(FILE);
296
297 # Loop through the array.
298 foreach my $line (@lines) {
299 # Remove newlines.
300 chomp($line);
301
302 # Skip comments.
303 next if ($line =~ /\#/);
304
305 # Skip blank lines.
306 next if ($line =~ /^\s*$/);
307
308 # Gather rule sid and message from the ruleline.
309 if ($line =~ /.*- (.*)/) {
310 my $rulefile = $1;
311
312 # Check if the current rulefile exists in the %idsrules hash.
313 # If not, the file probably does not exist anymore or contains
314 # no rules.
315 if($idsrules{$rulefile}) {
316 # Add the rulefile state to the %idsrules hash.
317 $idsrules{$rulefile}{'Rulefile'}{'State'} = "on";
318 }
43ab7d9c 319 }
e5738079
SS
320 }
321 }
322}
323
ea5c8eeb
SS
324# Save ruleset configuration.
325if ($cgiparams{'RULESET'} eq $Lang::tr{'save'}) {
326 my %oldsettings;
327
328 # Read-in current (old) IDS settings.
b02e30fd 329 &General::readhash("$IDS::rules_settings_file", \%oldsettings);
ea5c8eeb
SS
330
331 # Prevent form name from been stored in conf file.
332 delete $cgiparams{'RULESET'};
333
613f58fb 334 # Check if the choosen vendor (URL) requires an subscription/oinkcode.
3e12c6e6 335 if ($IDS::Ruleset::Providers{$cgiparams{'RULES'}}{'requires_subscription'} eq "True") {
613f58fb
SS
336 # Check if an subscription/oinkcode has been provided.
337 if ($cgiparams{'OINKCODE'}) {
338 # Check if the oinkcode contains unallowed chars.
339 unless ($cgiparams{'OINKCODE'} =~ /^[a-z0-9]+$/) {
340 $errormessage = $Lang::tr{'invalid input for oink code'};
341 }
342 } else {
343 # Print an error message, that an subsription/oinkcode is required for this
344 # vendor.
345 $errormessage = $Lang::tr{'ids oinkcode required'};
ea5c8eeb
SS
346 }
347 }
348
349 # Go on if there are no error messages.
350 if (!$errormessage) {
351 # Store settings into settings file.
b02e30fd 352 &General::writehash("$IDS::rules_settings_file", \%cgiparams);
ea5c8eeb 353
f644a167
SS
354 # Check if a ruleset is present - if not or the source has been changed download it.
355 if((! %idsrules) || ($oldsettings{'RULES'} ne $cgiparams{'RULES'})) {
356 # Check if the red device is active.
357 unless (-e "${General::swroot}/red/active") {
358 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
5fd2e9d6
SS
359 }
360
a5ba473c 361 # Check if enough free disk space is availabe.
f644a167
SS
362 if(&IDS::checkdiskspace()) {
363 $errormessage = "$Lang::tr{'not enough disk space'}";
97870bf2
SS
364 }
365
f644a167
SS
366 # Check if any errors happend.
367 unless ($errormessage) {
368 # Lock the webpage and print notice about downloading
369 # a new ruleset.
5bd8940d 370 &working_notice("$Lang::tr{'ids working'}");
f644a167 371
a5ba473c 372 # Write the modify sid's file and pass the taken ruleaction.
81bae51f 373 &IDS::write_modify_sids_file();
a5ba473c 374
f644a167
SS
375 # Call subfunction to download the ruleset.
376 if(&IDS::downloadruleset()) {
377 $errormessage = $Lang::tr{'could not download latest updates'};
378
379 # Call function to store the errormessage.
380 &IDS::_store_error_message($errormessage);
381 } else {
382 # Call subfunction to launch oinkmaster.
383 &IDS::oinkmaster();
384 }
385
386 # Check if the IDS is running.
387 if(&IDS::ids_is_running()) {
388 # Call suricatactrl to stop the IDS - because of the changed
389 # ruleset - the use has to configure it before suricata can be
390 # used again.
391 &IDS::call_suricatactrl("stop");
392 }
393
394 # Perform a reload of the page.
395 &reload();
396 }
5fd2e9d6
SS
397 }
398 }
399
298723b9 400# Save ruleset.
ee7fe87e 401} elsif ($cgiparams{'RULESET'} eq $Lang::tr{'ids apply'}) {
d2212836 402 # Arrays to store which rulefiles have been enabled and will be used.
e5738079 403 my @enabled_rulefiles;
298723b9 404
d2212836
SS
405 # Hash to store the user-enabled and disabled sids.
406 my %enabled_disabled_sids;
407
af8e5145
SS
408 # Store if a restart of suricata is required.
409 my $suricata_restart_required;
410
9d18656b
SS
411 # Loop through the hash of idsrules.
412 foreach my $rulefile(keys %idsrules) {
1622e5c1
SS
413 # Check if the state of the rulefile has been changed.
414 unless ($cgiparams{$rulefile} eq $idsrules{$rulefile}{'Rulefile'}{'State'}) {
415 # A restart of suricata is required to apply the changes of the used rulefiles.
416 $suricata_restart_required = 1;
417 }
418
e5738079
SS
419 # Check if the rulefile is enabled.
420 if ($cgiparams{$rulefile} eq "on") {
421 # Add rulefile to the array of enabled rulefiles.
422 push(@enabled_rulefiles, $rulefile);
b65b5ef3
SS
423
424 # Drop item from cgiparams hash.
425 delete $cgiparams{$rulefile};
e5738079 426 }
466c6779 427 }
e5738079 428
d2212836
SS
429 # Read-in the files for enabled/disabled sids.
430 # This will be done by calling the read_enabled_disabled_sids_file function two times
431 # and merge the returned hashes together into the enabled_disabled_sids hash.
432 %enabled_disabled_sids = (
b02e30fd
SS
433 &read_enabled_disabled_sids_file($IDS::disabled_sids_file),
434 &read_enabled_disabled_sids_file($IDS::enabled_sids_file));
d2212836 435
9d18656b
SS
436 # Loop through the hash of idsrules.
437 foreach my $rulefile (keys %idsrules) {
298723b9 438 # Loop through the single rules of the rulefile.
9d18656b 439 foreach my $sid (keys %{$idsrules{$rulefile}}) {
c51a044a
SS
440 # Skip the current sid if it is not numeric.
441 next unless ($sid =~ /\d+/ );
442
298723b9
SS
443 # Check if there exists a key in the cgiparams hash for this sid.
444 if (exists($cgiparams{$sid})) {
445 # Look if the rule is disabled.
9d18656b 446 if ($idsrules{$rulefile}{$sid}{'State'} eq "off") {
298723b9
SS
447 # Check if the state has been set to 'on'.
448 if ($cgiparams{$sid} eq "on") {
d2212836
SS
449 # Add/Modify the sid to/in the enabled_disabled_sids hash.
450 $enabled_disabled_sids{$sid} = "enabled";
298723b9
SS
451
452 # Drop item from cgiparams hash.
60333473 453 delete $cgiparams{$rulefile}{$sid};
298723b9
SS
454 }
455 }
456 } else {
457 # Look if the rule is enabled.
9d18656b 458 if ($idsrules{$rulefile}{$sid}{'State'} eq "on") {
298723b9
SS
459 # Check if the state is 'on' and should be disabled.
460 # In this case there is no entry
461 # for the sid in the cgiparams hash.
d2212836
SS
462 # Add/Modify it to/in the enabled_disabled_sids hash.
463 $enabled_disabled_sids{$sid} = "disabled";
298723b9
SS
464
465 # Drop item from cgiparams hash.
60333473 466 delete $cgiparams{$rulefile}{$sid};
298723b9
SS
467 }
468 }
469 }
470 }
471
37659505 472 # Open enabled sid's file for writing.
b02e30fd 473 open(ENABLED_FILE, ">$IDS::enabled_sids_file") or die "Could not write to $IDS::enabled_sids_file. $!\n";
37659505
SS
474
475 # Open disabled sid's file for writing.
b02e30fd 476 open(DISABLED_FILE, ">$IDS::disabled_sids_file") or die "Could not write to $IDS::disabled_sids_file. $!\n";
d2212836
SS
477
478 # Write header to the files.
479 print ENABLED_FILE "#Autogenerated file. Any custom changes will be overwritten!\n";
480 print DISABLED_FILE "#Autogenerated file. Any custom changes will be overwritten!\n";
481
482 # Check if the hash for enabled/disabled files contains any entries.
483 if (%enabled_disabled_sids) {
484 # Loop through the hash.
485 foreach my $sid (keys %enabled_disabled_sids) {
486 # Check if the sid is enabled.
487 if ($enabled_disabled_sids{$sid} eq "enabled") {
488 # Print the sid to the enabled_sids file.
489 print ENABLED_FILE "enablesid $sid\n";
490 # Check if the sid is disabled.
491 } elsif ($enabled_disabled_sids{$sid} eq "disabled") {
492 # Print the sid to the disabled_sids file.
493 print DISABLED_FILE "disablesid $sid\n";
494 # Something strange happende - skip the current sid.
495 } else {
496 next;
497 }
37659505
SS
498 }
499 }
298723b9 500
d2212836
SS
501 # Close file for enabled_sids after writing.
502 close(ENABLED_FILE);
503
504 # Close file for disabled_sids after writing.
505 close(DISABLED_FILE);
e5738079 506
b02e30fd
SS
507 # Call function to generate and write the used rulefiles file.
508 &IDS::write_used_rulefiles_file(@enabled_rulefiles);
52599865 509
27760092 510 # Lock the webpage and print message.
5bd8940d 511 &working_notice("$Lang::tr{'ids apply ruleset changes'}");
27760092 512
52599865 513 # Call oinkmaster to alter the ruleset.
27760092
SS
514 &IDS::oinkmaster();
515
e2e7880d 516 # Check if the IDS is running.
5a28e721 517 if(&IDS::ids_is_running()) {
af8e5145
SS
518 # Check if a restart of suricata is required.
519 if ($suricata_restart_required) {
520 # Call suricatactrl to perform the restart.
521 &IDS::call_suricatactrl("restart");
522 } else {
523 # Call suricatactrl to perform a reload.
524 &IDS::call_suricatactrl("reload");
525 }
e2e7880d
SS
526 }
527
27760092
SS
528 # Reload page.
529 &reload();
52599865
SS
530
531# Download new ruleset.
5fd2e9d6 532} elsif ($cgiparams{'RULESET'} eq $Lang::tr{'update ruleset'}) {
43263ea6
SS
533 # Check if the red device is active.
534 unless (-e "${General::swroot}/red/active") {
013274d7 535 $errormessage = "$Lang::tr{'could not download latest updates'} - $Lang::tr{'system is offline'}";
43263ea6 536 }
52599865 537
3983aebd 538 # Check if enought free disk space is availabe.
434001d0
SS
539 if(&IDS::checkdiskspace()) {
540 $errormessage = "$Lang::tr{'not enough disk space'}";
541 }
52599865 542
43263ea6
SS
543 # Check if any errors happend.
544 unless ($errormessage) {
27760092
SS
545 # Lock the webpage and print notice about downloading
546 # a new ruleset.
5bd8940d 547 &working_notice("$Lang::tr{'ids download new ruleset'}");
3983aebd 548
43263ea6 549 # Call subfunction to download the ruleset.
434001d0
SS
550 if(&IDS::downloadruleset()) {
551 $errormessage = $Lang::tr{'could not download latest updates'};
8f22237b 552
3983aebd 553 # Call function to store the errormessage.
434001d0 554 &IDS::_store_error_message($errormessage);
52599865 555
3983aebd
SS
556 # Preform a reload of the page.
557 &reload();
558 } else {
559 # Call subfunction to launch oinkmaster.
560 &IDS::oinkmaster();
43263ea6 561
e2e7880d 562 # Check if the IDS is running.
5a28e721 563 if(&IDS::ids_is_running()) {
e2e7880d
SS
564 # Call suricatactrl to perform a reload.
565 &IDS::call_suricatactrl("reload");
566 }
567
3983aebd
SS
568 # Perform a reload of the page.
569 &reload();
570 }
52599865 571 }
5bd8940d 572# Save IDS settings.
e0bfd338 573} elsif ($cgiparams{'IDS'} eq $Lang::tr{'save'}) {
bbb6efae
SS
574 my %oldidssettings;
575 my $reload_page;
ebdd0f9a 576 my $monitored_zones = 0;
bbb6efae
SS
577
578 # Read-in current (old) IDS settings.
b02e30fd 579 &General::readhash("$IDS::ids_settings_file", \%oldidssettings);
bbb6efae 580
a232b58c 581 # Prevent form name from been stored in conf file.
e0bfd338 582 delete $cgiparams{'IDS'};
a232b58c 583
ebdd0f9a
SS
584 # Check if the IDS should be enabled.
585 if ($cgiparams{'ENABLE_IDS'} eq "on") {
586 # Check if any ruleset is available. Otherwise abort and display an error.
2f252efa 587 unless(%used_providers) {
ebdd0f9a
SS
588 $errormessage = $Lang::tr{'ids no ruleset available'};
589 }
590
591 # Loop through the array of available interfaces.
592 foreach my $zone (@network_zones) {
593 # Convert interface name into upper case.
594 my $zone_upper = uc($zone);
595
596 # Check if the IDS is enabled for this interaces.
597 if ($cgiparams{"ENABLE_IDS_$zone_upper"}) {
598 # Increase count.
599 $monitored_zones++;
600 }
601 }
602
603 # Check if at least one zone should be monitored, or show an error.
604 unless ($monitored_zones >= 1) {
605 $errormessage = $Lang::tr{'ids no network zone'};
606 }
607 }
608
a232b58c
SS
609 # Go on if there are no error messages.
610 if (!$errormessage) {
611 # Store settings into settings file.
b02e30fd 612 &General::writehash("$IDS::ids_settings_file", \%cgiparams);
a9a91e5f 613 }
8d2f6b0b 614
77351a6b
SS
615 # Check if the the automatic rule update hass been touched.
616 if($cgiparams{'AUTOUPDATE_INTERVAL'} ne $oldidssettings{'AUTOUPDATE_INTERVAL'}) {
617 # Call suricatactrl to set the new interval.
618 &IDS::call_suricatactrl("cron", $cgiparams{'AUTOUPDATE_INTERVAL'});
619 }
620
8d2f6b0b 621 # Generate file to store the home net.
b02e30fd 622 &IDS::generate_home_net_file();
e2e7880d 623
a40ee6b9
SS
624 # Generate file to the store the DNS servers.
625 &IDS::generate_dns_servers_file();
626
e698090e
SS
627 # Generate file to store the HTTP ports.
628 &IDS::generate_http_ports_file();
629
74cc8f5a 630 # Write the modify sid's file and pass the taken ruleaction.
81bae51f 631 &IDS::write_modify_sids_file();
bbb6efae 632
01d02eb6
SS
633 # Check if "MONITOR_TRAFFIC_ONLY" has been changed.
634 if($cgiparams{'MONITOR_TRAFFIC_ONLY'} ne $oldidssettings{'MONITOR_TRAFFIC_ONLY'}) {
bbb6efae 635 # Check if a ruleset exists.
2f252efa 636 if (%used_providers) {
bbb6efae 637 # Lock the webpage and print message.
5bd8940d 638 &working_notice("$Lang::tr{'ids working'}");
bbb6efae
SS
639
640 # Call oinkmaster to alter the ruleset.
641 &IDS::oinkmaster();
642
643 # Set reload_page to "True".
644 $reload_page="True";
645 }
646 }
647
e2e7880d
SS
648 # Check if the IDS currently is running.
649 if(&IDS::ids_is_running()) {
650 # Check if ENABLE_IDS is set to on.
651 if($cgiparams{'ENABLE_IDS'} eq "on") {
652 # Call suricatactrl to perform a reload of suricata.
653 &IDS::call_suricatactrl("reload");
654 } else {
655 # Call suricatactrl to stop suricata.
656 &IDS::call_suricatactrl("stop");
657 }
658 } else {
659 # Call suricatactrl to start suricata.
660 &IDS::call_suricatactrl("start");
661 }
bbb6efae
SS
662
663 # Check if the page should be reloaded.
664 if ($reload_page) {
665 # Perform a reload of the page.
666 &reload();
667 }
4c067847 668
9bf260de
SS
669# Toggle Enable/Disable autoupdate for a provider
670} elsif ($cgiparams{'AUTOUPDATE'} eq $Lang::tr{'toggle enable disable'}) {
671 my %used_providers = ();
672
673 # Only go further, if an ID has been passed.
674 if ($cgiparams{'ID'}) {
675 # Assign the given ID.
676 my $id = $cgiparams{'ID'};
677
678 # Undef the given ID.
679 undef($cgiparams{'ID'});
680
681 # Read-in providers settings file.
682 &General::readhasharray($IDS::providers_settings_file, \%used_providers);
683
684 # Grab the configured status of the corresponding entry.
685 my $status_autoupdate = $used_providers{$id}[2];
686
687 # Switch the status.
688 if ($status_autoupdate eq "disabled") {
689 $status_autoupdate = "enabled";
690 } else {
691 $status_autoupdate = "disabled";
692 }
693
694 # Modify the status of the existing entry.
695 $used_providers{$id} = ["$used_providers{$id}[0]", "$used_providers{$id}[1]", "$status_autoupdate", "$used_providers{$id}[3]"];
696
697 # Write the changed hash to the providers settings file.
698 &General::writehasharray($IDS::providers_settings_file, \%used_providers);
699 }
700
701# Add/Edit a provider to the list of used providers.
702#
4c067847 703} elsif (($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") || ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'update'}")) {
aba3cbe5
SS
704 my %used_providers = ();
705
706 # Read-in providers settings file.
707 &General::readhasharray("$IDS::providers_settings_file", \%used_providers);
708
4c067847
SS
709 # Assign some nice human-readable values.
710 my $provider = $cgiparams{'PROVIDER'};
711 my $subscription_code = $cgiparams{'SUBSCRIPTION_CODE'};
bb4c30c6
SS
712 my $status_autoupdate;
713
714 # Handle autoupdate checkbox.
715 if ($cgiparams{'ENABLE_AUTOUPDATE'} eq "on") {
716 $status_autoupdate = "enabled";
717 } else {
718 $status_autoupdate = "disabled";
719 }
4c067847
SS
720
721 # Check if we are going to add a new provider.
722 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'add'}") {
723 # Loop through the hash of used providers.
724 foreach my $id ( keys %used_providers) {
725 # Check if the choosen provider is already in use.
726 if ($used_providers{$id}[0] eq "$provider") {
727 # XXX - add to language file.
728 # Assign error message.
729 $errormessage = "The choosen provider is already in use.";
730 }
731 }
732 }
733
734 # Check if the provider requires a subscription code.
735 if ($IDS::Ruleset::Providers{$provider}{'requires_subscription'} eq "True") {
736 # Check if an subscription code has been provided.
737 if ($subscription_code) {
738 # Check if the code contains unallowed chars.
739 unless ($subscription_code =~ /^[a-z0-9]+$/) {
740 $errormessage = $Lang::tr{'invalid input for subscription code'};
741 }
742 } else {
743 # Print an error message, that an subsription code is required for this
744 # provider.
745 $errormessage = $Lang::tr{'ids subscription code required'};
746 }
747 }
748
749 # Go further if there was no error.
750 if ($errormessage eq '') {
751 my $id;
752 my $status;
753
754 # Check if we should edit an existing entry and got an ID.
755 if (($cgiparams{'PROVIDERS'} eq $Lang::tr{'update'}) && ($cgiparams{'ID'})) {
756 # Assin the provided id.
757 $id = $cgiparams{'ID'};
758
759 # Undef the given ID.
760 undef($cgiparams{'ID'});
761
762 # Grab the configured status of the corresponding entry.
763 $status = $used_providers{$id}[3];
764 } else {
765 # Each newly added entry automatically should be enabled.
766 $status = "enabled";
767
768 # Generate the ID for the new entry.
769 #
770 # Sort the keys by their ID and store them in an array.
771 my @keys = sort { $a <=> $b } keys %used_providers;
772
773 # Reverse the key array.
774 my @reversed = reverse(@keys);
775
776 # Obtain the last used id.
777 my $last_id = @reversed[0];
778
779 # Increase the last id by one and use it as id for the new entry.
780 $id = ++$last_id;
781 }
782
783 # Add/Modify the entry to/in the used providers hash..
784 $used_providers{$id} = ["$provider", "$subscription_code", "$status_autoupdate", "$status"];
785
786 # Write the changed hash to the providers settings file.
787 &General::writehasharray($IDS::providers_settings_file, \%used_providers);
788
789 # Undefine providers flag.
790 undef($cgiparams{'PROVIDERS'});
791 }
ac1cfefa
MT
792}
793
ac1cfefa
MT
794&Header::openpage($Lang::tr{'intrusion detection system'}, 1, '');
795
2bbe6ede 796&Header::openbigbox('100%', 'left', '', $errormessage);
e0cec9fe 797
2bbe6ede 798&show_display_error_message();
0d34a479 799
2bbe6ede
SS
800if ($cgiparams{'RULESET'} eq "$Lang::tr{'ids customize ruleset'}" ) {
801 &show_customize_ruleset();
2f252efa
SS
802} elsif ($cgiparams{'PROVIDERS'} ne "") {
803 &show_add_provider();
2bbe6ede
SS
804} else {
805 &show_mainpage();
806}
029b8ed2 807
2bbe6ede
SS
808&Header::closebigbox();
809&Header::closepage();
e0cec9fe 810
2bbe6ede
SS
811#
812## Tiny function to show if a error message happened.
813#
814sub show_display_error_message() {
815 if ($errormessage) {
816 &Header::openbox('100%', 'left', $Lang::tr{'error messages'});
817 print "<class name='base'>$errormessage\n";
818 print "&nbsp;</class>\n";
819 &Header::closebox();
820 }
821}
e0cec9fe 822
2bbe6ede
SS
823#
824## Function to display the main IDS page.
825#
826sub show_mainpage() {
aba3cbe5 827 # Read-in idssettings and provider settings.
2bbe6ede 828 &General::readhash("$IDS::ids_settings_file", \%idssettings);
aba3cbe5 829 &General::readhasharray("$IDS::providers_settings_file", \%used_providers);
2bbe6ede
SS
830
831 # If no autoupdate intervall has been configured yet, set default value.
77351a6b 832 unless(exists($idssettings{'AUTOUPDATE_INTERVAL'})) {
2bbe6ede 833 # Set default to "weekly".
77351a6b 834 $idssettings{'AUTOUPDATE_INTERVAL'} = 'weekly';
17726644 835 }
2bbe6ede
SS
836
837 # Read-in ignored hosts.
838 &General::readhasharray("$IDS::settingsdir/ignored", \%ignored);
839
840 $checked{'ENABLE_IDS'}{'off'} = '';
841 $checked{'ENABLE_IDS'}{'on'} = '';
842 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
843 $checked{'MONITOR_TRAFFIC_ONLY'}{'off'} = '';
844 $checked{'MONITOR_TRAFFIC_ONLY'}{'on'} = '';
845 $checked{'MONITOR_TRAFFIC_ONLY'}{$idssettings{'MONITOR_TRAFFIC_ONLY'}} = "checked='checked'";
2bbe6ede
SS
846 $selected{'AUTOUPDATE_INTERVAL'}{'off'} = '';
847 $selected{'AUTOUPDATE_INTERVAL'}{'daily'} = '';
848 $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} = '';
2f252efa 849 $selected{'AUTOUPDATE_INTERVAL'}{$idssettings{'AUTOUPDATE_INTERVAL'}} = "selected='selected'";
17726644 850
2bbe6ede
SS
851 # Draw current state of the IDS
852 &Header::openbox('100%', 'left', $Lang::tr{'intrusion detection system'});
1504a375 853
2bbe6ede
SS
854 # Check if the IDS is running and obtain the process-id.
855 my $pid = &IDS::ids_is_running();
87660964 856
2bbe6ede
SS
857 # Display some useful information, if suricata daemon is running.
858 if ($pid) {
859 # Gather used memory.
860 my $memory = &get_memory_usage($pid);
87660964 861
2bbe6ede
SS
862 print <<END;
863 <table width='95%' cellspacing='0' class='tbl'>
864 <tr>
865 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
866 </tr>
87660964 867
2bbe6ede
SS
868 <tr>
869 <td class='base'>$Lang::tr{'guardian daemon'}</td>
870 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
871 </tr>
87660964 872
2bbe6ede
SS
873 <tr>
874 <td class='base'></td>
875 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
876 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
877 </tr>
87660964 878
2bbe6ede
SS
879 <tr>
880 <td class='base'></td>
881 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
882 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
883 </tr>
884 </table>
87660964 885END
2bbe6ede
SS
886 } else {
887 # Otherwise display a hint that the service is not launched.
888 print <<END;
889 <table width='95%' cellspacing='0' class='tbl'>
890 <tr>
891 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
892 </tr>
87660964 893
2bbe6ede
SS
894 <tr>
895 <td class='base'>$Lang::tr{'guardian daemon'}</td>
896 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
897 </tr>
898 </table>
87660964 899END
2bbe6ede 900 }
87660964 901
2f252efa
SS
902 # Only show this area, if at least one ruleset provider is configured.
903 if (%used_providers) {
674912fc 904
2bbe6ede 905print <<END
674912fc 906
2bbe6ede 907 <br><br><h2>$Lang::tr{'settings'}</h2>
1286e0d4 908
2bbe6ede
SS
909 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
910 <table width='100%' border='0'>
911 <tr>
912 <td class='base' colspan='2'>
913 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}>&nbsp;$Lang::tr{'ids enable'}
914 </td>
cf02bf2f 915
2bbe6ede
SS
916 <td class='base' colspan='2'>
917 <input type='checkbox' name='MONITOR_TRAFFIC_ONLY' $checked{'MONITOR_TRAFFIC_ONLY'}{'on'}>&nbsp;$Lang::tr{'ids monitor traffic only'}
918 </td>
919 </tr>
1504a375 920
2bbe6ede
SS
921 <tr>
922 <td><br><br></td>
923 <td><br><br></td>
924 <td><br><br></td>
925 <td><br><br></td>
926 </tr>
a4ccfcbb 927
2bbe6ede
SS
928 <tr>
929 <td colspan='4'><b>$Lang::tr{'ids monitored interfaces'}</b><br></td>
930 </tr>
a4ccfcbb 931
2bbe6ede 932 <tr>
ac1cfefa
MT
933END
934;
1504a375 935
2bbe6ede
SS
936 # Loop through the array of available networks and print config options.
937 foreach my $zone (@network_zones) {
938 my $checked_input;
939 my $checked_forward;
1504a375 940
2bbe6ede
SS
941 # Convert current zone name to upper case.
942 my $zone_upper = uc($zone);
1504a375 943
2bbe6ede
SS
944 # Set zone name.
945 my $zone_name = $zone;
53817b89 946
2bbe6ede
SS
947 # Dirty hack to get the correct language string for the red zone.
948 if ($zone eq "red") {
949 $zone_name = "red1";
950 }
53817b89 951
2bbe6ede
SS
952 # Grab checkbox status from settings hash.
953 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
954 $checked_input = "checked = 'checked'";
955 }
1504a375 956
2bbe6ede
SS
957 print "<td class='base' width='20%'>\n";
958 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>\n";
959 print "&nbsp;$Lang::tr{'enabled on'}<font color='$colourhash{$zone}'> $Lang::tr{$zone_name}</font>\n";
960 print "</td>\n";
961 }
1b73b07e 962
ac1cfefa 963print <<END
2bbe6ede 964 </tr>
77351a6b
SS
965
966 <tr>
967 <td><br><br></td>
968 <td><br><br></td>
969 <td><br><br></td>
970 <td><br><br></td>
971 </tr>
972
973 <tr>
974 <td colspan='4'><b>$Lang::tr{'ids automatic rules update'}</b></td>
975 </tr>
976
977 <tr>
978 <td>
979 <select name='AUTOUPDATE_INTERVAL'>
980 <option value='off' $selected{'AUTOUPDATE_INTERVAL'}{'off'} >- $Lang::tr{'Disabled'} -</option>
981 <option value='daily' $selected{'AUTOUPDATE_INTERVAL'}{'daily'} >$Lang::tr{'Daily'}</option>
982 <option value='weekly' $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} >$Lang::tr{'Weekly'}</option>
983 </select>
984 </td>
985 </tr>
2bbe6ede 986 </table>
1504a375 987
2bbe6ede 988 <br><br>
ea5c8eeb 989
2bbe6ede
SS
990 <table width='100%'>
991 <tr>
992 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
993 </tr>
994 </table>
995 </form>
ea5c8eeb
SS
996END
997;
998
2bbe6ede 999 }
cf02bf2f 1000
2bbe6ede 1001 &Header::closebox();
ea5c8eeb 1002
2f252efa
SS
1003 #
1004 # Used Ruleset Providers section.
1005 #
2bbe6ede 1006 &Header::openbox('100%', 'center', $Lang::tr{'ids ruleset settings'});
ea5c8eeb 1007
2f252efa
SS
1008print <<END;
1009 <table width='100%' border='0'>
1010 <tr>
1011 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ids provider'}</b></td>
1012 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'date'}</b></td>
1013 <td class='base' bgcolor='$color{'color20'}' align='center'><b>$Lang::tr{'ids autoupdates'}</b></td>
1014 <td class='base' bgcolor='$color{'color20'}'></td>
1015 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1016 </tr>
3e12c6e6 1017END
2f252efa
SS
1018 # Check if some providers has been configured.
1019 if (keys (%used_providers)) {
1020 my $col = "";
3e12c6e6 1021
2f252efa 1022 # Loop through all entries of the hash.
2f252efa
SS
1023 foreach my $id (sort keys(%used_providers)) {
1024 # Assign data array positions to some nice variable names.
1025 my $provider = $used_providers{$id}[0];
1026 my $provider_name = &get_provider_name($provider);
3e12c6e6 1027
2f252efa
SS
1028 #XXX my $rulesdate = &IDS::get_ruleset_date($provider);
1029 my $rulesdate;
1030
1031 my $subscription_code = $used_providers{$id}[1];
1032 my $autoupdate_status = $used_providers{$id}[2];
1033 my $status = $used_providers{$id}[3];
1034
1035 # Check if the item number is even or not.
1036 if ($id % 2) {
1037 $col="bgcolor='$color{'color22'}'";
1038 } else {
1039 $col="bgcolor='$color{'color20'}'";
2bbe6ede 1040 }
1504a375 1041
2f252efa
SS
1042 # Choose icons for the checkboxes.
1043 my $status_gif;
1044 my $status_gdesc;
1045 my $autoupdate_status_gif;
1046 my $autoupdate_status_gdesc;
1504a375 1047
2f252efa
SS
1048 # Check if the status is enabled and select the correct image and description.
1049 if ($status eq 'enabled' ) {
1050 $status_gif = 'on.gif';
1051 $status_gdesc = $Lang::tr{'click to disable'};
1052 } else {
1053 $status_gif = 'off.gif';
1054 $status_gdesc = $Lang::tr{'click to enable'};
1055 }
1504a375 1056
2f252efa
SS
1057 # Check if the autoupdate status is enabled and select the correct image and description.
1058 if ($autoupdate_status eq 'enabled') {
1059 $autoupdate_status_gif = 'on.gif';
1060 $autoupdate_status_gdesc = $Lang::tr{'click to disable'};
1061 } else {
1062 $autoupdate_status_gif = 'off.gif';
1063 $autoupdate_status_gdesc = $Lang::tr{'click to enable'};
1064 }
2bbe6ede 1065
2f252efa
SS
1066print <<END;
1067 <tr>
1068 <td width='33%' class='base' $col>$provider_name</td>
1069 <td width='30%' class='base' $col>$rulesdate</td>
1070
1071 <td align='center' $col>
1072 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1073 <input type='hidden' name='AUTOUPDATE' value='$Lang::tr{'toggle enable disable'}' />
1074 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$autoupdate_status_gif' alt='$autoupdate_status_gdesc' title='$autoupdate_status_gdesc' />
1075 <input type='hidden' name='ID' value='$id' />
1076 </form>
1077 </td>
1078
1079 <td align='center' $col>
7323c72d 1080 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
2f252efa
SS
1081 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'toggle enable disable'}'>
1082 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$status_gif' alt='$status_gdesc' title='$status_gdesc'>
1083 <input type='hidden' name='ID' value='$id'>
1084 </form>
1085 </td>
1086
1087 <td align='center' $col>
1088 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1089 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'edit'}'>
1090 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1091 <input type='hidden' name='ID' value='$id'>
1092 </form>
1093 </td>
1504a375 1094
2f252efa
SS
1095 <td align='center' $col>
1096 <form method='post' name='$provider' action='$ENV{'SCRIPT_NAME'}'>
1097 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1098 <input type='hidden' name='ID' value='$id'>
1099 <input type='hidden' name='PROVIDERS' value='$Lang::tr{'remove'}'>
1100 </form>
1101 </td>
1102 </tr>
ea5c8eeb 1103END
2bbe6ede 1104 }
2f252efa
SS
1105
1106 } else {
1107 # Print notice that currently no hosts are ignored.
1108 print "<tr>\n";
1109 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1110 print "</tr>\n";
1111 }
1112
1113 print "</table>\n";
1114
1115 # Section to add new elements or edit existing ones.
ea5c8eeb 1116print <<END;
2f252efa
SS
1117 <br>
1118 <hr>
1119 <br>
1504a375 1120
2f252efa
SS
1121 <div align='right'>
1122 <table width='100%'>
1123 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1124 <tr>
1125END
1126
1127 # Only show this button if a ruleset provider is configured.
1128 if (%used_providers) {
1129 print "<input type='submit' name='RULESET' value='$Lang::tr{'ids customize ruleset'}'>\n";
1130 }
1131print <<END;
1132 <input type='submit' name='PROVIDERS' value='$Lang::tr{'ids add provider'}'>
1133 </tr>
1134 </form>
2bbe6ede 1135 </table>
2f252efa 1136 </div>
ac1cfefa 1137END
ac1cfefa 1138
2bbe6ede 1139 &Header::closebox();
fbfdb241 1140
2bbe6ede
SS
1141 #
1142 # Whitelist / Ignorelist
1143 #
1144 &Header::openbox('100%', 'center', $Lang::tr{'ids ignored hosts'});
b7e29743 1145
2bbe6ede 1146 print <<END;
b7e29743
SS
1147 <table width='100%'>
1148 <tr>
1149 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
1150 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
1151 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
1152 </tr>
1153END
1154 # Check if some hosts have been added to be ignored.
1155 if (keys (%ignored)) {
1156 my $col = "";
1157
1158 # Loop through all entries of the hash.
1159 while( (my $key) = each %ignored) {
1160 # Assign data array positions to some nice variable names.
1161 my $address = $ignored{$key}[0];
1162 my $remark = $ignored{$key}[1];
1163 my $status = $ignored{$key}[2];
1164
1165 # Check if the key (id) number is even or not.
1166 if ($cgiparams{'ID'} eq $key) {
1167 $col="bgcolor='${Header::colouryellow}'";
1168 } elsif ($key % 2) {
1169 $col="bgcolor='$color{'color22'}'";
1170 } else {
1171 $col="bgcolor='$color{'color20'}'";
1172 }
1173
1174 # Choose icon for the checkbox.
1175 my $gif;
1176 my $gdesc;
1177
1178 # Check if the status is enabled and select the correct image and description.
1179 if ($status eq 'enabled' ) {
1180 $gif = 'on.gif';
1181 $gdesc = $Lang::tr{'click to disable'};
1182 } else {
1183 $gif = 'off.gif';
1184 $gdesc = $Lang::tr{'click to enable'};
1185 }
1186
1187print <<END;
1188 <tr>
1189 <td width='20%' class='base' $col>$address</td>
1190 <td width='65%' class='base' $col>$remark</td>
1191
1192 <td align='center' $col>
1193 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
2f252efa
SS
1194 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}'>
1195 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc'>
1196 <input type='hidden' name='ID' value='$key'>
b7e29743
SS
1197 </form>
1198 </td>
1199
1200 <td align='center' $col>
1201 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
2f252efa
SS
1202 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}'>
1203 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}'>
1204 <input type='hidden' name='ID' value='$key'>
b7e29743
SS
1205 </form>
1206 </td>
1207
1208 <td align='center' $col>
1209 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
1210 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
1211 <input type='hidden' name='ID' value='$key'>
1212 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
1213 </form>
2bbe6ede
SS
1214 </td>
1215 </tr>
b7e29743 1216END
2bbe6ede
SS
1217 }
1218 } else {
1219 # Print notice that currently no hosts are ignored.
1220 print "<tr>\n";
1221 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
1222 print "</tr>\n";
b7e29743 1223 }
b7e29743 1224
2bbe6ede 1225 print "</table>\n";
b7e29743 1226
2bbe6ede 1227 # Section to add new elements or edit existing ones.
b7e29743 1228print <<END;
2bbe6ede
SS
1229 <br>
1230 <hr>
1231 <br>
1232
1233 <div align='center'>
1234 <table width='100%'>
b7e29743
SS
1235END
1236
2bbe6ede
SS
1237 # Assign correct headline and button text.
1238 my $buttontext;
1239 my $entry_address;
1240 my $entry_remark;
b7e29743 1241
2bbe6ede
SS
1242 # Check if an ID (key) has been given, in this case an existing entry should be edited.
1243 if ($cgiparams{'ID'} ne '') {
1244 $buttontext = $Lang::tr{'update'};
1245 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
b7e29743 1246
2bbe6ede
SS
1247 # Grab address and remark for the given key.
1248 $entry_address = $ignored{$cgiparams{'ID'}}[0];
1249 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
1250 } else {
1251 $buttontext = $Lang::tr{'add'};
1252 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
1253 }
b7e29743
SS
1254
1255print <<END;
2bbe6ede
SS
1256 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1257 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1258 <tr>
1259 <td width='30%'>$Lang::tr{'ip address'}: </td>
1260 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
b7e29743 1261
2bbe6ede
SS
1262 <td width='30%'>$Lang::tr{'remark'}: </td>
1263 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
1264 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
1265 </tr>
1266 </form>
1267 </table>
1268 </div>
b7e29743
SS
1269END
1270
2bbe6ede 1271 &Header::closebox();
fed57fe7
SS
1272}
1273
fed57fe7
SS
1274#
1275## Function to show the customize ruleset section.
1276#
1277sub show_customize_ruleset() {
2bbe6ede
SS
1278 ### Java Script ###
1279 print"<script>\n";
1280
1281 # Java script variable declaration for show and hide.
1282 print"var show = \"$Lang::tr{'ids show'}\"\;\n";
1283 print"var hide = \"$Lang::tr{'ids hide'}\"\;\n";
1284
1285print <<END
1286 // Tiny java script function to show/hide the rules
1287 // of a given category.
1288 function showhide(tblname) {
1289 \$("#" + tblname).toggle();
1290
1291 // Get current content of the span element.
1292 var content = document.getElementById("span_" + tblname);
1293
1294 if (content.innerHTML === show) {
1295 content.innerHTML = hide;
1296 } else {
1297 content.innerHTML = show;
1298 }
1299 }
1300 </script>
1301END
1302;
87df37da 1303 &Header::openbox('100%', 'LEFT', "$Lang::tr{'intrusion detection system rules'}" );
80bcd4dd 1304 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
ce0e83b3 1305
80bcd4dd
SS
1306 # Output display table for rule files
1307 print "<table width='100%'>\n";
f7fcd1c0 1308
80bcd4dd
SS
1309 # Loop over each rule file
1310 foreach my $rulefile (sort keys(%idsrules)) {
1311 my $rulechecked = '';
3ffee04b 1312
80bcd4dd
SS
1313 # Check if rule file is enabled
1314 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
1315 $rulechecked = 'CHECKED';
1316 }
1317
0a1bba1a
SS
1318 # Convert rulefile name into category name.
1319 my $categoryname = &_rulefile_to_category($rulefile);
1320
80bcd4dd
SS
1321 # Table and rows for the rule files.
1322 print"<tr>\n";
1323 print"<td class='base' width='5%'>\n";
1324 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
1325 print"</td>\n";
1326 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
1327 print"<td class='base' width='5%' align='right'>\n";
e0cec9fe 1328 print"<a href=\"javascript:showhide('$categoryname')\"><span id='span_$categoryname'>$Lang::tr{'ids show'}</span></a>\n";
80bcd4dd
SS
1329 print"</td>\n";
1330 print"</tr>\n";
1331
1332 # Rows which will be hidden per default and will contain the single rules.
0a1bba1a 1333 print"<tr style='display:none' id='$categoryname'>\n";
80bcd4dd 1334 print"<td colspan='3'>\n";
17726644 1335
f7fcd1c0 1336 # Local vars
80bcd4dd
SS
1337 my $lines;
1338 my $rows;
1339 my $col;
f9c2147d 1340
80bcd4dd
SS
1341 # New table for the single rules.
1342 print "<table width='100%'>\n";
e5738079 1343
80bcd4dd
SS
1344 # Loop over rule file rules
1345 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
1346 # Local vars
1347 my $ruledefchecked = '';
3ffee04b 1348
80bcd4dd
SS
1349 # Skip rulefile itself.
1350 next if ($sid eq "Rulefile");
f7fcd1c0 1351
80bcd4dd
SS
1352 # If 2 rules have been displayed, start a new row
1353 if (($lines % 2) == 0) {
1354 print "</tr><tr>\n";
1355
1356 # Increase rows by once.
1357 $rows++;
1358 }
1359
1360 # Colour lines.
1361 if ($rows % 2) {
1362 $col="bgcolor='$color{'color20'}'";
1363 } else {
1364 $col="bgcolor='$color{'color22'}'";
1365 }
f7fcd1c0 1366
80bcd4dd
SS
1367 # Set rule state
1368 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
1369 $ruledefchecked = 'CHECKED';
1370 }
1371
1372 # Create rule checkbox and display rule description
1373 print "<td class='base' width='5%' align='right' $col>\n";
1374 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
1375 print "</td>\n";
1376 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1377
1378 # Increment rule count
1379 $lines++;
f7fcd1c0 1380 }
3ffee04b 1381
80bcd4dd
SS
1382 # If do not have a second rule for row, create empty cell
1383 if (($lines % 2) != 0) {
1384 print "<td class='base'></td>";
1385 }
17726644 1386
80bcd4dd
SS
1387 # Close display table
1388 print "</tr></table></td></tr>";
f7fcd1c0
SS
1389 }
1390
1391 # Close display table
80bcd4dd 1392 print "</table>";
17726644 1393
9268cddf 1394 print <<END
2999f1d2
CS
1395<table width='100%'>
1396<tr>
4efc8ccd
SS
1397 <td width='100%' align='right'>
1398 <input type='submit' value='$Lang::tr{'fwhost back'}'>
1399 <input type='submit' name='RULESET' value='$Lang::tr{'ids apply'}'>
1400 </td>
2999f1d2
CS
1401</tr>
1402</table>
298723b9 1403</form>
3ffee04b
CS
1404END
1405;
9268cddf
MT
1406 &Header::closebox();
1407 }
80bcd4dd
SS
1408}
1409
2f252efa
SS
1410#
1411## Function to show section for add/edit a provider.
1412#
1413sub show_add_provider() {
aba3cbe5 1414 my %used_providers = ();
2f252efa
SS
1415 my @subscription_providers;
1416
aba3cbe5
SS
1417 # Read -in providers settings file.
1418 &General::readhasharray("$IDS::providers_settings_file", \%used_providers);
1419
2f252efa
SS
1420 # Get all supported ruleset providers.
1421 my @ruleset_providers = &IDS::get_ruleset_providers();
1422
1423 ### Java Script ###
1424 print "<script>\n";
1425
1426 # Generate Java Script Object which contains the URL of the providers.
1427 print "\t// Object, which contains the webpages of the ruleset providers.\n";
1428 print "\tvar url = {\n";
1429
1430 # Loop through the array of supported providers.
1431 foreach my $provider (@ruleset_providers) {
1432 # Check if the provider requires a subscription.
1433 if ($IDS::Ruleset::Providers{$provider}{'requires_subscription'} eq "True") {
1434 # Add the provider to the array of subscription_providers.
1435 push(@subscription_providers, $provider);
1436 }
1437
1438 # Grab the URL for the provider.
1439 my $url = $IDS::Ruleset::Providers{$provider}{'website'};
1440
1441 # Print the URL to the Java Script Object.
1442 print "\t\t$provider: \"$url\"\,\n";
1443 }
1444
1445 # Close the Java Script Object declaration.
1446 print "\t}\;\n\n";
1447
1448 # Generate Java Script Array which contains the provider that requires a subscription.
1449 my $line = "";
1450 $line = join("', '", @subscription_providers);
1451
1452 print "\t// Array which contains the providers that requires a subscription.\n";
1453 print "\tsubscription_provider = ['$line']\;\n\n";
1454
1455print <<END
1456 // Java Script function to swap the text input field for
1457 // entering a subscription code.
1458 var update_provider = function() {
1459 if(inArray(\$('#PROVIDER').val(), subscription_provider)) {
1460 \$('.subscription_code').show();
1461 } else {
1462 \$('.subscription_code').hide();
1463 }
1464
1465 // Call function to change the website url.
1466 change_url(\$('#PROVIDER').val());
1467 };
1468
1469 // Java Script function to check if a given value is part of
1470 // an array.
1471 function inArray(value,array) {
1472 var count=array.length;
1473
1474 for(var i=0;i<count;i++) {
1475 if(array[i]===value){
1476 return true;
1477 }
1478 }
1479
1480 return false;
1481 }
1482
1483 // Tiny function to change the website url based on the selected element in the "PROVIDERS"
1484 // dropdown menu.
1485 function change_url(provider) {
1486 // Get and change the href to the corresponding url.
1487 document.getElementById("website").href = url[provider];
1488 }
1489
1490 // JQuery function to call corresponding function when
1491 // the ruleset provider is changed or the page is loaded for showing/hiding
1492 // the subscription_code area.
1493 \$(document).ready(function() {
1494 \$('#PROVIDER').change(update_provider);
1495 update_provider();
1496 });
1497
1498 </script>
1499END
1500;
1501
1502 &Header::openbox('100%', 'center', $Lang::tr{'ids provider settings'});
1503
1504 # Check if an existing provider should be edited.
1505 if($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1506 # Check if autoupdate is enabled for this provider.
bb4c30c6 1507 if ($used_providers{$cgiparams{'ID'}}[2] eq "enabled") {
2f252efa
SS
1508 # Set the checkbox to be checked.
1509 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1510 }
1511 } elsif ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'ids add provider'}") {
1512 # Set the autoupdate to true as default.
1513 $checked{'ENABLE_AUTOUPDATE'} = "checked='checked'";
1514 }
1515
1516print <<END
1517 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
1518 <table width='100%' border='0'>
1519 <tr>
1520 <td colspan='2'><b>$Lang::tr{'ids provider'}</b></td>
1521 </tr>
1522
1523 <tr>
1524 <td width='40%'>
1525 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
1526 <select name='PROVIDER' id='PROVIDER'>
1527END
1528;
1529 # Loop through the array of ruleset providers.
1530 foreach my $provider (@ruleset_providers) {
1531 # Get the provider name.
1532 my $provider_name = &get_provider_name($provider);
1533
1534 # Pre-select the provider if one is given.
1535 if (($used_providers{$cgiparams{'ID'}}[0] eq "$provider") || ($cgiparams{'PROVIDER'} eq "$provider")) {
1536 $selected{$provider} = "selected='selected'";
1537 }
1538
1539 # Add the provider to the dropdown menu.
1540 print "<option value='$provider' $selected{$provider}>$provider_name</option>\n";
1541 }
1542print <<END
1543 </select>
1544 </td>
1545
1546 <td width='60%'>
1547 <b><a id="website" target="_blank" href="#">$Lang::tr{'ids visit provider website'}</a></b>
1548 </td>
1549 </tr>
1550
1551 <tr>
1552 <td colspan='2'><br><br></td>
1553 </tr>
1554
1555 <tr class='subscription_code' style='display:none' id='subscription_code'>
1556 <td colspan='2'>
1557 <table border='0'>
1558 <tr>
1559 <td>
1560 <b>$Lang::tr{'subscription code'}</b>
1561 </td>
1562 </tr>
1563
1564 <tr>
1565 <td>
1566 <input type='text' size='40' name='SUBSCRIPTION_CODE' value='$used_providers{$cgiparams{'ID'}}[1]'>
1567 </td>
1568 </tr>
1569
1570 <tr>
1571 <td><br><br></td>
1572 </tr>
1573 </table>
1574 </td>
1575 </tr>
1576
1577 <tr>
1578 <td colspan='2'>
1579 <input type='checkbox' name='ENABLE_AUTOUPDATE' $checked{'ENABLE_AUTOUPDATE'}>&nbsp;$Lang::tr{'ids enable automatic updates'}
1580 </td>
1581 </tr>
1582
1583 <tr>
1584 <td colspan='2' align='right'>
1585 <input type='submit' value='$Lang::tr{'back'}'>
1586END
1587;
1588 # Check if a provider should be added or edited.
1589 if ($cgiparams{'PROVIDERS'} eq "$Lang::tr{'edit'}") {
1590 # Display button for updating the existing provider.
1591 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'update'}'>\n";
1592 } else {
1593 # Display button to add the new provider.
1594 print "<input type='submit' name='PROVIDERS' value='$Lang::tr{'add'}'>\n";
1595 }
1596print <<END
1597 </td>
1598 </tr>
1599 </table>
1600 </form>
1601END
1602;
1603 &Header::closebox();
1604}
1605
27760092
SS
1606#
1607## A function to display a notice, to lock the webpage and
1608## tell the user which action currently will be performed.
1609#
1610sub working_notice ($) {
1611 my ($message) = @_;
1612
1613 &Header::openpage($Lang::tr{'intrusion detection system'}, 1, '');
1614 &Header::openbigbox('100%', 'left', '', $errormessage);
1615 &Header::openbox( 'Waiting', 1,);
1616 print <<END;
1617 <table>
1618 <tr>
1619 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
1620 <td>$message</td>
1621 </tr>
1622 </table>
1623END
1624 &Header::closebox();
1625 &Header::closebigbox();
1626 &Header::closepage();
1627}
1628
3983aebd
SS
1629#
1630## A tiny function to perform a reload of the webpage after one second.
1631#
1632sub reload () {
1633 print "<meta http-equiv='refresh' content='1'>\n";
1634
1635 # Stop the script.
1636 exit;
a70d269a
SS
1637}
1638
25f5cb0d
SS
1639#
1640## Private function to read-in and parse rules of a given rulefile.
1641#
1642## The given file will be read, parsed and all valid rules will be stored by ID,
9d18656b 1643## message/description and it's state in the idsrules hash.
25f5cb0d 1644#
3da6e01b
SS
1645sub readrulesfile ($) {
1646 my $rulefile = shift;
1647
1648 # Open rule file and read in contents
298ef5ba 1649 open(RULEFILE, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
3da6e01b
SS
1650
1651 # Store file content in an array.
1652 my @lines = <RULEFILE>;
1653
1654 # Close file.
1655 close(RULEFILE);
1656
1657 # Loop over rule file contents
1658 foreach my $line (@lines) {
1659 # Remove whitespaces.
1660 chomp $line;
1661
1662 # Skip blank lines.
1663 next if ($line =~ /^\s*$/);
1664
1665 # Local vars.
1666 my $sid;
1667 my $msg;
1668
1669 # Gather rule sid and message from the ruleline.
1670 if ($line =~ m/.*msg:\"(.*?)\"\; .* sid:(.*?); /) {
1671 $msg = $1;
1672 $sid = $2;
1673
1674 # Check if a rule has been found.
1675 if ($sid && $msg) {
9d18656b
SS
1676 # Add rule to the idsrules hash.
1677 $idsrules{$rulefile}{$sid}{'Description'} = $msg;
3da6e01b
SS
1678
1679 # Grab status of the rule. Check if ruleline starts with a "dash".
1680 if ($line =~ /^\#/) {
1681 # If yes, the rule is disabled.
9d18656b 1682 $idsrules{$rulefile}{$sid}{'State'} = "off";
3da6e01b
SS
1683 } else {
1684 # Otherwise the rule is enabled.
9d18656b 1685 $idsrules{$rulefile}{$sid}{'State'} = "on";
3da6e01b
SS
1686 }
1687 }
1688 }
b7e29743 1689 }
3da6e01b 1690}
87660964 1691
8d2f6b0b
SS
1692#
1693## Function to get the used memory of a given process-id.
1694#
87660964 1695sub get_memory_usage($) {
004b13b7 1696 my ($pid) = @_;
87660964 1697
004b13b7 1698 my $memory = 0;
87660964 1699
004b13b7 1700 # Try to open the status file for the given process-id on the pseudo
87660964 1701 # file system proc.
004b13b7
SS
1702 if (open(FILE, "/proc/$pid/status")) {
1703 # Loop through the entire file.
1704 while (<FILE>) {
1705 # Splitt current line content and store them into variables.
1706 my ($key, $value) = split(":", $_, 2);
1707
1708 # Check if the current key is the one which contains the memory usage.
1709 # The wanted one is VmRSS which contains the Real-memory (resident set)
1710 # of the entire process.
1711 if ($key eq "VmRSS") {
1712 # Found the memory usage add it to the memory variable.
1713 $memory += $value;
1714
1715 # Break the loop.
1716 last;
1717 }
1718 }
87660964
SS
1719
1720 # Close file handle.
004b13b7 1721 close(FILE);
87660964
SS
1722
1723 # Return memory usage.
1724 return $memory;
004b13b7 1725 }
87660964
SS
1726
1727 # If the file could not be open, return nothing.
1728 return;
1729}
1730
a5d61752
SS
1731#
1732## Function to read-in the given enabled or disables sids file.
1733#
1734sub read_enabled_disabled_sids_file($) {
1735 my ($file) = @_;
1736
1737 # Temporary hash to store the sids and their state. It will be
1738 # returned at the end of this function.
1739 my %temphash;
1740
1741 # Open the given filename.
1742 open(FILE, "$file") or die "Could not open $file. $!\n";
1743
1744 # Loop through the file.
1745 while(<FILE>) {
1746 # Remove newlines.
1747 chomp $_;
1748
1749 # Skip blank lines.
1750 next if ($_ =~ /^\s*$/);
1751
1752 # Skip coments.
1753 next if ($_ =~ /^\#/);
1754
1755 # Splitt line into sid and state part.
1756 my ($state, $sid) = split(" ", $_);
1757
1758 # Skip line if the sid is not numeric.
1759 next unless ($sid =~ /\d+/ );
1760
1761 # Check if the sid was enabled.
1762 if ($state eq "enablesid") {
1763 # Add the sid and its state as enabled to the temporary hash.
1764 $temphash{$sid} = "enabled";
1765 # Check if the sid was disabled.
1766 } elsif ($state eq "disablesid") {
1767 # Add the sid and its state as disabled to the temporary hash.
1768 $temphash{$sid} = "disabled";
1769 # Invalid state - skip the current sid and state.
1770 } else {
1771 next;
1772 }
1773 }
1774
1775 # Close filehandle.
1776 close(FILE);
1777
1778 # Return the hash.
1779 return %temphash;
1780}
0a1bba1a 1781
019e5e9b
SS
1782#
1783## Function to get the provider name from the language file or providers file for a given handle.
1784#
1785sub get_provider_name($) {
1786 my ($handle) = @_;
1787 my $provider_name;
1788
1789 # Get the required translation string for the given provider handle.
1790 my $tr_string = $IDS::Ruleset::Providers{$handle}{'tr_string'};
1791
1792 # Check if the translation string is available in the language files.
1793 if ($Lang::tr{$tr_string}) {
1794 # Use the translated string from the language file.
1795 $provider_name = $Lang::tr{$tr_string};
1796 } else {
1797 # Fallback and use the provider summary from the providers file.
1798 $provider_name = $IDS::Ruleset::Providers{$handle}{'summary'};
1799 }
1800
1801 # Return the obtained provider name.
1802 return $provider_name;
1803}
1804
0a1bba1a
SS
1805#
1806## Private function to convert a given rulefile to a category name.
1807## ( No file extension anymore and if the name contained a dot, it
1808## would be replaced by a underline sign.)
1809#
1810sub _rulefile_to_category($) {
1811 my ($filename) = @_;
1812
1813 # Splitt the filename into single chunks and store them in a
1814 # temorary array.
1815 my @parts = split(/\./, $filename);
1816
1817 # Return / Remove last element of the temporary array.
1818 # This removes the file extension.
1819 pop @parts;
1820
1821 # Join together the single elements of the temporary array.
1822 # If these are more than one, use a "underline" for joining.
1823 my $category = join '_', @parts;
1824
1825 # Return the converted filename.
1826 return $category;
1827}