adding imspector package

3 files changed, 312 insertions, 1 deletions

diff --git a/packages/imspector/imspector.inc b/packages/imspector/imspector.inc
new file mode 100644
index 00000000..15aacbdf
--- /dev/null
+++ b/packages/imspector/imspector.inc
@@ -0,0 +1,161 @@
+<?php
+	require_once("config.inc");
+	require_once("functions.inc");
+
+	/* IMSpector */
+
+	function imspector_notice ($msg) { syslog(LOG_NOTICE, "imspector: $msg"); return; }
+	function imspector_warn ($msg) { syslog(LOG_WARNING, "imspector: $msg"); return; }
+	
+	function imspector_config ($name) {
+		global $config;
+		if($config['installedpackages']['imspector']['config'][0]["{$name}"])
+			return $config['installedpackages']['imspector']['config'][0]["{$name}"];
+		else
+			return NULL;
+	}
+
+	function write_imspector_config($conf_file, $conf_text) {
+		$conf = fopen($conf_file, "w");
+		if(!$conf) {
+			imspector_warn("Could not open $conf_file for writing.");
+			exit;
+		}
+		fwrite($conf, $conf_text);
+		fclose($conf);	
+	}	
+
+	function imspector_pf_rdr($iface, $port) {
+		return "rdr on {$iface} inet proto tcp from any to any port = {$port} -> 127.0.0.1 port 16667\n";
+	}
+
+	function imspector_pf_rule($iface, $port) {
+		return "pass in quick on {$iface} inet proto tcp from any to any port {$port} keep state\n";
+	}	
+
+	function imspector_proto_to_port ($proto)
+	{
+		switch ($proto) {
+			case "msn":
+				return 1863;
+			case "icqaim":
+				return 5190;
+			case "yahoo":
+				return 5050;
+			case "irc":
+				return 6667;
+			default:
+				return NULL;
+		}
+	}
+	
+	function imspector_remove_rules() {
+		$anchor = "imspector";
+		exec("/sbin/pfctl -a " . $anchor . " -Fr"); 
+		exec("/sbin/pfctl -a " . $anchor . " -Fn");
+	}	
+
+	function before_form_imspector($pkg) {
+		global $config;
+		
+	}
+
+	function validate_form_imspector($post, $input_errors) {
+
+	}
+
+	function sync_package_imspector() {
+		global $config;
+		global $input_errors;
+		$configfile = "/usr/local/etc/imspector.conf";
+		$proto="";
+		$pf_rules="";
+
+		imspector_notice("Syncing package");
+
+		imspector_remove_rules();
+
+		conf_mount_rw();
+		config_lock();			
+
+		if(imspector_config("proto_msn")) $proto .= "msn,";
+		if(imspector_config("proto_icqaim")) $proto .= "icqaim,";
+		if(imspector_config("proto_yahoo")) $proto .= "yahoo,";
+		if(imspector_config("proto_irc")) $proto .= "irc,";
+		
+		if($proto != "") 
+			$proto_array = explode(",",$proto);
+
+		if(imspector_config("iface_array"))
+			$iface_array = explode(",",imspector_config("iface_array"));
+
+		if($iface_array && $proto_array) {	
+			for($i=1;$i<=2;$i++) {			
+				foreach($iface_array as $iface) {
+					$if = convert_friendly_interface_to_real_interface_name($iface);
+					/* above function returns iface if fail */
+					if($if!=$iface) {
+						$addr = find_interface_ip($if);
+						/* non enabled interfaces are displayed in list on imspector settings page */
+						/* check that the interface has an ip address before adding parameters */
+						if($addr) {
+							foreach($proto_array as $proto) {
+								if($i==1 && imspector_proto_to_port($proto))
+									$pf_rules .= imspector_pf_rdr($if,imspector_proto_to_port($proto));
+								elseif ($i==2 && imspector_proto_to_port($proto))
+									$pf_rules .= imspector_pf_rule($if,imspector_proto_to_port($proto));
+							}							
+						}
+					}
+				}
+			}
+
+			if($pf_rules != "") {
+				exec("echo \"{$pf_rules}\" | /sbin/pfctl -a imspector -f -");
+
+				$configtext = "plugin_dir=/usr/local/lib/imspector\n";
+				if(imspector_config("log_file"))
+					$configtext .= "file_logging_dir=/var/log/imspector\n";
+				write_imspector_config($configfile,$configtext);					
+					
+				$stop = <<<EOD
+if [ `pgrep imspector | wc -l` != 0  ]; then
+		/usr/bin/killall imspector
+		while [ `pgrep imspector | wc -l` != 0 ]; do
+			sleep 1
+		done	
+	fi
+EOD;
+					
+				$start = $stop."\n\t/usr/local/sbin/imspector -c \"{$configfile}\"";
+
+				write_rcfile(array(
+					    "file" => "imspector.sh",
+					    "start" => $start,
+					    "stop" => $stop
+				    )
+				);
+			}
+		
+			if((int)exec("pgrep imspector | wc -l") == 0 || $_POST['iface_array']) {
+				imspector_notice("Starting service");
+				if(imspector_config("log_file"))
+					exec("mkdir -p /var/log/imspector");
+				start_service("imspector");
+			} 	
+		}
+
+		if(!$iface_array || !$proto_array || $pf_rules = "") {
+			/* no parameters user does not want imspector running */
+			/* lets stop the service and remove the rc file */
+		
+			stop_service("imspector");
+			imspector_warn("No interfaces and/or protocols stopping service");
+			exec("rm -f /usr/local/etc/rc.d/imspector*");
+			exec("rm -f {$configfile}");
+		}	
+
+		config_unlock();
+		conf_mount_ro();		
+	}
+?>
diff --git a/packages/imspector/imspector.xml b/packages/imspector/imspector.xml
new file mode 100644
index 00000000..1beb085e
--- /dev/null
+++ b/packages/imspector/imspector.xml
@@ -0,0 +1,136 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<packagegui>
+	<title>Services: IMSpector</title>
+	<name>imspector</name>
+	<version>0.2</version>
+	<savetext>Change</savetext>
+	<include_file>/usr/local/pkg/imspector.inc</include_file>
+	<aftersaveredirect>/pkg_edit.php?xml=imspector.xml&amp;id=0</aftersaveredirect>
+	<menu>
+		<name>IMSpector</name>
+		<tooltiptext>Set IMSpector settings such as protocols to listen on.</tooltiptext>
+		<section>Services</section>
+		<url>/pkg_edit.php?xml=imspector.xml&amp;id=0</url>
+	</menu>
+	<additional_files_needed>
+		<item>http://www.pfsense.org/packages/config/imspector/imspector.inc</item>
+	    <prefix>/usr/local/pkg/</prefix>
+	    <chmod>0755</chmod>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/local/sbin/</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/imspector/sbin/imspector</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/local/lib/</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/imspector/lib/libimspector.so</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/local/lib/imspector</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/imspector/lib/debugloggingplugin.so</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/local/lib/imspector</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/imspector/lib/fileloggingplugin.so</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/local/lib/imspector</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/imspector/lib/icqprotocolplugin.so</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/local/lib/imspector</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/imspector/lib/ircprotocolplugin.so</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/local/lib/imspector</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/imspector/lib/msnprotocolplugin.so</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/local/lib/imspector</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/imspector/lib/yahooprotocolplugin.so</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/lib</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/imspector/lib/libstdc++.a</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/lib</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/imspector/lib/libstdc++.so</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/lib</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/imspector/lib/libstdc++.so.5</item>
+	</additional_files_needed>
+	<additional_files_needed>
+		<prefix>/usr/lib</prefix>
+		<chmod>0755</chmod>
+		<item>http://www.pfsense.com/packages/config/imspector/lib/libstdc++_p.a</item>
+	</additional_files_needed>
+	<service>
+		<name>imspector</name>
+		<rcfile>imspector.sh</rcfile>
+		<executable>imspector</executable>
+	</service>
+	<fields>
+		<field>
+			<fielddescr>Interface (generally LAN)</fielddescr>
+			<fieldname>iface_array</fieldname>
+			<value>lan</value>
+			<multiple>true</multiple>
+			<size>3</size>
+			<type>interfaces_selection</type>
+		</field>
+		<field>
+			<fielddescr>Listen on MSN protocol</fielddescr>
+			<fieldname>proto_msn</fieldname>
+			<type>checkbox</type>
+		</field>	
+		<field>
+			<fielddescr>Listen on ICQ/AIM protocol</fielddescr>
+			<fieldname>proto_icqaim</fieldname>
+			<type>checkbox</type>
+		</field>	
+		<field>
+			<fielddescr>Listen on Yahoo protocol</fielddescr>
+			<fieldname>proto_yahoo</fieldname>
+			<type>checkbox</type>
+		</field>	
+		<field>
+			<fielddescr>Listen on IRC protocol</fielddescr>
+			<fieldname>proto_irc</fieldname>
+			<type>checkbox</type>
+		</field>
+		<field>
+			<fielddescr>Enable file logging</fielddescr>
+			<fieldname>log_file</fieldname>
+			<type>checkbox</type>
+		</field>	
+	</fields>
+	<custom_php_command_before_form>
+		before_form_imspector(&amp;$pkg);
+	</custom_php_command_before_form>
+	<custom_php_validation_command>
+		validate_form_imspector($_POST, &amp;$input_errors);
+	</custom_php_validation_command>
+	<custom_php_resync_config_command>
+		sync_package_imspector();
+	</custom_php_resync_config_command>    
+	<custom_php_install_command>
+		sync_package_imspector();
+	</custom_php_install_command>
+	<custom_php_deinstall_command>
+		exec("rm -f /usr/local/etc/rc.d/imspector*");
+		exec("rm -f /usr/local/etc/imspector.conf");
+	</custom_php_deinstall_command>
+</packagegui>
diff --git a/pkg_config.xml b/pkg_config.xml
index f4b2c7a1..20a8bfa8 100644
--- a/pkg_config.xml
+++ b/pkg_config.xml
@@ -126,7 +126,21 @@
       <status>BETA</status>
       <config_file>http://www.pfsense.com/packages/config/miniupnpd/miniupnpd.xml</config_file>
       <configurationfile>miniupnpd.xml</configurationfile>
-    </package>
+	</package>
+    <package>
+      <name>imspector</name>
+	  <descr>** REQUIRES: 1.0.1-SNAPSHOT-11-24-2006 OR LATER ** NOTE: IF MINIUPNPD INSTALLED, YOU NEED TO UPGRADE
+      TO MINIUPNPD 20061123 ** IMSpector is an Instant Messenger transparent proxy with logging capabilities.  
+      Currently it supports MSN, AIM, ICQ, Yahoo and IRC to different degrees.</descr>
+      <website>http://www.imspector.org/</website>
+      <category>Network Management</category>
+	  <maintainer>ryan@wgnrs.dynu.com</maintainer>
+      <version>0.2</version>
+      <required_version>1.0</required_version>
+      <status>ALPHA</status>
+      <config_file>http://www.pfsense.com/packages/config/imspector/imspector.xml</config_file>
+      <configurationfile>imspector.xml</configurationfile>
+    </package>	
     <package>
       <name>nut</name>
       <descr>Network UPS Tools</descr>