j-chkmail.cf(4)

NAME
j-chkmail.cf - configuration file for j-chkmail

SYNOPSIS
/etc/mail/j-chkmail.cf

DESCRIPTION
j-chkmail.cf is j-chkmail daemon configuration file

•   General section

DOMAIN
    this is your domain name. There is no default value
    Syntax :
    DOMAIN my-domain.com
    Default : no default value

J_HOSTNAME
    this option tells how j-chkmail sets its own hostname.
    Syntax :
    J_HOSTNAME SYSTEM | SENDMAIL | myserver.mydomain.com
    Default : SYSTEM Declaring SYSTEM tells sendmail to use value returned by gethostname system call. SENDMAIL tells j-chkmail to use value defined by $j macro at sendmail configuration file. Otherwise, j-chkmail will use declared value for this option.

PRESENCE
    this option defines if j-chkmail will add a header to announce its presence.
    Syntax :
    PRESENCE SHOW | HIDE
    Default : SHOW

USER
    this option tells j-chkmail to run as USER.
    Syntax :
    USER user
    Default : smmsp, if undefined elsewhere

GROUP
    this options tells j-chkmail to run as GROUP.

    Syntax :
    GROUP group
    Default : smmsp, if undefined elsewhere

•   sendmail <-> j-chkmail communications socket - only one declaration is possible.

SOCKET
    General declaration
    Syntax :
    SOCKET local:/var/jchkmail/j-chkmail.sock (UNIX socket)
    SOCKET unix:/var/jchkmail/j-chkmail.sock (UNIX socket)
    SOCKET inet:2000@hostname (INET socket)

INET_SOCK
    If you've chosen an INET socket at localhost, only the port number is necessary.
    Syntax :
    INET_SOCK 2000

UNIX_SOCK
    if you prefer an UNIX socket (named pipe), you shall tell j-chkmail the socket name.
    Syntax :
    UNIX_SOCK /var/jchkmail/j-chkmail.sock

•   Warning messages

WARN_SENDER
    this option tells j-chkmail if sender shall receive warning messages.
    Syntax :
    WARN_SENDER YES | NO
    Default : YES

WARN_RCPT
    this option tells j-chkmail if warning original recipients shall receive warning messages.
    Syntax :
    WARN_RCPT YES | NO
    Default : YES

J_SENDER
    This option tells j-chkmail which address to use when sending warning messages. SENDER preserves sender address.
    Syntax :
    J_SENDER SENDER | j-master@myserver.mydomain.com
    Default : SENDER

•   Logging

LOG_FACILITY
    obvious
    Syntax :
    LOG_FACILITY local5
    Default : local5

LOG_LEVEL
    obvious
    Syntax :
    LOG_LEVEL 10
    Default : 10

STATS_INTERVAL
    j-chkmail periodically dumps internal counters contents. This option defines interval between two dumps. If this parameter is set to 0, j-chkmail does no dumps.
    Syntax :
    STATS_INTERVAL 300
    Default : 300

LOG_ATTACHMENTS
    this option tells j-chkmail to log every attachment detected.
    Syntax :
    LOG_ATTACHMENTS NO | YES
    Default : NO

•   Configuration files

ERROR_MSG_FILE
    This file contains warning messages.
    Syntax (and default file) :
    ERROR_MSG_FILE /etc/mail/j-error-msg

CW_FILE
    This is the file used by sendmail to define Class W hosts.
    Syntax (and default file) :
    CW_FILE /etc/mail/local-host-names or /etc/mail/sendmail.cw

USERS_FILE
    This file contains the list of local e-mail addresses.
    Syntax (and default file) :
    USERS_FILE /etc/mail/j-local-users

NETS_FILE
    Syntax (and default file) :
    NETS_FILE /etc/mail/j-nets

•   Work files and directories

SPOOLDIR
    Syntax (and default file) :
    SPOOLDIR /var/spool/jchkmail

WORKDIR
    Syntax (and default file) :
    WORKDIR /var/jchkmail

PID_FILE
    Syntax (and default file) :
    PID_FILE /var/jchkmail/j-chkmail.pid

STATS_FILE
    Syntax (and default file) :
    STATS_FILE /var/jchkmail/j-stats

STATE_FILE
    Syntax (and default file) :
    STATE_FILE /var/jchkmail/j-state

XFILES_LOG
    Syntax (and default file) :
    XFILES_LOG /var/jchkmail/j-files

•   Using internal scanner to filter unsafe X-files

DELETE_EXEC_FILES
    Obsolete - use XFILES

XFILES
    this option tells j-chkmail what to do when detecting an attached XFILE.
    Syntax :
    XFILES OK | WARN | REJECT | DISCARD
    Default : OK

    OK  tells j-chkmail to do behave normally if it detects an XFILE.

    WARN
        tells j-chkmail to replace original message by the message configured at error configuration file (/etc/mail/j-error-msg)

    REJECT
        tells j-chkmail to reject message. Sender receives the usual MTA error message.

    DISCARD
        message is silently discarded

FILE_EXT
    this option defines which file extensions are used to detect "unsafe" attached files. You may define multiple values each line and declare multiple lines.
    Syntax :
    FILE_EXT ext1 [ext2] [ext3] ...

FILE_REGEX
    You can also declare "unsafe" files to being defined by regular expressions appearing in their filenames.
    Syntax :
    FILE_REGEX regex

XFILE_SAVE_MSG
    doesn't delete spool message if a XFILE is found.
    Syntax :
    XFILE_SAVE_MSG YES | NO
    Default : NO

•   Using anti-virus to filter messages

AV_ACTION
    this option disables anti-virus checking and tells j-chkmail what to do when finding a virus.
    Syntax :
    AV_ACTION OK | WARN | REJECT | DISCARD
    Default : OK

    OK  disables anti-virus scanner calls.

    WARN
        tells j-chkmail to replace original message by the message configured at error configuration file (/etc/mail/j-error-msg)

    REJECT
        tells j-chkmail to reject message. Sender receives the usual MTA error message.

    DISCARD
        message is silently discarded

AV_PORT
    port number will be used to communicate with anti-virus scanner server
    Syntax :
    AV_PORT 2000

AV_TYPE, AV_PATH and AV_ARGS
    Anti-virus specific parameters - these parameters are specific to each anti-virus and tells j-chkmail what kind of anti-virus is being used, the path to the command line scanner and eventual parameters to pass to the scanner. Nowadays, only these three anti-virus are supported by j-chkmail.
    Syntax :
    AV_TYPE UVSCAN
    AV_PATH /usr/local/uvscan/uvscan
    AV_ARGS --mime --secure -rv --summary --noboot
    AV_TYPE SOPHOS
    AV_PATH /opt/sophos/bin/sweep
    AV_ARGS -nb -f -all -rec -ss -sc -archive
    AV_TYPE TREND
    AV_PATH /opt/trend/ISBASE/IScan.BASE/vscan
    AV_ARGS -a

AV_SAVE_MSG
    doesn't delete spool message if a virus is detected in a message.
    Syntax :
    AV_SAVE_MSG YES | NO
    Default : NO

•   Filtering messages sent to Intranet users

CHECK_LOCAL_USERS
    this option enables checking of local users recipient addresses (as defined at /etc/mail/j-local-users file) against known IP networks (as defined at /etc/mail/j-nets file).
    Syntax :
    CHECK_LOCAL_USERS YES | NO
    Default : NO

•   Filtering messages by the number of recipients

CHECK_NB_RCPT
    this option enables checking of number of message recipients and the IP address SMTP connection is coming from, against known IP networks (as defined at /etc/mail/j-nets file).
    Syntax :
    CHECK_NB_RCPT YES | NO
    Default : NO

MAX_RCPT_FROM_DOMAIN
    Syntax :
    MAX_RCPT_FROM_DOMAIN 200
    Default : 200

MAX_RCPT_FROM_LOCAL
    Syntax :
    MAX_RCPT_FROM_LOCAL 200
    Default : 200

MAX_RCPT_FROM_FRIEND
    Syntax :
    MAX_RCPT_FROM_FRIEND 1000
    Default : 1000

MAX_RCPT_FROM_OUTSIDE
    Syntax :
    MAX_RCPT_FROM_OUTSIDE 10
    Default : 10

•   Filtering messages by RFCs conformance

NO_TO_HEADERS
    this option enables checking of existence of at least one recipient address between header fields (To or Cc or Bcc).
    Syntax :
    NO_TO_HEADERS OK | REJECT
    Default : OK

NO_FROM_HEADERS
    this option enables checking of existence of at least one sender address correctly written (fields From at header or envelope).
    Syntax :
    NO_FROM_HEADERS OK | REJECT
    Default : OK

•   Trying to detect forget domain address

CHECK_DOMAIN_ADDRESS
    this option enables checking of sender address. If sender e-mail address is an address from your domain and the IP network the SMTP connection is coming from isn't defined at j-nets file, the message may be rejected. There are some unsolved problems with this option as there may be some legitimate messages of this kind : e.g. messages sent to external list servers. So it isn't recommended to use this option.
    Syntax :
    CHECK_DOMAIN_ADDRESS OK | REJECT
    Default : OK

FILES

/etc/mail/j-chkmail.cf
    Global j-chkmail configuration file

SEE ALSO
j-chkmail(8), j-printstats(1), j-scanfile(5)

BUGS
Bugs ??? Did you say bugs ??? Where did you see a bug ???

If you find yourself in a very improbable situation of finding a bug, please send me a bug repport.

AUTHOR
Joe's j-chkmail was written by Jose Marcio Martins da Cruz : martins@paris.ensmp.fr