This commit was manufactured by cvs2svn to create tag 'pymilter-0_8_12'.

Sprout from master 2008-12-13 21:08:51 UTC Stuart Gathman <stuart@gathman.org> 'Release 0.8.12' Cherrypick from master 2008-08-25 18:49:13 UTC Stuart Gathman <stuart@gathman.org> 'Release 0.8.10': HOWTO Cherrypick from master 2008-12-14 02:55:42 UTC Stuart Gathman <stuart@gathman.org> 'Release 0.8.12': MANIFEST.in Cherrypick from bmsi 2005-05-31 18:23:49 UTC Stuart Gathman <stuart@gathman.org> 'Development changes since 0.7.2': sample.py test/amazon test/big5 test/bounce test/bounce1 test/bound test/honey test/missingboundary test/samp1 test/spam44 test/spam7 test/spam8 test/test1 test/test8 test/virus1 test/virus13 test/virus2 test/virus3 test/virus4 test/virus5 test/virus6 test/virus7 testsample.py
Release 0.8.12
2008-12-14 02:55:43 +00:00 · 2008-12-13 21:08:51 +00:00 · 2008-12-13 21:06:16 +00:00 · 2008-12-13 20:45:30 +00:00 · 2008-12-13 20:29:56 +00:00 · 2008-12-06 21:13:57 +00:00
58 changed files with 4245 additions and 4380 deletions
@@ -0,0 +1,339 @@
 		    GNU GENERAL PUBLIC LICENSE
 		       Version 2, June 1991
 Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.
 			    Preamble
  The licenses for most software are designed to take away your
 freedom to share and change it.  By contrast, the GNU General Public
 License is intended to guarantee your freedom to share and change free
 software--to make sure the software is free for all its users.  This
 General Public License applies to most of the Free Software
 Foundation's software and to any other program whose authors commit to
 using it.  (Some other Free Software Foundation software is covered by
 the GNU Lesser General Public License instead.)  You can apply it to
 your programs, too.
  When we speak of free software, we are referring to freedom, not
 price.  Our General Public Licenses are designed to make sure that you
 have the freedom to distribute copies of free software (and charge for
 this service if you wish), that you receive source code or can get it
 if you want it, that you can change the software or use pieces of it
 in new free programs; and that you know you can do these things.
  To protect your rights, we need to make restrictions that forbid
 anyone to deny you these rights or to ask you to surrender the rights.
 These restrictions translate to certain responsibilities for you if you
 distribute copies of the software, or if you modify it.
  For example, if you distribute copies of such a program, whether
 gratis or for a fee, you must give the recipients all the rights that
 you have.  You must make sure that they, too, receive or can get the
 source code.  And you must show them these terms so they know their
 rights.
  We protect your rights with two steps: (1) copyright the software, and
 (2) offer you this license which gives you legal permission to copy,
 distribute and/or modify the software.
  Also, for each author's protection and ours, we want to make certain
 that everyone understands that there is no warranty for this free
 software.  If the software is modified by someone else and passed on, we
 want its recipients to know that what they have is not the original, so
 that any problems introduced by others will not reflect on the original
 authors' reputations.
  Finally, any free program is threatened constantly by software
 patents.  We wish to avoid the danger that redistributors of a free
 program will individually obtain patent licenses, in effect making the
 program proprietary.  To prevent this, we have made it clear that any
 patent must be licensed for everyone's free use or not licensed at all.
  The precise terms and conditions for copying, distribution and
 modification follow.
 		    GNU GENERAL PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
  0. This License applies to any program or other work which contains
 a notice placed by the copyright holder saying it may be distributed
 under the terms of this General Public License.  The "Program", below,
 refers to any such program or work, and a "work based on the Program"
 means either the Program or any derivative work under copyright law:
 that is to say, a work containing the Program or a portion of it,
 either verbatim or with modifications and/or translated into another
 language.  (Hereinafter, translation is included without limitation in
 the term "modification".)  Each licensee is addressed as "you".
 Activities other than copying, distribution and modification are not
 covered by this License; they are outside its scope.  The act of
 running the Program is not restricted, and the output from the Program
 is covered only if its contents constitute a work based on the
 Program (independent of having been made by running the Program).
 Whether that is true depends on what the Program does.
  1. You may copy and distribute verbatim copies of the Program's
 source code as you receive it, in any medium, provided that you
 conspicuously and appropriately publish on each copy an appropriate
 copyright notice and disclaimer of warranty; keep intact all the
 notices that refer to this License and to the absence of any warranty;
 and give any other recipients of the Program a copy of this License
 along with the Program.
 You may charge a fee for the physical act of transferring a copy, and
 you may at your option offer warranty protection in exchange for a fee.
  2. You may modify your copy or copies of the Program or any portion
 of it, thus forming a work based on the Program, and copy and
 distribute such modifications or work under the terms of Section 1
 above, provided that you also meet all of these conditions:
    a) You must cause the modified files to carry prominent notices
    stating that you changed the files and the date of any change.
    b) You must cause any work that you distribute or publish, that in
    whole or in part contains or is derived from the Program or any
    part thereof, to be licensed as a whole at no charge to all third
    parties under the terms of this License.
    c) If the modified program normally reads commands interactively
    when run, you must cause it, when started running for such
    interactive use in the most ordinary way, to print or display an
    announcement including an appropriate copyright notice and a
    notice that there is no warranty (or else, saying that you provide
    a warranty) and that users may redistribute the program under
    these conditions, and telling the user how to view a copy of this
    License.  (Exception: if the Program itself is interactive but
    does not normally print such an announcement, your work based on
    the Program is not required to print an announcement.)
 These requirements apply to the modified work as a whole.  If
 identifiable sections of that work are not derived from the Program,
 and can be reasonably considered independent and separate works in
 themselves, then this License, and its terms, do not apply to those
 sections when you distribute them as separate works.  But when you
 distribute the same sections as part of a whole which is a work based
 on the Program, the distribution of the whole must be on the terms of
 this License, whose permissions for other licensees extend to the
 entire whole, and thus to each and every part regardless of who wrote it.
 Thus, it is not the intent of this section to claim rights or contest
 your rights to work written entirely by you; rather, the intent is to
 exercise the right to control the distribution of derivative or
 collective works based on the Program.
 In addition, mere aggregation of another work not based on the Program
 with the Program (or with a work based on the Program) on a volume of
 a storage or distribution medium does not bring the other work under
 the scope of this License.
  3. You may copy and distribute the Program (or a work based on it,
 under Section 2) in object code or executable form under the terms of
 Sections 1 and 2 above provided that you also do one of the following:
    a) Accompany it with the complete corresponding machine-readable
    source code, which must be distributed under the terms of Sections
    1 and 2 above on a medium customarily used for software interchange; or,
    b) Accompany it with a written offer, valid for at least three
    years, to give any third party, for a charge no more than your
    cost of physically performing source distribution, a complete
    machine-readable copy of the corresponding source code, to be
    distributed under the terms of Sections 1 and 2 above on a medium
    customarily used for software interchange; or,
    c) Accompany it with the information you received as to the offer
    to distribute corresponding source code.  (This alternative is
    allowed only for noncommercial distribution and only if you
    received the program in object code or executable form with such
    an offer, in accord with Subsection b above.)
 The source code for a work means the preferred form of the work for
 making modifications to it.  For an executable work, complete source
 code means all the source code for all modules it contains, plus any
 associated interface definition files, plus the scripts used to
 control compilation and installation of the executable.  However, as a
 special exception, the source code distributed need not include
 anything that is normally distributed (in either source or binary
 form) with the major components (compiler, kernel, and so on) of the
 operating system on which the executable runs, unless that component
 itself accompanies the executable.
 If distribution of executable or object code is made by offering
 access to copy from a designated place, then offering equivalent
 access to copy the source code from the same place counts as
 distribution of the source code, even though third parties are not
 compelled to copy the source along with the object code.
  4. You may not copy, modify, sublicense, or distribute the Program
 except as expressly provided under this License.  Any attempt
 otherwise to copy, modify, sublicense or distribute the Program is
 void, and will automatically terminate your rights under this License.
 However, parties who have received copies, or rights, from you under
 this License will not have their licenses terminated so long as such
 parties remain in full compliance.
  5. You are not required to accept this License, since you have not
 signed it.  However, nothing else grants you permission to modify or
 distribute the Program or its derivative works.  These actions are
 prohibited by law if you do not accept this License.  Therefore, by
 modifying or distributing the Program (or any work based on the
 Program), you indicate your acceptance of this License to do so, and
 all its terms and conditions for copying, distributing or modifying
 the Program or works based on it.
  6. Each time you redistribute the Program (or any work based on the
 Program), the recipient automatically receives a license from the
 original licensor to copy, distribute or modify the Program subject to
 these terms and conditions.  You may not impose any further
 restrictions on the recipients' exercise of the rights granted herein.
 You are not responsible for enforcing compliance by third parties to
 this License.
  7. If, as a consequence of a court judgment or allegation of patent
 infringement or for any other reason (not limited to patent issues),
 conditions are imposed on you (whether by court order, agreement or
 otherwise) that contradict the conditions of this License, they do not
 excuse you from the conditions of this License.  If you cannot
 distribute so as to satisfy simultaneously your obligations under this
 License and any other pertinent obligations, then as a consequence you
 may not distribute the Program at all.  For example, if a patent
 license would not permit royalty-free redistribution of the Program by
 all those who receive copies directly or indirectly through you, then
 the only way you could satisfy both it and this License would be to
 refrain entirely from distribution of the Program.
 If any portion of this section is held invalid or unenforceable under
 any particular circumstance, the balance of the section is intended to
 apply and the section as a whole is intended to apply in other
 circumstances.
 It is not the purpose of this section to induce you to infringe any
 patents or other property right claims or to contest validity of any
 such claims; this section has the sole purpose of protecting the
 integrity of the free software distribution system, which is
 implemented by public license practices.  Many people have made
 generous contributions to the wide range of software distributed
 through that system in reliance on consistent application of that
 system; it is up to the author/donor to decide if he or she is willing
 to distribute software through any other system and a licensee cannot
 impose that choice.
 This section is intended to make thoroughly clear what is believed to
 be a consequence of the rest of this License.
  8. If the distribution and/or use of the Program is restricted in
 certain countries either by patents or by copyrighted interfaces, the
 original copyright holder who places the Program under this License
 may add an explicit geographical distribution limitation excluding
 those countries, so that distribution is permitted only in or among
 countries not thus excluded.  In such case, this License incorporates
 the limitation as if written in the body of this License.
  9. The Free Software Foundation may publish revised and/or new versions
 of the General Public License from time to time.  Such new versions will
 be similar in spirit to the present version, but may differ in detail to
 address new problems or concerns.
 Each version is given a distinguishing version number.  If the Program
 specifies a version number of this License which applies to it and "any
 later version", you have the option of following the terms and conditions
 either of that version or of any later version published by the Free
 Software Foundation.  If the Program does not specify a version number of
 this License, you may choose any version ever published by the Free Software
 Foundation.
  10. If you wish to incorporate parts of the Program into other free
 programs whose distribution conditions are different, write to the author
 to ask for permission.  For software which is copyrighted by the Free
 Software Foundation, write to the Free Software Foundation; we sometimes
 make exceptions for this.  Our decision will be guided by the two goals
 of preserving the free status of all derivatives of our free software and
 of promoting the sharing and reuse of software generally.
 			    NO WARRANTY
  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
 REPAIR OR CORRECTION.
  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGES.
 		     END OF TERMS AND CONDITIONS
 	    How to Apply These Terms to Your New Programs
  If you develop a new program, and you want it to be of the greatest
 possible use to the public, the best way to achieve this is to make it
 free software which everyone can redistribute and change under these terms.
  To do so, attach the following notices to the program.  It is safest
 to attach them to the start of each source file to most effectively
 convey the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
    <one line to give the program's name and a brief idea of what it does.>
    Copyright (C) <year>  <name of author>
    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.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 Also add information on how to contact you by electronic and paper mail.
 If the program is interactive, make it output a short notice like this
 when it starts in an interactive mode:
    Gnomovision version 69, Copyright (C) year name of author
    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.
 The hypothetical commands `show w' and `show c' should show the appropriate
 parts of the General Public License.  Of course, the commands you use may
 be called something other than `show w' and `show c'; they could even be
 mouse-clicks or menu items--whatever suits your program.
 You should also get your employer (if you work as a programmer) or your
 school, if any, to sign a "copyright disclaimer" for the program, if
 necessary.  Here is a sample; alter the names:
  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
  `Gnomovision' (which makes passes at compilers) written by James Hacker.
  <signature of Ty Coon>, 1 April 1989
  Ty Coon, President of Vice
 This General Public License does not permit incorporating your program into
 proprietary programs.  If your program is a subroutine library, you may
 consider it more useful to permit linking proprietary applications with the
 library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.
@@ -5,10 +5,18 @@ wrapper (Milter.py) that handles attachments, did lots of testing, packaged
 it with distutils, and generally transformed it from a quick hack to a
 real, usable Python extension.
-Other contributors:
+Other contributors (in random order):
 Dwayne Litzenberger, B.A.Sc.
  for library_dirs patch to compile on Debian 
 Dave MacQuigg 
  for noticing that smfi_insheader wasn't supported, and creating
  a template to help first time pymilter users create their own milter.
 Terence Way
  for providing a Python port of SPF
 Scott Kitterman
  for doing lots of testing and debugging of SPF against draft standard,
  and for putting up a web page that validates SPF records using spf.py
 Alexander Kourakos
  for plugging several memory leaks
 George Graf at Vienna University of Economics and Business Administration
@@ -22,6 +30,9 @@ John Draper
  then pointing out that it would be easier to just write the MTA in Python.
 Eric S. Johansson
  for helpful design discussions while working on camram
 Alex Savguira
  for finding bugs with international headers and
  suggesting the scan_zip option.
 Business Management Systems - http://www.bmsi.com
  for hosting the website, and providing paying clients who need milter service
  so I can work on it as part of my day job.
@@ -0,0 +1,214 @@
 # Revision 1.69  2006/11/04 22:09:39  customdesigned
 # Another lame DSN heuristic.  Block PTR cache poisoning attack.
 #
 # Revision 1.68  2006/10/04 03:46:01  customdesigned
 # Fix defaults.
 #
 # Revision 1.67  2006/10/01 01:44:06  customdesigned
 # case_sensitive_localpart option, more delayed bounce heuristics,
 # optional smart_alias section.
 #
 # Revision 1.66  2006/07/26 16:42:26  customdesigned
 # Support CBV timeout
 #
 # Revision 1.65  2006/06/21 22:22:00  customdesigned
 # Handle multi-line headers in delayed dsns.
 #
 # Revision 1.64  2006/06/21 21:12:04  customdesigned
 # More delayed reject token headers.
 # Don't require HELO pass for CBV.
 #
 # Revision 1.63  2006/05/21 03:41:44  customdesigned
 # Fail dsn
 #
 # Revision 1.61  2006/05/17 21:28:07  customdesigned
 # Create GOSSiP record only when connection will procede to DATA.
 #
 # Revision 1.60  2006/05/12 16:14:48  customdesigned
 # Don't require SPF pass for white/black listing mail from trusted relay.
 # Support localpart wildcard for white and black lists.
 #
 # Revision 1.59  2006/04/06 18:14:17  customdesigned
 # Check whitelist/blacklist even when not checking SPF (e.g. trusted relay).
 #
 # Revision 1.58  2006/03/10 20:52:49  customdesigned
 # Use re to recognize failure DSNs.
 #
 # Revision 1.57  2006/03/07 20:50:54  customdesigned
 # Use signed Message-ID in delayed reject to blacklist senders
 #
 # Revision 1.56  2006/02/24 02:12:54  customdesigned
 # Properly report hard PermError (lax mode fails also) by always setting
 # perm_error attribute with PermError exception.  Improve reporting of
 # invalid domain PermError.
 #
 # Revision 1.55  2006/02/17 05:04:29  customdesigned
 # Use SRS sign domain list.
 # Accept but do not use for training whitelisted senders without SPF pass.
 # Immediate rejection of unsigned bounces.
 #
 # Revision 1.54  2006/02/16 02:16:36  customdesigned
 # User specific SPF receiver policy.
 #
 # Revision 1.53  2006/02/12 04:15:01  customdesigned
 # Remove spf dependency for iniplist
 #
 # Revision 1.52  2006/02/12 02:12:08  customdesigned
 # Use CIDR notation for internal connect list.
 #
 # Revision 1.51  2006/02/12 01:13:58  customdesigned
 # Don't check rcpt user list when signed MFROM.
 #
 # Revision 1.50  2006/02/09 20:39:43  customdesigned
 # Use CIDR notation for trusted_relay iplist
 #
 # Revision 1.49  2006/01/30 23:14:48  customdesigned
 # put back eom condition
 #
 # Revision 1.48  2006/01/12 20:31:24  customdesigned
 # Accelerate training via whitelist and blacklist.
 #
 # Revision 1.47  2005/12/29 04:49:10  customdesigned
 # Do not auto-whitelist autoreplys
 #
 # Revision 1.46  2005/12/28 20:17:29  customdesigned
 # Expire and renew AddrCache entries
 #
 # Revision 1.45  2005/12/23 22:34:46  customdesigned
 # Put guessed result in separate header.
 #
 # Revision 1.44  2005/12/23 21:47:07  customdesigned
 # Move Received-SPF header to top.
 #
 # Revision 1.43  2005/12/09 16:54:01  customdesigned
 # Select neutral DSN template for best_guess
 #
 # Revision 1.42  2005/12/01 22:42:32  customdesigned
 # improve gossip support.
 # Initialize srs_domain from srs.srs config property.  Should probably
 # always block unsigned DSN when signing all.
 #
 # Revision 1.41  2005/12/01 18:59:25  customdesigned
 # Fix neutral policy.  pobox.com -> openspf.org
 #
 # Revision 1.40  2005/11/07 21:22:35  customdesigned
 # GOSSiP support, local database only.
 #
 # Revision 1.39  2005/10/31 00:04:58  customdesigned
 # Simple implementation of trusted_forwarder list.  Inefficient for
 # more than 1 or 2 entries.
 #
 # Revision 1.38  2005/10/28 19:36:54  customdesigned
 # Don't check internal_domains for trusted_relay.
 #
 # Revision 1.37  2005/10/28 09:30:49  customdesigned
 # Do not send quarantine DSN when sender is DSN.
 #
 # Revision 1.36  2005/10/23 16:01:29  customdesigned
 # Consider MAIL FROM a match for supply_sender when a subdomain of From or Sender
 #
 # Revision 1.35  2005/10/20 18:47:27  customdesigned
 # Configure auto_whitelist senders.
 #
 # Revision 1.34  2005/10/19 21:07:49  customdesigned
 # access.db stores keys in lower case
 #
 # Revision 1.33  2005/10/19 19:37:50  customdesigned
 # Train screener on whitelisted messages.
 #
 # Revision 1.32  2005/10/14 16:17:31  customdesigned
 # Auto whitelist refinements.
 #
 # Revision 1.31  2005/10/14 01:14:08  customdesigned
 # Auto whitelist feature.
 #
 # Revision 1.30  2005/10/12 16:36:30  customdesigned
 # Release 0.8.3
 #
 # Revision 1.29  2005/10/11 22:50:07  customdesigned
 # Always check HELO except for SPF pass, temperror.
 #
 # Revision 1.28  2005/10/10 23:50:20  customdesigned
 # Use logging module to make logging threadsafe (avoid splitting log lines)
 #
 # Revision 1.27  2005/10/10 20:15:33  customdesigned
 # Configure SPF policy via sendmail access file.
 #
 # Revision 1.26  2005/10/07 03:23:40  customdesigned
 # Banned users option.  Experimental feature to supply Sender when
 # missing and MFROM domain doesn't match From.  Log cipher bits for
 # SMTP AUTH.  Sketch access file feature.
 #
 # Revision 1.25  2005/09/08 03:55:08  customdesigned
 # Handle perverse MFROM quoting.
 #
 # Revision 1.24  2005/08/18 03:36:54  customdesigned
 # Don't innoculate with SCREENED mail.
 #
 # Revision 1.23  2005/08/17 19:35:27  customdesigned
 # Send DSN before adding message to quarantine.
 #
 # Revision 1.22  2005/08/11 22:17:58  customdesigned
 # Consider SMTP AUTH connections internal.
 #
 # Revision 1.21  2005/08/04 21:21:31  customdesigned
 # Treat fail like softfail for selected (braindead) domains.
 # Treat mail according to extended processing results, but
 # report any PermError that would officially result via DSN.
 #
 # Revision 1.20  2005/08/02 18:04:35  customdesigned
 # Keep screened honeypot mail, but optionally discard honeypot only mail.
 #
 # Revision 1.19  2005/07/20 03:30:04  customdesigned
 # Check pydspam version for honeypot, include latest pyspf changes.
 #
 # Revision 1.18  2005/07/17 01:25:44  customdesigned
 # Log as well as use extended result for best guess.
 #
 # Revision 1.17  2005/07/15 20:25:36  customdesigned
 # Use extended results processing for best_guess.
 #
 # Revision 1.16  2005/07/14 03:23:33  customdesigned
 # Make SES package optional.  Initial honeypot support.
 #
 # Revision 1.15  2005/07/06 04:05:40  customdesigned
 # Initial SES integration.
 #
 # Revision 1.14  2005/07/02 23:27:31  customdesigned
 # Don't match hostnames for internal connects.
 #
 # Revision 1.13  2005/07/01 16:30:24  customdesigned
 # Always log trusted Received and Received-SPF headers.
 #
 # Revision 1.12  2005/06/20 22:35:35  customdesigned
 # Setreply for rejectvirus.
 #
 # Revision 1.11  2005/06/17 02:07:20  customdesigned
 # Release 0.8.1
 #
 # Revision 1.10  2005/06/16 18:35:51  customdesigned
 # Ignore HeaderParseError decoding header
 #
 # Revision 1.9  2005/06/14 21:55:29  customdesigned
 # Check internal_domains for outgoing mail.
 #
 # Revision 1.8  2005/06/06 18:24:59  customdesigned
 # Properly log exceptions from pydspam
 #
 # Revision 1.7  2005/06/04 19:41:16  customdesigned
 # Fix bugs from testing RPM
 #
 # Revision 1.6  2005/06/03 04:57:05  customdesigned
 # Organize config reader by section.  Create defang section.
 #
 # Revision 1.5  2005/06/02 15:00:17  customdesigned
 # Configure banned extensions.  Scan zipfile option with test case.
 #
 # Revision 1.4  2005/06/02 04:18:55  customdesigned
 # Update copyright notices after reading article on /.
 #
 # Revision 1.3  2005/06/02 02:09:00  customdesigned
 # Record timestamp in send_dsn.log
 #
 # Revision 1.2  2005/06/02 01:00:36  customdesigned
 # Support configurable templates for DSNs.
@@ -0,0 +1,154 @@
 On Sun, 11 Feb 2007, Rick Saul wrote:
 > Stuart I was planning to move to centos4.4 in a couple of weeks anyway... 
 > Your advice of where to go from here. 
 Oh - you are asking for a howto.
 	Step one.  Which DSPAM is right for you?
 The DSPAM project makes dspam part of the LDA (Local Delivery Agent).
 Pydspam puts dspam into the MTA (Mail Transfer Agent - sendmail with pymilter).
 The advantage of doing dspam in the LDA is that any aliasing has already been
 resolved.  You need only configure mailboxes.
 The advantage of doing dspam in the MTA is it can screen an entire 
 company as a gateway with multiple domains.  Unfortunately, this
 means you have to tell it about all the aliases that comprise each
 account.  (Also, pydspam is still uses dspam-2.6.5.2 - the Dspam API
 has changed for newer versions.)
 If the LDA is right for you, you'll want to use the official Dspam 
 package.  http://www.nuclearelephant.com/projects/dspam/
 If the MTA approach is what you want, then pydspam is what you want.
 In either case, you will still want pymilter to block forgeries, Windows 
 executables, etc.
 So, lets assume you want to install pymilter, and may or may not
 wish to install pydspam.
 	Step two.  Obtaining RPMS.
 For basic pymilter you'll need:
 python-2.4
 milter-0.8.10
 sendmail-8.13.x	(with milter support enabled)
 and for SPF you'll need:
 pydns-2.3.3-2.4
 pyspf-2.0.5-1.py24
 and for SRS you'll need:
 pysrs-0.30.11-1.py24
 I'm pretty sure you will want to have SPF and SRS available.
 	Step three.  Activate basic milter.
 Activate the basic milter and pysrs by editing /etc/mail/sendmail.mc and adding:
 define(`NO_SRS_FILE',`/etc/mail/no-srs-mailers')dnl
 dnl define(`NO_SRS_FROM_LOCAL')dnl
 HACK(`pysrs',`/var/run/milter/pysrs')dnl
 INPUT_MAIL_FILTER(`pythonfilter', `S=local:/var/run/milter/pythonsock, F=T, T=C:5m;S:20s;R:5m;E:5m')
 You can then "make sendmail.cf" and restart sendmail.
 Start milter and pysrs with "service milter start", "service pysrs start".
 Tail /var/log/milter/milter.log while SMTP clients connect to your
 sendmail instance.  This should show you what the milter is doing.
 By default, milter-0.8.10 rejects on SPF fail.
 	Step four.  Tweaking the basic config.
 Most pymilter configuration is in /etc/mail/pymilter.cfg.  To activate
 changes, "service milter restart".
 By default, milter scans attachments for executable extensions.  You can
 turn this off by setting banned_exts to the empty list.  There are options
 to scan ZIP attachments and rfc822 attachments.  When it finds a banned
 file type, milter saves the original message in /var/log/milter/save,
 and replaces the attachment with a plain text warning message.
 Configure hello_blacklist with your own helo name and domains - which
 you know cannot legitimately be used by external MTAs.
 Configure trusted_relay with your secondary MX servers, if any.  These
 should also run pymilter with similar policies.  (But this isn't
 needed for initial testing.)
 Configure internal_connect with subnets of your internal SMTP clients.
 Internal connections skip SPF testing and other policies.  You will
 likely need to set this to allow outgoing mail if you have
 an SPF policy already.
 Configure internal_domains with domains used by your internal SMTP clients.
 If they attempt to use any other domain, the attempt is blocked and the
 client is logged as a "zombie".  Conversely, any attempt by an external
 MTA to use one of your internal domains is treated as a forgery and
 blocked (a simplified form of local SPF).
 Adjust porn_words and spam_words - these block emails with a Subject
 containing the listed strings.  They can be empty to disable Subject
 string blocking.
 	Advanced SPF configuration.
 The sendmail access file, or another readonly database with that
 format, can be used for detail spf policy.  SPF access policy
 record are tagged with "SPF-{Result}:".  Results are
 Pass, Neutral, Softfail, Fail, PermError.  Currently supported
 policy keywords are OK, CBV, REJECT.  Currently, TempError always
 results in TEMPFAIL.
 The default policies are set in pymilter.cfg.  The defaults
 if none of the config options are set are as follows:
 SPF-Fail:	REJECT
 SPF-Softfail:	CBV
 SPF-Neutral:	OK
 SPF-PermError:	REJECT
 SPF-Pass:	OK
 The tag may be followed by a specific domain.  For instance, to
 require a Pass from aol.com:
 SPF-Neutral:aol.com	REJECT
 SPF-Softfail:aol.com	REJECT
 The CBV policy requires a valid HELO name.  If the EHLO name is 
 RFC2822 compliant, then a DSN is sent to the alleged sender.  The 
 template for the DSN is selected according to the SPF result:
 Fail:		fail.txt
 SoftFail:	softfail.txt
 Neutral:	neutral.txt
 PermError:	permerror.txt
 None:		strike3.txt
 An SPF-Pass is always accepted by the milter.  Domains can be blacklisted 
 via sendmail in the access file or via a RHS DNS blacklist.
 	To be continued.
 Forthcoming topics:
 SRS config
 pydspam config
 wiretap config
 -- 
 	      Stuart D. Gathman <stuart@bmsi.com>
    Business Management Systems Inc.  Phone: 703 591-0911 Fax: 703 591-6154
 "Confutatis maledictis, flammis acribus addictis" - background song for
 a Microsoft sponsored "Where do you want to go from here?" commercial.
@@ -3,20 +3,15 @@ include TODO
 include NEWS
 include CREDITS
 include README
 include ChangeLog
 include MANIFEST.in
 include testsample.py
 include testmime.py
-include testbms.py
+include testutils.py
 include testdspam.py
 include rejects.py
 include bms.py
 include spf.py
 include spfquery.py
 include test.py
 include sample.py
 include milter-template.py
 include test/*
 include Milter/*.py
 include *.spec
 include start.sh
 include milter.rc
 include milter.rc7
 include milter.cfg
@@ -1,22 +1,22 @@
 # Author: Stuart D. Gathman <stuart@bmsi.com>
 # Copyright 2001 Business Management Systems, Inc.
-# This code is under GPL.  See COPYING for details.
+# This code is under the GNU General Public License.  See COPYING for details.
 # A thin OO wrapper for the milter module
 import os
 import milter
 import thread
 from milter import ACCEPT,CONTINUE,REJECT,DISCARD,TEMPFAIL,	\
-  set_flags, setdbg, \
+  set_flags, setdbg, setbacklog, settimeout, error,	\
  ADDHDRS, CHGBODY, ADDRCPT, DELRCPT, CHGHDRS,	\
  V1_ACTS, V2_ACTS, CURR_ACTS
-try:
+try: from milter import QUARANTINE
-  from milter import QUARANTINE
+except: pass
-except:
+
-  #print 'No QUARANTINE support'
+__version__ = '0.8.5'
  pass
 _seq_lock = thread.allocate_lock()
 _seq = 0
@@ -44,7 +44,7 @@ class Milter:
    for i in msg: print i,
    print
-  def connect(self,hostname,unused,hostaddr):
+  def connect(self,hostname,family,hostaddr):
    "Called for each connection to sendmail."
    self.log("connect from %s at %s" % (hostname,hostaddr))
    return CONTINUE
@@ -100,18 +100,20 @@ class Milter:
  def getsymval(self,sym):
    return self.__ctx.getsymval(sym)
-  def setreply(self,rcode,xcode,msg):
+  # If sendmail does not support setmlreply, then only the
-    return self.__ctx.setreply(rcode,xcode,msg)
+  # first msg line is used.
  def setreply(self,rcode,xcode=None,msg=None,*ml):
    return self.__ctx.setreply(rcode,xcode,msg,*ml)
  # Milter methods which can only be called from eom callback.
-  def addheader(self,field,value):
+  def addheader(self,field,value,idx=-1):
-    return self.__ctx.addheader(field,value)
+    return self.__ctx.addheader(field,value,idx)
  def chgheader(self,field,idx,value):
    return self.__ctx.chgheader(field,idx,value)
-  def addrcpt(self,rcpt):
+  def addrcpt(self,rcpt,params=None):
-    return self.__ctx.addrcpt(rcpt)
+    return self.__ctx.addrcpt(rcpt,params)
  def delrcpt(self,rcpt):
    return self.__ctx.delrcpt(rcpt)
@@ -119,6 +121,11 @@ class Milter:
  def replacebody(self,body):
    return self.__ctx.replacebody(body)
  def chgfrom(self,sender,params=None):
    return self.__ctx.chgfrom(sender,params)
  # When quarantined, a message goes into the mailq as if to be delivered,
  # but delivery is deferred until the message is unquarantined.
  def quarantine(self,reason):
    return self.__ctx.quarantine(reason)
@@ -139,16 +146,28 @@ def closecallback(ctx):
  m._setctx(None)	# release milterContext
  return rc
 def dictfromlist(args):
  "Convert ESMTP parm list to keyword dictionary."
  kw = {}
  for s in args:
    pos = s.find('=')
    if pos > 0:
      kw[s[:pos].upper()] = s[pos+1:]
  return kw
 def envcallback(c,args):
-  """Convert ESMTP parms to keyword parameters.
+  """Call function c with ESMTP parms converted to keyword parameters.
  Can be used in the envfrom and/or envrcpt callbacks to process
  ESMTP parameters as python keyword parameters."""
  kw = {}
  pargs = [args[0]]
  for s in args[1:]:
    pos = s.find('=')
    if pos > 0:
-      kw[s[:pos]] = s[pos+1:]
+      kw[s[:pos].upper()] = s[pos+1:]
-  return apply(c,args,kw)
+    else:
      pargs.append(s)
  return c(*pargs,**kw)
 def runmilter(name,socketname,timeout = 0):
  # This bit is here on the assumption that you will be starting this filter
@@ -168,21 +187,22 @@ def runmilter(name,socketname,timeout = 0):
    print "Removing %s" % fname
    try:
      os.unlink(fname)
-    except:
+    except os.error, x:
-      pass
+      import errno
      if x.errno != errno.ENOENT:
        raise milter.error(x)
  # The default flags set include everything
  # milter.set_flags(milter.ADDHDRS)
  milter.set_connect_callback(connectcallback)
  milter.set_helo_callback(lambda ctx, host: ctx.getpriv().hello(host))
-  milter.set_envfrom_callback(lambda ctx,*str:
+  # For envfrom and envrcpt, we would like to convert ESMTP parms to keyword
-  	ctx.getpriv().envfrom(*str))
+  # parms, but then all existing users would have to include **kw to accept
-#  	envcallback(ctx.getpriv().envfrom,str))
+  # arbitrary keywords without crashing.  We do provide envcallback and
-  milter.set_envrcpt_callback(lambda ctx,*str:
+  # dictfromlist to make parsing the ESMTP args convenient.
-  	ctx.getpriv().envrcpt(*str))
+  milter.set_envfrom_callback(lambda ctx,*str: ctx.getpriv().envfrom(*str))
-#  	envcallback(ctx.getpriv().envrcpt,str))
+  milter.set_envrcpt_callback(lambda ctx,*str: ctx.getpriv().envrcpt(*str))
-  milter.set_header_callback(lambda ctx,fld,val:
+  milter.set_header_callback(lambda ctx,fld,val: ctx.getpriv().header(fld,val))
  	ctx.getpriv().header(fld,val))
  milter.set_eoh_callback(lambda ctx: ctx.getpriv().eoh())
  milter.set_body_callback(lambda ctx,chunk: ctx.getpriv().body(chunk))
  milter.set_eom_callback(lambda ctx: ctx.getpriv().eom())
@@ -200,3 +220,8 @@ def runmilter(name,socketname,timeout = 0):
    if start_seq == _seq: raise	# couldn't start
    # milter has been running for a while, but now it can't start new threads
    raise milter.error("out of thread resources")
 __all__ = globals().copy()
 for priv in ('os','milter','thread','factory','_seq','_seq_lock','__version__'):
  del __all__[priv]
 __all__ = __all__.keys()
@@ -0,0 +1,158 @@
 # Email address list with expiration
 #
 # This class acts like a map.  Entries with a value of None are persistent,
 # but disappear after a time limit.  This is useful for automatic whitelists
 # and blacklists with expiration.  The persistent store is a simple ascii
 # file with sender and timestamp on each line.  Entries can be appended
 # to the store, and will be picked up the next time it is loaded.
 #
 # Entries with other values are not persistent.  This is used to hold failed
 # CBV results.
 #
 # $Log$
 # Revision 1.8  2007/09/03 16:18:45  customdesigned
 # Delete unparseable timestamps when loading address cache.  These have
 # arisen because of failure to parse MAIL FROM properly.   Will have to
 # tighten up MAIL FROM parsing to match RFC.
 #
 # Revision 1.7  2007/01/25 22:47:26  customdesigned
 # Persist blacklisting from delayed DSNs.
 #
 # Revision 1.6  2007/01/19 23:31:38  customdesigned
 # Move parse_header to Milter.utils.
 # Test case for delayed DSN parsing.
 # Fix plock when source missing or cannot set owner/group.
 #
 # Revision 1.5  2007/01/11 19:59:40  customdesigned
 # Purge old entries in auto_whitelist and send_dsn logs.
 #
 # Revision 1.4  2007/01/11 04:31:26  customdesigned
 # Negative feedback for bad headers.  Purge cache logs on startup.
 #
 # Revision 1.3  2007/01/08 23:20:54  customdesigned
 # Get user feedback.
 #
 # Revision 1.2  2007/01/05 23:33:55  customdesigned
 # Make blacklist an AddrCache
 #
 # Revision 1.1  2007/01/05 21:25:40  customdesigned
 # Move AddrCache to Milter package.
 #
 # Author: Stuart D. Gathman <stuart@bmsi.com>
 # Copyright 2001,2002,2003,2004,2005 Business Management Systems, Inc.
 # This code is under the GNU General Public License.  See COPYING for details.
 import time
 from plock import PLock
 class AddrCache(object):
  time_format = '%Y%b%d %H:%M:%S %Z'
  def __init__(self,renew=7,fname=None):
    self.age = renew
    self.cache = {}
    self.fname = fname
  def load(self,fname,age=0):
    "Load address cache from persistent store."
    if not age:
      age = self.age
    self.fname = fname
    cache = {}
    self.cache = cache
    now = time.time()
    lock = PLock(self.fname)
    wfp = lock.lock()
    changed = False
    try:
      too_old = now - age*24*60*60	# max age in days
      try:
        fp = open(self.fname)
      except OSError:
        fp = ()
      for ln in fp:
 	try:
 	  rcpt,ts = ln.strip().split(None,1)
          try:
            l = time.strptime(ts,AddrCache.time_format)
            t = time.mktime(l)
            if t < too_old:
              changed = True
              continue
            cache[rcpt.lower()] = (t,None)
          except:       # unparsable timestamp - likely garbage
            changed = True
            continue
 	except: # manual entry (no timestamp)
 	  cache[ln.strip().lower()] = (now,None)
 	wfp.write(ln)
      if changed:
 	lock.commit(self.fname+'.old')
      else:
        lock.unlock()
    except IOError:
      lock.unlock()
  def has_precise_key(self,sender):
    """True if precise sender is cached and has not expired.  Don't
    try looking up wildcard entries.
    """
    try:
      lsender = sender and sender.lower()
      ts,res = self.cache[lsender]
      too_old = time.time() - self.age*24*60*60	# max age in days
      if not ts or ts > too_old:
        return True
      del self.cache[lsender]
    except KeyError: pass
    return False
  def has_key(self,sender):
    "True if sender is cached and has not expired."
    if self.has_precise_key(sender):
      return True
    try:
      user,host = sender.split('@',1)
      return self.has_precise_key(host)
    except: pass
    return False
  __contains__ = has_key
  def __getitem__(self,sender):
    try:
      lsender = sender.lower()
      ts,res = self.cache[lsender]
      too_old = time.time() - self.age*24*60*60	# max age in days
      if not ts or ts > too_old:
 	return res
      del self.cache[lsender]
      raise KeyError, sender
    except KeyError,x:
      try:
 	user,host = sender.split('@',1)
 	return self.__getitem__(host)
      except ValueError:
        raise x
  def addperm(self,sender,res=None):
    "Add a permanent sender."
    lsender = sender.lower()
    if self.has_key(lsender):
      ts,res = self.cache[lsender]
      if not ts: return		# already permanent
    self.cache[lsender] = (None,res)
    if not res:
      print >>open(self.fname,'a'),sender
  def __setitem__(self,sender,res):
    lsender = sender.lower()
    now = time.time()
    self.cache[lsender] = (now,res)
    if not res and self.fname:
      s = time.strftime(AddrCache.time_format,time.localtime(now))
      print >>open(self.fname,'a'),sender,s # log refreshed senders
  def __len__(self):
    return len(self.cache)
@@ -0,0 +1,64 @@
 from ConfigParser import ConfigParser
 class MilterConfigParser(ConfigParser):
  def __init__(self,defaults={}):
    ConfigParser.__init__(self)
    self.defaults = defaults
  # The defaults provided by ConfigParser show up in all sections,
  # which screws up iterating over all options in a section.
  # Worse, passing "defaults" with vars= overrides the config file!
  # So we roll our own defaults.
  def get(self,sect,opt):
    if not self.has_option(sect,opt) and opt in self.defaults:
      return self.defaults[opt]
    return ConfigParser.get(self,sect,opt)
  def getlist(self,sect,opt):
    if self.has_option(sect,opt):
      return [q.strip() for q in self.get(sect,opt).split(',')]
    return []
  def getaddrset(self,sect,opt):
    if not self.has_option(sect,opt):
      return {}
    s = self.get(sect,opt)
    d = {}
    for q in s.split(','):
      q = q.strip()
      if q.startswith('file:'):
        domain = q[5:].lower()
 	d[domain] = d.setdefault(domain,[]) + open(domain,'r').read().split()
      else:
 	user,domain = q.split('@')
 	d.setdefault(domain.lower(),[]).append(user)
    return d
  def getaddrdict(self,sect,opt):
    if not self.has_option(sect,opt):
      return {}
    d = {}
    for q in self.get(sect,opt).split(','):
      q = q.strip()
      if self.has_option(sect,q):
        l = self.get(sect,q)
 	for addr in l.split(','):
 	  addr = addr.strip()
 	  if addr.startswith('file:'):
 	    fname = addr[5:]
 	    for a in open(fname,'r').read().split():
 	      d[a] = q
 	  else:
 	    d[addr] = q
    return d
  def getdefault(self,sect,opt,default=None):
    if self.has_option(sect,opt):
      return self.get(sect,opt)
    return default
  def getintdefault(self,sect,opt,default=None):
    if self.has_option(sect,opt):
      return self.getint(sect,opt)
    return default
@@ -0,0 +1,90 @@
 # provide a higher level interface to pydns
 import DNS
 from DNS import DNSError
 MAX_CNAME = 10
 def DNSLookup(name, qtype):
    try:
        req = DNS.DnsRequest(name, qtype=qtype)
        resp = req.req()
        #resp.show()
        # key k: ('wayforward.net', 'A'), value v
        # FIXME: pydns returns AAAA RR as 16 byte binary string, but
        # A RR as dotted quad.  For consistency, this driver should
        # return both as binary string.
        return [((a['name'], a['typename']), a['data']) for a in resp.answers]
    except IOError, x:
        raise DNSError, str(x)
 class Session(object):
  """A Session object has a simple cache with no TTL that is valid
   for a single "session", for example an SMTP conversation."""
  def __init__(self):
    self.cache = {}
  # We have to be careful which additional DNS RRs we cache.  For
  # instance, PTR records are controlled by the connecting IP, and they
  # could poison our local cache with bogus A and MX records.  
  SAFE2CACHE = {
    ('MX','A'): None,
    ('MX','MX'): None,
    ('CNAME','A'): None,
    ('CNAME','CNAME'): None,
    ('A','A'): None,
    ('AAAA','AAAA'): None,
    ('PTR','PTR'): None,
    ('NS','NS'): None,
    ('NS','A'): None,
    ('TXT','TXT'): None,
    ('SPF','SPF'): None
  }
  def dns(self, name, qtype, cnames=None):
    """DNS query.
    If the result is in cache, return that.  Otherwise pull the
    result from DNS, and cache ALL answers, so additional info
    is available for further queries later.
    CNAMEs are followed.
    If there is no data, [] is returned.
    pre: qtype in ['A', 'AAAA', 'MX', 'PTR', 'TXT', 'SPF']
    post: isinstance(__return__, types.ListType)
    """
    result = self.cache.get( (name, qtype) )
    cname = None
    if not result:
        safe2cache = Session.SAFE2CACHE
        for k, v in DNSLookup(name, qtype):
            if k == (name, 'CNAME'):
                cname = v
            if (qtype,k[1]) in safe2cache:
                self.cache.setdefault(k, []).append(v)
        result = self.cache.get( (name, qtype), [])
    if not result and cname:
        if not cnames:
            cnames = {}
        elif len(cnames) >= MAX_CNAME:
            #return result    # if too many == NX_DOMAIN
            raise DNSError('Length of CNAME chain exceeds %d' % MAX_CNAME)
        cnames[name] = cname
        if cname in cnames:
            raise DNSError, 'CNAME loop'
        result = self.dns(cname, qtype, cnames=cnames)
    return result
 DNS.DiscoverNameServers()
 if __name__ == '__main__':
  import sys
  s = Session()
  for n,t in zip(*[iter(sys.argv[1:])]*2):
    print n,t
    print s.dns(n,t)
@@ -0,0 +1,167 @@
 # Author: Stuart D. Gathman <stuart@bmsi.com>
 # Copyright 2005 Business Management Systems, Inc.
 # This code is under the GNU General Public License.  See COPYING for details.
 # Send DSNs, do call back verification,
 # and generate DSN messages from a template
 # $Log$
 # Revision 1.15  2007/09/24 20:13:26  customdesigned
 # Remove explicit spf dependency.
 #
 # Revision 1.14  2007/03/03 18:19:40  customdesigned
 # Handle DNS error sending DSN.
 #
 # Revision 1.13  2007/01/04 18:01:11  customdesigned
 # Do plain CBV when template missing.
 #
 # Revision 1.12  2006/07/26 16:37:35  customdesigned
 # Support timeout.
 #
 # Revision 1.11  2006/06/21 21:07:11  customdesigned
 # Include header fields in DSN template.
 #
 # Revision 1.10  2006/05/24 20:56:35  customdesigned
 # Remove default templates.  Scrub test.
 #
 import smtplib
 import socket
 from email.Message import Message
 import Milter
 import time
 import dns
 def send_dsn(mailfrom,receiver,msg=None,timeout=600,session=None):
  """Send DSN.  If msg is None, do callback verification.
     Mailfrom is original sender we are sending DSN or CBV to.
     Receiver is the MTA sending the DSN.
     Return None for success or (code,msg) for failure."""
  user,domain = mailfrom.split('@')
  if not session: session = dns.Session()
  try:
    mxlist = session.dns(domain,'MX')
  except dns.DNSError:
    return (450,'DNS Timeout: %s MX'%domain)	# temp error
  if not mxlist:
    mxlist = (0,domain),	# fallback to A record when no MX
  else:
    mxlist.sort()
  smtp = smtplib.SMTP()
  toolate = time.time() + timeout
  for prior,host in mxlist:
    try:
      smtp.connect(host)
      code,resp = smtp.helo(receiver)
      # some wiley spammers have MX records that resolve to 127.0.0.1
      a = resp.split()
      if not a:
        return (553,'MX for %s has no hostname in banner: %s' % (domain,host))
      if a[0] == receiver:
        return (553,'Fraudulent MX for %s: %s' % (domain,host))
      if not (200 <= code <= 299):
 	raise smtplib.SMTPHeloError(code, resp)
      if msg:
        try:
 	  smtp.sendmail('<>',mailfrom,msg)
 	except smtplib.SMTPSenderRefused:
 	  # does not accept DSN, try postmaster (at the risk of mail loops)
 	  smtp.sendmail('<postmaster@%s>'%receiver,mailfrom,msg)
      else:	# CBV
 	code,resp = smtp.docmd('MAIL FROM: <>')
 	if code != 250:
 	  raise smtplib.SMTPSenderRefused(code, resp, '<>')
 	code,resp = smtp.rcpt(mailfrom)
 	if code not in (250,251):
 	  return (code,resp)		# permanent error
 	smtp.quit()
      return None			# success
    except smtplib.SMTPRecipientsRefused,x:
      return x.recipients[mailfrom]	# permanent error
    except smtplib.SMTPSenderRefused,x:
      return x.args[:2]			# does not accept DSN
    except smtplib.SMTPDataError,x:
      return x.args			# permanent error
    except smtplib.SMTPException:
      pass		# any other error, try next MX
    except socket.error:
      pass		# MX didn't accept connections, try next one
    except socket.timeout:
      pass		# MX too slow, try next one
    smtp.close()
    if time.time() > toolate:
      return (450,'No MX response within %f minutes'%(timeout/60.0))
  return (450,'No MX servers available')	# temp error
 class Vars: pass
 # NOTE: Caller can pass an object to create_msg that in a typical milter
 # collects things like heloname or sender anyway.
 def create_msg(v,rcptlist=None,origmsg=None,template=None):
  """Create a DSN message from a template.  Template must be '\n' separated.
     v - an object whose attributes are used for substitutions.  Must
       have sender and receiver attributes at a minimum.
     rcptlist - used to set v.rcpt if given
     origmsg - used to set v.subject and v.spf_result if given
     template - a '\n' separated string with python '%(name)s' substitutions.
  """
  if not template:
    return None
  if hasattr(v,'perm_error'):
    # likely to be an spf.query, try translating for backward compatibility
    q = v
    v = Vars()
    try:
      v.heloname = q.h
      v.sender = q.s
      v.connectip = q.i
      v.receiver = q.r
      v.sender_domain = q.o
      v.result = q.result
      v.perm_error = q.perm_error
    except: v = q
  if rcptlist:
    v.rcpt = '\n\t'.join(rcptlist)
  if origmsg:
    try: v.subject = origmsg['Subject']
    except: v.subject = '(none)'
    try:
      v.spf_result = origmsg['Received-SPF']
    except: v.spf_result = None
  msg = Message()
  msg.add_header('X-Mailer','PyMilter-'+Milter.__version__)
  msg.set_type('text/plain')
  hdrs,body = template.split('\n\n',1)
  for ln in hdrs.splitlines():
    name,val = ln.split(':',1)
    msg.add_header(name,(val % v.__dict__).strip())
  msg.set_payload(body % v.__dict__)
  # add headers if missing from old template
  if 'to' not in msg:
    msg.add_header('To',v.sender)
  if 'from' not in msg:
    msg.add_header('From','postmaster@%s'%v.receiver)
  if 'auto-submitted' not in msg:
    msg.add_header('Auto-Submitted','auto-generated')
  return msg
 if __name__ == '__main__':
  import spf
  q = spf.query('192.168.9.50',
  'SRS0=pmeHL=RH==stuart@example.com',
  'red.example.com',receiver='mail.example.com')
  q.result = 'softfail'
  q.perm_error = None
  msg = create_msg(q,['charlie@example.com'],None,
 """From: postmaster@%(receiver)s
 To: %(sender)s
 Subject: Test
 Test DSN template
 """
  )
  print msg.as_string()
  # print send_dsn(f,msg.as_string())
  # print send_dsn(q.s,'mail.example.com',msg.as_string())
@@ -0,0 +1,95 @@
 # Author: Stuart D. Gathman <stuart@bmsi.com>
 # Copyright 2005 Business Management Systems, Inc.
 # This code is under the GNU General Public License.  See COPYING for details.
 # Heuristically determine whether a domain name is for a dynamic IP.
 # examples we don't yet recognize:
 #
 # wiley-268-8196.roadrunner.nf.net at ('205.251.174.46', 4810)
 # cbl-sd-02-79.aster.com.do at ('200.88.62.79', 4153)
 import re
 ip3 = re.compile('[0-9]{1,3}')
 hpats = (
 'h[0-9a-f]{12}[.]',
 'h\d*n\d*c\d*o\d*\.',
 'pcp\d{6,10}pcs[.]',
 'no-reverse',
 'S[0-9a-f]{16}[.][a-z]{2}[.]',
 'user<3>\.',
 '[Cc]ust<3>\.',
 '^<3>\.',
 'ppp[^.]*<3>\.',
 '-ppp\d*\.',
 '\d*-<3>\.',
 '[0-9a-f]{1,3}-<3>\.',
 'p<3>\.pool',
 'h<3>\.',
 'xdsl-\d*\.',
 '-\d*-\d*\.',
 '\.adsl\.',
 '\.cable\.'
 )
 rehmac = re.compile('|'.join(hpats))
 def is_dynip(host,addr):
  """Return True if hostname is for a dynamic ip.
  Examples:
  >>> is_dynip('post3.fabulousdealz.com','69.60.99.112')
  False
  >>> is_dynip('adsl-69-208-201-177.dsl.emhril.ameritech.net','69.208.201.177')
  True
  >>> is_dynip('[1.2.3.4]','1.2.3.4')
  True
  >>> is_dynip('c-71-63-151-151.hsd1.mn.comcast.net','71.63.151.151')
  True
  """
  if host.startswith('[') and host.endswith(']'):
    return True
  if addr:
    if host.find(addr) >= 0: return True
    a = addr.split('.')
    ia = map(int,a)
    h = host
    m = ip3.findall(host)
    if m:
      g = map(int,m)[:4]
      ia3 = (ia[1:],ia[:3])
      if g[-3:] in ia3: return True
      if g[0] == ia[3] and g[1:3] == ia[:2]: return True
      if g[-2:] == ia[2:]: return True
      g.reverse()
      if g[:3] in ia3: return True
      if g[:2] == ia[2:]: return True
      if ia[2:] in (g[:2],g[-2:]): return True
      for m in ip3.finditer(host):
        if int(m.group()) == ia[3]:
 	  h = host[:m.start()] + '<3>' + host[m.end():]
 	  break
    if rehmac.search(h): return True
    if host.find(''.join(a[:3])) >= 0: return True
    if host.find(''.join(a[1:])) >= 0: return True
    x = "%02x%02x%02x%02x" % tuple(ia)
    if host.lower().find(x) >= 0: return True
  return False
 if __name__ == '__main__':
  import fileinput
  import sets
  seen = sets.Set()
  for ln in fileinput.input():
    a = ln.split()
    if a[3:5] == ['connect','from']:
      host = a[5]
      if host.startswith('[') and host.endswith(']'):
 	continue	# no PTR
      ip = a[7][2:-2]
      if ip in seen: continue
      seen.add(ip)
      if is_dynip(host,ip):
        print '%s\t%s DYN' % (ip,host)
      else:
        print '%s\t%s' % (ip,host)
@@ -0,0 +1,74 @@
 import time
 import shelve
 import thread
 import logging
 import urllib
 log = logging.getLogger('milter.greylist')
 def quoteAddress(s):
  '''Quote an address so that it's safe to store in the file-system.
  Address can either be a domain name, or local part.
  Returns the quoted address.'''
  s = urllib.quote(s, '@_-+~!.%')
  if s.startswith('.'): s = '%2e' + s[1:]
  return s
 class Record(object):
  __slots__ = ( 'firstseen', 'lastseen', 'umis', 'cnt' )
  def __init__(self):
    now = time.time()
    self.firstseen = now
    self.lastseen = now
    self.cnt = 0
    self.umis = None
 class Greylist(object):
  def __init__(self,dbname,grey_time=10,grey_expire=4,grey_retain=36):
    self.ignoreLastByte = False
    self.greylist_time = grey_time * 60         # minutes
    self.greylist_expire = grey_expire * 3600   # hours
    self.greylist_retain = grey_retain * 24 * 3600   # days
    self.dbp = shelve.open(dbname,'c',protocol=2)
    self.lock = thread.allocate_lock()
  def check(self,ip,sender,recipient):
    "Return number of allowed messages for greylist triple."
    sender = quoteAddress(sender)
    recipient = quoteAddress(recipient)
    key = ip + ':' + sender + ':' + recipient
    self.lock.acquire()
    try:
      dbp = self.dbp
      try:
        r = dbp[key]
        now = time.time()
        if now > r.lastseen + self.greylist_retain:
          # expired
          log.debug('Expired greylist: %s',key)
          r = Record()
        elif now < r.firstseen + self.greylist_time:
          # still greylisted
          log.debug('Early greylist: %s',key)
          #r = Record()
          r.lastseen = now
        elif r.cnt or now < r.firstseen + self.greylist_expire:
          # in greylist window or active
          r.lastseen = now
          r.cnt += 1
          log.debug('Active greylist(%d): %s',r.cnt,key)
        else:
          # passed greylist window
          log.debug('Late greylist: %s',key)
          r = Record()
        dbp[key] = r
      except:
        r = Record()
        dbp[key] = r
      dbp.sync()
    finally:
      self.lock.release()
    return r.cnt
@@ -0,0 +1,66 @@
 # Author: Stuart D. Gathman <stuart@bmsi.com>
 # Copyright 2001 Business Management Systems, Inc.
 # This code is under the GNU General Public License.  See COPYING for details.
 import os
 from time import sleep
 class PLock(object):
  "A simple /etc/passwd style lock,update,rename protocol for updating files."
  def __init__(self,basename):
    self.basename = basename
    self.fp = None
  def lock(self,lockname=None,mode=0660,strict_perms=False):
    "Start an update transaction.  Return FILE to write new version."
    self.unlock()
    if not lockname:
      lockname = self.basename + '.lock'
    self.lockname = lockname
    try:
      st = os.stat(self.basename)
      mode |= st.st_mode
    except OSError: pass
    u = os.umask(0002)
    try:
      fd = os.open(lockname,os.O_WRONLY+os.O_CREAT+os.O_EXCL,mode)
    finally:
      os.umask(u)
    self.fp = os.fdopen(fd,'w')
    try:
      os.chown(self.lockname,-1,st.st_gid)
    except:
      if strict_perms:
 	self.unlock()
 	raise
    return self.fp
  def wlock(self,lockname=None):
    "Wait until lock is free, then start an update transaction."
    while True:
      try:
        return self.lock(lockname)
      except OSError:
        sleep(2)
  def commit(self,backname=None):
    "Commit update transaction with optional backup file."
    if not self.fp:
      raise IOError,"File not locked"
    self.fp.close()
    self.fp = None
    if backname:
      try:
 	os.remove(backname)
      except OSError: pass
      os.link(self.basename,backname)
    os.rename(self.lockname,self.basename)
  def unlock(self):
    "Cancel update transaction."
    if self.fp:
      try:
        self.fp.close()
      except: pass
      self.fp = None
      os.remove(self.lockname)
@@ -0,0 +1,17 @@
 # Author: Stuart D. Gathman <stuart@bmsi.com>
 # Copyright 2005 Business Management Systems, Inc.
 # This code is under the GNU General Public License.  See COPYING for details.
 # The localpart of SMTP return addresses is often signed.  The format
 # of the signing is application specific and doesn't concern us -
 # except that we wish to extract some sort of fixed string from
 # the variable signature which represents the "source" of the message.
 def unsign(s):
  """Attempt to unsign localpart and return original email.
  No attempt is made to verify the signature.
  >>> unsign('SRS0=8Y3CZ=3U=jsconnor.com=bills@bmsi.com')
  'bills@jsconnor.com'
  """
  # not implemented yet
  return s
@@ -0,0 +1,125 @@
 import re
 import struct
 import socket
 import email.Errors
 from fnmatch import fnmatchcase
 from email.Header import decode_header
 #import email.Utils
 import rfc822
 ip4re = re.compile(r'^[0-9]*\.[0-9]*\.[0-9]*\.[0-9]*$')
 # from spf.py
 def addr2bin(str):
  "Convert a string IPv4 address into an unsigned integer."
  return struct.unpack("!L", socket.inet_aton(str))[0]
 MASK = 0xFFFFFFFFL
 def cidr(i,n):
  return ~(MASK >> n) & MASK & i
 def iniplist(ipaddr,iplist):
  """Return whether ip is in cidr list
  >>> iniplist('66.179.26.146',['127.0.0.1','66.179.26.128/26'])
  True
  >>> iniplist('127.0.0.1',['127.0.0.1','66.179.26.128/26'])
  True
  >>> iniplist('192.168.0.45',['192.168.0.*'])
  True
  """
  ipnum = addr2bin(ipaddr)
  for pat in iplist:
    p = pat.split('/',1)
    if ip4re.match(p[0]):
      if len(p) > 1:
 	n = int(p[1])
      else:
        n = 32
      if cidr(addr2bin(p[0]),n) == cidr(ipnum,n):
        return True
    elif fnmatchcase(ipaddr,pat):
      return True
  return False
 def parseaddr(t):
  """Split email into Fullname and address.
  >>> parseaddr('user@example.com')
  ('', 'user@example.com')
  >>> parseaddr('"Full Name" <foo@example.com>')
  ('Full Name', 'foo@example.com')
  >>> parseaddr('spam@spammer.com <foo@example.com>')
  ('spam@spammer.com', 'foo@example.com')
  >>> parseaddr('God@heaven <@hop1.org,@hop2.net:jeff@spec.org>')
  ('God@heaven', 'jeff@spec.org')
  >>> parseaddr('Real Name ((comment)) <addr...@example.com>')
  ('Real Name', 'addr...@example.com')
  >>> parseaddr('a(WRONG)@b')
  ('WRONG', 'a@b')
  """
  #return email.Utils.parseaddr(t)
  res = rfc822.parseaddr(t)
  # dirty fix for some broken cases
  if not res[0]:
    pos = t.find('<')
    if pos > 0 and t[-1] == '>':
      addrspec = t[pos+1:-1]
      pos1 = addrspec.rfind(':')
      if pos1 > 0:
        addrspec = addrspec[pos1+1:]
      return rfc822.parseaddr('"%s" <%s>' % (t[:pos].strip(),addrspec))
  if not res[1]:
    pos = t.find('<')
    if pos > 0 and t[-1] == '>':
      addrspec = t[pos+1:-1]
      pos1 = addrspec.rfind(':')
      if pos1 > 0:
        addrspec = addrspec[pos1+1:]
      return rfc822.parseaddr('%s<%s>' % (t[:pos].strip(),addrspec))
  return res
 def parse_addr(t):
  """Split email into user,domain.
  >>> parse_addr('user@example.com')
  ['user', 'example.com']
  >>> parse_addr('"user@example.com"')
  ['user@example.com']
  >>> parse_addr('"user@bar"@example.com')
  ['user@bar', 'example.com']
  >>> parse_addr('foo')
  ['foo']
  """
  if t.startswith('<') and t.endswith('>'): t = t[1:-1]
  if t.startswith('"'):
    if t.endswith('"'): return [t[1:-1]]
    pos = t.find('"@')
    if pos > 0: return [t[1:pos],t[pos+2:]]
  return t.split('@')
 def parse_header(val):
  """Decode headers gratuitously encoded to hide the content.
  """
  try:
    h = decode_header(val)
    if not len(h) or (not h[0][1] and len(h) == 1): return val
    u = []
    for s,enc in h:
      if enc:
        try:
 	  u.append(unicode(s,enc))
 	except LookupError:
 	  u.append(unicode(s))
      else:
 	u.append(unicode(s))
    u = ''.join(u)
    for enc in ('us-ascii','iso-8859-1','utf8'):
      try:
 	return u.encode(enc)
      except UnicodeError: continue
  except UnicodeDecodeError: pass
  except LookupError: pass
  except email.Errors.HeaderParseError: pass
  return val
@@ -1,5 +1,87 @@
-Here is a history of user visible changes to Python milter.
+See pymilter.spec for recent history.
 Here is a history of older changes to Python milter.
 0.8.8	move AddrCache, parse_addr, iniplist, parse_header to Milter package
 	fix plock for missing source and can't change owner/group
 	add sample spfmilter.py milter
 	private_relay config option
 0.8.7	Move spf module to pyspf
 	Prevent PTR cache poisoning
 	More lame bounce heuristics
 	Do plain CBV when template is missing
 0.8.6	Support CBV timeout
 	Support fail template, headers in templates
 	Create GOSSiP record only when connection will procede to DATA.
 	More SPF lax heuristics
 	Don't require SPF pass for white/black listing mail from trusted relay.
 	Support localpart wildcard for white and black lists.
 	Delay reject of unsigned RCPT for postmaster and abuse only
 	Fix dsn reporting of hard permerror
 	Resolve FIXME for wrap_close in miltermodule.c
 	Add Message-ID to DSNs
 	Use signed Message-ID in delayed reject to blacklist senders
 	Auto-train via blacklist and auto-whitelist
 	Don't check userlist for signed MFROM
 	Accept but skip DSPAM training for whitelisted senders without SPF PASS
 	Report GC stats 
 	Support CIDR matching for IP lists
 	Support pysrs sign feature
 	Support localpart specific SPF policy in access file
 0.8.5	Simple trusted_forwarder implementation.
 	Fix access_file neutral policy
 	Move Received-SPF header to beginning of headers
 	Supply keyword info for all results in Received-SPF header.
 	Move guessed SPF result to separate header
 	Activate smfi_insheader only when SMFIR_INSHEADER defined
 	Handle NULL MX in spf.py
 	in-process GOSSiP server support (to be extended later)
 	Expire CBV cache and renew auto-whitelist entries
 0.8.4	Auto-whitelist recipients of outgoing email.
 	Fix SPF policy via sendmail access map (case insensitive keys).
 	Train screener on whitelisted messages
 	Optional idx parameter to addheader to invoke smfi_insheader
 	Activate progress API when SMFIR_PROGRESS defined
 0.8.3   Keep screened honeypot mail, but optionally discard honeypot only mail.
 	spf_accept_fail option for braindead SPF senders 
 	  (treats fail like softfail)
 	Option to set SPF policy via sendmail access map.
 	Option to supply Sender header from MAIL FROM when missing.
 	Consider SMTP AUTH connections internal.
 	Send DSN for SPF errors corrected by extended processing.
 	Send DSN before SCREENED mail is quarantined
 	Use logging package to keep log lines atomic.
 0.8.2	Strict processing limits per SPF RFC
 	Fixed several parsing bugs under RFC 
 	Support official IANA SPF record (type99)
 	Honeypot support (requires pydspam-1.1.9)
 	Extended SPF processing results beyond strict RFC limits
 	Support original SES for bounce protection (requires pysrs-0.30.10)
 	Callback exception processing option in milter module
 	Handle corrupt ZIP attachments
 0.8.1	Fix zip in zip loop in mime.py
 	Fix HeaderParseError in bms.py header callback
 	Check internal_domains for outgoing mail
 	Fix inconsistent results from send_dsn
 0.8.0	Move Milter module to subpackage.
 	DSN support for Three strikes rule and SPF SOFTFAIL
 	Move /*mime*/ and dynip to Milter subpackage
 	Fix SPF unknown mechanism list not cleared
 	Make banned extensions configurable.
 	Option to scan zipfiles for bad extensions.
 	Properly log pydspam exceptions
 0.7.3	Experimental release with python2.4 support
 0.7.2	Return unknown for invalid ip address in mechanism
 	Recognize dynamic PTR names, and don't count them as authentication.
 	Three strikes and yer out rule.
 	Block softfail by default when no PTR or HELO
 	Return unknown for null mechanism
 	Try best guess on HELO also
 	Expand setreply for common errors
 	make rhsbl.m4 hack available for sendmail.mc
 0.7.1	Handle modifying mislabeled multipart messages without an exception
 	Support setbacklog, setmlreply
 	Allow multi-recipient CBV
 	Return TEMPFAIL for SPF softfail
 0.7.0	SPF check hello name
 	Move pythonsock to /var/run/milter
 	Move milter.cfg to /etc/mail/pymilter.cfg
@@ -42,7 +42,7 @@ Quick Installation
 1. Build and install Sendmail, enabling libmilter (see libmilter/README).
 2. Build and install Python, enabling threading.
 3. Install this module: python setup.py --help
-4. Add these two lines to sendmail.cf:
+4. Add these two lines to sendmail.cf[*]:
 O InputMailFilters=pythonfilter
 Xpythonfilter,        S=local:/home/username/pythonsock
@@ -51,9 +51,17 @@ Xpythonfilter,        S=local:/home/username/pythonsock
 Note that milters should almost certainly not run as root.
 That's it.  Incoming mail will cause the milter to print some things, and
-some email will be rejected (see the "header" method).  Edit and play.  See
+some email will be rejected (see the "header" method).  Edit and play.  
-bms.py for an example milter used in production.
+See spfmilter.py for a functional SPF milter, or see bms.py for an complex
 milter used in production.
 [*] This is for a quick test.  Your sendmail.cf in most distros will get
 overwritten whenever sendmail.mc is updated.  To make a milter permanent,
 add something like:
 INPUT_MAIL_FILTER(`pythonfilter', `S=local:/home/username/pythonsock, F=T, T=C:5m;S:20s;R:5m;E:5m')
 to sendmail.mc instead.
 Not-so-quick Installation
 -------------------------
@@ -90,9 +98,10 @@ some options associated with it.  In this case, we have the "S" option, which
 names the socket that sendmail will use to communicate with this particular
 milter.  This milter's socket is a unix-domain socket in the filesystem.
 See libmilter/README for the definitive list of options.
 NB: The name is specified in two places: here, in sendmail's cf file, and
 in the milter itself.  Make sure the two match.
-NB: OpenBSD must use an inet socket.  See the web page for details.
+
 NB: The above lines can be added in your .mc file with this line:
 INPUT_MAIL_FILTER(`pythonfilter', `S=local:/home/username/pythonsock')
@@ -124,16 +133,6 @@ and headers at
 http://www.bmsi.com/linux/sendmail-rh72.spec
 OpenBSD Notes
 -------------
 Sendmail is broken on OpenBSD for unix domain sockets.  You must use an
 inet socket for milter.  The sendmail.cf 'X' config line would look like:
 Xpythonfilter,        S=inet:1234@localhost
 and the sample milter needs to be modified accordingly.
 IPv6 Notes
 ----------
@@ -1,65 +1,6 @@
-Message not saved for following traceback:
+Support smfi_negotiate and auto negotiate only those callbacks for which 
-Traceback (most recent call last):
+Milter.Milter methods have been overridden.  (Python should be able to
-  File "/usr/lib/python2.3/site-packages/Milter.py", line 188, in <lambda>
+do that.)
    milter.set_eom_callback(lambda ctx: ctx.getpriv().eom())
  File "bms.py", line 935, in eom
    msg.dump(out)
  File "/usr/lib/python2.3/site-packages/mime.py", line 347, in dump
    g.flatten(self,unixfrom=unixfrom)
  File "/var/tmp/python2.3-2.3.3-root/usr/lib/python2.3/email/Generator.py", line 102, in flatten
  File "/var/tmp/python2.3-2.3.3-root/usr/lib/python2.3/email/Generator.py", line 130, in _write
  File "/var/tmp/python2.3-2.3.3-root/usr/lib/python2.3/email/Generator.py", line 156, in _dispatch
  File "/var/tmp/python2.3-2.3.3-root/usr/lib/python2.3/email/Generator.py", line 199, in _handle_text
 TypeError: string payload expected: <type 'list'>
 ------------
 spf.py has no recursion bound on CNAME lookup
 Support SMTP AUTH and disable SPF checks when connection is authorized.
 Web admin interface
 RHSBL
 Check valid domains allowed by internal senders to detect PCs infected
 with spam trojans.
 Do CBV (callback verification) for mail with no published SPF record.
 message log for automated stats and blacklisting
 Skip dspam when SPF pass?
 Report 551 with rcpt on SPF fail?
 check spam keywords with character classes, e.g.
 	{a}=[a@ãä], {i}=[i1í], {e}=[eë], {o}=[o0ö]
-Implement RRS - a backdoor for non-SRS forwarders.  User lists non-SRS 
+Lookup exact RFC syntax of real name / email and make 
-forwarder accounts, and a util provides a special local alias for the
+Milter.utils.parse_addr() pass all unit tests.
 user to give to the forwarder.  Alias only works for mail from that
 forwarder.  Milter gets forwarder domain from alias and uses it to
 SPF check forwarder.
 Another special dspam user, 'honeypot', can be listed in innoculations.
 All email to those addresses is treated as known spam.
 Framework for modular Python milter components within a single VM.
 Python milters can be already be composed through sendmail by running each in
 a separate process.  However, a significant amount of memory is wasted
 for each additional Python VM, and communication between milters
 is cumbersome (e.g., adding mail headers, writing external files).
 Backup copies for outgoing/incoming mail.
 Allow multiple wiretap groups, each with its own destination.  Perhaps 
 also copy incoming wiretap mail, even though sendmail alias works perfectly
 for the purpose, to avoid having to change two configs for a wiretap.
 Provide a way to reload milter.cfg without stopping/restarting milter.
 Allow selected Windows extensions for specific domains via milter.cfg
 Fix setup.py so that _FFR_QUARANTINE is automatically defined when
 available in libmilter.
 Keep separate ismodified flag for headers and body.  This is important
 when rejecting outgoing mail with viruses removed (so as not to
 embarrass yourself), and also removing Received headers with hidepath.
 Wrap smfi_setbacklog(int) - but it is only available in sendmail >= 8.12.3,
  so how can we detect whether to wrap it?
 Need a test module to feed sample messages to a milter though a live 
 sendmail and SMTP.  The mockup currently used is probably not very accurate,
 and doesn't test the threading code.
@@ -1,153 +0,0 @@
 #!/usr/bin/python2.3
 # Convert a MS Caller-ID entry (XML) to a SPF entry
 #
 # (c) 2004 by Ernesto Baschny
 # (c) 2004 Python version by Stuart Gathman
 #
 # Date: 2004-02-25
 # Version: 1.0
 #
 # Usage:
 #  ./cid2spf.pl "<ep xmlns='http://ms.net/1'>...</ep>"
 #
 # Note that the 'include' directives will also have to be checked and
 # "translated". Future versions of this script might be able to get a
 # domain name as an argument and "crawl" the DNS for the necessary
 # information.
 #
 # A complete reverse translation (SPF -> CID) might be impossible, since
 # there are no way to handle:
 # - PTR and EXISTS mechanism 
 # - MX mechanism with an different domain as argument
 # - macros
 # 
 # References:
 # http://www.microsoft.com/mscorp/twc/privacy/spam_callerid.mspx
 # http://spf.pobox.com/
 #
 # Known bugs:
 # - Currently it won't handle the exclusions provided in the A and R
 #   tags (prefix '!'). They will show up "as-is" in the SPF record
 # - I really haven't read the MS-CID specs in-depth, so there are probably
 #   other bugs too :)
 #
 # Ernesto Baschny <ernst@baschny.de>
 #
 import xml.sax
 import spf
 # -------------------------------------------------------------------------
 class CIDParser(xml.sax.ContentHandler):
  "Convert a MS Caller-ID entry (XML) to a SPF entry"
  def __init__(self,q=None):
    self.spf = []
    self.action = '-all'
    self.has_servers = None
    self.spf_entry = None
    if q:
      self.spf_query = q
    else:
      self.spf_query = spf.query(i='127.0.0.1', s='localhost', h='unknown')
  def startElement(self,tag,attr):
      if tag == 'm':
 	if self.has_servers != None and not self.has_servers:
 	  raise ValueError(
    "Declared <noMailServers\> and later <m>, this CID entry is not valid."
 	  )
 	self.has_servers = True
      elif tag == 'noMailServers':
 	if self.has_servers:
 	  raise ValueError(
    "Declared <m> and later <noMailServers\>, this CID entry is not valid."
 	  )
 	self.has_servers = False
      elif tag == 'ep':
 	if attr.has_key('testing') and attr.getValue('testing') == 'true':
 	  # A CID with 'testing' found:
 	  # From the MS-specs:
 	  #  "Documents in which such attribute is present with a true
 	  #  value SHOULD be entirely ignored (one should act as if the
 	  #  document were absent)"
 	  # From the SPF-specs:
 	  #  "Neutral (?): The SPF client MUST proceed as if a domain did
 	  #  not publish SPF data."
 	  # So we set SPF action to "neutral":
 	  self.action = '?all'
      elif tag == 'mx':
 	  # The empty MX-tag, same as SPF's MX-mechanism
 	  self.spf.append('mx')
      self.tag = tag
  def characters(self,text):
 	tag = self.tag
 	# Remove starting and trailing spaces from text:
 	text = text.strip()
 	if tag == 'a' or tag == 'r':
 	    # The A and R tags from MS-CID are both handled by the 
 	    # ipv4/6-mechanisms from SPF:
 	    if text.find(':') < 0:
 	      mechanism = 'ip4'
 	    else:
 	      mechanism = 'ip6'
 	    self.spf.append(mechanism + ':' + text)
 	elif tag == 'indirect':
 	    # MS-CID's indirect is "sort of" the include from SPF:
 	    # Not really true, because the <indirect> tag from MS-CID also 
 	    # provides a fallback in case the included domain doesn't provide
 	    # _ep-records: The inbound MX-servers of the included domains
 	    # are added to the list of allowed outgoing mailservers for the
 	    # domain that declared the _ep-record with the <indirect> tag.
 	    # In SPF you would use the 'mx:domain' to handle this, but this
 	    # wouldn't depend on referred domain having or not SPF-records.
 	    cid_xml = self.cid_txt(text)
 	    if cid_xml:
 	      p = CIDParser()
 	      xml.sax.parseString(cid_xml,p)
 	      if p.has_servers != False:
 		self.spf += p.spf
 	    else:
 	      self.spf.append('mx:' + text)
  def cid_txt(self,domain):
    q = self.spf_query
    domain='_ep.' + domain
    a = q.dns_txt(domain)
    if not a: return None
    if a[0].lower().startswith('<ep ') and a[-1].lower().endswith('</ep>'):
      return ''.join(a)
    return None
  def endElement(self,tag):
      if tag == 'ep':
 	# This is the end... assemble what we've got
 	spf_entry = ['v=spf1']
 	if self.has_servers != False:
 	  spf_entry += self.spf
 	spf_entry.append(self.action)
 	self.spf_entry = ' '.join(spf_entry)
  def spf_txt(self,cid_xml):
    if not cid_xml.startswith('<'):
      cid_xml = self.cid_txt(cid_xml)
      if not cid_xml: return None
    # Parse the beast. Any XML-problem will be reported by xlm.sax
    self.spf_entry = None
    xml.sax.parseString(cid_xml,self)
    return self.spf_entry
 if __name__ == '__main__':
  import sys
  if len(sys.argv) < 2:
    print >>sys.stderr, \
      """Usage: %s "<ep xmlns='http://ms.net/1'>...</ep>" """ % sys.argv[0]
    sys.exit(1)
  cid_xml = sys.argv[1]
  p = CIDParser()
  print p.spf_txt(cid_xml)
@@ -0,0 +1,222 @@
 Title: Recent Changes
 <h2> Recent Changes </h2>
 <h3> 0.8.10 </h3>
 SRS rejections now log the recipient.  
 I have finally implemented plain CBV (no DSN).  The CBV policy
 will do a plain CBV from now on, and the DSN policy is required
 if you want to send a DSN.
 I started checking the MAIL FROM fullname (human readable part
 of an email) for porn keywords.  There is now a banned IP database.
 IPs are banned for too many bad MAIL FROMs or RCPT TOs, and remain banned
 for 7 days.
 <h3> 0.8.9 </h3>
 I use the <code>%ifarch</code> hack to build milter and milter-spf
 packages as noarch, while pymilter is built as native.
 I removed the spf dependency from dsn.py, so pymilter can be used without
 installing pyspf, and added a Milter.dns module to let python milters do
 general DNS lookups without loading pyspf.
 <h3> 0.8.8 </h3>
 Programs do not belong in the /var/log directory.  I moved the
 milter apps to /usr/lib/pymilter.  Since having the programs and
 data in the same directory is convenient for debugging, it will
 still use an executable present in the datadir.
 Several general utility classes and functions are now in the Milter package
 for possible use by other python milters.  In addition to the trivial example
 milter, a simple SPF only milter is included as a realistic example.
 The spec file now build 3 RPMs:
 <ul>
 <li> pymilter is the milter module and Milter package for use by all python
     milters.
 <li> milter is the all-singing, all-dancing python milter application, with
     supporting <code>/etc/init.d</code>, logrotate and other scripts.
 <li> milter-spf is the simple SPF only milter application.
 </ul>
 <h3> 0.8.7 </h3>
 The spf module has been moved to the 
 <a href="http://cheeseshop.python.org/pypi/pyspf">pyspf</a> package.
 Download <a href="http://sourceforge.net/project/showfiles.php?group_id=139894&package_id=191419">here</a>.
 <h3> 0.8.6 </h3>
 Python milter has been moved to 
 <a href="http://sourceforge.net/projects/pymilter/">pymilter Sourceforge
 project</a> for development and release downloads.
 <h3> 0.8.5 </h3>
 Release 0.8.5 fixes some build bugs reported by Stephen Figgins.  It
 fixes many small things, like not auto-whitelisting recipients of
 outgoing mail when the subject contains "autoreply:".  There is a 
 simple trusted forwarder implementation.  If you have more than
 2 or so forwarders, we will need a way to "compile" SPF records into an
 IP set and TTL for it to be efficient (like libspf2 does).
 <h3> GOSSiP </h3>
 An alpha release of <a href="pygossip.html">pygossip</a> has been commited to
 CVS, module pygossip. A version of the bms.py milter has been commited to CVS
 which supports calling GOSSiP to track domain reputation in a local database.
 <h3> New website design </h3>
 Hey, I'm no artist, so I just used the
 <a href="http://ht2html.sourceforge.net/">ht2html</a> package
 by <a href="http://barry.wooz.org/">Barry Warsaw</a>.  The mascot
 is by <a href="http://alphard.ethz.ch/hafner/lebl.htm">Christian Hafner</a>,
 or maybe his wife.  I chose Maxwell's daemon because it tirelessly
 and invisibly sorts molecules, just as milters sort mail.
 Christian has also provided a fun 
 <a href="http://alphard.ethz.ch/hafner/PPS/PPS2002/Maxwell/simulation.htm">
 simulation</a> that lets you try your hand at sorting molecules.
 <h3> 0.8.4 </h3>
 Release 0.8.4 makes configuring SPF policy via access.db actually work.
 The honeypot idea is enhanced by auto-whitelisting recipients of
 email sent from selected domains.  Whitelisted messages are then used
 to train the honeypot.  This makes the honeypot screener entirely self
 training.  The smfi_progress() API is now automatically supported when present.
 An optional idx parameter to milter.addheader() invokes smfi_insheader().
 <h3> 0.8.3 </h3>
 Release 0.8.3 uses the standard logging module, and supports configuring
 more detailed SPF policy via the sendmail access map.  SMTP AUTH connections
 are considered INTERNAL.  Preventing forgery between internal domains is
 just a matter of specifying the user-domain map - I'll define something
 for the next version.  We now send DSNs when mail is quarantined (rejecting
 if DSN fails) and for SPF syntax errors (PermError).  There is an
 experimental option to add a Sender header when it is missing and the From
 domain doesn't match the MAIL FROM domain.  Next release, we may start
 renaming and replacing an existing Sender header when neither it nor the
 From domain matches MAIL FROM.  Since bogus MAIL FROMs are rejected
 (to varying degrees depending on the configured SPF policy), and
 both Sender and From and displayed by default in many email clients,
 this provides some phishing protection without rejecting mail based
 on headers.
 <h3> 0.8.2 </h3>
 Release 0.8.2 has changes to <a href="http://openspf.net">SPF</a> to bring it
 in line with the newly official RFC.  It adds 
 <a href="http://ses.codeshare.ca/">SES</a>
 support (the original SES without body hash) for pysrs-0.30.10, and honeypot
 support for pydspam-1.1.9.  There is a new method in the base milter module.
 milter.set_exception_policy(i) lets you choose a policy of CONTINUE, REJECT, or
 TEMPFAIL (default) for untrapped exceptions encountered in a milter callback.
 <h3> 0.8.0 </h3>
 Release 0.8.0 is the first <a href="http://sourceforge.net/">Sourceforge</a>
 release.  It supports Python-2.4, and provides an option to accept mail
 that gets an SPF softfail or fails the 3 strikes rule, provided the
 alleged sender accepts a DSN explaining the problem.  Python-2.3 is
 no longer supported by the reworked mime.py module, although API changes
 could be backported.  There are too many incompatible changes to the
 python email package.
 <h3> Older Releases </h3>
 Release 0.7.2 tightens the authentication screws with a "3 strikes and
 you're out" policy.  A sender must have a valid PTR, HELO, or SPF record
 to send email.  Specific senders can be whitelisted using the
 "delegate" option in the spf configuration section by adding a
 default SPF record for them.  The PTR and HELO are required
 by RFC anyway, so this is not an unreasonable requirement.
 There is now a coherent policy for an SPF softfail result.  A softfail
 is accepted if there is a valid PTR or HELO, or if the domain
 is listed in the "accept_softfail" option of the spf configuration section.
 A neutral result is accepted by default if there is a valid PTR or
 HELO, (and the SPF record was not guessed), unless the domain is listed in the
 "reject_neutral" option.  Common forms of PTR records for dynamic IPs are
 recognized, and do not count as a valid PTR.  This does not prevent anyone
 from sending mail from a dynamic IP - they just need to configure a
 valid HELO name or publish an SPF record.
 <p>
 As SPF adoption continues to rise, forged spam is not getting through.  So
 spammers are publishing their SPF records as predicted.  The 0.7.2 RPM
 now provides the <code>rhsbl</code> sendmail hack so that spammer domains
 can be blacklisted.  With the RPM installed, add a line like the following
 to your <code>sendmail.mc</code>.
 <pre>
 HACK(rhsbl,`blackholes.example.com',"550 Rejected: " $&{RHS} " has been spamming our customers.")dnl
 </pre>
 <p>
 Of course, spammers are now starting to register
 throwaway domains.  The next thing we need is a custom DNS server,
 in Python, that
 can recognize patterns.  For instance, one spammer registers ded304.com,
 ded305.com, ded306.com, etc.  We also need the custom DNS server to
 let SPF classic clients check SES (which will be part of pysrs).  
 The <a href="http://twistedmatrix.com/products/twisted">Twisted Python</a>
 framework provides a custom DNS server - but I
 would like a smaller implementation for our use.
 <p>
 The RPM for release 0.7.0 moves the config file and socket locations to
 /etc/mail and /var/run/milter respectively.  We now parse Microsoft CID records
 - but only hotmail.com uses them.  They seem to have applied for a patent on
 the brilliant idea of examining the mail headers to see who the message is
 from.  We aren't doing that here, so not to worry - but I am not a lawyer, so
 if you are worried, change spf.py around line 626 to return None instead of
 calling CIDParser().  There is a new option to reject mail with no PTR
 and no SPF.
 <p>
 Microsoft is pushing an anti-opensource license for their pending patent
 along with their sender-ID proposal before the IETF.
 It is royalty free - but requires anyone distributing a binary they've
 compiled from source to sign a license agreement.  The Apache Software
 Foundation <a
 href="http://www.apache.org/foundation/docs/sender-id-position.html"> explains
 the problem with sender-ID</a>, and Debian <a
 href="http://www.debian.org/News/2004/20040904">concurs</a>.  Since 
 the <a href="http://download.microsoft.com/download/4/3/9/439b024b-09fd-44ee-8ff0-10e834004c36/senderid_FAQ.PDF">Microsoft license</a> is
 <a href="http://www.circleid.com/article/732_0_1_0_C/">incompatible with free
 software in general</a> and the <a
 href="http://www.imc.org/ietf-mxcomp/mail-archive/msg03678.html">GPL in
 particular</a>, Python milter will not be able to implement sender-ID in its
 current form.  This was, no doubt, Microsoft's intent all along.
 <p>
 Sender-ID attempts to do for RFC2822 headers what SPF does for RFC2821 headers.
 Unlike SPF, it has never been tried, and is encumbered by a stupid patent.  I
 recommend ignoring it and continuing to implement and improve SPF until a
 working and unencumbered proposal for RFC2822 headers surfaces.
 <p>
 <a href="http://openspf.com">
 <img src="SPF.gif" align=left alt="SPF logo"></a>
 Release 0.6.6 adds support for <a href="http://openspf.com/">SPF</a>,
 a protocol to prevent forging of the envelope from address.  
 SPF support requires <a href="http://pydns.sourceforge.net/">pydns</a>.
 The included spf.py module is an updated version of the original 1.6
 version at <a href="http://www.wayforward.net/spf/">wayforward.net</a>.
 The updated version tracks the draft RFC and test suite.
 <p>
 The FAQ addresses <a href="faq.html#spf">how to get started with SPF</a>.
 <p>
 Release 0.6.1 adds a full milter based dspam application.
 <p>
 I have selected the <a href="http://www.nuclearelephant.com/projects/dspam/">
 dspam bayes filter project</a> and <a href="dspam.html">
 packaged it for python</a>.
 Release 0.6.0 offers a simple application of dspam I call "header triage",
 which rejects messages with spammy headers.  
 To use header triage, you must have <a href="dspam.html">DSPAM</a> installed,
 and select a dictionary that is well moderated by someone who gets
 lots of spam.  That dictionary can be used to block spam that is 
 obvious from the headers (e.g. X-Mailer and Subject) before it ties
 up any more resources.  I have yet to see any false positives from this
 approach (check the milter log), but if there are, the sender will
 get a REJECT with the message "Your message looks spammy."
@@ -0,0 +1,55 @@
 Title: Credits
 <h1> CREDITS </h1>
 <a href="mailto:Jim Niemira <urmane@urmane.org>">Jim Niemira</a>
 wrote the original C module and some quick
 and dirty python to use it.  
 <a href="http://gathman.org/vitae">Stuart D. Gathman</a>
 took that kludge and added threading and context objects to it, wrote a proper
 OO wrapper (Milter.py) that handles attachments, did lots of testing, packaged
 it with distutils, and generally transformed it from a quick hack to a
 real, usable Python extension.
 <h2>Other contributors (in random order):</h2>
 <dl>
 <dt> <a href="http://alphard.ethz.ch/hafner/lebl.htm">Christian Hafner</a>
  <dd>for the pymilter mascot image of 
  <a href="http://maxwelld.netfirms.com/">
  Maxwell's daemon</a>
 <dt>Stephen Figgins
  <dd>for reporting problems building with sendmail-8.12, and when
  building milter.so for the first time.
 <dt>Dave MacQuigg 
  <dd>for noticing that smfi_insheader wasn't supported, and creating
  a template to help first time pymilter users create their own milter.
 <dt>Terence Way
  <dd>for providing a Python port of SPF
 <dt>Scott Kitterman
  <dd>for doing lots of testing and debugging of SPF against draft standard,
  and for putting up a <a href="http://www.kitterman.com/spf/validate.html">
  web page that validates SPF</a> records using spf.py
 <dt>Alexander Kourakos
  <dd>for plugging several memory leaks
 <dt>George Graf at Vienna University of Economics and Business Administration
  <dd>for handling None passed to setreply and chgheader.
 <dt>Deron Meranda
  <dd>for IPv6 patches
 <dt>Jason Erikson
  <dd>for handling NULL hostaddr in connect callback.
 <dt>John Draper
  <dd>for porting Python milter to OpenBSD, and starting to work on tutorials
  then pointing out that it would be easier to just write the MTA in Python.
 <dt>Eric S. Johansson
  <dd>for helpful design discussions while working on camram
 <dt>Alex Savguira
  <dd>for finding bugs with international headers and
  suggesting the scan_zip option.
 <dt><a href="http://www.bmsi.com">Business Management Systems</a>
  <dd>for hosting the website, and providing paying clients who need milter
  service so I can work on it as part of my day job.
 </dl>
 If I have left anybody out, send me a reminder: 
 <a href="mailto:Stuart Gathman <stuart@bmsi.com>">stuart@bmsi.com</a>
@@ -0,0 +1,293 @@
 Title: Python Milter FAQ
 <h1> Python Milter <a name=faq>FAQ</a> </h1>
 <menu>
 <li> <a href="#compiling">Compiling Python Milter</a>
 <li> <a href="#running">Running Python Milter</a>
 <li> <a href="#spf">Using SPF</a>
 <li> <a href="#srs">Using SRS</a>
 </menu>
 <ol>
 <h3> <a name="compiling">Compiling Python Milter </a> </h3>
 <li> Q. I have tried to download the current milter code and my virus scan
 traps several viruses in the download.
 <p>  A. The milter source includes a number of deactivated viruses in
 the test directory.  All but the first and last lines of the base64
 encoded virus data has been removed.  I suppose I should randomize
 the first and last lines as well, since pymilter just deletes executables,
 and doesn't look for signatures.
 <li> Q. I have installed sendmail from source, but Python milter won't
 compile.
 <p>  A. Even though libmilter is officially supported in sendmail-8.12, 
 you need to build and install it in separate steps.  Take a look
 at the <a href="/aix/sendmail12.spec">RPM spec file</a> for sendmail-8.12.  
 The %prep section shows you how to create
 a site.config.m4 that enables MILTER.  The %build section shows you how
 to build libmilter in a separate invocation of make.  The %install section
 shows you how to install libmilter with a separate invocation of make.
 <p>
 <li> Q. Why is mfapi.h not found when I try to compile Python milter on
 RedHat 7.2?
 <p>  A. RedHat forgot to include the header in the RPM.  See the
 <a href="requirements.html#rh72">RedHat 7.2 requirements</a>.
 <p>
 <li> Q. Python milter compiles ok, but I get an error like this when
 	I try to import the milter module:
 <pre>
 ImportError: /usr/lib/python2.4/site-packages/milter.so: undefined symbol: smfi_setmlreply
 </pre>
 <p>  A. Your libmilter.a is from sendmail-8.12 or earlier.  You need
 	sendmail-8.13 or later to support setmlreply.  You can disable
 	setmlreply by changing setup.py.  Change:
 <pre>
            define_macros = [ ('MAX_ML_REPLY',32) ]
 </pre>
 in setup.py to
 <pre>
            define_macros = [ ('MAX_ML_REPLY',1) ]
 </pre>
 <h3> <a name="running">Running Python Milter </a></h3>
 <li> Q. The sample.py milter prints a message, then just sits there.
 <pre>
 To use this with sendmail, add the following to sendmail.cf:
 O InputMailFilters=pythonfilter
 Xpythonfilter,        S=local:inet:1030@localhost
 See the sendmail README for libmilter.
 sample  milter startup
 </pre>
 <p>  A. You need to tell sendmail to connect to your milter.  The
 sample milter tells you what to add to your sendmail.cf to tell
 sendmail to use the milter.  You can also add an INPUT_MAIL_FILTER
 macro to your sendmail.mc file and rebuild sendmail.cf - see the sendmail
 README for milters.
 <p>
 <li> Q. I've configured sendmail properly, but still nothing happens
 when I send myself mail!
 <p>  A. Sendmail only milters SMTP mail.  Local mail is not miltered.
 You can pipe a raw message through sendmail to test your milter:
 <pre>
 $ cat rawtextmsg | sendmail myname@my.full.domain
 </pre>
 Now check your milter log.
 <p>
 <li> Q. Why do I get this ImportError exception?
 <pre>
 File "mime.py", line 370, in ?
    from sgmllib import declstringlit, declname
    ImportError: cannot import name declstringlit
 </pre>
 <p>  A. <code>declstringlit</code> is not provided by sgmllib in all versions
 of python.  For instance, python-2.2 does not have it.  Upgrade to
 milter-0.4.5 or later to remove this dependency.
 <p>
 <li> Q. Why do I get <code>milter.error: cannot add recipient</code>?
 <pre>
 </pre>
 <p>  A. You must tell libmilter how you might mutate the message with
 <code>set_flags()</code> before calling <code>runmilter()</code>.  For
 instance, <code>Milter.set_flags(Milter.ADDRCPT)</code>.  You must add together
 all of <code>ADDHDRS, CHGBODY, ADDRCPT, DELRCPT, CHGHDRS</code> that apply.
 <p> NOTE - recent versions default flags to enabling all features.  You
 must now call <code>set_flags()</code> if you wish to disable features for
 efficiency.
 <p>
 <li> Q. Why does sendmail sometimes print something like:
 "...write(D) returned -1, expected 5: Broken pipe"
 in the sendmail log?
 <p>  A. Libmilter expects "rcpt to" shortly after getting "mail from".
 "Shortly" is defined by the timeout parameter you passed to
 <code>Milter.runmilter()
 </code> or <code>milter.settimeout()</code>.  If the timeout is 10 seconds,
 and looking up the first recipient in DNS takes more than
 10 seconds, libmilter will give up and break the connection.  
 <code>Milter.runmilter()</code> defaulted to 10 seconds in 0.3.4.  In 0.3.5
 it will keep the libmilter default of 2 hours.
 <p>
 <li> Q. Why does milter block messages with big5 encoding?  What if I
 want to receive them?
 <p>  A. sample.py is a sample.  It is supposed to be easily modified
 for your specific needs.  We will of course continue to move generic
 code out of the sample as the project evolves.  Think of sample.py as
 an active config file.
 <p>
 If you are running bms.py, then the block_chinese option in 
 <code>/etc/mail/pymilter.cfg</code> controls this feature.
 <p>
 <li> Q. Why does sendmail coredump with milters on OpenBSD?
 <p>  A. Sendmail has a problem with unix sockets on old versions of OpenBSD.
 OpenBSD users report that this problem has been fixed, so upgrading
 OpenBSD will fix this.  Otherwise, you can
 use an internet domain socket instead.  For example, in
 <code>sendmail.cf</code> use
 <pre>
 Xpythonfilter, S=inet:1234@localhost
 </pre>
 and change sample.py accordingly.
 <p>
 <li> Q. How can I change the bounce message for an invalid recipient?
 I can only change the recipient in the eom callback, but the eom callback
 is never called when the recipient is invalid!
 <p>  A. Configure sendmail to use virtusertable, and send all unknown
 addresses to /dev/null.  For example,
 <h4>/etc/mail/virtusertable</h4>
 <pre>
@mycorp.com	dev-null
 dan@mycorp.com	dan
 sally@mycorp.com	sally
 </pre>
 <h4>/etc/aliases</h4>
 <pre>
 dev-null:	/dev/null
 </pre>
 Now your milter will get to the eom callback, and can change the
 envelope recipient at will.  Thanks to Dredd at 
 <a href=http://www.milter.org/>milter.org</a> for this solution.
 <p>
 <li> Q. I am having trouble with the setreply method.  It always outputs
 	"milter.error: cannot set reply".
 <p>  A. Check the sendmail log for errors.  If sendmail is getting
 milter timeouts, then your milter is taking too long and sendmail gave
 up waiting.  You can adjust the timeouts in your sendmail config.  Here
 is a milter declaration for sendmail.cf with all timeouts specified:
 <pre>
 Xpythonfilter, S=local:/var/log/milter/pythonsock, F=T, T=C:5m;S:20s;R:60s;E:5m
 </pre>
 <li> Q. There is a Python traceback in the log file!  What happened to
 	my email?
 <p>  A. By default, when the milter fails with an untrapped exception, a
 TEMPFAIL result (451) is returned to the sender.  The sender will then retry
 every hour or so for several days.  Hopefully, someone will notice the 
 traceback, and workaround or fix the problem.  Beginning with milter-0.8.2,
 you can call <code>milter.set_exception_policy(milter.CONTINUE)</code>
 to cause an untrapped exception to continue processing with the
 next callback or milter instead.  For
 completeness, you can also set the exception policy to
 <code>milter.REJECT</code>.
 <li> Q. I read some notes such as "Check valid domains allowed by internal
 	senders to detect PCs infected with spam trojans." but could not
 	understand the idea. Could you clarify the content ?
 <p>  A. The <code>internal_domains</code> configuration specifies which
 MAIL FROM domains are used by internal connections.  If an internal
 PC tries to use some other domain, it is assumed to be a "Zombie".
 <p>
 Here is a sample log line:
 <pre>
 2005Jun22 12:01:04 [12430] REJECT: zombie PC at  192.168.100.171  sending MAIL FROM  debby@fedex.com
 </pre>
 No, fedex.com does not use pymilter, and there is no one named debby at my
 client.  But the idiot using the PC at 192.168.100.171 has downloaded and
 installed some stupid weatherbar/hotbar/aquariumscreensaver that is actually a
 spam bot.
 <p>
 The <code>internal_domains</code> option is simplistic, it assumes all
 valid senders of the domains are internal.  SPF provides a much more general
 check of IP and MAIL FROM for external email.  Pymilter should soon
 have a local policy feature for more general checking of internal mail.
 <li> Q. <code>mail_archive</code> isn't working.  Or I don't understand how
 	it's suppose to work.  I have
 	<code>mail_archive = /var/mail/mail_archive</code>
 	in <code>pymilter.cfg</code> but nothing ever gets dumped into
 	<code>/var/mail/mail_archive</code>.
 <p>  A. The 'mail' user needs to have write access.  Permission failures
 	should be logged as a traceback in milter.log if it doesn't.
 <h3> <a name="spf">Using SPF </a></h3>
 <li> Q. So how do I use the SPF support?  The sample.py milter doesn't seem
        to use it.
 <p>  A. The bms.py milter supports spf.  The RedHat RPMs will set almost
 everything up for you.  For other systems:
 <ol type=i>
 <li> Arrange to run bms.py in the background (as a service perhaps) and
     redirect output and errors to a logfile.  For instance, on AIX you'll want
     to use SRC (System Resource Controller).  
 <li> Copy pymilter.cfg to the /etc/mail or the directory you run bms.py in,
     and edit it.  The comments should explain the options. 
 <li> Start bms.py in the background as arranged.
 <li> Add Xpythonfilter to sendmail.cf or add an INPUT_MAIL_FILTER to
     sendmail.mc.  Regen sendmail.cf if you use sendmail.mc and restart 
     sendmail.
 <li> Arrange to rotate log files and remove old defang files in 
     <code>tempdir</code>.  The RedHat RPM uses <code>logrotate</code> for
     logfiles and a simple cron script using <code>find</code> to clean
     <code>tempdir</code>.
 </ol>
 	In CVS, there is <code>spfmilter.py</code>.  Run that as a service,
 	and it does just SPF.  It uses the sendmail <code>access</code>
 	file to configure SPF responses just like <code>bms.py</code>, but
 	supports only REJECT and OK.
 <li> Q. The SPF DSN is sent at least once for domains that don't publish a SPF.
 	How do I stop this behavior?
 <p>  A. The SPF response is controlled by <code>/etc/mail/access</code>
 	(actually the file you specify with <code>access_file</code> in
 	the <code>[spf]</code> section of <code>pymilter.cfg</code>).  
 	Responses are OK, CBV, and REJECT.  CBV sends the DSN.
 <p>
 You can change the defaults.  For instance, I have:
 <pre>
 SPF-None:	REJECT
 SPF-Neutral:	CBV
 SPF-Softfail:	CBV
 SPF-Permerror:	CBV
 </pre>
 I have best_guess = 1, so SPF none is converted to PASS/NEUTRAL for policy
 lookup, and 3 strikes (no PTR, no HELO, no SPF) becomes "SPF NONE" for local
 policy purposes (the Received-SPF header always shows the official SPF
 result.)
 <p>
 You can change the default for specific domains:
 <pre>
 # these guys aren't going to pay attention to CBVs anyway...
 SPF-None:cia.gov	REJECT
 SPF-None:fbi.gov	REJECT
 SPF-Neutral:aol.com	REJECT
 SPF-Softfail:ebay.com	REJECT
 </pre>
 <h3> <a name="srs">Using SRS </a></h3>
 <li> Q. The SRS part doesn't seem to work as whenever I try to start
 	<code>/etc/init.d/pysrs</code>, I get this in
 	<code>/var/log/milter/pysrs.log</code>:
 <pre>
 ConfigParser.NoOptionError: No option 'fwdomain' in section: 'srs'
 </pre>
 <p>  A. You need to specify the forward domain - i.e. the domain you want
 	SRS to rewrite stuff too.
 <p>
 For instance, I have:
 <pre>
 # sample SRS configuration
 [srs]
 secret = don't you wish
 maxage = 8
 hashlength = 5
 ;database=/var/log/milter/srs.db
 fwdomain = bmsi.com
 sign=bmsi.com,mail.bmsi.com,gathman.org
 srs=bmsaix.bmsi.com,bmsred.bmsi.com,stl.gathman.org,bampa.gathman.org
 </pre>
 The <code>sign</code> is for local domains which are signed.
 The <code>srs</code> list is for other domains which you are relaying,
 and which need to have SRS checked/undone for bounces.
 </ol>
@@ -0,0 +1,24 @@
 <!-- -*- html -*- -->
 <h3>Subsections</h3>
 <li><a href="milter.html">Introduction</a>
 <li><a href="changes.html">Changes</a>
 <li><a href="requirements.html">Requirements</a>
 <li><a href="http://sourceforge.net/project/showfiles.php?group_id=139894">Download</a>
 <li><a href="RPM-GPG-KEY-bms">GPG-KEY</a>
 <li><a href="faq.html">FAQ</a>
 <li><a href="policy.html">Policies</a>
 <li><a href="logmsgs.html">Log&nbsp;Messages</a>
 <li><a href="http://bmsi.com/mailman/listinfo/pymilter">Mailing&nbsp;List</a>
 <li><a href="credits.html">CREDITS</a>
 <li><a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=139894&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
 <h3>Links</h3>
 <li><a href="https://www.milter.org/developers/api/index">C&nbsp;API</a>
 <li><a href="http://www.milter.org/">Milter.Org</a>
 <li><a href="http://www.python.org/">Python.Org</a>
 <li><a href="http://www.sendmail.org/">Sendmail.Org</a>
 <li><a href="http://www.openspf.org/">SPF</a>
 <li><a href="pysrs.html">pysrs</a>
 <li><a href="http://cheeseshop.python.org/pypi/pyspf">pyspf</a>
 <li><a href="http://bmsi.com/python/pygossip.html">pygossip</a>
 <li><a href="http://bmsi.com/python/dspam.html">pydspam</a>
 <li><a href="http://bmsi.com/libdspam/dspam.html">libdspam</a>
@@ -0,0 +1,91 @@
 Title: Python Milter Log Documentation
 <style>
 DT              { font-weight: bolder; padding-top: 1em }
 </style>
 <h1> Milter Log Documentation </h1>
 The milter log from the bms.py application has a variety of "tags" in it that
 indicate what it did.
 <dl>
 <dt> DSPAM: honeypot SCREENED
 <dd> message was quarantined to the honeypot quarantine
 <dt> REJECT: hello SPF: fail 550 access denied
 <dt> REJECT: hello SPF: softfail 550 domain in transition
 <dt> REJECT: hello SPF: neutral 550 access neither permitted nor denied
 <dd> message was rejected because there was an SPF policy for the
 HELO name, and it did not pass.
 <dt> CBV: sender-17-44662668-643@bluepenmagic.com
 <dd> we performed a call back verification
 <dt> dspam
 <dd> dspam identifier was added to the message
 <dt> REJECT: spam from self: jsconnor.com
 <dd> message was reject because HELO was us (jsconnor.com)
 <dt> INNOC: richh
 <dd> message was used to update richh's dspam dictionary
 <dt> HONEYPOT: pooh@bwicorp.com
 <dd> message was sent to a honeypot address (pooh@bwicorp.com), the 
 message was added to the honeypot dspam dictionary as spam
 <dt> REJECT: numeric hello name: 63.217.19.146
 <dd> message was rejected because helo name was invalid (numeric)
 <dt> eom
 <dd> message was successfully received
 <dt> TEMPFAIL: CBV: 450 No MX servers available
 <dd> we tried to do a call back verification but could not look up 
 MX record, we told the sender to try again later
 <dt> CBV: info@emailpizzahut.com (cached)
 <dd> call back verification was needed, we had already done it recently
 <dt> abort after 0 body chars
 <dd> sender hung up on us
 <dt> REJECT: SPF fail 550 SPF fail: see 
  http://openspf.com/why.html?sender=m.hendersonxk@163.net&ip=213.47.161.100
 <dd> message was reject because its sender's spf policy said to
 <dt> REJECT: Subject: Cialis - No prescription needed!
 <dd> message was rejected because its subject contained a bad expression
 <dt> REJECT: zombie PC at  192.168.3.37  sending MAIL FROM  seajdr@amritind.com
 <dd> message was rejected because the connect ip was internal, but the
 sender was not.  This is usually because a Windows PC is infected with
 malware.
 <dt> X-Guessed-SPF: pass
 <dd> When the SPF result is NONE, we guess a result based on the generic
 SPF policy "v=spf1 a/24 mx/24 ptr".
 <dt> DSPAM: tonyc tonyc@example.com
 <dd> message was sent to tonyc@example.com and it was identified as spam 
 and placed in the tonyc dspam quarantine
 <dt> REJECT: CBV: 550 calvinalstonis@ix.netcom.com...User unknown
 <dt> REJECT: CBV: 553 sorry, that domain isn't in my list
 <dt> REJECT: CBV: 554 delivery error: dd This user doesn't have an account 
 <dd> message was rejected because call back verification gave us a fatal
 error
 <dt> Auto-Whitelist: user@example.com
 <dd> recipient has been added to auto_whitelist.log because the message
 was sent from an internal IP and the recipient is not internal.
 <dt> WHITELIST user@example.com
 <dd> message is whitelisted because sender appears in auto_whitelist.log
 <dt> BLACKLIST user@example.com
 <dd> message is blacklisted because sender appears in blacklist.log or
     failed a CBV test.
 <dt> TRAINSPAM: honeypot X-Dspam-Score: 0.002278
 <dd> message was used to train screener dictionary as spam
 <dt> TRAIN: honeypot X-Dspam-Score: 0.980203
 <dd> message was used to train screener dictionary as ham
 </dl>
 <br>
@@ -0,0 +1,264 @@
 Title: Python Milters
 <P ALIGN="CENTER"><A HREF="http://www.anybrowser.org/campaign/">
 <IMG SRC="http://bmsi.com/art/brain1.gif"
 ALT="Viewable With Any Browser" BORDER="0"></A>
 <img src="http://bmsi.com/art/banner_4.gif" width="468" height="60" border="0"
 	usemap="#banner_4" alt="Your vote?">
 <map name="banner_4">
  <area shape="rect" coords="330,25,426,59"
  	href="http://education-survey.org/" alt="I Disagree">
  <area shape="rect" coords="234,28,304,57" href="http://www.honestEd.com/" alt="I Agree">
 </map>
 </P>
 <table rules="none">
 <tr><td>
 <img src="Maxwells.gif" alt="Maxwell's Daemon: pymilter mascot" align="top">
 Mascot by <a href="http://alphard.ethz.ch/hafner/lebl.htm">Christian Hafner</a>
 </td>
 <td>
 <h1 align=center>Sendmail Milters in Python</h1>
 <h4 align=center>by <a href="mailto:%75%72%6D%61%6E%65%40%6E%65%75%72%61l%61%63%63%65%73%73%2E%63%6F%6D">Jim Niemira</a>
  and <a href="mailto:%73%74%75%61%72%74%40%62%6D%73%69%2E%63%6F%6D">
  Stuart D. Gathman</a><br>
 This web page is written by Stuart D. Gathman<br>and<br>sponsored by
 <a href="http://www.bmsi.com">Business Management Systems, Inc.</a> <br>
 Last updated Aug 26, 2008</h4>
 See the <a href="faq.html">FAQ</a> | <a href="http://sourceforge.net/project/showfiles.php?group_id=139894">Download now</a> |
 <a href="http://bmsi.com/mailman/listinfo/pymilter">Subscribe to mailing list</a> |
 <a href="#overview">Overview</a> |
 <a href="/python/dspam.html">pydspam</a> |
 <a href="/libdspam/dspam.html">libdspam</a>
 <p>
 <a href="//www.python.org">
 <img src="python55.gif" align=left alt="A Python"></a>
 <a href="//www.sendmail.org/">Sendmail</a> introduced a
 <a href="https://www.milter.org/developers/api/index"> new API</a> beginning with version 8.10 -
 libmilter.  The milter module for <a href="//www.python.org">Python</a>
 provides a python interface to libmilter that exploits all its features.
 <p>
 Sendmail 8.12 officially releases libmilter.  
 Version 8.12 seems to be more robust, and includes new privilege
 separation features to enhance security.  Even better, sendmail 8.13
 supports socket maps, which makes <a href="pysrs.html">pysrs</a> much more
 efficient and secure.   Sendmail 8.14 finally supports modifying 
 MAIL FROM via the milter API.  Unfortunately, I haven't gotten around
 to supporting that yet in python milter.
 </td></tr>
 </table>
 <h3><a name=overview>Overview</a></h3>
 This package provides a robust toolkit for Python <a
 href="#milter">milters</a>, and the beginnings of a general purpose mail
 filtering system written in Python.
 <p>
 At the lowest level, the 'milter' module provides a thin wrapper around the
 <a href="https://www.milter.org/developers/api/index">
 sendmail libmilter API</a>.  This API lets you register callbacks for 
 a number of events in the
 <a href="http://www.cs.concordia.ca/~group/fig/public/email/relay/milter+ruleset-checks.html">process of sendmail receiving a message via SMTP</a>.  
 These events include the initial connection from a MTA,
 the envelope sender and recipients, the top level mail headers, and
 the message body.  There are options to mangle all of these components
 of the message as it passes through the milter.
 <p>
 At the next level, the 'Milter' module (note the case difference) provides a
 Python friendly object oriented wrapper for the low level API.  To use the
 Milter module, an application registers a 'factory' to create an object
 for each connection from a MTA to sendmail.  These connection objects
 must provide methods corresponding to the libmilter callback events.
 <p>
 Each event method returns a code to tell sendmail whether to proceed
 with processing the message.  This is a big advantage of milters over
 other mail filtering systems.  Unwanted mail can be stopped in its
 tracks at the earliest possible point.
 <p>
 The Milter.Milter class provides default implementations for event
 methods that
 do nothing, and also provides wrappers for the libmilter methods to mutate
 the message.
 <p>
 The 'spf' module provides an implementation of <a href="http://openspf.com">
 SPF</a> useful for detecting email forgery.
 <p>
 The 'mime' module provides a wrapper for the Python email package that
 fixes some bugs, and simplifies modifying selected parts of a MIME message.
 <p>
 Finally, the bms.py application is both a sample of how to use the
 Milter and spf modules, and the beginnings of a general purpose SPAM filtering,
 wiretapping, SPF checking, and Win32 virus protecting milter.  It can
 make use of the <a href="pysrs.html">pysrs</a> package when available for
 SRS/SES checking and the <a href="dspam.html">pydspam</a> package for Bayesian
 content filtering.  SPF checking
 requires <a href="http://pydns.sourceforge.net/">
 pydns</a>.  Configuration documentation is currently included as comments
 in the <a href="milter.cfg">sample config file</a> for the bms.py milter.
 See also the <a href="HOWTO">HOWTO</a> and <a href="logmsgs.html">
 Milter Log Message Tags</a>.
 <p>
 Python milter is under GPL.  The authors can probably be convinced to
 change this to LGPL if needed.
 <h3>What is a <a name="milter">milter</a>?</h3>
 Milters can run on the same machine as sendmail, or another machine.  The
 milter can even run with a different operating system or processor than
 sendmail.
 Sendmail talks to the milter via a local or internet socket.
 Sendmail keeps the
 milter informed of events as it processes a mail connection.  At any 
 point, the milter can cut the conversation short by telling sendmail
 to ACCEPT, REJECT, or DISCARD the message.  After receiving a complete
 message from sendmail, the milter can again REJECT or DISCARD it, but it
 can also ACCEPT it with changes to the headers or body.
 <h3> What can you do with a milter? </h3>
 <menu>
 <li> A milter can DISCARD or REJECT spam based based on algorithms scripted
 in python rather than sendmail's cryptic "cf" language.
 <li> A milter can alter or remove attachments from mail that are poisonous to
 Windows.
 <li> A milter can scan for viruses and clean them when detected.
 <li> A milter scans outgoing as well as incoming mail.
 <li> A milter can add and delete recipients to forward or secretly
 copy mail.
 <li> For more ideas, check the <a href="//www.milter.org">Milter Web Page</a>.
 </menu>
 <a href="https://www.milter.org/developers/api/index">
 Documentation</a> for the C API is provided with sendmail.  Miltermodule
 provides a thin python wrapper for the C API.  Milter.py provides a simple
 OO wrapper on top of that.
 <p>
 The Python milter package includes a sample milter that replaces dangerous 
 attachments with a warning message, discards mail addressed to
 MAILER-DAEMON, and demonstrates several SPAM abatement strategies.  
 The MimeMessage class to do this used to be based on the
 <code>mimetools</code> and <code>multifile</code> standard python packages.  
 As of milter version 0.6.0, it is based on the email standard
 python packages, which were derived from the 
 <a href="http://sourceforge.net/projects/mimelib">mimelib</a> project.
 The MimeMessage class patches several bugs in the email package,
 and provides some backward compatibility.
 <p>
 The "defang" function of the sample milter was inspired by
 <a href="http://www.roaringpenguin.com/mimedefang/">MIMEDefang</a>,
 a Perl milter with flexible attachment processing options.  The latest
 version of MIMEDefang uses an apache style process pool to avoid reloading
 the Perl interpreter for each message.  This makes it fast enough for
 production without using Perl threading.
 <p>
 <a href="http://sourceforge.net/projects/mailchecker">mailchecker</a> is
 a Python project to provide flexible attachment processing for mail.  I
 will be looking at plugging mailchecker into a milter.
 <p>
 <a href="http://software.libertine.org/tmda/">TMDA</a> is a Python project
 to require confirmation the first time someone tries to send to your
 mailbox.  This would be a nice feature to have in a milter.
 <p>
 There is also a <a href="http://www.milter.org/">Milter community website</a>
 where milter software and gory details of the API are discussed.
 <h3> Is a milter written in python efficient? </h3>
 The python milter process is multi-threaded and startup cost is incurred
 only once.  This is much more efficient than some implementations that
 start a new interpreter for each connection.  Testing in a production
 environment did not use a significant percentage of the CPU.  Furthermore,
 python is easily extended in C for any step requiring expensive CPU
 processing.
 <p>
 For example, the HTML parsing feature to remove scripts from HTML attachments
 is rather CPU intensive in pure python.  Using the C replacement for sgmllib
 greatly speeds things up.
 <h3> Goals </h3>
 <menu>
 <li> Implement RRS - a backdoor for non-SRS forwarders.  User lists non-SRS 
     forwarder accounts (perhaps in <code>~/.forwarders</code>), and a util
     provides a special local alias for the user to give to the forwarder.
     Alias only works for mail from that forwarder.  Milter gets forwarder
     domain from alias and uses it to SPF check forwarder.  Requires
     milter to have read access to <code>~/.forwarders</code> or else
     a way for user to submit entries to milter database.
 <li> The bms.py milter has too many features.  Create a framework where
     numerous small feature modules can be plugged together in the
     configuration.
 <li> Create a pure python substitute for miltermodule and libmilter that
     implements the <a
 href="http://www.duh.org/cvsweb.cgi/~checkout~/pmilter/doc/milter-protocol.txt?rev=1">
     libmilter protocol</a> in python. 
 <li> Find or write a faster implementation of sgmllib.  The 
     <a href="http://www.effbot.org/zone/sgmlop-index.htm">sgmlop package</a>
     is not very compatible with 
     <a href="http://www.python.org/doc/2.1.3/lib/module-sgmllib.html">
     Python-2.1 sgmllib</a>, but it is a start, and is supported in
     milter-0.4.5 or later.
 <li> Implement all or most of the features of 
     <a href="http://www.roaringpenguin.com/mimedefang/">MIMEDefang</a>.
 <li> Follow the official <a href="http://www.python.org/peps/pep-0008.html">
     Python coding standards</a> more closely.
 <li> Make unit test code more like other python modules.
 </menu>
 <h3> Confirmed Installations </h3>
 Please <a href="mailto:%73%74%75%61%72%74%40%62%6D%73%69%2E%63%6F%6D">email</a>
 me if you do <i>not</i> successfully install milter.  The confirmed
 installations are too numerous to list at this point.
 <h2> Enough Already! </h2>
 Nearly a dozen people have emailed me begging for a feature to copy
 outgoing and/or incoming mail to a backup directory by user.  Ok, it
 looks like this is a most requested feature for 0.5.6.  In the meantime,
 here are some things to consider:
 <ul>
 <li> If you want to equivalent of a Bcc added to each message, this
 is very easy to do in the python code for bms.py.   See below.
 <li> If you want to copy to a file in a directory (thus avoiding having to
 set up aliases), this is slightly more involved.  The bms.py milter already
 copies the message to a temporary file for use in replacing the message body
 when banned attachments are found.  You have to open a file, and copy the
 Mesage object to it in eom().
 <li> Finally, you are probably aware that most email clients already
 keep a copy of outgoing mail?  Presumably there is a good reason for
 keeping another copy on the server.
 </ul>
 <p>
 To Bcc a message, call <code>self.add_recipient(rcpt)</code> in envfrom after
 determining whether you want to copy (e.g. whether the sender is local).  For
 example,
 <pre>
  def envfrom(...
    ...
    if len(t) == 2:
      self.rejectvirus = t[1] in reject_virus_from
      if t[0] in wiretap_users.get(t[1],()):
 	self.add_recipient(wiretap_dest)
      if t[1] == 'mydomain.com':
        self.add_recipient('&lt;copy-%s&gt;' % t[0])
      ...
 </pre>
 <p>
 To make this a generic feature requires thinking about how the configuration
 would look.  Feel free to make specific suggestions about config file
 entries.  Be sure to handle both Bcc and file copies, and designating what
 mail should be copied.  How should "outgoing" be defined?  Implementing it is
 easy once the configuration is designed.
 <hr>
 <p>
 <a href="http://validator.w3.org/check/referer">
 <img border=0 src="http://bmsi.com/vh32.png" alt=" [ Valid HTML 3.2! ] " height=31 width=88></a>
 <a href="http://www.redhat.com">
 <img src="http://bmsi.com/art/powered_by.gif" width="88" height="31" alt=" [ Powered By Red Hat Linux ] " border="0"></a>
 </p>
@@ -0,0 +1,249 @@
 Title: Python Milter Mail Policy
 <h1> Python Milter Mail Policy </h1>
 These are the policies implemented by the <code>bms.py</code> milter
 application.  The milter and Milter modules do not implement any policies
 by themselves.  
 <h3> Classify connection </h3>
 When the SMTP client connects, the connection IP address is
 saved for later verification, and the connection
 is classified as INTERNAL or EXTERNAL by matching the ip
 address against the <code>internal_connect</code> configuration.
 IP addresses with no PTR, and PTR names that look like
 the kind assigned to dynamic IPs (as determined by a heuristic
 algorithm) are flagged as DYNAMIC.  IPs that match the
 <code>trusted_relay</code> configuration are flagged as TRUSTED.
 <p>
 Examples from the log file (<i>not</i> the SMTP error message returned):
 <pre>
 2005Jul29 13:56:53 [71207] connect from p50863492.dip0.t-ipconnect.de at ('80.134.52.146', 1858) EXTERNAL DYN
 2005Jul29 18:10:15 [74511] connect from foopub at ('1.2.3.4', 46513) EXTERNAL TRUSTED
 2005Jul29 14:41:00 [71805] connect from foobar at ('192.168.0.1', 41205) INTERNAL
 2005Jul29 14:41:15 [71806] connect from cncln.online.ln.cn at ('218.25.240.137', 35992) EXTERNAL
 </pre>
 <p>
 Certain obviously evil PTR names are blocked at this point:
 "localhost" (when IP is not 127.*) and ".".
 <pre>
 2005Jul29 14:49:50 [71918] connect from localhost at ('221.132.0.6', 50507) EXTERNAL
 2005Jul29 14:49:50 [71918] REJECT: PTR is localhost
 </pre>
 <h3> HELO Check </h3>
 The HELO name provided by the client is saved for later verification
 (for example by SPF).  We could validate the HELO at this point
 by verifying that an A record for the HELO name matches the connect ip.
 However, currently we only block certain obvious problems.  
 HELO names that look like an IP4 address 
 and ones that match the <code>hello_blacklist</code> configuration
 are immediately rejected.  The hello_blacklist typically contains
 the current MTAs own HELO name or email domains.
 Clients that attempt to skip HELO are immediately rejected.
 <pre>
 2005Jul29 18:10:15 [74512] hello from example.com
 2005Jul29 18:10:15 [74512] REJECT: spam from self: example.com
 2005Jul29 18:17:09 [74581] hello from 80.191.244.69
 2005Jul29 18:17:09 [74581] REJECT: numeric hello name: 80.191.244.69
 </pre>
 <h3> MAIL FROM Check </h3>
 Before calling our milter, sendmail checks a DNS blacklist to 
 block banned sender domains.  We never see a blocked domain.
 <p>
 The MAIL FROM address is saved for possible use by the smart-alias
 feature.  First, the <code>internal_domains</code> is used for
 a simple screening if defined.  If the MAIL FROM for an INTERNAL connection 
 is NOT in <code>internal_domains</code>, then it is rejected (the
 PC is most likely infected and attempting to send out spam).
 If the MAIL FROM for an EXTERNAL connection IS in
 <code>internal_domains</code>, then the message is immediately rejected.
 This is quick and effective for most small company MTAs.  For more
 complex mail networks, it is too simplistic, and should not be defined.
 SPF will handle the complex cases.
 <h4> wiretap </h4>
 The wiretap feature can screen and/or monitor mail to/from certain
 users.  If the MAIL FROM is being wiretapped, the recipients are
 altered accordingly.
 <!--table-stop-->
 <h2> SPF check </h2>
 The MAIL FROM, connect IP, and HELO name are checked against
 any SPF records published via DNS for the alleged sender (MAIL FROM)
 to determine the official SPF policy result.
 The offical SPF result is then logged in the Received-SPF header field,
 but certain results are subjected to further processing to create
 an effective result for policy purposes.
 <p>
 If the official result is 'none', we try to turn it into an effective result of
 'pass' or 'fail'.  First, we check for a local substitute SPF record
 under the domain defined in the <code>[spf]delegate</code> configuration.  
 It is often useful to add local SPF records for correspondents that are
 too clueless to add their own.  If there is no local substitute, we use a "best
 guess" SPF record of "v=spf1 a/24 mx/24 ptr" for MAIL FROM or "v=spf1 a/24
 mx/24" for HELO.  In addition, a HELO that is a subdomain of MAIL FROM and
 resolves to the connect IP results in an effective result of 'pass'.
 <p>
 If there is no local SPF record, and the effective result is still not
 'pass', we check for either a valid HELO name or a valid PTR record for
 the connect IP.  A valid HELO or PTR cannot look like a dynamic name
 as determined by the heuristic in <code>Milter.dynip</code>.
 <p>
 If HELO has an SPF record, and the result is anything but pass, we reject
 the connection:
 <pre>
 2005Jul30 19:45:16 [93991] connect from [221.200.41.54] at ('221.200.41.54', 3581) EXTERNAL DYN
 2005Jul30 19:45:18 [93991] hello from adelphia.net
 2005Jul30 19:45:19 [93991] mail from <wendy.stubbsua@link-it.com> ()
 2005Jul30 19:45:19 [93991] REJECT: hello SPF: fail 550 access denied
 </pre>
 Note that HELO does not have any forwarding issues like MAIL FROM, and so
 any result other than 'pass' or 'none' should be treated like 'fail'.
 <p>
 Only if nothing about the SMTP envelope can be validated does the effective
 result remain 'none.  I call this the "3 strikes" rule.
 <p>
 If the official result is 'permerror' (a syntax error in the sender's
 policy), we use the 'lax' option in pyspf to try various heuristics to guess 
 what they really meant.  For instance, the invalid mechanism "ip:1.2.3.4" is
 treated as "ip4:1.2.3.4".  The result of lax processing is then used
 as the effective result for policy purposes.
 <p>
 With an effective SPF result in hand, we consult the sendmail access
 database to find our receiver policy for the sender.  
 <table border=1>
 <tr><th>REJECT</th><td>
 Reject the sender with a 550 5.7.1 SMTP code.  The SMTP rejection
 includes a detailed description of the problem.
 </td></tr>
 <tr><th>CBV</th><td>
 Do a Call Back Validation by connecting to an MX of the sender
 and checking that using the sender as the RCPT TO is not rejected.
 We quit the CBV connection before actualling sending a message.
 If the CBV is rejected, our SMTP connection is rejected with the
 same error code and message.  CBV results are cached.
 </td></tr>
 <tr><th>DSN</th><td>
 Do a Call Back Validation by connecting to an MX of the sender
 and checking that using the sender as the RCPT TO is not rejected.
 Unlike a CBV, we continue on to data and send a detailed message
 explaining the problem.  This can be useful for reporting PermError
 or SoftFail to the sender.  Keep in mind that for any result other
 than 'pass', the sender could be forged, and your DSN could annoy the
 wrong person.  However, a SoftFail result is requesting such feedback
 for debugging and a PermError result needs to be fixed by the sender ASAP
 whether forged or not.  DSN results are cached so that senders are
 annoyed only weekly.
 </td></tr>
 <tr><th>OK</th><td>
 Accept the sender.  The message may still be rejected via reputation
 or content filtering.
 </td></tr>
 </table>
 <h3> SPF policy syntax </h3>
 First, the full sender is checked:
 <pre>
 SPF-Fail:abeb@adelphia.net     DSN
 </pre>
 This says to accept mail from that adelphia.net user despite the
 SPF fail, but only after annoying them with a DSN about their ISP's broken
 policy. 
 <p>
 If there is no match on the full sender, the domain is checked:
 <pre>
 SPF-Neutral:aol.com     REJECT
 </pre>
 This says to reject mail from AOL with an SPF result of neutral.
 This means AOL users can't use their AOL address with another mail service
 to send us mail.  This is good because the other mail service is 
 likely a badly configured greeting card site or a virus.
 <p>
 Finally, a default policy for the result is checked.  While there are program
 defaults, you should have defaults in the access database for SPF results:
 <pre>
 SPF-Neutral:            CBV
 SPF-Softfail:           DSN
 SPF-PermError:          DSN
 SPF-TempError:          REJECT
 SPF-None:               REJECT
 SPF-Fail:               REJECT
 SPF-Pass:               OK
 </pre>
 <h2> Reputation </h2>
 If the sender has not been rejected by this point, and if a GOSSiP server is
 configured, we consult GOSSiP for the reputation score of the sender and
 SPF result.  The score is a number from -100 to 100 with a confidence
 percentage from 0 to 100.  A really bad reputation (less than -50 with
 confidence greater than 3) is rejected.  Note that the reputation is tracked
 independently for each SPF result and sender combination.  So aol.com:neutral
 might have a really bad reputation, while aol.com:pass would be ok.
 Furthermore, when a sender finally publishes an SPF policy and starts
 getting SPF pass, their reputation is effectively reset.
 <h2> Whitelists and Blacklists </h2>
 The administrator can whitelist or blacklist senders and sending domains by
 appending them to <code>${datadir}/auto_whitelist.log</code> or
 <code>${datadir}/blacklist.log</code> respectively.  In addition,
 recipients of internal senders (except for automatic replies like vacation
 messages and return receipts) are automatically whitelisted for 60 days, and
 senders that fail CBV or DSN checks are automatically blacklisted for 30 days.
 Whitelisted and blacklisted senders are used to automatically train the
 bayesian content filter before being delivered or rejected, respectively.
 <p>
 Real Soon Now users will be able to maintain their own whitelist and
 blacklist that applies only when they are the recipient.
 <h2> Content Filter </h2>
 Most messages have been rejected or delivered by now, but spammers
 are always finding new places to send their junk from.  For instance,
 we get around 10000 emails a day, of which around 500 are first time
 spam senders.  A bayesian filter is trained by the whitelists and
 blacklists, and scores the message.  What is likely spam is either
 rejected or quarantined.  If the sender is an effective SPF pass,
 then they get a DSN notifying them that their message has been
 quarantined.  (A DSN failure gets the sender auto blacklisted.)
 Else, if the reject_spam option is set, the message is rejected.  
 Otherwise, a CBV is done (failure gets the sender auto blacklisted)
 and the message is silently quarantined.
 <p>
 Normally, you don't want email messages to silently disappear into
 a black hole, so you should set the reject_spam option.  However,
 if you don't want your correspondent's email to get rejected, you can
 check your quarantine frequently instead.
 <h3> Honeypot </h3>
 You can also blacklist recipients by listing them as aliases of the
 'honeypot' dspam user.  These are collectively called
 the honeypot.  Any email to these recipients is used to train the
 spam filter as spam and chalk up a reputation demerit for the sender, then
 discarded.  It might be a good idea to blacklist the sender if it has SPF pass
 as well, but I'm afraid of accidents.
 <h3> Reputation </h3>
 Reputation is tracked by sending domain and effective SPF result.
 The GOSSiP server tracks the spam/ham status of the last 1024 messages
 for each domain:result combination.  When the server is queried during
 the SMTP envelope phase (MAIL FROM), it also queries any configured
 peers, and the scores are combined.  Domains with a history of spam for
 a given SPF result are rejected at MAIL FROM.  The GOSSiP system has
 a command line utility to reset (delete) a reputation for cases where a
 sender that was infected with malware is repaired.  In addition,
 the confidence score of a reputation decays with time, so a bad sender
 will eventually be able to try again without manual intervention.
@@ -0,0 +1,99 @@
 Title: Requirements
 <h2> Requirements </h2>
 <menu>
 <li> While the miltermodule will work with python 1.5, you probably
 want to use python 2.0 or better.  The python code uses a number of
 python 2 features.  The email support requires python 2.4.
 <li> Python must be configured with thread support.  This is because
 pymilter uses sendmail's libmilter which requires thread support.
 <li> You must compile sendmail with libmilter enabled.  In versions of
 sendmail prior to 8.12 libmilter is marked FFR (For Future Release) and
 is not installed by default.  
 Sendmail 8.12 still does not enable libmilter by default.  You must 
 explicitly select the "MILTER" option when compiling.  
 <li> When compiling Python milter against sendmail versions earlier than
 8.13, you must set MAX_ML_REPLY to 1 in setup.py.  There is no way to tell from
 the libmilter includes that smfi_setmlreply is not supported.
 <li> You probably want to use sendmail-8.13, since that supports multi-line
 SMTP error descriptions and SOCKETMAP.  You want SOCKETMAP for use with
 pysrs.
 <li> Python milter has been tested against sendmail-8.11 through sendmail-8.13.
 <li> Python milter must be compiled for the specific version of sendmail
 it will run with.  (Since the result is dynamically loaded, there could 
 conceivably be multiple versions available and selected at startup - but
 that will have to wait.)  This situation may only exist for sendmail
 versions prior to 8.12.  The protocol seems designed for backward 
 compatibility - and 8.12 is the first official milter release.
 <li> Mea Culpa!  After reading the Python Style guide, I realize that
 my Python code is not up to snuff.  Apparently mixed tabs and spaces
 are anathema to those using Windows editors, where tabs can be expanded using
 any arbitrary algorithm.  Other than that, my
 intuition matched Guido's pretty well - although I like to indent by 2
 rather than 4.  I will arrange to have tabs expanded to spaces when
 exporting new versions.  Until then, beware!
 </menu>
 <h3> <a name="aix4"> AIX 4.1.5 Requirements </a> </h3>
 To create sendmail RPMs for AIX, you can download my AIX 4.1.5 spec files 
 for <a href="/aix/sendmail.spec">sendmail-8.11.5</a> 
 or <a href="/aix/sendmail12.spec">sendmail-8.12.3</a>.  If you have
 not already set it up, I use a <a href="/aix/aix.spec">dummy RPM package</a>
 to represent the stuff that comes with AIX.  You might also want
 my <a href="/aix/python.spec">python-2.1.1</a> spec file for AIX.  It
 does not include Tk or curses modules, sorry.  If y'all trust me, you can
 download rpms for AIX 4.x from my <a href="/aix">AIX RPM directory</a>.
 <p>
 Sendmail-8.12 renames 
 libsmutil.a to libsm.a.  Unfortunately, libsm.a is an important AIX system
 shared library.  Therefore, I rename libsm.a back to libsmutil.a for
 AIX.  This presents a problem for setup.py.
 <h3> <a name="rh72"> RedHat 7.2 Requirements </a> </h3>
 If you are running Redhat 7.2, the distributed version of sendmail
 now enables libmilter by default.  RedHat 7.2 bundles
 the development libraries with the main sendmail package, so
 there is no sendmail-devel package.  However, they forgot to include the
 headers!  So you'll have to get the SRPM and modify it.  I suggest
 moving the static libs to a devel package and adding the headers.  If
 this is too much trouble, you can get the <a href="mfapi.h">mfapi.h</a>
 header for sendmail-8.6.11 from here and manually install it as
 <code>/usr/include/libmilter/mfapi.h</code>.
 <p>
 If you do modify the SRPM, I suggest renaming libsmutil.a
 to libsm.a - just like sendmail-8.12 will.  If you manually install
 mfapi.h or don't rename libsmutil.a, you'll
 need to force <code>libs = ["milter", "smutil"]</code> in setup.py.
 <p>
 If you have installed python2, and want
 python-milter to use python2, add <code>python=python2</code> to setup.cfg
 and build with <code>python2 setup.py bdist_rpm</code>.   
 <h3> <a name="rh62"> Redhat 6.2 Requirements </a> </h3>
 If you are running Redhat 6.2, the distributed version of sendmail
 does not enable libmilter.  You can download the Redhat 7.2 sendmail.spec
 modified to compile on RedHat 6.2:
 <a href="http://www.bmsi.com/linux/rh62/sendmail-rhmilter.spec">
 sendmail-rhmilter.spec</a>.  The <a
 href="ftp://updates.redhat.com/7.0/en/os/SRPMS/sendmail-8.11.6-1.7.0.src.rpm">
 SRPM for sendmail-8.11.6</a> is available from
 <a href="http://www.redhat.com">Redhat</a> under 
 <a href="http://www.redhat.com/support/errata/RHSA-2001-106.html">
 Errata for RH6.2</a>.  But that doesn't include the latest security
 patches since RH6.2 is no longer supported.
 <p>
 If y'all trust me, you can pick up source and binary sendmail RPMs for RH6.2
 from my <a href="http://www.bmsi.com/linux/rh62">linux downloads</a> directory.
 The lastest RPMs were built by taking a RH7.2 SRPMS and removing some
 RPM features from the spec file that RH6.2 doesn't support, then
 recompiling on RH6.2.  You can check this by installing the RH7.2 SRPM,
 then diffing my sendmail.spec with theirs.  Then run
 "rpm -bb sendmail-rhmilter.spec" when you are satisfied.
 <p>
 If you have installed python2, and want
 python-milter to use python2, add <code>python=python2</code> to setup.cfg
 and build with <code>python2 setup.py bdist_rpm</code>.
 You'll need to install the sendmail-devel package to compile milter.
@@ -1,159 +0,0 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
 <html>
 <head>
 <title>Python Milter FAQ</title>
 </head><body>
 <h1> Python Milter <a name=faq>FAQ</a> </h1>
 <ol>
 <h3> Compiling Python Milter </h3>
 <li> Q. I have installed sendmail from source, but Python milter won't
 compile.
 <p>  A. Even though libmilter is officially supported in sendmail-8.12, 
 you need to build and install it in separate steps.  Take a look
 at the <a href="/aix/sendmail12.spec">RPM spec file</a> for sendmail-8.12.  
 The %prep section shows you how to create
 a site.config.m4 that enables MILTER.  The %build section shows you how
 to build libmilter in a separate invocation of make.  The %install section
 shows you how to install libmilter with a separate invocation of make.
 <p>
 <li> Q. Why is mfapi.h not found when I try to compile Python milter on
 RedHat 7.2?
 <p>  A. RedHat forgot to include the header in the RPM.  See the
 <a href="milter.html#rh72">RedHat 7.2 requirements</a>.
 <p>
 <h3> Running Python Milter </h3>
 <li> Q. The sample.py milter prints a message, then just sits there.
 <pre>
 To use this with sendmail, add the following to sendmail.cf:
 O InputMailFilters=pythonfilter
 Xpythonfilter,        S=local:inet:1030@localhost
 See the sendmail README for libmilter.
 sample  milter startup
 </pre>
 <p>  A. You need to tell sendmail to connect to your milter.  The
 sample milter tells you what to add to your sendmail.cf to tell
 sendmail to use the milter.  You can also add an INPUT_MAIL_FILTER
 macro to your sendmail.mc file and rebuild sendmail.cf - see the sendmail
 README for milters.
 <p>
 <li> Q. I've configured sendmail properly, but still nothing happens
 when I send myself mail!
 <p>  A. Sendmail only milters SMTP mail.  Local mail is not miltered.
 You can pipe a raw message through sendmail to test your milter:
 <pre>
 $ cat rawtextmsg | sendmail myname@my.full.domain
 </pre>
 Now check your milter log.
 <p>
 <li> Q. Why do I get this ImportError exception?
 <pre>
 File "mime.py", line 370, in ?
    from sgmllib import declstringlit, declname
    ImportError: cannot import name declstringlit
 </pre>
 <p>  A. <code>declstringlit</code> is not provided by sgmllib in all versions
 of python.  For instance, python-2.2 does not have it.  Upgrade to
 milter-0.4.5 or later to remove this dependency.
 <p>
 <li> Q. Why do I get <code>milter.error: cannot add recipient</code>?
 <pre>
 </pre>
 <p>  A. You must tell libmilter how you might mutate the message with
 <code>set_flags()</code> before calling <code>runmilter()</code>.  For
 instance, <code>Milter.set_flags(Milter.ADDRCPT)</code>.  You must add together
 all of <code>ADDHDRS, CHGBODY, ADDRCPT, DELRCPT, CHGHDRS</code> that apply.
 <p>
 <li> Q. Why does sendmail sometimes print something like:
 "...write(D) returned -1, expected 5: Broken pipe"
 in the sendmail log?
 <p>  A. Libmilter expects "rcpt to" shortly after getting "mail from".
 "Shortly" is defined by the timeout parameter you passed to
 <code>Milter.runmilter()
 </code> or <code>milter.settimeout()</code>.  If the timeout is 10 seconds,
 and looking up the first recipient in DNS takes more than
 10 seconds, libmilter will give up and break the connection.  
 <code>Milter.runmilter()</code> defaulted to 10 seconds in 0.3.4.  In 0.3.5
 it will keep the libmilter default of 2 hours.
 <p>
 <li> Q. Why does milter block messages with big5 encoding?  What if I
 want to receive them?
 <p>  A. sample.py is a sample.  It is supposed to be easily modified
 for your specific needs.  We will of course continue to move generic
 code out of the sample as the project evolves.  Think of sample.py as
 an active config file.
 <p>
 <li> Q. Why does sendmail coredump with milters on OpenBSD?
 <p>  A. Sendmail has a problem with unix sockets on OpenBSD.  Use
 an internet domain socket instead.  For example, in <code>sendmail.cf</code> use
 <pre>
 Xpythonfilter, S=inet:1234@localhost
 </pre>
 and change sample.py accordingly.
 <p>
 <li> Q. How can I change the bounce message for an invalid recipient?
 I can only change the recipient in the eom callback, but the eom callback
 is never called when the recipient is invalid!
 <p>  A. Configure sendmail to use virtusertable, and send all unknown
 addresses to /dev/null.  For example,
 <h4>/etc/mail/virtusertable</h4>
 <pre>
@mycorp.com	dev-null
 dan@mycorp.com	dan
 sally@mycorp.com	sally
 </pre>
 <h4>/etc/aliases</h4>
 <pre>
 dev-null:	/dev/null
 </pre>
 Now your milter will get to the eom callback, and can change the
 envelope recipient at will.  Thanks to Dredd at 
 <a href=http://www.milter.org/>milter.org</a> for this solution.
 <p>
 <li> Q. I am having trouble with the setreply method.  It always outputs
 	"milter.error: cannot set reply".
 <p>  A. Check the sendmail log for errors.  If sendmail is getting
 milter timeouts, then your milter is taking too long and sendmail gave
 up waiting.  You can adjust the timeouts in your sendmail config.  Here
 is a milter declaration for sendmail.cf with all timeouts specified:
 <pre>
 Xpythonfilter, S=local:/var/log/milter/pythonsock, F=T, T=C:5m;S:20s;R:60s;E:5m
 </pre>
 <a name="spf">
 <li> Q. So how do I use the SPF support?  The sample.py milter doesn't seem
        to use it.
 <p>  A. The bms.py milter supports spf.  The RedHat RPMs will set almost
 everything up for you.  For other systems:
 <ol type=i>
 <li> Arrange to run bms.py in the background (as a service perhaps) and
     redirect output and errors to a logfile.  For instance, on AIX you'll want
     to use SRC (System Resource Controller).  
 <li> Copy milter.cfg to the directory you run bms.py in, and edit it.  The
     comments should explain the options. 
 <li> Start bms.py in the background as arranged.
 <li> Add Xpythonfilter to sendmail.cf or add an INPUT_MAIL_FILTER to
     sendmail.mc.  Regen sendmail.cf if you use sendmail.mc and restart 
     sendmail.
 <li> Arrange to rotate log files and remove old defang files in 
     <code>tempdir</code>.  The RedHat RPM uses <code>logrotate</code> for
     logfiles and a simple cron script using <code>find</code> to clean
     <code>tempdir</code>.
 </ol>
 </ol>
 </html>
@@ -0,0 +1,138 @@
 ## To roll your own milter, create a class that extends Milter.  
 #  See the pymilter project at http://bmsi.com/python/milter.html
 #  based on Sendmail's milter API http://www.milter.org/milter_api/api.html
 #  This code is open-source on the same terms as Python.
 ## Milter calls methods of your class at milter events.
 ## Return REJECT,TEMPFAIL,ACCEPT to short circuit processing for a message.
 ## You can also add/del recipients, replacebody, add/del headers, etc.
 import Milter
 import StringIO
 import time
 import email
 from socket import AF_INET, AF_INET6
 from Milter import parse_addr
 class myMilter(Milter.Milter):
  def __init__(self):  # A new instance with each new connection.
    self.id = Milter.uniqueID()  # Integer incremented with each call.
  # each connection runs in its own thread and has its own myMilter
  # instance.  Python code must be thread safe.  This is trivial if only stuff
  # in myMilter instances is referenced.
  def connect(self, IPname, family, hostaddr):
    # (self, 'ip068.subnet71.example.com', AF_INET, ('215.183.71.68', 4720) )
    # (self, 'ip6.mxout.example.com', AF_INET6,
    #	('3ffe:80e8:d8::1', 4720, 1, 0) )
    self.IP = hostaddr[0]
    self.port = hostaddr[1]
    if family == AF_INET6:
      self.flow = hostaddr[2]
      self.scope = hostaddr[3]
    else:
      self.flow = None
      self.scope = None
    self.IPname = IPname  # Name from a reverse IP lookup
    self.H = None
    self.fp = None
    self.receiver = self.getsymval('j')
    self.log("connect from %s at %s" % (IPname, hostaddr) )
    return Milter.CONTINUE
  ##  def hello(self,hostname):
  def hello(self, heloname):
    # (self, 'mailout17.dallas.texas.example.com')
    self.H = heloname
    self.log("HELO %s" % heloname)
    if heloname.find('.') < 0:	# illegal helo name
      # NOTE: example only - too many real braindead clients to reject on this
      self.setreply('550','5.7.1','Sheesh people!  Use a proper helo name!')
      return Milter.REJECT
    return Milter.CONTINUE
  ##  def envfrom(self,f,*str):
  def envfrom(self, mailfrom, *str):
    self.F = mailfrom
    self.R = []  # list of recipients
    self.fromparms = Milter.dictfromlist(str)	# ESMTP parms
    self.user = self.getsymval('{auth_authen}')	# authenticated user
    self.log("mail from:", mailfrom, *str)
    self.fp = StringIO.StringIO()
    self.canon_from = '@'.join(parse_addr(mailfrom))
    self.fp.write('From %s %s\n' % (self.canon_from,time.ctime()))
    return Milter.CONTINUE
  ##  def envrcpt(self, to, *str):
  def envrcpt(self, recipient, *str):
    rcptinfo = to,Milter.dictfromlist(str)
    self.R.append(rcptinfo)
    return Milter.CONTINUE
  def header(self, name, hval):
    self.fp.write("%s: %s\n" % (name,hval))	# add header to buffer
    return Milter.CONTINUE
  def eoh(self):
    self.fp.write("\n")				# terminate headers
    return Milter.CONTINUE
  def body(self, chunk):
    self.fp.write(chunk)
    return Milter.CONTINUE
  def eom(self):
    self.fp.seek(0)
    msg = email.message_from_file(self.fp)
    self.setreply('250','2.5.1','Grokked by pymilter')
    # many milter functions can only be called from eom()
    # example of adding a Bcc:
    self.addrcpt('<%s>' % 'spy@example.com')
    return Milter.ACCEPT
  def close(self):
    # always called, even when abort is called.  Clean up
    # any external resources here.
    return Milter.CONTINUE
  def abort(self):
    # client disconnected prematurely
    return Milter.CONTINUE
  ## === Support Functions ===
  def log(self,*msg):
    print "%s [%d]" % (time.strftime('%Y%b%d %H:%M:%S'),self.id),
    # 2005Oct13 02:34:11 [1] msg1 msg2 msg3 ...
    for i in msg: print i,
    print
 ## ===
 def main():
  # Register to have the Milter factory create instances of your class:
  Milter.factory = myMilter
  flags = Milter.CHGBODY + Milter.CHGHDRS + Milter.ADDHDRS
  flags += Milter.ADDRCPT
  flags += Milter.DELRCPT
  Milter.set_flags(flags)       # tell Sendmail which features we use
  print "%s milter startup" % time.strftime('%Y%b%d %H:%M:%S')
  sys.stdout.flush()
  Milter.runmilter("pythonfilter",socketname,timeout)
  print "%s bms milter shutdown" % time.strftime('%Y%b%d %H:%M:%S')
 if __name__ == "__main__":
  main()
@@ -1,122 +0,0 @@
 # features intended to filter or block incoming mail
 [milter]
 ;socket=/var/run/milter/pythonsock
 tempdir = /var/log/milter/save
 ;timeout=600
 scan_rfc822 = 1
 # can be CPU intensive
 scan_html = 0
 # reject asian fonts because we can't read them
 block_chinese = 1
 # users who hate forwarded mail
 ;block_forward = egghead@mycorp.com, busybee@mycorp.com
 log_headers = 0
 # Reject mail for domains mentioned unless user is mentioned here also
 ;check_user = joe@mycorp.com, mary@mycorp.com, file:bigcorp.com
 # porn words are case insensitive
 porn_words = penis, breast, pussy, horse cock, porn, xenical, diet pill, d1ck,
 	vi*gra, vi-a-gra, viag, tits, p0rn, hunza, horny, sexy, c0ck,
 	p-e-n-i-s, hydrocodone, vicodin, xanax, vicod1n, x@nax, diazepam,
 	v1@gra, xan@x, cialis, ci@lis, frëe, xãnax, valíum, vãlium, via-gra,
 	x@n3x, vicod3n, penís, c0d1n, phentermine, en1arge, dip1oma, v1codin
 # spam words are case sensitive
 spam_words = $$$, !!!, XXX, FREE, HGH
 # connection ips and hostnames are matched against this glob style list
 # to recognize internal senders
 ;internal_connect = 192.168.*.*
 # mail that is not an internal_connect and claims to be from an
 # internal domain is rejected.
 ;internal_domains = mycorp.com
 # connections from a trusted relay can trust the first Received header
 ;trusted_relay = 1.2.3.4, 66.12.34.56
 # reject external senders with hello names no legit external sender would use
 ;hello_blacklist = mycorp.com, 66.12.34.56
 [srs]
 config=/etc/mail/pysrs.cfg
 ;secret="shhhh!"
 ;maxage=21
 ;hashlength=4
 ;database=/var/log/milter/srsdata
 ;fwdomain = mydomain.com
 # turn this on after a grace period
 reject_spoofed = 0
 [spf]
 # namespace where SPF records can be supplied for domains without one
 # records are search for under _spf.domain.com
 ;delegate = domain.com
 # domains where a neutral SPF result should cause mail to be rejected
 ;reject_neutral = aol.com
 # use a default (v=spf1 a/24 mx/24 ptr) when no SPF records are published
 ;best_guess = 0
 # reject senders that have neither PTR nor SPF records
 ;reject_noptr = 0
 # features intended to clean up outgoing mail
 [scrub]
 # domains that stupidly block visible private nodes
 ;hide_path = jcpenney.com	
 # block, don't just replace with warning, viruses from these domains
 ;reject_virus_from = mycorp.com
 # features intended for spying on users and coworkers
 [wiretap]
 blind = 1
 #
 # wiretap lets you surreptitiously monitor a users outgoing email
 # (sendmail aliases let you monitor incoming mail)
 #
 ;users = disloyal@bigcorp.com, bigmouth@bigcorp.com
 ;dest = spy@bigcorp.com
 # discard outgoing mail without alerting sender
 # can be used in conjunction with wiretap to censor outgoing mail
 ;discard_users = canned@bigcorp.com
 #
 # smart aliases trigger on both sender and recipient
 #
 ;smart_alias = copycust,walter
 # mail from client@clientcorp.com to sue@bigcorp.com is redirected to 
 # local alias copycust
 ;copycust = client@clientcorp.com,sue@bigcorp.com
 # mail from cust@othercorp.com to walter@bigcorp.com is redirected to
 # boss@bigcorp.com
 ;walter = cust@othercorp.com,walter@bigcorp.com,boss@bigcorp.com
 # additional copies can be added
 ;walter1 = cust@othercorp.com,walter@bigcorp.com,boss@bigcorp.com,
 ;	walter@bigcorp.com
 [dspam]
 # Select a well moderated dspam dictionary to reject spammy headers
 # dspam-python must be installed to use: http://bmsi.com/python/dspam.html
 # only EXTERNAL messages are dspam filtered
 ;dspam_dict=/var/lib/dspam/moderator.dict
 # Opt-opt recipients from dspam screening and header triage
 ;dspam_exempt=getitall@mycorp.com
 # Do not scan mail (ostensibly) from these senders
 ;dspam_whitelist=getitall@sender.com
 # Reject spam to these domains, perhaps because we are a backup MX server
 ;dspam_reject=othercorp.com
 # directory for dspam user quarantine, signature db, and dictionaries
 # defining this activates the dspam application
 # dspam and dspam-python must be installed
 ;dspam_userdir=/var/lib/dspam
 # do not dspam messages larger than this
 ;dspam_sizelimit=180000
 # Map email addresses and aliases to dspam users
 ;dspam_users=david,goliath,spam,falsepositive
 ;david=david@foocorp.com,david.yelnetz@foocorp.com,david@bar.foocorp.com
 ;goliath=giant@foocorp.com,goliath.philistine@foocorp.com
 # address to forward spam to.  milter will process these and not deliver
 ;spam=spam@foocorp.com
 # address to forward false positives to.  milter will process and not deliver
 ;falsepositive=ham@foocorp.com
 # the dspam_screener is used to screen mail for all recipients who are
 # not dspam_users.  Spam goes to the screeners quarantine, and the original
 # recipients saved so that false positives can be properly delivered.
 # The dspam CGI can also be used: logins must match dspam users
@@ -1,646 +0,0 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <title>Python Milters</title>
 </head><body>
 <P ALIGN="CENTER"><A HREF="http://www.anybrowser.org/campaign/">
 <IMG SRC="/art/brain1.gif"
 ALT="Viewable With Any Browser" BORDER="0"></A>
 <img src="/art/banner_4.gif" width="468" height="60" border="0"
 	usemap="#banner_4" alt="Your vote?">
 <map name="banner_4">
  <area shape="rect" coords="330,25,426,59"
  	href="http://www.sepschool.org/survey/" alt="I Disagree">
  <area shape="rect" coords="234,28,304,57" href="http://sepschool.org/" alt="I Agree">
 </map>
 </P>
 <h1 align=center>Sendmail Milters in Python</h1>
 <h4 align=center>by <a href="mailto:%75%72%6D%61%6E%65%40%6E%65%75%72%61l%61%63%63%65%73%73%2E%63%6F%6D">Jim Niemira</a>
  and <a href="mailto:%73%74%75%61%72%74%40%62%6D%73%69%2E%63%6F%6D">
  Stuart D. Gathman</a><br>
 This web page is written by Stuart D. Gathman<br>and<br>sponsored by
 <a href="http://www.bmsi.com">Business Management Systems, Inc.</a> <br>
 Last updated Jun 08, 2004</h4>
 See the <a href="faq.html">FAQ</a> | <a href="#download">Download now</a> |
 <a href="/mailman/listinfo/pymilter">Subscribe to mailing list</a>
 <p>
 <img src="python55.gif" align=left alt="A Python">
 <a href="//www.sendmail.org/">Sendmail</a> introduced a
 <a href="http://www.milter.org/milter_api/api.html"> new API</a> beginning with version 8.10 -
 libmilter.  The milter module for <a href="//www.python.org">Python</a>
 provides a python interface to libmilter that exploits all its features.
 <p>
 Sendmail 8.12 officially releases libmilter.  
 Version 8.12 seems to be more robust, and includes new privilege
 separation features to enhance security.
 I recommend upgrading.
 <h2> Recent Changes </h2>
 Release 0.6.6 adds support for <a href="http://spf.pobox.com/">SPF</a>,
 a protocol to prevent forging of the envelope from address.  
 SPF support requires <a href="http://pydns.sourceforge.net/">pydns</a>.
 The included spf.py module is an updated version of the original 1.6
 version at <a href="http://www.wayforward.net/spf/">wayforward.net</a>.
 The updated version tracks the draft RFC and test suite.
 <p>
 The FAQ addresses <a href="faq.html#spf">how to get started with SPF</a>.
 <p>
 Release 0.6.1 adds a full milter based dspam application.
 <p>
 I have selected the <a href="http://www.nuclearelephant.com/projects/dspam/">
 dspam bayes filter project</a> and <a href="dspam.html">
 packaged it for python</a>.
 Release 0.6.0 offers a simple application of dspam I call "header triage",
 which rejects messages with spammy headers.  
 To use header triage, you must have <a href="dspam.html">DSPAM</a> installed,
 and select a dictionary that is well moderated by someone who gets
 lots of spam.  That dictionary can be used to block spam that is 
 obvious from the headers (e.g. X-Mailer and Subject) before it ties
 up any more resources.  I have yet to see any false positives from this
 approach (check the milter log), but if there are, the sender will
 get a REJECT with the message "Your message looks spammy."
 <h2> Enough Already! </h2>
 Nearly a dozen people have emailed me begging for a feature to copy
 outgoing and/or incoming mail to a backup directory by user.  Ok, it
 looks like this is a most requested feature for 0.5.6.  In the meantime,
 here are some things to consider:
 <ul>
 <li> If you want to equivalent of a Bcc added to each message, this
 is very easy to do in the python code for bms.py.   See below.
 <li> If you want to copy to a file in a directory (thus avoiding having to
 set up aliases), this is slightly more involved.  The bms.py milter already
 copies the message to a temporary file for use in replacing the message body
 when banned attachments are found.  You have to open a file, and copy the
 Mesage object to it in eom().
 <li> Finally, you are probably aware that most email clients already
 keep a copy of outgoing mail?  Presumably there is a good reason for
 keeping another copy on the server.
 </ul>
 <p>
 To Bcc a message, call <code>self.add_recipient(rcpt)</code> in envfrom after
 determining whether you want to copy (e.g. whether the sender is local).  For
 example,
 <pre>
  def envfrom(...
    ...
    if len(t) == 2:
      self.rejectvirus = t[1] in reject_virus_from
      if t[0] in wiretap_users.get(t[1],()):
 	self.add_recipient(wiretap_dest)
      if t[1] == 'mydomain.com':
        self.add_recipient('&lt;copy-%s&gt;' % t[0])
      ...
 </pre>
 <p>
 To make this a generic feature requires thinking about how the configuration
 would look.  Feel free to make specific suggestions about config file
 entries.  Be sure to handle both Bcc and file copies, and designating what
 mail should be copied.  How should "outgoing" be defined?  Implementing it is
 easy once the configuration is designed.
 <h3>Overview</h3>
 This package provides a robust toolkit for Python <a
 href="#milter">milters</a>, and the beginnings of a general purpose mail
 filtering system written in Python.
 <p>
 At the lowest level, the 'milter' module provides a thin wrapper around the
 <a href="http://www.milter.org/milter_api/api.html">
 sendmail libmilter API</a>.  This API lets you register callbacks for 
 a number of events in the
 <a href="http://www.cs.concordia.ca/~group/fig/public/email/relay/milter+ruleset-checks.html">process of sendmail receiving a message via SMTP</a>.  
 These events include the initial connection from a MTA,
 the envelope sender and recipients, the top level mail headers, and
 the message body.  There are options to mangle all of these components
 of the message as it passes through the milter.
 <p>
 At the next level, the 'Milter' module (note the case difference) provides a
 Python friendly object oriented wrapper for the low level API.  To use the
 Milter module, an application registers a 'factory' to create an object
 for each connection from a MTA to sendmail.  These connection objects
 must provide methods corresponding to the libmilter callback events.
 <p>
 Each event method returns a code to tell sendmail whether to proceed
 with processing the message.  This is a big advantage of milters over
 other mail filtering systems.  Unwanted mail can be stopped in its
 tracks at the earliest possible point.
 <p>
 The Milter.Milter class provides default implementations for event
 methods that
 do nothing, and also provides wrappers for the libmilter methods to mutate
 the message.
 <p>
 Finally, the bms.py application is both a sample of how to use the
 Milter module, and the beginnings of a general purpose SPAM filtering,
 wiretapping, and Win32 virus protection milter.
 <h3><a name=download>Downloading</a></h3>
 The latest stable release is <a href="#stable">0.6.9</a>. A stable
 release is one which has been installed (and working correctly) on
 production systems long enough to convince me that it is stable.  As
 the package gains more features and complexity, stable will mean no
 bug reports from outside users either.
 <p>
 The latest version is 0.6.9-1.  See the <a href=NEWS>Change Log</a>.
 <p>
 <a name="stable"><b>Stable</b></a>
 <a href="http://bmsi.com/python/milter-0.6.9.tar.gz">
 milter-0.6.9.tar.gz</a> Add SPF test suite driver, and validate
 spf.py against test suite.  Add best_guess and get_header to spf.py.
 Libmilter timeout option in config.
 <br>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.9-1.i386.rpm">
 milter-0.6.9-1.i386.rpm</a> Binary RPM for Redhat 7.x, now requires 
 	sendmail-8.12 and <a href="http://www.python.org/2.3.3/rpms.html">
 	python2.3</a>.
 <br>
 <a href="http://bmsi.com/linux/rh9/milter-0.6.9-1.src.rpm">
 milter-0.6.9-1.src.rpm</a> Source RPM for Redhat 9,7.x.  
 <p>
 <a href="http://bmsi.com/python/milter-0.6.8.tar.gz">
 milter-0.6.8.tar.gz</a> Include Received-SPF headers in Dspam analysis.
 Fix sysv init for Redhat 9 and later.  Reject bounces with multiple
 recipients.
 <br>
 <a href="http://bmsi.com/python/milter-0.6.8.patch">milter-0.6.8.patch</a>
 Last minutes fixes from production testing.
 <p>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.8-3.i386.rpm">
 milter-0.6.8-3.i386.rpm</a> Binary RPM for Redhat 7.x, now requires 
 	sendmail-8.12 and <a href="http://www.python.org/2.3.3/rpms.html">
 	python2.3</a>. 
 <br>
 <a href="http://bmsi.com/linux/rh9/milter-0.6.8-3.src.rpm">
 milter-0.6.8-3.src.rpm</a> Source RPM for Redhat 9,7.x.  
 <p>
 <a href="http://bmsi.com/python/milter-0.6.7.tar.gz">
 milter-0.6.7.tar.gz</a> Explicit local socket bug,
 <a href="http://spf.pobox.com/srs.html">SRS</a> forgery detection,
 thread resource starvation detection.
 SRS support requires <a href="http://bmsi.com/python/pysrs.html">pysrs</a>.
 <p>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.7-3.i386.rpm">
 milter-0.6.7-3.i386.rpm</a> Binary RPM for Redhat 7.x, now requires 
 	sendmail-8.12 and <a href="http://www.python.org/2.3.3/rpms.html">
 	python2.3</a>. 
 <br>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.7-3.src.rpm">
 milter-0.6.7-3.src.rpm</a> Source RPM for Redhat 7.x. 
 Release 0.6.7-3 patches:
 <ul>
 <li> Defang message/rfc822 content_type with boundary 
 <li> Support SPF delegation
 <li> Reject neutral SPF result for selected domains
 </ul>
 <p>
 <a href="http://bmsi.com/python/milter-0.6.6.tar.gz">
 milter-0.6.6.tar.gz</a> Plug another memory leak, 
 <a href="http://spf.pobox.com/">SPF</a> support, hello blacklist.
 SPF support requires <a href="http://pydns.sourceforge.net/">pydns</a>.
 NOTE - the spf.py module included is modified from the official 1.6
 version at <a href="http://www.wayforward.net/spf/">wayforward.net</a>.
 I neglected to add the CVS log.  The changes are expanded result codes
 and tolerating common method misspellings in SPF records.  I have notified the
 author, but haven't heard back.  At some point, the RPM will
 include the official pyspf tarball and apply patches.
 <p>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.6-2.i386.rpm">
 milter-0.6.6-2.i386.rpm</a> Binary RPM for Redhat 7.x, now requires 
 	sendmail-8.12 and <a href="http://www.python.org/2.3.3/rpms.html">
 	python2.3</a>.  Release 2 fixes sysv init script bug for python2.3.
 <br>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.6-2.src.rpm">
 milter-0.6.6-2.src.rpm</a> Source RPM for Redhat 7.x
 <p>
 <a href="http://bmsi.com/python/milter-0.6.5.tar.gz">
 milter-0.6.5.tar.gz</a> Plug memory leak, progress reporting, trusted relay.
 Redhat RPM now requires sendmail-8.12.
 <p>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.5-2.i386.rpm">
 milter-0.6.5-2.i386.rpm</a> Binary RPM for Redhat 7.x
 <br>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.5-2.src.rpm">
 milter-0.6.5-2.src.rpm</a> Source RPM for Redhat 7.x
 <p>
 <a href="http://bmsi.com/python/milter-0.6.4.tar.gz">
 milter-0.6.4.tar.gz</a> Numerous Dspam fixes.  Requires
 <a href="dspam.html">pydspam-1.1.5</a> and 
 <a href="/libdspam/dspam.html">dspam-2.6.5.2</a>
 for Dspam features.  The dspam-python RPM has been replaced by pydspam.
 <p>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.4-1.i386.rpm">
 milter-0.6.4-1.i386.rpm</a> Binary RPM for Redhat 7.x
 <p>
 <a href="http://bmsi.com/python/milter-0.6.3.1.tar.gz">
 milter-0.6.3.1.tar.gz</a> New dspam SCREENER feature with pydspam-1.1.4.
 Don't save a defang copy of false positives.  Fixed an oops from last fix,
 rejecting false positives.  BUG: sendmail-8.11 doesn't invoke milter
 when sending mail via sendmail from command line (8.12 works).  Therefore,
 the supplied falsepositive script for milter based dspam doesn't work
 with stock RedHat 7.x.  I am writing a HOWTO for configuring milter
 based dspam that will address this (and a fix in the next version).
 <p>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.3-1.i386.rpm">
 milter-0.6.3-1.i386.rpm</a> Binary RPM for Redhat 7.x
 <p>
 <a href="http://bmsi.com/python/milter-0.6.2.tar.gz">
 milter-0.6.2.tar.gz</a> work around email.Message.get_filename bug,
 dspam_exempt list, REJECT messages with missing MIME boundaries (which
 are almost always spam),
 DISCARD messages which any dspam user flags as spam,
 start.sh was calling python instead of python2 on Linux.
 <p>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.2-1.src.rpm">
 milter-0.6.2-1.src.rpm</a> Source RPM for Redhat 7.x (and likely
 higher versions)
 <p>
 <a href="http://bmsi.com/python/milter-0.6.1.tar.gz">
 milter-0.6.1.tar.gz</a> dspam milter application, python-2.2.3 support.
 <p>
 You must have <a href=dspam.html>dspam and dspam-python</a> loaded for
 the dspam feature to work.  Brief instructions for configuring are
 in the default config file.  This is working at a customer, but I'm
 sure a few more iterations will be required to make setup as smooth
 as possible.
 <p>
 NOTE: Outlook destroys dspam tags when forwarding mail (while converting
 HTML to text).  Perhaps some config option will turn this abominable
 "feature" off.  Working around this by making dspam tags visble on
 HTML mail is ugly.  My suggestion is to not use Outlook, for this and
 many other reasons - especially security.  Any other suggestions for
 those married to Microsoft are welcome.  The DSPAM LDA works around this
 by making the tags visible in HTML attachments.  This is ugly, and
 occasionally corrupts attachments.
 <p>
 We have to supply workarounds for bugs in the email module (reported
 to sourceforge).  The workarounds reference some internal variables
 which change with python versions.
 <p>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.1-1.i386.rpm">
 milter-0.6.1-1.i386.rpm</a> Binary RPM for Redhat 7.x
 <p>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.1-1.src.rpm">
 milter-0.6.1-1.src.rpm</a> Source RPM for Redhat 7.x (and likely
 higher versions)
 <p>
 <a href="http://bmsi.com/python/milter-0.6.0.tar.gz">
 milter-0.6.0.tar.gz</a> simple dspam pre-filtering, use email module,
 requires python &gt;= 2.2.2.  
 <ul>
 <li> The milter.so module from 0.5.4
 is needed to run this release on AIX.  Haven't tracked this down yet.
 <li> The patches to fix the email packages in mime.py don't work
 on python-2.2.3.  The email package is still broken in 2.3, and patches
 required for that will likely be different still.
 </ul>
 <p>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.0-1.i386.rpm">
 milter-0.6.0-1.i386.rpm</a> Binary RPM for Redhat 7.x
 <p>
 <a href="http://bmsi.com/linux/rh72/milter-0.6.0-1.src.rpm">
 milter-0.6.0-1.src.rpm</a> Source RPM for Redhat 7.x (and likely
 higher versions)
 <p>
 <a href="http://www.bmsi.com/python/milter-0.5.5.tar.gz">
 milter-0.5.5.tar.gz</a> IPV6 support, passing None to set_XXX_callback,
 set_reply, chg_header, detect internal connections.  Note, this release
 did not work on AIX4.1.5, probably due to IPV6 support breaking something.
 The milter.so module from 0.5.4 can be installed to use this release 
 with AIX.
 <p>
 <a href="http://www.bmsi.com/python/milter-0.5.4.tar.gz">
 milter-0.5.4.tar.gz</a> wiretap, smart alias features, quarantine support.
 <p>
 The name of the production "sample" milter "bms.py" now
 stands for "Basic Milter System" until someone suggests a better name.
 The test coverage is rather
  sparse at present.  
  Please <a href="mailto:%73%74%75%61%72%74%40%62%6D%73%69%2E%63%6F%6D">email</a> with proposals for what
  to name the milter application.
 <h4>NOTES</h4>
 <ul>
 <li>
  Quarantine support requires that you define _FFR_QUARANTINE 
  when compiling miltermodule.c.  I am not sure how to make setup.py
  do that for you iff sendmail was actually compiled with _FFR_QUARANTINE.
 <li>
  While 0.6.0 will use the new email package in Python-2.2, that
  package seems to be buggy in Python-2.2.1.  The list example in the docs
  doesn't find all MIME parts.  Update: Python-2.2.2 has fixed the email
  package.  It can now parse my test cases.
 <li>
  Preliminary testing with python-2.2 shows that most things work after
  adding <code>self.readahead = ""</code> to <code>mimepart.seek</code>.
  Python-2.2 <code>multifile</code> reads one less newline per section than
  2.1.  I'm not not sure which is correct.  After adding some calls to
  <code>rstrip()</code> in testmime.py, all milter modules pass unit testing
  with python-2.2.  Python-2.2 patches have been released since 0.5.3.
 <li>
  sgmlop-1.1a3 has a memory leak (at least Python milter has a
  memory leak when using sgmlop instead of sgmllib).  Do not make Python
  milter use sgmlop-1.1a2 or a3 in a production
  system unless you can restart your milter periodically.  The amount
  of memory leaked seems roughly proportional to the amount of HTML
  parsed.
 <li>
  There are a number of ways that malformed MIME attachments
  can cause a python traceback.  Uncaught exceptions cause a 415
  error to be returned to sendmail.  So far, all the malformed messages
  I've investigated have been SPAM - so good riddance.  I would prefer,
  however, that the mime handling libraries were more precise.  Beginning
  with 0.5.1, bms.py will save messages that cause a traceback during
  scanning in the tempfile directory with a ".fail" extension.  This
  makes it easier to get samples of mail that causes parsing problems
  for incorporation into the unit tests.
 </ul>
 <p>
 <a href="http://www.bmsi.com/python/milter-0.5.2.tar.gz">
 milter-0.5.2.tar.gz</a> Fix and unittest another HTML parsing bug.<br>
 <a href="http://www.bmsi.com/python/milter-0.5.1.tar.gz">
 milter-0.5.1.tar.gz</a> Handle encoded rfc822 attachments.<br>
 <a href="http://www.bmsi.com/python/milter-0.5.0.tar.gz">
 milter-0.5.0.tar.gz</a> Use a config file so users don't have to
 keep syncing with bms.py.  <br>
 <a href="http://www.bmsi.com/python/milter-0.4.5.tar.gz">
 milter-0.4.5.tar.gz</a> Work with sgmlop. Reduce local hacks to config variables.
 <p>
 Python milter is under GPL.  The authors can probably be convinced to
 change this to LGPL.
 <h3>What is a <a name="milter">milter</a>?</h3>
 Milters can run on the same machine as sendmail, or another machine.  The
 milter can even run with a different operating system or processor than
 sendmail.
 Sendmail talks to the milter via a local or internet socket.
 Sendmail keeps the
 milter informed of events as it processes a mail connection.  At any 
 point, the milter can cut the conversation short by telling sendmail
 to ACCEPT, REJECT, or DISCARD the message.  After receiving a complete
 message from sendmail, the milter can again REJECT or DISCARD it, but it
 can also ACCEPT it with changes to the headers or body.
 <h3> What can you do with a milter? </h3>
 <menu>
 <li> A milter can DISCARD or REJECT spam based based on algorithms scripted
 in python rather than sendmail's cryptic "cf" language.
 <li> A milter can alter or remove attachments from mail that are poisonous to
 Windows.
 <li> A milter can scan for viruses and clean them when detected.
 <li> A milter scans outgoing as well as incoming mail.
 <li> A milter can add and delete recipients to forward or secretly
 copy mail.
 <li> For more ideas, check the <a href="//www.milter.org">Milter Web Page</a>.
 </menu>
 <a href="http://www.milter.org/milter_api/api.html">
 Documentation</a> for the C API is provided with sendmail.  Miltermodule
 provides a thin python wrapper for the C API.  Milter.py provides a simple
 OO wrapper on top of that.
 <p>
 The Python milter package includes a sample milter that replaces dangerous 
 attachments with a warning message, discards mail addressed to
 MAILER-DAEMON, and demonstrates several SPAM abatement strategies.  
 The MimeMessage class to do this used to be based on the
 <code>mimetools</code> and <code>multifile</code> standard python packages.  
 As of milter version 0.6.0, it is based on the email standard
 python packages, which were derived from the 
 <a href="http://sourceforge.net/projects/mimelib">mimelib</a> project.
 The MimeMessage class patches several bugs in the email package,
 and provides some backward compatibility.
 <p>
 The "defang" function of the sample milter was inspired by
 <a href="http://www.roaringpenguin.com/mimedefang/">MIMEDefang</a>,
 a Perl milter with flexible attachment processing options.  The latest
 version of MIMEDefang uses an apache style process pool to avoid reloading
 the Perl interpreter for each message.  This makes it fast enough for
 production and does not use Perl threading.
 <p>
 <a href="http://sourceforge.net/projects/mailchecker">mailchecker</a> is
 a Python project to provide flexible attachment processing for mail.  I
 will be looking at plugging mailchecker into a milter.
 <p>
 <a href="http://software.libertine.org/tmda/">TMDA</a> is a Python project
 to require confirmation the first time someone tries to send to your
 mailbox.  This would be a nice feature to have in a milter.
 <p>
 There is also a <a href="http://www.milter.org/">Milter community website</a>
 where milter software and gory details of the API are discussed.
 <h3> Is a milter written in python efficient? </h3>
 The python milter process is multi-threaded and startup cost is incurred
 only once.  This is much more efficient than some implementations that
 start a new interpreter for each connection.  Testing in a production
 environment did not use a significant percentage of the CPU.  Furthermore,
 python is easily extended in C for any step requiring expensive CPU
 processing.
 <p>
 For example, the HTML parsing feature to remove scripts from HTML attachments
 is rather CPU intensive in pure python.  Using the C replacement for sgmllib
 greatly speeds things up.
 <h3> Goals </h3>
 <menu>
 <li> Implement RRS - a backdoor for non-SRS forwarders.  User lists non-SRS 
     forwarder accounts (perhaps in <code>~/.forwarders</code>), and a util
     provides a special local alias for the user to give to the forwarder.
     Alias only works for mail from that forwarder.  Milter gets forwarder
     domain from alias and uses it to SPF check forwarder.  Requires
     milter to have read access to <code>~/.forwarders</code> or else
     a way for user to submit entries to milter database.
 <li> The bms.py milter has too many features.  Create a framework where
     numerous small feature modules can be plugged together in the
     configuration.
 <li> Create a pure python substitute for miltermodule and libmilter that
     implements the <a
 href="http://www.duh.org/cvsweb.cgi/~checkout~/pmilter/doc/milter-protocol.txt?rev=1">
     libmilter protocol</a> in python. 
 <li> Find or write a faster implementation of sgmllib.  The 
     <a href="http://www.effbot.org/zone/sgmlop-index.htm">sgmlop package</a>
     is not very compatible with 
     <a href="http://www.python.org/doc/2.1.3/lib/module-sgmllib.html">
     Python-2.1 sgmllib</a>, but it is a start, and is supported in
     milter-0.4.5 or later.
 <li> Implement all or most of the features of 
     <a href="http://www.roaringpenguin.com/mimedefang/">MIMEDefang</a>.
 <li> Follow the official <a href="http://www.python.org/peps/pep-0008.html">
     Python coding standards</a> more closely.
 <li> Make unit test code more like other python modules.
 </menu>
 <h3> Confirmed Installations </h3>
 Please <a href="mailto:%73%74%75%61%72%74%40%62%6D%73%69%2E%63%6F%6D">email</a>
 me if you successfully install milter on a system not mentioned below.
 <p>
 <table>
 <tr>
 <th>Operating System</th> <th>Compiler</th> <th>Python</th> <th>Sendmail</th>
 <th>milter</th>
 <tr>
 <td>Mandrake 8.0</td><td>gcc-3.0.1</td><td>2.1.1</td><td>8.12.0</td>
 <td>0.3.3</td><tr>
 <td>Mandrake 8.0</td><td>gcc-2.96</td><td>2.0</td><td>8.11.2</td>
 <td>0.3.6</td><tr>
 <td>RedHat 6.2</td><td>egcs-1.1.2</td><td>2.2.2</td><td>8.11.6</td>
 <td>0.5.4</td><tr>
 <td>RedHat 7.1</td><td>gcc-2.96</td><td>?</td><td>8.12.1</td>
 <td>0.3.5</td><tr>
 <td>RedHat 7.2</td><td>gcc-2.96</td><td>2.1.1</td><td>8.11.6</td>
 <td>0.4.1</td><tr>
 <td>RedHat 7.2</td><td>gcc-2.96</td><td>2.2.1</td><td>8.11.6</td>
 <td>0.4.5</td><tr>
 <td>RedHat 7.2</td><td>gcc-2.96</td><td>2.2.2</td><td>8.11.6</td>
 <td>0.5.5</td><tr>
 <td>RedHat 7.2</td><td>gcc-2.96</td><td>2.3.3</td><td>8.12.10</td>
 <td>0.6.6</td><tr>
 <td>RedHat 7.3</td><td>gcc-2.96</td><td>2.2.2</td><td>8.11.6</td>
 <td>0.5.5</td><tr>
 <td>RedHat 7.3</td><td>gcc-2.96</td><td>2.3.3</td><td>8.12.10</td>
 <td>0.6.6</td><tr>
 <td>RedHat 8.0</td><td>gcc-3.2</td><td>2.2.1</td><td>8.12.6</td>
 <td>0.5.2</td><tr>
 <td>Debian Linux</td><td>gcc-2.95.2</td><td>2.1.1</td><td>8.12.0</td>
 <td>0.3.7</td><tr>
 <td>Debian Linux</td><td>gcc-3.2.2</td><td>2.2.2</td><td>8.12.7</td>
 <td>0.5.4</td><tr>
 <td>AIX-4.1.5</td><td>gcc-2.95.2</td><td>2.1.1</td><td>8.11.5</td>
 <td>0.3.3</td><tr>
 <td>AIX-4.1.5</td><td>gcc-2.95.2</td><td>2.1.1</td><td>8.12.1</td>
 <td>0.3.4</td><tr>
 <td>AIX-4.1.5</td><td>gcc-2.95.2</td><td>2.1.3</td><td>8.12.3</td>
 <td>0.4.2</td><tr>
 <td>AIX-4.1.5</td><td>gcc-2.95.2</td><td>2.2.2</td><td>8.12.6</td>
 <td>0.5.4</td><tr>
 <td>Slackware 7.1</td><td>?</td><td>?</td><td>8.12.1</td>
 <td>0.3.8</td><tr>
 <td>Slackware 9.0</td><td>gcc-3.2.2</td><td>2.2.3</td><td>8.12.9</td>
 <td>0.5.4</td><tr>
 <td>OpenBSD</td><td>?</td><td>2.1.1</td><td>8.11.6</td>
 <td>0.3.9</td><tr>
 <td>SuSE 7.3</td><td>gcc-2.95.3</td><td>2.1.1</td><td>8.12.2</td>
 <td>0.3.9</td><tr>
 <td>FreeBSD</td><td>gcc-2.95.3</td><td>2.2.1</td><td>8.12.3</td>
 <td>0.4.0</td><tr>
 <td>FreeBSD</td><td>gcc-2.95.3</td><td>2.2.2</td><td>?</td>
 <td>0.5.5</td><tr>
 <td>FreeBSD 4.4</td><td>gcc-2.95.3</td><td>?</td><td>8.12.10</td>
 <td>0.6.6</td><tr>
 </table>
 <h3> Requirements </h3>
 <menu>
 <li> While the miltermodule will work with python 1.5, you probably
 want to use python 2.0 or better.  The python code uses a number of
 python 2 features.
 <li> Python must be configured with thread support.  This is because
 sendmail's libmilter requires thread support.
 <li> You must compile sendmail with libmilter enabled.  In versions of
 sendmail prior to 8.12 libmilter is marked FFR (For Future Release) and
 is not installed by default.  
 Sendmail 8.12 still does not enable libmilter by default.  You must 
 explicitly select the "MILTER" option when compiling.  
 <li> Python milter has been tested against sendmail-8.11 and sendmail-8.12.
 <li> Python milter must be compiled for the specific version of sendmail
 it will run with.  (Since the result is dynamically loaded, there could 
 conceivably be multiple versions available and selected at startup - but
 that will have to wait.)  This situation may only exist for sendmail
 versions prior to 8.12.  The protocol seems designed for backward 
 compatibility - and 8.12 is the first official milter release.
 <li> Mea Culpa!  After reading the Python Style guide, I realize that
 my Python code is not up to snuff.  Apparently mixed tabs and spaces
 are anathema to those using Windows editors, where tabs can be expanded using
 any arbitrary algorithm.  Other than that, my
 intuition matched Guido's pretty well - although I like to indent by 2
 rather than 4.  I will arrange to have tabs expanded to spaces when
 exporting new versions.  Until then, beware!
 </menu>
 <h3> <a name="aix4"> AIX 4.1.5 Requirements </a> </h3>
 To create sendmail RPMs for AIX, you can download my AIX 4.1.5 spec files 
 for <a href="/aix/sendmail.spec">sendmail-8.11.5</a> 
 or <a href="/aix/sendmail12.spec">sendmail-8.12.3</a>.  If you have
 not already set it up, I use a <a href="/aix/aix.spec">dummy RPM package</a>
 to represent the stuff that comes with AIX.  You might also want
 my <a href="/aix/python.spec">python-2.1.1</a> spec file for AIX.  It
 does not include Tk or curses modules, sorry.  If y'all trust me, you can
 download rpms for AIX 4.x from my <a href="/aix">AIX RPM directory</a>.
 <p>
 Sendmail-8.12 renames 
 libsmutil.a to libsm.a.  Unfortunately, libsm.a is an important AIX system
 shared library.  Therefore, I rename libsm.a back to libsmutil.a for
 AIX.  This presents a problem for setup.py.
 <h3> <a name="rh72"> RedHat 7.2 Requirements </a> </h3>
 If you are running Redhat 7.2, the distributed version of sendmail
 now enables libmilter by default.  RedHat 7.2 bundles
 the development libraries with the main sendmail package, so
 there is no sendmail-devel package.  However, they forgot to include the
 headers!  So you'll have to get the SRPM and modify it.  I suggest
 moving the static libs to a devel package and adding the headers.  If
 this is too much trouble, you can get the <a href="mfapi.h">mfapi.h</a>
 header for sendmail-8.6.11 from here and manually install it as
 <code>/usr/include/libmilter/mfapi.h</code>.
 <p>
 If you do modify the SRPM, I suggest renaming libsmutil.a
 to libsm.a - just like sendmail-8.12 will.  If you manually install
 mfapi.h or don't rename libsmutil.a, you'll
 need to force <code>libs = ["milter", "smutil"]</code> in setup.py.
 <p>
 If you have installed python2, and want
 python-milter to use python2, add <code>python=python2</code> to setup.cfg
 and build with <code>python2 setup.py bdist_rpm</code>.   
 <h3> <a name="rh62"> Redhat 6.2 Requirements </a> </h3>
 If you are running Redhat 6.2, the distributed version of sendmail
 does not enable libmilter.  You can download the Redhat 7.2 sendmail.spec
 modified to compile on RedHat 6.2:
 <a href="http://www.bmsi.com/linux/rh62/sendmail-rhmilter.spec">
 sendmail-rhmilter.spec</a>.  The <a
 href="ftp://updates.redhat.com/7.0/en/os/SRPMS/sendmail-8.11.6-1.7.0.src.rpm">
 SRPM for sendmail-8.11.6</a> is available from
 <a href="http://www.redhat.com">Redhat</a> under 
 <a href="http://www.redhat.com/support/errata/RHSA-2001-106.html">
 Errata for RH6.2</a>.  But that doesn't include the latest security
 patches since RH6.2 is no longer supported.
 <p>
 If y'all trust me, you can pick up source and binary sendmail RPMs for RH6.2
 from my <a href="http://www.bmsi.com/linux/rh62">linux downloads</a> directory.
 The lastest RPMs were built by taking a RH7.2 SRPMS and removing some
 RPM features from the spec file that RH6.2 doesn't support, then
 recompiling on RH6.2.  You can check this by installing the RH7.2 SRPM,
 then diffing my sendmail.spec with theirs.  Then run
 "rpm -bb sendmail-rhmilter.spec" when you are satisfied.
 <p>
 If you have installed python2, and want
 python-milter to use python2, add <code>python=python2</code> to setup.cfg
 and build with <code>python2 setup.py bdist_rpm</code>.
 You'll need to install the sendmail-devel package to compile milter.
 <hr>
 <p>
 <a href="http://validator.w3.org/check/referer">
 <img border=0 src="/vh32.png" alt=" [ Valid HTML 3.2! ] " height=31 width=88></a>
 <a href="http://www.redhat.com">
 <img src="/art/powered_by.gif" width="88" height="31" alt=" [ Powered By Red Hat Linux ] " border="0"></a>
 </p>
 </body></html>
@@ -1,81 +0,0 @@
 #!/bin/bash
 #
 # milter	This shell script takes care of starting and stopping milter.
 #
 # chkconfig: 2345 80 30
 # description: Milter is a process that filters messages sent through sendmail.
 # processname: milter
 # config: /var/log/milter/bms.py
 # pidfile: /var/run/milter/milter.pid
 python="python2.3"
 pidof() {
 	set - ""
 	if set - `ps -e -o pid,cmd | grep "${python} bms.py"` &&
 	  [ "$2" != "grep" ]; then
 	  echo $1
 	  return 0
 	fi
 	return 1
 }
 # Source function library.
 . /etc/rc.d/init.d/functions
 [ -x /var/log/milter/start.sh ] || exit 0
 RETVAL=0
 prog="milter"
 start() {
 	# Start daemons.
 	echo -n "Starting $prog: "
 	daemon --check milter --user mail /var/log/milter/start.sh
 	RETVAL=$?
 	echo
 	[ $RETVAL -eq 0 ] && touch /var/lock/subsys/milter
 	return $RETVAL
 }
 stop() {
 	# Stop daemons.
 	echo -n "Shutting down $prog: "
 	killproc milter
 	RETVAL=$?
 	echo
 	[ $RETVAL -eq 0 ] && rm -f /var/lock/subsys/milter
 	return $RETVAL
 }
 # See how we were called.
 case "$1" in
  start)
 	start
 	;;
  stop)
 	stop
 	;;
  restart|reload)
 	stop
 	start
 	RETVAL=$?
 	;;
  condrestart)
 	if [ -f /var/lock/subsys/milter ]; then
 	    stop
 	    start
 	    RETVAL=$?
 	fi
 	;;
  status)
 	status milter
 	RETVAL=$?
 	;;
  *)
 	echo "Usage: $0 {start|stop|restart|condrestart|status}"
 	exit 1
 esac
 exit $RETVAL
@@ -1,81 +0,0 @@
 #!/bin/bash
 #
 # milter	This shell script takes care of starting and stopping milter.
 #
 # chkconfig: 2345 80 30
 # description: Milter is a process that filters messages sent through sendmail.
 # processname: milter
 # config: /var/log/milter/bms.py
 # pidfile: /var/run/milter/milter.pid
 python="python2.3"
 pidof() {
 	set - ""
 	if set - `ps -e -o pid,wchan,cmd | grep "rt_sig ${python} bms.py"` &&
 	  [ "$3" != "grep" ]; then
 	  echo $1
 	  return 0
 	fi
 	return 1
 }
 # Source function library.
 . /etc/rc.d/init.d/functions
 [ -x /var/log/milter/start.sh ] || exit 0
 RETVAL=0
 prog="milter"
 start() {
 	# Start daemons.
 	echo -n "Starting $prog: "
 	daemon --check milter --user mail /var/log/milter/start.sh
 	RETVAL=$?
 	echo
 	[ $RETVAL -eq 0 ] && touch /var/lock/subsys/milter
 	return $RETVAL
 }
 stop() {
 	# Stop daemons.
 	echo -n "Shutting down $prog: "
 	killproc milter
 	RETVAL=$?
 	echo
 	[ $RETVAL -eq 0 ] && rm -f /var/lock/subsys/milter
 	return $RETVAL
 }
 # See how we were called.
 case "$1" in
  start)
 	start
 	;;
  stop)
 	stop
 	;;
  restart|reload)
 	stop
 	start
 	RETVAL=$?
 	;;
  condrestart)
 	if [ -f /var/lock/subsys/milter ]; then
 	    stop
 	    start
 	    RETVAL=$?
 	fi
 	;;
  status)
 	status milter
 	RETVAL=$?
 	;;
  *)
 	echo "Usage: $0 {start|stop|restart|condrestart|status}"
 	exit 1
 esac
 exit $RETVAL
@@ -1,191 +0,0 @@
 %define name milter
 %define version 0.7.0
 %define release 1
 # Redhat 7.x and earlier (multiple ps lines per thread)
 %define sysvinit milter.rc7
 # RH9, other systems (single ps line per process)
 #define sysvinit milter.rc
 %ifos Linux
 %define python python2.3
 %else
 %define python python
 %endif
 Summary: Python interface to sendmail milter API
 Name: %{name}
 Version: %{version}
 Release: %{release}
 Source: %{name}-%{version}.tar.gz
 #Patch: %{name}-%{version}.patch
 Copyright: GPL
 Group: Development/Libraries
 BuildRoot: %{_tmppath}/%{name}-buildroot
 Prefix: %{_prefix}
 Vendor: Stuart D. Gathman <stuart@bmsi.com>
 Packager: Stuart D. Gathman <stuart@bmsi.com>
 Url: http://www.bmsi.com/python/milter.html
 Requires: %{python} >= 2.2.2, sendmail >= 8.12
 BuildRequires: %{python}-devel >= 2.2.2, sendmail-devel >= 8.12
 %description
 This is a python extension module to enable python scripts to
 attach to sendmail's libmilter functionality.  Additional python
 modules provide for navigating and modifying MIME parts.
 %prep
 %setup
 #%patch -p1
 %build
 env CFLAGS="$RPM_OPT_FLAGS" %{python} setup.py build
 %install
 rm -rf $RPM_BUILD_ROOT
 %{python} setup.py install --root=$RPM_BUILD_ROOT --record=INSTALLED_FILES
 mkdir -p $RPM_BUILD_ROOT/var/log/milter
 mkdir -p $RPM_BUILD_ROOT/etc/mail
 mkdir $RPM_BUILD_ROOT/var/log/milter/save
 cp bms.py $RPM_BUILD_ROOT/var/log/milter
 cp milter.cfg $RPM_BUILD_ROOT/etc/mail/pymilter.cfg
 # logfile rotation
 mkdir -p $RPM_BUILD_ROOT/etc/logrotate.d
 cat >$RPM_BUILD_ROOT/etc/logrotate.d/milter <<'EOF'
 /var/log/milter/milter.log {
  copytruncate
  compress
 }
 EOF
 # purge saved defanged message copies
 mkdir -p $RPM_BUILD_ROOT/etc/cron.daily
 cat >$RPM_BUILD_ROOT/etc/cron.daily/milter <<'EOF'
 #!/bin/sh
 find /var/log/milter/save -mtime +7 | xargs -r rm
 EOF
 chmod a+x $RPM_BUILD_ROOT/etc/cron.daily/milter
 %ifos aix4.1
 cat >$RPM_BUILD_ROOT/var/log/milter/start.sh <<'EOF'
 #!/bin/sh
 cd /var/log/milter
 # uncomment to enable sgmlop if installed
 #export PYTHONPATH=/usr/local/lib/python2.1/site-packages
 exec /usr/local/bin/python bms.py >>milter.log 2>&1
 EOF
 %else
 cat >$RPM_BUILD_ROOT/var/log/milter/start.sh <<'EOF'
 #!/bin/sh
 cd /var/log/milter
 exec >>milter.log 2>&1
 %{python} bms.py &
 echo $! >/var/run/milter/milter.pid
 EOF
 mkdir -p $RPM_BUILD_ROOT/etc/rc.d/init.d
 cp %{sysvinit} $RPM_BUILD_ROOT/etc/rc.d/init.d/milter
 ed $RPM_BUILD_ROOT/etc/rc.d/init.d/milter <<'EOF'
 /^python=/
 c
 python="%{python}"
 .
 w
 q
 EOF
 %endif
 chmod a+x $RPM_BUILD_ROOT/var/log/milter/start.sh
 mkdir -p $RPM_BUILD_ROOT/var/run/milter
 %ifos aix4.1
 %post
 mkssys -s milter -p /var/log/milter/start.sh -u 25 -S -n 15 -f 9 -G mail || :
 %preun
 if [ $1 = 0 ]; then
  rmssys -s milter || :
 fi
 %else
 %post
 echo "pythonsock has moved to /var/run/milter, update /etc/mail/sendmail.cf"
 %endif
 %clean
 rm -rf $RPM_BUILD_ROOT
 %files -f INSTALLED_FILES
 %defattr(-,root,root)
 %doc README NEWS TODO CREDITS sample.py
 /etc/logrotate.d/milter
 /etc/cron.daily/milter
 %ifos aix4.1
 %defattr(-,smmsp,mail)
 %else
 /etc/rc.d/init.d/milter
 %defattr(-,mail,mail)
 %endif
 %dir /var/log/milter
 %dir /var/run/milter
 %dir /var/log/milter/save
 %config /var/log/milter/start.sh
 %config /var/log/milter/bms.py
 %config(noreplace) /etc/mail/pymilter.cfg
 %changelog
 * Fri Jul 23 2004 Stuart Gathman <stuart@bmsi.com> 0.7.0-1
 - SPF check hello name
 - Move pythonsock to /var/run/milter
 - Move milter.cfg to /etc/mail/pymilter.cfg
 - Check M$ style XML CID records by converting to SPF
 - Recognize, but never match ip6 until we properly support it.
 - Option to reject when no PTR and no SPF
 * Fri Apr 09 2004 Stuart Gathman <stuart@bmsi.com> 0.6.9-1
 - Validate spf.py against test suite, and add Received-SPF support to spf.py
 - Support best_guess for SPF
 - Reject numeric hello names
 - Preserve case of local part in sender
 - Make libmilter timeout a config option
 - Fix setup.py to work with python < 2.2.3
 * Tue Apr 06 2004 Stuart Gathman <stuart@bmsi.com> 0.6.8-3
 - Reject invalid SRS immediately for benefit of callback verifiers
 - Fix include bug in spf.py
 * Tue Apr 06 2004 Stuart Gathman <stuart@bmsi.com> 0.6.8-2
 - Bug in check_header
 * Mon Apr 05 2004 Stuart Gathman <stuart@bmsi.com> 0.6.8-1
 - Don't report spoofed unless rcpt looks like SRS
 - Check for bounce with multiple rcpts
 - Make dspam see Received-SPF headers
 - Make sysv init work with RH9
 * Thu Mar 25 2004 Stuart Gathman <stuart@bmsi.com> 0.6.7-3
 - Forgot to make spf_reject_neutral global in bms.py
 * Wed Mar 24 2004 Stuart Gathman <stuart@bmsi.com> 0.6.7-2
 - Defang message/rfc822 content_type with boundary 
 - Support SPF delegation
 - Reject neutral SPF result for selected domains
 * Tue Mar 23 2004 Stuart Gathman <stuart@bmsi.com> 0.6.7-1
 - SRS forgery check.  Detect thread resource starvation.
 - Properly remove local socket with explicit type.
 - Decode obfuscated subject headers.
 * Wed Mar 11 2004 Stuart Gathman <stuart@bmsi.com> 0.6.6-2
 - init script bug with python2.3
 * Wed Mar 10 2004 Stuart Gathman <stuart@bmsi.com> 0.6.6-1
 - SPF checking, hello blacklist
 * Mon Mar 08 2004 Stuart Gathman <stuart@bmsi.com> 0.6.5-2
 - memory leak in envfrom and envrcpt
 * Mon Mar 01 2004 Stuart Gathman <stuart@bmsi.com> 0.6.5-1
 - progress notification
 - memory leak in connect
 - trusted relay
 * Thu Feb 19 2004 Stuart Gathman <stuart@bmsi.com> 0.6.4-2
 - smart alias wildcard patch, compile for sendmail-8.12
 * Thu Dec 04 2003 Stuart Gathman <stuart@bmsi.com> 0.6.4-1
 - many fixes for dspam support
 * Wed Oct 22 2003 Stuart Gathman <stuart@bmsi.com> 0.6.3
 - dspam SCREEN feature
 - streamline dspam false positive handling
 * Mon Sep 01 2003 Stuart Gathman <stuart@bmsi.com> 0.6.1
 - Full dspam support added
 * Mon Aug 26 2003 Stuart Gathman <stuart@bmsi.com>
 - Use New email module
 * Fri Jun 27 2003 Stuart Gathman <stuart@bmsi.com>
 - Add dspam module
@@ -1,18 +1,20 @@
 /* Copyright (C) 2001  James Niemira (niemira@colltech.com, urmane@urmane.org)
- * 
+ * Portions Copyright (C) 2001,2002,2003,2004,2005,2006,2007
- * This program is free software; you can redistribute it and/or
+ *   Stuart Gathman (stuart@bmsi.com)
- * modify it under the terms of the GNU General Public License
+ *
- * as published by the Free Software Foundation; either version 2
+ * This program is free software: you can redistribute it and/or modify it
- * of the License, or (at your option) any later version.
+ * 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
- * This program is distributed in the hope that it will be useful,
+ * option) any later version.
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * This program is distributed in the hope that it will be useful, but
- * GNU General Public License for more details.
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
- * 
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * You should have received a copy of the GNU General Public License
+ * General Public License for more details.
- * along with this program; if not, write to the Free Software
+ *
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * milterContext object and thread interface contributed by
 * 	Stuart D. Gathman <stuart@bmsi.com>
@@ -33,6 +35,60 @@ $ python setup.py help
     libraries=["milter","smutil","resolv"]
 * $Log$
 * Revision 1.14  2008/12/04 19:43:00  customdesigned
 * Doc updates.
 *
 * Revision 1.13  2008/11/23 03:06:47  customdesigned
 * Milter support for chgfrom.
 *
 * Revision 1.12  2008/11/21 20:42:52  customdesigned
 * Support smfi_chgfrom and smfi_addrcpt_par.
 *
 * Revision 1.11  2007/09/25 02:26:29  customdesigned
 * Update license.
 *
 * Revision 1.10  2006/02/12 02:00:42  customdesigned
 * Resolve FIXME for wrap_close.
 *
 * Revision 1.9  2005/12/23 21:46:36  customdesigned
 * Compile on sendmail-8.12 (ifdef SMFIR_INSHEADER)
 *
 * Revision 1.8  2005/10/20 23:23:36  customdesigned
 * Include smfi_progress is SMFIR_PROGRESS defined
 *
 * Revision 1.7  2005/10/20 23:04:46  customdesigned
 * Add optional idx for position of added header.
 *
 * Revision 1.6  2005/07/15 22:18:17  customdesigned
 * Support callback exception policy
 *
 * Revision 1.5  2005/06/24 04:20:07  customdesigned
 * Report context allocation error.
 *
 * Revision 1.4  2005/06/24 04:12:43  customdesigned
 * Remove unused name argument to generic wrappers.
 *
 * Revision 1.3  2005/06/24 03:57:35  customdesigned
 * Handle close called before connect.
 *
 * Revision 1.2  2005/06/02 04:18:55  customdesigned
 * Update copyright notices after reading article on /.
 *
 * Revision 1.1.1.2  2005/05/31 18:09:06  customdesigned
 * Release 0.7.1
 *
 * Revision 2.31  2004/08/23 02:24:36  stuart
 * Support setbacklog
 *
 * Revision 2.30  2004/08/21 20:29:53  stuart
 * Support option of 11 lines max for mlreply.
 *
 * Revision 2.29  2004/08/21 04:14:29  stuart
 * mlreply support
 *
 * Revision 2.28  2004/08/21 02:45:21  stuart
 * Don't leak int constants if module unloaded.
 *
 * Revision 2.27  2004/04/06 03:19:59  stuart
 * Release 0.6.8
 *
@@ -127,10 +183,19 @@ $ python setup.py help
 *
 */
-#include <pthread.h>
+#ifndef MAX_ML_REPLY
-#include <netinet/in.h>
+#define MAX_ML_REPLY 32
-#include <Python.h>
+#endif
-#include <libmilter/mfapi.h>
+#if MAX_ML_REPLY != 1 && MAX_ML_REPLY != 32 && MAX_ML_REPLY != 11
 #error MAX_ML_REPLY must be 1 or 11 or 32
 #endif
 #define _FFR_MULTILINE (MAX_ML_REPLY > 1)
 //#include <pthread.h>	// shouldn't be needed - use Python API
 #include <Python.h>		// Python C API
 #include <libmilter/mfapi.h>	// libmilter API
 #include <netinet/in.h>		// socket API
 /* See if we have IPv4 and/or IPv6 support in this OS and in
 * libmilter.  We need to make several macro tests because some OS's
@@ -169,7 +234,7 @@ $ python setup.py help
 /* Yes, these are static.  If you need multiple different callbacks, */
-/* it's cleaner to use multiple filters. */
+/* it's cleaner to use multiple filters, or convert to OO method calls. */
 static PyObject *connect_callback = NULL;
 static PyObject *helo_callback    = NULL;
 static PyObject *envfrom_callback = NULL;
@@ -196,10 +261,10 @@ typedef struct {
  PyThreadState *t;	/* python thread state */
 } milter_ContextObject;
-/* Return a borrowed reference to the python Context.  Create a
+/* Return a borrowed reference to the python Context.  Called by callbacks
-   new Context if needed.  The new Python Context is owned by
+   invoked by libmilter.  Create a new Context if needed.  The new
-   the SMFICTX. The python interpreter is locked on successful
+   Python Context is owned by the SMFICTX. The python interpreter is locked on
-   return, otherwise not. */
+   successful return, otherwise not. */
 static milter_ContextObject *
 _get_context(SMFICTX *ctx) {
  milter_ContextObject *self = smfi_getpriv(ctx);
@@ -214,8 +279,11 @@ _get_context(SMFICTX *ctx) {
    PyEval_AcquireThread(t);	/* lock interp */
    self = PyObject_New(milter_ContextObject,&milter_ContextType);
    if (!self) {
-      /* Can't pass on exception since we are called from libmilter */
+      /* Report and clear exception since we are called from libmilter */
-      PyErr_Clear();
+      if (PyErr_Occurred()) {
 	PyErr_Print();
 	PyErr_Clear();
      }
      PyThreadState_Clear(t);
      PyEval_ReleaseThread(t);
      PyThreadState_Delete(t);
@@ -230,14 +298,15 @@ _get_context(SMFICTX *ctx) {
  return self;
 }
-/* Find the SMFICTX from a Python Context. The interpreter must be locked. */
+/* Find the SMFICTX from a Python Context.  Called by context methods invoked
   from python.  The interpreter must be locked. */ 
 static SMFICTX *
 _find_context(PyObject *c) {
  SMFICTX *ctx = NULL;
  if (c->ob_type == &milter_ContextType) {
    milter_ContextObject *self = (milter_ContextObject *)c;
    ctx = self->ctx;
-    if (smfi_getpriv(ctx) != self)
+    if (ctx != NULL && smfi_getpriv(ctx) != self)
      ctx = NULL;
  }
  if (ctx == NULL)
@@ -245,23 +314,6 @@ _find_context(PyObject *c) {
  return ctx;
 }
 /* Release the Python Context for a SMFICTX.  */
 static void
 _clear_context(SMFICTX *ctx) {
  milter_ContextObject *self = smfi_getpriv(ctx);
  if (self) {
    PyThreadState *t = self->t;
    PyEval_AcquireThread(t);
    self->t = 0;
    self->ctx = 0;
    smfi_setpriv(ctx,0);
    Py_DECREF(self);
    PyThreadState_Clear(t);
    PyEval_ReleaseThread(t);
    PyThreadState_Delete(t);
  }
 }
 static void
 milter_Context_dealloc(PyObject *s) {
  milter_ContextObject *self = (milter_ContextObject *)s;
@@ -300,13 +352,15 @@ static char milter_set_flags__doc__[] =
 Set flags for filter capabilities; OR of one or more of:\n\
 ADDHDRS - filter may add headers\n\
 CHGBODY - filter may replace body\n\
 CHGFROM - filter may replace body\n\
 ADDRCPT - filter may add recipients\n\
 DELRCPT - filter may delete recipients\n\
 CHGHDRS - filter may change/delete headers";
 static PyObject *
 milter_set_flags(PyObject *self, PyObject *args) {
-  if (!PyArg_ParseTuple(args, "i", &description.xxfi_flags)) return NULL;
+  if (!PyArg_ParseTuple(args, "i:set_flags", &description.xxfi_flags))
    return NULL;
  Py_INCREF(Py_None);
  return Py_None;
 }
@@ -472,17 +526,52 @@ milter_set_close_callback(PyObject *self, PyObject *args) {
  return generic_set_callback(args, "O:set_close_callback", &close_callback);
 }
 static int exception_policy = SMFIS_TEMPFAIL;
 static char milter_set_exception_policy__doc__[] =
 "set_exception_policy(i) -> None\n\
 Sets the policy for untrapped Python exceptions during a callback.\n\
 Must be one of TEMPFAIL,REJECT,CONTINUE";
 static PyObject *
 milter_set_exception_policy(PyObject *self, PyObject *args) {
  int i;
  if (!PyArg_ParseTuple(args, "i:set_exception_policy", &i))
    return NULL;
  switch (i) {
  case SMFIS_REJECT: case SMFIS_TEMPFAIL: case SMFIS_CONTINUE:
    exception_policy = i;
    Py_INCREF(Py_None);
    return Py_None;
  }
  PyErr_SetString(MilterError,"invalid exception policy");
  return NULL;
 }
 static void
 _release_thread(PyThreadState *t) {
  if (t != NULL)
    PyEval_ReleaseThread(t);
 }
 /** Report and clear any python exception before returning to libmilter. 
  The interpreter is locked when we are called, and we unlock it.  */
 static int _report_exception(milter_ContextObject *self) {
  if (PyErr_Occurred()) {
    PyErr_Print();
    PyErr_Clear();	/* must clear since not returning to python */
-    PyEval_ReleaseThread(self->t);
+    _release_thread(self->t);
-    smfi_setreply(self->ctx, "451", "4.3.0", "Filter failure");
+    switch (exception_policy) {
-    return SMFIS_TEMPFAIL;
+      case SMFIS_REJECT:
 	smfi_setreply(self->ctx, "554", "5.3.0", "Filter failure");
 	return SMFIS_REJECT;
      case SMFIS_TEMPFAIL:
 	smfi_setreply(self->ctx, "451", "4.3.0", "Filter failure");
 	return SMFIS_TEMPFAIL;
    }
    return SMFIS_CONTINUE;
  }
-  PyEval_ReleaseThread(self->t);
+  _release_thread(self->t);
  return SMFIS_CONTINUE;
 }
@@ -501,7 +590,7 @@ _generic_wrapper(milter_ContextObject *self, PyObject *cb, PyObject *arglist) {
  retval = PyInt_AsLong(result);
  Py_DECREF(result);
  if (PyErr_Occurred()) return _report_exception(self);
-  PyEval_ReleaseThread(self->t);
+  _release_thread(self->t);
  return retval;
 }
@@ -591,7 +680,7 @@ milter_wrap_helo(SMFICTX *ctx, char *helohost) {
 }
 static int
-generic_env_wrapper(SMFICTX *ctx, PyObject*cb, char **argv, const char *name) {
+generic_env_wrapper(SMFICTX *ctx, PyObject*cb, char **argv) {
   PyObject *arglist;
   milter_ContextObject *self;
   int count = 0;
@@ -628,12 +717,12 @@ generic_env_wrapper(SMFICTX *ctx, PyObject*cb, char **argv, const char *name) {
 static int
 milter_wrap_envfrom(SMFICTX *ctx, char **argv) {
-  return generic_env_wrapper(ctx,envfrom_callback,argv,"milter_wrap_envfrom");
+  return generic_env_wrapper(ctx,envfrom_callback,argv);
 }
 static int
 milter_wrap_envrcpt(SMFICTX *ctx, char **argv) {
-  return generic_env_wrapper(ctx,envrcpt_callback,argv,"milter_wrap_envrcpt");
+  return generic_env_wrapper(ctx,envrcpt_callback,argv);
 }    
 static int
@@ -649,7 +738,7 @@ milter_wrap_header(SMFICTX *ctx, char *headerf, char *headerv) {
 }
 static int
-generic_noarg_wrapper(SMFICTX *ctx,PyObject *cb,const char *name) {
+generic_noarg_wrapper(SMFICTX *ctx,PyObject *cb) {
   PyObject *arglist;
   milter_ContextObject *c;
   if (cb == NULL) return SMFIS_CONTINUE;
@@ -661,7 +750,7 @@ generic_noarg_wrapper(SMFICTX *ctx,PyObject *cb,const char *name) {
 static int
 milter_wrap_eoh(SMFICTX *ctx) {
-  return generic_noarg_wrapper(ctx,eoh_callback,"milter_wrap_eoh");
+  return generic_noarg_wrapper(ctx,eoh_callback);
 }   
 static int
@@ -679,23 +768,42 @@ milter_wrap_body(SMFICTX *ctx, u_char *bodyp, size_t bodylen) {
 static int
 milter_wrap_eom(SMFICTX *ctx) {
-  return generic_noarg_wrapper(ctx,eom_callback,"milter_wrap_eom");
+  return generic_noarg_wrapper(ctx,eom_callback);
 }
 static int
 milter_wrap_abort(SMFICTX *ctx) {
  /* libmilter still calls close after abort */
-  return generic_noarg_wrapper(ctx,abort_callback,"milter_wrap_abort");
+  return generic_noarg_wrapper(ctx,abort_callback);
 }
 static int
 milter_wrap_close(SMFICTX *ctx) {
-  int r = generic_noarg_wrapper(ctx,close_callback,"milter_wrap_close");
+  /* xxfi_close can be called out of order - even before connect.  
-  /* FIXME: It is inefficient to have released the interp lock only to
+   * There may not yet be a private context pointer.  To avoid
-     acquire it again in _clear_context.  We can tell _generic_return and
+   * creating a ThreadContext and allocating a milter context only
-     friends not to release the lock by, for instance, setting self->t to NULL.
+   * to destroy them, and to avoid invoking the python close_callback when
-     However, first we make it work. */
+   * connect has never been called, we don't use generic_noarg_wrapper here. */
-  _clear_context(ctx);
+  PyObject *cb = close_callback;
  milter_ContextObject *self = smfi_getpriv(ctx);
  int r = SMFIS_CONTINUE;
  if (self != NULL) {
    PyThreadState *t = self->t;
    PyEval_AcquireThread(t);
    self->t = 0;
    if (cb != NULL && self->ctx == ctx) {
      PyObject *arglist = Py_BuildValue("(O)", self);
      /* Call python close callback, but do not ReleaseThread, because
       * self->t is NULL */
      r = _generic_wrapper(self, cb, arglist);
    }
    self->ctx = 0;
    smfi_setpriv(ctx,0);
    Py_DECREF(self);
    PyThreadState_Clear(t);
    PyEval_ReleaseThread(t);
    PyThreadState_Delete(t);
  }
  return r;
 }
@@ -746,6 +854,18 @@ milter_setdbg(PyObject *self, PyObject *args) {
  return _generic_return(smfi_setdbg(val), "cannot set debug value");
 }
 static char milter_setbacklog__doc__[] =
 "setbacklog(int) -> None\n\
 Set the TCP connection queue size for the milter socket.";
 static PyObject *
 milter_setbacklog(PyObject *self, PyObject *args) {
   int val;
   if (!PyArg_ParseTuple(args, "i:setbacklog", &val)) return NULL;
   return _generic_return(smfi_setbacklog(val), "cannot set backlog");
 }
 static char milter_settimeout__doc__[] =
 "settimeout(int) -> None\n\
 Set the time (in seconds) that sendmail will wait before\n\
@@ -820,41 +940,117 @@ static PyObject *
 milter_setreply(PyObject *self, PyObject *args) {
  char *rcode;
  char *xcode;
-  char *message;
+  char *message[MAX_ML_REPLY];
  char fmt[MAX_ML_REPLY + 16];
  SMFICTX *ctx;
-  if (!PyArg_ParseTuple(args, "szz:setreply", &rcode, &xcode, &message))
+  int i;
  strcpy(fmt,"sz|");
  for (i = 0; i < MAX_ML_REPLY; ++i) {
    message[i] = 0;
    fmt[i+3] = 's';
  }
  strcpy(fmt+i+3,":setreply");
  if (!PyArg_ParseTuple(args, fmt,
 	&rcode, &xcode, message
 #if MAX_ML_REPLY > 1
 	,message+1,message+2,message+3,message+4,message+5,message+6,
 	message+7,message+8,message+9,message+10
 #if MAX_ML_REPLY > 11
 	,message+11,message+12,message+13,message+14,message+15,
 	message+16,message+17,message+18,message+19,message+20,
 	message+21,message+22,message+23,message+24,message+25,
 	message+26,message+27,message+28,message+29,message+30,
 	message+31
 #endif
 #endif
  ))
    return NULL;
  ctx = _find_context(self);
  if (ctx == NULL) return NULL;
-  return _generic_return(smfi_setreply(ctx, rcode, xcode, message),
+#if MAX_ML_REPLY > 1
  /*
   * C varargs might be convenient for some things, but they sure are a pain
   * when the number of args is not known at compile time.
   */
  if (message[0] && message[1])
    return _generic_return(smfi_setmlreply(ctx, rcode, xcode,
 	  message[0],
 	  message[1],message[2],message[3],message[4],message[5],
 	  message[6],message[7],message[8],message[9],message[10],
 #if MAX_ML_REPLY > 11
 	  message[11],message[12],message[13],message[14],message[15],
 	  message[16],message[17],message[18],message[19],message[20],
 	  message[21],message[22],message[23],message[24],message[25],
 	  message[26],message[27],message[28],message[29],message[30],
 	  message[31],
 #endif
 	  (char *)0
    ), "cannot set reply");
 #endif
  return _generic_return(smfi_setreply(ctx, rcode, xcode, message[0]),
 			 "cannot set reply");
 }
 static char milter_addheader__doc__[] =
-"addheader(field, value) -> None\n\
+"addheader(field, value, idx=-1) -> None\n\
 Add a header to the message. This header is not passed to other\n\
 filters. It is not checked for standards compliance;\n\
 the mail filter must ensure that no protocols are violated\n\
 as a result of adding this header.\n\
 field - header field name\n\
 value - header field value\n\
 idx - optional position in internal header list to insert new header\n\
 Both are strings.  This function can only be called from the EOM callback.";
 static PyObject *
 milter_addheader(PyObject *self, PyObject *args) {
  char *headerf;
  char *headerv;
  int idx = -1;
  SMFICTX *ctx;
  PyThreadState *t;
-  if (!PyArg_ParseTuple(args, "ss:addheader", &headerf, &headerv)) return NULL;
+  if (!PyArg_ParseTuple(args, "ss|i:addheader", &headerf, &headerv, &idx))
    return NULL;
  ctx = _find_context(self);
  if (ctx == NULL) return NULL;
  t = PyEval_SaveThread();
-  return _thread_return(t,smfi_addheader(ctx, headerf, headerv),
+#ifdef SMFIR_INSHEADER
-			 "cannot add header");
+  return _thread_return(t, (idx < 0) ? smfi_addheader(ctx, headerf, headerv) :
      smfi_insheader(ctx, idx, headerf, headerv), "cannot add header");
 #else
  if (idx < 0)
    return _thread_return(t, smfi_addheader(ctx, headerf, headerv),
 	"cannot add header");
  PyErr_SetString(MilterError, "insheader not supported");
  return NULL;
 #endif
 }
 #ifdef SMFIF_CHGFROM
 static char milter_chgfrom__doc__[] =
 "chgfrom(sender,params) -> None\n\
 Change the envelope sender (MAIL From) of the current message.\n\
 A filter which calls smfi_chgfrom must have set the CHGFROM flag\n\
 in set_flags() before calling register.\n\
 This function can only be called from the EOM callback.";
 static PyObject *
 milter_chgfrom(PyObject *self, PyObject *args) {
  char *sender;
  char *params;
  SMFICTX *ctx;
  PyThreadState *t;
  if (!PyArg_ParseTuple(args, "s|z:chgfrom", &sender, &params))
    return NULL;
  ctx = _find_context(self);
  if (ctx == NULL) return NULL;
  t = PyEval_SaveThread();
  return _thread_return(t,smfi_chgfrom(ctx, sender, params),
 			 "cannot change sender");
 }
 #endif
 static char milter_chgheader__doc__[] =
 "chgheader(field, int, value) -> None\n\
 Change/delete a header in the message. \n\
@@ -884,22 +1080,33 @@ milter_chgheader(PyObject *self, PyObject *args) {
 }
 static char milter_addrcpt__doc__[] =
-"addrcpt(string) -> None\n\
+"addrcpt(string,params=None) -> None\n\
 Add a recipient to the envelope.  It must be in the same format\n\
 as is passed to the envrcpt callback in the first tuple element.\n\
 If params is used, you must pass ADDRCPT_PAR to set_flags().\n\
 This function can only be called from the EOM callback.";
 static PyObject *
 milter_addrcpt(PyObject *self, PyObject *args) {
  char *rcpt;
  char *params = 0;
  SMFICTX *ctx;
  PyThreadState *t;
  int rc;
-  if (!PyArg_ParseTuple(args, "s:addrcpt", &rcpt)) return NULL;
+  if (!PyArg_ParseTuple(args, "s|z:addrcpt", &rcpt)) return NULL;
  ctx = _find_context(self);
  if (ctx == NULL) return NULL;
  t = PyEval_SaveThread();
-  return _thread_return(t,smfi_addrcpt(ctx, rcpt), "cannot add recipient");
+  if (params)
 #ifdef SMFIF_ADDRCPT_PAR
    rc = smfi_addrcpt_par(ctx,rcpt,params);
 #else
    rc = MI_FAILURE;
 #endif
  else
    rc = smfi_addrcpt(ctx,rcpt);
  return _thread_return(t,rc, "cannot add recipient");
 }
 static char milter_delrcpt__doc__[] =
@@ -986,7 +1193,7 @@ milter_getpriv(PyObject *self, PyObject *args) {
  return o;
 }
-#if _FFR_QUARANTINE
+#ifdef SMFIF_QUARANTINE
 static char milter_quarantine__doc__[] =
 "quarantine(string) -> None\n\
 Place the message in quarantine.  A string with a description of the reason\n\
@@ -1007,7 +1214,7 @@ milter_quarantine(PyObject *self, PyObject *args) {
 }
 #endif
-#if _FFR_SMFI_PROGRESS
+#ifdef SMFIR_PROGRESS
 static char milter_progress__doc__[] =
 "progress() -> None\n\
 Notify the MTA that we are working on a message so it will reset timeouts.";
@@ -1035,11 +1242,14 @@ static PyMethodDef context_methods[] = {
  { "replacebody", milter_replacebody, METH_VARARGS, milter_replacebody__doc__},
  { "setpriv",     milter_setpriv,     METH_VARARGS, milter_setpriv__doc__},
  { "getpriv",     milter_getpriv,     METH_VARARGS, milter_getpriv__doc__},
-#if _FFR_QUARANTINE
+#ifdef SMFIF_QUARANTINE
  { "quarantine",  milter_quarantine,  METH_VARARGS, milter_quarantine__doc__},
 #endif
-#if _FFR_SMFI_PROGRESS
+#ifdef SMFIR_PROGRESS
  { "progress",  milter_progress,  METH_VARARGS, milter_progress__doc__},
 #endif
 #ifdef SMFIF_CHGFROM
  { "chgfrom",  milter_chgfrom,  METH_VARARGS, milter_chgfrom__doc__},
 #endif
  { NULL, NULL }
 };
@@ -1077,10 +1287,13 @@ static PyMethodDef milter_methods[] = {
   { "set_eom_callback",     milter_set_eom_callback,     METH_VARARGS, milter_set_eom_callback__doc__},
   { "set_abort_callback",   milter_set_abort_callback,   METH_VARARGS, milter_set_abort_callback__doc__},
   { "set_close_callback",   milter_set_close_callback,   METH_VARARGS, milter_set_close_callback__doc__},
   { "set_exception_policy",   milter_set_exception_policy,METH_VARARGS, milter_set_exception_policy__doc__},
   { "register",             milter_register,             METH_VARARGS, milter_register__doc__},
   { "register",             milter_register,             METH_VARARGS, milter_register__doc__},
   { "main",                 milter_main,                 METH_VARARGS, milter_main__doc__},
   { "setdbg",               milter_setdbg,               METH_VARARGS, milter_setdbg__doc__},
   { "settimeout",           milter_settimeout,           METH_VARARGS, milter_settimeout__doc__},
   { "setbacklog",           milter_setbacklog,           METH_VARARGS, milter_setbacklog__doc__},
   { "setconn",              milter_setconn,              METH_VARARGS, milter_setconn__doc__},
   { "stop",                 milter_stop,                 METH_VARARGS, milter_stop__doc__},
   { NULL, NULL }
@@ -1116,6 +1329,12 @@ allowing one to write email filters directly in Python.\n\
 Libmilter is currently marked FFR, and needs to be explicitly installed.\n\
 See <sendmailsource>/libmilter/README for details on setting it up.\n";
 static void setitem(PyObject *d,const char *name,long val) {
  PyObject *v = PyInt_FromLong(val);
  PyDict_SetItemString(d,name,v);
  Py_DECREF(v);
 }
 void
 initmilter(void) {
   PyObject *m, *d;
@@ -1125,24 +1344,30 @@ initmilter(void) {
   d = PyModule_GetDict(m);
   MilterError = PyErr_NewException("milter.error", NULL, NULL);
   PyDict_SetItemString(d,"error", MilterError);
-   PyDict_SetItemString(d,"SUCCESS", PyInt_FromLong((long) MI_SUCCESS));
+   setitem(d,"SUCCESS",  MI_SUCCESS);
-   PyDict_SetItemString(d,"FAILURE", PyInt_FromLong((long) MI_FAILURE));
+   setitem(d,"FAILURE",  MI_FAILURE);
-   PyDict_SetItemString(d,"VERSION", PyInt_FromLong((long) SMFI_VERSION));
+   setitem(d,"VERSION",  SMFI_VERSION);
-   PyDict_SetItemString(d,"ADDHDRS", PyInt_FromLong((long) SMFIF_ADDHDRS));
+   setitem(d,"ADDHDRS",  SMFIF_ADDHDRS);
-   PyDict_SetItemString(d,"CHGBODY", PyInt_FromLong((long) SMFIF_CHGBODY));
+   setitem(d,"CHGBODY",  SMFIF_CHGBODY);
-   PyDict_SetItemString(d,"MODBODY", PyInt_FromLong((long) SMFIF_MODBODY));
+   setitem(d,"MODBODY",  SMFIF_MODBODY);
-   PyDict_SetItemString(d,"ADDRCPT", PyInt_FromLong((long) SMFIF_ADDRCPT));
+   setitem(d,"ADDRCPT",  SMFIF_ADDRCPT);
-   PyDict_SetItemString(d,"DELRCPT", PyInt_FromLong((long) SMFIF_DELRCPT));
+#ifdef SMFIF_ADDRCPT_PAR
-   PyDict_SetItemString(d,"CHGHDRS", PyInt_FromLong((long) SMFIF_CHGHDRS));
+   setitem(d,"ADDRCPT_PAR",  SMFIF_ADDRCPT_PAR);
   PyDict_SetItemString(d,"V1_ACTS", PyInt_FromLong((long) SMFI_V1_ACTS));
   PyDict_SetItemString(d,"V2_ACTS", PyInt_FromLong((long) SMFI_V2_ACTS));
   PyDict_SetItemString(d,"CURR_ACTS", PyInt_FromLong((long) SMFI_CURR_ACTS));
 #ifdef SMFIF_QUARANTINE
   PyDict_SetItemString(d,"QUARANTINE",PyInt_FromLong((long)SMFIF_QUARANTINE));
 #endif
-   PyDict_SetItemString(d,"CONTINUE", PyInt_FromLong((long) SMFIS_CONTINUE));
+   setitem(d,"DELRCPT",  SMFIF_DELRCPT);
-   PyDict_SetItemString(d,"REJECT", PyInt_FromLong((long) SMFIS_REJECT));
+   setitem(d,"CHGHDRS",  SMFIF_CHGHDRS);
-   PyDict_SetItemString(d,"DISCARD", PyInt_FromLong((long) SMFIS_DISCARD));
+   setitem(d,"V1_ACTS",  SMFI_V1_ACTS);
-   PyDict_SetItemString(d,"ACCEPT", PyInt_FromLong((long) SMFIS_ACCEPT));
+   setitem(d,"V2_ACTS",  SMFI_V2_ACTS);
-   PyDict_SetItemString(d,"TEMPFAIL", PyInt_FromLong((long) SMFIS_TEMPFAIL));
+   setitem(d,"CURR_ACTS",  SMFI_CURR_ACTS);
 #ifdef SMFIF_QUARANTINE
   setitem(d,"QUARANTINE",SMFIF_QUARANTINE);
 #endif
 #ifdef SMFIF_CHGFROM
   setitem(d,"CHGFROM",SMFIF_CHGFROM);
 #endif
   setitem(d,"CONTINUE",  SMFIS_CONTINUE);
   setitem(d,"REJECT",  SMFIS_REJECT);
   setitem(d,"DISCARD",  SMFIS_DISCARD);
   setitem(d,"ACCEPT",  SMFIS_ACCEPT);
   setitem(d,"TEMPFAIL",  SMFIS_TEMPFAIL);
 }
@@ -1,4 +1,44 @@
 # $Log$
 # Revision 1.4  2005/06/17 01:49:39  customdesigned
 # Handle zip within zip.
 #
 # Revision 1.3  2005/06/02 15:00:17  customdesigned
 # Configure banned extensions.  Scan zipfile option with test case.
 #
 # Revision 1.2  2005/06/02 04:18:55  customdesigned
 # Update copyright notices after reading article on /.
 #
 # Revision 1.1.1.4  2005/05/31 18:23:49  customdesigned
 # Development changes since 0.7.2
 #
 # Revision 1.62  2005/02/14 22:31:17  stuart
 # _parseparam replacement not needed for python2.4
 #
 # Revision 1.61  2005/02/12 02:11:11  stuart
 # Pass unit tests with python2.4.
 #
 # Revision 1.60  2005/02/11 18:34:14  stuart
 # Handle garbage after quote in boundary.
 #
 # Revision 1.59  2005/02/10 01:10:59  stuart
 # Fixed MimeMessage.ismodified()
 #
 # Revision 1.58  2005/02/10 00:56:49  stuart
 # Runs with python2.4.  Defang not working correctly - more work needed.
 #
 # Revision 1.57  2004/11/20 16:37:52  stuart
 # fix regex for splitting header and body
 #
 # Revision 1.56  2004/11/09 20:33:51  stuart
 # Recognize more dynamic PTR variations.
 #
 # Revision 1.55  2004/10/06 21:39:20  stuart
 # Handle message attachments with boundary errors by not parsing them
 # until needed.
 #
 # Revision 1.54  2004/08/18 01:59:46  stuart
 # Handle mislabeled multipart messages
 #
 # Revision 1.53  2004/04/24 22:53:20  stuart
 # Rename some local variables to avoid shadowing builtins
 #
@@ -34,169 +74,46 @@
 # with a warning message.
 # Author: Stuart D. Gathman <stuart@bmsi.com>
-# Copyright 2001 Business Management Systems, Inc.
+# Copyright 2001,2002,2003,2004,2005 Business Management Systems, Inc.
-# This code is under GPL.  See COPYING for details.
+# This code is under the GNU General Public License.  See COPYING for details.
 import StringIO
 import socket
 import Milter
 import zipfile
 import email
 import email.Message
 from email.Message import Message
 from email.Generator import Generator
 from email.Utils import quote
 from email import Utils
 from email.Parser import Parser
 from email import Errors
 from types import ListType,StringType
-# Enhance email.Parser
+def zipnames(txt):
-# - Fix _parsebody to decode message attachments before parsing
+  fp =  StringIO.StringIO(txt)
  zipf = zipfile.ZipFile(fp,'r')
  names = []
  for nm in zipf.namelist():
    names.append(('zipname',nm))
    if nm.lower().endswith('.zip'):
      names += zipnames(zipf.read(nm))
  return names
-from email.Parser import Parser
+class MimeGenerator(Generator):
-try: from email.Parser import NLCRE
+    def _dispatch(self, msg):
-except: from email.Parser import nlcre as NLCRE
+        # Get the Content-Type: for the message, then try to dispatch to
-
+        # self._handle_<maintype>_<subtype>().  If there's no handler for the
-from email import Errors
+        # full MIME type, then dispatch to self._handle_<maintype>().  If
-
+        # that's missing too, then dispatch to self._writeBody().
-class MimeParser(Parser):
+        main = msg.get_content_maintype()
-
+	if msg.is_multipart() and main.lower() != 'multipart':
-    # This is a copy of _parsebody from email.Parser, with a fix
+	  self._handle_multipart(msg)
-    # for message attachments.  I couldn't find a smaller way to patch it
+	else:
-    # in a subclass.
+	  Generator._dispatch(self,msg)
    def _parsebody(self, container, fp, firstbodyline=None):
        # Parse the body, but first split the payload on the content-type
        # boundary if present.
        boundary = container.get_boundary()
        isdigest = (container.get_content_type() == 'multipart/digest')
        # If there's a boundary, split the payload text into its constituent
        # parts and parse each separately.  Otherwise, just parse the rest of
        # the body as a single message.  Note: any exceptions raised in the
        # recursive parse need to have their line numbers coerced.
        if boundary:
            preamble = epilogue = None
            # Split into subparts.  The first boundary we're looking for won't
            # always have a leading newline since we're at the start of the
            # body text, and there's not always a preamble before the first
            # boundary.
            separator = '--' + boundary
            payload = fp.read()
            if firstbodyline is not None:
                payload = firstbodyline + '\n' + payload
            # We use an RE here because boundaries can have trailing
            # whitespace.
            mo = re.search(
                r'(?P<sep>' + re.escape(separator) + r')(?P<ws>[ \t]*)',
                payload)
            if not mo:
                if self._strict:
                    raise Errors.BoundaryError(
                        "Couldn't find starting boundary: %s" % boundary)
                container.set_payload(payload)
                return
            start = mo.start()
            if start > 0:
                # there's some pre-MIME boundary preamble
                preamble = payload[0:start]
            # Find out what kind of line endings we're using
            start += len(mo.group('sep')) + len(mo.group('ws'))
            mo = NLCRE.search(payload, start)
            if mo:
                start += len(mo.group(0))
            # We create a compiled regexp first because we need to be able to
            # specify the start position, and the module function doesn't
            # support this signature. :(
            cre = re.compile('(?P<sep>\r\n|\r|\n)' +
                             re.escape(separator) + '--')
            mo = cre.search(payload, start)
            if mo:
                terminator = mo.start()
                linesep = mo.group('sep')
                if mo.end() < len(payload):
                    # There's some post-MIME boundary epilogue
                    epilogue = payload[mo.end():]
            elif self._strict:
                raise Errors.BoundaryError(
                        "Couldn't find terminating boundary: %s" % boundary)
            else:
                # Handle the case of no trailing boundary.  Check that it ends
                # in a blank line.  Some cases (spamspamspam) don't even have
                # that!
                mo = re.search('(?P<sep>\r\n|\r|\n){2}$', payload)
                if not mo:
                    mo = re.search('(?P<sep>\r\n|\r|\n)$', payload)
                    if not mo:
                        raise Errors.BoundaryError(
                          'No terminating boundary and no trailing empty line')
                linesep = mo.group('sep')
                terminator = len(payload)
            # We split the textual payload on the boundary separator, which
            # includes the trailing newline. If the container is a
            # multipart/digest then the subparts are by default message/rfc822
            # instead of text/plain.  In that case, they'll have a optional
            # block of MIME headers, then an empty line followed by the
            # message headers.
            parts = re.split(
                linesep + re.escape(separator) + r'[ \t]*' + linesep,
                payload[start:terminator])
            for part in parts:
                if isdigest:
                    if part.startswith(linesep):
                        # There's no header block so create an empty message
                        # object as the container, and lop off the newline so
                        # we can parse the sub-subobject
                        msgobj = self._class()
                        part = part[len(linesep):]
                    else:
                        parthdrs, part = part.split(linesep+linesep, 1)
                        # msgobj in this case is the "message/rfc822" container
                        msgobj = self.parsestr(parthdrs, headersonly=1)
                    # while submsgobj is the message itself
                    msgobj.set_default_type('message/rfc822')
                    maintype = msgobj.get_content_maintype()
                    if maintype in ('message', 'multipart'):
                        submsgobj = self.parsestr(part)
                        msgobj.attach(submsgobj)
                    else:
                        msgobj.set_payload(part)
                else:
                    msgobj = self.parsestr(part)
                container.preamble = preamble
                container.epilogue = epilogue
                container.attach(msgobj)
        elif container.get_main_type() == 'multipart':
            # Very bad.  A message is a multipart with no boundary!
            raise Errors.BoundaryError(
                'multipart message with no defined boundary')
        elif container.get_type() == 'message/delivery-status':
            # This special kind of type contains blocks of headers separated
            # by a blank line.  We'll represent each header block as a
            # separate Message object
            blocks = []
            while True:
                blockmsg = self._class()
                self._parseheaders(blockmsg, fp)
                if not len(blockmsg):
                    # No more header blocks left
                    break
                blocks.append(blockmsg)
            container.set_payload(blocks)
        elif container.get_main_type() == 'message':
            # Create a container for the payload, but watch out for there not
            # being any headers left
            container.set_payload(fp.read())
 	    fp = StringIO.StringIO(container.get_payload(decode=True))
            try:
                msg = self.parse(fp)
            except Errors.HeaderParseError:
                msg = self._class()
                self._parsebody(msg, fp)
            container.set_payload([msg])
        else:
            text = fp.read()
            if firstbodyline is not None:
                text = firstbodyline + '\n' + text
            container.set_payload(text)
 def unquote(s):
    """Remove quotes from a string."""
@@ -206,10 +123,11 @@ def unquote(s):
            s = s[1:-1]
 	  else: # remove garbage after trailing quote
 	    try: s = s[1:s[1:].index('"')+1]
-	    except: return s
+	    except:
 	      return s
 	  return s.replace('\\\\', '\\').replace('\\"', '"')
        if s.startswith('<') and s.endswith('>'):
-            return s[1:-1]
+	  return s[1:-1]
    return s
 from types import TupleType
@@ -220,27 +138,11 @@ def _unquotevalue(value):
  else:
      return unquote(value)
-email.Message._unquotevalue = _unquotevalue
+#email.Message._unquotevalue = _unquotevalue
-def _parseparam(s):
+from email.Message import _parseparam
    plist = []
    while s[:1] == ';':
 	s = s[1:]
 	end = s.find(';')
 	while end > 0 and (s.count('"',0,end) & 1):
 	  end = s.find(';',end + 1)
 	if end < 0: end = len(s)
 	f = s[:end]
 	if '=' in f:
 	    i = f.index('=')
 	    f = f[:i].strip().lower() + \
 		    '=' + f[i+1:].strip()
 	plist.append(f.strip())
 	s = s[end:]
    return plist
 # Enhance email.Message 
 # - Fix getparam to parse attributes IE style
 # - Provide a headerchange event for integration with Milter
 #   Headerchange attribute can be assigned a function to be called when
 #   changing headers.  The signature is:
@@ -251,64 +153,19 @@ class MimeMessage(Message):
  """Version of email.Message.Message compatible with old mime module
  """
  def __init__(self,fp=None,seekable=1):
    Message.__init__(self)
    self.headerchange = None
    self.submsg = None
-    Message.__init__(self)
+    self.modified = False
    self.fp = fp
    if fp:
      parser = MimeParser(MimeMessage)
      self.startofheaders = fp.tell()
      parser._parseheaders(self,fp)
      self.startofbody = fp.tell()
      parser._parsebody(self,fp)
    for part in self.walk():
      part.modified = False
-  def rewindbody(self):
+  def get_param(self, param, failobj=None, header='content-type', unquote=True):
-    return self.fp.seek(self.startofbody)
+    val = Message.get_param(self,param,failobj,header,unquote)
    if val != failobj and param == 'boundary' and unquote:
      # unquote boundaries an extra time, test case testDefang5
      return _unquotevalue(val)
    return val
-  # override param parsing to handle quotes
+  getfilename = Message.get_filename
  def _get_params_preserve(self,failobj=None,header='content-type'):
    "Return all parameter names and values. Use parser that handles quotes."
    missing = []
    value = self.get(header, missing)
    if value is missing:
 	return failobj
    params = []
    for p in _parseparam(';' + value):
 	  try:
 	      name, val = p.split('=', 1)
 	      name = name.strip()
 	      val = val.strip()
 	  except ValueError:
 	      # Must have been a bare attribute
 	      name = p.strip()
 	      val = ''
 	  params.append((name, val))
    params = Utils.decode_params(params)
    return params
  def get_filename(self, failobj=None):
      """Return the filename associated with the payload if present.
      The filename is extracted from the Content-Disposition header's
      `filename' parameter, and it is unquoted.
      """
      missing = []
      filename = self.get_param('filename', missing, 'content-disposition')
      if filename is missing:
 	  return failobj
      if isinstance(filename, TupleType):
 	  # It's an RFC 2231 encoded parameter
 	  newvalue = _unquotevalue(filename)
 	  if newvalue[0]:
 	    return unicode(newvalue[2], newvalue[0])
 	  return unicode(newvalue[2])
      else:
 	  newvalue = _unquotevalue(filename.strip())
 	  return newvalue
  getfilename = get_filename
  ismultipart = Message.is_multipart
  getheaders = Message.get_all
  gettype = Message.get_content_type
@@ -319,11 +176,11 @@ class MimeMessage(Message):
  def getname(self):
    return self.get_param('name')
-  def getnames(self):
+  def getnames(self,scan_zip=False):
    """Return a list of (attr,name) pairs of attributes that IE might
       interpret as a name - and hence decide to execute this message."""
    names = []
-    for attr,val in self.get_params([]):
+    for attr,val in self._get_params_preserve([],'content-type'):
      if isinstance(val, TupleType):
 	  # It's an RFC 2231 encoded parameter
 	  newvalue = _unquotevalue(val)
@@ -334,12 +191,19 @@ class MimeMessage(Message):
      else:
 	  val = _unquotevalue(val.strip())
      names.append((attr,val))
-    return names + [("filename",self.get_filename())]
+    names += [("filename",self.get_filename())]
    if scan_zip:
      for key,name in tuple(names):	# copy by converting to tuple
 	if name and name.lower().endswith('.zip'):
 	  txt = self.get_payload(decode=True)
 	  if txt.strip():
 	    names += zipnames(txt)
    return names
  def ismodified(self):
    "True if this message or a subpart has been modified."
    if not self.is_multipart():
-      if self.submsg:
+      if isinstance(self.submsg,Message):
        return self.submsg.ismodified()
      return self.modified
    if self.modified: return True
@@ -349,9 +213,15 @@ class MimeMessage(Message):
  def dump(self,file,unixfrom=False):
    "Write this message (and all subparts) to a file"
-    g = Generator(file)
+    g = MimeGenerator(file)
    g.flatten(self,unixfrom=unixfrom)
  def as_string(self, unixfrom=False):
      "Return the entire formatted message as a string."
      fp = StringIO.StringIO()
      self.dump(fp,unixfrom=unixfrom)
      return fp.getvalue()
  def getencoding(self):
    return self.get('content-transfer-encoding',None)
@@ -380,7 +250,7 @@ class MimeMessage(Message):
  def get_payload(self,i=None,decode=False):
    msg = self.submsg
-    if msg and msg.ismodified():
+    if isinstance(msg,Message) and msg.ismodified():
      self.set_payload([msg])
    return Message.get_payload(self,i,decode)
@@ -394,18 +264,27 @@ class MimeMessage(Message):
    self.submsg = None
  def get_submsg(self):
-    if self.get_content_type().lower() == 'message/rfc822':
+    t = self.get_content_type().lower()
    if t == 'message/rfc822' or t.startswith('multipart/'):
      if not self.submsg:
        txt = self.get_payload()
 	if type(txt) == str:
 	  txt = self.get_payload(decode=True)
-	  parser = MimeParser(MimeMessage)
+	  self.submsg = email.message_from_string(txt,MimeMessage)
-	  self.submsg = parser.parsestr(txt)
+	  for part in self.submsg.walk():
 	    part.modified = False
 	else:
 	  self.submsg = txt[0]
      return self.submsg
    return None
 def message_from_file(fp):
  msg = email.message_from_file(fp,MimeMessage)
  for part in msg.walk():
    part.modified = False
  assert not msg.ismodified()
  return msg
 extlist = ''.join("""
 ade,adp,asd,asx,asp,bas,bat,chm,cmd,com,cpl,crt,dll,exe,hlp,hta,inf,ins,isp,js,
 jse,lnk,mdb,mde,msc,msi,msp,mst,ocx,pcd,pif,reg,scr,sct,shs,url,vb,vbe,vbs,wsc,
@@ -427,19 +306,27 @@ A copy of your original message was saved as '%s:%s'.
 See your administrator.
 """
-def check_name(msg,savname=None,ckname=check_ext):
+def check_name(msg,savname=None,ckname=check_ext,scan_zip=False):
  "Replace attachment with a warning if its name is suspicious."
-  for key,name in msg.getnames():
+  try:
-    badname = ckname(name)
+    for key,name in msg.getnames(scan_zip):
-    if badname:
+      badname = ckname(name)
-      hostname = socket.gethostname()
+      if badname:
-      msg.set_payload(virus_msg % (badname,hostname,savname))
+        if key == 'zipname':
-      del msg["content-type"]
+          badname = msg.get_filename()
-      del msg["content-disposition"]
+	break
-      del msg["content-transfer-encoding"]
+    else:
-      name = "WARNING.TXT"
+      return Milter.CONTINUE
-      msg["Content-Type"] = "text/plain; name="+name
+  except zipfile.BadZipfile:
-      break
+    # a ZIP that is not a zip is very suspicious
    badname = msg.get_filename()
  hostname = socket.gethostname()
  msg.set_payload(virus_msg % (badname,hostname,savname))
  del msg["content-type"]
  del msg["content-disposition"]
  del msg["content-transfer-encoding"]
  name = "WARNING.TXT"
  msg["Content-Type"] = "text/plain; name="+name
  return Milter.CONTINUE
 import email.Iterators
@@ -450,7 +337,7 @@ msg	MimeMessage
 check	function(MimeMessage): int
 	Return CONTINUE, REJECT, ACCEPT
  """
-  if msg.ismultipart() and not msg.get_content_type() == 'message/rfc822':
+  if msg.is_multipart():
    for i in msg.get_payload():
      rc = check_attachments(i,check)
      if rc != Milter.CONTINUE: return rc
@@ -459,28 +346,35 @@ check	function(MimeMessage): int
 # save call context for Python without nested_scopes
 class _defang:
-  def __init__(self,savname,check):
+
-    self._savname = savname
+  def __init__(self,scan_html=True):
-    self._check = check
+    self.scan_html = scan_html
-    self.scan_rfc822 = True
+
    self.scan_html = True
  def _chk_name(self,msg):
-    rc = check_name(msg,self._savname,self._check)
+    rc = check_name(msg,self._savname,self._check,self.scan_zip)
    if self.scan_html:
      check_html(msg,self._savname)	# remove scripts from HTML
    if self.scan_rfc822:
      msg = msg.get_submsg()
-      if msg: return check_attachments(msg,self._chk_name)
+      if isinstance(msg,Message):
        return check_attachments(msg,self._chk_name)
    return rc
  def __call__(self,msg,savname=None,check=check_ext,scan_rfc822=True,
  		scan_zip=False):
    """Compatible entry point.
    Replace all attachments with dangerous names."""
    self._savname = savname
    self._check = check
    self.scan_rfc822 = scan_rfc822
    self.scan_zip = scan_zip
    check_attachments(msg,self._chk_name)
    if msg.ismodified():
      return True
    return False
 # emulate old defang function
-def defang(msg,savname=None,check=check_ext):
+defang = _defang()
  """Compatible entry point.
 Replace all attachments with dangerous names."""
  check_attachments(msg,_defang(savname,check)._chk_name)
  if msg.ismodified():
    return 1;
  return 0
 import sgmllib
@@ -577,7 +471,6 @@ class HTMLScriptFilter(SGMLFilter):
  def handle_comment(self,comment):
    if not self.ignoring: SGMLFilter.handle_comment(self,comment)
 def check_html(msg,savname=None):
  "Remove scripts from HTML attachments."
  msgtype = msg.get_content_type().lower()
@@ -611,3 +504,20 @@ def check_html(msg,savname=None):
      del msg["content-transfer-encoding"]
      email.Encoders.encode_quopri(msg)
  return Milter.CONTINUE
 if __name__ == '__main__':
  import sys
  def _list_attach(msg):
    t = msg.get_content_type()
    p = msg.get_payload(decode=True)
    print msg.get_filename(),msg.get_content_type(),type(p)
    msg = msg.get_submsg()
    if isinstance(msg,Message):
      return check_attachments(msg,_list_attach)
    return Milter.CONTINUE
  for fname in sys.argv[1:]:
    fp = open(fname)
    msg = message_from_file(fp)
    email.Iterators._structure(msg)
    check_attachments(msg,_list_attach)
@@ -0,0 +1,100 @@
 %define __python python2.4
 %define version 0.8.12
 %define release 1%{?dist}.py24
 %define libdir %{_libdir}/pymilter
 %define name pymilter
 %define redhat7 0
 Summary: Python interface to sendmail milter API
 Name: %{name}
 Version: %{version}
 Release: %{release}
 Source: %{name}-%{version}.tar.gz
 #Patch: %{name}-%{version}.patch
 License: GPLv2+
 Group: Development/Libraries
 BuildRoot: %{_tmppath}/%{name}-buildroot
 Vendor: Stuart D. Gathman <stuart@bmsi.com>
 Url: http://www.bmsi.com/python/milter.html
 Requires: %{__python} >= 2.4, sendmail >= 8.13
 BuildRequires: %{__python}-devel >= 2.4, sendmail-devel >= 8.13
 %description
 This is a python extension module to enable python scripts to
 attach to sendmail's libmilter functionality.  Additional python
 modules provide for navigating and modifying MIME parts, sending
 DSNs, and doing CBV.
 %prep
 %setup -q
 #patch -p0 -b .bms
 %build
 %if %{redhat7} 
  LDFLAGS="-s"
 %else # Redhat builds debug packages after 7.3
  LDFLAGS="-g"
 %endif
 env CFLAGS="$RPM_OPT_FLAGS" LDFLAGS="$LDFLAGS" %{__python} setup.py build
 %install
 rm -rf $RPM_BUILD_ROOT
 %{__python} setup.py install --root=$RPM_BUILD_ROOT --record=INSTALLED_FILES
 mkdir -p $RPM_BUILD_ROOT/var/run/milter
 mkdir -p $RPM_BUILD_ROOT%{libdir}
 %ifos aix4.1
 cat >$RPM_BUILD_ROOT%{libdir}/start.sh <<'EOF'
 #!/bin/sh
 cd /var/log/milter
 exec /usr/local/bin/python bms.py >>milter.log 2>&1
 EOF
 %else # not aix4.1
 cp start.sh $RPM_BUILD_ROOT%{libdir}
 ed $RPM_BUILD_ROOT%{libdir}/start.sh <<'EOF'
 /^python=/
 c
 python="%{__python}"
 .
 w
 q
 EOF
 %endif
 chmod a+x $RPM_BUILD_ROOT%{libdir}/start.sh
 %if !%{redhat7}
 #grep '.pyc$' INSTALLED_FILES | sed -e 's/c$/o/' >>INSTALLED_FILES
 %endif
 # start.sh is used by spfmilter and milter, and could be used by
 # other milters running on redhat
 %files -f INSTALLED_FILES
 %defattr(-,root,root)
 %doc README ChangeLog NEWS TODO CREDITS sample.py milter-template.py
 %config %{libdir}/start.sh
 %dir %attr(0755,mail,mail) /var/run/milter
 %clean
 rm -rf $RPM_BUILD_ROOT
 %changelog
 * Mon Nov 24 2008 Stuart Gathman <stuart@bmsi.com> 0.8.12-1
 - Split pymilter into its own CVS module
 - Support chgfrom and addrcpt_par
 - Support NS records in Milter.dns
 * Mon Aug 25 2008 Stuart Gathman <stuart@bmsi.com> 0.8.10-2
 - /var/run/milter directory must be owned by mail
 * Mon Aug 25 2008 Stuart Gathman <stuart@bmsi.com> 0.8.10-1
 - improved parsing into email and fullname (still 2 self test failures)
 - implement no-DSN CBV, reduce full DSNs
 * Mon Sep 24 2007 Stuart Gathman <stuart@bmsi.com> 0.8.9-1
 - Use ifarch hack to build milter and milter-spf packages as noarch
 - Remove spf dependency from dsn.py, add dns.py
 * Fri Jan 05 2007 Stuart Gathman <stuart@bmsi.com> 0.8.8-1
 - move AddrCache, parse_addr, iniplist to Milter package
 - move parse_header to Milter.utils
 - fix plock for missing source and can't change owner/group
 - split out pymilter and pymilter-spf packages
 - move milter apps to /usr/lib/pymilter
 * Sat Nov 04 2006 Stuart Gathman <stuart@bmsi.com> 0.8.7-1
 - SPF moved to pyspf RPM
 * Tue May 23 2006 Stuart Gathman <stuart@bmsi.com> 0.8.6-2
 - Support CBV timeout
@@ -1,38 +0,0 @@
 # Analyze milter log to find abusers
 fp = open('/var/log/milter/milter.log','r')
 subdict = {}
 ipdict = {}
 spamcnt = {}
 for line in fp:
  a = line.split(None,4)
  if len(a) < 4: continue
  dt,tm,id,op = a[:4]
  if op == 'Subject:':
    if len(a) > 4: subdict[id] = a[4].rstrip()
  elif op == 'connect':
    ipdict[id] = a[4].rstrip()
  elif op in ('eom','dspam'):
    if id in subdict: del subdict[id]
    if id in ipdict: del ipdict[id]
  elif op in ('REJECT:','DSPAM:','SPAM:','abort'):
    if id in subdict:
      if id in ipdict:
        ip = ipdict[id]
 	del ipdict[id]
 	f,host,raw = ip.split(None,2)
 	if host in spamcnt:
 	  spamcnt[host] += 1
 	else:
 	  spamcnt[host] = 1
      else: ip = ''
      print dt,tm,op,a[4].rstrip(),subdict[id]
      del subdict[id]
    else:
      print line.rstrip()
 print len(subdict),'leftover entries'
 spamlist = filter(lambda x: x[1] > 1,spamcnt.items())
 spamlist.sort(lambda x,y: x[1] - y[1])
 for ip,cnt in spamlist:
  print cnt,ip
@@ -126,7 +126,7 @@ class sampleMilter(Milter.Milter):
  def eom(self):
    if not self.fp: return Milter.ACCEPT
    self.fp.seek(0)
-    msg = mime.MimeMessage(self.fp)
+    msg = mime.message_from_file(self.fp)
    msg.headerchange = self._headerChange
    if not mime.defang(msg,self.tempname):
      os.remove(self.tempname)
@@ -1,4 +1,5 @@
 [bdist_rpm]
-python=python2
+python=python2.4
 doc_files=README NEWS TODO
 packager=Stuart D. Gathman <stuart@bmsi.com>
 release=1
@@ -3,7 +3,10 @@ import sys
 from distutils.core import setup, Extension
 # FIXME: on some versions of sendmail, smutil is renamed to sm
 # on slackware and debian, leave it out entirely.  It depends
 # on how libmilter was built by the sendmail package.
 libs = ["milter", "smutil"]
 libdirs = ["/usr/lib/libmilter"]    # needed for Debian
 # patch distutils if it can't cope with the "classifiers" or
 # "download_url" keywords
@@ -12,13 +15,14 @@ if sys.version < '2.2.3':
  DistributionMetadata.classifiers = None
  DistributionMetadata.download_url = None
-setup(name = "milter", version = "0.7.0",
+# NOTE: importing Milter to obtain version fails when milter.so not built
 setup(name = "pymilter", version = '0.8.12',
 	description="Python interface to sendmail milter API",
 	long_description="""\
 This is a python extension module to enable python scripts to
 attach to sendmail's libmilter functionality.  Additional python
 modules provide for navigating and modifying MIME parts, and
-querying SPF records.
+sending DSNs or doing CBVs.
 """,
 	author="Jim Niemira",
 	author_email="urmane@urmane.org",
@@ -26,9 +30,15 @@ querying SPF records.
 	maintainer_email="stuart@bmsi.com",
 	license="GPL",
 	url="http://www.bmsi.com/python/milter.html",
-	py_modules=["Milter","mime","spf"],
+	py_modules=["mime"],
 	packages = ['Milter'],
 	ext_modules=[
-	  Extension("milter", ["miltermodule.c"],libraries=libs),
+	  Extension("milter", ["miltermodule.c"],
            library_dirs=libdirs,
 	    libraries=libs,
 	    # set MAX_ML_REPLY to 1 for sendmail < 8.13
 	    define_macros = [ ('MAX_ML_REPLY',32) ]
 	  ),
 	],
 	keywords = ['sendmail','milter'],
 	classifiers = [
@@ -39,6 +49,7 @@ querying SPF records.
 	  'Natural Language :: English',
 	  'Operating System :: POSIX',
 	  'Programming Language :: Python',
-	  'Topic :: Communications :: Email :: Mail Transport Agents'
+	  'Topic :: Communications :: Email :: Mail Transport Agents',
 	  'Topic :: Communications :: Email :: Filters'
 	]
 )
@@ -1,973 +0,0 @@
 #!/usr/bin/env python
 """SPF (Sender-Permitted From) implementation.
 Copyright (c) 2003, Terence Way
 This module is free software, and you may redistribute it and/or modify
 it under the same terms as Python itself, so long as this copyright message
 and disclaimer are retained in their original form.
 IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
 SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OF
 THIS CODE, EVEN IF THE AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
 DAMAGE.
 THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 PARTICULAR PURPOSE.  THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS,
 AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 For more information about SPF, a tool against email forgery, see
 	http://spf.pobox.com
 For news, bugfixes, etc. visit the home page for this implementation at
 	http://www.wayforward.net/spf/
 """
 # Changes:
 #    9-dec-2003, v1.1, Meng Weng Wong added PTR code, THANK YOU
 #   11-dec-2003, v1.2, ttw added macro expansion, exp=, and redirect=
 #   13-dec-2003, v1.3, ttw added %{o} original domain macro,
 #                      print spf result on command line, support default=,
 #                      support localhost, follow DNS CNAMEs, cache DNS results
 #                      during query, support Python 2.2 for Mac OS X
 #   16-dec-2003, v1.4, ttw fixed include handling (include is a mechanism,
 #                      complete with status results, so -include: should work.
 #                      Expand macros AFTER looking for status characters ?-+
 #                      so altavista.com SPF records work.
 #   17-dec-2003, v1.5, ttw use socket.inet_aton() instead of DNS.addr2bin, so
 #                      n, n.n, and n.n.n forms for IPv4 addresses work, and to
 #                      ditch the annoying Python 2.4 FutureWarning
 #   18-dec-2003, v1.6, Failures on Intel hardware: endianness.  Use ! on
 #                      struct.pack(), struct.unpack().
 #
 # Development taken over by Stuart Gathman <stuart@bmsi.com> since
 # Terrence is not responding to email.
 #
 # $Log$
 # Revision 1.13  2004/07/23 19:23:12  stuart
 # Always fail to match on ip6, until we support it properly.
 #
 # Revision 1.12  2004/07/23 18:48:15  stuart
 # Fold CID parsing into spf
 #
 # Revision 1.11  2004/07/21 21:32:01  stuart
 # Handle CID records (Microsoft XML format).
 #
 # Revision 1.10  2004/04/19 22:12:11  stuart
 # Release 0.6.9
 #
 # Revision 1.9  2004/04/18 03:29:35  stuart
 # Pass most tests except -local and -rcpt-to
 #
 # Revision 1.8  2004/04/17 22:17:55  stuart
 # Header comment method.
 #
 # Revision 1.7  2004/04/17 18:22:48  stuart
 # Support default explanation.
 #
 # Revision 1.6  2004/04/06 20:18:02  stuart
 # Fix bug in include
 #
 # Revision 1.5  2004/04/05 22:29:46  stuart
 # SPF best_guess,
 #
 # Revision 1.4  2004/03/25 03:27:34  stuart
 # Support delegation of SPF records.
 #
 # Revision 1.3  2004/03/13 12:23:23  stuart
 # Expanded result codes.  Tolerate common method misspellings.
 #
 __author__ = "Terence Way"
 __email__ = "terry@wayforward.net"
 __version__ = "1.6: December 18, 2003"
 MODULE = 'spf'
 USAGE = """To check an incoming mail request:
    % python spf.py {ip} {sender} {helo}
    % python spf.py 69.55.226.139 tway@optsw.com mx1.wayforward.net
 To test an SPF record:
    % python spf.py "v=spf1..." {ip} {sender} {helo}
    % python spf.py "v=spf1 +mx +ip4:10.0.0.1 -all" 10.0.0.1 tway@foo.com a    
 To fetch an SPF record:
    % python spf.py {domain}
    % python spf.py wayforward.net
 To test this script (and to output this usage message):
    % python spf.py
 """
 import re
 import socket  # for inet_ntoa() and inet_aton()
 import struct  # for pack() and unpack()
 import time    # for time()
 import DNS	# http://pydns.sourceforge.net
 import xml.sax
 # -------------------------------------------------------------------------
 # Convert a MS Caller-ID entry (XML) to a SPF entry
 #
 # (c) 2004 by Ernesto Baschny
 # (c) 2004 Python version by Stuart Gathman
 #
 # Date: 2004-02-25
 # Version: 1.0
 #
 # Usage:
 #  ./cid2spf.pl "<ep xmlns='http://ms.net/1'>...</ep>"
 #
 # Note that the 'include' directives will also have to be checked and
 # "translated". Future versions of this script might be able to get a
 # domain name as an argument and "crawl" the DNS for the necessary
 # information.
 #
 # A complete reverse translation (SPF -> CID) might be impossible, since
 # there are no way to handle:
 # - PTR and EXISTS mechanism 
 # - MX mechanism with an different domain as argument
 # - macros
 # 
 # References:
 # http://www.microsoft.com/mscorp/twc/privacy/spam_callerid.mspx
 # http://spf.pobox.com/
 #
 # Known bugs:
 # - Currently it won't handle the exclusions provided in the A and R
 #   tags (prefix '!'). They will show up "as-is" in the SPF record
 # - I really haven't read the MS-CID specs in-depth, so there are probably
 #   other bugs too :)
 #
 # Ernesto Baschny <ernst@baschny.de>
 #
 class CIDParser(xml.sax.ContentHandler):
  "Convert a MS Caller-ID entry (XML) to a SPF entry."
  def __init__(self,q=None):
    self.spf = []
    self.action = '-all'
    self.has_servers = None
    self.spf_entry = None
    if q:
      self.spf_query = q
    else:
      self.spf_query = query(i='127.0.0.1', s='localhost', h='unknown')
  def startElement(self,tag,attr):
      if tag == 'm':
 	if self.has_servers != None and not self.has_servers:
 	  raise ValueError(
    "Declared <noMailServers\> and later <m>, this CID entry is not valid."
 	  )
 	self.has_servers = True
      elif tag == 'noMailServers':
 	if self.has_servers:
 	  raise ValueError(
    "Declared <m> and later <noMailServers\>, this CID entry is not valid."
 	  )
 	self.has_servers = False
      elif tag == 'ep':
 	if attr.has_key('testing') and attr.getValue('testing') == 'true':
 	  # A CID with 'testing' found:
 	  # From the MS-specs:
 	  #  "Documents in which such attribute is present with a true
 	  #  value SHOULD be entirely ignored (one should act as if the
 	  #  document were absent)"
 	  # From the SPF-specs:
 	  #  "Neutral (?): The SPF client MUST proceed as if a domain did
 	  #  not publish SPF data."
 	  # So we set SPF action to "neutral":
 	  self.action = '?all'
      elif tag == 'mx':
 	  # The empty MX-tag, same as SPF's MX-mechanism
 	  self.spf.append('mx')
      self.tag = tag
  def characters(self,text):
 	tag = self.tag
 	# Remove starting and trailing spaces from text:
 	text = text.strip()
 	if tag == 'a' or tag == 'r':
 	    # The A and R tags from MS-CID are both handled by the 
 	    # ipv4/6-mechanisms from SPF:
 	    if text.find(':') < 0:
 	      mechanism = 'ip4'
 	    else:
 	      mechanism = 'ip6'
 	    self.spf.append(mechanism + ':' + text)
 	elif tag == 'indirect':
 	    # MS-CID's indirect is "sort of" the include from SPF:
 	    # Not really true, because the <indirect> tag from MS-CID also 
 	    # provides a fallback in case the included domain doesn't provide
 	    # _ep-records: The inbound MX-servers of the included domains
 	    # are added to the list of allowed outgoing mailservers for the
 	    # domain that declared the _ep-record with the <indirect> tag.
 	    # In SPF you would use the 'mx:domain' to handle this, but this
 	    # wouldn't depend on referred domain having or not SPF-records.
 	    cid_xml = self.cid_txt(text)
 	    if cid_xml:
 	      p = CIDParser()
 	      xml.sax.parseString(cid_xml,p)
 	      if p.has_servers != False:
 		self.spf += p.spf
 	    else:
 	      self.spf.append('mx:' + text)
  def cid_txt(self,domain):
    q = self.spf_query
    domain='_ep.' + domain
    a = q.dns_txt(domain)
    if not a: return None
    if a[0].lower().startswith('<ep ') and a[-1].lower().endswith('</ep>'):
      return ''.join(a)
    return None
  def endElement(self,tag):
      if tag == 'ep':
 	# This is the end... assemble what we've got
 	spf_entry = ['v=spf1']
 	if self.has_servers != False:
 	  spf_entry += self.spf
 	spf_entry.append(self.action)
 	self.spf_entry = ' '.join(spf_entry)
  def spf_txt(self,cid_xml):
    if not cid_xml.startswith('<'):
      cid_xml = self.cid_txt(cid_xml)
      if not cid_xml: return None
    # Parse the beast. Any XML-problem will be reported by xlm.sax
    self.spf_entry = None
    xml.sax.parseString(cid_xml,self)
    return self.spf_entry
 # 32-bit IPv4 address mask
 MASK = 0xFFFFFFFFL
 # Regular expression to look for modifiers
 RE_MODIFIER = re.compile(r'^([a-zA-Z]+)=')
 # Regular expression to find macro expansions
 RE_CHAR = re.compile(r'%(%|_|-|(\{[a-zA-Z][0-9]*r?[^\}]*\}))')
 # Regular expression to break up a macro expansion
 RE_ARGS = re.compile(r'([0-9]*)(r?)([^0-9a-zA-Z]*)')
 # Local parts and senders have their delimiters replaced with '.' during
 # macro expansion
 #
 JOINERS = {'l': '.', 's': '.'}
 RESULTS = {'+': 'pass', '-': 'fail', '?': 'neutral', '~': 'softfail',
           'pass': 'pass', 'fail': 'fail', 'unknown': 'unknown',
 	   'neutral': 'neutral', 'softfail': 'softfail',
 	   'none': 'none', 'deny': 'fail' }
 EXPLANATIONS = {'pass': 'sender SPF verified', 'fail': 'access denied',
                'unknown': 'SPF unknown',
 		'softfail': 'domain in transition',
 		'neutral': 'access neither permitted nor denied',
 		'none': ''
 		}
 # if set to a domain name, search _spf.domain namespace if no SPF record
 # found in source domain.
 DELEGATE = None
 # support pre 2.2.1....
 try:
 	bool, True, False = bool, True, False
 except NameError:
 	False, True = 0, 1
 	def bool(x): return not not x
 # ...pre 2.2.1
 # standard default SPF record
 DEFAULT_SPF = 'v=spf1 a/24 mx/24 ptr'
 def check(i, s, h,local=None):
 	"""Test an incoming MAIL FROM:<s>, from a client with ip address i.
 	h is the HELO/EHLO domain name.
 	Returns (result, mta-status-code, explanation) where result in
 	['pass', 'unknown', 'fail', 'error', 'softfail', 'none', 'neutral' ].
 	Example:
 	>>> check(i='127.0.0.1', s='terry@wayforward.net', h='localhost')
 	('pass', 250, 'local connections always pass')
 	#>>> check(i='61.51.192.42', s='liukebing@bcc.com', h='bmsi.com')
 	"""
 	return query(i=i, s=s, h=h,local=local).check()
 class query(object):
 	"""A query object keeps the relevant information about a single SPF
 	query:
 	i: ip address of SMTP client
 	s: sender declared in MAIL FROM:<>
 	l: local part of sender s
 	d: current domain, initially domain part of sender s
 	h: EHLO/HELO domain
 	v: 'in-addr' for IPv4 clients and 'ip6' for IPv6 clients
 	t: current timestamp
 	p: SMTP client domain name
 	o: domain part of sender s
 	This is also, by design, the same variables used in SPF macro
 	expansion.
 	Also keeps cache: DNS cache.
 	"""
 	def __init__(self, i, s, h,local=None):
 		self.i, self.s, self.h = i, s, h
 		self.l, self.o = split_email(s, h)
 		self.t = str(int(time.time()))
 		self.v = 'in-addr'
 		self.d = self.o
 		self.p = None
 		self.cache = {}
 		self.exps = dict(EXPLANATIONS)
 		self.local = local	# local policy
 	def set_default_explanation(self,exp):
 		exps = self.exps
 		for i in 'softfail','fail','unknown':
 		  exps[i] = exp
 	def getp(self):
 		if not self.p:
 			p = self.dns_ptr(self.i)
 			if len(p) > 0:
 				self.p = p[0]
 			else:
 				self.p = self.i
 		return self.p
 	def best_guess(self,spf=DEFAULT_SPF):
 		"""Return a best guess based on a default SPF record"""
 		return self.check(spf)
 	def check(self, spf=None):
 		"""
 	Returns (result, mta-status-code, explanation) where
 	result in ['fail', 'softfail', 'neutral' 'unknown', 'pass', 'error']
 		"""
 		if self.i.startswith('127.'):
 			return ('pass', 250, 'local connections always pass')
 		try:
 			if not spf:
 			    spf = self.dns_spf(self.d)
 			if self.local and spf:
 			    spf += ' ' + self.local
 			return self.check1(spf, self.d, 0)
 		except DNS.DNSError:
 			return ('error', 450, 'SPF DNS Error')
 	def check1(self, spf, domain, recursion):
 		# spf rfc: 3.7 Processing Limits
 		#
 		if recursion > 20:
 			self.prob =  'Mechanisms used too many DNS lookups'
 			return ('unknown', 250, 'SPF recursion limit exceeded')
 		try:
 			tmp, self.d = self.d, domain
 			return self.check0(spf, recursion)
 		finally:
 			self.d = tmp
 	def check0(self, spf, recursion):
 		"""Test this query information against SPF text.
 		Returns (result, mta-status-code, explanation) where
 		result in ['fail', 'unknown', 'pass', 'none']
 		"""
 		if not spf:
 			return ('none', 250, EXPLANATIONS['none'])
 		# split string by whitespace, drop the 'v=spf1'
 		#
 		spf = spf.split()[1:]
 		# copy of explanations to be modified by exp=
 		exps = self.exps
 		redirect = None
 		# no mechanisms at all cause unknown result, unless
 		# overridden with 'default=' modifier
 		#
 		default = 'neutral'
 		self.mech = []		# unknown mechanisms
 		# Look for modifiers
 		#
 		for m in spf:
 			m = RE_MODIFIER.split(m)[1:]
 			if len(m) != 2: continue
 			if m[0] == 'exp':
 				exps['fail'] = exps['unknown'] = \
 					self.get_explanation(m[1])
 			elif m[0] == 'redirect':
 				redirect = self.expand(m[1])
 			elif m[0] == 'default':
 				# default=- is the same as default=fail
 				default = RESULTS.get(m[1], default)
 			# spf rfc: 3.6 Unrecognized Mechanisms and Modifiers
 		# Look for mechanisms
 		#
 		for mech in spf:
 			if RE_MODIFIER.match(mech): continue
 			m, arg, cidrlength = parse_mechanism(mech, self.d)
 			# map '?' '+' or '-' to 'unknown' 'pass' or 'fail'
 			result = RESULTS.get(m[0])
 			if result:
 				# eat '?' '+' or '-'
 				m = m[1:]
 			else:
 				# default pass
 				result = 'pass'
 			if m in ['a', 'mx', 'ptr', 'exists', 'include']:
 				arg = self.expand(arg)
 			if m == 'include':
 			    if arg != self.d:
 				res,code,txt = self.check1(self.dns_spf(arg),
 						  arg, recursion + 1)
 				if res == 'pass':
 					break
 				if res in ('fail','neutral','softfail'):
 					continue
 				if res == 'none':
 				  	self.prob = \
 					  'Could not find a valid SPF record'
 				  	res = 'unknown'
 				return res,code,txt
 			    else:
 			    	self.prob = 'Required option is missing'
 				self.mech.append(mech)
 				return ('unknown', 250, 'missing SPF option')
 			elif m == 'all':
 				break
 			elif m == 'exists':
 				if len(self.dns_a(arg)) > 0:
 					break
 			elif m == 'a':
 				if cidrmatch(self.i, self.dns_a(arg),
 				             cidrlength):
 					break
 			elif m == 'mx':
 				if cidrmatch(self.i, self.dns_mx(arg),
 				             cidrlength):
 					break
 			elif m in ('ip4', 'ipv4', 'ip') and arg != self.d:
 				if cidrmatch(self.i, [arg], cidrlength):
 					break
 			elif m == 'ip6':
 			# Until we support IPV6, we should never
 			# get an IPv6 connection.  So this mech
 			# will never match.
 				pass
 			elif m in ('ptr', 'prt'):
 				if domainmatch(self.validated_ptrs(self.i),
 				               arg):
 					break
 			else:
 				# unknown mechanisms cause immediate unknown
 				# abort results
 				self.mech.append(mech)
 				self.prob = 'Unknown mechanism found'
 				return ('unknown',250,'unknown SPF mechanism')
 		else:
 			# no matches
 			if redirect:
 				return self.check1(self.dns_spf(redirect),
 				                   redirect, recursion+1)
 			else:
 				result = default
 		if result == 'fail':
 			return (result, 550, exps[result])
 		else:
 			return (result, 250, exps[result])
 	def get_explanation(self, spec):
 		"""Expand an explanation."""
 		if spec:
 		  return self.expand(''.join(self.dns_txt(self.expand(spec))))
 		else:
 		  return 'explanation : Required option is missing'
 	def expand(self, str):
 		"""Do SPF RFC macro expansion.
 		Examples:
 		>>> q = query(s='strong-bad@email.example.com',
 		...           h='mx.example.org', i='192.0.2.3')
 		>>> q.p = 'mx.example.org'
 		>>> q.expand('%{d}')
 		'email.example.com'
 		>>> q.expand('%{d4}')
 		'email.example.com'
 		>>> q.expand('%{d3}')
 		'email.example.com'
 		>>> q.expand('%{d2}')
 		'example.com'
 		>>> q.expand('%{d1}')
 		'com'
 		>>> q.expand('%{p}')
 		'mx.example.org'
 		>>> q.expand('%{p2}')
 		'example.org'
 		>>> q.expand('%{dr}')
 		'com.example.email'
 		>>> q.expand('%{d2r}')
 		'example.email'
 		>>> q.expand('%{l}')
 		'strong-bad'
 		>>> q.expand('%{l-}')
 		'strong.bad'
 		>>> q.expand('%{lr}')
 		'strong-bad'
 		>>> q.expand('%{lr-}')
 		'bad.strong'
 		>>> q.expand('%{l1r-}')
 		'strong'
 		>>> q.expand('%{ir}.%{v}._spf.%{d2}')
 		'3.2.0.192.in-addr._spf.example.com'
 		>>> q.expand('%{lr-}.lp._spf.%{d2}')
 		'bad.strong.lp._spf.example.com'
 		>>> q.expand('%{lr-}.lp.%{ir}.%{v}._spf.%{d2}')
 		'bad.strong.lp.3.2.0.192.in-addr._spf.example.com'
 		>>> q.expand('%{ir}.%{v}.%{l1r-}.lp._spf.%{d2}')
 		'3.2.0.192.in-addr.strong.lp._spf.example.com'
 		>>> q.expand('%{p2}.trusted-domains.example.net')
 		'example.org.trusted-domains.example.net'
 		>>> q.expand('%{p2}.trusted-domains.example.net')
 		'example.org.trusted-domains.example.net'
 		"""
 		end = 0
 		result = ''
 		for i in RE_CHAR.finditer(str):
 			result += str[end:i.start()]
 			macro = str[i.start():i.end()]
 			if macro == '%%':
 				result += '%'
 			elif macro == '%_':
 				result += ' '
 			elif macro == '%-':
 				result += '%20'
 			else:
 				letter = macro[2].lower()
 				if letter == 'p':
 					self.getp()
 				expansion = getattr(self, letter, '')
 				if expansion:
 					result += expand_one(expansion,
 						macro[3:-1],
 					        JOINERS.get(letter))
 			end = i.end()
 		return result + str[end:]
 	def dns_spf(self, domain):
 		"""Get the SPF record recorded in DNS for a specific domain
 		name.  Returns None if not found, or if more than one record
 		is found.
 		"""
 		a = [t for t in self.dns_txt(domain) if t.startswith('v=spf1')]
 		if not a:
 		  if DELEGATE:
 		    a = [t
 		      for t in self.dns_txt(domain+'._spf.'+DELEGATE)
 			if t.startswith('v=spf1')
 		    ]
 		  if not a:
 		    # No SPF record: convert and return CID if present
 		    p = CIDParser(q=self)
 		    return p.spf_txt(domain)
 		if len(a) == 1:
 			return a[0]
 		else:
 			return None
 	def dns_txt(self, domainname):
 		"Get a list of TXT records for a domain name."
 		if domainname:
 		  return [t for a in self.dns(domainname, 'TXT') for t in a]
 		return []
 	def dns_mx(self, domainname):
 		"""Get a list of IP addresses for all MX exchanges for a
 		domain name.
 		"""
 		return [a for mx in self.dns(domainname, 'MX') \
 		          for a in self.dns_a(mx[1])]
 	def dns_a(self, domainname):
 		"""Get a list of IP addresses for a domainname."""
 		return self.dns(domainname, 'A')
 	def dns_aaaa(self, domainname):
 		"""Get a list of IPv6 addresses for a domainname."""
 		return self.dns(domainname, 'AAAA')
 	def validated_ptrs(self, i):
 		"""Figure out the validated PTR domain names for a given IP
 		address.
 		"""
 		return [p for p in self.dns_ptr(i) if i in self.dns_a(p)]
 	def dns_ptr(self, i):
 		"""Get a list of domain names for an IP address."""
 		return self.dns(reverse_dots(i) + ".in-addr.arpa", 'PTR')
 	def dns(self, name, qtype):
 		"""DNS query.
 		If the result is in cache, return that.  Otherwise pull the
 		result from DNS, and cache ALL answers, so additional info
 		is available for further queries later.
 		CNAMEs are followed.
 		If there is no data, [] is returned.
 		pre: qtype in ['A', 'AAAA', 'MX', 'PTR', 'TXT', 'SPF']
 		post: isinstance(__return__, types.ListType)
 		"""
 		result = self.cache.get( (name, qtype) )
 		cname = None
 		if not result:
 			req = DNS.DnsRequest(name, qtype=qtype)
 			resp = req.req()
 			for a in resp.answers:
 				# key k: ('wayforward.net', 'A'), value v
 				k, v = (a['name'], a['typename']), a['data']
 				if k == (name, 'CNAME'):
 					cname = v
 				self.cache.setdefault(k, []).append(v)
 			result = self.cache.get( (name, qtype), [])
 		if not result and cname:
 			result = self.dns(cname, qtype)
 		return result
 	def get_header(self,res,receiver):
 	  if res in ('pass','fail'):
 	    return '%s (%s: %s) client-ip=%s; envelope-from=%s; helo=%s;' % (
 	  	res,receiver,self.get_header_comment(res),self.i,
 	        self.l + '@' + self.o, self.h)
 	  if res == 'unknown':
 	    return '%s (%s: %s)' % (' '.join([res] + self.mech),
 	      receiver,self.get_header_comment(res))
 	  return '%s (%s: %s)' % (res,receiver,self.get_header_comment(res))
 	def get_header_comment(self,res):
 		"""Return comment for Received-SPF header.
 		"""
 		sender = self.o
 		if res == 'pass':
 		  if self.i.startswith('127.'):
 		    return "localhost is always allowed."
 		  else: return \
 		    "domain of %s designates %s as permitted sender" \
 			% (sender,self.i)
 		elif res == 'softfail': return \
      "transitioning domain of %s does not designate %s as permitted sender" \
 			% (sender,self.i)
 		elif res == 'neutral': return \
 		    "%s is neither permitted nor denied by domain of %s" \
 		    	% (self.i,sender)
 		elif res == 'none': return \
 		    "%s is neither permitted nor denied by domain of %s" \
 		    	% (self.i,sender)
 		    #"%s does not designate permitted sender hosts" % sender
 		elif res == 'unknown': return \
 		    "error in processing during lookup of domain of %s: %s" \
 		    	% (sender, self.prob)
 		elif res == 'error': return \
 		    "error in processing during lookup of %s" % sender
 		elif res == 'fail': return \
 		    "domain of %s does not designate %s as permitted sender" \
 			% (sender,self.i)
 		raise ValueError("invalid SPF result for header comment: "+res)
 def split_email(s, h):
 	"""Given a sender email s and a HELO domain h, create a valid tuple
 	(l, d) local-part and domain-part.
 	Examples:
 	>>> split_email('', 'wayforward.net')
 	('postmaster', 'wayforward.net')
 	>>> split_email('foo.com', 'wayforward.net')
 	('postmaster', 'foo.com')
 	>>> split_email('terry@wayforward.net', 'optsw.com')
 	('terry', 'wayforward.net')
 	"""
 	if not s:
 		return 'postmaster', h
 	else:
 		parts = s.split('@', 1)
 		if len(parts) == 2:
 			return tuple(parts)
 		else:
 			return 'postmaster', s
 def parse_mechanism(str, d):
 	"""Breaks A, MX, IP4, and PTR mechanisms into a (name, domain,
 	cidr) tuple.  The domain portion defaults to d if not present,
 	the cidr defaults to 32 if not present.
 	Examples:
 	>>> parse_mechanism('a', 'foo.com')
 	('a', 'foo.com', 32)
 	>>> parse_mechanism('a:bar.com', 'foo.com')
 	('a', 'bar.com', 32)
 	>>> parse_mechanism('a/24', 'foo.com')
 	('a', 'foo.com', 24)
 	>>> parse_mechanism('a:bar.com/16', 'foo.com')
 	('a', 'bar.com', 16)
 	"""
 	a = str.split('/')
 	if len(a) == 2:
 		a, port = a[0], int(a[1])
 	else:
 		a, port = str, 32
 	b = a.split(':')
 	if len(b) == 2:
 		return b[0], b[1], port
 	else:
 		return a, d, port
 def reverse_dots(name):
 	"""Reverse dotted IP addresses or domain names.
 	Example:
 	>>> reverse_dots('192.168.0.145')
 	'145.0.168.192'
 	>>> reverse_dots('email.example.com')
 	'com.example.email'
 	"""
 	a = name.split('.')
 	a.reverse()
 	return '.'.join(a)
 def domainmatch(ptrs, domainsuffix):
 	"""grep for a given domain suffix against a list of validated PTR
 	domain names.
 	Examples:
 	>>> domainmatch(['FOO.COM'], 'foo.com')
 	1
 	>>> domainmatch(['moo.foo.com'], 'FOO.COM')
 	1
 	>>> domainmatch(['moo.bar.com'], 'foo.com')
 	0
 	"""
 	domainsuffix = domainsuffix.lower()
 	for ptr in ptrs:
 		ptr = ptr.lower()
 		if ptr == domainsuffix or ptr.endswith('.' + domainsuffix):
 			return True
 	return False
 def cidrmatch(i, ipaddrs, cidr_length = 32):
 	"""Match an IP address against a list of other IP addresses.
 	Examples:
 	>>> cidrmatch('192.168.0.45', ['192.168.0.44', '192.168.0.45'])
 	1
 	>>> cidrmatch('192.168.0.43', ['192.168.0.44', '192.168.0.45'])
 	0
 	>>> cidrmatch('192.168.0.43', ['192.168.0.44', '192.168.0.45'], 24)
 	1
 	"""
 	c = cidr(i, cidr_length)
 	for ip in ipaddrs:
 		if cidr(ip, cidr_length) == c:
 			return True
 	return False
 def cidr(i, n):
 	"""Convert an IP address string with a CIDR mask into a 32-bit
 	integer.
 	i must be a string of numbers 0..255 separated by dots '.'::
 	pre: forall([0 <= int(p) < 256 for p in i.split('.')])
 	n is a number of bits to mask::
 	pre: 0 <= n <= 32
 	Examples:
 	>>> bin2addr(cidr('192.168.5.45', 32))
 	'192.168.5.45'
 	>>> bin2addr(cidr('192.168.5.45', 24))
 	'192.168.5.0'
 	>>> bin2addr(cidr('192.168.0.45', 8))
 	'192.0.0.0'
 	"""
 	return ~(MASK >> n) & MASK & addr2bin(i)
 def addr2bin(str):
 	"""Convert a string IPv4 address into an unsigned integer.
 	Examples::
 	>>> addr2bin('127.0.0.1')
 	2130706433L
 	>>> addr2bin('127.0.0.1') == socket.INADDR_LOOPBACK
 	1
 	>>> addr2bin('255.255.255.254')
 	4294967294L
 	>>> addr2bin('192.168.0.1')
 	3232235521L
 	Unlike DNS.addr2bin, the n, n.n, and n.n.n forms for IP addresses
 	are handled as well::
 	>>> addr2bin('10.65536')
 	167837696L
 	>>> 10 * (2 ** 24) + 65536
 	167837696
 	>>> addr2bin('10.93.512')
 	173867520L
 	>>> 10 * (2 ** 24) + 93 * (2 ** 16) + 512
 	173867520
 	"""
 	return struct.unpack("!L", socket.inet_aton(str))[0]
 def bin2addr(addr):
 	"""Convert a numeric IPv4 address into string n.n.n.n form.
 	Examples::
 	>>> bin2addr(socket.INADDR_LOOPBACK)
 	'127.0.0.1'
 	>>> bin2addr(socket.INADDR_ANY)
 	'0.0.0.0'
 	>>> bin2addr(socket.INADDR_NONE)
 	'255.255.255.255'
 	"""
 	return socket.inet_ntoa(struct.pack("!L", addr))
 def expand_one(expansion, str, joiner):
 	if not str:
 		return expansion
 	len, reverse, delimiters = RE_ARGS.split(str)[1:4]
 	if not delimiters:
 		delimiters = '.'
 	expansion = split(expansion, delimiters, joiner)
 	if reverse: expansion.reverse()
 	if len: expansion = expansion[-int(len)*2+1:]
 	return ''.join(expansion)
 def split(str, delimiters, joiner=None):
 	"""Split a string into pieces by a set of delimiter characters.  The
 	resulting list is delimited by joiner, or the original delimiter if
 	joiner is not specified.
 	Examples:
 	>>> split('192.168.0.45', '.')
 	['192', '.', '168', '.', '0', '.', '45']
 	>>> split('terry@wayforward.net', '@.')
 	['terry', '@', 'wayforward', '.', 'net']
 	>>> split('terry@wayforward.net', '@.', '.')
 	['terry', '.', 'wayforward', '.', 'net']
 	"""
 	result, element = [], ''
 	for c in str:
 		if c in delimiters:
 			result.append(element)
 			element = ''
 			if joiner:
 				result.append(joiner)
 			else:
 				result.append(c)
 		else:
 			element += c
 	result.append(element)
 	return result
 def _test():
 	import doctest, spf
 	return doctest.testmod(spf)
 DNS.DiscoverNameServers() # Fails on Mac OS X? Add domain to /etc/resolv.conf
 if __name__ == '__main__':
 	import sys
 	if len(sys.argv) == 1:
 		print USAGE
 		_test()
 	elif len(sys.argv) == 2:
 		q = query(i='127.0.0.1', s='localhost', h='unknown')
 		print q.dns_spf(sys.argv[1])
 	elif len(sys.argv) == 4:
 		print check(i=sys.argv[1], s=sys.argv[2], h=sys.argv[3])
 	elif len(sys.argv) == 5:
 		i, s, h = sys.argv[2:]
 		q = query(i=i, s=s, h=h)
 		print q.check(sys.argv[1])
 	else:
 		print USAGE
@@ -1,91 +0,0 @@
 #!/usr/bin/python2.3
 # $Log$
 # Revision 2.3  2004/04/19 22:12:11  stuart
 # Release 0.6.9
 #
 # Revision 2.2  2004/04/18 03:29:35  stuart
 # Pass most tests except -local and -rcpt-to
 #
 # Revision 2.1  2004/04/08 18:41:15  stuart
 # Reject numeric hello names
 #
 # Driver for SPF test system
 import spf
 import sys
 from optparse import OptionParser
 class PerlOptionParser(OptionParser):
    def _process_args (self, largs, rargs, values):
        """_process_args(largs : [string],
                         rargs : [string],
                         values : Values)
        Process command-line arguments and populate 'values', consuming
        options and arguments from 'rargs'.  If 'allow_interspersed_args' is
        false, stop at the first non-option argument.  If true, accumulate any
        interspersed non-option arguments in 'largs'.
        """
        while rargs:
            arg = rargs[0]
            # We handle bare "--" explicitly, and bare "-" is handled by the
            # standard arg handler since the short arg case ensures that the
            # len of the opt string is greater than 1.
            if arg == "--":
                del rargs[0]
                return
            elif arg[0:2] == "--":
                # process a single long option (possibly with value(s))
                self._process_long_opt(rargs, values)
            elif arg[:1] == "-" and len(arg) > 1:
                # process a single perl style long option
 		rargs[0] = '-' + arg
                self._process_long_opt(rargs, values)
            elif self.allow_interspersed_args:
                largs.append(arg)
                del rargs[0]
            else:
 		return
 def format(q):
  res,code,txt = q.check()
  print res
  if res in ('pass','neutral','unknown'): print
  else: print txt
  print 'spfquery:',q.get_header_comment(res)
  print 'Received-SPF:',q.get_header(res,'spfquery')
 def main(argv):
  parser = PerlOptionParser()
  parser.add_option("--file",dest="file")
  parser.add_option("--ip",dest="ip")
  parser.add_option("--sender",dest="sender")
  parser.add_option("--helo",dest="hello_name")
  parser.add_option("--local",dest="local_policy")
  parser.add_option("--rcpt-to",dest="rcpt")
  parser.add_option("--default-explanation",dest="explanation")
  parser.add_option("--sanitize",type="int",dest="sanitize")
  parser.add_option("--debug",type="int",dest="debug")
  opts,args = parser.parse_args(argv)
  if opts.ip:
    q = spf.query(opts.ip,opts.sender,opts.hello_name,local=opts.local_policy)
    if opts.explanation:
      q.set_default_explanation(opts.explanation)
    format(q)
  if opts.file:
    if opts.file == '0':
      fp = sys.stdin
    else:
      fp = open(opts.file,'r')
    for ln in fp:
      ip,sender,helo,rcpt = ln.split(None,3)
      q = spf.query(ip,sender,helo,local=opts.local_policy)
      if opts.explanation:
 	q.set_default_explanation(opts.explanation)
      format(q)
    fp.close()
 if __name__ == "__main__":
  import sys
  main(sys.argv[1:])
@@ -0,0 +1,14 @@
 #!/bin/sh
 appname="$1"
 script="${2:-${appname}}"
 datadir=/var/log/milter
 python="python2.4"
 exec >>${datadir}/${appname}.log 2>&1
 if test -s ${datadir}/${script}.py; then
  cd ${datadir} # use version in log dir if it exists for debugging
 else
  cd /usr/lib/pymilter
 fi
 ${python} ${script}.py &
 echo $! >/var/run/milter/${appname}.pid
@@ -1,14 +1,14 @@
 import unittest
 import testbms
 import testmime
 import testsample
 import testutils
 import os
 def suite(): 
  s = unittest.TestSuite()
  s.addTest(testbms.suite())
  s.addTest(testmime.suite())
  s.addTest(testsample.suite())
  s.addTest(testutils.suite())
  return s
 if __name__ == '__main__':
@@ -0,0 +1,128 @@
 From leec@windowsshop.com Fri Sep 10 11:48:25 2004
 Message-ID: <4141CDD4.7040305@windowsshop.com>
 Date: Fri, 10 Sep 2004 11:52:52 -0400
 From: Lee Connor <leec@windowsshop.com>
 User-Agent: Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.4) Gecko/20030624 Netscape/7.1 (ax)
 X-Accept-Language: en-us, en
 MIME-Version: 1.0
 To: Cleo Matthews-Conley <cleom@windowsshop.com>, 
 Tony Collini <tonyc@windowsshop.com>,
 John Higinbothom <johnh@windowsshop.com>
 CC: Rich Higgins <richh@windowsshop.com>
 Subject: [Fwd: [Fwd: Customer Concerns]]
 Content-Type: multipart/mixed;
 boundary="------------020209070802060007090105"
 This is a multi-part message in MIME format.
 --------------020209070802060007090105
 Content-Type: text/plain; charset=us-ascii; format=flowed
 Content-Transfer-Encoding: 7bit
 Cleo - please review attached feedback from Sales team.......I recall at 
 an early meeting after we moved in you and Tony (and maybe 1 or 2 
 others) were going to develop a voice mail procedure or instruction 
 sheet for all staff. It looks like we really need this to get what we 
 are looking for from the system. Please let me know when you can produce 
 this and give a draft to the managers here for review.
 Thanks,
 Lee
 --------------020209070802060007090105
 Content-Type: message/rfc822;
 name="[Fwd: Customer Concerns]"
 Content-Transfer-Encoding: 7bit
 Content-Disposition: inline;
 filename="[Fwd: Customer Concerns]"
 Return-Path: <richh@windowsshop.com>
 Received: from windowsshop.com (pc147.windowsshop.com [192.168.100.147] (may be forged))
 	by lord.windowsshop.com (8.12.10/8.12.10) with ESMTP id i89KCClX003425
 	for <leec@windowsshop.com>; Thu, 9 Sep 2004 16:12:12 -0400
 Message-ID: <4140B851.3020501@windowsshop.com>
 Date: Thu, 09 Sep 2004 16:08:49 -0400
 From: Rich <richh@windowsshop.com>
 User-Agent: Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.0.2) Gecko/20021120 Netscape/7.01
 X-Accept-Language: en-us, en
 MIME-Version: 1.0
 To: Lee Connor <leec@windowsshop.com>
 Subject: [Fwd: Customer Concerns]
 Content-Type: multipart/mixed;
 boundary="------------030301030706020401010801"
 X-DSpam-Score: 0.000000
 This is a multi-part message in MIME format.
 --------------030301030706020401010801
 Content-Type: text/plain; charset=us-ascii; format=flowed
 Content-Transfer-Encoding: 7bit
 Lee - do you want me to do anything else with this?
 Rich
 <!DSPAM:FEE4D3278234264874834386>
 --------------030301030706020401010801
 Content-Type: message/rfc822; name="Customer Concerns";
 	boundary="===============0045392615=="
 Content-Transfer-Encoding: 7bit
 Content-Disposition: inline;
 filename="Customer Concerns"
 Return-Path: <joes@windowsshop.com>
 Received: from joes (pc148.windowsshop.com [192.168.100.148] (may be forged))
 	by lord.windowsshop.com (8.12.10/8.12.10) with SMTP id i89K9BlX003262
 	for <richh@windowsshop.com>; Thu, 9 Sep 2004 16:09:11 -0400
 From: "Joe Schmuck" <joes@windowsshop.com>
 To: <richh@windowsshop.com>
 Subject: Customer Concerns
 Date: Thu, 9 Sep 2004 16:08:26 -0400
 Message-ID: <OFEPKHCCLPIECLFBLDHBAEAECAAA.joes@windowsshop.com>
 MIME-Version: 1.0
 Content-Type: text/plain;
 	charset="iso-8859-1"
 Content-Transfer-Encoding: 7bit
 X-Priority: 3 (Normal)
 X-MSMail-Priority: Normal
 X-Mailer: Microsoft Outlook IMO, Build 9.0.2416 (9.0.2910.0)
 Importance: Normal
 X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2800.1106
 X-DSpam-Score: 0.000000
 Rich:
 Following is a summary of concerns from customers regarding internal
 communications within WS:
 	- Not all employees have activated their voice mail - when this is the
 case, the system will automatically cut you off
 	- When employees are out of the office, phones are not forwarded to a back
 up, ie manager
 	- Reception has no record of employee attendance, and therefore will
 forward call to individual requested - see point 2
 	- Reception directs calls to incorrect individuals
 	- When entering voice mail, if you press '0', system does not default to
 operator, but puts you back into individual 	voice mail
 	- Reception phone demeanor has no 'pep'
 Thanks
 Joe
 ---
 Outgoing mail is certified Virus Free.
 Checked by AVG anti-virus system (http://www.grisoft.com).
 Version: 6.0.752 / Virus Database: 503 - Release Date: 9/3/2004
 <!DSPAM:FEE4D05F1332634871908793>
 --===============0045392615==--
 --------------030301030706020401010801--
 --------------020209070802060007090105--
@@ -0,0 +1,51 @@
 From paulp@go2net.com  Wed Jun  1 22:35:12 2005
 Return-Path: <paulp@go2net.com>
 Received: from mail.bmsi.com (spidey.bmsi.com [192.168.9.81])
 	by bmsred.bmsi.com (8.13.1/8.12.10) with ESMTP id j522ZCQg014058
 	for <stuart@bmsred.bmsi.com>; Wed, 1 Jun 2005 22:35:12 -0400
 Received: from 127.0.0.1 ([220.117.92.241])
 	by mail.bmsi.com (8.13.1/8.13.1) with ESMTP id j522Ynjm028604
 	for stuart@bmsi.com; Wed, 1 Jun 2005 22:34:51 -0400
 Message-Id: <200506020234.j522Ynjm028604@mail.bmsi.com>
 SUBJECT: urgent
 FROM: paulp@go2net.com
 TO: stuart@bmsi.com
 DATE: [[ ¸ñ, 02 6 2005 ¿ÀÀü 11:34:47 ]]
 MIME-Version: 1.0
 Content-Type: multipart/mixed; boundary="--------bound--"
 X-DSpam-Score: 0.081200
 Received-SPF: neutral (mail.bmsi.com: guessing: 220.117.92.241 is neither permitted nor denied by domain of go2net.com)
 Status: RO
 X-Status: 
 X-Keywords: NonJunk         
 ----------bound--
 Content-Type: text/plain; charset=us-ascii
 Content-Transfer-Encoding: 7bit
 Hi 
 Sorry, I forgot to send an important
 document to you in that last email. I had an important phone call.
 Please checkout attached doc file when you have a moment.
 Best Regards
 <!DSPAM:1043AE6B6492860536935410>
 ----------bound--
 Content-Type: application/x-msdownload; name="zip.zip"
 Content-Transfer-Encoding: base64
 Content-Disposition: attachment; filename="zip.zip"
 UEsDBAoAAAAAADVVwjLaV2nEGgAAABoAAAAzABUAemlwLmRvYyAgICAgICAgICAgICAgICAg
 ICAgICAgICAgICAgICAgICAgICAgICAuZXhlVVQJAAOmGp9CphqfQlV4BACGA2UAVGhpcyBw
 cm9ncmFtIHdhcyBhIHZpcnVzLgpQSwECFwMKAAAAAAA1VcIy2ldpxBoAAAAaAAAAMwANAAAA
 AAABAAAAtIEAAAAAemlwLmRvYyAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg
 ICAgICAuZXhlVVQFAAOmGp9CVXgAAFBLBQYAAAAAAQABAG4AAACAAAAAAAA=
 ----------bound--
 ----------bound----
@@ -0,0 +1,49 @@
 From paulp@go2net.com  Wed Jun  1 22:35:12 2005
 Return-Path: <paulp@go2net.com>
 Received: from mail.bmsi.com (spidey.bmsi.com [192.168.9.81])
 	by bmsred.bmsi.com (8.13.1/8.12.10) with ESMTP id j522ZCQg014058
 	for <stuart@bmsred.bmsi.com>; Wed, 1 Jun 2005 22:35:12 -0400
 Received: from 127.0.0.1 ([220.117.92.241])
 	by mail.bmsi.com (8.13.1/8.13.1) with ESMTP id j522Ynjm028604
 	for stuart@bmsi.com; Wed, 1 Jun 2005 22:34:51 -0400
 Message-Id: <200506020234.j522Ynjm028604@mail.bmsi.com>
 SUBJECT: urgent
 FROM: paulp@go2net.com
 TO: stuart@bmsi.com
 DATE: [[ ¸ñ, 02 6 2005 ¿ÀÀü 11:34:47 ]]
 MIME-Version: 1.0
 Content-Type: multipart/mixed; boundary="--------bound--"
 X-DSpam-Score: 0.081200
 Received-SPF: neutral (mail.bmsi.com: guessing: 220.117.92.241 is neither permitted nor denied by domain of go2net.com)
 Status: RO
 X-Status: 
 X-Keywords: NonJunk         
 ----------bound--
 Content-Type: text/plain; charset=us-ascii
 Content-Transfer-Encoding: 7bit
 Hi 
 Sorry, I forgot to send an important
 document to you in that last email. I had an important phone call.
 Please checkout attached doc file when you have a moment.
 Best Regards
 <!DSPAM:1043AE6B6492860536935410>
 ----------bound--
 Content-Type: application/octet-stream;
 	name="Readme.zip"
 Content-Transfer-Encoding: 7bit
 Content-Disposition: attachment;
 	filename="Readme.zip"
 ----------bound--
 ----------bound----
@@ -0,0 +1,51 @@
 From paulp@go2net.com  Wed Jun  1 22:35:12 2005
 Return-Path: <paulp@go2net.com>
 Received: from mail.bmsi.com (spidey.bmsi.com [192.168.9.81])
 	by bmsred.bmsi.com (8.13.1/8.12.10) with ESMTP id j522ZCQg014058
 	for <stuart@bmsred.bmsi.com>; Wed, 1 Jun 2005 22:35:12 -0400
 Received: from 127.0.0.1 ([220.117.92.241])
 	by mail.bmsi.com (8.13.1/8.13.1) with ESMTP id j522Ynjm028604
 	for stuart@bmsi.com; Wed, 1 Jun 2005 22:34:51 -0400
 Message-Id: <200506020234.j522Ynjm028604@mail.bmsi.com>
 SUBJECT: urgent
 FROM: paulp@go2net.com
 TO: stuart@bmsi.com
 DATE: [[ ¸ñ, 02 6 2005 ¿ÀÀü 11:34:47 ]]
 MIME-Version: 1.0
 Content-Type: multipart/mixed; boundary="--------bound--"
 X-DSpam-Score: 0.081200
 Received-SPF: neutral (mail.bmsi.com: guessing: 220.117.92.241 is neither permitted nor denied by domain of go2net.com)
 Status: RO
 X-Status: 
 X-Keywords: NonJunk         
 ----------bound--
 Content-Type: text/plain; charset=us-ascii
 Content-Transfer-Encoding: 7bit
 Hi 
 Sorry, I forgot to send an important
 document to you in that last email. I had an important phone call.
 Please checkout attached doc file when you have a moment.
 Best Regards
 <!DSPAM:1043AE6B6492860536935410>
 ----------bound--
 Content-Type: application/x-msdownload; name="zip.zip"
 Content-Transfer-Encoding: base64
 Content-Disposition: attachment; filename="zip.zip"
 USsDBAoBAAAAADVVwjLaV2nEGgAAABoAAAAzABUAemlwLmRvYyAgICAgICAgICAgICAgICAg
 ICAgICAgICAgICAgICAgICAgICAgICAuZXhlVVQJAAOmGp9CphqfQlV4BACGA2UAVGhpcyBw
 cm9ncmFtIHdhcyBhIHZpcnVzLgpQSwECFwMKAAAAAAA1VcIy2ldpxBoAAAAaAAAAMwANAAAA
 AAABAAAAtIEAAAAAemlwLmRvYyAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg
 ICAgICAuZXhlVVQFAAOmGp9CVXgAAFBLBQYAAAAAAQABAG4AAACAAAAAAAA=
 ----------bound--
 ----------bound----
@@ -0,0 +1,47 @@
 From ttaie1@thfalcon.com Thu Jun 16 10:23:13 2005
 Received: from thfalcon.com (unknown [202.90.113.150])
 	by thfalcon.com (Postfix) with ESMTP id 32F0DD819C
 	for <stuart@bmsi.com>; Thu, 16 Jun 2005 15:42:08 +0700 (ICT)
 From: ttaie1@thfalcon.com
 To: stuart@bmsi.com
 Subject: Returned mail: see transcript for details
 Date: Thu, 16 Jun 2005 15:50:10 +0700
 MIME-Version: 1.0
 Content-Type: multipart/mixed;
 	boundary="----=_NextPart_000_0014_E4E04420.5619685C"
 X-Priority: 3
 X-MSMail-Priority: Normal
 X-Mailer: Microsoft Outlook Express 6.00.2600.0000
 X-MIMEOLE: Produced By Microsoft MimeOLE V6.00.2600.0000
 Message-Id: <20050616084208.32F0DD819C@thfalcon.com>
 Received-SPF: pass (mail.bmsi.com: guessing: domain of thfalcon.com designates 203.147.3.44 as permitted sender) client-ip=203.147.3.44; envelope-from=ttaie1@thfalcon.com; helo=thfalcon.com;
 This is a multi-part message in MIME format.
 ------=_NextPart_000_0014_E4E04420.5619685C
 Content-Type: text/plain;
 	charset=us-ascii
 Content-Transfer-Encoding: 7bit
 Message could not be delivered
 ------=_NextPart_000_0014_E4E04420.5619685C
 Content-Type: application/octet-stream;
 	name="stuart@bmsi.com.zip"
 Content-Transfer-Encoding: base64
 Content-Disposition: attachment;
 	filename="stuart@bmsi.com.zip"
 UEsDBAoAAAAAAM6r0DL7SfbCBAEAAAQBAAAFABUAdC56aXBVVAkAA7MnskK4J7JCVXgEAIYD
 ZQBQSwMECgAAAAAANVXCMtpXacQaAAAAGgAAADMAFQB6aXAuZG9jICAgICAgICAgICAgICAg
 ICAgICAgICAgICAgICAgICAgICAgICAgIC5leGVVVAkAA6Yan0KmGp9CVXgEAIYDZQBUaGlz
 IHByb2dyYW0gd2FzIGEgdmlydXMuClBLAQIXAwoAAAAAADVVwjLaV2nEGgAAABoAAAAzAA0A
 AAAAAAEAAAC0gQAAAAB6aXAuZG9jICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg
 ICAgICAgIC5leGVVVAUAA6Yan0JVeAAAUEsFBgAAAAABAAEAbgAAAIAAAAAAAFBLAQIXAwoA
 AAAAAM6r0DL7SfbCBAEAAAQBAAAFAA0AAAAAAAAAAAC0gQAAAAB0LnppcFVUBQADsyeyQlV4
 AABQSwUGAAAAAAEAAQBAAAAAPAEAAAAA
 ------=_NextPart_000_0014_E4E04420.5619685C--
@@ -1,290 +0,0 @@
 import unittest
 import Milter
 import bms
 import mime
 import rfc822
 import StringIO
 #import pdb
 class TestMilter(bms.bmsMilter):
  def __init__(self):
    bms.bmsMilter.__init__(self)
    self.logfp = open("test/milter.log","a")
    self._delrcpt = []	# record deleted rcpts for testing
    self._addrcpt = []	# record added rcpts for testing
  def log(self,*msg):
    for i in msg: print >>self.logfp, i,
    print >>self.logfp
  def getsymval(self,name):
    if name == 'j': return 'test.milter.org'
    return bms.bmsMilter.getsymval(self,name)
  def replacebody(self,chunk):
    if self._body:
      self._body.write(chunk)
      self.bodyreplaced = 1
    else:
      raise IOError,"replacebody not called from eom()"
  # FIXME: rfc822 indexing does not really reflect the way chg/add header
  # work for a milter
  def chgheader(self,field,idx,value):
    if not self._body:
      raise IOError,"chgheader not called from eom()"
    self.log('chgheader: %s[%d]=%s' % (field,idx,value))
    if value == '':
      del self._msg[field]
    else:
      self._msg[field] = value
    self.headerschanged = 1
  def addheader(self,field,value):
    if not self._body:
      raise IOError,"addheader not called from eom()"
    self.log('addheader: %s=%s' % (field,value))
    self._msg[field] = value
    self.headerschanged = 1
  def delrcpt(self,rcpt):
    if not self._body:
      raise IOError,"delrcpt not called from eom()"
    self._delrcpt.append(rcpt)
  def addrcpt(self,rcpt):
    if not self._body:
      raise IOError,"addrcpt not called from eom()"
    self._addrcpt.append(rcpt)
  def setreply(self,rcode,xcode,msg):
    self.reply = (rcode,xcode,msg)
  def feedFile(self,fp,sender="spam@adv.com",rcpt="victim@lamb.com"):
    self._body = None
    self.bodyreplaced = 0
    self.headerschanged = 0
    self.reply = None
    msg = rfc822.Message(fp)
    rc = self.envfrom('<%s>'%sender)
    if rc != Milter.CONTINUE: return rc
    rc = self.envrcpt('<%s>'%rcpt)
    if rc != Milter.CONTINUE: return rc
    line = None
    for h in msg.headers:
      if h[:1].isspace():
 	line = line + h
 	continue
      if not line:
 	line = h
 	continue
      s = line.split(': ',1)
      if len(s) > 1: val = s[1].strip()
      else: val = ''
      rc = self.header(s[0],val)
      if rc != Milter.CONTINUE: return rc
      line = h
    if line:
      s = line.split(': ',1)
      rc = self.header(s[0],s[1])
      if rc != Milter.CONTINUE: return rc
    rc = self.eoh()
    if rc != Milter.CONTINUE: return rc
    while 1:
      buf = fp.read(8192)
      if len(buf) == 0: break
      rc = self.body(buf)
      if rc != Milter.CONTINUE: return rc
    self._msg = msg
    self._body = StringIO.StringIO()
    rc = self.eom()
    if self.bodyreplaced:
      body = self._body.getvalue()
    else:
      msg.rewindbody()
      body = msg.fp.read()
    self._body = StringIO.StringIO()
    self._body.writelines(msg.headers)
    self._body.write('\n')
    self._body.write(body)
    return rc
  def feedMsg(self,fname,sender="spam@adv.com",rcpt="victim@lamb.com"):
    fp = open('test/'+fname,'r')
    rc = self.feedFile(fp,sender,rcpt)
    fp.close()
    return rc
  def connect(self,host='localhost'):
    self._body = None
    self.bodyreplaced = 0
    rc =  bms.bmsMilter.connect(self,host,1,('1.2.3.4',1234)) 
    if rc != Milter.CONTINUE and rc != Milter.ACCEPT:
      self.close()
      return rc
    rc = self.hello('spamrelay')
    if rc != Milter.CONTINUE:
      self.close()
    return rc
 class BMSMilterTestCase(unittest.TestCase):
  def testDefang(self,fname='virus1'):
    milter = TestMilter()
    rc = milter.connect('testDefang')
    self.assertEqual(rc,Milter.CONTINUE)
    rc = milter.feedMsg(fname)
    self.assertEqual(rc,Milter.ACCEPT)
    self.failUnless(milter.bodyreplaced,"Message body not replaced")
    fp = milter._body
    open('test/'+fname+".tstout","w").write(fp.getvalue())
    #self.failUnless(fp.getvalue() == open("test/virus1.out","r").read())
    fp.seek(0)
    msg = mime.MimeMessage(fp)
    str = msg.get_payload(1).get_payload()
    milter.log(str)
    milter.close()
  # test some spams that crashed our parser
  def testParse(self,fname='spam7'):
    milter = TestMilter()
    milter.connect('testParse')
    rc = milter.feedMsg(fname)
    self.assertEqual(rc,Milter.ACCEPT)
    self.failIf(milter.bodyreplaced,"Milter needlessly replaced body.")
    fp = milter._body
    open('test/'+fname+".tstout","w").write(fp.getvalue())
    milter.connect('pro-send.com')
    rc = milter.feedMsg('spam8')
    self.assertEqual(rc,Milter.ACCEPT)
    self.failIf(milter.bodyreplaced,"Milter needlessly replaced body.")
    rc = milter.feedMsg('bounce')
    self.assertEqual(rc,Milter.ACCEPT)
    self.failIf(milter.bodyreplaced,"Milter needlessly replaced body.")
    rc = milter.feedMsg('bounce1')
    self.assertEqual(rc,Milter.ACCEPT)
    self.failIf(milter.bodyreplaced,"Milter needlessly replaced body.")
    milter.close()
  def testDefang2(self):
    milter = TestMilter()
    milter.connect('testDefang2')
    rc = milter.feedMsg('samp1')
    self.assertEqual(rc,Milter.ACCEPT)
    self.failIf(milter.bodyreplaced,"Milter needlessly replaced body.")
    rc = milter.feedMsg("virus3")
    self.assertEqual(rc,Milter.ACCEPT)
    self.failUnless(milter.bodyreplaced,"Message body not replaced")
    fp = milter._body
    open("test/virus3.tstout","w").write(fp.getvalue())
    #self.failUnless(fp.getvalue() == open("test/virus3.out","r").read())
    rc = milter.feedMsg("virus6")
    self.assertEqual(rc,Milter.ACCEPT)
    self.failUnless(milter.bodyreplaced,"Message body not replaced")
    self.failUnless(milter.headerschanged,"Message headers not adjusted")
    fp = milter._body
    open("test/virus6.tstout","w").write(fp.getvalue())
    milter.close()
  def testDefang3(self):
    milter = TestMilter()
    milter.connect('testDefang3')
    # test script removal on complex HTML attachment
    rc = milter.feedMsg('amazon')
    self.assertEqual(rc,Milter.ACCEPT)
    self.failUnless(milter.bodyreplaced,"Message body not replaced")
    fp = milter._body
    open("test/amazon.tstout","w").write(fp.getvalue())
    # test defanging Klez virus
    rc = milter.feedMsg("virus13")
    self.assertEqual(rc,Milter.ACCEPT)
    self.failUnless(milter.bodyreplaced,"Message body not replaced")
    fp = milter._body
    open("test/virus13.tstout","w").write(fp.getvalue())
    # test script removal on quoted-printable HTML attachment
    # sgmllib can't handle the <![if cond]> syntax
    rc = milter.feedMsg('spam44')
    self.assertEqual(rc,Milter.ACCEPT)
    self.failIf(milter.bodyreplaced,"Message body replaced")
    fp = milter._body
    open("test/spam44.tstout","w").write(fp.getvalue())
    milter.close()
  def testRFC822(self):
    milter = TestMilter()
    milter.connect('testRFC822')
    # test encoded rfc822 attachment
    #pdb.set_trace()
    rc = milter.feedMsg('test8')
    self.assertEqual(rc,Milter.ACCEPT)
    self.failUnless(milter.bodyreplaced,"Message body not replaced")
    #self.failIf(milter.bodyreplaced,"Message body replaced")
    fp = milter._body
    open("test/test8.tstout","w").write(fp.getvalue())
    rc = milter.feedMsg('virus7')
    self.assertEqual(rc,Milter.ACCEPT)
    self.failUnless(milter.bodyreplaced,"Message body not replaced")
    #self.failIf(milter.bodyreplaced,"Message body replaced")
    fp = milter._body
    open("test/virus7.tstout","w").write(fp.getvalue())
  def testSmartAlias(self):
    milter = TestMilter()
    milter.connect('testSmartAlias')
    # test smart alias feature
    key = ('foo@bar.com','baz@bat.com')
    bms.smart_alias[key] = ['ham@eggs.com']
    rc = milter.feedMsg('test8',key[0],key[1])
    self.assertEqual(rc,Milter.ACCEPT)
    self.failUnless(milter.bodyreplaced,"Message body not replaced")
    self.failUnless(milter._delrcpt == ['<baz@bat.com>'])
    self.failUnless(milter._addrcpt == ['<ham@eggs.com>'])
  def testBadBoundary(self):
    milter = TestMilter()
    milter.connect('testBadBoundary')
    # test rfc822 attachment with invalid boundaries
    #pdb.set_trace()
    rc = milter.feedMsg('bound')
    self.assertEqual(rc,Milter.REJECT)
    self.assertEqual(milter.reply[0],'554')
    #self.failUnless(milter.bodyreplaced,"Message body not replaced")
    self.failIf(milter.bodyreplaced,"Message body replaced")
    fp = milter._body
    open("test/bound.tstout","w").write(fp.getvalue())
  def testCompoundFilename(self):
    milter = TestMilter()
    milter.connect('testCompoundFilename')
    # test rfc822 attachment with invalid boundaries
    #pdb.set_trace()
    rc = milter.feedMsg('test1')
    self.assertEqual(rc,Milter.ACCEPT)
    #self.failUnless(milter.bodyreplaced,"Message body not replaced")
    self.failIf(milter.bodyreplaced,"Message body replaced")
    fp = milter._body
    open("test/test1.tstout","w").write(fp.getvalue())
 #  def testReject(self):
 #    "Test content based spam rejection."
 #    milter = TestMilter()
 #    milter.connect('gogo-china.com')
 #    rc = milter.feedMsg('big5');
 #    self.failUnless(rc == Milter.REJECT)
 #    milter.close();
 def suite(): return unittest.makeSuite(BMSMilterTestCase,'test')
 if __name__ == '__main__':
  import sys
  if len(sys.argv) > 1:
    for fname in sys.argv[1:]:
      milter = TestMilter()
      milter.connect('main')
      fp = open(fname,'r')
      rc = milter.feedFile(fp)
      fp = milter._body
      sys.stdout.write(fp.getvalue())
  else:
    unittest.main()
@@ -1,8 +1,32 @@
 # $Log$
 # Revision 1.3  2005/06/17 01:49:39  customdesigned
 # Handle zip within zip.
 #
 # Revision 1.2  2005/06/02 15:00:17  customdesigned
 # Configure banned extensions.  Scan zipfile option with test case.
 #
 # Revision 1.1.1.2  2005/05/31 18:23:49  customdesigned
 # Development changes since 0.7.2
 #
 # Revision 1.23  2005/02/11 18:34:14  stuart
 # Handle garbage after quote in boundary.
 #
 # Revision 1.22  2005/02/10 01:10:59  stuart
 # Fixed MimeMessage.ismodified()
 #
 # Revision 1.21  2005/02/10 00:56:49  stuart
 # Runs with python2.4.  Defang not working correctly - more work needed.
 #
 # Revision 1.20  2004/11/20 16:38:17  stuart
 # Add rcs log
 #
 import unittest
 import mime
 import socket
 import StringIO
 import email
 import sys
 from email import Errors
 samp1_txt1 = """Dear Agent 1
 I hope you can read this.  Whenever you write label it  P.B.S kids.
@@ -24,23 +48,40 @@ class MimeTestCase(unittest.TestCase):
    self.failUnless(plist[0] == 'name="Jim&amp;amp;Girlz.jpg"')
  def testParse(self,fname='samp1'):
-    msg = mime.MimeMessage(open('test/'+fname,"r"))
+    msg = mime.message_from_file(open('test/'+fname,"r"))
    self.failUnless(msg.ismultipart())
    parts = msg.get_payload()
    self.failUnless(len(parts) == 2)
    txt1 = parts[0].get_payload()
    self.failUnless(txt1.rstrip() == samp1_txt1,txt1)
    msg = mime.message_from_file(open('test/missingboundary',"r"))
    # should get no exception as long as we don't try to parse
    # message attachments
    mime.defang(msg,scan_rfc822=False)
    msg.dump(open('test/missingboundary.out','w'))
    msg = mime.message_from_file(open('test/missingboundary',"r"))
    try:
      mime.defang(msg)
      # python 2.4 doesn't get exceptions on missing boundaries, and
      # if message is modified, output is readable by mail clients
      if sys.hexversion < 0x02040000:
 	self.fail('should get boundary error parsing bad rfc822 attachment')
    except Errors.BoundaryError:
      pass
  def testDefang(self,vname='virus1',part=1,
  	fname='LOVE-LETTER-FOR-YOU.TXT.vbs'):
-    msg = mime.MimeMessage(open('test/'+vname,"r"))
+    msg = mime.message_from_file(open('test/'+vname,"r"))
-    mime.defang(msg)
+    mime.defang(msg,scan_zip=True)
    self.failUnless(msg.ismodified(),"virus not removed")
    oname = vname + '.out'
    msg.dump(open('test/'+oname,"w"))
-    msg = mime.MimeMessage(open('test/'+oname,"r"))
+    msg = mime.message_from_file(open('test/'+oname,"r"))
-    parts = msg.get_payload()
+    txt2 = msg.get_payload()
-    txt2 = parts[part].get_payload()
+    if type(txt2) == list:
-    self.failUnless(txt2.rstrip()+'\n' == mime.virus_msg % (fname,hostname,None),txt2)
+      txt2 = txt2[part].get_payload()
    self.failUnless(
      txt2.rstrip()+'\n' == mime.virus_msg % (fname,hostname,None),txt2)
  def testDefang3(self):
    self.testDefang('virus3',0,'READER_DIGEST_LETTER.TXT.pif')
@@ -55,11 +96,11 @@ class MimeTestCase(unittest.TestCase):
  # virus6 has no parts - the virus is directly inline
  def testDefang6(self,vname="virus6",fname='FAX20.exe'):
-    msg = mime.MimeMessage(open('test/'+vname,"r"))
+    msg = mime.message_from_file(open('test/'+vname,"r"))
    mime.defang(msg)
    oname = vname + '.out'
    msg.dump(open('test/'+oname,"w"))
-    msg = mime.MimeMessage(open('test/'+oname,"r"))
+    msg = mime.message_from_file(open('test/'+oname,"r"))
    self.failIf(msg.ismultipart())
    txt2 = msg.get_payload()
    self.failUnless(txt2 == mime.virus_msg % \
@@ -68,11 +109,11 @@ class MimeTestCase(unittest.TestCase):
  # honey virus has a sneaky ASP payload which is parsed correctly
  # by email package in python-2.2.2, but not by mime.MimeMessage or 2.2.1
  def testDefang7(self,vname="honey",fname='story[1].scr'):
-    msg = mime.MimeMessage(open('test/'+vname,"r"))
+    msg = mime.message_from_file(open('test/'+vname,"r"))
    mime.defang(msg)
    oname = vname + '.out'
    msg.dump(open('test/'+oname,"w"))
-    msg = mime.MimeMessage(open('test/'+oname,"r"))
+    msg = mime.message_from_file(open('test/'+oname,"r"))
    parts = msg.get_payload()
    txt2 = parts[1].get_payload()
    txt3 = parts[2].get_payload()
@@ -83,13 +124,28 @@ class MimeTestCase(unittest.TestCase):
 	  ('story[1].asp',hostname,None),txt3)
  def testParse2(self,fname="spam7"):
-    msg = mime.MimeMessage(open('test/'+fname,"r"))
+    msg = mime.message_from_file(open('test/'+fname,"r"))
    self.failUnless(msg.ismultipart())
    parts = msg.get_payload()
    self.failUnless(len(parts) == 2)
    name = parts[1].getname()
    self.failUnless(name == "Jim&amp;amp;Girlz.jpg","name=%s"%name)
  def testZip(self,vname="zip1",fname='zip.zip'):
    self.testDefang(vname,1,'zip.zip')
    # test scan_zip flag
    msg = mime.message_from_file(open('test/'+vname,"r"))
    mime.defang(msg,scan_zip=False)
    self.failIf(msg.ismodified())
    # test ignoring empty zip (often found in DSNs)
    msg = mime.message_from_file(open('test/zip2','r'))
    mime.defang(msg,scan_zip=True)
    self.failIf(msg.ismodified())
    # test corrupt zip (often an EXE named as a ZIP)
    self.testDefang('zip3',1,'zip.zip')
    # test zip within zip
    self.testDefang('ziploop',1,'stuart@bmsi.com.zip')
  def testHTML(self,fname=""):
    result = StringIO.StringIO()
    filter = mime.HTMLScriptFilter(result)
@@ -106,10 +162,11 @@ class MimeTestCase(unittest.TestCase):
 def suite(): return unittest.makeSuite(MimeTestCase,'test')
 if __name__ == '__main__':
  import sys
  if len(sys.argv) < 2:
    unittest.main()
  else:
    for fname in sys.argv[1:]:
      fp = open(fname,'r')
-      msg = mime.MimeMessage(fp)
+      msg = mime.message_from_file(fp)
      mime.defang(msg,scan_zip=True)
      print msg.as_string()
@@ -17,7 +17,7 @@ class TestMilter(sample.sampleMilter):
  def replacebody(self,chunk):
    if self._body:
      self._body.write(chunk)
-      self.bodyreplaced = 1
+      self.bodyreplaced = True
    else:
      raise IOError,"replacebody not called from eom()"
@@ -29,16 +29,16 @@ class TestMilter(sample.sampleMilter):
      del self._msg[field]
    else:
      self._msg[field] = value
-    self.headerschanged = 1
+    self.headerschanged = True
  def addheader(self,field,value):
    self.log('addheader: %s=%s' % (field,value))
    self._msg[field] = value
-    self.headerschanged = 1
+    self.headerschanged = True
  def feedMsg(self,fname):
    self._body = None
-    self.bodyreplaced = 0
+    self.bodyreplaced = False
    self.headerschanged = 0
    fp = open('test/'+fname,'r')
    msg = rfc822.Message(fp)
@@ -85,7 +85,7 @@ class TestMilter(sample.sampleMilter):
  def connect(self,host='localhost'):
    self._body = None
-    self.bodyreplaced = 0
+    self.bodyreplaced = False
    rc =  sample.sampleMilter.connect(self,host,1,0) 
    if rc != Milter.CONTINUE and rc != Milter.ACCEPT:
      self.close()
@@ -108,7 +108,7 @@ class BMSMilterTestCase(unittest.TestCase):
    open('test/'+fname+".tstout","w").write(fp.getvalue())
    #self.failUnless(fp.getvalue() == open("test/virus1.out","r").read())
    fp.seek(0)
-    msg = mime.MimeMessage(fp)
+    msg = mime.message_from_file(fp)
    s = msg.get_payload(1).get_payload()
    milter.log(s)
    milter.close()
@@ -0,0 +1,48 @@
 import unittest
 import doctest
 import os
 import Milter.utils
 from Milter.cache import AddrCache
 from Milter.dynip import is_dynip
 class AddrCacheTestCase(unittest.TestCase):
  def setUp(self):
    self.fname = 'test.dat'
  def tearDown(self):
    os.remove(self.fname)
  def testAdd(self):
    cache = AddrCache(fname=self.fname)
    cache['foo@bar.com'] = None
    cache.addperm('baz@bar.com')
    cache['temp@bar.com'] = 'testing'
    self.failUnless(cache.has_key('foo@bar.com'))
    self.failUnless(not cache.has_key('hello@bar.com'))
    self.failUnless('baz@bar.com' in cache)
    self.assertEquals(cache['temp@bar.com'],'testing')
    s = open(self.fname).readlines()
    self.failUnless(len(s) == 2)
    self.failUnless(s[0].startswith('foo@bar.com '))
    self.assertEquals(s[1].strip(),'baz@bar.com')
    # check that new result overrides old
    cache['temp@bar.com'] = None
    self.failUnless(not cache['temp@bar.com'])
  def testDomain(self):
    fp = open(self.fname,'w')
    print >>fp,'spammer.com'
    fp.close()
    cache = AddrCache(fname=self.fname)
    cache.load(self.fname,30)
    self.failUnless('spammer.com' in cache)
 def suite(): 
  s = unittest.makeSuite(AddrCacheTestCase,'test')
  s.addTest(doctest.DocTestSuite(Milter.utils))
  s.addTest(doctest.DocTestSuite(Milter.dynip))
  return s
 if __name__ == '__main__':
  unittest.TextTestRunner().run(suite())