SAGATOR version 0.3

(c) 2003 Jan ONDREJ (SAL) <ondrejj@salstar.sk>

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.

This program is a email antivir gateway. It is an interface
to postfix, which runs clamscan antivirus and spamassassin.

---------------------------------------------------------------------

Features:
  - simple chroot support
  - modular antivirus support
     - currently supports only clamscan from clamav
     - any other antivirus can be implemented
     - spamaassassin supprt in future versions
  - you don't need any perl modules or any other modules, only python

---------------------------------------------------------------------

Requirements:
  - python1 1.5.2 or higher (python2 recomended)
  - clamav, spamassassin, ...
  - postfix 1.1.11 (or may be later or newer)

---------------------------------------------------------------------

Tests:
  Hardware:
    Intel Celeron 950 MHz/256 MB RAM
  Software:
    RedHat Linux 9
    postfix 1.1.11
    spamassassin - used as daemon
    clamav - started as binary
    sagator - started as separate daemon with forking
  Pattern:
    # of bigtest patterns (1 Palyh, 1 Lirva, 1 simple spam,
          1 long 1000 lines pattern, 1 long 300 lines pattern,
          1 mime zipped Palyh, 1 mime attached random data)
          size: 556 kB
    files: 7
    viruses: 4
    spams: 1
  Time with spamd:
    3*3 /~ 1m
  Time without spamtest:
    3*3 /~ 1m

---------------------------------------------------------------------

Installation:

1. ClamAV installation

  Download and install clamav - clam antivirus.
URL: http://clamav.elektrapro.com/. You will also need some
decompressors, like unrar, unace, unarj, zoo, lha, tar, deb.

  If you are using clamd, do not forget to start it in chroot,
and set these parameters:
  Leave commented:
    #ScannerDaemonOutputFormat # required
  Uncoment:
    StreamSaveToDisk # recomended
    ScanMail # required
    ScanArchive # recomended

  If you are using another DataDirectory (directory with viruses),
do not forget to set freshclam to use this directory. Otherwise
your virus database will be not up to date.

2. Install this program

  Unpack the package. Go into main directory and run:
    make install

3. Create chrooted environment.

  Go into main directory, then run:
    ./makechroot.sh /some/where/new/root/
The directory cat be for example: /var/spool/vscan .
This script creates a small copy of your files, where are required
for antivirus.

  If you want to secure this newroot, do make secure.

4. Main configuration.

  Edit config.py. There are some parameters, described in config.py file.
You must set all of these. If you do not need it, set it to 0 (False),
or [] (emty list).

5. Postfix configuration.

# /etc/postfix/main.cf
mynetworks = 127.0.0.0/8, ...
content_filter = smtp:localhost:27

# /etc/postfix/master.cf
# ANTIVIR
localhost:27	inet	n	n	n	-	5	spawn
  user=root argv=/usr/bin/sagator --inetd --logfile /tmp/sagator.log
localhost:26	inet	n	-	n	-	5	smtpd
  -o content_filter=
  -o local_recipient_maps=
  -o myhostname=antivir.mydomain.sk
