]>
git.ipfire.org Git - ipfire-2.x.git/blob - html/cgi-bin/guardian.cgi
2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2014 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 ###############################################################################
25 # enable only the following on debugging purpose
27 use CGI
::Carp
'fatalsToBrowser';
29 require '/var/ipfire/general-functions.pl';
30 require "${General::swroot}/lang.pl";
31 require "${General::swroot}/header.pl";
33 #workaround to suppress a warning when a variable is used only once
34 my @dummy = ( ${Header
::colouryellow
} );
43 # Path to the guardian.ignore file.
44 my $ignorefile ='/var/ipfire/guardian/guardian.ignore';
46 our %netsettings = ();
47 &General
::readhash
("${General::swroot}/ethernet/settings", \
%netsettings);
50 our %mainsettings = ();
51 &General
::readhash
("${General::swroot}/main/settings", \
%mainsettings);
52 &General
::readhash
("/srv/web/ipfire/html/themes/".$mainsettings{'THEME'}."/include/colors.txt", \
%color);
56 $settings{'GUARDIAN_ENABLED'} = 'off';
57 $settings{'GUARDIAN_ENABLE_SNORT'} = 'on';
58 $settings{'GUARDIAN_ENABLE_SSH'} = 'on';
59 $settings{'GUARDIAN_ENABLE_HTTPD'} = 'on';
60 $settings{'GUARDIAN_LOGLEVEL'} = 'info';
61 $settings{'GUARDIAN_BLOCKCOUNT'} = '3';
62 $settings{'GUARDIAN_BLOCKTIME'} = '86400';
63 $settings{'GUARDIAN_LOGFILE'} = '/var/log/guardian/guardian.log';
64 $settings{'GUARDIAN_SNORT_ALERTFILE'} = '/var/log/snort/alert';
66 $settings{'ACTION'} = '';
68 my $errormessage = '';
70 &Header
::showhttpheaders
();
73 &Header
::getcgihash
(\
%settings);
75 ## Perform input checks and save settings.
77 if ($settings{'ACTION'} eq $Lang::tr
{'save'}) {
78 # Check for valid blocktime.
79 if (! $settings{'GUARDIAN_BLOCKTIME'} =~ /^\d+$/) {
80 $errormessage = "$Lang::tr{'guardian invalid blocktime'}";
83 # Check if the bloccount is valid.
84 if (! $settings{'GUARDIAN_BLOCKCOUNT'} =~ /^\d+$/) {
85 $errormessage = "$Lang::tr{'guardian invalid blockcount'}";
89 if (! $settings{'GUARDIAN_LOGFILE'} =~ /^[a-zA-Z0-9\.\/]+$/) {
90 $errormessage = "$Lang::tr{'guardian invalid logfile'}";
93 # Check input for snort alert file.
94 if (! $settings{'GUARDIAN_SNORT_ALERTFILE'} =~ /^[a-zA-Z0-9\.\/]+$/) {
95 $errormessage = "$Lang::tr{'guardian invalid alertfile'}";
98 # Only continue if no error message has been set.
99 if ($errormessage eq '') {
100 # Write configuration settings to file.
101 &General
::writehash
("${General::swroot}/guardian/settings", \
%settings);
103 # Update configuration files.
104 &BuildConfiguration
();
107 ## Add a new entry to the ignore file.
109 } elsif ($settings{'ACTION'} eq $Lang::tr
{'add'}) {
111 # Check if any input has been performed.
112 if ($settings{'NEW_IGNORE_ENTRY'} ne '') {
114 # Check if the given input is no valid IP-address or IP-address with subnet, display an error message.
115 if ((!&General
::validip
($settings{'NEW_IGNORE_ENTRY'})) && (!&General
::validipandmask
($settings{'NEW_IGNORE_ENTRY'}))) {
116 $errormessage = "$Lang::tr{'guardian invalid address or subnet'}";
119 $errormessage = "$Lang::tr{'guardian empty input'}";
122 # Go further if there was no error.
123 if ($errormessage eq '') {
124 my $new_entry = $settings{'NEW_IGNORE_ENTRY'};
126 # Open file for appending the new entry.
127 open (FILE
, ">>$ignorefile") or die "Unable to open $ignorefile for writing";
129 # Write the new entry to the ignore file.
130 print FILE
"$new_entry\n";
134 ## Remove entry from ignore list.
136 } elsif ($settings{'ACTION'} eq $Lang::tr
{'remove'}) {
139 # Open ignorefile and read content.
140 open(FILE
, "<$ignorefile") or die "Unable to open $ignorefile.";
141 my @current = <FILE
>;
144 # Re-open ignorefile for writing.
145 open(FILE
, ">$ignorefile") or die "Unable to open $ignorefile for writing";
148 # Read line by line from ignorefile and write them back except the line with the given ID.
149 # So this line is missing in the new file and the entry has been deleted.
150 foreach my $line (@current) {
152 unless ($settings{'ID'} eq $id) {
158 ## Block a user given address or subnet.
160 } elsif ($settings{'ACTION'} eq $Lang::tr
{'block'}) {
162 # Check if no empty input has been performed.
163 if ($settings{'ADDRESS_BLOCK'} ne '') {
165 # Check if the given input is no valid IP-address or IP-address with subnet, display an error message.
166 if ((!&General
::validip
($settings{'ADDRESS_BLOCK'})) && (!&General
::validipandmask
($settings{'ADDRESS_BLOCK'}))) {
167 $errormessage = "$Lang::tr{'guardian invalid address or subnet'}";
171 $errormessage = "$Lang::tr{'guardian empty input'}";
174 # Go further if there was no error.
175 if ($errormessage eq '') {
176 my $block = $settings{'ADDRESS_BLOCK'};
178 # Call helper to unblock address.
179 system("/usr/local/bin/guardianctrl block $block &>/dev/null");
182 ## Unblock address or subnet.
184 } elsif ($settings{'ACTION'} eq $Lang::tr
{'unblock'}) {
186 # Check if no empty input has been performed.
187 if ($settings{'ADDRESS_UNBLOCK'} ne '') {
189 # Check if the given input is no valid IP-address or IP-address with subnet, display an error message.
190 if ((!&General
::validip
($settings{'ADDRESS_UNBLOCK'})) && (!&General
::validipandmask
($settings{'ADDRESS_UNBLOCK'}))) {
191 $errormessage = "$Lang::tr{'guardian invalid address or subnet'}";
195 $errormessage = "$Lang::tr{'guardian empty input'}";
198 # Go further if there was no error.
199 if ($errormessage eq '') {
200 my $unblock = $settings{'ADDRESS_UNBLOCK'};
202 # Call helper to unblock address.
203 system("/usr/local/bin/guardianctrl unblock $unblock &>/dev/null");
208 } elsif ($settings{'ACTION'} eq $Lang::tr
{'unblock all'}) {
210 # Call helper to flush iptables chain from guardian.
211 system("/usr/local/bin/guardianctrl flush-chain &>/dev/null");
214 # Load settings from file.
215 &General
::readhash
("${General::swroot}/guardian/settings", \
%settings);
219 # Call functions to generate whole page.
223 # Display area only if guardian is running.
224 if ( ($memory != 0) && (@pid[0] ne "///") ) {
228 # Function to display the status of guardian and allow base configuration.
233 $checked{'GUARDIAN_ENABLED'}{'on'} = '';
234 $checked{'GUARDIAN_ENABLED'}{'off'} = '';
235 $checked{'GUARDIAN_ENABLED'}{$settings{'GUARDIAN_ENABLED'}} = 'checked';
236 $checked{'GUARDIAN_ENABLE_SNORT'}{'off'} = '';
237 $checked{'GUARDIAN_ENABLE_SNORT'}{'on'} = '';
238 $checked{'GUARDIAN_ENABLE_SNORT'}{$settings{'GUARDIAN_ENABLE_SNORT'}} = "checked='checked'";
239 $checked{'GUARDIAN_ENABLE_SSH'}{'off'} = '';
240 $checked{'GUARDIAN_ENABLE_SSH'}{'on'} = '';
241 $checked{'GUARDIAN_ENABLE_SSH'}{$settings{'GUARDIAN_ENABLE_SSH'}} = "checked='checked'";
242 $checked{'GUARDIAN_ENABLE_HTTPD'}{'off'} = '';
243 $checked{'GUARDIAN_ENABLE_HTTPD'}{'on'} = '';
244 $checked{'GUARDIAN_ENABLE_HTTPD'}{$settings{'GUARDIAN_ENABLE_HTTPD'}} = "checked='checked'";
246 $selected{'GUARDIAN_LOGLEVEL'}{$settings{'GUARDIAN_LOGLEVEL'}}= 'selected';
248 &Header
::openpage
($Lang::tr
{'guardian configuration'}, 1, '');
249 &Header
::openbigbox
('100%', 'left', '', $errormessage);
251 # Print errormessage if there is one.
253 &Header
::openbox
('100%', 'left', $Lang::tr
{'error messages'});
254 print "<font class='base'>$errormessage </font>\n";
259 # Draw current guardian state.
260 &Header
::openbox
('100%', 'center', $Lang::tr
{'guardian'});
262 # Check if guardian is running and grab some stats.
265 # Display some useful information related to guardian, if daemon is running.
266 if ( ($memory != 0) && (@pid[0] ne "///") ){
268 <table width='95%' cellspacing='0' class='tbl'>
270 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'guardian service'}</strong></th>
273 <td class='base'>$Lang::tr{'guardian daemon'}</td>
274 <td align='center' colspan='2' width='75%' bgcolor='${Header::colourgreen}'><font color='white'><strong>$Lang::tr{'running'}</strong></font></td>
277 <td class='base'></td>
278 <td bgcolor='$color{'color20'}' align='center'><strong>PID</strong></td>
279 <td bgcolor='$color{'color20'}' align='center'><strong>$Lang::tr{'memory'}</strong></td>
282 <td class='base'></td>
283 <td bgcolor='$color{'color22'}' align='center'>@pid[0]</td>
284 <td bgcolor='$color{'color22'}' align='center'>$memory KB</td>
289 # Otherwise display a hint that the service is not launched.
291 <table width='95%' cellspacing='0' class='tbl'>
293 <th bgcolor='$color{'color20'}' colspan='3' align='left'><strong>$Lang::tr{'guardian service'}</strong></th>
296 <td class='base'>$Lang::tr{'guardian daemon'}</td>
297 <td align='center' width='75%' bgcolor='${Header::colourred}'><font color='white'><strong>$Lang::tr{'stopped'}</strong></font></td>
305 # Draw elements for guardian configuration.
306 &Header
::openbox
('100%', 'center', $Lang::tr
{'guardian configuration'});
309 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
313 <td colspan='2' class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'guardian common settings'}</b></td>
316 <td width='20%' class='base'>$Lang::tr{'guardian enabled'}:</td>
317 <td><input type='checkbox' name='GUARDIAN_ENABLED' $checked{'GUARDIAN_ENABLED'}{'on'} /></td>
320 <td colspan='2'><br></td>
323 <td width='20%' class='base'>$Lang::tr{'guardian watch snort alertfile'}</td>
324 <td align='left'>on <input type='radio' name='GUARDIAN_ENABLE_SNORT' value='on' $checked{'GUARDIAN_ENABLE_SNORT'}{'on'} /> /
325 <input type='radio' name='GUARDIAN_ENABLE_SNORT' value='off' $checked{'GUARDIAN_ENABLE_SNORT'}{'off'} /> off</td>
328 <td width='20%' class='base'>$Lang::tr{'guardian block ssh brute-force'}</td>
329 <td align='left'>on <input type='radio' name='GUARDIAN_ENABLE_SSH' value='on' $checked{'GUARDIAN_ENABLE_SSH'}{'on'} /> /
330 <input type='radio' name='GUARDIAN_ENABLE_SSH' value='off' $checked{'GUARDIAN_ENABLE_SSH'}{'off'} /> off</td>
333 <td width='20%' class='base'>$Lang::tr{'guardian block httpd brute-force'}</td>
334 <td align='left'>on <input type='radio' name='GUARDIAN_ENABLE_HTTPD' value='on' $checked{'GUARDIAN_ENABLE_HTTPD'}{'on'} /> /
335 <input type='radio' name='GUARDIAN_ENABLE_HTTPD' value='off' $checked{'GUARDIAN_ENABLE_HTTPD'}{'off'} /> off</td>
338 <td colspan='2'><br></td>
341 <td align='left' width='20%'>$Lang::tr{'guardian loglevel'}:</td>
342 <td><select name='GUARDIAN_LOGLEVEL'>
343 <option value='off' $selected{'GUARDIAN_LOGLEVEL'}{'off'}>off</option>
344 <option value='info' $selected{'GUARDIAN_LOGLEVEL'}{'info'}>info</option>
345 <option value='debug' $selected{'GUARDIAN_LOGLEVEL'}{'debug'}>debug</option>
349 <td colspan='2'><br></td>
352 <td width='20%' class='base'>$Lang::tr{'guardian blockcount'}:</td>
353 <td><input type='text' name='GUARDIAN_BLOCKCOUNT' value='$settings{'GUARDIAN_BLOCKCOUNT'}' size='5' /></td>
356 <td width='20%' class='base'>$Lang::tr{'guardian blocktime'}:</td>
357 <td><input type='text' name='GUARDIAN_BLOCKTIME' value='$settings{'GUARDIAN_BLOCKTIME'}' size='10' /></td>
360 <td width='20%' class='base'>$Lang::tr{'guardian logfile'}:</td>
361 <td><input type='text' name='GUARDIAN_LOGFILE' value='$settings{'GUARDIAN_LOGFILE'}' size='30' /></td>
364 <td width='20%' class='base'>$Lang::tr{'guardian snort alertfile'}:</td>
365 <td><input type='text' name='GUARDIAN_SNORT_ALERTFILE' value='$settings{'GUARDIAN_SNORT_ALERTFILE'}' size='30' /></td>
376 <td align='center'><input type='submit' name='ACTION' value='$Lang::tr{'save'}' /></td>
386 # Function to show elements of the guardian ignorefile and allow to add or remove single members of it.
387 sub showIgnoreBox
() {
388 &Header
::openbox
('100%', 'center', $Lang::tr
{'guardian ignored hosts'});
393 <td colspan='2' class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'guardian ignored hosts'}</b></td>
396 # Check if the guardian ignore file contains any content.
397 if (-s
$ignorefile) {
399 # Open file and print contents.
400 open FILE
, $ignorefile or die "Could not open $ignorefile";
405 # Read file line by line and print out the elements.
406 while( my $ignored_element = <FILE
> ) {
408 # Increase id number for each element in the ignore file.
411 # Check if the id number is even or not.
413 $col="bgcolor='$color{'color22'}'";
415 $col="bgcolor='$color{'color20'}'";
420 <td width='80%' class='base' $col>$ignored_element</td>
421 <td width='20%' align='center' $col>
422 <form method='post' name='$id' action='$ENV{'SCRIPT_NAME'}'>
423 <input type='image' name='$Lang::tr{'remove'}' src='/images/delete.gif' title='$Lang::tr{'remove'}' alt='$Lang::tr{'remove'}'>
424 <input type='hidden' name='ID' value='$id'>
425 <input type='hidden' name='ACTION' value='$Lang::tr{'remove'}'>
433 # Print notice that currently no elements are stored in the ignore file.
435 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
441 # Section to add new elements to the ignore list.
446 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
448 <td width='30%'>$Lang::tr{'dnsforward add a new entry'}: </td>
449 <td width='50%'><input type='text' name='NEW_IGNORE_ENTRY' value='' size='24' /></td>
450 <td align='center' width='20%'><input type='submit' name='ACTION' value='$Lang::tr{'add'}' /></td>
460 # Function to list currently bocked addresses from guardian and unblock them or add custom entries to block.
461 sub showBlockedBox
() {
462 &Header
::openbox
('100%', 'center', $Lang::tr
{'guardian blocked hosts'});
467 <td colspan='2' class='base' bgcolor='$color{'color20'}'><b>$Lang::tr{'guardian blocked hosts'}</b></td>
471 # Lauch function to get the currently blocked hosts.
472 my @blocked_hosts = &GetBlockedHosts
();
477 # Loop through our blocked hosts array.
478 foreach my $blocked_host (@blocked_hosts) {
480 # Increase id number for each element in the ignore file.
483 # Check if the id number is even or not.
485 $col="bgcolor='$color{'color22'}'";
487 $col="bgcolor='$color{'color20'}'";
492 <td width='80%' class='base' $col><a href='/cgi-bin/ipinfo.cgi?ip=$blocked_host'>$blocked_host</a></td>
493 <td width='20%' align='center' $col>
494 <form method='post' name='frmb$id' action='$ENV{'SCRIPT_NAME'}'>
495 <input type='image' name='$Lang::tr{'unblock'}' src='/images/delete.gif' title='$Lang::tr{'unblock'}' alt='$Lang::tr{'unblock'}'>
496 <input type='hidden' name='ADDRESS_UNBLOCK' value='$blocked_host'>
497 <input type='hidden' name='ACTION' value='$Lang::tr{'unblock'}'>
504 # If the loop only has been runs once the id still is "0", which means there are no
505 # additional entries (blocked hosts) in the iptables chain.
508 # Print notice that currently no hosts are blocked.
510 print "<td class='base' colspan='2'>$Lang::tr{'guardian no entries'}</td>\n";
516 # Section for a manual block of an IP-address.
520 <table width='60%' border='0'>
521 <form method='post' action='$ENV{'SCRIPT_NAME'}'>
523 <td width='30%'>$Lang::tr{'guardian block a host'}: </td>
524 <td width='40%'><input type='text' name='ADDRESS_BLOCK' value='' size='24' /></td>
525 <td align='center' width='15%'><input type='submit' name='ACTION' value='$Lang::tr{'block'}'></td>
526 <td align='center' width='15%'><input type='submit' name='ACTION' value='$Lang::tr{'unblock all'}'></td>
536 &Header
::closebigbox
();
537 &Header
::closepage
();
539 # Function to check if guardian has been started.
540 # Grab process id and consumed memory if the daemon is running.
544 open(FILE
, '/usr/local/bin/addonctrl guardian status | ');
547 $string = join("", @guardian);
548 $string =~ s/[a-z_]//gi;
549 $string =~ s/\[[0-1]\;[0-9]+//gi;
550 $string =~ s/[\(\)\.]//gi;
553 @pid = split(/\s/,$string);
554 if (open(FILE
, "/proc/$pid[0]/statm")){
556 @memory = split(/ /,$temp);
562 sub GetBlockedHosts
() {
564 # Create new, empty array.
567 # Lauch helper to get chains from iptables.
568 open(FILE
, "/usr/local/bin/guardianctrl get-chain |");
570 # Read file line by line and print out the elements.
571 foreach my $line (<FILE
>) {
573 # Skip descriptive lines.
574 next if ($line =~ /^Chain/);
575 next if ($line =~ /^ pkts/);
577 # Generate array, based on the line content (seperator is a single or multiple space's)
578 my @comps = split(/\s{1,}/, $line);
579 my ($lead, $pkts, $bytes, $target, $prot, $opt, $in, $out, $source, $destination) = @comps;
581 # Assign different variable names.
582 my $blocked_host = $source;
584 # Add host to our hosts array.
585 push(@hosts, $blocked_host);
588 # Convert entries, sort them, write back and store the sorted entries into new array.
589 my @sorted = map { $_->[0] }
590 sort { $a->[1] <=> $b->[1] }
591 map { [$_, int sprintf("%03.f%03.f%03.f%03.f", split(/\./, $_))] }
594 # Return our sorted list.
598 sub BuildConfiguration
() {
600 &General
::readhash
("${General::swroot}/guardian/settings", \
%settings);
602 my $configfile = "${General::swroot}/guardian/guardian.conf";
604 # We set this to 1 (enabled) to prevent guardian from blocking the ISP gateway.
605 my $HostGatewayByte = "1";
607 # Open configfile for writing.
608 open(FILE
, ">$configfile");
610 print FILE
"EnableSnortMonitoring $settings{'GUARDIAN_ENABLE_SNORT'}\n";
611 print FILE
"EnableSSHMonitoring $settings{'GUARDIAN_ENABLE_SSH'}\n";
612 print FILE
"EnableHTTPDMonitoring $settings{'GUARDIAN_ENABLE_HTTPD'}\n";
613 print FILE
"LogLevel $settings{'GUARDIAN_LOGLEVEL'}\n";
614 print FILE
"BlockCount $settings{'GUARDIAN_BLOCKCOUNT'}\n";
615 print FILE
"HostGatewayByte $HostGatewayByte\n";
616 print FILE
"LogFile $settings{'GUARDIAN_LOGFILE'}\n";
617 print FILE
"AlertFile $settings{'GUARDIAN_SNORT_ALERTFILE'}\n";
618 print FILE
"IgnoreFile $ignorefile\n";
619 print FILE
"TimeLimit $settings{'GUARDIAN_BLOCKTIME'}\n";
623 # Restart the service.
624 if ($settings{'GUARDIAN_ENABLED'} eq 'on') {
625 system("/usr/local/bin/guardianctrl restart &>/dev/null");
627 system("/usr/local/bin/guardianctrl stop &>/dev/null");