pypolicyd-spf-0.1/0000755000175000017500000000000010553573361014406 5ustar kittermakittermapypolicyd-spf-0.1/CHANGES0000644000175000017500000000100610553523620015367 0ustar kittermakitterma# Legend: # --- = A new release # + = Added a feature (in a backwards compatible way) # ! = Changed something significant, or removed a feature # * = Fixed a bug, or made a minor improvement --- 0.1 (2007-01-17 18:00) ! Initial release ! Removed greylisting ! Stubbed out config files until they can be updated and integrated + Defer on temperror + Reject on permerror + Check HELO for null Sender (Mail From) --- 0.0 Source from Tumgreyspf (2007-01-11 00:00) ! Source Tumgreyspf Version 1.24 pypolicyd-spf-0.1/INSTALL0000644000175000017500000000340010553523620015425 0ustar kittermakittermaINSTALLING Use the supplied setup.py to install this package: $ python setup.py build Gain root priviledges using su or sudo (distribution dependent) # python setup.py install You will need to integrate python-policyd-spf with Postfix: CONFIGURING POSTFIX Add to your postfix master.cf: policy-spf unix - n n - - spawn user=nobody argv=/usr/bin/python /usr/bin/policyd-spf Next, main.cf must be configured so that "smtpd_sender_restrictions" or "smtpd_recipient_restrictions" includes a call to the policy-spf policy filter. If you already have a "smtpd_sender_restrictions" line(s), you can add the following line anywhere after the line which reads "reject_unauth_destination". check_policy_service unix:private/policyd-spf WARNING: It's very important that you have "reject_unauth_destination" before the "check_policy_service". If you do not, your system may be an open relay. So, for example, a minimal "smtpd_sender_restrictions" may look like: smtpd_sender_restrictions = \ reject_unauth_destination, \ check_policy_service unix:private/policyd-spf Please consult the postfix documentation for more information on these and other settings you may wish to have in the "smtpd_recipient_restrictions" configuration. Similar considerations apply to "smtpd_recipient_restrictions". Since SPF checks require external DNS lookups it may be more effecient to place this policy check in "smtpd_recipient_restrictions" after invalid recipients have already been rejected. You will also need to have a line in the main.cf which reads: policy_time_limit = 3600 pypolicyd-spf-0.1/LICENSE0000644000175000017500000004310310553523620015405 0ustar kittermakitterma 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. Copyright (C) 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. , 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. pypolicyd-spf-0.1/policyd-spf0000755000175000017500000001406610553523620016565 0ustar kittermakitterma#!/usr/bin/python # # Check SPF results and provide recommended action back to Postfix. # # Tumgreyspf source # Copyright (c) 2004-2005, Sean Reifschneider, tummy.com, ltd. # # # pypolicyd-spf # Copyright (c) 2007, Scott Kitterman ''' 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.''' import syslog, os, sys, string, re, time, popen2, urllib, stat, errno sys.path.append('/usr/local/lib/policy-spf') import policydspfsupp syslog.openlog(os.path.basename(sys.argv[0]), syslog.LOG_PID, syslog.LOG_MAIL) policydspfsupp.setExceptHook() ############################################# def spfcheck(data, configData, configGlobal): #{{{1 debugLevel = configGlobal.get('debugLevel', 0) ip = data.get('client_address') if ip == None: if debugLevel: syslog.syslog('spfcheck: No client address, exiting') return(( None, None )) if ip[:4] == '127.': return (( None, 'SPF check N/A for local connections' )) sender = data.get('sender') helo = data.get('helo_name') if not sender and not helo: if debugLevel: syslog.syslog('spfcheck: No sender or helo, exiting') return(( None, None )) # if no helo name sent, use domain from sender if not helo: foo = string.split(sender, '@', 1) if len(foo) < 2: helo = 'unknown' else: helo = foo[1] # start query spfResult = None spfReason = None # try to use pyspf try: import spf ret = spf.check2(i = ip, s = sender, h = helo) spfResult = string.strip(ret[0]) spfReason = string.strip(ret[1]) if debugLevel: syslog.syslog('spfcheck: pyspf result: "%s"' % str(ret)) except ImportError: pass # try spfquery - Add back in later '''if not spfResult: # check for spfquery spfqueryPath = configGlobal['spfqueryPath'] if not os.path.exists(spfqueryPath): if debugLevel: syslog.syslog('spfcheck: No spfquery at "%s", exiting' % spfqueryPath) return(( None, None )) # open connection to spfquery fpIn, fpOut = popen2.popen2('%s -file -' % spfqueryPath) fpOut.write('%s %s %s\n' % ( ip, sender, helo )) fpOut.close() spfData = fpIn.readlines() fpIn.close() if debugLevel: syslog.syslog('spfcheck: spfquery result: "%s"' % str(spfData)) spfResult = string.strip(spfData[0]) spfReason = string.strip(spfData[1])''' # read result if spfResult == 'fail' or spfResult == 'permerror': syslog.syslog('SPF fail: REMOTEIP="%s" HELO="%s" SENDER="%s" ' 'RECIPIENT="%s" QUEUEID="%s" REASON="%s"' % ( data.get('client_address', ''), data.get('helo_name', ''), data.get('sender', ''), data.get('recipient', ''), data.get('queue_id', ''), spfReason ) ) return(( 'reject', 'SPF Reports: %s' % str(spfReason) )) if spfResult == 'permerror': syslog.syslog('SPF pemerror: REMOTEIP="%s" HELO="%s" SENDER="%s" ' 'RECIPIENT="%s" QUEUEID="%s" REASON="%s"' % ( data.get('client_address', ''), data.get('helo_name', ''), data.get('sender', ''), data.get('recipient', ''), data.get('queue_id', ''), spfReason ) ) return(( 'reject', 'SPF Reports: %s' % str(spfReason) )) if spfResult == 'temperror': syslog.syslog('SPF TempError: REMOTEIP="%s" HELO="%s" SENDER="%s" ' 'RECIPIENT="%s" QUEUEID="%s" REASON="%s"' % ( data.get('client_address', ''), data.get('helo_name', ''), data.get('sender', ''), data.get('recipient', ''), data.get('queue_id', ''), spfReason ) ) return(( 'defer', 'SPF Reports: %s' % str(spfReason) )) return(( None, None )) ################################################### # load config file {{{1 configFile = policydspfsupp.defaultConfigFilename if len(sys.argv) > 1: if sys.argv[1] in ( '-?', '--help', '-h' ): print 'usage: policy-spf []' sys.exit(1) configFile = sys.argv[1] configGlobal = policydspfsupp.processConfigFile(filename = configFile) # loop reading data {{{1 debugLevel = configGlobal.get('debugLevel', 0) if debugLevel >= 2: syslog.syslog('Starting') data = {} lineRx = re.compile(r'^\s*([^=\s]+)\s*=(.*)$') while 1: line = sys.stdin.readline() if not line: break line = string.rstrip(line) if debugLevel >= 4: syslog.syslog('Read line: "%s"' % line) # end of entry {{{2 if not line: if debugLevel >= 4: syslog.syslog('Found the end of entry') #TO DO Make Config file work configData = configGlobal #configData = policydspfsupp.lookupConfig(configGlobal.get('configPath'), # data, configGlobal) if debugLevel >= 2: syslog.syslog('Config: %s' % str(configData)) # run the checkers {{{3 checkerValue = None checkerReason = None checkerValue, checkerReason = spfcheck(data, configData, configGlobal) if configData.get('SPFSEEDONLY', 0): checkerValue = None checkerReason = None # handle results {{{3 if checkerValue == 'defer': sys.stdout.write('action=defer_if_permit %s\n\n' % checkerReason) elif checkerValue == 'reject': sys.stdout.write('action=550 %s\n\n' % checkerReason) else: sys.stdout.write('action=dunno\n\n') # end of record {{{3 sys.stdout.flush() data = {} continue # parse line {{{2 m = lineRx.match(line) if not m: syslog.syslog('ERROR: Could not match line "%s"' % line) continue # save the string {{{2 key = m.group(1) value = m.group(2) if key not in [ 'protocol_state', 'protocol_name', 'queue_id' ]: value = string.lower(value) data[key] = value pypolicyd-spf-0.1/policydspfsupp.py0000755000175000017500000002231210553523620020040 0ustar kittermakitterma#!/usr/bin/python # # Tumgreyspf # Copyright (c) 2004-2005, Sean Reifschneider, tummy.com, ltd. # # pypolicyd-spf changes # Copyright (c) 2007, Scott Kitterman ''' 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.''' import syslog, os, sys, string, re, time, popen2, urllib, stat # default values defaultConfigFilename = '/var/local/lib/policyd-spf/config/policy-spf.conf' defaultConfigData = { 'debugLevel' : 0, 'defaultSeedOnly' : 1, 'configPath' : 'file:///var/local/lib/policyd-spf/config', 'spfqueryPath' : '/usr/local/lib/policyd-spf/spfquery', } ################################# class ConfigException(Exception): '''Exception raised when there's a configuration file error.''' pass ################################# def loadConfigFile(file, values): '''Load the specified config file if it exists, raise ValueError if there is an error in the config file. "values" is a dictionary of default config values. "values" is modified in place, and nothing is returned.''' if not os.path.exists(file): return try: execfile(file, {}, values) except Exception, e: import traceback etype, value, tb = sys.exc_info() raise ConfigException, ('Error reading config file "%s": %s' % ( file, sys.exc_info()[1] )) return() #################################################################### def processConfigFile(filename = None, config = None, useSyslog = 1, useStderr = 0): '''Load the specified config file, exit and log errors if it fails, otherwise return a config dictionary.''' import policydspfsupp if config == None: config = policydspfsupp.defaultConfigData if filename == None: filename = policydspfsupp.defaultConfigFilename #TO DO Make config file work #try: # loadConfigFile(filename, config) #except Exception, e: # if useSyslog: # syslog.syslog(e.args[0]) # if useStderr: # sys.stderr.write('%s\n' % e.args[0]) # sys.exit(1) return(config) ################# class ExceptHook: def __init__(self, useSyslog = 1, useStderr = 0): self.useSyslog = useSyslog self.useStderr = useStderr def __call__(self, etype, evalue, etb): import traceback, string tb = traceback.format_exception(*(etype, evalue, etb)) tb = map(string.rstrip, tb) tb = string.join(tb, '\n') for line in string.split(tb, '\n'): if self.useSyslog: syslog.syslog(line) if self.useStderr: sys.stderr.write(line + '\n') #################### def setExceptHook(): sys.excepthook = ExceptHook(useSyslog = 1, useStderr = 1) #################### 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 len(s) > 0 and s[0] == '.': s = '%2e' + s[1:] return(s) ###################### def unquoteAddress(s): '''Undo the quoting of an address. Returns the unquoted address.''' return(urllib.unquote(s)) ############################################################### commentRx = re.compile(r'^(.*)#.*$') def readConfigFile(path, configData = None, configGlobal = {}): '''Reads a configuration file from the specified path, merging it with the configuration data specified in configData. Returns a dictionary of name/value pairs based on configData and the values read from path.''' debugLevel = configGlobal.get('debugLevel', 0) if debugLevel >= 3: syslog.syslog('readConfigFile: Loading "%s"' % path) if configData == None: configData = {} nameConversion = { 'SPFSEEDONLY' : int, 'GREYLISTTIME' : int, 'CHECKERS' : str, 'OTHERCONFIGS' : str, 'GREYLISTEXPIREDAYS' : float, } # check to see if it's a file try: mode = os.stat(path)[0] except OSError, e: syslog.syslog('ERROR stating "%s": %s' % ( path, e.strerror )) return(configData) if not stat.S_ISREG(mode): syslog.syslog('ERROR: is not a file: "%s", mode=%s' % ( path, oct(mode) )) return(configData) # load file fp = open(path, 'r') while 1: line = fp.readline() if not line: break # parse line line = string.strip(string.split(line, '#', 1)[0]) if not line: continue data = map(string.strip, string.split(line, '=', 1)) if len(data) != 2: syslog.syslog('ERROR parsing line "%s" from file "%s"' % ( line, path )) continue name, value = data # check validity of name conversion = nameConversion.get(name) if conversion == None: syslog.syslog('ERROR: Unknown name "%s" in file "%s"' % ( name, path )) continue if debugLevel >= 4: syslog.syslog('readConfigFile: Found entry "%s=%s"' % ( name, value )) configData[name] = conversion(value) fp.close() return(configData) #################################################### def lookupConfig(configPath, msgData, configGlobal): '''Given a path, load the configuration as dictated by the msgData information. Returns a dictionary of name/value pairs.''' debugLevel = configGlobal.get('debugLevel', 0) # set up default config configData = { 'SPFSEEDONLY' : configGlobal.get('defaultSeedOnly'), 'CHECKSPF' : 1, 'OTHERCONFIGS' : 'envelope_sender,envelope_recipient', } # load directory-based config information if configPath[:8] == 'file:///': if debugLevel >= 3: syslog.syslog('lookupConfig: Starting file lookup from "%s"' % configPath) basePath = configPath[7:] configData = {} # load default config path = os.path.join(basePath, '__default__') if os.path.exists(path): if debugLevel >= 3: syslog.syslog('lookupConfig: Loading default config: "%s"' % path) configData = readConfigFile(path, configData, configGlobal) else: syslog.syslog(('lookupConfig: No default config found in "%s", ' 'this is probably an install problem.') % path) # load other configs from OTHERCONFIGS configsAlreadyLoaded = {} didLoad = 1 while didLoad: didLoad = 0 otherConfigs = string.split(configData.get('OTHERCONFIGS', ''), ',') if not otherConfigs or otherConfigs == ['']: break if debugLevel >= 3: syslog.syslog('lookupConfig: Starting load of configs: "%s"' % str(otherConfigs)) # SENDER/RECIPIENT for cfgType in otherConfigs: cfgType = string.strip(cfgType) # skip if already loaded if configsAlreadyLoaded.get(cfgType) != None: continue configsAlreadyLoaded[cfgType] = 1 didLoad = 1 if debugLevel >= 3: syslog.syslog('lookupConfig: Trying config "%s"' % cfgType) # SENDER/RECIPIENT if cfgType == 'envelope_sender' or cfgType == 'envelope_recipient': # get address if cfgType == 'envelope_sender': address = msgData.get('sender') else: address = msgData.get('recipient') if not address: if debugLevel >= 2: syslog.syslog('lookupConfig: Could not find %s' % cfgType) continue # split address into domain and local data = string.split(address, '@', 1) if len(data) != 2: if debugLevel >= 2: syslog.syslog('lookupConfig: Could not find %s address ' 'from "%s", skipping' % ( cfgType, address )) continue local = quoteAddress(data[0]) domain = quoteAddress(data[1]) # load configs path = os.path.join(basePath, cfgType) domainPath = os.path.join(path, domain, '__default__') localPath = os.path.join(path, domain, local) for name in ( domainPath, localPath ): if debugLevel >= 3: syslog.syslog('lookupConfig: Trying file "%s"' % name) if os.path.exists(name): configData = readConfigFile(name, configData, configGlobal) # CLIENT IP ADDRESS elif cfgType == 'client_address': ip = msgData.get('client_address') if not ip: if debugLevel >= 2: syslog.syslog('lookupConfig: Could not find client ' 'address') else: path = basePath for name in [ 'client_address' ] \ + list(string.split(ip, '.')): path = os.path.join(path, name) defaultPath = os.path.join(path, '__default__') if debugLevel >= 3: syslog.syslog('lookupConfig: Trying file "%s"' % defaultPath) if os.path.exists(defaultPath): configData = readConfigFile(defaultPath, configData, configGlobal) if debugLevel >= 3: syslog.syslog('lookupConfig: Trying file "%s"' % path) if os.path.exists(path): configData = readConfigFile(path, configData, configGlobal) # unknown configuration type else: syslog.syslog('ERROR: Unknown configuration type: "%s"' % cfgType) # unkonwn config path else: syslog.syslog('ERROR: Unknown path type in: "%s", using defaults' % msgData) # return results return(configData) pypolicyd-spf-0.1/README0000644000175000017500000000630410553523620015262 0ustar kittermakittermaPython Postfix Policy for SPF (python-policy-spf) 0.01 Python based policy daemon for Postfix SPF checking Tumgreyspf source Copyright (c) 2004-2005, Sean Reifschneider, tummy.com, ltd. python-policyd-spf changes Copyright (c) 2007, Scott Kitterman Documentation inputs: Copyright (c) 2004-2005, Sean Reifschneider, tummy.com, ltd. 2003-2004 Meng Weng Wong from postfix-policyd-spf-perl Copyright (c) 2007, Scott Kitterman ================= This is python-policyd-spf, an external policy checker for the postfix mail server. It will use pyspf to check SPF records to determine if email should be rejected by your server. LICENSE python-policyd-spf is licensed under the GPLv2. REQUIREMENTS Python 2.3 or above http://www.python.org/ Postfix 2.1 or above http://www.postfix.org/ Pyspf 2.0 or above http://cheeseshop.python.org/pypi/pyspf/ DESCRIPTION This documentation assumes you have read Postfix's README_FILES/ SMTPD_POLICY_README.. Each time a Postfix SMTP server process is started it connects to the policy service socket, and Postfix runs one instance of this Python script. By default, a Postfix SMTP server process terminates after 100 seconds of idle time, or after serving 100 clients. Thus, the cost of starting this Python script is smoothed out over time. The default policy_time_limit is 1000 seconds. This may be too short for some SMTP transactions to complete. As recommended in SMTPD_POLICY_README, this should be extended to 3600 seconds. To do so, set "policy_time_limit = 3600" in /etc/postfix/main.cf. Detailed instructions for installing python-policy-spf and integrating it with Postfix can be found in the INSTALL file (Note: Versions of the program packaged with specific distributions may provide a distribution specific install file). LOGGING Policyd-spf will log messages to syslog about it's activities. The "debugLevel" value in "policyd-spf.conf" can be increased to get additional information to be logged. When set to a value of "0", only test results (SPF hits/misses) are logged. Look for "policy-spf" in your mail log files. TODO Warning - Currently config files are not processed. Logging can be changed in the default values in policydspfsupp.py. TESTING To test the policy daemon by hand, execute: % python /usr/bin/policyd-spf Each query is a bunch of attributes. Order does not matter, and the daemon uses only a few of all the attributes shown below: request=smtpd_access_policy protocol_state=RCPT protocol_name=SMTP helo_name=some.domain.tld queue_id=8045F2AB23 sender=foo@bar.tld recipient=bar@foo.tld client_address=1.2.3.4 client_name=another.domain.tld [empty line] The policy daemon will answer in the same style, with an attribute list followed by a empty line: action=dunno [empty line] CONFIGURATION VALUES SPFSEEDONLY=0 will only check SPF and log, not use it for decisions. SPF will be used if SPFSEEDONLY!=0 debugLevel=0 log only SPF results. Values of 1 - 4 result in increasing levels of detail. pypolicyd-spf-0.1/setup.py0000755000175000017500000000172010553523620016114 0ustar kittermakitterma#!/usr/bin/env python from distutils.core import setup DESC = """python-policyd-spf SPF Postfix policy daemon implemented in Python.""" setup(name='python-policyd-spf', version='0.1', description=DESC, author='Scott Kitterman', author_email='scott@kitterman.com', url='http://www.openspf.org/Software', license='GNU General Public License', py_modules=['policydspfsupp'], keywords = ['Postfix','spf','email'], scripts = ['policyd-spf'], classifiers = [ 'Development Status :: 4 - Beta', 'Environment :: No Input/Output (Daemon)', 'Intended Audience :: Developers', 'License :: OSI Approved :: GNU General Public License (GPL)', 'Natural Language :: English', 'Operating System :: POSIX', 'Programming Language :: Python', 'Topic :: Communications :: Email :: Mail Transport Agents', 'Topic :: Communications :: Email :: Filters', 'Topic :: Software Development :: Libraries :: Python Modules' ] ) pypolicyd-spf-0.1/TODO0000644000175000017500000000321010553523620015063 0ustar kittermakittermaMake Config files work Warn if reject for test mode Whitelisting Local Policy Better Documentation Add back to README and update after config files work: CONFIGURATION NOTE: After changing "policy-spf.conf", you should run "policy-spf-configtest" to ensure that it's correct. This only applies to changes made to the "policy-spf.conf" master configuration file. Configurations are processed from the top down, in the order specified by "OTHERCONFIGS". So, settings in a top-level __default__ file will be overridden if set in a configuration below that top level. There is the __default__ file at the top level that is used as a default for all decisions. If you wish to disable SPF for a specific IP/subnet/sender/recipient, you simply make a __default__ file in a subdirectory under config matching the entity you wish to match, with SPF or other checks disabled. For example, if you want to disable SPF queries for hosts in 192.168.10.0/24: mkdir /var/spool/policy-spf/config/client_address/192/168/10/ edit /var/spool/policy-spf/config/client_address/192/168/10/__default__ The __default__ file should contain: SPFSEEDONLY=0 CHECKERS= OTHERCONFIGS= Note that for a specific IP address, the last component is a file, having the same structure as the __default__. For example, to block the address "10.1.2.3", you would create a file named "3" under the directory ".../config/client_address/10/1/2". The above sets CHECKERS and OTHERCONFIGS to nothing, so for that subnet no checks are done. All other IP address blocks are still using the top level __default__