NAME
f-prot-qmail - Qmail plugin for F-Prot Antivirus Mail Scanner
SYNTAX
f-prot-qmail
DESCRIPTION
f-prot-qmail
is a plugin for Qmail that allows the user to scan messages passing through a Qmail mailsystem with the F-Prot Antivirus Mail Scanner.
f-prot-qmail
uses the same interface of receiving messages and envelope information as the
qmail-queue(8)
utility in the Qmail distribution.
To achieve in-transit scanning of mail messages in Qmail you must rename the
qmail-queue
application to
qmail-queue.orig
, and put
f-prot-qmail
in its place with the same name and file permissions as the original qmail-queue. Usually this means setting
qmailq
as the file's owner and
qmail
as the file's group.
The
f-prot-qmail
utility depends on the F-Prot Antivirus Mail Scanner (
scan-mail.pl
) listening in server mode on port 11200. For more information on F-Prot Antivirus Mail Scanner and its server mode, refer to the
scan-mail.pl(8)
manual page.
The
f-prot-qmail
utility will make a copy of each message in /tmp with the name /tmp/fi<pid>.<random>. It will then create another file called /tmp/fo<pid>.<random> and then contact the Mail Scanner and supply it with both filenames. When the Mail Scanner replies that it has finished,
f-prot-qmail
will execute qmail-queue.orig and supply it with a clean message and the envelope information handed to
f-prot-qmail.
STEP-BY-STEP COMMANDLINE INSTRUCTIONS
Here are the instructions for moving qmail-queue and putting
f-prot-qmail
in its place:
-
# cd /var/qmail/bin
# mv qmail-queue qmail-queue.orig
# cp /opt/f-prot/tools/f-prot-qmail ./qmail-queue
# chown qmailq.qmail qmail-queue
# chmod 4711 qmail-queue
LOGLEVEL
Since f-prot-qmail (now renamed as qmail-queue) is executed for each incoming mail, the startup
penalty can be significant for busy mailservers. To reduce overhead f-prot-qmail will first check
the variable FP_QMAIL_LOGLEVEL in /etc/f-prot.conf to determine the amount of information to
write to the system logs. Then it checks if FP_QMAIL_LOGLEVEL is set in the environment, and
if so it will override the value from the config file. If FP_QMAIL_LOGLEVEL is not set in the
config file nor in the environment FP_LOGLEVEL will be used instead. Note that
/etc/f-prot.conf is sh compatible and can thus be "sourced" by the environment that runs qmail,
making it unnecessary for f-prot-qmail to parse the file itself upon each startup.
See /etc/f-prot.conf and your systems manual page for syslog for more information on log levels.
LICENSING
For information about Licensing, see the LICENSE file that comes with F-Prot Antivirus.
CONTACT INFORMATION
Please direct any feedback to:
http://www.f-prot.com/support/contact_support.html
Updates will be advertised on: http://www.f-prot.com/
SEE ALSO
f-prot.conf(5)
scan-mail.pl(8)
qmail-queue(8)