pfSense

#!/usr/local/bin/php-cgi -q

<?php

/*

 * easyrule

 *

 * part of pfSense (https://www.pfsense.org)

 * Copyright (c) 2010-2016 Rubicon Communications, LLC (Netgate)

 * 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.

 *

 * 3. All advertising materials mentioning features or use of this software

 *    must display the following acknowledgment:

 *    "This product includes software developed by the pfSense Project

 *    for use in the pfSense® software distribution. (http://www.pfsense.org/).

 *

 * 4. The names "pfSense" and "pfSense Project" must not be used to

 *    endorse or promote products derived from this software without

 *    prior written permission. For written permission, please contact

 *    coreteam@pfsense.org.

 *

 * 5. Products derived from this software may not be called "pfSense"

 *    nor may "pfSense" appear in their names without prior written

 *    permission of the Electric Sheep Fencing, LLC.

 *

 * 6. Redistributions of any form whatsoever must retain the following

 *    acknowledgment:

 *

 * "This product includes software developed by the pfSense Project

 * for use in the pfSense software distribution (http://www.pfsense.org/).

 *

 * THIS SOFTWARE IS PROVIDED BY THE pfSense PROJECT ``AS IS'' AND ANY

 * EXPRESSED 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 pfSense PROJECT OR

 * ITS CONTRIBUTORS 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.

 */

require_once("pfsense-utils.inc");

require_once("easyrule.inc");

require_once("filter.inc");

require_once("shaper.inc");

$message = "";

$specialsrcdst = explode(" ", "any pptp pppoe l2tp openvpn");

$ifdisp = get_configured_interface_with_descr();

foreach ($ifdisp as $kif => $kdescr) {

	$specialsrcdst[] = "{$kif}";

	$specialsrcdst[] = "{$kif}ip";

}

/* Borrow this function from guiconfig.inc since we can't include it for use at the CLI

 - Maybe these need to be moved to util.inc or pfsense-utils.inc?

*/

function pconfig_to_address(&$adr, $padr, $pmask, $pnot=false, $pbeginport=0, $pendport=0) {

	$adr = array();

	if ($padr == "any") {

		$adr['any'] = true;

	} else if (is_specialnet($padr)) {

		$adr['network'] = $padr;

	} else {

		$adr['address'] = $padr;

		if ($pmask != 32) {

			$adr['address'] .= "/" . $pmask;

		}

	}

	if ($pnot) {

		$adr['not'] = true;

	} else {

		unset($adr['not']);

	}

	if (($pbeginport != 0) && ($pbeginport != "any")) {

		if ($pbeginport != $pendport) {

			$adr['port'] = $pbeginport . "-" . $pendport;

		} else {

			$adr['port'] = $pbeginport;

		}

	}

	if (is_alias($pbeginport)) {

		$adr['port'] = $pbeginport;

	}

}

/* Borrow this one from guiconfig.inc also */

function is_specialnet($net) {

	global $specialsrcdst;

	if (!$net) {

		return false;

	}

	if (in_array($net, $specialsrcdst)) {

		return true;

	} else {

		return false;

	}

}

if (($argc > 1) && !empty($argv[1])) {

	/* Automagically derive an alternate alias name from the scripts name

	 * This allows for using alternate alias lists with just a symlink */

	if (($alias = basename($argv[0])) != 'easyrule') {

		$blockaliasname = ucfirst($alias).'Rules';

	}

	$message = "";

	switch ($argv[1]) {

		case 'block':

			$message = easyrule_parse_block($argv[2], $argv[3]);

			break;

		case 'unblock':

			$message = easyrule_parse_unblock($argv[2], $argv[3]);

			break;

		case 'showblock':

			$message = easyrule_parse_getblock($argv[2]);

			break;

		case 'pass':

			$message = easyrule_parse_pass($argv[2], $argv[3], $argv[4], $argv[5], $argv[6]);

			break;

	}

	echo $message . "\n";

} else {

	// Print usage:

	echo "usage:\n";

	echo " Blocking only requires an IP to block, block rules can be shown with showblock and revoked using unblock\n";

	echo "     " . basename($argv[0]) . " block <interface> <source IP>\n";

	echo "\n";

	echo " Passing requires more detail, as it must be as specific as possible. The destination port is optional if you're using a protocol without a port (e.g. ICMP, OSPF, etc).\n";

	echo "     " . basename($argv[0]) . " pass <interface> <protocol> <source IP> <destination ip> [destination port]\n";

	echo "\n";

	echo " Block example:\n";

	echo "     " . basename($argv[0]) . " block wan 1.2.3.4\n";

	echo "\n";

	echo " Show active blocks example:\n";

	echo "     " . basename($argv[0]) . " showblock wan\n";

	echo "\n";

	echo " Unblock example:\n";

	echo "     " . basename($argv[0]) . " unblock wan 1.2.3.4\n";

	echo "\n";

	echo " Pass example (protocol with port):\n";

	echo "     " . basename($argv[0]) . " pass wan tcp 1.2.3.4 192.168.0.4 80\n";

	echo "\n";

	echo " Pass example (protocol without port):\n";

	echo "     " . basename($argv[0]) . " pass wan icmp 1.2.3.4 192.168.0.4\n";

	echo "\n";

}

?>