pfSense

<?php

/* $Id$ */

/*

	diag_backup.php

	Copyright (C) 2004-2009 Scott Ullrich

	All rights reserved.

	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.

*/

/*

	pfSense_BUILDER_BINARIES:	/sbin/shutdown

	pfSense_MODULE:	backup

*/

##|+PRIV

##|*IDENT=page-diagnostics-backup/restore

##|*NAME=Diagnostics: Backup/restore page

##|*DESCR=Allow access to the 'Diagnostics: Backup/restore' page.

##|*MATCH=diag_backup.php*

##|-PRIV

/* Allow additional execution time 0 = no limit. */

ini_set('max_execution_time', '0');

ini_set('max_input_time', '0');

/* omit no-cache headers because it confuses IE with file downloads */

$omit_nocacheheaders = true;

require("guiconfig.inc");

require_once("functions.inc");

require_once("filter.inc");

require_once("shaper.inc");

function add_base_packages_menu_items() {

	global $g, $config;

	$base_packages = split($g['base_packages'], ",");

	$modified_config = false;

	foreach($base_packages as $bp) {

		$basepkg_path = "/usr/local/pkg/{$bp}";

		$tmpinfo = pathinfo($basepkg_path, PATHINFO_EXTENSION); 

		if($tmpinfo['extension'] == "xml" && file_exists($basepkg_path)) {

			$pkg_config = parse_xml_config_pkg($basepkg_path, "packagegui");

			if($pkg_config['menu'] != "") {

				if(is_array($pkg_config['menu'])) {

					foreach($pkg_config['menu'] as $menu) {

						if(is_array($config['installedpackages']['menu']))

							foreach($config['installedpackages']['menu'] as $amenu)

								if($amenu['name'] == $menu['name'])

									continue;

						$config['installedpackages']['menu'][] = $menu;

						$modified_config = true;

					}

				}

				$static_output .= "done.\n";

				update_output_window($static_output);

			}

		}

	}

	if($modified_config) {

		write_confg("Restored base_package menus after configuration restore.");

		$config = parse_config(true);

	}

}

function remove_bad_chars($string) {

	return preg_replace('/[^a-z|_|0-9]/i','',$string);

}

function check_and_returnif_section_exists($section) {

	global $config;

	if(is_array($config[$section]))

		return true;

	return false;

}

function spit_out_select_items($area, $showall) {

	global $config;

	$areas = array("aliases" => "Aliases", 

				   "captiveportal" => "Captive Portal",

				   "dnsmasq" => "DNS Forwarder",				

				   "dhcpd" => "DHCP Server",

				   "filter" => "Firewall Rules",

				   "interfaces" => "Interfaces",

				   "ipsec" => "IPSEC",

				   "nat" => "NAT",

				   "ovpn" => "OpenVPN",

				   "installedpackages" => "Package Manager",

				   "pptpd" => "PPTP Server",

				   "cron" => "Scheduled Tasks",				

				   "syslog" => "Syslog",

				   "system" => "System",

				   "staticroutes" => "Static routes",

				   "sysctl" => "System tunables",

				   "snmpd" => "SNMP Server",

				   "shaper" => "Traffic Shaper",

				   "vlans" => "VLANS",

				   "wol" => "Wake on LAN"

	);

	$select  = "<select name=\"{$area}\">\n";

	$select .= "<option VALUE=\"\">ALL</option>";

	if($showall == true) 

		foreach($areas as $area => $areaname)

			$select .= "<option value='{$area}'>{$areaname}</option>\n";

	else 

		foreach($areas as $area => $areaname)

			if(check_and_returnif_section_exists($area) == true)

				$select .= "<option value='{$area}'>{$areaname}</option>\n";

	$select .= "</select>\n";

	echo $select;

}

if ($_POST['apply']) {

        ob_flush();

        flush();

		conf_mount_rw();

		clear_subsystem_dirty("restore");

		conf_mount_ro();

        exit;

}

if ($_POST) {

	unset($input_errors);

	if (stristr($_POST['Submit'], "Restore configuration"))

		$mode = "restore";

	else if (stristr($_POST['Submit'], "Reinstall"))

		$mode = "reinstallpackages";

	else if (stristr($_POST['Submit'], "Download"))

		$mode = "download";

	else if (stristr($_POST['Submit'], "Restore version"))

		$mode = "restore_ver";

	if ($_POST["nopackages"] <> "")

		$options = "nopackages";

	if ($_POST["ver"] <> "")

		$ver2restore = $_POST["ver"];

	if ($mode) {

		if ($mode == "download") {

			if ($_POST['encrypt']) {

				if(!$_POST['encrypt_password'] || !$_POST['encrypt_passconf'])

					$input_errors[] = "You must supply and confirm the password for encryption.";

				if($_POST['encrypt_password'] != $_POST['encrypt_passconf'])

					$input_errors[] = "The supplied 'Password' and 'Confirm' field values must match.";

			}

			if (!$input_errors) {

				//$lockbckp = lock('config');

				$host = "{$config['system']['hostname']}.{$config['system']['domain']}";

				$name = "config-{$host}-".date("YmdHis").".xml";

				$data = "";

				if($options == "nopackages") {

					if(!$_POST['backuparea']) {

						/* backup entire configuration */

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

					} else {

						/* backup specific area of configuration */

						$data = backup_config_section($_POST['backuparea']);

						$name = "{$_POST['backuparea']}-{$name}";

					}

					$sfn = "{$g['tmp_path']}/config.xml.nopkg";

					file_put_contents($sfn, $data);

					exec("sed '/<installedpackages>/,/<\/installedpackages>/d' {$sfn} > {$sfn}-new");

					$data = file_get_contents($sfn . "-new");					

				} else {

					if(!$_POST['backuparea']) {

						/* backup entire configuration */

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

					} else {

						/* backup specific area of configuration */

						$data = backup_config_section($_POST['backuparea']);

						$name = "{$_POST['backuparea']}-{$name}";

					}

				}

				//unlock($lockbckp);

				if ($_POST['encrypt']) {

					$data = encrypt_data($data, $_POST['encrypt_password']);

					tagfile_reformat($data, $data, "config.xml");

				}

				/* 

				 *  Backup RRD Data

				 */

				if(!$_POST['donotbackuprrd']) {

					$data = str_replace("</pfsense>", "\t<rrddata>", $data);

					$rrd_files_var_db_rrd = split("\n",`cd /var/db/rrd && ls *.rrd`);

					foreach($rrd_files_var_db_rrd as $rrd) {

						if($rrd) {

							$rrd_data = file_get_contents("{$g['vardb_path']}/rrd/{$rrd}");

							if($rrd_data) {

								$data .= "\t\t<rrddatafile>\n";

								$data .= "\t\t\t<filename>{$rrd}</filename>\n";

								$data .= "\t\t\t<data>" . base64_encode($rrd_data) . "</data>\n";

								$data .= "\t\t</rrddatafile>\n";

							}

						}

					}

					$data .= "\t</rrddata>\n";

					$data .= "</pfsense>\n";

				}

				$size = strlen($data);

				header("Content-Type: application/octet-stream");

				header("Content-Disposition: attachment; filename={$name}");

				header("Content-Length: $size");

				echo $data;

				exit;

			}

		}

		if ($mode == "restore") {

			if ($_POST['decrypt']) {

				if(!$_POST['decrypt_password'] || !$_POST['decrypt_passconf'])

					$input_errors[] = "You must supply and confirm the password for decryption.";

				if($_POST['decrypt_password'] != $_POST['decrypt_passconf'])

					$input_errors[] = "The supplied 'Password' and 'Confirm' field values must match.";

			}

			if (!$input_errors) {

				if (is_uploaded_file($_FILES['conffile']['tmp_name'])) {

					/* read the file contents */

					$data = file_get_contents($_FILES['conffile']['tmp_name']);

					if(!$data) {

						log_error("Warning, could not read file " . $_FILES['conffile']['tmp_name']);

						return 1;

					}

					if ($_POST['decrypt']) {

						if (!tagfile_deformat($data, $data, "config.xml")) {

							$input_errors[] = "The uploaded file does not appear to contain an encrypted pfsense configuration.";

							return 1;

						}

						$data = decrypt_data($data, $_POST['decrypt_password']);

					}

					if(stristr($data, "<m0n0wall>")) {

						log_error("Upgrading m0n0wall configuration to pfsense.");

						/* m0n0wall was found in config.  convert it. */

						$data = str_replace("m0n0wall", "pfsense", $data);

						$m0n0wall_upgrade = true;

					}

					if($_POST['restorearea']) {

						/* restore a specific area of the configuration */

						if(!stristr($data, $_POST['restorearea'])) {

							$input_errors[] = "You have selected to restore an area but we could not locate the correct xml tag.";

						} else {

							restore_config_section($_POST['restorearea'], $data);

							filter_configure();

							$savemsg = "The configuration area has been restored.  You may need to reboot the firewall.";

						}

					} else {

						if(!stristr($data, "<" . $g['xml_rootobj'] . ">")) {

							$input_errors[] = "You have selected to restore the full configuration but we could not locate a " . $g['xml_rootobj'] . " tag.";

						} else {

							/* restore the entire configuration */

							file_put_contents($_FILES['conffile']['tmp_name'], $data);

							if (config_install($_FILES['conffile']['tmp_name']) == 0) {

								/* this will be picked up by /index.php */

								conf_mount_rw();

								mark_subsystem_dirty("restore");

								touch("/conf/needs_package_sync");

								/* remove cache, we will force a config reboot */

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

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

								$config = parse_config(true);

								/* extract out rrd items, unset from $confgi when done */

								if($config['rrddata']) {

									foreach($config['rrddata']['rrddatafile'] as $rrd) {

										$rrd_fd = fopen("{$g['vardb_path']}/rrd/{$rrd['filename']}", "w");

										fwrite($rrd_fd, base64_decode($rrd['data']));

										fclose($rrd_fd);

									}

									unset($config['rrddata']);

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

									write_config();

									add_base_packages_menu_items();

									convert_config();

									conf_mount_ro();

								}

								if($m0n0wall_upgrade == true) {

									if($config['system']['gateway'] <> "")

										$config['interfaces']['wan']['gateway'] = $config['system']['gateway'];

									unset($config['shaper']);

									/* optional if list */

									$ifdescrs = get_configured_interface_list(true, true);

									/* remove special characters from interface descriptions */

									if(is_array($ifdescrs))

										foreach($ifdescrs as $iface)

											$config['interfaces'][$iface]['descr'] = remove_bad_chars($config['interfaces'][$iface]['descr']);

									/* check for interface names with an alias */

									if(is_array($ifdescrs)) {

										foreach($ifdescrs as $iface) {

											if(is_alias($config['interfaces'][$iface]['descr'])) {

												// Firewall rules

												$origname = $config['interfaces'][$iface]['descr'];

												$newname  = $config['interfaces'][$iface]['descr'] . "Alias";

												update_alias_names_upon_change('filter', 'rule', 'source', 'address', $newname, $origname);

												update_alias_names_upon_change('filter', 'rule', 'destination', 'address', $newname, $origname);

												// NAT Rules

												update_alias_names_upon_change('nat', 'rule', 'target', '', $newname, $origname);

												update_alias_names_upon_change('nat', 'rule', 'external-port', '', $newname, $origname);

												update_alias_names_upon_change('nat', 'rule', 'local-port', '', $newname, $origname);

												// Alias in an alias

												update_alias_names_upon_change('aliases', 'alias', 'address', '', $newname, $origname);

											}

										}

									}

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

									// Reset configuration version to something low

									// in order to force the config upgrade code to 

									// run through with all steps that are required.

									$config['system']['version'] = "1.0";

									// Deal with descriptions longer than 63 characters

									for ($i = 0; isset($config["filter"]["rule"][$i]); $i++) {

										if(count($config['filter']['rule'][$i]['descr']) > 63)

											$config['filter']['rule'][$i]['descr'] = substr($config['filter']['rule'][$i]['descr'], 0, 63);

									}

									// Move interface from ipsec to enc0

									for ($i = 0; isset($config["filter"]["rule"][$i]); $i++) {

										if($config['filter']['rule'][$i]['interface'] == "ipsec")

											$config['filter']['rule'][$i]['interface'] = "enc0";

									}

									// Convert icmp types

									// http://www.openbsd.org/cgi-bin/man.cgi?query=icmp&sektion=4&arch=i386&apropos=0&manpath=OpenBSD+Current

									for ($i = 0; isset($config["filter"]["rule"][$i]); $i++) {

										if($config["filter"]["rule"][$i]['icmptype']) {

											switch($config["filter"]["rule"][$i]['icmptype']) {

												case "echo":

													$config["filter"]["rule"][$i]['icmptype'] = "echoreq";

													break;

					                            case "unreach":

													$config["filter"]["rule"][$i]['icmptype'] = "unreach";

													break;

					                            case "echorep":

													$config["filter"]["rule"][$i]['icmptype'] = "echorep";

													break;

					                            case "squench":

													$config["filter"]["rule"][$i]['icmptype'] = "squench";

													break;

					                            case "redir":

													$config["filter"]["rule"][$i]['icmptype'] = "redir";

													break;

					                            case "timex":

													$config["filter"]["rule"][$i]['icmptype'] = "timex";

													break;

					                            case "paramprob":

													$config["filter"]["rule"][$i]['icmptype'] = "paramprob";

													break;

					                            case "timest":

													$config["filter"]["rule"][$i]['icmptype'] = "timereq";

													break;

					                            case "timestrep":

													$config["filter"]["rule"][$i]['icmptype'] = "timerep";

													break;

					                            case "inforeq":

													$config["filter"]["rule"][$i]['icmptype'] = "inforeq";

													break;

					                            case "inforep":

													$config["filter"]["rule"][$i]['icmptype'] = "inforep";

													break;

					                            case "maskreq":

													$config["filter"]["rule"][$i]['icmptype'] = "maskreq";

													break;

					                            case "maskrep":

													$config["filter"]["rule"][$i]['icmptype'] = "maskrep";

													break;

											}

										}

									}

									$config['diag']['ipv6nat'] = true;

									write_config();

									add_base_packages_menu_items();									

									convert_config();

									conf_mount_ro();

									$savemsg = "The m0n0wall configuration has been restored and upgraded to pfSense.";

									mark_subsystem_dirty("restore");

								}

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

									/* for some reason ipfw doesn't init correctly except on bootup sequence */

									mark_subsystem_dirty("restore");

								}

								setup_serial_port();

								if(is_interface_mismatch() == true) {

									touch("/var/run/interface_mismatch_reboot_needed");

									clear_subsystem_dirty("restore");

									convert_config();

									header("Location: interfaces_assign.php");

									exit;

								}

							} else {

								$input_errors[] = "The configuration could not be restored.";

							}

						}

					}

				} else {

					$input_errors[] = "The configuration could not be restored (file upload error).";

				}

			}

		}

		if ($mode == "reinstallpackages") {

			header("Location: pkg_mgr_install.php?mode=reinstallall");

			exit;

                } else if ($mode == "restore_ver") {

			$input_errors[] = "XXX - this feature may hose your config (do NOT backrev configs!) - billm";

			if ($ver2restore <> "") {

				$conf_file = "{$g['cf_conf_path']}/bak/config-" . strtotime($ver2restore) . ".xml";

				if (config_install($conf_file) == 0) {

						mark_subsystem_dirty("restore");

                        } else {

                        	$input_errors[] = "The configuration could not be restored.";

                        }

                } else {

                        $input_errors[] = "No version selected.";

                }

		}

	}

}

$id = rand() . '.' . time();

$mth = ini_get('upload_progress_meter.store_method');

$dir = ini_get('upload_progress_meter.file.filename_template');

$pgtitle = array("Diagnostics","Backup/restore");

include("head.inc");

?>

<body link="#0000CC" vlink="#0000CC" alink="#0000CC">

<?php include("fbegin.inc"); ?>

<script language="JavaScript">

<!--

function encrypt_change() {

	if (!document.iform.encrypt.checked)

		document.getElementById("encrypt_opts").style.display="none";

	else

		document.getElementById("encrypt_opts").style.display="";

}

function decrypt_change() {

	if (!document.iform.decrypt.checked)

		document.getElementById("decrypt_opts").style.display="none";

	else

		document.getElementById("decrypt_opts").style.display="";

}

//-->

</script>

<?php if ($input_errors) print_input_errors($input_errors); ?>

<?php if ($savemsg) print_info_box($savemsg); ?>

<?php if (is_subsystem_dirty('restore')): ?><p>

<form action="reboot.php" method="post">

<input name="Submit" type="hidden" value=" Yes ">

<?php print_info_box("The firewall configuration has been changed.<br/>The firewall is now rebooting.");?><br>

</form>

<?php endif; ?>

<form action="diag_backup.php" method="post" name="iform" enctype="multipart/form-data">

<table width="100%" border="0" cellspacing="0" cellpadding="0">

	<tr>

		<td>

<?php

		$tab_array = array();

		$tab_array[0] = array("Config History", false, "diag_confbak.php");

		$tab_array[1] = array("Backup/Restore", true, "diag_backup.php");

		display_top_tabs($tab_array);

?>

		</td>

	</tr>

	<tr>

		<td>

			<div id="mainarea">

			<table class="tabcont" align="center" width="100%" border="0" cellpadding="6" cellspacing="0">

				<tr>

					<td colspan="2" class="listtopic">Backup configuration</td>

				</tr>

				<tr>

					<td width="22%" valign="baseline" class="vncell">&nbsp;</td>

					<td width="78%" class="vtable">

						<p>Click this button to download the system configuration in XML format.<br /><br /> Backup area: <?php spit_out_select_items("backuparea", false); ?></p>

						<table>

							<tr>

								<td>

									<input name="nopackages" type="checkbox" class="formcheckbox" id="nopackages">

								</td>

								<td>

									<span class="vexpl">Do not backup package information.</span>

								</td>

							</tr>

						</table>

						<table>

							<tr>

								<td>

									<input name="encrypt" type="checkbox" class="formcheckbox" id="nopackages" onClick="encrypt_change()">

								</td>

								<td>

									<span class="vexpl">Encrypt this configuration file.</span>

								</td>

							</tr>

							<tr>

								<td>

									<input name="donotbackuprrd" type="checkbox" class="formcheckbox" id="dotnotbackuprrd">

								</td>

								<td>

									<span class="vexpl">Do not backup RRD data (NOTE: RRD Data can consume 4+ megabytes of config.xml space!)</span>

								</td>

							</tr>

						</table>

						<table id="encrypt_opts">

							<tr>

								<td>

									<span class="vexpl">Password :</span>

								</td>

								<td>

									<input name="encrypt_password" type="password" class="formfld pwd" size="20" value="" />

								</td>

							</tr>

							<tr>

								<td>

									<span class="vexpl">confirm :</span>

								</td>

								<td>

									<input name="encrypt_passconf" type="password" class="formfld pwd" size="20" value="" />

								</td>

							</tr>

						</table>

						<p><input name="Submit" type="submit" class="formbtn" id="download" value="Download configuration"></p>

					</td>

				</tr>

				<tr>

					<td colspan="2" class="list" height="12">&nbsp;</td>

                </tr>

                <tr>

					<td colspan="2" class="listtopic">Restore configuration</td>

				</tr>

				<tr>

					<td width="22%" valign="baseline" class="vncell">&nbsp;</td>

					<td width="78%" class="vtable">

						Open a <?=$g['[product_name']?> configuration XML file and click the button below to restore the configuration. <br /><br /> Restore area: <?php spit_out_select_items("restorearea", true); ?>

						<p><input name="conffile" type="file" class="formfld unknown" id="conffile" size="40"></p>

						<table>

							<tr>

								<td>

									<input name="decrypt" type="checkbox" class="formcheckbox" id="nopackages" onClick="decrypt_change()">

								</td>

								<td>

									<span class="vexpl">Configuration file is encrypted.</span>

								</td>

							</tr>

						</table>

						<table id="decrypt_opts">

							<tr>

								<td>

									<span class="vexpl">Password :</span>

								</td>

								<td>

									<input name="decrypt_password" type="password" class="formfld pwd" size="20" value="" />

								</td>

							</tr>

							<tr>

								<td>

									<span class="vexpl">confirm :</span>

								</td>

								<td>

									<input name="decrypt_passconf" type="password" class="formfld pwd" size="20" value="" />

								</td>

							</tr>

						</table>

						<p><input name="Submit" type="submit" class="formbtn" id="restore" value="Restore configuration"></p>

                      	<p><strong><span class="red">Note:</span></strong><br />The firewall will reboot after restoring the configuration.<br /></p>

					</td>

				</tr>

				<?php if($config['installedpackages']['package'] != "") { ?>

				<tr>

					<td colspan="2" class="list" height="12">&nbsp;</td>

				</tr>

				<tr>

					<td colspan="2" class="listtopic">Reinstall packages</td>

				</tr>

				<tr>

					<td width="22%" valign="baseline" class="vncell">&nbsp;</td>

					<td width="78%" class="vtable">

						<p>Click this button to reinstall all system packages.  This may take a while. <br /><br />

		  				<input name="Submit" type="submit" class="formbtn" id="reinstallpackages" value="Reinstall packages">

					</td>

				</tr>

				<?php } ?>

			</table>

			</div>

		</td>

	</tr>

</table>

</form>

<script language="JavaScript">

<!--

encrypt_change();

decrypt_change();

//-->

</script>

<?php include("fend.inc"); ?>

</body>

</html>

<?php

if (is_subsystem_dirty('restore'))

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

?>