Welcome to http://emailscan.sourceforge.net/

EmailScan v0.12
Copyright (C) 2000 Mat Kovach 

Brought to you via the GPL :)

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 distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

INTRODUCTION

	EmailScan is yet another scanner for e-mail.  Now, why did I
	write my own and not use one of the others that are available.
	First of all, I have always used my own and second of all I 
	wanted something that was a bit more flexable, expandable, and
	portable.

	Although EmailScan uses bash, it should be able to use ksh just
	as well.  If always attempts to NOT use any gnu specific switchs
	on the utilities used.  My goal is to make EmailScan work on 
	any platform that has a virus scanner available for it.

	Another feature that I found lacking (in my eyes) was how restrictive
	more scanner "wrappers" are.  Which is why I have broken off 
	quite a bit of the fuctions in emailscan-libs.  This will allow
	adminstrators that have a better way, to add it to the script
	in a faily simple way (and hopefully share it with us).  While
	I will be working hard to provide strong baseline projection, I 
	obviously am not the end-all-be-all of e-mail virus projection, 
	so why not make it EASY to contribute.

FILES:

	o README

	This file.

	o emailscan

	The base script.  It reads in the e-mail message and does the 
	processing.

	o bad-files

	file extentions that we block.

	o bad-types

	types of files that we block.

	o emailscan.conf

	This is an enviroment script which is sourced in each time the
	script is run.   Here is where you configure variables that both
	emailscan and emailscan-libs will need to operate.

	o emailscan-libs

	This is the "library functions" for emailscan.  Right now the
	following functions are used in emailscan and the following
	fuctions must be defined in emailscan-libs.

	make_attachments
	
		Takes the e-mail message and seperates it into files
		that will be examined.

	find_bad_types

		This takes the files created by make_attachments and
		checks what TYPE of file it is.  These filetypes are
		located in bad-types

	find_bad_files

		This takes the files created by make_attachments and
		using the iname fuction of find and the experssions
		in bad-files to look for files to be blocked.

	virus_scan_files

		This does a virus scan on the files created by 
		make_attachment.

	procmailrc

		this is a sample system wide procmailrc so that
		emailscan is run for each local email that is 
		delivered.

Hey, and right now it does work.

INSTALLATION

	Installation is done now completely by hand, but isn't too 
	painful.

	Basically, make sure you have the following programs installed:

	mkdir
	rm
	cat
	metamail
	find
	file
	grep
	formail
	procmail
	sendmail
	send
	mv

	and a virus scanning package (I currently us uvscan from Network
	Assoc.).

	Pick a place to install it. (I choose /etc/emailscan)

	Modify emailscan.conf.  Make sure you have the directories, file
	locations, and options of the virus scanner.

	Install /etc/procmailrc

	Make sure sendmail is using procmail as the local delivery agent.
	This is pretty much the default install for sendmail at this time.
	If you are not using it, I highly recommend that you do.

	Then test :)

FEATURE

	I have the following plans

	o	Move the mailing of messages to emailscan-libs and make
		it much more configurable.
	o	Make emailscan work when relaying messages through a 
		mail host.
	o	A nice auto configuration script and installer.
	o	Any other features point out to me that are needed and/or
		desired.