pfSense

<?php

/****h* pfSense/config

 * NAME

 *   This include contains various config.xml specific functions.

 * HISTORY

 * $Id$

 ******

	config.lib.inc

	Ported from config.inc by Erik Kristensen

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

	Copyright (C) 2003-2004 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.

*/

/****f* config/encrypted_configxml

 * NAME

 *   encrypted_configxml - Checks to see if config.xml is encrypted and if so, prompts to unlock.

 * INPUTS

 *   None

 * RESULT

 *   $config 	- rewrites config.xml without encryption

 ******/

function encrypted_configxml() {

	global $g, $config;

	if (!file_exists($g['conf_path'] . "/config.xml"))

		return;

	if (!$g['booting'])

		return;

	$configtxt = file_get_contents($g['conf_path'] . "/config.xml");			

	if(tagfile_deformat($configtxt, $configtxt, "config.xml")) {

		$fp = fopen('php://stdin', 'r');

		$data = "";

		echo "\n\n*** Encrypted config.xml detected ***\n";

		while($data == "") {

			echo "\nEnter the password to decrypt config.xml: ";

			$decrypt_password = chop(fgets($fp));

			$data = decrypt_data($configtxt, $decrypt_password);

			if(!strstr($data, "<pfsense>"))

				$fd = fopen($g['conf_path'] . "/config.xml.tmp", "w");

				fwrite($fd, $data);

				fclose($fd);

				exec("/bin/mv {$g['conf_path']}/config.xml.tmp {$g['conf_path']}/config.xml");

				echo "\nConfig.xml unlocked.\n";

				fclose($fp);

			} else {

				echo "\nInvalid password entered.  Please try again.\n";

		}

	}

}

/****f* config/parse_config

 * NAME

 *   parse_config - Read in config.cache or config.xml if needed and return $config array

 * INPUTS

 *   $parse       - boolean to force parse_config() to read config.xml and generate config.cache

 * RESULT

 *   $config      - array containing all configuration variables

 ******/

		$last_backup = discover_last_backup();

		if($last_backup) {

			log_error("No config.xml found, attempting last known config restore.");

			file_notice("config.xml", "No config.xml found, attempting last known config restore.", "pfSenseConfigurator", "");

			restore_backup("{$g['conf_path']}/backup/{$last_backup}");

		} else {

			unlock($lockkey);

			die("Config.xml is corrupted and is 0 bytes.  Could not restore a previous backup.");

		}

	}

	if($g['booting'])

		echo ".";

	encrypted_configxml();

				$parse = true;

		} else

			$parse = true;

	}

	if ($parse == true) {

				echo ".";

			file_notice("config.xml", "No config.xml found, attempting last known config restore.", "pfSenseConfigurator", "");

			$last_backup = discover_last_backup();

			if ($last_backup)

				restore_backup("/cf/conf/backup/{$last_backup}");

				die("Config.xml is corrupted and is 0 bytes.  Could not restore a previous backup.");

			}

			if ($last_backup)

				restore_backup("/cf/conf/backup/{$last_backup}");

				die("Config.xml is corrupted and is 0 bytes.  Could not restore a previous backup.");

			}

		generate_config_cache($config);

	}

	if($g['booting'])

		echo ".";

	unlock($lockkey);

}

/****f* config/generate_config_cache

 * NAME

 *   generate_config_cache - Write serialized configuration to cache.

 * INPUTS

 *   $config	- array containing current firewall configuration

 * RESULT

 *   boolean	- true on completion

 ******/

function generate_config_cache($config) {

	$configcache = fopen($g['tmp_path'] . '/config.cache', "w");

	fwrite($configcache, serialize($config));

	fclose($configcache);

	/* Used for config.extra.xml */

	if(file_exists($g['tmp_path'] . '/config.extra.cache') && $config_extra) {

		$configcacheextra = fopen($g['tmp_path'] . '/config.extra.cache', "w");

		fwrite($configcacheextra, serialize($config_extra));

		fclose($configcacheextra);		

		unset($configcacheextra);

	}

function discover_last_backup() {

        $backups = split("\n", `cd /cf/conf/backup && ls -ltr *.xml | awk '{print \$9}'`);

	$last_backup = "";

        foreach($backups as $backup)

        	if($backup)

	        	$last_backup = $backup;

        return $last_backup;

}

function restore_backup($file) {

	global $g;

	if (file_exists($file)) {

		conf_mount_rw();

		unlink_if_exists("{$g['tmp_path']}/config.cache");

	}

}

/****f* config/parse_config_bootup

 * NAME

 *   parse_config_bootup - Bootup-specific configuration checks.

 * RESULT

 *   null

 ******/

function parse_config_bootup() {

		echo ".";

	$lockkey = lock('config');

		if ($g['booting']) {

			if (strstr($g['platform'], "cdrom")) {

				/* try copying the default config. to the floppy */

				echo "Resetting factory defaults...\n";

				reset_factory_defaults(true);

				if (!file_exists("{$g['conf_path']}/config.xml")) {

					echo "No XML configuration file found - using factory defaults.\n";

					echo "Make sure that the configuration floppy disk with the conf/config.xml\n";

					echo "file is inserted. If it isn't, your configuration changes will be lost\n";

					echo "on reboot.\n";

			} else {

				if($last_backup) {

					log_error("No config.xml found, attempting last known config restore.");

					file_notice("config.xml", "No config.xml found, attempting last known config restore.", "pfSenseConfigurator", "");

					restore_backup("/cf/conf/backup/{$last_backup}");

				}

				if(!file_exists("{$g['conf_path']}/config.xml")) {

					echo "XML configuration file not found.  {$g['product_name']} cannot continue booting.\n";

					exit;

				}

				log_error("Last known config found and restored.  Please double check your configuration file for accuracy.");

				file_notice("config.xml", "Last known config found and restored.  Please double check your configuration file for accuracy.", "pfSenseConfigurator", "");

			unlock($lockkey);

			exit(0);

	}

		$last_backup = discover_last_backup();

		if($last_backup) {

			log_error("No config.xml found, attempting last known config restore.");

			file_notice("config.xml", "No config.xml found, attempting last known config restore.", "pfSenseConfigurator", "");

			restore_backup("{$g['conf_path']}/backup/{$last_backup}");

		} else {

			unlock($lockkey);

			die("Config.xml is corrupted and is 0 bytes.  Could not restore a previous backup.");

		}

	}

	unlock($lockkey);

	parse_config(true);

	if ((float)$config['version'] > (float)$g['latest_config']) {

		echo <<<EOD

*******************************************************************************

* WARNING!                                                                    *

* The current configuration has been created with a newer version of {$g['product_name']}  *

* than this one! This can lead to serious misbehavior and even security       *

* holes! You are urged to either upgrade to a newer version of {$g['product_name']} or     *

* revert to the default configuration immediately!                            *

*******************************************************************************

EOD;

		}

	/* make alias table (for faster lookups) */

	alias_make_table($config);

}

/****f* config/conf_mount_rw

 * NAME

 *   conf_mount_rw - Mount filesystems read/write.

 * RESULT

 *   null

 ******/

/* mount flash card read/write */

	/* do not mount on cdrom platform */

	if($g['platform'] == "cdrom" or $g['platform'] == "pfSense")

		return;

	if (refcount_reference(1000) > 1)

		if($g['booting'])

			echo "Disk is dirty.  Running fsck -y\n";

		mwexec("/sbin/fsck -y {$g['cf_path']}");

	/*    if the platform is soekris or wrap or pfSense, lets mount the

	 *    compact flash cards root.

	if($status <> 0) {

		log_error("File system is dirty.  Launching FSCK for /");

		mwexec("/sbin/fsck -y /");

	mark_subsystem_dirty('mount');

}

/****f* config/conf_mount_ro

 * NAME

 *   conf_mount_ro - Mount filesystems readonly.

 * RESULT

 *   null

 ******/

	if($g['platform'] == "cdrom" or $g['platform'] == "pfSense")

		return;

	clear_subsystem_dirty('mount');

	/* sync data, then force a remount of /cf */

	mwexec("/sbin/mount -u -r -f -o sync,noatime /");

/****f* config/convert_config

 * NAME

 *   convert_config - Attempt to update config.xml.

 * DESCRIPTION

 *   convert_config() reads the current global configuration

 *   and attempts to convert it to conform to the latest

 *   config.xml version. This allows major formatting changes

 *   to be made with a minimum of breakage.

 * RESULT

 *   null

 ******/

/* convert configuration, if necessary */

function convert_config() {

	global $config, $g;

	$now = date("H:i:s");

	log_error("Start Configuration upgrade at $now, set execution timeout to 15 minutes");

	/* special case upgrades */

	/* fix every minute crontab bogons entry */

	$cron_item_count = count($config['cron']['item']);

	for($x=0; $x<$cron_item_count; $x++) {

		if(stristr($config['cron']['item'][$x]['command'], "rc.update_bogons.sh")) {

			if($config['cron']['item'][$x]['hour'] == "*" ) {

		        $config['cron']['item'][$x]['hour'] = "3";

		 		write_config("Updated bogon update frequency to 3am");

		 		log_error("Updated bogon update frequency to 3am");

		 	}       

		}

	}

	if ($config['version'] == $g['latest_config'])

		return;		/* already at latest version */

	// Save off config version

	$prev_version = $config['version'];

		include_once("upgrade_config_custom.inc");

	while ($config['version'] < $g['latest_config']) {

		$cur = $config['version'] * 10;

		$next = $cur + 1;

		$migration_function = sprintf('upgrade_%03d_to_%03d', $cur, $next);

			$migration_function();

		if (function_exists($migration_function))

			$migration_function();

			echo ".";

	$now = date("H:i:s");

	log_error("Ended Configuration upgrade at $now");

	if ($prev_version != $config['version'])

		write_config("Upgraded config version level from {$prev_version} to {$config['version']}");

}

 * NAME

 *   safe_write_file - Write a file out atomically

 * DESCRIPTION

 *   safe_write_file() Writes a file out atomically by first writing to a

 *   temporary file of the same name but ending with the pid of the current

 *   process, them renaming the temporary file over the original.

 * INPUTS

 *   $filename  - string containing the filename of the file to write

 *   $content   - string containing the file content to write to file

 *   $force_binary      - boolean denoting whether we should force binary

 *   mode writing.

 * RESULT

 *   boolean - true if successful, false if not

 ******/

function safe_write_file($file, $content, $force_binary) {

	$write_mode = $force_binary ? "wb" : "w";

	if (!$fd) {

		// Unable to open temporary file for writing

		return false;

		// Unable to write to temporary file

	}

	fflush($fd);

	fclose($fd);

		// Unable to move temporary file to original

		@unlink($tmp_file);

		return false;

	}

	pfSense_sync();

 * NAME

 *   write_config - Backup and write the firewall configuration.

 * DESCRIPTION

 *   write_config() handles backing up the current configuration,

 *   applying changes, and regenerating the configuration cache.

 * INPUTS

 *   $desc	- string containing the a description of configuration changes

 *   $backup	- boolean: do not back up current configuration if false.

 * RESULT

 *   null

 ******/

/* save the system configuration */

function write_config($desc="Unknown", $backup = true) {

	global $config, $g;

	 *       for now, since it was preventing config saving. */

	// $config = parse_config(true, false, false);

	 *   make this problematic, and it makes users think there is a problem

	 *   when one doesn't really exist.

		backup_config();

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

	/* Log the running script so it's not entirely unlogged what changed */

	$config['revision']['username'] = $username;

	$lockkey = lock('config', LOCK_EX);

	/* generate configuration XML */

	$xmlconfig = dump_xml_config($config, $g['xml_rootobj']);

	if (!safe_write_file("{$g['cf_conf_path']}/config.xml", $xmlconfig, false)) {

		unlock($lockkey);

		cleanup_backupcache(5, true);

	} else {

		cleanup_backupcache(30, true);

	}

	/* re-read configuration */

		$last_backup = discover_last_backup();

		if ($last_backup)

			restore_backup("/cf/conf/backup/{$last_backup}");

		else

			log_error(gettext("Could not restore config.xml."));

	} else

		generate_config_cache($config);

	unlock($lockkey);

	unlink_if_exists("/usr/local/pkg/pf/carp_sync_client.php");

	conf_mount_ro();

	if(is_dir("/usr/local/pkg/write_config")) {

		/* process packager manager custom rules */

		run_plugins("/usr/local/pkg/write_config/");

	}

	return $config;

}

/****f* config/reset_factory_defaults

 * NAME

 *   reset_factory_defaults - Reset the system to its default configuration.

 * RESULT

 *   integer	- indicates completion

 ******/

function reset_factory_defaults($lock = false) {

	global $g;

	conf_mount_rw();

		$lockkey = lock('config', LOCK_EX);

	/* create conf directory, if necessary */

	safe_mkdir("{$g['cf_conf_path']}");

	/* clear out /conf */

	$dh = opendir($g['conf_path']);

	while ($filename = readdir($dh)) {

		if (($filename != ".") && ($filename != "..")) {

			unlink_if_exists($g['conf_path'] . "/" . $filename);

		}

	}

	closedir($dh);

	/* copy default configuration */

	copy("{$g['conf_default_path']}/config.xml", "{$g['conf_path']}/config.xml");

	touch("/conf/trigger_initial_wizard");

	if (!$lock)

		unlock($lockkey);

	return 0;

}

function config_restore($conffile) {

	global $config, $g;

	if (!file_exists($conffile))

		return 1;

	backup_config();

	unlink_if_exists("{$g['tmp_path']}/config.cache");

	$config = parse_config(true);

	conf_mount_ro();

}

function config_install($conffile) {

	global $config, $g;

	if (!file_exists($conffile))

		return 1;

	if (!config_validate("{$conffile}"))

		return 1;

	if($g['booting'] == true)

		echo "Installing configuration...\n";

	else

		log_error("Installing configuration ....");

	conf_mount_rw();

	copy($conffile, "{$g['conf_path']}/config.xml");

	if(file_exists("{$g['tmp_path']}/config.cache"))

		unlink("{$g['tmp_path']}/config.cache");

	unlock($lockkey);

	conf_mount_ro();

    return 0;

}

 * Disable security checks for DNS rebind and HTTP referrer until next time

 * they pass (or reboot), to aid in preventing accidental lockout when

 * restoring settings like hostname, domain, IP addresses, and settings

 * related to the DNS rebind and HTTP referrer checks.

 * Intended for use when restoring a configuration or directly

 * modifying config.xml without an unconditional reboot.

 */

function disable_security_checks() {

	global $g;

	touch("{$g['tmp_path']}/disable_security_checks");

}

/* Restores security checks.  Should be called after all succeed. */

function restore_security_checks() {

	global $g;

	unlink_if_exists("{$g['tmp_path']}/disable_security_checks");

}

/* Returns status of security check temporary disable. */

function security_checks_disabled() {

	global $g;

	return file_exists("{$g['tmp_path']}/disable_security_checks");

}

	global $g, $xmlerr;

	$xml_parser = xml_parser_create();

	if (!($fp = fopen($conffile, "r"))) {

		$xmlerr = "XML error: unable to open file";

		return false;

	}

	while ($data = fread($fp, 4096)) {

		if (!xml_parse($xml_parser, $data, feof($fp))) {

			$xmlerr = sprintf("%s at line %d",

						xml_error_string(xml_get_error_code($xml_parser)),

						xml_get_current_line_number($xml_parser));

			return false;

		}

	}

	xml_parser_free($xml_parser);

	fclose($fp);

	return true;

}

function cleanup_backupcache($revisions = 30, $lock = false) {

	global $g;

	$i = false;

	if (!$lock)

		$lockkey = lock('config');

	conf_mount_rw();

	$backups = get_backups();

	if ($backups) {