]> git.ipfire.org Git - ipfire-2.x.git/blob - html/cgi-bin/ids.cgi
Merge branch 'next' of ssh://git.ipfire.org/pub/git/ipfire-2.x into next-suricata
[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-2018 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
24 # enable only the following on debugging purpose
25 #use warnings;
26 #use CGI::Carp 'fatalsToBrowser';
27
28 require '/var/ipfire/general-functions.pl';
29 require "${General::swroot}/lang.pl";
30 require "${General::swroot}/header.pl";
31 require "${General::swroot}/ids-functions.pl";
32
33 my %color = ();
34 my %mainsettings = ();
35 my %idsrules = ();
36 my %idssettings=();
37 my %rulessettings=();
38 my %rulesetsources = ();
39 my %cgiparams=();
40 my %checked=();
41 my %selected=();
42 my %ignored=();
43
44 # Read-in main settings, for language, theme and colors.
45 &General::readhash("${General::swroot}/main/settings", \%mainsettings);
46 &General::readhash("/srv/web/ipfire/html/themes/".$mainsettings{'THEME'}."/include/colors.txt", \%color);
47
48 # Get the available network zones, based on the config type of the system and store
49 # the list of zones in an array.
50 my @network_zones = &IDS::get_available_network_zones();
51
52 my $errormessage;
53
54 # Create files if they does not exist yet.
55 &IDS::check_and_create_filelayout();
56
57 # Hash which contains the colour code of a network zone.
58 my %colourhash = (
59 'red' => $Header::colourred,
60 'green' => $Header::colourgreen,
61 'blue' => $Header::colourblue,
62 'orange' => $Header::colourorange
63 );
64
65 &Header::showhttpheaders();
66
67 #Get GUI values
68 &Header::getcgihash(\%cgiparams);
69
70 ## Add/edit an entry to the ignore file.
71 #
72 if (($cgiparams{'WHITELIST'} eq $Lang::tr{'add'}) || ($cgiparams{'WHITELIST'} eq $Lang::tr{'update'})) {
73
74 # Check if any input has been performed.
75 if ($cgiparams{'IGNORE_ENTRY_ADDRESS'} ne '') {
76
77 # Check if the given input is no valid IP-address or IP-address with subnet, display an error message.
78 if ((!&General::validip($cgiparams{'IGNORE_ENTRY_ADDRESS'})) && (!&General::validipandmask($cgiparams{'IGNORE_ENTRY_ADDRESS'}))) {
79 $errormessage = "$Lang::tr{'guardian invalid address or subnet'}";
80 }
81 } else {
82 $errormessage = "$Lang::tr{'guardian empty input'}";
83 }
84
85 # Go further if there was no error.
86 if ($errormessage eq '') {
87 my %ignored = ();
88 my $id;
89 my $status;
90
91 # Assign hash values.
92 my $new_entry_address = $cgiparams{'IGNORE_ENTRY_ADDRESS'};
93 my $new_entry_remark = $cgiparams{'IGNORE_ENTRY_REMARK'};
94
95 # Read-in ignoredfile.
96 &General::readhasharray($IDS::ignored_file, \%ignored);
97
98 # Check if we should edit an existing entry and got an ID.
99 if (($cgiparams{'WHITELIST'} eq $Lang::tr{'update'}) && ($cgiparams{'ID'})) {
100 # Assin the provided id.
101 $id = $cgiparams{'ID'};
102
103 # Undef the given ID.
104 undef($cgiparams{'ID'});
105
106 # Grab the configured status of the corresponding entry.
107 $status = $ignored{$id}[2];
108 } else {
109 # Each newly added entry automatically should be enabled.
110 $status = "enabled";
111
112 # Generate the ID for the new entry.
113 #
114 # Sort the keys by their ID and store them in an array.
115 my @keys = sort { $a <=> $b } keys %ignored;
116
117 # Reverse the key array.
118 my @reversed = reverse(@keys);
119
120 # Obtain the last used id.
121 my $last_id = @reversed[0];
122
123 # Increase the last id by one and use it as id for the new entry.
124 $id = ++$last_id;
125 }
126
127 # Add/Modify the entry to/in the ignored hash.
128 $ignored{$id} = ["$new_entry_address", "$new_entry_remark", "$status"];
129
130 # Write the changed ignored hash to the ignored file.
131 &General::writehasharray($IDS::ignored_file, \%ignored);
132
133 # Regenerate the ignore file.
134 &GenerateIgnoreFile();
135 }
136
137 # Check if the IDS is running.
138 if(&IDS::ids_is_running()) {
139 # Call suricatactrl to perform a reload.
140 &IDS::call_suricatactrl("reload");
141 }
142
143 ## Toggle Enabled/Disabled for an existing entry on the ignore list.
144 #
145
146 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr{'toggle enable disable'}) {
147 my %ignored = ();
148
149 # Only go further, if an ID has been passed.
150 if ($cgiparams{'ID'}) {
151 # Assign the given ID.
152 my $id = $cgiparams{'ID'};
153
154 # Undef the given ID.
155 undef($cgiparams{'ID'});
156
157 # Read-in ignoredfile.
158 &General::readhasharray($IDS::ignored_file, \%ignored);
159
160 # Grab the configured status of the corresponding entry.
161 my $status = $ignored{$id}[2];
162
163 # Switch the status.
164 if ($status eq "disabled") {
165 $status = "enabled";
166 } else {
167 $status = "disabled";
168 }
169
170 # Modify the status of the existing entry.
171 $ignored{$id} = ["$ignored{$id}[0]", "$ignored{$id}[1]", "$status"];
172
173 # Write the changed ignored hash to the ignored file.
174 &General::writehasharray($IDS::ignored_file, \%ignored);
175
176 # Regenerate the ignore file.
177 &GenerateIgnoreFile();
178
179 # Check if the IDS is running.
180 if(&IDS::ids_is_running()) {
181 # Call suricatactrl to perform a reload.
182 &IDS::call_suricatactrl("reload");
183 }
184 }
185
186 ## Remove entry from ignore list.
187 #
188 } elsif ($cgiparams{'WHITELIST'} eq $Lang::tr{'remove'}) {
189 my %ignored = ();
190
191 # Read-in ignoredfile.
192 &General::readhasharray($IDS::ignored_file, \%ignored);
193
194 # Drop entry from the hash.
195 delete($ignored{$cgiparams{'ID'}});
196
197 # Undef the given ID.
198 undef($cgiparams{'ID'});
199
200 # Write the changed ignored hash to the ignored file.
201 &General::writehasharray($IDS::ignored_file, \%ignored);
202
203 # Regenerate the ignore file.
204 &GenerateIgnoreFile();
205
206 # Check if the IDS is running.
207 if(&IDS::ids_is_running()) {
208 # Call suricatactrl to perform a reload.
209 &IDS::call_suricatactrl("reload");
210 }
211 }
212
213 # Check if any error has been stored.
214 if (-e $IDS::storederrorfile) {
215 # Open file to read in the stored error message.
216 open(FILE, "<$IDS::storederrorfile") or die "Could not open $IDS::storederrorfile. $!\n";
217
218 # Read the stored error message.
219 $errormessage = <FILE>;
220
221 # Close file.
222 close (FILE);
223
224 # Delete the file, which is now not longer required.
225 unlink($IDS::storederrorfile);
226 }
227
228 ## Grab all available snort rules and store them in the idsrules hash.
229 #
230 # Open snort rules directory and do a directory listing.
231 opendir(DIR, $IDS::rulespath) or die $!;
232 # Loop through the direcory.
233 while (my $file = readdir(DIR)) {
234
235 # We only want files.
236 next unless (-f "$IDS::rulespath/$file");
237
238 # Ignore empty files.
239 next if (-z "$IDS::rulespath/$file");
240
241 # Use a regular expression to find files ending in .rules
242 next unless ($file =~ m/\.rules$/);
243
244 # Ignore files which are not read-able.
245 next unless (-R "$IDS::rulespath/$file");
246
247 # Skip whitelist rules file.
248 next if( $file eq "whitelist.rules");
249
250 # Call subfunction to read-in rulefile and add rules to
251 # the idsrules hash.
252 &readrulesfile("$file");
253 }
254
255 closedir(DIR);
256
257 # Gather used rulefiles.
258 #
259 # Check if the file for activated rulefiles is not empty.
260 if(-f $IDS::used_rulefiles_file) {
261 # Open the file for used rulefile and read-in content.
262 open(FILE, $IDS::used_rulefiles_file) or die "Could not open $IDS::used_rulefiles_file. $!\n";
263
264 # Read-in content.
265 my @lines = <FILE>;
266
267 # Close file.
268 close(FILE);
269
270 # Loop through the array.
271 foreach my $line (@lines) {
272 # Remove newlines.
273 chomp($line);
274
275 # Skip comments.
276 next if ($line =~ /\#/);
277
278 # Skip blank lines.
279 next if ($line =~ /^\s*$/);
280
281 # Gather rule sid and message from the ruleline.
282 if ($line =~ /.*- (.*)/) {
283 my $rulefile = $1;
284
285 # Check if the current rulefile exists in the %idsrules hash.
286 # If not, the file probably does not exist anymore or contains
287 # no rules.
288 if($idsrules{$rulefile}) {
289 # Add the rulefile state to the %idsrules hash.
290 $idsrules{$rulefile}{'Rulefile'}{'State'} = "on";
291 }
292 }
293 }
294 }
295
296 # Save ruleset configuration.
297 if ($cgiparams{'RULESET'} eq $Lang::tr{'save'}) {
298 my %oldsettings;
299
300 # Read-in current (old) IDS settings.
301 &General::readhash("$IDS::rules_settings_file", \%oldsettings);
302
303 # Prevent form name from been stored in conf file.
304 delete $cgiparams{'RULESET'};
305
306 # Check if an oinkcode has been provided.
307 if ($cgiparams{'OINKCODE'}) {
308 # Check if the oinkcode contains unallowed chars.
309 unless ($cgiparams{'OINKCODE'} =~ /^[a-z0-9]+$/) {
310 $errormessage = $Lang::tr{'invalid input for oink code'};
311 }
312 }
313
314 # Go on if there are no error messages.
315 if (!$errormessage) {
316 # Store settings into settings file.
317 &General::writehash("$IDS::rules_settings_file", \%cgiparams);
318 }
319
320 # Check if the the automatic rule update hass been touched.
321 if($cgiparams{'AUTOUPDATE_INTERVAL'} ne $oldsettings{'AUTOUPDATE_INTERVAL'}) {
322 # Call suricatactrl to set the new interval.
323 &IDS::call_suricatactrl("cron", $cgiparams{'AUTOUPDATE_INTERVAL'});
324 }
325
326 # Save ruleset.
327 } elsif ($cgiparams{'RULESET'} eq $Lang::tr{'update'}) {
328 # Arrays to store which rulefiles have been enabled and will be used.
329 my @enabled_rulefiles;
330
331 # Hash to store the user-enabled and disabled sids.
332 my %enabled_disabled_sids;
333
334 # Loop through the hash of idsrules.
335 foreach my $rulefile(keys %idsrules) {
336 # Check if the rulefile is enabled.
337 if ($cgiparams{$rulefile} eq "on") {
338 # Add rulefile to the array of enabled rulefiles.
339 push(@enabled_rulefiles, $rulefile);
340
341 # Drop item from cgiparams hash.
342 delete $cgiparams{$rulefile};
343 }
344 }
345
346 # Read-in the files for enabled/disabled sids.
347 # This will be done by calling the read_enabled_disabled_sids_file function two times
348 # and merge the returned hashes together into the enabled_disabled_sids hash.
349 %enabled_disabled_sids = (
350 &read_enabled_disabled_sids_file($IDS::disabled_sids_file),
351 &read_enabled_disabled_sids_file($IDS::enabled_sids_file));
352
353 # Loop through the hash of idsrules.
354 foreach my $rulefile (keys %idsrules) {
355 # Loop through the single rules of the rulefile.
356 foreach my $sid (keys %{$idsrules{$rulefile}}) {
357 # Skip the current sid if it is not numeric.
358 next unless ($sid =~ /\d+/ );
359
360 # Check if there exists a key in the cgiparams hash for this sid.
361 if (exists($cgiparams{$sid})) {
362 # Look if the rule is disabled.
363 if ($idsrules{$rulefile}{$sid}{'State'} eq "off") {
364 # Check if the state has been set to 'on'.
365 if ($cgiparams{$sid} eq "on") {
366 # Add/Modify the sid to/in the enabled_disabled_sids hash.
367 $enabled_disabled_sids{$sid} = "enabled";
368
369 # Drop item from cgiparams hash.
370 delete $cgiparams{$rulefile}{$sid};
371 }
372 }
373 } else {
374 # Look if the rule is enabled.
375 if ($idsrules{$rulefile}{$sid}{'State'} eq "on") {
376 # Check if the state is 'on' and should be disabled.
377 # In this case there is no entry
378 # for the sid in the cgiparams hash.
379 # Add/Modify it to/in the enabled_disabled_sids hash.
380 $enabled_disabled_sids{$sid} = "disabled";
381
382 # Drop item from cgiparams hash.
383 delete $cgiparams{$rulefile}{$sid};
384 }
385 }
386 }
387 }
388
389 # Open enabled sid's file for writing.
390 open(ENABLED_FILE, ">$IDS::enabled_sids_file") or die "Could not write to $IDS::enabled_sids_file. $!\n";
391
392 # Open disabled sid's file for writing.
393 open(DISABLED_FILE, ">$IDS::disabled_sids_file") or die "Could not write to $IDS::disabled_sids_file. $!\n";
394
395 # Write header to the files.
396 print ENABLED_FILE "#Autogenerated file. Any custom changes will be overwritten!\n";
397 print DISABLED_FILE "#Autogenerated file. Any custom changes will be overwritten!\n";
398
399 # Check if the hash for enabled/disabled files contains any entries.
400 if (%enabled_disabled_sids) {
401 # Loop through the hash.
402 foreach my $sid (keys %enabled_disabled_sids) {
403 # Check if the sid is enabled.
404 if ($enabled_disabled_sids{$sid} eq "enabled") {
405 # Print the sid to the enabled_sids file.
406 print ENABLED_FILE "enablesid $sid\n";
407 # Check if the sid is disabled.
408 } elsif ($enabled_disabled_sids{$sid} eq "disabled") {
409 # Print the sid to the disabled_sids file.
410 print DISABLED_FILE "disablesid $sid\n";
411 # Something strange happende - skip the current sid.
412 } else {
413 next;
414 }
415 }
416 }
417
418 # Close file for enabled_sids after writing.
419 close(ENABLED_FILE);
420
421 # Close file for disabled_sids after writing.
422 close(DISABLED_FILE);
423
424 # Call function to generate and write the used rulefiles file.
425 &IDS::write_used_rulefiles_file(@enabled_rulefiles);
426
427 # Lock the webpage and print message.
428 &working_notice("$Lang::tr{'snort working'}");
429
430 # Call oinkmaster to alter the ruleset.
431 &IDS::oinkmaster();
432
433 # Check if the IDS is running.
434 if(&IDS::ids_is_running()) {
435 # Call suricatactrl to perform a reload.
436 &IDS::call_suricatactrl("reload");
437 }
438
439 # Reload page.
440 &reload();
441
442 # Download new ruleset.
443 } elsif ($cgiparams{'RULESET'} eq $Lang::tr{'download new ruleset'}) {
444 # Check if the red device is active.
445 unless (-e "${General::swroot}/red/active") {
446 $errormessage = $Lang::tr{'could not download latest updates'};
447 }
448
449 # Check if enought free disk space is availabe.
450 if(&IDS::checkdiskspace()) {
451 $errormessage = "$Lang::tr{'not enough disk space'}";
452 }
453
454 # Check if any errors happend.
455 unless ($errormessage) {
456 # Lock the webpage and print notice about downloading
457 # a new ruleset.
458 &working_notice("$Lang::tr{'snort working'}");
459
460 # Call subfunction to download the ruleset.
461 if(&IDS::downloadruleset()) {
462 $errormessage = $Lang::tr{'could not download latest updates'};
463
464 # Call function to store the errormessage.
465 &IDS::_store_error_message($errormessage);
466
467 # Preform a reload of the page.
468 &reload();
469 } else {
470 # Call subfunction to launch oinkmaster.
471 &IDS::oinkmaster();
472
473 # Check if the IDS is running.
474 if(&IDS::ids_is_running()) {
475 # Call suricatactrl to perform a reload.
476 &IDS::call_suricatactrl("reload");
477 }
478
479 # Perform a reload of the page.
480 &reload();
481 }
482 }
483 # Save snort settings.
484 } elsif ($cgiparams{'IDS'} eq $Lang::tr{'save'}) {
485 my %oldidssettings;
486 my $reload_page;
487 my $monitored_zones = 0;
488
489 # Read-in current (old) IDS settings.
490 &General::readhash("$IDS::ids_settings_file", \%oldidssettings);
491
492 # Prevent form name from been stored in conf file.
493 delete $cgiparams{'IDS'};
494
495 # Check if the IDS should be enabled.
496 if ($cgiparams{'ENABLE_IDS'} eq "on") {
497 # Check if any ruleset is available. Otherwise abort and display an error.
498 unless(%idsrules) {
499 $errormessage = $Lang::tr{'ids no ruleset available'};
500 }
501
502 # Loop through the array of available interfaces.
503 foreach my $zone (@network_zones) {
504 # Convert interface name into upper case.
505 my $zone_upper = uc($zone);
506
507 # Check if the IDS is enabled for this interaces.
508 if ($cgiparams{"ENABLE_IDS_$zone_upper"}) {
509 # Increase count.
510 $monitored_zones++;
511 }
512 }
513
514 # Check if at least one zone should be monitored, or show an error.
515 unless ($monitored_zones >= 1) {
516 $errormessage = $Lang::tr{'ids no network zone'};
517 }
518 }
519
520 # Go on if there are no error messages.
521 if (!$errormessage) {
522 # Store settings into settings file.
523 &General::writehash("$IDS::ids_settings_file", \%cgiparams);
524 }
525
526 # Generate file to store the home net.
527 &IDS::generate_home_net_file();
528
529 # Temporary variable to set the ruleaction.
530 # Default is "drop" to use suricata as IPS.
531 my $ruleaction="drop";
532
533 # Check if the traffic only should be monitored.
534 if($cgiparams{'MONITOR_TRAFFIC_ONLY'} eq 'on') {
535 # Switch the ruleaction to "alert".
536 # Suricata acts as an IDS only.
537 $ruleaction="alert";
538 }
539
540 # Write the modify sid's file and pass the taken ruleaction.
541 &IDS::write_modify_sids_file($ruleaction);
542
543 # Check if "MONITOR_TRAFFIC_ONLY" has been changed.
544 if($cgiparams{'MONITOR_TRAFFIC_ONLY'} ne $oldidssettings{'MONITOR_TRAFFIC_ONLY'}) {
545 # Check if a ruleset exists.
546 if (%idsrules) {
547 # Lock the webpage and print message.
548 &working_notice("$Lang::tr{'snort working'}");
549
550 # Call oinkmaster to alter the ruleset.
551 &IDS::oinkmaster();
552
553 # Set reload_page to "True".
554 $reload_page="True";
555 }
556 }
557
558 # Check if the IDS currently is running.
559 if(&IDS::ids_is_running()) {
560 # Check if ENABLE_IDS is set to on.
561 if($cgiparams{'ENABLE_IDS'} eq "on") {
562 # Call suricatactrl to perform a reload of suricata.
563 &IDS::call_suricatactrl("reload");
564 } else {
565 # Call suricatactrl to stop suricata.
566 &IDS::call_suricatactrl("stop");
567 }
568 } else {
569 # Call suricatactrl to start suricata.
570 &IDS::call_suricatactrl("start");
571 }
572
573 # Check if the page should be reloaded.
574 if ($reload_page) {
575 # Perform a reload of the page.
576 &reload();
577 }
578 }
579
580 # Read-in idssettings and rulesetsettings
581 &General::readhash("$IDS::ids_settings_file", \%idssettings);
582 &General::readhash("$IDS::rules_settings_file", \%rulessettings);
583
584 # If no autoupdate intervall has been configured yet, set default value.
585 unless(exists($rulessettings{'AUTOUPDATE_INTERVAL'})) {
586 # Set default to "weekly".
587 $rulessettings{'AUTOUPDATE_INTERVAL'} = 'weekly';
588 }
589
590 # Read-in ignored hosts.
591 &General::readhasharray("$IDS::settingsdir/ignored", \%ignored);
592
593 $checked{'ENABLE_IDS'}{'off'} = '';
594 $checked{'ENABLE_IDS'}{'on'} = '';
595 $checked{'ENABLE_IDS'}{$idssettings{'ENABLE_IDS'}} = "checked='checked'";
596 $checked{'MONITOR_TRAFFIC_ONLY'}{'off'} = '';
597 $checked{'MONITOR_TRAFFIC_ONLY'}{'on'} = '';
598 $checked{'MONITOR_TRAFFIC_ONLY'}{$idssettings{'MONITOR_TRAFFIC_ONLY'}} = "checked='checked'";
599 $selected{'RULES'}{'nothing'} = '';
600 $selected{'RULES'}{'community'} = '';
601 $selected{'RULES'}{'emerging'} = '';
602 $selected{'RULES'}{'registered'} = '';
603 $selected{'RULES'}{'subscripted'} = '';
604 $selected{'RULES'}{$rulessettings{'RULES'}} = "selected='selected'";
605 $selected{'AUTOUPDATE_INTERVAL'}{'off'} = '';
606 $selected{'AUTOUPDATE_INTERVAL'}{'daily'} = '';
607 $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} = '';
608 $selected{'AUTOUPDATE_INTERVAL'}{$rulessettings{'AUTOUPDATE_INTERVAL'}} = "selected='selected'";
609
610 &Header::openpage($Lang::tr{'intrusion detection system'}, 1, '');
611
612 ### Java Script ###
613 print <<END
614 <script>
615 // Tiny java script function to show/hide the rules
616 // of a given category.
617 function showhide(tblname) {
618 \$("#" + tblname).toggle();
619 }
620 </script>
621 END
622 ;
623
624 &Header::openbigbox('100%', 'left', '', $errormessage);
625
626 if ($errormessage) {
627 &Header::openbox('100%', 'left', $Lang::tr{'error messages'});
628 print "<class name='base'>$errormessage\n";
629 print "&nbsp;</class>\n";
630 &Header::closebox();
631 }
632
633 # Draw current state of the IDS
634 &Header::openbox('100%', 'left', $Lang::tr{'intrusion detection system'});
635
636 # Check if the IDS is running and obtain the process-id.
637 my $pid = &IDS::ids_is_running();
638
639 # Display some useful information, if suricata daemon is running.
640 if ($pid) {
641 # Gather used memory.
642 my $memory = &get_memory_usage($pid);
643
644 print <<END;
645 <table width='95%' cellspacing='0' class='tbl'>
646 <tr>
647 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
648 </tr>
649
650 <tr>
651 <td class='base'>$Lang::tr{'guardian daemon'}</td>
652 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
653 </tr>
654
655 <tr>
656 <td class='base'></td>
657 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
658 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
659 </tr>
660
661 <tr>
662 <td class='base'></td>
663 <td bgcolor='$color{'color22'}' align='center'>$pid</td>
664 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
665 </tr>
666 </table>
667 END
668 } else {
669 # Otherwise display a hint that the service is not launched.
670 print <<END;
671 <table width='95%' cellspacing='0' class='tbl'>
672 <tr>
673 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'intrusion detection'}</strong></th>
674 </tr>
675
676 <tr>
677 <td class='base'>$Lang::tr{'guardian daemon'}</td>
678 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
679 </tr>
680 </table>
681 END
682 }
683 &Header::closebox();
684
685 my $rulesdate;
686
687 # Check if a ruleset allready has been downloaded.
688 if ( -f "$IDS::rulestarball"){
689 # Call stat on the filename to obtain detailed information.
690 my @Info = stat("$IDS::rulestarball");
691
692 # Grab details about the creation time.
693 $rulesdate = localtime($Info[9]);
694 }
695
696 # Draw elements for IDS configuration.
697 &Header::openbox('100%', 'center', $Lang::tr{'settings'});
698
699 print <<END
700 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
701 <table width='100%' border='0'>
702 <tr>
703 <td class='base' colspan='2'>
704 <input type='checkbox' name='ENABLE_IDS' $checked{'ENABLE_IDS'}{'on'}>$Lang::tr{'ids activate'} $Lang::tr{'intrusion detection system'}
705 </td>
706
707 <td class='base' colspan='2'>
708 <input type='checkbox' name='MONITOR_TRAFFIC_ONLY' $checked{'MONITOR_TRAFFIC_ONLY'}{'on'}>$Lang::tr{'ids monitor traffic only'}
709 </td>
710 </tr>
711
712 <tr>
713 <td><br><br></td>
714 <td><br><br></td>
715 <td><br><br></td>
716 <td><br><br></td>
717 </tr>
718
719 <tr>
720 <td colspan='4'><b>$Lang::tr{'ids monitored interfaces'}</b><br></td>
721 </tr>
722
723 <tr>
724 END
725 ;
726
727 # Loop through the array of available networks and print config options.
728 foreach my $zone (@network_zones) {
729 my $checked_input;
730 my $checked_forward;
731
732 # Convert current zone name to upper case.
733 my $zone_upper = uc($zone);
734
735 # Set zone name.
736 my $zone_name = $zone;
737
738 # Dirty hack to get the correct language string for the red zone.
739 if ($zone eq "red") {
740 $zone_name = "red1";
741 }
742
743 # Grab checkbox status from settings hash.
744 if ($idssettings{"ENABLE_IDS_$zone_upper"} eq "on") {
745 $checked_input = "checked = 'checked'";
746 }
747
748 print "<td class='base' width='25%'>\n";
749 print "<input type='checkbox' name='ENABLE_IDS_$zone_upper' $checked_input>\n";
750 print "&nbsp$Lang::tr{'enabled on'}<font color='$colourhash{$zone}'> $Lang::tr{$zone_name}</font>\n";
751 print "</td>\n";
752 }
753
754 print <<END
755 </tr>
756 </table>
757
758 <br><br>
759
760 <table width='100%'>
761 <tr>
762 <td align='right'><input type='submit' name='IDS' value='$Lang::tr{'save'}' /></td>
763 </tr>
764 </table>
765 </form>
766 END
767 ;
768
769 &Header::closebox();
770
771 # Draw elements for ruleset configuration.
772 &Header::openbox('100%', 'center', $Lang::tr{'ids ruleset settings'});
773
774 print <<END
775 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
776 <table width='100%' border='0'>
777 <tr>
778 <td><b>$Lang::tr{'ids rules update'}</b></td>
779 <td><b>$Lang::tr{'ids automatic rules update'}</b></td>
780 </tr>
781
782 <tr>
783 <td><select name='RULES'>
784 <option value='emerging' $selected{'RULES'}{'emerging'} >$Lang::tr{'emerging rules'}</option>
785 <option value='community' $selected{'RULES'}{'community'} >$Lang::tr{'community rules'}</option>
786 <option value='registered' $selected{'RULES'}{'registered'} >$Lang::tr{'registered user rules'}</option>
787 <option value='subscripted' $selected{'RULES'}{'subscripted'} >$Lang::tr{'subscripted user rules'}</option>
788 </select>
789 </td>
790
791 <td>
792 <select name='AUTOUPDATE_INTERVAL'>
793 <option value='off' $selected{'AUTOUPDATE_INTERVAL'}{'off'} >$Lang::tr{'no'}</option>
794 <option value='daily' $selected{'AUTOUPDATE_INTERVAL'}{'daily'} >$Lang::tr{'urlfilter daily'}</option>
795 <option value='weekly' $selected{'AUTOUPDATE_INTERVAL'}{'weekly'} >$Lang::tr{'urlfilter weekly'}</option>
796 </select>
797 </td>
798 </tr>
799
800 <tr>
801 <td colspan='2'>
802 <br>$Lang::tr{'ids rules license'} <a href='https://www.snort.org/subscribe' target='_blank'>www.snort.org</a>$Lang::tr{'ids rules license1'}</br>
803 <br>$Lang::tr{'ids rules license2'} <a href='https://www.snort.org/account/oinkcode' target='_blank'>Get an Oinkcode</a>, $Lang::tr{'ids rules license3'}</br>
804 </td>
805 </tr>
806
807 <tr>
808 <td colspan='2' nowrap='nowrap'>Oinkcode:&nbsp;<input type='text' size='40' name='OINKCODE' value='$rulessettings{'OINKCODE'}'></td>
809 </tr>
810
811 <tr>
812 <td>&nbsp;</td>
813
814 <td align='right'>
815 END
816 ;
817 # Check if a ruleset source has been configured yet.
818 unless($rulessettings{'RULES'}) {
819 # If no ruleset settings have been saved yet, disable the button to download / update the ruleset.
820 print"<input type='submit' name='RULESET' disabled='disabled' value='$Lang::tr{'download new ruleset'}'>\n";
821 } else {
822 # Ruleset setting have been saved. - Check if a ruleset already is downloaded.
823 if (%idsrules) {
824 # Allow to press the button and show it as "update ruleset".
825 print"<input type='submit' name='RULESET' value='$Lang::tr{'update ruleset'}'>\n";
826 } else {
827 # Also allow to press the button, but show it as "download new ruleset".
828 print"<input type='submit' name='RULESET' value='$Lang::tr{'download new ruleset'}'>\n";
829 }
830 }
831 print <<END;
832 <input type='submit' name='RULESET' value='$Lang::tr{'save'}'>
833 </td>
834
835 </tr>
836 </table>
837 </form>
838 END
839 ;
840
841 &Header::closebox();
842
843 #
844 # Whitelist / Ignorelist
845 #
846 &Header::openbox('100%', 'center', $Lang::tr{'guardian ignored hosts'});
847
848 print <<END;
849 <table width='100%'>
850 <tr>
851 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'ip address'}</b></td>
852 <td class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'remark'}</b></td>
853 <td class='base' colspan='3' bgcolor='$color{'color20'}'></td>
854 </tr>
855 END
856 # Check if some hosts have been added to be ignored.
857 if (keys (%ignored)) {
858 my $col = "";
859
860 # Loop through all entries of the hash.
861 while( (my $key) = each %ignored) {
862 # Assign data array positions to some nice variable names.
863 my $address = $ignored{$key}[0];
864 my $remark = $ignored{$key}[1];
865 my $status = $ignored{$key}[2];
866
867 # Check if the key (id) number is even or not.
868 if ($cgiparams{'ID'} eq $key) {
869 $col="bgcolor='${Header::colouryellow}'";
870 } elsif ($key % 2) {
871 $col="bgcolor='$color{'color22'}'";
872 } else {
873 $col="bgcolor='$color{'color20'}'";
874 }
875
876 # Choose icon for the checkbox.
877 my $gif;
878 my $gdesc;
879
880 # Check if the status is enabled and select the correct image and description.
881 if ($status eq 'enabled' ) {
882 $gif = 'on.gif';
883 $gdesc = $Lang::tr{'click to disable'};
884 } else {
885 $gif = 'off.gif';
886 $gdesc = $Lang::tr{'click to enable'};
887 }
888
889 print <<END;
890 <tr>
891 <td width='20%' class='base' $col>$address</td>
892 <td width='65%' class='base' $col>$remark</td>
893
894 <td align='center' $col>
895 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
896 <input type='hidden' name='WHITELIST' value='$Lang::tr{'toggle enable disable'}' />
897 <input type='image' name='$Lang::tr{'toggle enable disable'}' src='/images/$gif' alt='$gdesc' title='$gdesc' />
898 <input type='hidden' name='ID' value='$key' />
899 </form>
900 </td>
901
902 <td align='center' $col>
903 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
904 <input type='hidden' name='WHITELIST' value='$Lang::tr{'edit'}' />
905 <input type='image' name='$Lang::tr{'edit'}' src='/images/edit.gif' alt='$Lang::tr{'edit'}' title='$Lang::tr{'edit'}' />
906 <input type='hidden' name='ID' value='$key' />
907 </form>
908 </td>
909
910 <td align='center' $col>
911 <form method='post' name='$key' action='$ENV{'SCRIPT_NAME'}'>
912 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
913 <input type='hidden' name='ID' value='$key'>
914 <input type='hidden' name='WHITELIST' value='$Lang::tr{'remove'}'>
915 </form>
916 </td>
917 </tr>
918 END
919 }
920 } else {
921 # Print notice that currently no hosts are ignored.
922 print "<tr>\n";
923 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
924 print "</tr>\n";
925 }
926
927 print "</table>\n";
928
929 # Section to add new elements or edit existing ones.
930 print <<END;
931 <br>
932 <hr>
933 <br>
934
935 <div align='center'>
936 <table width='100%'>
937 END
938
939 # Assign correct headline and button text.
940 my $buttontext;
941 my $entry_address;
942 my $entry_remark;
943
944 # Check if an ID (key) has been given, in this case an existing entry should be edited.
945 if ($cgiparams{'ID'} ne '') {
946 $buttontext = $Lang::tr{'update'};
947 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'update'}</b></td></tr>\n";
948
949 # Grab address and remark for the given key.
950 $entry_address = $ignored{$cgiparams{'ID'}}[0];
951 $entry_remark = $ignored{$cgiparams{'ID'}}[1];
952 } else {
953 $buttontext = $Lang::tr{'add'};
954 print "<tr><td class='boldbase' colspan='3'><b>$Lang::tr{'dnsforward add a new entry'}</b></td></tr>\n";
955 }
956
957 print <<END;
958 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
959 <input type='hidden' name='ID' value='$cgiparams{'ID'}'>
960 <tr>
961 <td width='30%'>$Lang::tr{'ip address'}: </td>
962 <td width='50%'><input type='text' name='IGNORE_ENTRY_ADDRESS' value='$entry_address' size='24' /></td>
963
964 <td width='30%'>$Lang::tr{'remark'}: </td>
965 <td wicth='50%'><input type='text' name=IGNORE_ENTRY_REMARK value='$entry_remark' size='24' /></td>
966 <td align='center' width='20%'><input type='submit' name='WHITELIST' value='$buttontext' /></td>
967 </tr>
968 </form>
969 </table>
970 </div>
971 END
972
973 &Header::closebox();
974
975 # Only show the section for configuring the ruleset if one is present.
976 if (%idsrules) {
977 &Header::openbox('100%', 'LEFT', $Lang::tr{'intrusion detection system rules'});
978
979 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
980
981 # Output display table for rule files
982 print "<table width='100%'>\n";
983
984 # Loop over each rule file
985 foreach my $rulefile (sort keys(%idsrules)) {
986 my $rulechecked = '';
987
988 # Check if rule file is enabled
989 if ($idsrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
990 $rulechecked = 'CHECKED';
991 }
992
993 # Convert rulefile name into category name.
994 my $categoryname = &_rulefile_to_category($rulefile);
995
996 # Table and rows for the rule files.
997 print"<tr>\n";
998 print"<td class='base' width='5%'>\n";
999 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
1000 print"</td>\n";
1001 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
1002 print"<td class='base' width='5%' align='right'>\n";
1003 print"<a href=\"javascript:showhide('$categoryname')\">SHOW</a>\n";
1004 print"</td>\n";
1005 print"</tr>\n";
1006
1007 # Rows which will be hidden per default and will contain the single rules.
1008 print"<tr style='display:none' id='$categoryname'>\n";
1009 print"<td colspan='3'>\n";
1010
1011 # Local vars
1012 my $lines;
1013 my $rows;
1014 my $col;
1015
1016 # New table for the single rules.
1017 print "<table width='100%'>\n";
1018
1019 # Loop over rule file rules
1020 foreach my $sid (sort {$a <=> $b} keys(%{$idsrules{$rulefile}})) {
1021 # Local vars
1022 my $ruledefchecked = '';
1023
1024 # Skip rulefile itself.
1025 next if ($sid eq "Rulefile");
1026
1027 # If 2 rules have been displayed, start a new row
1028 if (($lines % 2) == 0) {
1029 print "</tr><tr>\n";
1030
1031 # Increase rows by once.
1032 $rows++;
1033 }
1034
1035 # Colour lines.
1036 if ($rows % 2) {
1037 $col="bgcolor='$color{'color20'}'";
1038 } else {
1039 $col="bgcolor='$color{'color22'}'";
1040 }
1041
1042 # Set rule state
1043 if ($idsrules{$rulefile}{$sid}{'State'} eq 'on') {
1044 $ruledefchecked = 'CHECKED';
1045 }
1046
1047 # Create rule checkbox and display rule description
1048 print "<td class='base' width='5%' align='right' $col>\n";
1049 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
1050 print "</td>\n";
1051 print "<td class='base' width='45%' $col>$idsrules{$rulefile}{$sid}{'Description'}</td>";
1052
1053 # Increment rule count
1054 $lines++;
1055 }
1056
1057 # If do not have a second rule for row, create empty cell
1058 if (($lines % 2) != 0) {
1059 print "<td class='base'></td>";
1060 }
1061
1062 # Close display table
1063 print "</tr></table></td></tr>";
1064 }
1065
1066 # Close display table
1067 print "</table>";
1068
1069 print <<END
1070 <table width='100%'>
1071 <tr>
1072 <td width='100%' align='right'><input type='submit' name='RULESET' value='$Lang::tr{'update'}'>
1073 &nbsp; <!-- space for future online help link -->
1074 </td>
1075 </tr>
1076 </table>
1077 </form>
1078 END
1079 ;
1080 &Header::closebox();
1081 }
1082
1083 &Header::closebigbox();
1084 &Header::closepage();
1085
1086 #
1087 ## A function to display a notice, to lock the webpage and
1088 ## tell the user which action currently will be performed.
1089 #
1090 sub working_notice ($) {
1091 my ($message) = @_;
1092
1093 &Header::openpage($Lang::tr{'intrusion detection system'}, 1, '');
1094 &Header::openbigbox('100%', 'left', '', $errormessage);
1095 &Header::openbox( 'Waiting', 1,);
1096 print <<END;
1097 <table>
1098 <tr>
1099 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
1100 <td>$message</td>
1101 </tr>
1102 </table>
1103 END
1104 &Header::closebox();
1105 &Header::closebigbox();
1106 &Header::closepage();
1107 }
1108
1109 #
1110 ## A tiny function to perform a reload of the webpage after one second.
1111 #
1112 sub reload () {
1113 print "<meta http-equiv='refresh' content='1'>\n";
1114
1115 # Stop the script.
1116 exit;
1117 }
1118
1119 #
1120 ## Private function to read-in and parse rules of a given rulefile.
1121 #
1122 ## The given file will be read, parsed and all valid rules will be stored by ID,
1123 ## message/description and it's state in the idsrules hash.
1124 #
1125 sub readrulesfile ($) {
1126 my $rulefile = shift;
1127
1128 # Open rule file and read in contents
1129 open(RULEFILE, "$IDS::rulespath/$rulefile") or die "Unable to read $rulefile!";
1130
1131 # Store file content in an array.
1132 my @lines = <RULEFILE>;
1133
1134 # Close file.
1135 close(RULEFILE);
1136
1137 # Loop over rule file contents
1138 foreach my $line (@lines) {
1139 # Remove whitespaces.
1140 chomp $line;
1141
1142 # Skip blank lines.
1143 next if ($line =~ /^\s*$/);
1144
1145 # Local vars.
1146 my $sid;
1147 my $msg;
1148
1149 # Gather rule sid and message from the ruleline.
1150 if ($line =~ m/.*msg:\"(.*?)\"\; .* sid:(.*?); /) {
1151 $msg = $1;
1152 $sid = $2;
1153
1154 # Check if a rule has been found.
1155 if ($sid && $msg) {
1156 # Add rule to the idsrules hash.
1157 $idsrules{$rulefile}{$sid}{'Description'} = $msg;
1158
1159 # Grab status of the rule. Check if ruleline starts with a "dash".
1160 if ($line =~ /^\#/) {
1161 # If yes, the rule is disabled.
1162 $idsrules{$rulefile}{$sid}{'State'} = "off";
1163 } else {
1164 # Otherwise the rule is enabled.
1165 $idsrules{$rulefile}{$sid}{'State'} = "on";
1166 }
1167 }
1168 }
1169 }
1170 }
1171
1172 #
1173 ## Function to get the used memory of a given process-id.
1174 #
1175 sub get_memory_usage($) {
1176 my ($pid) = @_;
1177
1178 my $memory = 0;
1179
1180 # Try to open the status file for the given process-id on the pseudo
1181 # file system proc.
1182 if (open(FILE, "/proc/$pid/status")) {
1183 # Loop through the entire file.
1184 while (<FILE>) {
1185 # Splitt current line content and store them into variables.
1186 my ($key, $value) = split(":", $_, 2);
1187
1188 # Check if the current key is the one which contains the memory usage.
1189 # The wanted one is VmRSS which contains the Real-memory (resident set)
1190 # of the entire process.
1191 if ($key eq "VmRSS") {
1192 # Found the memory usage add it to the memory variable.
1193 $memory += $value;
1194
1195 # Break the loop.
1196 last;
1197 }
1198 }
1199
1200 # Close file handle.
1201 close(FILE);
1202
1203 # Return memory usage.
1204 return $memory;
1205 }
1206
1207 # If the file could not be open, return nothing.
1208 return;
1209 }
1210
1211 #
1212 ## Function to generate the rules file with whitelisted addresses.
1213 #
1214 sub GenerateIgnoreFile() {
1215 my %ignored = ();
1216
1217 # SID range 1000000-1999999 Reserved for Local Use
1218 # Put your custom rules in this range to avoid conflicts
1219 my $sid = 1500000;
1220
1221 # Read-in ignoredfile.
1222 &General::readhasharray($IDS::ignored_file, \%ignored);
1223
1224 # Open ignorefile for writing.
1225 open(FILE, ">$IDS::whitelist_file") or die "Could not write to $IDS::whitelist_file. $!\n";
1226
1227 # Config file header.
1228 print FILE "# Autogenerated file.\n";
1229 print FILE "# All user modifications will be overwritten.\n\n";
1230
1231 # Add all user defined addresses to the whitelist.
1232 #
1233 # Check if the hash contains any elements.
1234 if (keys (%ignored)) {
1235 # Loop through the entire hash and write the host/network
1236 # and remark to the ignore file.
1237 while ( (my $key) = each %ignored) {
1238 my $address = $ignored{$key}[0];
1239 my $remark = $ignored{$key}[1];
1240 my $status = $ignored{$key}[2];
1241
1242 # Check if the status of the entry is "enabled".
1243 if ($status eq "enabled") {
1244 # Check if the address/network is valid.
1245 if ((&General::validip($address)) || (&General::validipandmask($address))) {
1246 # Write rule line to the file to pass any traffic from this IP
1247 print FILE "pass ip $address any -> any any (msg:\"pass all traffic from/to $address\"\; sid:$sid\;)\n";
1248
1249 # Increment sid.
1250 $sid++;
1251 }
1252 }
1253 }
1254 }
1255
1256 close(FILE);
1257 }
1258
1259 #
1260 ## Function to read-in the given enabled or disables sids file.
1261 #
1262 sub read_enabled_disabled_sids_file($) {
1263 my ($file) = @_;
1264
1265 # Temporary hash to store the sids and their state. It will be
1266 # returned at the end of this function.
1267 my %temphash;
1268
1269 # Open the given filename.
1270 open(FILE, "$file") or die "Could not open $file. $!\n";
1271
1272 # Loop through the file.
1273 while(<FILE>) {
1274 # Remove newlines.
1275 chomp $_;
1276
1277 # Skip blank lines.
1278 next if ($_ =~ /^\s*$/);
1279
1280 # Skip coments.
1281 next if ($_ =~ /^\#/);
1282
1283 # Splitt line into sid and state part.
1284 my ($state, $sid) = split(" ", $_);
1285
1286 # Skip line if the sid is not numeric.
1287 next unless ($sid =~ /\d+/ );
1288
1289 # Check if the sid was enabled.
1290 if ($state eq "enablesid") {
1291 # Add the sid and its state as enabled to the temporary hash.
1292 $temphash{$sid} = "enabled";
1293 # Check if the sid was disabled.
1294 } elsif ($state eq "disablesid") {
1295 # Add the sid and its state as disabled to the temporary hash.
1296 $temphash{$sid} = "disabled";
1297 # Invalid state - skip the current sid and state.
1298 } else {
1299 next;
1300 }
1301 }
1302
1303 # Close filehandle.
1304 close(FILE);
1305
1306 # Return the hash.
1307 return %temphash;
1308 }
1309
1310 #
1311 ## Private function to convert a given rulefile to a category name.
1312 ## ( No file extension anymore and if the name contained a dot, it
1313 ## would be replaced by a underline sign.)
1314 #
1315 sub _rulefile_to_category($) {
1316 my ($filename) = @_;
1317
1318 # Splitt the filename into single chunks and store them in a
1319 # temorary array.
1320 my @parts = split(/\./, $filename);
1321
1322 # Return / Remove last element of the temporary array.
1323 # This removes the file extension.
1324 pop @parts;
1325
1326 # Join together the single elements of the temporary array.
1327 # If these are more than one, use a "underline" for joining.
1328 my $category = join '_', @parts;
1329
1330 # Return the converted filename.
1331 return $category;
1332 }