pfSense

<?php

/*

	captiveportal.inc

	part of m0n0wall (http://m0n0.ch/wall)

	Copyright (C) 2003-2006 Manuel Kasper <mk@neon1.net>.

	All rights reserved.

	Redistribution and use in source and binary forms, with or without

	modification, are permitted provided that the following conditions are met:

	1. Redistributions of source code must retain the above copyright notice,

	   this list of conditions and the following disclaimer.

	2. Redistributions in binary form must reproduce the above copyright

	   notice, this list of conditions and the following disclaimer in the

	   documentation and/or other materials provided with the distribution.

	THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,

	INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY

	AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE

	AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,

	OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

	SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

	INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

	CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

	ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

	POSSIBILITY OF SUCH DAMAGE.

	This version of captiveportal.inc has been modified by Rob Parker

	<rob.parker@keycom.co.uk> to include changes for per-user bandwidth management

	via returned RADIUS attributes. This page has been modified to delete any

	added rules which may have been created by other per-user code (index.php, etc).

	These changes are (c) 2004 Keycom PLC.

*/

/* include all configuration functions */

require_once("functions.inc");

require_once("globals.inc");

require_once("radius_authentication.inc");

require_once("radius_accounting.inc");

require_once("radius.inc");

$lockfile = "{$g['varrun_path']}/captiveportal.lock";

function captiveportal_configure() {

	global $config, $g;

	if (isset($config['captiveportal']['enable']) &&

		(($config['captiveportal']['interface'] == "lan") ||

			isset($config['interfaces'][$config['captiveportal']['interface']]['enable']))) {

		if ($g['booting'])

			echo "Starting captive portal... ";

		/* kill any running mini_httpd */

		killbypid("{$g['varrun_path']}/lighty-CaptivePortal.pid");

		killbypid("{$g['varrun_path']}/lighty-CaptivePortal-SSL.pid");

		/* kill any running minicron */

		killbypid("{$g['varrun_path']}/minicron.pid");

		/* generate ipfw rules */

		$cprules = captiveportal_rules_generate();

		/* make sure ipfw is loaded */

		mwexec("/sbin/kldload ipfw");

		/* 

		 * make sure ipfw is the first hook to make CP work correctly on

		 * Multi-WAN.

		 * Disable the ipfw outer hook it has not value to us.

		 */

		mwexec("/sbin/sysctl net.inet.ip.pfil.inbound=\"ipfw,pf\"");

		/* 

		 * TODO: Check if disabling ipfw hook 

		 * does not break accounting. 

		 */

		mwexec("/sbin/sysctl net.inet.ip.pfil.outbound=\"ipfw,pf\"");    

		/* stop accounting on all clients */

		captiveportal_radius_stop_all();

		/* initialize minicron interval value */

		$croninterval = $config['captiveportal']['croninterval'] ? $config['captiveportal']['croninterval'] : 60;

		/* double check if the $croninterval is numeric and at least 10 seconds. If not we set it to 60 to avoid problems */

		if ((!is_numeric($croninterval)) || ($croninterval < 10)) { $croninterval = 60; }

		/* remove old information */

		unlink_if_exists("{$g['vardb_path']}/captiveportal.nextrule");

		unlink_if_exists("{$g['vardb_path']}/captiveportal.db");

		unlink_if_exists("{$g['vardb_path']}/captiveportal_mac.db");

		unlink_if_exists("{$g['vardb_path']}/captiveportal_ip.db");

		unlink_if_exists("{$g['vardb_path']}/captiveportal_radius.db");

		/* write portal page */

		if ($config['captiveportal']['page']['htmltext'])

			$htmltext = base64_decode($config['captiveportal']['page']['htmltext']);

		else {

			/* example/template page */

			$htmltext = <<<EOD

<html>

<head>

<title>{$g['product_name']} captive portal</title>

</head>

<body>

<center>

<h2>{$g['product_name']} captive portal</h2>

Welcome to the {$g['product_name']} Captive Portal!  This is the default page since a custom page has not been defined.

<p>

<form method="post" action="\$PORTAL_ACTION\$">

<input name="redirurl" type="hidden" value="\$PORTAL_REDIRURL\$">

<table>

   <tr><td>Username:</td><td><input name="auth_user" type="text"></td></tr>

   <tr><td>Password:</td><td><input name="auth_pass" type="password"></td></tr>

   <tr><td>&nbsp;</td></tr>

   <tr>

     <td colspan="2">

	<center><input name="accept" type="submit" value="Continue"></center>

     </td>

   </tr>

</table>

</center>

</form>

</body>

</html>

EOD;

		}

		$fd = @fopen("{$g['varetc_path']}/captiveportal.html", "w");

		if ($fd) {

			fwrite($fd, $htmltext);

			fclose($fd);

		}

		/* write error page */

		if ($config['captiveportal']['page']['errtext'])

			$errtext = base64_decode($config['captiveportal']['page']['errtext']);

		else {

			/* example page */

			$errtext = <<<EOD

<html>

<head>

<title>Authentication error</title>

</head>

<body>

<font color="#cc0000"><h2>Authentication error</h2></font>

<b>

Username and/or password invalid.

<br><br>

<a href="javascript:history.back()">Go back</a>

</b>

</body>

</html>

EOD;

		}

		$fd = @fopen("{$g['varetc_path']}/captiveportal-error.html", "w");

		if ($fd) {

			fwrite($fd, $errtext);

			fclose($fd);

		}

		/* write elements */

		captiveportal_write_elements();

		/* load rules */

		mwexec("/sbin/ipfw -f delete set 1");

		mwexec("/sbin/ipfw -f delete set 2");

		mwexec("/sbin/ipfw -f delete set 3");

		/* ipfw cannot accept rules directly on stdin,

		   so we have to write them to a temporary file first */

		$fd = @fopen("{$g['tmp_path']}/ipfw.cp.rules", "w");

		if (!$fd) {

			printf("Cannot open ipfw.cp.rules in captiveportal_configure()\n");

			return 1;

		}

		fwrite($fd, $cprules);

		fclose($fd);

		mwexec("/sbin/ipfw {$g['tmp_path']}/ipfw.cp.rules");

		unlink("{$g['tmp_path']}/ipfw.cp.rules");

		/* filter on layer2 as well so we can check MAC addresses */

		mwexec("/sbin/sysctl net.link.ether.ipfw=1");

		chdir($g['captiveportal_path']);

		if ($config['captiveportal']['maxproc'])

			$maxproc = $config['captiveportal']['maxproc'];

		else

			$maxproc = 16;

		$use_fastcgi = true;

		if(isset($config['captiveportal']['httpslogin'])) {

			$cert = base64_decode($config['captiveportal']['certificate']);

			$key = base64_decode($config['captiveportal']['private-key']);

			/* generate lighttpd configuration */

			system_generate_lighty_config("{$g['varetc_path']}/lighty-CaptivePortal-SSL.conf",

				$cert, $key, "lighty-CaptivePortal-ssl.pid", "8001", "/usr/local/captiveportal/",

					"cert-portal.pem", "1", $maxproc, $use_fastcgi, true);

		}

		/* generate lighttpd configuration */

		system_generate_lighty_config("{$g['varetc_path']}/lighty-CaptivePortal.conf",

			"", "", "lighty-CaptivePortal.pid", "8000", "/usr/local/captiveportal/",

				"cert-portal.pem", "1", $maxproc, $use_fastcgi, true);

		/* attempt to start lighttpd */

		$res = mwexec("/usr/local/sbin/lighttpd -f {$g['varetc_path']}/lighty-CaptivePortal.conf");

		/* fire up https instance */

		if(isset($config['captiveportal']['httpslogin']))

			$res = mwexec("/usr/local/sbin/lighttpd -f {$g['varetc_path']}/lighty-CaptivePortal-SSL.conf");

		/* start pruning process (interval defaults to 60 seconds) */

		mwexec("/usr/local/bin/minicron $croninterval {$g['varrun_path']}/minicron.pid " .

			"/etc/rc.prunecaptiveportal");

		/* generate passthru mac database */

		captiveportal_passthrumac_configure();

		/* create allowed ip database and insert ipfw rules to make it so */

		captiveportal_allowedip_configure();

		/* generate radius server database */

		if ($config['captiveportal']['radiusip'] && (!isset($config['captiveportal']['auth_method']) ||

				($config['captiveportal']['auth_method'] == "radius"))) {

			$radiusip = $config['captiveportal']['radiusip'];

			$radiusip2 = ($config['captiveportal']['radiusip2']) ? $config['captiveportal']['radiusip2'] : null;

			if ($config['captiveportal']['radiusport'])

				$radiusport = $config['captiveportal']['radiusport'];

			else

				$radiusport = 1812;

			if ($config['captiveportal']['radiusacctport'])

				$radiusacctport = $config['captiveportal']['radiusacctport'];

			else

				$radiusacctport = 1813;

			if ($config['captiveportal']['radiusport2'])

				$radiusport2 = $config['captiveportal']['radiusport2'];

			else

				$radiusport2 = 1812;

			$radiuskey = $config['captiveportal']['radiuskey'];

			$radiuskey2 = ($config['captiveportal']['radiuskey2']) ? $config['captiveportal']['radiuskey2'] : null;

			$fd = @fopen("{$g['vardb_path']}/captiveportal_radius.db", "w");

			if (!$fd) {

				printf("Error: cannot open radius DB file in captiveportal_configure().\n");

				return 1;

			} else if (isset($radiusip2, $radiuskey2)) {

				fwrite($fd,$radiusip . "," . $radiusport . "," . $radiusacctport . "," . $radiuskey . "\n"

					 . $radiusip2 . "," . $radiusport2 . "," . $radiusacctport . "," . $radiuskey2);

			} else {

				fwrite($fd,$radiusip . "," . $radiusport . "," . $radiusacctport . "," . $radiuskey);

			}

			fclose($fd);

		}

		if ($g['booting'])

			echo "done\n";

	} else {

		killbypid("{$g['varrun_path']}/lighty-CaptivePortal.pid");

		killbypid("{$g['varrun_path']}/minicron.pid");

		captiveportal_radius_stop_all();

		mwexec("/sbin/sysctl net.link.ether.ipfw=0");

		if (!isset($config['shaper']['enable'])) {

			/* unload ipfw */

			$installed_time_based_rules = false;

			if($config['schedules']) {

				foreach($config['schedules']['schedule'] as $sched) {

					$installed_time_based_rules = true;

				}

			}

			if($installed_time_based_rules == false)

				mwexec("/sbin/kldunload ipfw");

		} else {

			/* shaper is on - just remove our rules */

			mwexec("/sbin/ipfw -f delete set 1");

			mwexec("/sbin/ipfw -f delete set 2");

			mwexec("/sbin/ipfw -f delete set 3");

		}

	}

    captiveportal_unlock();

	return 0;

}

function captiveportal_rules_generate() {

	global $config, $g;

	$cpifn = $config['captiveportal']['interface'];

	$cpif = $config['interfaces'][$cpifn]['if'];

	$cpip = $config['interfaces'][$cpifn]['ipaddr'];

	$lanip = $config['interfaces']['lan']['ipaddr'];

	/* note: the captive portal daemon inserts all pass rules for authenticated

	   clients as skipto 50000 rules to make traffic shaping work */

	$cprules =  "add 500 set 1 allow pfsync from any to any\n";

	$cprules .= "add 500 set 1 allow carp from any to any\n";

	/*   allow nat redirects to work  see

	     http://cvstrac.pfsense.com/tktview?tn=651

	 */

	$captive_portal_interface = strtoupper($cpifn);

        /* if list */

        $iflist = get_configured_interface_list();

	foreach ($iflist as $ifent => $ifname) {

		if($captive_portal_interface == strtoupper($ifname))

			continue;

		$int = convert_friendly_interface_to_real_interface_name($ifname);

		$cprules .= "add 30 set 1 skipto 50000 all from any to any in via {$int} keep-state\n";

	}

	/* captive portal on LAN interface? */

	if ($cpifn == "lan") {

		/* add anti-lockout rules */

		$cprules .= <<<EOD

add 500 set 1 pass all from $cpip to any out via $cpif

add 501 set 1 pass all from any to $cpip in via $cpif

EOD;

	}

	$cprules .= <<<EOD

# skip to traffic shaper if not on captive portal interface

add 1000 set 1 skipto 50000 all from any to any not layer2 not via $cpif

# pass all layer2 traffic on other interfaces

add 1001 set 1 pass layer2 not via $cpif

# layer 2: pass ARP

add 1100 set 1 pass layer2 mac-type arp

# pfsense requires for WPA

add 1100 set 1 pass layer2 mac-type 0x888e

add 1100 set 1 pass layer2 mac-type 0x88c7

# PPP Over Ethernet Discovery Stage

add 1100 set 1 pass layer2 mac-type 0x8863

# PPP Over Ethernet Session Stage

add 1100 set 1 pass layer2 mac-type 0x8864

# layer 2: block anything else non-IP

add 1101 set 1 deny layer2 not mac-type ip

# layer 2: check if MAC addresses of authenticated clients are correct

add 1102 set 1 skipto 20000 layer2

# allow access to our DHCP server (which needs to be able to ping clients as well)

add 1200 set 1 pass udp from any 68 to 255.255.255.255 67 in

add 1201 set 1 pass udp from any 68 to $cpip 67 in

add 1202 set 1 pass udp from $cpip 67 to any 68 out

add 1203 set 1 pass icmp from $cpip to any out icmptype 8

add 1204 set 1 pass icmp from any to $cpip in icmptype 0

# allow access to our DNS forwarder

add 1300 set 1 pass udp from any to $cpip 53 in

add 1301 set 1 pass udp from $cpip 53 to any out

# allow access to our DNS forwarder if it incorrectly resolves the hostname to $lanip

add 1300 set 1 pass udp from any to $lanip 53 in

add 1301 set 1 pass udp from $lanip 53 to any out

# allow access to our web server

add 1302 set 1 pass tcp from any to $cpip 8000 in

add 1303 set 1 pass tcp from $cpip 8000 to any out

# allow access to lan web server incase the dns name resolves incorrectly to $lanip

add 1302 set 1 pass tcp from any to $lanip 8000 in

add 1303 set 1 pass tcp from $lanip 8000 to any out

EOD;

	if (isset($config['captiveportal']['httpslogin'])) {

		$cprules .= <<<EOD

add 1304 set 1 pass tcp from any to $cpip 8001 in

add 1305 set 1 pass tcp from $cpip 8001 to any out

add 1306 set 1 pass tcp from any to $lanip 8001 in

add 1307 set 1 pass tcp from $lanip 8001 to any out

EOD;

	}

        $cprules .= <<<EOD

#PPPoE Discovery Stage

add 1100 set 1 pass layer2 mac-type 0x8863

#PPPoE Session Stage

add 1100 set 1 pass layer2 mac-type 0x8864

EOD;

        $cprules .= <<<EOD

# Allow WPA

add 1100 set 1 pass layer2 mac-type 0x888e

EOD;

    $cprules .= <<<EOD

# ... 10000-19899: rules per authenticated client go here...

# redirect non-authenticated clients to captive portal

add 19902 set 1 fwd 127.0.0.1,8000 tcp from any to any 80 in

# let the responses from the captive portal web server back out

add 19903 set 1 pass tcp from any 80 to any out

# block everything else

add 19904 set 1 deny all from any to any

# ... 20000-29899: layer2 block rules per authenticated client go here...

# pass everything else on layer2

add 29900 set 1 pass all from any to any layer2

EOD;

    return $cprules;

}

/* remove clients that have been around for longer than the specified amount of time */

/* db file structure:

timestamp,ipfw_rule_no,clientip,clientmac,username,sessionid,password,session_timeout,idle_timeout,session_terminate_time */

/* (password is in Base64 and only saved when reauthentication is enabled) */

function captiveportal_prune_old() {

    global $g, $config;

    /* check for expired entries */

    if ($config['captiveportal']['timeout'])

        $timeout = $config['captiveportal']['timeout'] * 60;

    else

        $timeout = 0;

    if ($config['captiveportal']['idletimeout'])

        $idletimeout = $config['captiveportal']['idletimeout'] * 60;

    else

        $idletimeout = 0;

    if (!$timeout && !$idletimeout && !isset($config['captiveportal']['reauthenticate']) && !isset($config['captiveportal']['radiussession_timeout']))

        return;

    captiveportal_lock();

    /* read database */

    $cpdb = captiveportal_read_db();

    $radiusservers = captiveportal_get_radius_servers();

 	/*  To make sure we iterate over ALL accounts on every run the count($cpdb) is moved outside of the loop. Otherwise

     *  the loop would evalate count() on every iteration and since $i would increase and count() would decrement they

     *  would meet before we had a chance to iterate over all accounts.

     */

    $no_users = count($cpdb);

    for ($i = 0; $i < $no_users; $i++) {

        $timedout = false;

        $term_cause = 1;

		/* no pruning for fixed mac address entry */

		if (portal_mac_fixed($cpdb[$i][3])) {

			continue; // check next value

		}

        /* hard timeout? */

        if ($timeout) {

            if ((time() - $cpdb[$i][0]) >= $timeout) {

                $timedout = true;

                $term_cause = 5; // Session-Timeout

            }

        }

        /* Session-Terminate-Time */

        if (!$timedout && !empty($cpdb[$i][9])) {

            if (time() >= $cpdb[$i][9]) {

                $timedout = true;

                $term_cause = 5; // Session-Timeout

            }

        }

        /* check if the radius idle_timeout attribute has been set and if its set change the idletimeout to this value */

        $idletimeout = (is_numeric($cpdb[$i][8])) ? $cpdb[$i][8] : $idletimeout;

        /* if an idle timeout is specified, get last activity timestamp from ipfw */

        if (!$timedout && $idletimeout) {

            $lastact = captiveportal_get_last_activity($cpdb[$i][1]);

			/*  if the user has logged on but not sent any trafic they will never be logged out.

			 *  We "fix" this by setting lastact to the login timestamp 

			 */

			$lastact = $lastact ? $lastact : $cpdb[$i][0];

            if ($lastact && ((time() - $lastact) >= $idletimeout)) {

                $timedout = true;

                $term_cause = 4; // Idle-Timeout

                $stop_time = $lastact; // Entry added to comply with WISPr

            }

        }

        /* if radius session_timeout is enabled and the session_timeout is not null, then check if the user should be logged out */

        if (!$timedout && isset($config['captiveportal']['radiussession_timeout']) && !empty($cpdb[$i][7])) {

            if (time() >= ($cpdb[$i][0] + $cpdb[$i][7])) {

                $timedout = true;

                $term_cause = 5; // Session-Timeout

            }

        }

        if ($timedout) {

            captiveportal_disconnect($cpdb[$i], $radiusservers,$term_cause,$stop_time);

            captiveportal_logportalauth($cpdb[$i][4], $cpdb[$i][3], $cpdb[$i][2], "TIMEOUT");

            unset($cpdb[$i]);

        }

        /* do periodic RADIUS reauthentication? */

        if (!$timedout && isset($config['captiveportal']['reauthenticate']) &&

            ($radiusservers !== false)) {

            if (isset($config['captiveportal']['radacct_enable'])) {

                if ($config['captiveportal']['reauthenticateacct'] == "stopstart") {

                    /* stop and restart accounting */

                    RADIUS_ACCOUNTING_STOP($cpdb[$i][1], // ruleno

                                           $cpdb[$i][4], // username

                                           $cpdb[$i][5], // sessionid

                                           $cpdb[$i][0], // start time

                                           $radiusservers[0]['ipaddr'],

                                           $radiusservers[0]['acctport'],

                                           $radiusservers[0]['key'],

                                           $cpdb[$i][2], // clientip

                                           $cpdb[$i][3], // clientmac

                                           10); // NAS Request

                    exec("/sbin/ipfw zero {$cpdb[$i][1]}");

                    RADIUS_ACCOUNTING_START($cpdb[$i][1], // ruleno

                                            $cpdb[$i][4], // username

                                            $cpdb[$i][5], // sessionid

                                            $radiusservers[0]['ipaddr'],

                                            $radiusservers[0]['acctport'],

                                            $radiusservers[0]['key'],

                                            $cpdb[$i][2], // clientip

                                            $cpdb[$i][3]); // clientmac

                } else if ($config['captiveportal']['reauthenticateacct'] == "interimupdate") {

                    RADIUS_ACCOUNTING_STOP($cpdb[$i][1], // ruleno

                                           $cpdb[$i][4], // username

                                           $cpdb[$i][5], // sessionid

                                           $cpdb[$i][0], // start time

                                           $radiusservers[0]['ipaddr'],

                                           $radiusservers[0]['acctport'],

                                           $radiusservers[0]['key'],

                                           $cpdb[$i][2], // clientip

                                           $cpdb[$i][3], // clientmac

                                           10, // NAS Request

                                           true); // Interim Updates

                }

            }

            /* check this user against RADIUS again */

            $auth_list = RADIUS_AUTHENTICATION($cpdb[$i][4], // username

                                          base64_decode($cpdb[$i][6]), // password

                                            $radiusservers,

                                          $cpdb[$i][2], // clientip

                                          $cpdb[$i][3], // clientmac

                                          $cpdb[$i][1]); // ruleno

            if ($auth_list['auth_val'] == 3) {

                captiveportal_disconnect($cpdb[$i], $radiusservers, 17);

                captiveportal_logportalauth($cpdb[$i][4], $cpdb[$i][3], $cpdb[$i][2], "RADIUS_DISCONNECT", $auth_list['reply_message']);

                unset($cpdb[$i]);

            }

        }

    }

    /* write database */

    captiveportal_write_db($cpdb);

    captiveportal_unlock();

}

/* remove a single client according to the DB entry */

function captiveportal_disconnect($dbent, $radiusservers,$term_cause = 1,$stop_time = null) {

	global $g, $config;

	$stop_time = (empty($stop_time)) ? time() : $stop_time;

	/* this client needs to be deleted - remove ipfw rules */

	if (isset($config['captiveportal']['radacct_enable']) && isset($radiusservers[0])) {

		RADIUS_ACCOUNTING_STOP($dbent[1], // ruleno

							   $dbent[4], // username

							   $dbent[5], // sessionid

							   $dbent[0], // start time

							   $radiusservers[0]['ipaddr'],

							   $radiusservers[0]['acctport'],

							   $radiusservers[0]['key'],

							   $dbent[2], // clientip

							   $dbent[3], // clientmac

							   $term_cause, // Acct-Terminate-Cause

							   false,

							   $stop_time);

	}

	mwexec("/sbin/ipfw delete " . $dbent[1] . " " . ($dbent[1]+10000));

    /* We need to delete +40500 and +45500 as well...

     * these are the pipe numbers we use to control traffic shaping for each logged in user via captive portal

     * We could get an error if the pipe doesn't exist but everything should still be fine

     */

    if (isset($config['captiveportal']['peruserbw'])) {

        mwexec("/sbin/ipfw pipe " . ($dbent[1]+40500) . " delete");

        mwexec("/sbin/ipfw pipe " . ($dbent[1]+45500) . " delete");

    }

	/* pfSense: ensure all pf states are killed (pfSense) */

	mwexec("pfctl -k {$dbent[2]}");

	mwexec("pfctl -K {$dbent[2]}");

}

/* remove a single client by ipfw rule number */

function captiveportal_disconnect_client($id,$term_cause = 1) {

	global $g, $config;

	captiveportal_lock();

	/* read database */

	$cpdb = captiveportal_read_db();

	$radiusservers = captiveportal_get_radius_servers();

	/* find entry */

	for ($i = 0; $i < count($cpdb); $i++) {

		if ($cpdb[$i][1] == $id) {

			captiveportal_disconnect($cpdb[$i], $radiusservers, $term_cause);

			captiveportal_logportalauth($cpdb[$i][4], $cpdb[$i][3], $cpdb[$i][2], "DISCONNECT");

			unset($cpdb[$i]);

			break;

		}

	}

	/* write database */

	captiveportal_write_db($cpdb);

	captiveportal_unlock();

}

/* send RADIUS acct stop for all current clients */

function captiveportal_radius_stop_all() {

	global $g, $config;

	if (!isset($config['captiveportal']['radacct_enable']))

		return;

	captiveportal_lock();

	$cpdb = captiveportal_read_db();

	$radiusservers = captiveportal_get_radius_servers();

	if (isset($radiusservers[0])) {

		for ($i = 0; $i < count($cpdb); $i++) {

			RADIUS_ACCOUNTING_STOP($cpdb[$i][1], // ruleno

								   $cpdb[$i][4], // username

								   $cpdb[$i][5], // sessionid

								   $cpdb[$i][0], // start time

								   $radiusservers[0]['ipaddr'],

								   $radiusservers[0]['acctport'],

								   $radiusservers[0]['key'],

								   $cpdb[$i][2], // clientip

								   $cpdb[$i][3], // clientmac

								   7); // Admin Reboot

		}

	}

	captiveportal_unlock();

}

function captiveportal_passthrumac_configure() {

	global $config, $g;

	captiveportal_lock();

	/* clear out passthru macs, if necessary */

	unlink_if_exists("{$g['vardb_path']}/captiveportal_mac.db");

	if (is_array($config['captiveportal']['passthrumac'])) {

		$fd = @fopen("{$g['vardb_path']}/captiveportal_mac.db", "w");

		if (!$fd) {

			printf("Error: cannot open passthru mac DB file in captiveportal_passthrumac_configure().\n");

			captiveportal_unlock();

			return 1;

		}

		foreach ($config['captiveportal']['passthrumac'] as $macent) {

			/* record passthru mac so it can be recognized and let thru */

			fwrite($fd, $macent['mac'] . "\n");

		}

		fclose($fd);

	}

	/*    pfSense:

	 * 	  pass through mac entries should always exist.  the reason

	 *    for this is because we do not have native mac address filtering

	 *    mechanisms.  this allows us to filter by mac address easily

	 *    and get around this limitation.   I consider this a bug in

	 *    m0n0wall and pfSense as m0n0wall does not have native mac

	 *    filtering mechanisms as well. -Scott Ullrich

	 */

	if (is_array($config['captiveportal']['passthrumac'])) {

		mwexec("/sbin/ipfw delete 50");

		foreach($config['captiveportal']['passthrumac'] as $ptm) {

			/* create the pass through mac entry */

			//system("echo /sbin/ipfw add 50 skipto 65535 ip from any to any MAC {$ptm['mac']} any > /tmp/cp");

			mwexec("/sbin/ipfw add 50 skipto 29900 ip from any to any MAC {$ptm['mac']} any keep-state");

			mwexec("/sbin/ipfw add 50 skipto 29900 ip from any to any MAC any {$ptm['mac']} keep-state");

		}

	}

	captiveportal_unlock();

	return 0;

}

function captiveportal_allowedip_configure() {

	global $config, $g;

	captiveportal_lock();

	/* clear out existing allowed ips, if necessary */

	if (file_exists("{$g['vardb_path']}/captiveportal_ip.db")) {

		$fd = @fopen("{$g['vardb_path']}/captiveportal_ip.db", "r");

		if ($fd) {

			while (!feof($fd)) {

				$line = trim(fgets($fd));

				if ($line) {

					list($ip,$rule) = explode(",",$line);

					mwexec("/sbin/ipfw delete $rule");

				}

			}

		}

		fclose($fd);

		unlink("{$g['vardb_path']}/captiveportal_ip.db");

	}

	/* get next ipfw rule number */

	if (file_exists("{$g['vardb_path']}/captiveportal.nextrule"))

		$ruleno = trim(file_get_contents("{$g['vardb_path']}/captiveportal.nextrule"));

	if (!$ruleno)

		$ruleno = 10000;	/* first rule number */

	if (is_array($config['captiveportal']['allowedip'])) {

		$fd = @fopen("{$g['vardb_path']}/captiveportal_ip.db", "w");

		if (!$fd) {

			printf("Error: cannot open allowed ip DB file in captiveportal_allowedip_configure().\n");

			captiveportal_unlock();

			return 1;

		}

		foreach ($config['captiveportal']['allowedip'] as $ipent) {

            /* get next ipfw rule number */

            $ruleno = captiveportal_get_next_ipfw_ruleno();

            /* if the pool is empty, return apprioriate message and fail */

            if (is_null($ruleno)) {

                printf("Error: system reached maximum login capacity, no free FW rulenos in captiveportal_allowedip_configure().\n");

                fclose($fd);

                captiveportal_unlock();

                return 1;

            }

            /* record allowed ip so it can be recognized and removed later */

            fwrite($fd, $ipent['ip'] . "," . $ruleno ."\n");

            /* insert ipfw rule to allow ip thru */

            if ($ipent['dir'] == "from") {

                mwexec("/sbin/ipfw add $ruleno set 2 skipto 50000 ip from " . $ipent['ip'] . " to any in");

                mwexec("/sbin/ipfw add $ruleno set 2 skipto 50000 ip from any to " . $ipent['ip'] . " out");

            } else {

                mwexec("/sbin/ipfw add $ruleno set 2 skipto 50000 ip from any to " . $ipent['ip'] . " in");

                mwexec("/sbin/ipfw add $ruleno set 2 skipto 50000 ip from " . $ipent['ip'] . " to any out");

            }

        }

        fclose($fd);

    }

    captiveportal_unlock();

    return 0;

}

/* get last activity timestamp given ipfw rule number */

function captiveportal_get_last_activity($ruleno) {

	$ipfwoutput = "";

	exec("/sbin/ipfw -T list {$ruleno} 2>/dev/null", $ipfwoutput);

	/* in */

	if ($ipfwoutput[0]) {

		$ri = explode(" ", $ipfwoutput[0]);

		if ($ri[1])

			return $ri[1];

	}

	return 0;

}

/* read RADIUS servers into array */

function captiveportal_get_radius_servers() {

        global $g;

        if (file_exists("{$g['vardb_path']}/captiveportal_radius.db")) {

                $fd = @fopen("{$g['vardb_path']}/captiveportal_radius.db","r");

                if ($fd) {

                        $radiusservers = array();

                        while (!feof($fd)) {

                                $line = trim(fgets($fd));

                                if ($line) {

                                        $radsrv = array();

                                        list($radsrv['ipaddr'],$radsrv['port'],$radsrv['acctport'],$radsrv['key']) = explode(",",$line);

                                        $radiusservers[] = $radsrv;

                                }

                        }

                        fclose($fd);

                        return $radiusservers;

                }

        }

        return false;

}

/* lock captive portal information, decide that the lock file is stale after 

   10 minutes and EXIT the process to not risk dataloss, issue warning in syslog every 1 minutes */

function captiveportal_lock() {

        global $lockfile;

        $n = 1;

        while ($n) {

                /* open the lock file in append mode to avoid race condition */

                if ($fd = @fopen($lockfile, "x")) {

                        /* succeeded */

                        fclose($fd);

						if($n > 10) {

						    captiveportal_syslog("LOCKINFO: Waiting for lock for $n seconds/s!");

						}

                        return;

                } else {

                        /* file locked, wait and try again */

                        sleep(1);

						if(($n % 60) == 0) {

						    captiveportal_syslog("LOCKWARNING: waiting for lock for " . $n/60 . " minute/s!");

						    if(($n % 600) == 0) {

						        captiveportal_syslog("LOCKERROR: waiting for lock for 10 minute/s - EXITING PROCESS!");

						        die("Can't get a lock");

						    }

					    }

                }

                $n++;

        }

		/* we never get here */

}

/* unlock captive portal information file */

function captiveportal_unlock() {

        global $lockfile;

        if (file_exists($lockfile))

                unlink($lockfile);

}

/* log successful captive portal authentication to syslog */

/* part of this code from php.net */

function captiveportal_logportalauth($user,$mac,$ip,$status, $message = null) {

	$message = trim($message);