]>
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 my $snortrulepath = "/etc/snort/rules";
51 my $snortusedrulefilesfile = "${General::swroot}/snort/snort-used-rulefiles.conf";
54 &Header
::showhttpheaders
();
56 # Default settings for snort.
57 $snortsettings{'ENABLE_SNORT'} = 'off';
58 $snortsettings{'ENABLE_SNORT_GREEN'} = 'off';
59 $snortsettings{'ENABLE_SNORT_BLUE'} = 'off';
60 $snortsettings{'ENABLE_SNORT_ORANGE'} = 'off';
61 $snortsettings{'RULES'} = '';
62 $snortsettings{'OINKCODE'} = '';
65 &Header
::getcgihash
(\
%cgiparams);
67 # Try to determine if oinkmaster is running.
68 my $oinkmaster_pid = `pidof oinkmaster.pl -x`;
70 # If oinkmaster is running display output.
71 if ($oinkmaster_pid) {
72 &working
("$Lang::tr{'snort working'}");
75 ## Grab all available snort rules and store them in the snortrules hash.
77 # Open snort rules directory and do a directory listing.
78 opendir(DIR
, $snortrulepath) or die $!;
79 # Loop through the direcory.
80 while (my $file = readdir(DIR
)) {
83 next unless (-f
"$snortrulepath/$file");
86 next if (-z
"$snortrulepath/$file");
88 # Use a regular expression to find files ending in .rules
89 next unless ($file =~ m/\.rules$/);
91 # Ignore files which are not read-able.
92 next unless (-R
"$snortrulepath/$file");
94 # Call subfunction to read-in rulefile and add rules to
95 # the snortrules hash.
96 &readrulesfile
("$file");
101 # Gather used rulefiles.
103 # Check if the file for activated rulefiles is not empty.
104 if(-f
$snortusedrulefilesfile) {
105 # Open the file for used rulefile and read-in content.
106 open(FILE
, $snortusedrulefilesfile) or die "Could not open $snortusedrulefilesfile. $!\n";
114 # Loop through the array.
115 foreach my $line (@lines) {
120 next if ($line =~ /\#/);
123 next if ($line =~ /^\s*$/);
125 # Gather rule sid and message from the ruleline.
126 if ($line =~ /.*include \$RULE_PATH\/(.*)/) {
129 # Add the rulefile to the %snortrules hash.
130 $snortrules{$rulefile}{'Rulefile'}{'State'} = "on";
136 if ($cgiparams{'RULESET'} eq $Lang::tr
{'update'}) {
137 my $enabled_sids_file = "${General::swroot}/snort/oinkmaster-enabled-sids.conf";
138 my $disabled_sids_file = "${General::swroot}/snort/oinkmaster-disabled-sids.conf";
140 # Arrays to store sid which should be added to the corresponding files.
143 my @enabled_rulefiles;
145 # Loop through the hash of snortrules.
146 foreach my $rulefile(keys %snortrules) {
147 # Check if the rulefile is enabled.
148 if ($cgiparams{$rulefile} eq "on") {
149 # Add rulefile to the array of enabled rulefiles.
150 push(@enabled_rulefiles, $rulefile);
152 # Drop item from cgiparams hash.
153 delete $cgiparams{$rulefile};
157 # Loop through the hash of snortrules.
158 foreach my $rulefile (keys %snortrules) {
159 # Loop through the single rules of the rulefile.
160 foreach my $sid (keys %{$snortrules{$rulefile}}) {
161 # Skip the current sid if it is not numeric.
162 next unless ($sid =~ /\d+/ );
164 # Check if there exists a key in the cgiparams hash for this sid.
165 if (exists($cgiparams{$sid})) {
166 # Look if the rule is disabled.
167 if ($snortrules{$rulefile}{$sid}{'State'} eq "off") {
168 # Check if the state has been set to 'on'.
169 if ($cgiparams{$sid} eq "on") {
170 # Add the sid to the enabled_sids array.
171 push(@enabled_sids, $sid);
173 # Drop item from cgiparams hash.
174 delete $cgiparams{$rulefile}{$sid};
178 # Look if the rule is enabled.
179 if ($snortrules{$rulefile}{$sid}{'State'} eq "on") {
180 # Check if the state is 'on' and should be disabled.
181 # In this case there is no entry
182 # for the sid in the cgiparams hash.
183 # Add it to the disabled_sids array.
184 push(@disabled_sids, $sid);
186 # Drop item from cgiparams hash.
187 delete $cgiparams{$rulefile}{$sid};
193 # Open enabled sid's file for writing.
194 open(FILE
, ">$enabled_sids_file") or die "Could not write to $enabled_sids_file. $!\n";
196 # Write header to file.
197 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
199 # Check if the enabled_sids array contains any sid's.
201 # Loop through the array of enabled sids and write them to the file.
202 foreach my $sid (@enabled_sids) {
203 print FILE
"enablesid $sid\n";
207 # Close file after writing.
210 # Open disabled sid's file for writing.
211 open(FILE
, ">$disabled_sids_file") or die "Could not write to $disabled_sids_file. $!\n";
213 # Write header to file.
214 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
216 # Check if the enabled_sids array contains any sid's.
217 if (@disabled_sids) {
218 # Loop through the array of disabled sids and write them to the file.
219 foreach my $sid (@disabled_sids) {
220 print FILE
"disablesid $sid\n";
224 # Close file after writing.
227 # Open file for used rulefiles.
228 open (FILE
, ">$snortusedrulefilesfile") or die "Could not write to $snortusedrulefilesfile. $!\n";
230 # Write header to file.
231 print FILE
"#Autogenerated file. Any custom changes will be overwritten!\n";
233 # Check if the enabled_rulefiles array contains any entries.
234 if (@enabled_rulefiles) {
235 # Loop through the array of rulefiles which should be loaded and write the to the file.
236 foreach my $file (@enabled_rulefiles) {
237 print FILE
"include \$RULE_PATH/$file\n";
241 # Close file after writing.
244 # Call oinkmaster to alter the ruleset.
247 # Download new ruleset.
248 } elsif ($cgiparams{'RULESET'} eq $Lang::tr
{'download new ruleset'}) {
249 # Check if the red device is active.
250 unless (-e
"${General::swroot}/red/active") {
251 $errormessage = $Lang::tr
{'could not download latest updates'};
254 # Check if there is enought free disk space available.
255 $errormessage = &IDS
::checkdiskspace
();
257 # Check if any errors happend.
258 unless ($errormessage) {
259 # Call subfunction to download the ruleset.
260 $errormessage = &IDS
::downloadruleset
();
266 # Check if the downloader returend any error message.
267 unless ($errormessage) {
268 # Call subfunction to launch oinkmaster.
271 # Sleep for 1 seconds.
274 # Save snort settings.
275 } elsif ($cgiparams{'SNORT'} eq $Lang::tr
{'save'}) {
276 # Prevent form name from been stored in conf file.
277 delete $cgiparams{'SNORT'};
279 # Check if an oinkcode has been provided.
280 if ($cgiparams{'OINKCODE'}) {
281 # Check if the oinkcode contains unallowed chars.
282 unless ($cgiparams{'OINKCODE'} =~ /^[a-z0-9]+$/) {
283 $errormessage = $Lang::tr
{'invalid input for oink code'};
287 # Go on if there are no error messages.
288 if (!$errormessage) {
289 # Store settings into settings file.
290 &General
::writehash
("${General::swroot}/snort/settings", \
%cgiparams);
292 # Call snortctrl to restart snort
293 system('/usr/local/bin/snortctrl restart >/dev/null');
297 # Read-in snortsettings
298 &General
::readhash
("${General::swroot}/snort/settings", \
%snortsettings);
300 $checked{'ENABLE_SNORT'}{'off'} = '';
301 $checked{'ENABLE_SNORT'}{'on'} = '';
302 $checked{'ENABLE_SNORT'}{$snortsettings{'ENABLE_SNORT'}} = "checked='checked'";
303 $checked{'ENABLE_SNORT_GREEN'}{'off'} = '';
304 $checked{'ENABLE_SNORT_GREEN'}{'on'} = '';
305 $checked{'ENABLE_SNORT_GREEN'}{$snortsettings{'ENABLE_SNORT_GREEN'}} = "checked='checked'";
306 $checked{'ENABLE_SNORT_BLUE'}{'off'} = '';
307 $checked{'ENABLE_SNORT_BLUE'}{'on'} = '';
308 $checked{'ENABLE_SNORT_BLUE'}{$snortsettings{'ENABLE_SNORT_BLUE'}} = "checked='checked'";
309 $checked{'ENABLE_SNORT_ORANGE'}{'off'} = '';
310 $checked{'ENABLE_SNORT_ORANGE'}{'on'} = '';
311 $checked{'ENABLE_SNORT_ORANGE'}{$snortsettings{'ENABLE_SNORT_ORANGE'}} = "checked='checked'";
312 $selected{'RULES'}{'nothing'} = '';
313 $selected{'RULES'}{'community'} = '';
314 $selected{'RULES'}{'emerging'} = '';
315 $selected{'RULES'}{'registered'} = '';
316 $selected{'RULES'}{'subscripted'} = '';
317 $selected{'RULES'}{$snortsettings{'RULES'}} = "selected='selected'";
319 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
324 // Tiny java script function to show/hide the rules
325 // of a given category.
326 function showhide(tblname) {
327 \$("#" + tblname).toggle();
333 &Header
::openbigbox
('100%', 'left', '', $errormessage);
336 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
337 print "<class name='base'>$errormessage\n";
338 print " </class>\n";
342 &Header
::openbox
('100%', 'left', $Lang::tr
{'intrusion detection system'});
346 # Check if a ruleset allready has been downloaded.
347 if ( -f
"$IDS::rulestarball"){
348 # Call stat on the filename to obtain detailed information.
349 my @Info = stat("$IDS::rulestarball");
351 # Grab details about the creation time.
352 $rulesdate = localtime($Info[9]);
356 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
357 <table width='100%' border='0'>
359 <td class='base' width='25%'>
360 <input type='checkbox' name='ENABLE_SNORT' $checked{'ENABLE_SNORT'}{'on'}>RED Snort
363 <td class='base' width='25%'>
364 <input type='checkbox' name='ENABLE_SNORT_GREEN' $checked{'ENABLE_SNORT_GREEN'}{'on'}>GREEN Snort
367 <td class='base' width='25%'>
371 # Check if a blue device is configured.
372 if ($netsettings{'BLUE_DEV'}) {
373 print "<input type='checkbox' name='ENABLE_SNORT_BLUE' $checked{'ENABLE_SNORT_BLUE'}{'on'} />BLUE Snort\n";
378 print "<td width='25%'>\n";
380 # Check if an orange device is configured.
381 if ($netsettings{'ORANGE_DEV'}) {
382 print "<input type='checkbox' name='ENABLE_SNORT_ORANGE' $checked{'ENABLE_SNORT_ORANGE'}{'on'} />ORANGE Snort\n";
390 <td colspan='4'><br><br></td>
394 <td colspan='4'><b>$Lang::tr{'ids rules update'}</b></td>
398 <td colspan='4'><select name='RULES'>
399 <option value='nothing' $selected{'RULES'}{'nothing'} >$Lang::tr{'no'}</option>
400 <option value='emerging' $selected{'RULES'}{'emerging'} >$Lang::tr{'emerging rules'}</option>
401 <option value='community' $selected{'RULES'}{'community'} >$Lang::tr{'community rules'}</option>
402 <option value='registered' $selected{'RULES'}{'registered'} >$Lang::tr{'registered user rules'}</option>
403 <option value='subscripted' $selected{'RULES'}{'subscripted'} >$Lang::tr{'subscripted user rules'}</option>
410 <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>
411 <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>
416 <td colspan='4' nowrap='nowrap'>Oinkcode: <input type='text' size='40' name='OINKCODE' value='$snortsettings{'OINKCODE'}'></td>
420 <td colspan='4' align='left'><br>
421 <input type='submit' name='RULESET' value='$Lang::tr{'download new ruleset'}'> $Lang::tr{'updates installed'}: $rulesdate
431 <td align='right'><input type='submit' name='SNORT' value='$Lang::tr{'save'}' /></td>
440 &Header
::openbox
('100%', 'LEFT', $Lang::tr
{'intrusion detection system rules'});
441 print"<form method='POST' action='$ENV{'SCRIPT_NAME'}'>\n";
443 # Output display table for rule files
444 print "<table width='100%'>\n";
446 # Local variable required for java script to show/hide
447 # rules of a rulefile.
448 my $rulesetcount = 1;
450 # Loop over each rule file
451 foreach my $rulefile (sort keys(%snortrules)) {
452 my $rulechecked = '';
454 # Check if rule file is enabled
455 if ($snortrules{$rulefile}{'Rulefile'}{'State'} eq 'on') {
456 $rulechecked = 'CHECKED';
459 # Table and rows for the rule files.
461 print"<td class='base' width='5%'>\n";
462 print"<input type='checkbox' name='$rulefile' $rulechecked>\n";
464 print"<td class='base' width='90%'><b>$rulefile</b></td>\n";
465 print"<td class='base' width='5%' align='right'>\n";
466 print"<a href=\"javascript:showhide('ruleset$rulesetcount')\">SHOW</a>\n";
470 # Rows which will be hidden per default and will contain the single rules.
471 print"<tr style='display:none' id='ruleset$rulesetcount'>\n";
472 print"<td colspan='3'>\n";
479 # New table for the single rules.
480 print "<table width='100%'>\n";
482 # Loop over rule file rules
483 foreach my $sid (sort {$a <=> $b} keys(%{$snortrules{$rulefile}})) {
485 my $ruledefchecked = '';
487 # Skip rulefile itself.
488 next if ($sid eq "Rulefile");
490 # If 2 rules have been displayed, start a new row
491 if (($lines % 2) == 0) {
494 # Increase rows by once.
500 $col="bgcolor='$color{'color20'}'";
502 $col="bgcolor='$color{'color22'}'";
506 if ($snortrules{$rulefile}{$sid}{'State'} eq 'on') {
507 $ruledefchecked = 'CHECKED';
510 # Create rule checkbox and display rule description
511 print "<td class='base' width='5%' align='right' $col>\n";
512 print "<input type='checkbox' NAME='$sid' $ruledefchecked>\n";
514 print "<td class='base' width='45%' $col>$snortrules{$rulefile}{$sid}{'Description'}</td>";
516 # Increment rule count
520 # If do not have a second rule for row, create empty cell
521 if (($lines % 2) != 0) {
522 print "<td class='base'></td>";
525 # Close display table
526 print "</tr></table></td></tr>";
528 # Finished whith the rule file, increase count.
532 # Close display table
538 <td width='100%' align='right'><input type='submit' name='RULESET' value='$Lang::tr{'update'}'>
539 <!-- space for future online help link -->
547 &Header
::closebigbox
();
548 &Header
::closepage
();
553 &Header
::openpage
($Lang::tr
{'intrusion detection system'}, 1, '');
554 &Header
::openbigbox
('100%', 'left', '', $errormessage);
555 &Header
::openbox
( 'Waiting', 1, "<meta http-equiv='refresh' content='1'>" );
559 <td><img src='/images/indicator.gif' alt='$Lang::tr{'aktiv'}' /></td>
563 <td colspan='2' align='center'>
564 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
565 <input type='image' alt='$Lang::tr{'reload'}' title='$Lang::tr{'reload'}' src='/images/view-refresh.png' />
571 &Header
::closebigbox
();
572 &Header
::closepage
();
577 ## Private function to read-in and parse rules of a given rulefile.
579 ## The given file will be read, parsed and all valid rules will be stored by ID,
580 ## message/description and it's state in the snortrules hash.
582 sub readrulesfile
($) {
583 my $rulefile = shift;
585 # Open rule file and read in contents
586 open(RULEFILE
, "$snortrulepath/$rulefile") or die "Unable to read $rulefile!";
588 # Store file content in an array.
589 my @lines = <RULEFILE
>;
594 # Loop over rule file contents
595 foreach my $line (@lines) {
596 # Remove whitespaces.
600 next if ($line =~ /^\s*$/);
606 # Gather rule sid and message from the ruleline.
607 if ($line =~ m/.*msg:\"(.*?)\"\; .* sid:(.*?); /) {
611 # Check if a rule has been found.
613 # Add rule to the snortrules hash.
614 $snortrules{$rulefile}{$sid}{'Description'} = $msg;
616 # Grab status of the rule. Check if ruleline starts with a "dash".
617 if ($line =~ /^\#/) {
618 # If yes, the rule is disabled.
619 $snortrules{$rulefile}{$sid}{'State'} = "off";
621 # Otherwise the rule is enabled.
622 $snortrules{$rulefile}{$sid}{'State'} = "on";