pfSense

 * xmlrpc.php

 *

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

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

 * Copyright (c) 2005 Colin Smith

 *

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

 *

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

 *

 * 2. Redistributions in binary form must reproduce the above copyright

 *

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

 *

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

 *

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

 *

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

 *

 * "This product includes software developed by the pfSense Project

 *

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

 */

##|+PRIV

##|*NAME=XMLRPC Library

##|*DESCR=Allow access to the 'XMLRPC Library' page.

require_once("config.inc");

require_once("filter.inc");

require_once("ipsec.inc");

function xmlrpc_loop_detect() {

	if ($config['hasync']) {

		$synchronizetoip = $config['hasync']['synchronizetoip'];

	}

	}

}

$xmlrpc_g = array(

	"return" => array(

$exec_php_doc = gettext("XMLRPC wrapper for eval(). This method must be called with two parameters: a string containing the local system\'s password followed by the PHP code to evaluate.");

$exec_php_sig = array(

	array(

function xmlrpc_authfail() {

function exec_php_xmlrpc($raw_params) {

	$params = xmlrpc_params_to_php($raw_params);

	if (!xmlrpc_auth($params)) {

		xmlrpc_authfail();

		return $xmlrpc_g['return']['authfail'];

	}

	$exec_php = $params[0];

	if ($toreturn) {

		$response = XML_RPC_encode($toreturn);

	} else {

		return $xmlrpc_g['return']['true'];

	}

}

$exec_shell_doc = gettext("XMLRPC wrapper for mwexec(). This method must be called with two parameters: a string containing the local system\'s password followed by an shell command to execute.");

$exec_shell_sig = array(

	array(

	$params = xmlrpc_params_to_php($raw_params);

	if (!xmlrpc_auth($params)) {

		xmlrpc_authfail();

		return $xmlrpc_g['return']['authfail'];

	}

	$shell_cmd = $params[0];

	return $xmlrpc_g['return']['true'];

$backup_config_section_doc = gettext("XMLRPC wrapper for backup_config_section. This method must be called with two parameters: a string containing the local system\'s password followed by an array containing the keys to be backed up.");

$backup_config_section_sig = array(

	array(

function backup_config_section_xmlrpc($raw_params) {

	global $config, $xmlrpc_g;

	if (xmlrpc_loop_detect()) {

		log_error("Disallowing CARP sync loop");

		return;

	$params = xmlrpc_params_to_php($raw_params);

	if (!xmlrpc_auth($params)) {

		xmlrpc_authfail();

		return $xmlrpc_g['return']['authfail'];

	}

	$val = array_intersect_key($config, array_flip($params[0]));

	return new XML_RPC_Response(XML_RPC_encode($val));

}

/*****************************/

$restore_config_section_doc = gettext("XMLRPC wrapper for restore_config_section. This method must be called with two parameters: a string containing the local system\'s password and an array to merge into the system\'s config. This function returns true upon completion.");

$restore_config_section_sig = array(

	array(

function restore_config_section_xmlrpc($raw_params) {

	global $config, $xmlrpc_g;

	$old_config = $config;

	$old_ipsec_enabled = ipsec_enabled();

	if (xmlrpc_loop_detect()) {

		log_error("Disallowing CARP sync loop");

		return;

	$params = xmlrpc_params_to_php($raw_params);

	if (!xmlrpc_auth($params)) {

		xmlrpc_authfail();

		return $xmlrpc_g['return']['authfail'];

	}

	$sync_full = array('dnsmasq', 'unbound', 'ipsec', 'aliases', 'wol', 'load_balancer', 'openvpn', 'cert', 'ca', 'crl', 'schedules', 'filter', 'nat', 'dhcpd', 'dhcpv6');

	$sync_full_done = array();

	$vipbackup = array();

	$oldvips = array();

	if (isset($params[0]['virtualip'])) {

		if (is_array($config['virtualip']['vip'])) {

			foreach ($config['virtualip']['vip'] as $vipindex => $vip) {

				if ($vip['mode'] == "carp") {

				} else if ($vip['mode'] == "ipalias" && (substr($vip['interface'], 0, 4) == '_vip' || strstr($vip['interface'], "lo0"))) {

					$oldvips[$vip['subnet']]['content'] = "{$vip['interface']}{$vip['subnet']}{$vip['subnet_bits']}";

				} else if (($vip['mode'] == "ipalias" || $vip['mode'] == 'proxyarp') && !(substr($vip['interface'], 0, 4) == '_vip') || strstr($vip['interface'], "lo0")) {

					$vipbackup[] = $vip;

				}

			}

		}

	// For vip section, first keep items sent from the master

	$config = array_merge_recursive_unique($config, $params[0]);

	/* Then add ipalias and proxyarp types already defined on the backup */

	if (is_array($vipbackup) && !empty($vipbackup)) {

		if (!is_array($config['virtualip'])) {

			$config['virtualip'] = array();

		}

			$config['virtualip']['vip'] = array();

		}

			array_unshift($config['virtualip']['vip'], $vip);

		}

	}

	$mergedkeys = implode(",", array_merge(array_keys($params[0]), $sync_full_done));

	write_config(sprintf(gettext("Merged in config (%s sections) from XMLRPC client."), $mergedkeys));

	/*

	 * The real work on handling the vips specially

	if (isset($params[0]['virtualip']) && is_array($config['virtualip']) && is_array($config['virtualip']['vip'])) {

		$carp_setuped = false;

		$anyproxyarp = false;

		foreach ($config['virtualip']['vip'] as $vip) {

			if ($vip['mode'] == "carp" && isset($oldvips["{$vip['interface']}_vip{$vip['vhid']}"])) {

				if ($oldvips["{$vip['interface']}_vip{$vip['vhid']}"]['content'] == "{$vip['password']}{$vip['advskew']}{$vip['subnet']}{$vip['subnet_bits']}{$vip['advbase']}") {

					if (does_vip_exist($vip)) {

						unset($oldvips["{$vip['interface']}_vip{$vip['vhid']}"]);

						continue; // Skip reconfiguring this vips since nothing has changed.

					}

				}

			} else if ($vip['mode'] == "ipalias" && (substr($vip['interface'], 0, 4) == '_vip' || strstr($vip['interface'], "lo0")) && isset($oldvips[$vip['subnet']])) {

				if ($oldvips[$vip['subnet']]['content'] == "{$vip['interface']}{$vip['subnet']}{$vip['subnet_bits']}") {

					if (does_vip_exist($vip)) {

			}

				case "proxyarp":

			}

		foreach ($oldvips as $oldvipar) {

			if (!empty($oldvipif)) {

				if (is_ipaddrv6($oldvipar['subnet'])) {

					 mwexec("/sbin/ifconfig " . escapeshellarg($oldvipif) . " inet6 " . escapeshellarg($oldvipar['subnet']) . " delete");

				} else {

					pfSense_interface_deladdress($oldvipif, $oldvipar['subnet']);

				}

			}

		}

		if ($carp_setuped == true) {

			interfaces_sync_setup();

		}

			interface_proxyarp_configure();

		}

	}

	if ($old_ipsec_enabled !== ipsec_enabled()) {

		vpn_ipsec_configure();

	}

	return $xmlrpc_g['return']['true'];

}

/*****************************/

$merge_installedpackages_section_doc = gettext("XMLRPC wrapper for merging package sections. This method must be called with two parameters: a string containing the local system\'s password and an array to merge into the system\'s config. This function returns true upon completion.");

	array(

	if (xmlrpc_loop_detect()) {

		log_error("Disallowing CARP sync loop");

		return;

	$params = xmlrpc_params_to_php($raw_params);

	if (!xmlrpc_auth($params)) {

		xmlrpc_authfail();

		return $xmlrpc_g['return']['authfail'];

	}

	$config['installedpackages'] = array_merge($config['installedpackages'], $params[0]);

	write_config(sprintf(gettext("Merged in config (%s sections) from XMLRPC client."), $mergedkeys));

	return $xmlrpc_g['return']['true'];

/*****************************/

$merge_config_section_doc = gettext("XMLRPC wrapper for merge_config_section. This method must be called with two parameters: a string containing the local system\'s password and an array to merge into the system\'s config. This function returns true upon completion.");

$merge_config_section_sig = array(

	array(

	if (xmlrpc_loop_detect()) {

		log_error("Disallowing CARP sync loop");

		return;

	$params = xmlrpc_params_to_php($raw_params);

	if (!xmlrpc_auth($params)) {

		xmlrpc_authfail();

		return $xmlrpc_g['return']['authfail'];

	}

	$config_new = array_overlay($config, $params[0]);

	$config = $config_new;

}

$filter_configure_doc = gettext("Basic XMLRPC wrapper for filter_configure. This method must be called with one parameter: a string containing the local system\'s password. This function returns true upon completion.");

$filter_configure_sig = array(

	array(

	global $xmlrpc_g, $g, $config;

	$params = xmlrpc_params_to_php($raw_params);

	if (!xmlrpc_auth($params)) {

		xmlrpc_authfail();

		return $xmlrpc_g['return']['authfail'];

	}

	filter_configure();

	system_routing_configure();

	setup_gateways_monitor();

	relayd_configure();

	require_once("openvpn.inc");

	if (isset($config['dnsmasq']['enable'])) {

		/* Configure dnsmasq but tell it NOT to restart DHCP */

	} else {

		/* kill any running Unbound instance since it is not enabled. */

	}

	local_sync_accounts();

	return $xmlrpc_g['return']['true'];

}

/*****************************/

$carp_configure_doc = gettext("Basic XMLRPC wrapper for configuring CARP interfaces.");

$carp_configure_sig = array(

	array(

	if (xmlrpc_loop_detect()) {

		log_error("Disallowing CARP sync loop");

		return;

	$params = xmlrpc_params_to_php($raw_params);

	if (!xmlrpc_auth($params)) {

		xmlrpc_authfail();

		return $xmlrpc_g['return']['authfail'];

	}

	interfaces_vips_configure();

	return $xmlrpc_g['return']['true'];

$pfsense_firmware_version_doc = gettext("Basic XMLRPC wrapper for host_firmware_version. This function will return the output of host_firmware_version upon completion.");

	array (

);

		global $xmlrpc_g;

		$params = xmlrpc_params_to_php($raw_params);

			xmlrpc_authfail();

		return new XML_RPC_Response(XML_RPC_encode(host_firmware_version()));

}

/*****************************/

$reboot_doc = gettext("Basic XMLRPC wrapper for rc.reboot.");

$reboot_sig = array(array($XML_RPC_Boolean, $XML_RPC_String));

function reboot_xmlrpc($raw_params) {

	global $xmlrpc_g;

	$params = xmlrpc_params_to_php($raw_params);

	if (!xmlrpc_auth($params)) {

		xmlrpc_authfail();

		return $xmlrpc_g['return']['authfail'];

	}

	mwexec_bg("/etc/rc.reboot");

	return $xmlrpc_g['return']['true'];

}

/*****************************/

	array(

function get_notices_xmlrpc($raw_params) {

	global $g, $xmlrpc_g;

	$params = xmlrpc_params_to_php($raw_params);

	if (!xmlrpc_auth($params)) {

		xmlrpc_authfail();

	if (!function_exists("get_notices")) {

		require_once("notices.inc");

	}

		$toreturn = get_notices();

		$toreturn = get_notices($params);

	}

	return $response;

$xmlrpclockkey = lock('xmlrpc', LOCK_EX);

/*****************************/

$server = new XML_RPC_Server(

	array(

		'pfsense.exec_shell' => array('function' => 'exec_shell_xmlrpc',

			'signature' => $exec_shell_sig,

		'pfsense.exec_php' => array('function' => 'exec_php_xmlrpc',

			'signature' => $exec_php_sig,

			'docstring' => $exec_php_doc),

		'pfsense.filter_configure' => array('function' => 'filter_configure_xmlrpc',

			'signature' => $filter_configure_sig,

		'pfsense.interfaces_carp_configure' => array('function' => 'interfaces_carp_configure_xmlrpc',

			'signature' => $carp_configure_sig,

		'pfsense.backup_config_section' => array('function' => 'backup_config_section_xmlrpc',

			'signature' => $backup_config_section_sig,

		'pfsense.restore_config_section' => array('function' => 'restore_config_section_xmlrpc',

			'signature' => $restore_config_section_sig,

		'pfsense.merge_config_section' => array('function' => 'merge_config_section_xmlrpc',

			'signature' => $merge_config_section_sig,

		'pfsense.merge_installedpackages_section_xmlrpc' => array('function' => 'merge_installedpackages_section_xmlrpc',

			'signature' => $merge_installedpackages_section_sig,

		'pfsense.host_firmware_version' => array('function' => 'pfsense_firmware_version_xmlrpc',

			'signature' => $pfsense_firmware_version_sig,

			'docstring' => $pfsense_firmware_version_doc),

		'pfsense.reboot' => array('function' => 'reboot_xmlrpc',

			'signature' => $reboot_sig,

		'pfsense.get_notices' => array('function' => 'get_notices_xmlrpc',

			'signature' => $get_notices_sig)

	)

);

unlock($xmlrpclockkey);

function array_overlay($a1, $a2) {

	foreach ($a1 as $k => $v) {

		if (!array_key_exists($k, $a2)) {

			continue;

			$a1[$k] = array_overlay($v, $a2[$k]);

		} else {

?>