clamav-milter(8)

NAME

clamav-milter - milter compatible mail scanner

SYNOPSIS

clamav-milter [options] socket_address

DESCRIPTION

clamav-milter is a filter for sendmail mail server. It uses a mail scanning engine built into clamd.

clamav-milter requires clamd(8) to run. When starting, clamav-milter verifies that it can communicate with clamd; if it cannot it terminates.

clamav-milter supports tcpwrappers, the value for daemon_list is "clamav-milter".

The socket_address argument is the socket used to communicate with sendmail(8). It must agree with the entry in sendmail.cf or sendmail.mc. The file associated with the socket must be createable by clamav-milter, if the User option is set in clamav.conf(5), then that user must have the rights to create the file.

OPTIONS

-a FROM, --from=EMAIL
    Source email address of notices. The default is MAILER-DAEMON. -h, --help Output the help information and exit.

-H, --headers
    Include all headers in the content of emails generated by clamav-milter. This is useful for systems administrators who may want to look at headers to check if any of their machines are infected.

-V, --version
    Print the version number and exit.

-c FILE, --config-file=FILE
    By default clamav-milter uses a default configuration file, this option allows you to specify another one.

-x n, --debug
    Enables debugging.

-x n, --debug-level=n
    Set the debug level to n (where n from [0..9]) if clamav-milter was configured with --clamav-debug. Will be replaced by --debug for compatability with other programs in the suite.

-b, --bounce
    Send a failure message to the sender, and to the postmaster. [ Warning: most viruses and worms fake their source address, so this option is not recommended ]. See also --noreject.

-C, --dont-log-clean
    Messages without viruses are usually logged if SysLog is set in clamav.conf since it gives a feel-good factor. This option turns that off.

-d, --dont-scan-on-error
    If a system error occurs pass messages through unscanned, usually when a system error occurs the milter raises a temporary failure which generally causes the message to remain in the queue.

-f, --force-scan
    Always scan, whereever the message came from (see also --local and --outgoing).

-l, --local
    Also scan messages sent from LAN.

-n, --noxheader
    Usually clamav-milter adds headings to messages that are scanned. The headers are of the form "X-Virus-Scanned: version", and "X-Virus-Status: clean/infected/not-scanned". This option instructs clamav-milter to refrain from adding this heading.

-N, --noreject
    When clamav-milter processes an e-mail which contains a virus it rejects the e-mail by using the SMTP code 550 or 554 depending on the state machine. This option causes clamav-milter to silently discard such messages. It is recommended that systems administrators use this option when NOT using the --bounce option.

-o, --outgoing
    Scan outgoing messages from this machine.

-i, --pidfile=FILE
    Notifies clamav-milter to store its process ID in FILE. The file must be createable by clamav-milter, if the User option is set in clamav.conf(5), then that user must have the rights to create the file.

-p, --postmaster=EMAILADDRESS
    Sets the e-mail address to send notifications to when the --quiet option is not given.

-P, --postmaster-only
    When the --quiet option is not given, send a notification to the postmaster. Setting this flag will include the ID of the message which can ease searching through system logs if the administrator believes it is a locally sourced virus.

-q, --quiet
    Don't send any warning messages when a virus or worm or is detected. This option overrides the --bounce and --postmaster-only options, and is the way to turn off notification to the postmaster.

-Q, --quarantine=EMAILADDRESS
    If this e-mail address is given, messages containing a virus or worm are redirected to it.

-U, --quarantine-dir=DIR
    If this option is given, infected files are left in this directory. The directory must not be publically readable or writeable, if it is, clamav-milter will issue an error and fail to start. Note - this option only works when using LocalSocket.

--server=HOSTNAME/ADDRESS, -s HOSTNAME/ADDRESS
    IP address or hostname of server(s) running clamd (when using TCPsocket). More than one server may be specified, separating the server's names by colons. If more than one server is specified, clamav-milter will load balance between the available servers. All the servers must be up when clamav-milter starts, however afterwards it is fault tolerant to a server becoming unavailable, and will only raise an error if all of the servers cannot be reached. The default value for ADDRESS is 127.0.0.1 (localhost).

--sign, -S
    Add a hard-coded signature to each scanned file.

--signature-file, -F
    Location of file to be appended to each scanned message. Overrides -S.

--max-children=n, -m n
    Set a hint of the maximum number of children. If the number is hit the maximum time a pending thread will be held up is 1 minute, so the number of threads can exceed this number for short periods of time. There is no default, if this argument is not clamav-milter will spawn as many children as is necessary.

Most users will not need this option, if in doubt do not set it.

--template-file=file -t file
    File points to a file whose contents is sent as the warning message whenever a virus is intercepted. The first occurance of %v within the file is replaced with the message returned from clamd, which includes the name of the virus. If the -t option is not given, clamav-milter defaults to a hardcoded message.

EXAMPLES

clamav-milter --max-children=2 -ol local:/var/run/clamav/clmilter.sock

AUTHOR

clamav-milter was written by Nigel Horne <njh@bandsman.co.uk>, the manual page was created by Tomasz Kojm <zolw@konarski.edu.pl>.

SEE ALSO

clamd(8), clamscan(1), freshclam(1), sigtool(1), clamav.conf(5), hosts_access(5)