arpwatch.xml

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE packagegui SYSTEM "./schema/packages.dtd">
<?xml-stylesheet type="text/xsl" href="./xsl/package.xsl"?>
<packagegui>
	<copyright>
	<![CDATA[
/* ==========================================================================
/*
	arpwatch.xml
	part of pfSense (http://www.pfSense.com)
	Copyright (C) 2007 to whom it may belong
	All rights reserved.

	Based on m0n0wall (http://m0n0.ch/wall)
	Copyright (C) 2003-2006 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.
										*/
/* ==========================================================================	*/
	]]>
	</copyright>
	<description>ARP Monitoring Daemon</description>
	<requirements>None</requirements>
	<faq>Currently there are no FAQ items provided.</faq>
	<name>arpwatch</name>
	<version>2.1.a14 pkg v1.1.1</version>
	<title>Arpwatch: Settings</title>
	<aftersaveredirect>pkg_edit.php?xml=arpwatch.xml&amp;id=0</aftersaveredirect>
	<menu>
		<name>Arpwatch</name>
		<tooltiptext>Modify arpwatch settings.</tooltiptext>
		<section>Services</section>
		<configfile>arpwatch.xml</configfile>
		<url>/pkg_edit.php?xml=arpwatch.xml&amp;id=0</url>
	</menu>
	<service>
		<name>arpwatch</name>
		<rcfile>arpwatch.sh</rcfile>
		<executable>arpwatch</executable>
	</service>
	<tabs>
		<tab>
			<text>Settings</text>
			<url>/pkg_edit.php?xml=arpwatch.xml&amp;id=0</url>
			<active/>
		</tab>
		<tab>
			<text>Reports</text>
			<url>/arpwatch_reports.php?interface=default</url>
		</tab>
	</tabs>
	<configpath>installedpackages->package->$packagename->configuration->settings</configpath>
	<additional_files_needed>
		<prefix>/usr/local/www/</prefix>
		<chmod>a+rx</chmod>
		<item>http://www.pfsense.com/packages/config/arpwatch_reports.php</item>
	</additional_files_needed>
	<additional_files_needed>
		<prefix>/usr/sbin/</prefix>
		<chmod>a+rx</chmod>
		<item>http://www.pfsense.com/packages/config/sm.php</item>
	</additional_files_needed>
	<fields>
		<field>
			<fielddescr>Interfaces</fielddescr>
			<fieldname>interface_array</fieldname>
			<value>lan</value>
			<multiple>true</multiple>
			<size>10</size>
			<hideinterfaceregex>(loopback)</hideinterfaceregex>
			<type>interfaces_selection</type>
		</field>
		<field>
			<fielddescr>Enable E-mail Notifications</fielddescr>
			<fieldname>enable_email</fieldname>
			<type>checkbox</type>
			<description>Sends an E-mail notification for each new station and ARP change as they are seen &lt;strong&gt;instead of&lt;/strong&gt; local reports.&lt;br/&gt;NOTE: Only works on pfSense 2.1 or later. &lt;br/&gt;NOTE 2: Disables local reports which rely on arpwatch debug mode, which does not work with e-mail notifications.&lt;br/&gt;Configure SMTP and address settings in System &gt; Advanced on the Notifications tab</description>
		</field>
		
	</fields>
	<custom_php_global_functions>
	<![CDATA[
	function sync_package_arpwatch() {
		global $config;
		$pf_version=substr(trim(file_get_contents("/etc/version")),0,3);
		conf_mount_rw();
		config_lock();
		
		if(isset($_POST['interface_array'])) {
			$int = $_POST['interface_array'];
		} else {
			$int = $config['installedpackages']['arpwatch']['config'][0]['interface_array'];
		}
		
		$mail = "";
		$debug = "";
		if(($pf_version > 2.0) && (isset($_POST['enable_email']) || ($config['installedpackages']['arpwatch']['config'][0]['enable_email'] == "on"))) {
			if (!empty($config['notifications']['smtp']['notifyemailaddress']))
				$mail = " -m {$config['notifications']['smtp']['notifyemailaddress']}";
		} else {
			$debug = "-d";
		}
		
		foreach($_POST['interface_array'] as $iface) {
			$int = convert_friendly_interface_to_real_interface_name($iface);
			if($int) {
				$log_file = "/var/log/arp.{$int}.dat";
				$start .= "touch {$log_file}\n";
				$start .="/usr/local/sbin/arpwatch {$debug} -f {$log_file} \"{$mail}\" -i {$int} > /var/log/arpwatch.reports.{$int} 2>&amp;1 &amp;\n";	
			}
		}
		
		$stop = "/usr/bin/killall arpwatch";
		write_rcfile(array(
			"file" => "arpwatch.sh",
			"start" => $start,
			"stop" =>  $stop)
		);
		
		restart_service("arpwatch");
		conf_mount_ro();
		config_unlock();
	}
	]]>
	</custom_php_global_functions>
	<custom_add_php_command>
	<![CDATA[
		sync_package_arpwatch();
	]]>
	</custom_add_php_command>
	<custom_php_install_command>
	<![CDATA[
		unlink_if_exists("/usr/local/etc/rc.d/arpwatch.sh");
		@link("/usr/sbin/sm.php", "/usr/sbin/sendmail");
	]]>
	</custom_php_install_command>
</packagegui>