pfSense

<?php

	pfsense-utils.inc

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

	Copyright (c) 2004-2016 Electric Sheep Fencing, LLC.

	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

	   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.

 * NAME

 *   have_natpfruleint_access

 * INPUTS

 *   returns true if user has access to edit a specific firewall nat port forward interface

 ******/

function have_natpfruleint_access($if) {

	$security_url = "firewall_nat_edit.php?if=". strtolower($if);

}

 * NAME

 *   have_ruleint_access

 * INPUTS

 *   returns true if user has access to edit a specific firewall interface

 ******/

function have_ruleint_access($if) {

	$security_url = "firewall_rules.php?if=". strtolower($if);

}

 * NAME

 *   does_url_exist

 * INPUTS

 *   returns true if a url is available

 ******/

function does_url_exist($url) {

}

 * NAME

 *   is_private_ip

 * INPUTS

 *   returns true if an ip address is in a private range

 ******/

function is_private_ip($iptocheck) {

		"100.64.0.0/10",

		"172.16.0.0/12",

		"192.168.0.0/16",

	);

	return $isprivate;

 * NAME

 *   get_tmp_file

 * INPUTS

 *   returns a temporary filename

 ******/

	return "{$g['tmp_path']}/tmp-" . time();

/****f* pfsense-utils/get_dns_servers

 * NAME

function get_dns_servers() {

	$dns_servers = array();

	if (is_array($dns_s)) {

			$matches = "";

			if (preg_match("/nameserver (.*)/", $dns, $matches)) {

				$dns_servers[] = $matches[1];

			}

	global $config;

	$flags_on = 0;

	$flags_off = 0;

	$options = pfSense_get_interface_addresses($iface);

		if (isset($options['encaps']['txcsum'])) {

		if (isset($options['encaps']['rxcsum'])) {

	/* if the NIC supports polling *AND* it is enabled in the GUI */

	pfSense_interface_capabilities($iface, -$flags_off);

	pfSense_interface_capabilities($iface, $flags_on);

}

 * NAME

 *   enable_hardware_offloading - Enable a NIC's supported hardware features.

 * INPUTS

 *   $interface	- string containing the physical interface to work on.

 * RESULT

 *   null

 * NOTES

 *   This function only supports the fxp driver's loadable microcode.

 ******/

function enable_hardware_offloading($interface) {

	global $g, $config;

	if (!isset($config['system']['do_not_use_nic_microcode'])) {

		/* translate wan, lan, opt -> real interface if needed */

		$int_family = preg_split("/[0-9]+/", $int);

		$supported_ints = array('fxp');

		if (in_array($int_family, $supported_ints)) {

	$realhwif = get_parent_interface($interface);

		hardware_offloading_applyflags($int);

	}

 * NAME

 *   checks to see if an interface supports polling according to man polling

 * INPUTS

 *

 * RESULT

 *   true or false

 * NOTES

 *

 ******/

function interface_supports_polling($iface) {

}

 * NAME

 *   checks to see if an alias is currently in use by a rule

 * INPUTS

 *

 * RESULT

 *   true or false

 * NOTES

 *

 ******/

function is_alias_inuse($alias) {

	global $g, $config;

		return false;

	}

		foreach ($config['filter']['rule'] as $rule) {

			if ($rule['source']['address']) {

				if ($rule['source']['address'] == $alias) {

			}

			if ($rule['destination']['address']) {

				if ($rule['destination']['address'] == $alias) {

			}

		foreach ($config['nat']['rule'] as $rule) {

			if ($rule['target'] && $rule['target'] == $alias) {

			if ($rule['source']['address'] && $rule['source']['address'] == $alias) {

			if ($rule['destination']['address'] && $rule['destination']['address'] == $alias) {

}

 * NAME

 *   checks to see if a schedule is currently in use by a rule

 * INPUTS

 *

 * RESULT

 *   true or false

 * NOTES

 *

 ******/

function is_schedule_inuse($schedule) {

	global $g, $config;

		return false;

	}

		foreach ($config['filter']['rule'] as $rule) {

			if ($rule['sched'] == $schedule) {

}

 * NAME

 *   sets up polling

 * INPUTS

 *

 * RESULT

 *   null

 * NOTES

 *

 ******/

function setup_polling() {

	global $g, $config;

	if ($config['system']['polling_burst_max']) {

	if ($config['system']['polling_user_frac']) {

/****f* pfsense-utils/setup_microcode

 * NAME

 *   enumerates all interfaces and calls enable_hardware_offloading which

 *   enables a NIC's supported hardware features.

 * INPUTS

 *

 * RESULT

 *   null

 * NOTES

 *   This function only supports the fxp driver's loadable microcode.

 ******/

function setup_microcode() {

/****f* pfsense-utils/get_carp_status

 * NAME

 *   get_carp_status - Return whether CARP is enabled or disabled.

 * RESULT

 *   boolean	- true if CARP is enabled, false if otherwise.

 ******/

function get_carp_status() {

/*

 * convert_ip_to_network_format($ip, $subnet): converts an ip address to network form

function convert_ip_to_network_format($ip, $subnet) {

	return $string;

}

/*

	$carpiface = get_configured_vip_interface($carpid);

	if ($carpiface == NULL)

		return "";

	$interface = get_real_interface($carpiface);

	if ($interface == NULL)

		return "";

	$vhid = $carp['vhid'];

	$carp_query = '';

	$_gb = exec("/sbin/ifconfig $interface | /usr/bin/grep carp: | /usr/bin/grep \"vhid $vhid\"", $carp_query);

	foreach ($carp_query as $int) {

		if (stripos($int, "MASTER"))

			return "MASTER";

		elseif (stripos($int, "BACKUP"))

			return "BACKUP";

		elseif (stripos($int, "INIT"))

			return "INIT";

/*

 * get_pfsync_interface_status($pfsyncinterface): returns the status of a pfsync

 */

function get_pfsync_interface_status($pfsyncinterface) {

	return exec_command("/sbin/ifconfig {$pfsyncinterface} | /usr/bin/awk '/pfsync:/ {print \$5}'");

/*

 * add_rule_to_anchor($anchor, $rule): adds the specified rule to an anchor

 */

function add_rule_to_anchor($anchor, $rule, $label) {

/*

 * remove_text_from_file

 * remove $text from file $file

 */

function remove_text_from_file($file, $text) {

/*

 *   after_sync_bump_adv_skew(): create skew values by 1S

 */

function after_sync_bump_adv_skew() {

	global $config, $g;

	$processed_skew = 1;

	$a_vip = &$config['virtualip']['vip'];

	foreach ($a_vip as $vipent) {

			$vipent['advskew'] = $vipent['advskew']+1;

		}

	}

/*

 * get_filename_from_url($url): converts a url to its filename.

 */

function get_filename_from_url($url) {

	return basename($url);

}

/*

 *   get_dir: return an array of $dir

 */

function get_dir($dir) {

	$dir_array = array();

	$d = dir($dir);

	while (false !== ($entry = $d->read())) {

		array_push($dir_array, $entry);

	}

	$d->close();

	return $dir_array;

}

/****f* pfsense-utils/WakeOnLan

 * NAME

 *   WakeOnLan - Wake a machine up using the wake on lan format/protocol

 * RESULT

 *   true/false - true if the operation was successful

 ******/

	$hw_addr = '';

	$msg = chr(255).chr(255).chr(255).chr(255).chr(255).chr(255);

	// send it to the broadcast address using UDP

	$s = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);

	if ($s == false) {

		// setting a broadcast option to socket:

		socket_close($s);

	return false;

}

/*

 * reverse_strrchr($haystack, $needle):  Return everything in $haystack up to the *last* instance of $needle.

 *					 Useful for finding paths and stripping file extensions.

 */

function reverse_strrchr($haystack, $needle) {

	return strrpos($haystack, $needle) ? substr($haystack, 0, strrpos($haystack, $needle) +1) : false;

/*

 *  backup_config_section($section): returns as an xml file string of

 *                                   the configuration section

 */

	return $xmlconfig;

}

/*

 *                                                  to disk/cf.

 */

	conf_mount_rw();

	fclose($fout);

	$xml = parse_xml_config($g['tmp_path'] . "/tmpxml", null);

	if ($xml['pfsense']) {

		$xml = $xml['pfsense'];

	}

	else if ($xml['m0n0wall']) {

		$xml = $xml['m0n0wall'];

	}

	if ($xml[$section_name]) {

		$section_xml = $xml[$section_name];

	} else {

		$section_xml = -1;

	}

		return false;

	}

	$config[$section_name] = &$section_xml;

/*

 *                                                  to disk/cf.  But preserve the prior

 * 													structure if needed

 */

	conf_mount_rw();

	$fname = get_tmp_filename();

	$fout = fopen($fname, "w");

	fwrite($fout, $new_contents);

	fclose($fout);

	$config[$section_name] = $section_xml;

	return;

}

/*

 *  php_check_syntax($code_tocheck, $errormessage): checks $code_to_check for errors

 */

		$code = str_replace("<?php", "", $code);

		$code = str_replace("?>", "", $code);

		fwrite($fout, "<?php\n\n");

		fwrite($fout, $code_to_check);

		fwrite($fout, "\n\n?>\n");

		if (stristr($output, "Errors parsing") == false) {

			echo "false\n";

			$errormessage = '';

			return(false);

		} else {

			$errormessage = $output;

			return(true);

	}

/*

 *  php_check_filename_syntax($filename, $errormessage): checks the file $filename for errors

 */

	function php_check_syntax($code_to_check, &$errormessage) {

		if (stristr($output, "Errors parsing") == false) {

			echo "false\n";

			$errormessage = '';

			return(false);

		} else {

			$errormessage = $output;

			return(true);

		}

	}

}

/*

 * This is for directories _only_

 */

		$to_do = array($to_do);

	}

	foreach ($to_do as $workingdir) { // Handle wildcards by foreaching.

		if (file_exists($workingdir)) {

			if (is_dir($workingdir)) {

				while ($entry = readdir($dir)) {

				rmdir($workingdir);