Documentation cleanup.

This commit is contained in:
Scott Kitterman 2007-12-15 06:20:30 +00:00
commit f778a5ebbf
4 changed files with 32 additions and 16 deletions

24
README
View file

@ -1,6 +1,6 @@
postfix-policyd-spf-perl 2.003
postfix-policyd-spf-perl 2.005
A Postfix SMTPd policy server for SPF checking
(C) 2007 Scott Kitterman <scott@kitterman.com> and Julian Mehnle
(C) 2007 Scott Kitterman <scott@kitterman.com> and Julian Mehnle
<julian@mehnle.net>
(C) 2003-2004 Meng Weng Wong <mengwong@pobox.com>
Thanks for contributions by various members of the SPF project
@ -10,31 +10,31 @@ Thanks for contributions by various members of the SPF project
postfix-policyd-spf-perl is a Postfix SMTPd policy daemon for SPF checking.
It is implemented in pure Perl and uses the Mail::SPF CPAN module. Note that
Mail::SPF is a complete re-implementation of SPF based on the final SPF RFC,
RFC 4408. It shares no code with the older Mail::SPF::Query that was the
original SPF development implementation. If you are upgrading from on older
RFC 4408. It shares no code with the older Mail::SPF::Query that was the
original SPF development implementation. If you are upgrading from on older
version of this policy server you will need to install Mail::SPF.
This version of the policy server always checks HELO before Mail From (older
versions just checked HELO if Mail From was null). It will reject mail that
fails either Mail From or HELO SPF checks. It will defer mail if there is a
This version of the policy server always checks HELO before Mail From (older
versions just checked HELO if Mail From was null). It will reject mail that
fails either Mail From or HELO SPF checks. It will defer mail if there is a
temporary SPF error and the message would othersise be permitted
(DEFER_IF_PERMIT). If the HELO check produces a REJECT/DEFER result, Mail From
will not be checked.
If the message is not rejected or deferred, the policy server will PREPEND the
If the message is not rejected or deferred, the policy server will PREPEND the
appropriate SPF Received header. If Mail From is anything other than completely
empty (i.e. <>) then the Mail From result will be used for SPF Received (e.g.
Mail From None even if HELO is Pass).
The policy server skips SPF checks for connections from the localhost (127.) and
instead prepends and logs 'SPF skipped - localhost is always allowed.' If you
have relays that you want to skip SPF checks for, you can add them to
instead prepends and logs 'SPF skipped - localhost is always allowed.' If you
have relays that you want to skip SPF checks for, you can add them to
relay_addresses on line 78 using standard CIDR notation in a space separated
list. For these addresses, 'X-Comment: SPF skipped for whitelisted relay' is
prepended and logged.
Error conditions within the policy server (that don't result in a crash) or from
Mail::SPF will return DUNNO.
Error conditions within the policy server (that don't result in a crash) or from
Mail::SPF will return DUNNO.
See INSTALL for installation instructions.