This is not based on Raj's ClamAV package. This is the backend for Viralator, p3scan and clamsmtp. No, it doesn't support HAVP yet, but maybe it just works with Raj's HAVP package. I have plans of putting HAVP support into this interface, maybe HAVP + Squid, but I still gotta play a bit more with HAVP, and maybe I and Raj could work togheter to make this integration, dunno. This might just work out of the box, or maybe not. This package does nothing without p3scan, clamsmtp or Viralator, as of now.

2 files changed, 334 insertions, 80 deletions

diff --git a/packages/clamav.inc b/packages/clamav.inc
index 5ca1a9d2..afbfbca3 100644
--- a/packages/clamav.inc
+++ b/packages/clamav.inc
@@ -1,70 +1,260 @@
 <?php
-/*
-	clamav.inc
-        part of the ClamAV package for pfSense
-	Copyright (C) 2006 Rajkumar S <raj@linuxense.com>
-	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 sync_package_clamav() {
-	conf_mount_rw();
-	config_lock();
-	global $config;
-	$fd = fopen("/usr/local/etc/freshclam.conf","w");
-	fwrite($fd, "DatabaseDirectory /var/db/clamav\n");
-	fwrite($fd, "UpdateLogFile /var/log/clamav/freshclam.log\n");
-	fwrite($fd, "DatabaseOwner clamav\n");
-	fwrite($fd, "AllowSupplementaryGroups\n");
-	fwrite($fd, "DatabaseMirror database.clamav.net\n");
-	fclose($fd);
-	$cronjob = "*/120   *       *       *       *       root            /usr/bin/nice -n20 /usr/local/bin/freshclam";
-	add_text_to_file("/etc/crontab", $cronjob);
-	conf_mount_ro();
-	config_unlock();
-	mwexec("killall -HUP cron");
-}
+require_once('globals.inc');
+require_once('config.inc');
+require_once('service-utils.inc');
+require_once('pkg-utils.inc');
+require_once('pfsense-utils.inc');
 
 function clamav_install_command() {
-	global $config, $g;
-	mwexec ("mkdir -p /var/db/clamav");
-	mwexec ("chown clamav:clamav /var/db/clamav/");
-	mwexec ("chown clamav:clamav /var/log/clamav/");
-	update_output_window("Updating Virus Signatures...");
-	mwexec ("/usr/local/bin/freshclam");
-	sync_package_clamav();
+	global $g;
+	mwexec('rm -f /usr/local/etc/rc.d/clamav*');
+
+	$clamav_rundir = "{$g['varrun_path']}/clamav";
+
+	$pidfile = "$clamav_rundir/clamd.pid";
+	$rcfile = array();
+	$rcfile['file'] = 'clamd.sh';
+	$rcfile['start'] = "mkdir -p $clamav_rundir\n\tchown proxy:proxy $clamav_rundir\n\tclamd";
+	$rcfile['stop'] = "kill `cat $pidfile`";
+	write_rcfile($rcfile);
+
+	$pidfile = "$clamav_rundir/freshclam.pid";
+	$rcfile = array();
+	$rcfile['file'] = 'freshclam.sh';
+	$rcfile['start'] = "mkdir -p $clamav_rundir\n\tchown proxy:proxy $clamav_rundir\n\tfreshclam -d";
+	$rcfile['start'] = 'freshclam -d';
+	$rcfile['stop'] = "kill `cat $pidfile`";
+	write_rcfile($rcfile);
+
+	$dbdir = "{$g['vardb_path']}/clamav";
+	make_dirs($dbdir);
+	chown($dbdir, 'proxy');
+	$conf = <<<EOD
+DatabaseDirectory $dbdir
+PidFile $pidfile
+DatabaseOwner proxy
+AllowSupplementaryGroups
+DatabaseMirror database.clamav.net
+
+EOD;
+	file_put_contents('/usr/local/etc/freshclam.conf', $conf);
+
+	$static_output = "Fetching the virus database. This can take long. You can cancel this at any time by clicking the stop button in your browser.\n";
+	update_output_window($static_output);
+	$static_output .= system('freshclam');
+	update_output_window($static_output);
+	$static_output .= "Done!\n";
+	update_output_window($static_output);
+
+	start_service('freshclam');
 }
 
-function clamav_deinstall_command() {
-	global $config, $g;
-	conf_mount_rw();
-	unlink_if_exists("/usr/local/etc/rc.d/clamav.sh");
-	unlink_if_exists("/var/db/clamav/daily.cvd");
-	unlink_if_exists("/var/db/clamav/main.cvd");
-	unlink_if_exists("/var/db/clamav");
-	$cronjob = "*/120   *       *       *       *       root            /usr/bin/nice -n20 /usr/local/bin/freshclam";
-	#remove_text_to_file("/etc/crontab", $cronjob);
-	conf_mount_ro();
+function clamav_resync() {
+	global $g, $config;
+
+	$settings = $config['installedpackages']['clamav']['config'][0];
+
+	$clamav_rundir = "{$g['varrun_path']}/clamav";
+	$logfile = "{$g['varlog_path']}/clamd.log";
+	$pidfile = "$clamav_rundir/clamd.pid";
+	$tempdir = $g['tmp_path'];
+	$dbdir = "{$g['vardb_path']}/clamav";
+	$socket = "$clamav_rundir/clamd.socket";
+
+	$conf = <<<EOD
+LogFile $logfile
+LogTime
+PidFile $pidfile
+TemporaryDirectory $tempdir
+DatabaseDirectory $dbdir
+LocalSocket $socket
+FixStaleSocket
+User proxy
+AllowSupplementaryGroups
+ScanMail
+
+EOD;
+
+	if ($settings['expert_mode'] == 'on') $conf .= "DisableDefaultScanOptions";
+	else {
+		$options = array(	'brokenexec'	=> 'DetectBrokenExecutables',
+					'scan_pe'	=> 'ScanPE',
+					'scan_ole2'	=> 'ScanOLE2',
+					'scan_html'	=> 'ScanHTML',
+					'scan_archive'	=> 'ScanArchive');
+		foreach ($options as $option => $directive) {
+			if ($settings[$option] == 'on')
+				$conf .= "$directive\n";
+		}
+	}
+
+	file_put_contents('/usr/local/etc/clamd.conf', $conf);
+
+	restart_service('clamav');
+
+	if ($settings['scan_pop3'] == 'on') {
+		require_once('p3scan.inc');
+		p3scan_resync();
+	}
+
+	if ($settings['scan_smtp'] == 'on') {
+		require_once('clamsmtp.inc');
+		clamsmtp_resync();
+	}
+
+	if ($settings['scan_http'] == 'on') {
+		require_once('viralator.inc');
+		viralator_resync();
+	}
 }
 
+function clamav_before_form($pkg) {
+	global $config;
+
+	if (is_package_installed('p3scan')) {
+		$field = array();
+		$field['fieldname'] = 'scan_pop3';
+		$field['fielddescr'] = 'POP3 scanning';
+		$field['description'] = 'Enable POP3 scanning.';
+		$field['type'] = 'checkbox';
+		$field['required'] = true;
+		$field['enablefields'] = 'pop3_ifaces[]';
+		$pkg['fields']['field'][] = $field;
+
+		$field = array();
+		$field['fieldname'] = 'pop3_ifaces';
+		$field['fielddescr'] = 'POP3 interfaces';
+		$field['description'] = 'The POP3 proxy will bind to the selected interfaces';
+		$field['default_value'] = 'ALL';
+		$field['type'] = 'interfaces_selection';
+		$field['multiple'] = 'yes';
+		$pkg['fields']['field'][] = $field;
+	}
+
+	if (is_package_installed('clamsmtp')) {
+		$field = array();
+		$field['fieldname'] = 'scan_smtp';
+		$field['fielddescr'] = 'SMTP scanning';
+		$field['description'] = 'Enable SMTP scanning.';
+		$field['required'] = true;
+		$field['type'] = 'checkbox';
+		$field['enablefields'] = 'smtp_ifaces[],smtp_server,smtp_port';
+		$pkg['fields']['field'][] = $field;
+
+		$field = array();
+		$field['fieldname'] = 'smtp_ifaces';
+		$field['fielddescr'] = 'SMTP interfaces';
+		$field['description'] = 'The SMTP proxy will bind to the selected interfaces';
+		$field['default_value'] = 'ALL';
+		$field['type'] = 'interfaces_selection';
+		$field['multiple'] = 'yes';
+		$pkg['fields']['field'][] = $field;
+
+		$field = array();
+		$field['fieldname'] = 'smtp_server';
+		$field['fielddescr'] = 'SMTP server address';
+		$field['description'] = 'Enter the IP address of the local SMTP server.';
+		$field['type'] = 'input';
+		$pkg['fields']['field'][] = $field;
+
+		$field = array();
+		$field['fieldname'] = 'smtp_port';
+		$field['fielddescr'] = 'SMTP server port';
+		$field['description'] = 'Enter the port of the local SMTP server.';
+		$field['type'] = 'input';
+		$pkg['fields']['field'][] = $field;
+	}
+
+	if (is_package_installed('viralator')) {
+		$field = array();
+		$field['fieldname'] = 'scan_http';
+		$field['fielddescr'] = 'HTTP scanning';
+		$field['description'] = 'Enable HTTP scanning. Note that this filtering is triggered by the proxy server. Therefore, to transparently filter out HTTP viruses, you need to set up the proxy server in transparent mode.';
+		$field['required'] = 'yes';
+		$field['type'] = 'checkbox';
+		$field['enablefields'] = 'http_exts[],http_otherexts';
+		$pkg['fields']['field'][] = $field;
+
+		$field = array();
+		$field['fieldname'] = 'http_exts';
+		$field['fielddescr'] = 'Extensions to scan';
+		$field['description'] = 'Extensions to be scanned by the HTTP virus scanner';
+		$field['type'] = 'select';
+		$exts = array();
+		$exts['zip'] = 'Archives in the ZIP format';
+		$exts['rar'] = 'Archives in the RAR format';
+		$exts['arj'] = 'Archives in the ARJ format';
+		$exts['gz'] = 'Files compressed in the GZ format';
+		$exts['bz2'] = 'Files compressed in the BZIP2 format';
+		$exts['exe'] = 'Windows/DOS PE (EXE) executables';
+		$exts['com'] = 'DOS COM executables';
+		$exts['bat'] = 'DOS Batch files';
+		foreach ($exts as $ext => $desc)
+			$field['options']['option'][] = array('name' => "$desc (*.$ext)", 'value' => $ext);
+		$field['multiple'] = 'yes';
+		$pkg['fields']['field'][] = $field;
+
+		$field = array();
+		$field['fieldname'] = 'http_otherexts';
+		$field['fielddescr'] = 'Other extensions to scan';
+		$field['description'] = 'Comma-separated list of extensions to be scanned by the HTTP virus scanner (e.g.: txt,ppt,doc,wmv).';
+		$field['type'] = 'input';
+		$pkg['fields']['field'][] = $field;
+	}
+}
+
+function clamav_validate_input($post, $input_errors) {
+	if ($post['scan_smtp'] == 'on') {
+		require_once('clamsmtp.inc');
+		clamsmtp_validate_input($post, &$input_errors);
+	}
+
+	if (is_package_installed('viralator')) {
+		require_once('viralator.inc');
+		viralator_validate_input($post, &$input_errors);
+	}
+}
+
+function clamav_generate_rules($type) {
+	global $config;
+
+	if (!is_service_running('clamav')) return;
+
+	$rules = '';
+	$clamav_conf = $config['installedpackages']['clamav']['config'][0];
+	$sassassin_conf = $config['installedpackages']['sassassin']['config'][0];
+
+	$p3scan_enabled = (($clamav_conf['scan_pop3'] == 'on') || ($sassassin_conf['enable'] == 'on'));
+	if ($p3scan_enabled && is_service_running('p3scan')) {
+		$ifaces = explode(',', $clamav_conf['pop3_ifaces']);
+		$ifaces = array_map('convert_friendly_interface_to_real_interface_name', $ifaces);
+
+		if ($type == 'nat') {
+			foreach ($ifaces as $iface)
+				$rules .= "rdr on $iface proto tcp to port pop3 -> 127.0.0.1 port 8110\n";
+		}
+
+		else {
+			foreach ($ifaces as $iface)
+				$rules .= "pass quick on $iface proto tcp to port pop3 flags S/SA keep state\n";
+		}
+	}
+
+	if ($clamav_conf['scan_smtp'] && is_service_running('clamsmtp')) {
+		$ifaces = explode(',', $clamav_conf['pop3_ifaces']);
+		$ifaces = array_map('convert_friendly_interface_to_real_interface_name', $ifaces);
+
+		if ($type == 'nat') {
+			foreach ($ifaces as $iface)
+				$rules .= "rdr on $iface proto tcp to ($iface) port smtp -> 127.0.0.1 port 10025\n";
+		}
+
+		else {
+			foreach ($ifaces as $iface)
+				$rules .= "pass quick on $iface proto tcp to ($iface) port smtp flags S/SA keep state\n";
+		}
+	}
+
+	return ($rules);
+}
 ?>
diff --git a/packages/clamav.xml b/packages/clamav.xml
index ee390a50..212c2e68 100644
--- a/packages/clamav.xml
+++ b/packages/clamav.xml
@@ -1,24 +1,88 @@
+<?xml version="1.0" encoding="utf-8"?>
 <packagegui>
-	<name>clamav</name>
-	<version>0.1</version>
-	<title>ClamAV: Settings</title>
-	<include_file>/usr/local/pkg/clamav.inc</include_file>
+	<include_file>clamav.inc</include_file>
 
+	<!-- Installation -->
+	<additional_files_needed>
+		<item>http://www.pfsense.org/packages/config/clamav.inc</item>
+	</additional_files_needed>
+	<custom_php_install_command>
+		clamav_install_command();
+	</custom_php_install_command>
+	<menu>
+		<name>Antivirus</name>
+		<tooltiptext>Configure antivirus settings</tooltiptext>
+		<section>Services</section>
+		<url>/pkg_edit.php?xml=clamav.xml&amp;id=0</url>
+	</menu>
 	<service>
-		<name>clamav</name>
-		<rcfile>/usr/local/etc/rc.d/clamav.sh</rcfile>
+		<name>ClamAV</name>
+		<description>The ClamAV antivirus.</description>
+		<rcfile>clamd.sh</rcfile>
+		<executable>clamd</executable>
+	</service>
+	<service>
+		<name>FreshClam</name>
+		<description>A daemon that periodically updates the ClamAV virus database.</description>
+		<rcfile>freshclam.sh</rcfile>
+		<executable>freshclam</executable>
 	</service>
 
-    	<additional_files_needed>
-	    <prefix>/usr/local/pkg/</prefix>
-	    <chmod>0755</chmod>
-	    <item>http://agni.linuxense.com/packages/config/clamav.inc</item>
-	</additional_files_needed>
-
-	<custom_php_install_command> clamav_install_command(); </custom_php_install_command>
-	<custom_php_deinstall_command> clamav_deinstall_command(); </custom_php_deinstall_command>
-	<custom_delete_php_command> sync_package_clamav(); </custom_delete_php_command>
-	<custom_php_resync_config_command> sync_package_clamav(); </custom_php_resync_config_command>
-	<custom_add_php_command> sync_package_clamav(); </custom_add_php_command>
+	<!-- Interface -->
+	<name>clamav</name>
+	<title>Antivirus</title>
+	<fields>
+		<field>
+			<fieldname>expert</fieldname>
+			<fielddescr>Expert mode</fielddescr>
+			<description>This enables the expert mode. Don't check this unless you are sure of what you are doing.</description>
+			<type>checkbox</type>
+			<enablefields>brokenexec,scan_pe,scan_ole2,scan_html,scan_archive</enablefields>
+			<required/>
+		</field>
+		<field>
+			<fieldname>brokenexec</fieldname>
+			<fielddescr>Detect broken executables</fielddescr>
+			<description>Try to detect broken executables.</description>
+			<type>checkbox</type>
+			<default_value>on</default_value>
+		</field>
+		<field>
+			<fieldname>scan_pe</fieldname>
+			<fielddescr>Scan PE</fielddescr>
+			<description>Scan files in 32-bit Windows' Portable Executable format.</description>
+			<type>checkbox</type>
+			<default_value>on</default_value>
+		</field>
+		<field>
+			<fieldname>scan_ole2</fieldname>
+			<fielddescr>Scan OLE2</fielddescr>
+			<description>Scan Microsoft Office document macros.</description>
+			<type>checkbox</type>
+			<default_value>on</default_value>
+		</field>
+		<field>
+			<fieldname>scan_html</fieldname>
+			<fielddescr>Scan HTML</fielddescr>
+			<description>Perform HTML normalization and decryption of Microsoft Script Encoder code.</description>
+			<type>checkbox</type>
+			<default_value>on</default_value>
+		</field>
+		<field>
+			<fieldname>scan_archive</fieldname>
+			<fielddescr>Scan archives</fielddescr>
+			<description>Try to uncompress archived files to scan their content.</description>
+			<type>checkbox</type>
+			<default_value>on</default_value>
+		</field>
+	</fields>
+	<custom_php_command_before_form>
+		clamav_before_form(&amp;$pkg);
+	</custom_php_command_before_form>
+	<custom_php_validation_command>
+		clamav_validate_input($post, &amp;$input_errors);
+	</custom_php_validation_command>
+	<custom_php_resync_config_command>
+		clamav_resync();
+	</custom_php_resync_config_command>
 </packagegui>
-