From a6cf0cf080e21e905d458668916d19a5bce04819 Mon Sep 17 00:00:00 2001 From: Brian Scholer Date: Wed, 4 Jan 2012 11:38:17 -0500 Subject: Added the Filer package. --- config/filer/filer.inc | 193 ++++++++++++++++++++++++++++++++++++++++++++ config/filer/filer.xml | 132 ++++++++++++++++++++++++++++++ config/filer/filer_sync.xml | 110 +++++++++++++++++++++++++ 3 files changed, 435 insertions(+) create mode 100644 config/filer/filer.inc create mode 100644 config/filer/filer.xml create mode 100644 config/filer/filer_sync.xml (limited to 'config/filer') diff --git a/config/filer/filer.inc b/config/filer/filer.inc new file mode 100644 index 00000000..906928f2 --- /dev/null +++ b/config/filer/filer.inc @@ -0,0 +1,193 @@ + + Copyright (C) 2011 Marcello Coutinho + Copyright (C) 2011 Brian Scholer + 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. + */ +/* ========================================================================== */ + + +function filer_install() { + // reserved +} + +function filer_deinstall() { + // reserved +} + +function filer_start() { + global $g, $config; + + // reserved +} + +function sync_package_filer() { + global $config, $g; + + if($config['installedpackages']['filer']['config']!="") { + foreach($config['installedpackages']['filer']['config'] as $file) { + $fname = $file['fullfile']; + $fdata = base64_decode($file['filedata']); + if($file['mod']) { + if(!preg_match("/0?[0-7]{3}/", $file['mod'])) + $mod = 0700; + else + $mod = octdec($file['mod']); + } + conf_mount_rw(); + $fhnd = fopen($fname, 'w'); + fwrite($fhnd, $fdata); + fclose($fhnd); + if($mod) + chmod($fname, $mod); + conf_mount_ro(); + } + } + + filer_sync_on_changes(); +} + +/* Uses XMLRPC to synchronize the changes to a remote node */ +function filer_sync_on_changes() { + global $config, $g; + + log_error("[filer] filer_xmlrpc_sync.php is starting."); + $synconchanges = $config['installedpackages']['filersync']['config'][0]['synconchanges']; + if(!$synconchanges) + return; + foreach ($config['installedpackages']['filersync']['config'] as $rs ){ + foreach($rs['row'] as $sh){ + $sync_to_ip = $sh['ipaddress']; + $password = $sh['password']; + if($sh['username']) + $username = $sh['username']; + else + $username = 'admin'; + if($password && $sync_to_ip) + filer_do_xmlrpc_sync($sync_to_ip, $username, $password); + } + } + log_error("[filer] filer_xmlrpc_sync.php is ending."); +} +/* Do the actual XMLRPC sync */ +function filer_do_xmlrpc_sync($sync_to_ip, $username, $password) { + global $config, $g; + + if(!$username) + return; + + if(!$password) + return; + + if(!$sync_to_ip) + return; + + $xmlrpc_sync_neighbor = $sync_to_ip; + if($config['system']['webgui']['protocol'] != "") { + $synchronizetoip = $config['system']['webgui']['protocol']; + $synchronizetoip .= "://"; + } + $port = $config['system']['webgui']['port']; + /* if port is empty lets rely on the protocol selection */ + if($port == "") { + if($config['system']['webgui']['protocol'] == "http") + $port = "80"; + else + $port = "443"; + } + $synchronizetoip .= $sync_to_ip; + + /* xml will hold the sections to sync */ + $xml = array(); + $xml['filer'] = $config['installedpackages']['filer']; + + /* assemble xmlrpc payload */ + $params = array( + XML_RPC_encode($password), + XML_RPC_encode($xml) + ); + + /* set a few variables needed for sync code borrowed from filter.inc */ + $url = $synchronizetoip; + log_error("Beginning Filer XMLRPC sync to {$url}:{$port}."); + $method = 'pfsense.merge_installedpackages_section_xmlrpc'; + $msg = new XML_RPC_Message($method, $params); + $cli = new XML_RPC_Client('/xmlrpc.php', $url, $port); + $cli->setCredentials($username, $password); + if($g['debug']) + $cli->setDebug(1); + /* send our XMLRPC message and timeout after 250 seconds */ + $resp = $cli->send($msg, "250"); + if(!$resp) { + $error = "A communications error occurred while attempting filer XMLRPC sync with {$url}:{$port}."; + log_error($error); + file_notice("sync_settings", $error, "filer Settings Sync", ""); + } elseif($resp->faultCode()) { + $cli->setDebug(1); + $resp = $cli->send($msg, "250"); + $error = "An error code was received while attempting filer XMLRPC sync with {$url}:{$port} - Code " . $resp->faultCode() . ": " . $resp->faultString(); + log_error($error); + file_notice("sync_settings", $error, "filer Settings Sync", ""); + } else { + log_error("filer XMLRPC sync successfully completed with {$url}:{$port}."); + } + + /* tell filer to reload our settings on the destionation sync host. */ + $method = 'pfsense.exec_php'; + $execcmd = "require_once('/usr/local/pkg/filer.inc');\n"; + $execcmd .= "sync_package_filer();"; + /* assemble xmlrpc payload */ + $params = array( + XML_RPC_encode($password), + XML_RPC_encode($execcmd) + ); + + log_error("filer XMLRPC reload data {$url}:{$port}."); + $msg = new XML_RPC_Message($method, $params); + $cli = new XML_RPC_Client('/xmlrpc.php', $url, $port); + $cli->setCredentials($username, $password); + $resp = $cli->send($msg, "250"); + if(!$resp) { + $error = "A communications error occurred while attempting filer XMLRPC sync with {$url}:{$port} (pfsense.exec_php)."; + log_error($error); + file_notice("sync_settings", $error, "filer Settings Sync", ""); + } elseif($resp->faultCode()) { + $cli->setDebug(1); + $resp = $cli->send($msg, "250"); + $error = "An error code was received while attempting filer XMLRPC sync with {$url}:{$port} - Code " . $resp->faultCode() . ": " . $resp->faultString(); + log_error($error); + file_notice("sync_settings", $error, "filer Settings Sync", ""); + } else { + log_error("filer XMLRPC reload data success with {$url}:{$port} (pfsense.exec_php)."); + } + +} + +?> diff --git a/config/filer/filer.xml b/config/filer/filer.xml new file mode 100644 index 00000000..f772feb2 --- /dev/null +++ b/config/filer/filer.xml @@ -0,0 +1,132 @@ + + + + + + + Copyright (C) 2011 Brian Scholer + 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. + */ +/* ========================================================================== */ + ]]> + + Describe your package here + Describe your package requirements here + Currently there are no FAQ items provided. + filer + 0.5 + Filer + /usr/local/pkg/filer.inc + + /usr/local/pkg/ + 0755 + http://www.pfsense.com/packages/config/filer/filer.inc + + + /usr/local/pkg/ + 0755 + http://www.pfsense.com/packages/config/filer/filer_sync.xml + + + Filer + Filer +
Diagnostics
+ filer.xml + + + + Files + /pkg.php?xml=filer.xml + + + + XMLRPC Sync + /pkg_edit.php?xml=filer_sync.xml + + + + + + + File + fullfile + + + Permissions + mod + + + Description + description + + + + + Full path to the file + fullfile + input + + + + Permissions + mod + input + Blank leaves the permissions alone. + + + Description + description + Enter a description for this file. + input + + + File Contents + filedata + Paste the files contents here. + textarea + base64 + 60 + 30 + + + + + filer_install(); + + + + + sync_package_filer(); + + + sync_package_filer(); + + \ No newline at end of file diff --git a/config/filer/filer_sync.xml b/config/filer/filer_sync.xml new file mode 100644 index 00000000..ae8e48ba --- /dev/null +++ b/config/filer/filer_sync.xml @@ -0,0 +1,110 @@ + + + + + + + Copyright (C) 2011 Marcello Coutinho + Copyright (C) 2011 Brian Scholer + 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. + */ +/* ========================================================================== */ + ]]> + + Describe your package here + Describe your package requirements here + Currently there are no FAQ items provided. + filersync + 1.1 + Filer: Sync + /usr/local/pkg/filer.inc + + + Files + /pkg.php?xml=filer.xml + + + + XMLRPC Sync + /pkg_edit.php?xml=filer_sync.xml + + + + + + listtopic + temp + Enable Filer configuration sync + + + Automatically sync Filer configuration changes + synconchanges + pfSense will automatically sync changes to the hosts defined below. Blank user assumes 'admin'. + checkbox + + + Remote Servers + none + rowhelper + + + IP Address + ipaddress + IP Address of remote server + input + 20 + + + + User Name + username + user name of remote server + input + 20 + + + Password + password + Password for remote server. + password + 20 + + + + + + + filer_sync_on_changes(); + + + unset($_POST['temp']); + + \ No newline at end of file -- cgit v1.2.3