]>
git.ipfire.org Git - ipfire-2.x.git/blob - html/cgi-bin/ids.cgi
2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2007-2015 IPFire Team <info@ipfire.org> #
7 # This program is free software: you can redistribute it and/or modify #
8 # it under the terms of the GNU General Public License as published by #
9 # the Free Software Foundation, either version 3 of the License, or #
10 # (at your option) any later version. #
12 # This program is distributed in the hope that it will be useful, #
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of #
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
15 # GNU General Public License for more details. #
17 # You should have received a copy of the GNU General Public License #
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. #
20 ###############################################################################
24 # enable only the following on debugging purpose
26 #use CGI::Carp 'fatalsToBrowser';
28 require '/var/ipfire/general-functions.pl';
29 require "${General::swroot}/lang.pl";
30 require "${General::swroot}/header.pl";
31 require "${General::swroot}/ids-functions.pl";
34 my %mainsettings = ();
38 my %rulesetsources = ();
43 # Read-in main settings, for language, theme and colors.
44 &General
::readhash
("${General::swroot}/main/settings", \
%mainsettings);
45 &General
::readhash
("/srv/web/ipfire/html/themes/".$mainsettings{'THEME'}."/include/colors.txt", \
%color);
48 &General
::readhash
("${General::swroot}/ethernet/settings", \
%netsettings);
50 # Get all available ruleset locations.
51 &General
::readhash
("${General::swroot}/snort/ruleset-sources.list", \
%rulesetsources);
53 my $rulestarball = "/var/tmp/snortrules.tar.gz";
54 my $snortrulepath = "/etc/snort/rules";
55 my $snortusedrulefilesfile = "${General::swroot}/snort/snort-used-rulefiles.conf";
58 # Hook used to download and update the ruleset,
59 # if the cgi got called from command line.
60 if ($ENV{"REMOTE_ADDR"} eq "") {
62 &General
::readhash
("${General::swroot}/snort/settings", \
%snortsettings);
64 # Download rules tarball.
65 $errormessage = &downloadruleset
();
67 # Sleep for one second.
70 # Check if there was an error message.
71 unless ($errormessage) {
75 # Call logger and log the errormessage.
76 system("logger -t oinkmaster $errormessage");
82 &Header
::showhttpheaders
();
84 # Default settings for snort.
85 $snortsettings{'ENABLE_SNORT'} = 'off';
86 $snortsettings{'ENABLE_SNORT_GREEN'} = 'off';
87 $snortsettings{'ENABLE_SNORT_BLUE'} = 'off';
88 $snortsettings{'ENABLE_SNORT_ORANGE'} = 'off';
89 $snortsettings{'RULES'} = '';
90 $snortsettings{'OINKCODE'} = '';
93 &Header
::getcgihash
(\
%cgiparams);
95 # Try to determine if oinkmaster is running.
96 my $oinkmaster_pid = `pidof oinkmaster.pl -x`;
98 # If oinkmaster is running display output.
99 if ($oinkmaster_pid) {
100 &working
("$Lang::tr{'snort working'}");
103 ## Grab all available snort rules and store them in the snortrules hash.
105 # Open snort rules directory and do a directory listing.
106 opendir(DIR
, $snortrulepath) or die $!;
107 # Loop through the direcory.
108 while (my $file = readdir(DIR
)) {
110 # We only want files.
111 next unless (-f
"$snortrulepath/$file");
113 # Ignore empty files.
114 next if (-z
"$snortrulepath/$file");
116 # Use a regular expression to find files ending in .rules
117 next unless ($file =~ m/\.rules$/);
119 # Ignore files which are not read-able.
120 next unless (-R
"$snortrulepath/$file");
122 # Call subfunction to read-in rulefile and add rules to
123 # the snortrules hash.
124 &readrulesfile
("$file");
129 # Gather used rulefiles.
131 # Check if the file for activated rulefiles is not empty.
132 if(-f
$snortusedrulefilesfile) {
133 # Open the file for used rulefile and read-in content.
134 open(FILE
, $snortusedrulefilesfile) or die "Could not open $snortusedrulefilesfile. $!\n";
142 # Loop through the array.
143 foreach my $line (@lines) {
148 next if ($line =~ /\#/);
151 next if ($line =~ /^\s*$/);
153 # Gather rule sid and message from the ruleline.
154 if ($line =~ /.*include \$RULE_PATH\/(.*)/) {
157 # Add the rulefile to the %snortrules hash.
158 $snortrules{$rulefile}{'Rulefile'}{'State'} = "on";
164 if ($cgiparams{'RULESET'} eq $Lang::tr
{'update'}) {
165 my $enabled_sids_file = "${General::swroot}/snort/oinkmaster-enabled-sids.conf";
166 my $disabled_sids_file = "${General::swroot}/snort/oinkmaster-disabled-sids.conf";
168 # Arrays to store sid which should be added to the corresponding files.
171 my @enabled_rulefiles;
173 # Loop through the hash of snortrules.
174 foreach my $rulefile(keys %snortrules) {
175 # Check if the rulefile is enabled.
176 if ($cgiparams{$rulefile} eq "on") {
177 # Add rulefile to the array of enabled rulefiles.
178 push(@enabled_rulefiles, $rulefile);
180 # Drop item from cgiparams hash.
181 delete $cgiparams{$rulefile};
185 # Loop through the hash of snortrules.
186 foreach my $rulefile (keys %snortrules) {
187 # Loop through the single rules of the rulefile.
188 foreach my $sid (keys %{$snortrules{$rulefile}}) {
189 # Skip the current sid if it is not numeric.
190 next unless ($sid =~ /\d+/ );
192 # Check if there exists a key in the cgiparams hash for this sid.
193 if (exists($cgiparams{$sid})) {
194 # Look if the rule is disabled.
195 if ($snortrules{$rulefile}{$sid}{'State'} eq "off") {
196 # Check if the state has been set to 'on'.
197 if ($cgiparams{$sid} eq "on") {
198 # Add the sid to the enabled_sids array.
199 push(@enabled_sids, $sid);
201 # Drop item from cgiparams hash.
202 delete $cgiparams{$rulefile}{$sid};
206 # Look if the rule is enabled.
207 if ($snortrules{$rulefile}{$sid}{'State'} eq "on") {
208 # Check if the state is 'on' and should be disabled.
209 # In this case there is no entry
210 # for the sid in the cgiparams hash.
211 # Add it to the disabled_sids array.
212 push(@disabled_sids, $sid);
214 # Drop item from cgiparams hash.
215 delete $cgiparams{$rulefile}{$sid};
221 # Open enabled sid's file for writing.
222 open(FILE
, ">$enabled_sids_file") or die "Could not write to $enabled_sids_file. $!\n";
224 # Write header to file.
225 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
227 # Check if the enabled_sids array contains any sid's.
229 # Loop through the array of enabled sids and write them to the file.
230 foreach my $sid (@enabled_sids) {
231 print FILE
"enablesid $sid\n";
235 # Close file after writing.
238 # Open disabled sid's file for writing.
239 open(FILE
, ">$disabled_sids_file") or die "Could not write to $disabled_sids_file. $!\n";
241 # Write header to file.
242 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
244 # Check if the enabled_sids array contains any sid's.
245 if (@disabled_sids) {
246 # Loop through the array of disabled sids and write them to the file.
247 foreach my $sid (@disabled_sids) {
248 print FILE
"disablesid $sid\n";
252 # Close file after writing.
255 # Open file for used rulefiles.
256 open (FILE
, ">$snortusedrulefilesfile") or die "Could not write to $snortusedrulefilesfile. $!\n";
258 # Write header to file.
259 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
261 # Check if the enabled_rulefiles array contains any entries.
262 if (@enabled_rulefiles) {
263 # Loop through the array of rulefiles which should be loaded and write the to the file.
264 foreach my $file (@enabled_rulefiles) {
265 print FILE
"include \$RULE_PATH/$file\n";
269 # Close file after writing.
272 # Call oinkmaster to alter the ruleset.
275 # Download new ruleset.
276 } elsif ($cgiparams{'RULESET'} eq $Lang::tr
{'download new ruleset'}) {
277 # Check if the red device is active.
278 unless (-e
"${General::swroot}/red/active") {
279 $errormessage = $Lang::tr
{'could not download latest updates'};
282 # Call diskfree to gather the free disk space of /var.
283 my @df = `/bin/df -B M /var`;
285 # Loop through the output.
286 foreach my $line (@df) {
287 # Ignore header line.
288 next if $line =~ m/^Filesystem/;
290 # Search for a line with the device information.
291 if ($line =~ m/dev/ ) {
292 # Split the line into single pieces.
293 my @values = split(' ', $line);
294 my ($filesystem, $blocks, $used, $available, $used_perenctage, $mounted_on) = @values;
296 # Check if the available disk space is more than 300MB.
297 if ($available < 300) {
298 # If there is not enough space, print out an error message.
299 $errormessage = "$Lang::tr{'not enough disk space'} < 300MB, /var $1MB";
307 # Check if any errors happend.
308 unless ($errormessage) {
309 # Call subfunction to download the ruleset.
310 $errormessage = &downloadruleset
();
316 # Check if the downloader returend any error message.
317 unless ($errormessage) {
318 # Call subfunction to launch oinkmaster.
321 # Sleep for 1 seconds.
324 # Save snort settings.
325 } elsif ($cgiparams{'SNORT'} eq $Lang::tr
{'save'}) {
326 # Prevent form name from been stored in conf file.
327 delete $cgiparams{'SNORT'};
329 # Check if an oinkcode has been provided.
330 if ($cgiparams{'OINKCODE'}) {
331 # Check if the oinkcode contains unallowed chars.
332 unless ($cgiparams{'OINKCODE'} =~ /^[a-z0-9]+$/) {
333 $errormessage = $Lang::tr
{'invalid input for oink code'};
337 # Go on if there are no error messages.
338 if (!$errormessage) {
339 # Store settings into settings file.
340 &General
::writehash
("${General::swroot}/snort/settings", \
%cgiparams);
342 # Call snortctrl to restart snort
343 system('/usr/local/bin/snortctrl restart >/dev/null');
347 # Read-in snortsettings
348 &General
::readhash
("${General::swroot}/snort/settings", \
%snortsettings);
350 $checked{'ENABLE_SNORT'}{'off'} = '';
351 $checked{'ENABLE_SNORT'}{'on'} = '';
352 $checked{'ENABLE_SNORT'}{$snortsettings{'ENABLE_SNORT'}} = "checked='checked'";
353 $checked{'ENABLE_SNORT_GREEN'}{'off'} = '';
354 $checked{'ENABLE_SNORT_GREEN'}{'on'} = '';
355 $checked{'ENABLE_SNORT_GREEN'}{$snortsettings{'ENABLE_SNORT_GREEN'}} = "checked='checked'";
356 $checked{'ENABLE_SNORT_BLUE'}{'off'} = '';
357 $checked{'ENABLE_SNORT_BLUE'}{'on'} = '';
358 $checked{'ENABLE_SNORT_BLUE'}{$snortsettings{'ENABLE_SNORT_BLUE'}} = "checked='checked'";
359 $checked{'ENABLE_SNORT_ORANGE'}{'off'} = '';
360 $checked{'ENABLE_SNORT_ORANGE'}{'on'} = '';
361 $checked{'ENABLE_SNORT_ORANGE'}{$snortsettings{'ENABLE_SNORT_ORANGE'}} = "checked='checked'";
362 $selected{'RULES'}{'nothing'} = '';
363 $selected{'RULES'}{'community'} = '';
364 $selected{'RULES'}{'emerging'} = '';
365 $selected{'RULES'}{'registered'} = '';
366 $selected{'RULES'}{'subscripted'} = '';
367 $selected{'RULES'}{$snortsettings{'RULES'}} = "selected='selected'";
369 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
374 // Tiny java script function to show/hide the rules
375 // of a given category.
376 function showhide(tblname) {
377 \$("#" + tblname).toggle();
383 &Header
::openbigbox
('100%', 'left', '', $errormessage);
386 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
387 print "<class name='base'>$errormessage\n";
388 print " </class>\n";
392 &Header
::openbox
('100%', 'left', $Lang::tr
{'intrusion detection system'});
396 # Check if a ruleset allready has been downloaded.
397 if ( -f
"$rulestarball"){
398 # Call stat on the filename to obtain detailed information.
399 my @Info = stat("$rulestarball");
401 # Grab details about the creation time.
402 $rulesdate = localtime($Info[9]);
406 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
407 <table width='100%' border='0'>
409 <td class='base' width='25%'>
410 <input type='checkbox' name='ENABLE_SNORT' $checked{'ENABLE_SNORT'}{'on'}>RED Snort
413 <td class='base' width='25%'>
414 <input type='checkbox' name='ENABLE_SNORT_GREEN' $checked{'ENABLE_SNORT_GREEN'}{'on'}>GREEN Snort
417 <td class='base' width='25%'>
421 # Check if a blue device is configured.
422 if ($netsettings{'BLUE_DEV'}) {
423 print "<input type='checkbox' name='ENABLE_SNORT_BLUE' $checked{'ENABLE_SNORT_BLUE'}{'on'} />BLUE Snort\n";
428 print "<td width='25%'>\n";
430 # Check if an orange device is configured.
431 if ($netsettings{'ORANGE_DEV'}) {
432 print "<input type='checkbox' name='ENABLE_SNORT_ORANGE' $checked{'ENABLE_SNORT_ORANGE'}{'on'} />ORANGE Snort\n";
440 <td colspan='4'><br><br></td>
444 <td colspan='4'><b>$Lang::tr{'ids rules update'}</b></td>
448 <td colspan='4'><select name='RULES'>
449 <option value='nothing' $selected{'RULES'}{'nothing'} >$Lang::tr{'no'}</option>
450 <option value='emerging' $selected{'RULES'}{'emerging'} >$Lang::tr{'emerging rules'}</option>
451 <option value='community' $selected{'RULES'}{'community'} >$Lang::tr{'community rules'}</option>
452 <option value='registered' $selected{'RULES'}{'registered'} >$Lang::tr{'registered user rules'}</option>
453 <option value='subscripted' $selected{'RULES'}{'subscripted'} >$Lang::tr{'subscripted user rules'}</option>
460 <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>
461 <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>
466 <td colspan='4' nowrap='nowrap'>Oinkcode: <input type='text' size='40' name='OINKCODE' value='$snortsettings{'OINKCODE'}'></td>
470 <td colspan='4' align='left'><br>
471 <input type='submit' name='RULESET' value='$Lang::tr{'download new ruleset'}'> $Lang::tr{'updates installed'}: $rulesdate
481 <td align='right'><input type='submit' name='SNORT' value='$Lang::tr{'save'}' /></td>
490 &Header
::openbox
('100%', 'LEFT', $Lang::tr
{'intrusion detection system rules'});
491 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
493 # Output display table for rule files
494 print "<table width='100%'>\n";
496 # Local variable required for java script to show/hide
497 # rules of a rulefile.
498 my $rulesetcount = 1;
500 # Loop over each rule file
501 foreach my $rulefile (sort keys(%snortrules)) {
502 my $rulechecked = '';
504 # Check if rule file is enabled
505 if ($snortrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
506 $rulechecked = 'CHECKED';
509 # Table and rows for the rule files.
511 print"<td class='base' width='5%'>\n";
512 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
514 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
515 print"<td class='base' width='5%' align='right'>\n";
516 print"<a href=\"javascript:showhide('ruleset$rulesetcount')\">SHOW</a>\n";
520 # Rows which will be hidden per default and will contain the single rules.
521 print"<tr style='display:none' id='ruleset$rulesetcount'>\n";
522 print"<td colspan='3'>\n";
529 # New table for the single rules.
530 print "<table width='100%'>\n";
532 # Loop over rule file rules
533 foreach my $sid (sort {$a <=> $b} keys(%{$snortrules{$rulefile}})) {
535 my $ruledefchecked = '';
537 # Skip rulefile itself.
538 next if ($sid eq "Rulefile");
540 # If 2 rules have been displayed, start a new row
541 if (($lines % 2) == 0) {
544 # Increase rows by once.
550 $col="bgcolor='$color{'color20'}'";
552 $col="bgcolor='$color{'color22'}'";
556 if ($snortrules{$rulefile}{$sid}{'State'} eq 'on') {
557 $ruledefchecked = 'CHECKED';
560 # Create rule checkbox and display rule description
561 print "<td class='base' width='5%' align='right' $col>\n";
562 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
564 print "<td class='base' width='45%' $col>$snortrules{$rulefile}{$sid}{'Description'}</td>";
566 # Increment rule count
570 # If do not have a second rule for row, create empty cell
571 if (($lines % 2) != 0) {
572 print "<td class='base'></td>";
575 # Close display table
576 print "</tr></table></td></tr>";
578 # Finished whith the rule file, increase count.
582 # Close display table
588 <td width='100%' align='right'><input type='submit' name='RULESET' value='$Lang::tr{'update'}'>
589 <!-- space for future online help link -->
597 &Header
::closebigbox
();
598 &Header
::closepage
();
603 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
604 &Header
::openbigbox
('100%', 'left', '', $errormessage);
605 &Header
::openbox
( 'Waiting', 1, "<meta http-equiv='refresh' content='1'>" );
609 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
613 <td colspan='2' align='center'>
614 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
615 <input type='image' alt='$Lang::tr{'reload'}' title='$Lang::tr{'reload'}' src='/images/view-refresh.png' />
621 &Header
::closebigbox
();
622 &Header
::closepage
();
626 sub downloadruleset
{
627 # Read proxysettings.
628 my %proxysettings=();
629 &General
::readhash
("${General::swroot}/proxy/settings", \
%proxysettings);
631 # Load required perl module to handle the download.
634 # Init the download module.
635 my $downloader = LWP
::UserAgent
->new;
637 # Set timeout to 10 seconds.
638 $downloader->timeout(10);
640 # Check if an upstream proxy is configured.
641 if ($proxysettings{'UPSTREAM_PROXY'}) {
642 my ($peer, $peerport) = (/^(?:[a-zA-Z ]+\:\/\
/)?(?:[A-Za-z0-9\_\.\-]*?(?:\:[A-Za-z0-9\_\.\-]*?)?\@)?([a-zA-Z0-9\.\_\-]*?)(?:\:([0-9]{1,5}))?(?:\/.*?
)?
$/);
645 # Check if we got a peer.
647 $proxy_url = "http://";
649 # Check if the proxy requires authentication.
650 if (($proxysettings{'UPSTREAM_USER'}) && ($proxysettings{'UPSTREAM_PASSWORD'})) {
651 $proxy_url .= "$proxysettings{'UPSTREAM_USER'}\:$proxysettings{'UPSTREAM_PASSWORD'}\@";
654 # Add proxy server address and port.
655 $proxy_url .= "$peer\:$peerport";
657 # Break and return error message.
658 return "$Lang::tr{'could not download latest updates'}";
661 # Setup proxy settings.
662 $downloader->proxy('http', $proxy_url);
665 # Grab the right url based on the configured vendor.
666 my $url = $rulesetsources{$snortsettings{'RULES'}};
668 # Check if the vendor requires an oinkcode and add it if needed.
669 $url =~ s/\<oinkcode\>/$snortsettings{'OINKCODE'}/g;
671 # Abort if no url could be determined for the vendor.
673 # Abort and return errormessage.
674 return "$Lang::tr{'could not download latest updates'}";
677 # Pass the requested url to the downloader.
678 my $request = HTTP
::Request
->new(GET
=> $url);
680 # Perform the request and save the output into the "$rulestarball" file.
681 my $response = $downloader->request($request, $rulestarball);
683 # Check if there was any error.
684 unless ($response->is_success) {
685 return "$response->status_line";
688 # If we got here, everything worked fine. Return nothing.
693 # Call oinkmaster to generate ruleset.
694 system("/usr/local/bin/oinkmaster.pl -v -s -u file://$rulestarball -C /var/ipfire/snort/oinkmaster.conf -o /etc/snort/rules 2>&1 |logger -t oinkmaster");
697 sub readrulesfile
($) {
698 my $rulefile = shift;
700 # Open rule file and read in contents
701 open(RULEFILE
, "$snortrulepath/$rulefile") or die "Unable to read $rulefile!";
703 # Store file content in an array.
704 my @lines = <RULEFILE
>;
709 # Loop over rule file contents
710 foreach my $line (@lines) {
711 # Remove whitespaces.
715 next if ($line =~ /^\s*$/);
721 # Gather rule sid and message from the ruleline.
722 if ($line =~ m/.*msg:\"(.*?)\"\; .* sid:(.*?); /) {
726 # Check if a rule has been found.
728 # Add rule to the snortrules hash.
729 $snortrules{$rulefile}{$sid}{'Description'} = $msg;
731 # Grab status of the rule. Check if ruleline starts with a "dash".
732 if ($line =~ /^\#/) {
733 # If yes, the rule is disabled.
734 $snortrules{$rulefile}{$sid}{'State'} = "off";
736 # Otherwise the rule is enabled.
737 $snortrules{$rulefile}{$sid}{'State'} = "on";