Add config file parsing module and initial option set

config.py

@@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+#
+#  Tumgreyspf
+#  Copyright © 2004-2005, Sean Reifschneider, tummy.com, ltd.
+#
+#  pypolicyd-spf changes
+#  Copyright © 2007,2008,2009,2010 Scott Kitterman <scott@kitterman.com>
+#
+#  dkimpy-milter changes
+#  Copyright © 2018 Scott Kitterman <scott@kitterman.com>
+#  Note: Derived from pypolicydspfsupp.py version before relicensing to Apache
+#        2.0 license - 100% GPL
+'''
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License version 2 as published 
+    by the Free Software Foundation.
+
+    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
+import os
+import sys
+import string
+import re
+import urllib
+import stat
+
+
+#  default values
+defaultConfigData = {
+        'Syslog' : 'yes',
+        'UMask' : '007',
+        'Mode' : 'sv',
+        'Socket' : 'local:/var/run/dkimpy-milter/dkimpy-milter.sock',
+        'PidFile'  : '/var/run/dkimpy-milter/dkimpy-milter.pid',
+        'UserID' : 'dkimpy-milter',
+        'Canonicalization' : 'simple'
+        }
+
+
+#################################
+class ConfigException(Exception):
+    '''Exception raised when there's a configuration file error.'''
+    pass
+
+
+####################################################################
+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:
+        try:
+            readConfigFile(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
+      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)
+
+
+###############################################################
+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 >= 5: syslog.syslog('readConfigFile: Loading "%s"' % path)
+    if configData == None: configData = {}
+    nameConversion = {
+        'Syslog' : 'str',
+        'UMask' : 'str',
+        'Mode' : 'str',
+        'Socket' : 'str',
+        'PidFile'  : 'str',
+        'UserID' : 'str',
+        'Domain' : 'str',
+        'KeyFile' : 'str',
+        'Selector' : 'str',
+        'Canonicalization' : 'str'
+            }
+
+    #  check to see if it's a file
+    try:
+        mode = os.stat(path)[0]
+    except OSError, e:
+        syslog.syslog(syslog.LOG_ERR,'ERROR stating "%s": %s' % ( path, e.strerror ))
+        return(configData)
+    if not stat.S_ISREG(mode):
+        syslog.syslog(syslog.LOG_ERR,'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:
+            if len(data) == 1:
+                if debugLevel >= 1:
+                    syslog.syslog('Configuration item "%s" not defined in file "%s"'
+                        % ( line, path ))
+            else:
+                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 >= 5: syslog.syslog('readConfigFile: Found entry "%s=%s"'
+                % ( name, value ))
+        configData[name] = conversion(value)
+    fp.close()
+    
+    return(configData)

dkimpy-milter.conf

@@ -18,9 +18,8 @@ Selector		default
 # Commonly-used options; the commented-out versions show the defaults.
 #Canonicalization	simple
 #Mode			sv
-#SubDomains		no
 
-# Socket smtp://localhost
+# Socket local:/var/run/dkimpy-milter/dkimpy-milter.sock
 #
 # ##  Socket socketspec
 # ##
@@ -34,23 +33,15 @@ Selector		default
 Socket			inet:8892@localhost
 
 ##  PidFile filename
-###      default (none)
+###      default /var/run/dkimpy-milter/dkimpy-milter.pid
 ###
 ###  Name of the file where the filter should write its pid before beginning
 ###  normal operations.
 #
 PidFile			/var/run/dkimpy-milter/dkimpy-milter.pid
 
-
-# Always oversign From (sign using actual From and a null From to prevent
-# malicious signatures header fields (From and/or others) between the signer
-# and the verifier.  From is oversigned by default in the Debian pacakge
-# because it is often the identity key used by reputation systems and thus
-# somewhat security sensitive.
-OversignHeaders		From
-
 ##  Userid userid
-###      default (none)
+###      default dkimpy-milter
 ###
 ###  Change to user "userid" before starting normal operation?  May include
 ###  a group ID as well, separated from the userid by a colon.