Files
bpfire/html/cgi-bin/captive.cgi
2017-09-22 18:54:45 +01:00

561 lines
20 KiB
Perl
Executable File

#!/usr/bin/perl
###############################################################################
# #
# IPFire.org - A linux based firewall #
# Copyright (C) 2016 IPFire Team <alexander.marx@ipfire.org> #
# #
# This program is free software: you can redistribute it and/or modify #
# it under the terms of the GNU General Public License as published by #
# the Free Software Foundation, either version 3 of the License, or #
# (at your option) any later version. #
# #
# This program is distributed in the hope that it will be useful, #
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
# GNU General Public License for more details. #
# #
# You should have received a copy of the GNU General Public License #
# along with this program. If not, see <http://www.gnu.org/licenses/>. #
# #
###############################################################################
use strict;
use HTML::Entities();
# enable only the following on debugging purpose
#use warnings;
#use CGI::Carp 'fatalsToBrowser';
require '/var/ipfire/general-functions.pl';
require "${General::swroot}/lang.pl";
require "${General::swroot}/header.pl";
my %settings=();
my %mainsettings;
my %color;
my %cgiparams=();
my %netsettings=();
my %checked=();
my $errormessage='';
my $voucherout="${General::swroot}/captive/voucher_out";
my $clients="${General::swroot}/captive/clients";
my %voucherhash=();
my %clientshash=();
my $settingsfile="${General::swroot}/captive/settings";
unless (-e $settingsfile) { system("touch $settingsfile"); }
unless (-e $voucherout) { system("touch $voucherout"); }
&Header::getcgihash(\%cgiparams);
&General::readhash("${General::swroot}/main/settings", \%mainsettings);
&General::readhash("/srv/web/ipfire/html/themes/".$mainsettings{'THEME'}."/include/colors.txt", \%color);
&General::readhash("$settingsfile", \%settings) if(-f $settingsfile);
&General::readhash("${General::swroot}/ethernet/settings", \%netsettings);
&Header::showhttpheaders();
#actions
if ($cgiparams{'ACTION'} eq "$Lang::tr{'save'}"){
#saves the Captiveportal settings to disk
if ($cgiparams{'UNLIMITED'} eq 'on'){
$cgiparams{'EXP_HOUR'} = '0';
$cgiparams{'EXP_DAY'} = '0';
$cgiparams{'EXP_WEEK'} = '0';
$cgiparams{'EXP_MONTH'} = '0';
}
$settings{'ENABLE_GREEN'} = $cgiparams{'ENABLE_GREEN'};
$settings{'ENABLE_BLUE'} = $cgiparams{'ENABLE_BLUE'};
$settings{'AUTH'} = $cgiparams{'AUTH'};
$settings{'EXPIRE'} = $cgiparams{'EXP_HOUR'}+$cgiparams{'EXP_DAY'}+$cgiparams{'EXP_WEEK'}+$cgiparams{'EXP_MONTH'};
$settings{'EXP_HOUR'} = $cgiparams{'EXP_HOUR'};
$settings{'EXP_DAY'} = $cgiparams{'EXP_DAY'};
$settings{'EXP_WEEK'} = $cgiparams{'EXP_WEEK'};
$settings{'EXP_MONTH'} = $cgiparams{'EXP_MONTH'};
$settings{'TITLE'} = $cgiparams{'TITLE'};
$settings{'UNLIMITED'} = $cgiparams{'UNLIMITED'};
&General::writehash("$settingsfile", \%settings);
#write Licensetext if defined
if ($cgiparams{'AGB'}){
$cgiparams{'AGB'} = &Header::escape($cgiparams{'AGB'});
open( FH, ">:utf8", "/var/ipfire/captive/agb.txt" ) or die("$!");
print FH $cgiparams{'AGB'};
close( FH );
$cgiparams{'AGB'}="";
}
#execute binary to reload firewall rules
system("/usr/local/bin/captivectrl");
}
if ($cgiparams{'ACTION'} eq "$Lang::tr{'Captive voucherout'}"){
#generates a voucher and writes it to /var/ipfire/voucher_out
#check if we already have a voucher with same code
&General::readhasharray("$voucherout", \%voucherhash);
foreach my $key (keys %voucherhash) {
if($voucherhash{$key}[1] eq $cgiparams{'CODE'}){
$errormessage=$Lang::tr{'Captive err doublevoucher'};
last;
}
}
#check valid remark
if ($cgiparams{'REMARK'} ne '' && !&validremark($cgiparams{'REMARK'})){
$errormessage=$Lang::tr{'fwhost err remark'};
}
#if no error detected, write to disk
if (!$errormessage){
my $date=time(); #seconds in utc
#first get new key from hash
my $key=&General::findhasharraykey (\%voucherhash);
#initialize all fields with ''
foreach my $i (0 .. 3) { $voucherhash{$key}[$i] = "";}
#define fields
$voucherhash{$key}[0] = $date;
$voucherhash{$key}[1] = $cgiparams{'CODE'};
$voucherhash{$key}[2] = $settings{'EXPIRE'};
$voucherhash{$key}[3] = $cgiparams{'REMARK'};
#write values to disk
&General::writehasharray("$voucherout", \%voucherhash);
#now prepare log entry, get expiring date for voucher and decode remark for logfile
my $expdate=localtime(time()+$voucherhash{$key}[3]);
my $rem=HTML::Entities::decode_entities($voucherhash{$key}[4]);
#write logfile entry
&General::log("Captive", "Generated new voucher $voucherhash{$key}[1] $voucherhash{$key}[2] hours valid expires on $expdate remark $rem");
}
}
if ($cgiparams{'ACTION'} eq 'delvoucherout'){
#deletes an already generated but unused voucher
#read all generated vouchers
&General::readhasharray("$voucherout", \%voucherhash);
foreach my $key (keys %voucherhash) {
if($cgiparams{'key'} eq $voucherhash{$key}[0]){
#write logenty with decoded remark
my $rem=HTML::Entities::decode_entities($voucherhash{$key}[4]);
&General::log("Captive", "Delete unused voucher $voucherhash{$key}[1] $voucherhash{$key}[2] hours valid expires on $voucherhash{$key}[3] remark $rem");
#delete line from hash
delete $voucherhash{$key};
last;
}
}
#write back hash
&General::writehasharray("$voucherout", \%voucherhash);
}
if ($cgiparams{'ACTION'} eq 'delvoucherinuse'){
#delete voucher and connection in use
#read all active clients
&General::readhasharray("$clients", \%clientshash);
foreach my $key (keys %clientshash) {
if($cgiparams{'key'} eq $clientshash{$key}[0]){
#prepare log entry with decoded remark
my $rem=HTML::Entities::decode_entities($clientshash{$key}[7]);
#write logentry
&General::log("Captive", "Delete voucher in use $clientshash{$key}[1] $clientshash{$key}[2] hours valid expires on $clientshash{$key}[3] remark $rem - Connection will be terminated");
#delete line from hash
delete $clientshash{$key};
last;
}
}
#write back hash
&General::writehasharray("$clients", \%clientshash);
#reload firewallrules to kill connection of client
system("/usr/local/bin/captivectrl");
}
#open webpage, print header and open box
&Header::openpage($Lang::tr{'Captive menu'}, 1, '');
&Header::openbigbox();
#call error() to see if we have to print an errormessage on website
&error();
#call config() to display the configuration box
&config();
sub getagb(){
#open textfile from /var/ipfire/captive/agb.txt
open( my $handle, "<:utf8", "/var/ipfire/captive/agb.txt" ) or die("$!");
while(<$handle>){
#read line by line and print on screen
$cgiparams{'AGB'}.= HTML::Entities::decode_entities($_);
}
close( $handle );
}
sub config(){
#prints the config box on the website
&Header::openbox('100%', 'left', $Lang::tr{'Captive config'});
print <<END
<form method='post' action='$ENV{'SCRIPT_NAME'}'>\n
<table width='100%' border="0">
<tr>
END
;
#check which parameters have to be enabled (from settings file)
$checked{'ENABLE_GREEN'}{'off'} = '';
$checked{'ENABLE_GREEN'}{'on'} = '';
$checked{'ENABLE_GREEN'}{$settings{'ENABLE_GREEN'}} = "checked='checked'";
$checked{'ENABLE_BLUE'}{'off'} = '';
$checked{'ENABLE_BLUE'}{'on'} = '';
$checked{'ENABLE_BLUE'}{$settings{'ENABLE_BLUE'}} = "checked='checked'";
$checked{'UNLIMITED'}{'off'} = '';
$checked{'UNLIMITED'}{'on'} = '';
$checked{'UNLIMITED'}{$settings{'UNLIMITED'}} = "checked='checked'";
if ($netsettings{'GREEN_DEV'}){
print "<td width='30%'>$Lang::tr{'Captive active on'} <font color='$Header::colourgreen'>Green</font></td><td><input type='checkbox' name='ENABLE_GREEN' $checked{'ENABLE_GREEN'}{'on'} /></td></tr>";
}
if ($netsettings{'BLUE_DEV'}){
print "<td width='30%'>$Lang::tr{'Captive active on'} <font color='$Header::colourblue'>Blue</font></td><td><input type='checkbox' name='ENABLE_BLUE' $checked{'ENABLE_BLUE'}{'on'} /></td></tr>";
}
print<<END
</tr>
<tr>
<td><br>
$Lang::tr{'Captive title'}
</td>
<td><br>
<input type='text' name='TITLE' value="$settings{'TITLE'}" size='40'>
</td>
</tr>
END
;
print<<END
<tr>
<td>
$Lang::tr{'Captive authentication'}
</td>
<td>
<select name='AUTH' style='width:8em;'>
END
;
print "<option value='LICENSE' ";
print " selected='selected'" if ($settings{'AUTH'} eq 'LICENSE');
print ">$Lang::tr{'Captive auth_lic'}</option>";
print "<option value='VOUCHER' ";
print " selected='selected'" if ($settings{'AUTH'} eq 'VOUCHER');
print ">$Lang::tr{'Captive auth_vou'}</option>";
print<<END
</select>
</td>
</tr>
END
;
&agbbox();
print"<tr><td>$Lang::tr{'Captive vouchervalid'}</td><td>";
print "<br><table border='0' with=100%>";
print "<th>$Lang::tr{'hours'}</th><th>$Lang::tr{'days'}</th><th>$Lang::tr{'weeks'}</th><th>$Lang::tr{'months'}</th>";
#print hour-dropdownbox
my $hrs=3600;
print "<tr><td><select name='EXP_HOUR' style='width:8em;'>";
print "<option value='0' ";
print " selected='selected'" if ($settings{'EXP_HOUR'} eq '0');
print ">--</option>";
for (my $i = 1; $i<25; $i++){
my $exp_sec = $i * $hrs;
print "<option value='$exp_sec' ";
print " selected='selected'" if ($settings{'EXP_HOUR'} eq $exp_sec);
print ">$i</option>";
}
print "</td><td>";
#print day-dropdownbox
my $days=3600*24;
print "<select name='EXP_DAY' style='width:8em;'>";
print "<option value='0' ";
print " selected='selected'" if ($settings{'EXP_DAY'} eq '0');
print ">--</option>";
for (my $i = 1; $i<8; $i++){
my $exp_sec = $i * $days;
print "<option value='$exp_sec' ";
print " selected='selected'" if ($settings{'EXP_DAY'} eq $exp_sec);
print ">$i</option>";
}
print "</td><td>";
#print week-dropdownbox
my $week=3600*24*7;
print "<select name='EXP_WEEK' style='width:8em;'>";
print "<option value='0' ";
print " selected='selected'" if ($settings{'EXP_WEEK'} eq '0');
print ">--</option>";
for (my $i = 1; $i<5; $i++){
my $exp_sec = $i * $week;
print "<option value='$exp_sec' ";
print " selected='selected'" if ($settings{'EXP_WEEK'} eq $exp_sec);
print ">$i</option>";
}
print "</td><td>";
#print month-dropdownbox
my $month=3600*24*30;
print "<select name='EXP_MONTH' style='width:8em;'>";
print "<option value='0' ";
print " selected='selected'" if ($settings{'EXP_MONTH'} eq '0');
print ">--</option>";
for (my $i = 1; $i<13; $i++){
my $exp_sec = $i * $month;
print "<option value='$exp_sec' ";
print " selected='selected'" if ($settings{'EXP_MONTH'} eq $exp_sec);
print ">$i</option>";
}
print "</td>";
print "<td>&nbsp;&nbsp;&nbsp;<input type='checkbox' name='UNLIMITED' $checked{'UNLIMITED'}{'on'} /></td><td>&nbsp;<b>$Lang::tr{'Captive nolimit'}</b></td>";
print "</tr></table>";
print<<END
<tr>
<td>
</td>
<td align='right'>
<input type='submit' name='ACTION' value="$Lang::tr{'save'}"/>
</td>
</tr>
</table>
<br><br>
END
;
print "</form>";
&Header::closebox();
#if settings is set to use vouchers, the voucher part has to be displayed
if ($settings{'AUTH'} eq 'VOUCHER'){
&voucher();
}else{
#otherwise we show the licensepart
&show_license_connections();
}
}
sub agbbox(){
&getagb();
print<<END
<tr>
<td>
License agreement
</td>
<td>
<br>
<textarea cols="50" rows="10" name="AGB">$cgiparams{'AGB'}</textarea>
</td>
</tr>
END
;
}
sub gencode(){
#generate a random code only letters from A-Z except 'O' and 0-9
my @chars = ("A".."N", "P".."Z", "0".."9");
my $randomstring;
$randomstring .= $chars[rand @chars] for 1..8;
return $randomstring;
}
sub voucher(){
#show voucher part
#calculate expiredate
my $expire;
if ($settings{'UNLIMITED'} eq 'on'){
$expire = $Lang::tr{'Captive nolimit'};
}else{
$expire = sub{sprintf '%02d.%02d.%04d %02d:%02d', $_[3], $_[4]+1, $_[5]+1900, $_[2], $_[1] }->(localtime(time()+$settings{'EXPIRE'}));
}
&Header::openbox('100%', 'left', $Lang::tr{'Captive voucher'});
print<<END
<form method='post' action='$ENV{'SCRIPT_NAME'}'>
<table class='tbl'>
<tr>
<th align='center' width='20%'>$Lang::tr{'Captive voucher'}</th><th th align='center' width='25%'>$Lang::tr{'Captive expire'}</th><th align='center' width='55%'>$Lang::tr{'remark'}</th></tr>
END
;
$cgiparams{'CODE'} = &gencode();
print "<tr><td><center><b><font size='5'>$cgiparams{'CODE'}</font></b></center></td><td><center><font size='3'>$expire</font></center></td><td><input type='text' name='REMARK' align='left' size='80'></td></tr>";
print "</table><br>";
print "<center><input type='submit' name='ACTION' value='$Lang::tr{'Captive voucherout'}'><input type='hidden' name='CODE' value='$cgiparams{'CODE'}'</center></form>";
&Header::closebox();
if (! -z $voucherout) { &show_voucher_out();}
if (! -z $clients) { &show_voucher_in_use();}
}
sub show_license_connections(){
#if there are active clients, show the box with active connections
return if ( -z $clients || ! -f $clients );
my $count=0;
my $col;
&Header::openbox('100%', 'left', $Lang::tr{'Captive voactive'});
print<<END
<center><table class='tbl'>
<tr>
<th align='center' width='15%'>$Lang::tr{'Captive voucher'}</th><th th align='center' width='15%'>$Lang::tr{'Captive activated'}</th><th th align='center' width='15%'>$Lang::tr{'Captive expire'}</th><th align='center' width='50%'><font size='1'>$Lang::tr{'Captive mac'}</th><th th align='center' width='5%'>$Lang::tr{'delete'}</th></tr>
END
;
#read all clients from hash and show table
&General::readhasharray("$clients", \%clientshash);
foreach my $key (keys %clientshash){
my $starttime = sub{sprintf '%02d.%02d.%04d %02d:%02d', $_[3], $_[4]+1, $_[5]+1900, $_[2], $_[1] }->(localtime($clientshash{$key}[2]));
my $endtime;
if ($clientshash{$key}[3] eq '0'){
$endtime=$Lang::tr{'Captive nolimit'};
}else{
$endtime=sub{sprintf '%02d.%02d.%04d %02d:%02d', $_[3], $_[4]+1, $_[5]+1900, $_[2], $_[1] }->(localtime($clientshash{$key}[2]+$clientshash{$key}[3]));
}
if ($count % 2){
print" <tr>";
$col="bgcolor='$color{'color20'}'";
}else{
$col="bgcolor='$color{'color22'}'";
print" <tr>";
}
print "<td $col><center>$clientshash{$key}[4]</td><td $col><center>$starttime ";
print "</center></td><td $col><center>$endtime ";
print "</td><td $col><center>$clientshash{$key}[0]</td><td $col><form method='post'><center><input type='image' src='/images/delete.gif' align='middle' alt='$Lang::tr{'delete'}' title='$Lang::tr{'delete'}' /><form method='post'><input type='hidden' name='ACTION' value='delvoucherinuse' /><input type='hidden' name='key' value='$clientshash{$key}[0]' /></form></tr>";
$count++;
}
print "</table>";
&Header::closebox();
}
sub show_voucher_out(){
#if there are already generated but unsused vouchers, print a table
return if ( -z $voucherout);
my $count=0;
my $col;
&Header::openbox('100%', 'left', $Lang::tr{'Captive vout'});
print<<END
<center><table class='tbl' border='0'>
<tr>
<th align='center' width='15%'>$Lang::tr{'Captive voucher'}</th><th align='center' width='15%'>$Lang::tr{'date'}</th><th th align='center' width='15%'>$Lang::tr{'Captive expire'}</th><th align='center' width='60%'>$Lang::tr{'remark'}</th><th align='center' width='5%'>$Lang::tr{'delete'}</th></tr>
END
;
&General::readhasharray("$voucherout", \%voucherhash);
foreach my $key (keys %voucherhash)
{
my $starttime = sub{sprintf '%02d.%02d.%04d %02d:%02d', $_[3], $_[4]+1, $_[5]+1900, $_[2], $_[1] }->(localtime($voucherhash{$key}[0]));
my $endtime;
if ($voucherhash{$key}[2] eq '0'){
$endtime=$Lang::tr{'Captive nolimit'};
}else{
$endtime=sub{sprintf '%02d.%02d.%04d %02d:%02d', $_[3], $_[4]+1, $_[5]+1900, $_[2], $_[1] }->(localtime(time()+$voucherhash{$key}[2]));
}
if ($count % 2){
print" <tr>";
$col="bgcolor='$color{'color20'}'";
}else{
$col="bgcolor='$color{'color22'}'";
print" <tr>";
}
print "<td $col><center><b>$voucherhash{$key}[1]</b></td>";
print "<td $col><center>$starttime</td>";
print "<td $col><center>$endtime</td>";
print "<td $col align='center'>$voucherhash{$key}[3]</td>";
print "<td $col><form method='post'><center><input type='image' src='/images/delete.gif' align='middle' alt='$Lang::tr{'delete'}' title='$Lang::tr{'delete'}' /><form method='post'><input type='hidden' name='ACTION' value='delvoucherout' /><input type='hidden' name='key' value='$voucherhash{$key}[0]' /></form></tr>";
$count++;
}
print "</table>";
&Header::closebox();
}
sub show_voucher_in_use(){
#if there are active clients which use vouchers show table
return if ( -z $clients || ! -f $clients );
my $count=0;
my $col;
&Header::openbox('100%', 'left', $Lang::tr{'Captive voactive'});
print<<END
<center><table class='tbl' width='100%'>
<tr>
<th align='center' width='15%'>$Lang::tr{'Captive voucher'}</th><th th align='center' width='15%'>$Lang::tr{'Captive activated'}</th><th align='center' width='15%'>$Lang::tr{'Captive expire'}</th><th align='center' width='10%'>$Lang::tr{'Captive mac'}</th><th align='center' width='43%'>$Lang::tr{'remark'}</th><th th align='center' width='5%'>$Lang::tr{'delete'}</th></tr>
END
;
&General::readhasharray("$clients", \%clientshash);
foreach my $key (keys %clientshash)
{
#calculate time from clientshash (starttime)
my $starttime = sub{sprintf '%02d.%02d.%04d %02d:%02d', $_[3], $_[4]+1, $_[5]+1900, $_[2], $_[1] }->(localtime($clientshash{$key}[2]));
#calculate endtime from clientshash
my $endtime;
if ($clientshash{$key}[3] eq '0'){
$endtime=$Lang::tr{'Captive nolimit'};
}else{
$endtime = sub{sprintf '%02d.%02d.%04d %02d:%02d', $_[3], $_[4]+1, $_[5]+1900, $_[2], $_[1] }->(localtime($clientshash{$key}[2]+$clientshash{$key}[3]));
}
if ($count % 2){
print" <tr>";
$col="bgcolor='$color{'color20'}'";
}else{
$col="bgcolor='$color{'color22'}'";
print" <tr>";
}
print "<td $col><center><b>$clientshash{$key}[4]</b></td><td $col><center>$starttime ";
print "</center></td><td $col><center>$endtime</center></td><td $col><center>$clientshash{$key}[0]</td><td $col><center>$clientshash{$key}[5]</center>";
print "</td><td $col><form method='post'><center><input type='image' src='/images/delete.gif' align='middle' alt='$Lang::tr{'delete'}' title='$Lang::tr{'delete'}' /><form method='post'><input type='hidden' name='ACTION' value='delvoucherinuse' /><input type='hidden' name='key' value='$clientshash{$key}[0]' /></form></tr>";
$count++;
}
print "</table>";
&Header::closebox();
}
sub validremark
{
# Checks a hostname against RFC1035
my $remark = $_[0];
# Each part should be at least two characters in length
# but no more than 63 characters
if (length ($remark) < 1 || length ($remark) > 255) {
return 0;}
# Only valid characters are a-z, A-Z, 0-9 and -
if ($remark !~ /^[a-zäöüA-ZÖÄÜ0-9-.:;\|_()\/\s]*$/) {
return 0;}
# First character can only be a letter or a digit
if (substr ($remark, 0, 1) !~ /^[a-zäöüA-ZÖÄÜ0-9]*$/) {
return 0;}
# Last character can only be a letter or a digit
if (substr ($remark, -1, 1) !~ /^[a-zöäüA-ZÖÄÜ0-9.:;_)]*$/) {
return 0;}
return 1;
}
sub error{
#if an errormessage exits, show a box with errormessage
if ($errormessage) {
&Header::openbox('100%', 'left', $Lang::tr{'error messages'});
print "<class name='base'>$errormessage\n";
print "&nbsp;</class>\n";
&Header::closebox();
}
}
&Header::closebigbox();
&Header::closepage();