Differences between version 9 and predecessor to the previous major change of SpamAssassin.
Other diffs: Previous Revision, Previous Author, or view the Annotated Edit History
| Newer page: | version 9 | Last edited on Thursday, November 11, 2004 6:13:58 pm | by DrewBroadley | Revert |
| Older page: | version 8 | Last edited on Wednesday, July 21, 2004 6:27:25 am | by SpamAssassin | Revert |
@@ -43,4 +43,73 @@
crontab:
*/5 * * * * /home/localuser/bin/getmail
+
+----
+!!The ClamAV Plugin
+
+This plugin submits the entire email to a locally running [ClamAV] server for virus detection. If a virus is found, it returns a positive return code to indicate spam and sets the header "X-Spam-Virus: Yes ($virusname)".
+
+!Code
+
+----
+''clamav.cf''
+ loadplugin ClamAV clamav.pm
+ full CLAMAV eval:check_clamav()
+ describe CLAMAV Clam AntiVirus detected a virus
+ score CLAMAV 10
+----
+''clamav.pm''
+ package !ClamAV;
+ use strict;
+ use Mail::!SpamAssassin;
+ use Mail::!SpamAssassin::Plugin;
+ use File::Scan::!ClamAV;
+ our @ISA = qw(Mail::!SpamAssassin::Plugin);
+
+ sub new {
+ my ($class, $mailsa) = @_;
+ $class = ref($class) || $class;
+ my $self = $class->SUPER::new($mailsa);
+ bless ($self, $class);
+ $self->register_eval_rule ("check_clamav");
+ return $self;
+ }
+
+ sub check_clamav {
+ my ($self, $permsgstatus, $fulltext) = @_;
+ my $clamav = new File::Scan::!ClamAV(port => 3310);
+ my ($code, $virus) = $clamav->streamscan(${$fulltext});
+ my $isspam = 0;
+ my $header = "";
+ if(!$code) {
+ my $errstr = $clamav->errstr();
+ Mail::!SpamAssassin::Plugin::dbg("ClamAV: Error scanning: $errstr");
+ $header = "Error ($errstr)";
+ } elsif($code eq 'OK') {
+ Mail::!SpamAssassin::Plugin::dbg("ClamAV: No virus detected");
+ $header = "No";
+ } elsif($code eq 'FOUND') {
+ Mail::!SpamAssassin::Plugin::dbg("ClamAV: Detected virus: $virus");
+ $header = "Yes ($virus)";
+ $isspam = 1;
+ } else {
+ Mail::!SpamAssassin::Plugin::dbg("ClamAV: Error, unknown return code: $code");
+ $header = "Error (Unknown return code from ClamAV: $code)";
+ }
+ $permsgstatus->{main}->{conf}->{headers_spam}->{"Virus"} = $header;
+ $permsgstatus->{main}->{conf}->{headers_ham}->{"Virus"} = $header;
+ return $isspam;
+ }
+ 1;
+----
+
+__How To Use It__
+
+First of all, you need to install [ClamAV] and ensure that scanning a mail with '''clamscan''' works.
+
+Second, you need to install the [File::Scan::ClamAV|http://search.cpan.org/~cfaber/File-Scan-ClamAV/lib/File/Scan/ClamAV.pm] perl module.
+
+Finally, save the two files above into the /etc/mail/spamassassin/ directory. You can adjust the default score of 10 in '''clamav.cf''' if you like. Restart the spamd daemon if you're using that, and you should be all set.
+
+If you'd like to sort virus emails to a separate folder, create a rule looking for the "X-Spam-Virus: Yes" header.
