$Id: README,v 1.2 2007/03/10 03:52:22 msk Exp $

INTRODUCTION
============

This is the development area for Sendmail's BATV (Bounce Address Tag
Validation) filter, which is our implementation of the BATV service.

The filter implemented here, if plugged into the Sendmail MTA, provides
envelope sender verification service as per the BATV specification.


ADVISORY
========

THIS IS PRE-RELEASE SOFTWARE, and should not be used in any critical
production environments (yet).  Although we believe it is secure, it has
not undergone a formal security audit or thorough QA process.  However, we
hope this pre-release period will be as brief as possible so that it can be
sanctioned for mainstream use.


COMPILING
=========

Requires sendmail v8.14.0 or later, for required milter protocol
enhancements.

To build this package in the public domain:

(1) Download and unpack the source package.
(2) Change to the batv-milter-(version) directory.
(3) Edit batv-filter/Makefile.m4 as indicated in those files to specify the
    locations of the OpenSSL include and library files.
(4) Type "sh Build".


INSTALLING
==========

(1) Configure sendmail:
  (a) Choose a socket at which the MTA and the filter will rendezvous
      (see the documentation in libmilter for details)
  (b) Add a line like this example to your sendmail.mc using your desired
      socket specification:
	INPUT_MAIL_FILTER(`batv-filter', `S=inet:8893@localhost')
  (c) Rebuild your sendmail.cf in the usual way

(2) Start batv-filter.  You will need at least the "-p" option.  The current
    recommended set of command line options is:

	-l -p SOCKETSPEC -d DOMAIN -a ALLOWLIST -k KEYFILE

    ...where SOCKETSPEC is the socket you told sendmail to use above,
    DOMAIN is the domain or set of domains for which you want to verify
    mail, ALLOWLIST is a file containing envelope senders or patterns
    that should be ignored by the filter, and KEYFILE is a file containing
    the key to use when signing envelope senders.

(3) Restart sendmail.


SUPPORT
=======

To get support or report bugs, you can access the Sourceforge "tracker"
facilities at http://sourceforge.net/projects/batv-milter.

There are two public mailing lists available for news and questions about
batv-milter.  To keep up to date on the latest developments, please
subscribe to one or both of the following:

	batv-milter-announce@lists.sourceforge.net (release announcements)
	batv-milter-discuss@lists.sourceforge.net (general discussion)

You can subscribe to these lists via the project URL above.  There is also
a private mailing list which should be used to report security bugs or
other potentially sensitive issues:

	batv-milter-security@lists.sourceforge.net (security issues)
