Compare commits
28 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| f9483fea8c | |||
| 7a3a7bfb43 | |||
| 8a0e1bdd97 | |||
| e3005aa723 | |||
| 45d3ba13ca | |||
| f05309437f | |||
| d4499f6990 | |||
| 7d87309f4b | |||
| 1d8c309da9 | |||
| 4d5961e4d5 | |||
| 59448e8e57 | |||
| 695de0db14 | |||
| dfd6fa68c3 | |||
| 86eb152f93 | |||
| 126966e110 | |||
| 5d8d47cd52 | |||
| 1843ca6244 | |||
| f9358d594c | |||
| a8aa422b03 | |||
| 9836f2c9c2 | |||
| 70606ac58c | |||
| 6348bdcdc7 | |||
| fd39384e78 | |||
| 924c96d555 | |||
| efeabd19d3 | |||
| a9b8a44bfc | |||
| daaa6aada7 | |||
| e795db7c69 |
@@ -1,3 +1,31 @@
|
|||||||
|
0.9.6 2018-03-13
|
||||||
|
- Fixed typo in package installation section of README
|
||||||
|
- Added more to README about first run with systemd
|
||||||
|
- Fixed typo in path for fallback location of the config file if one is not
|
||||||
|
provided
|
||||||
|
- Added protection for malformed From addresses. If the From does not at
|
||||||
|
least have an '@' in the address, then the signing domain is not extracted
|
||||||
|
and the message will not be signed
|
||||||
|
|
||||||
|
0.9.5.1 2018-03-10
|
||||||
|
- Add conf file location to systemd unit file
|
||||||
|
- Fix setup.py install locations so they are installed correctly
|
||||||
|
|
||||||
|
0.9.5 2018-03-10
|
||||||
|
- Beta 1 (updated Alpha -> Beta warning in README and trove classifiers)
|
||||||
|
- Added support for MacroList option
|
||||||
|
- Added support for MacroListVerify option
|
||||||
|
- Added example in README to show use of MacroList* to separate inbound and
|
||||||
|
outbound mail streams
|
||||||
|
- Added support for SyslogSuccess option (both signing and verifying)
|
||||||
|
- Rationalized logging to be much less verbose unless SyslogSuccess or
|
||||||
|
debugLevel are set - default is generally start/stop/errors only
|
||||||
|
- Fixed install_requires so either dnspython (preferred if neither is
|
||||||
|
installed) or PyDNS satisfies the install requirements
|
||||||
|
- Updated Authentication Results result comment not to mention key size for
|
||||||
|
ed25519 signatures, since it's irrelevant
|
||||||
|
- Enhanced signature verification logging to provide more useful information
|
||||||
|
|
||||||
0.9.4 2018-03-09
|
0.9.4 2018-03-09
|
||||||
- Create PID directory if it is missing
|
- Create PID directory if it is missing
|
||||||
- Fix crash when verifying if domain for signing was not set
|
- Fix crash when verifying if domain for signing was not set
|
||||||
|
|||||||
@@ -16,8 +16,8 @@ python setup.py install --single-version-externally-managed --record=/dev/null
|
|||||||
For users of Debian Stable (Debian 9, Codename Squueze), all dependencies are
|
For users of Debian Stable (Debian 9, Codename Squueze), all dependencies are
|
||||||
available in either the main or backports repositories:
|
available in either the main or backports repositories:
|
||||||
|
|
||||||
[sudo] apt install python-milter python-nacl pthon-ipaddress python-dnspython
|
[sudo] apt install python-milter python-nacl python-ipaddress python-dnspython
|
||||||
[sudo] apt install -t squeeze-backports python-authres python-dkim
|
[sudo] apt install -t stretch-backports python-authres python-dkim
|
||||||
|
|
||||||
The preferred method of installation is from PyPi using pip (if distribution
|
The preferred method of installation is from PyPi using pip (if distribution
|
||||||
packages are not available):
|
packages are not available):
|
||||||
@@ -48,6 +48,14 @@ As an example, using the default dkimpy-user on Debian, the command would be:
|
|||||||
Since /var/run or /run is sometimes on a tempfs, if the PID file directory is
|
Since /var/run or /run is sometimes on a tempfs, if the PID file directory is
|
||||||
missing, the milter will create it on startup.
|
missing, the milter will create it on startup.
|
||||||
|
|
||||||
|
To start dkimpy-milter with systemd for the first time, you will need to take
|
||||||
|
the following steps:
|
||||||
|
|
||||||
|
[sudo] systemctl daemon-reload
|
||||||
|
[sudo] systemctl enable dkimpy-milter
|
||||||
|
[sudo] systemctl start dkimpy-milter
|
||||||
|
[sudo] systemctl status dkimpy-milter (to verify it started correctly)
|
||||||
|
|
||||||
As with all milters, dkimpy-milter needs to be integrated with your MTA of
|
As with all milters, dkimpy-milter needs to be integrated with your MTA of
|
||||||
choice (Sendmail or Postfix).
|
choice (Sendmail or Postfix).
|
||||||
|
|
||||||
@@ -86,10 +94,42 @@ submission inet n - - - - smtpd
|
|||||||
|
|
||||||
These need to match the Socket value for each dkimpy-milter instance.
|
These need to match the Socket value for each dkimpy-milter instance.
|
||||||
|
|
||||||
|
Care is required to segregate outbound mail to be signed and inbound mail to
|
||||||
|
be verified. The above example uses two instances of dkimpy-milter to do
|
||||||
|
this. There are many possible ways. Here is another example using milter
|
||||||
|
macros to keep the mail streams segregated:
|
||||||
|
|
||||||
|
Postfix master.cf:
|
||||||
|
|
||||||
|
smtp inet n - - - - smtpd
|
||||||
|
...
|
||||||
|
-o smtpd_milters=inet:localhost:8891
|
||||||
|
-o milter_macro_daemon_name=VERIFYING
|
||||||
|
...
|
||||||
|
|
||||||
|
submission inet n - - - - smtpd
|
||||||
|
-o syslog_name=postfix/submission
|
||||||
|
-o smtpd_tls_security_level=encrypt
|
||||||
|
-o smtpd_sasl_auth_enable=yes
|
||||||
|
...
|
||||||
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
|
-o smtpd_milters=inet:localhost:8891
|
||||||
|
...
|
||||||
|
|
||||||
|
Dkimpy-milter.conf:
|
||||||
|
|
||||||
|
...
|
||||||
|
Mode sv
|
||||||
|
MacroList dameon_name|ORIGINATING
|
||||||
|
MacroListVerify daemon_name|VERIFYING
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
The python DKIM library, dkimpy, requires the entire message being signed or
|
The python DKIM library, dkimpy, requires the entire message being signed or
|
||||||
verified to be in memory, so dkimpy-milter does not write messages out to a temp
|
verified to be in memory, so dkimpy-milter does not write messages out to a temp
|
||||||
file. This may impact performance on low-memory systems.
|
file. This may impact performance on low-memory systems.
|
||||||
|
|
||||||
WARNING: This is an alpha grade release to support interoperability testing with
|
This is an beta grade release to support interoperability testing with Ed25519
|
||||||
Ed25519 signatures and basic functionality. It is known to be incomplete and
|
signatures sufficient functionality for basic use. The documented
|
||||||
not suitable for general use.
|
functionality has been implemented and at least partially tested. It is free
|
||||||
|
of known major defects, but is not fully tested in a variety of environments.
|
||||||
|
|||||||
@@ -34,15 +34,14 @@ DiagnosticDirectory implemented verified
|
|||||||
InternalHosts implemented verified
|
InternalHosts implemented verified
|
||||||
|
|
||||||
0.9.5 (Beta)
|
0.9.5 (Beta)
|
||||||
|
MacroList implemented verified
|
||||||
|
MacroListVerify implemented verified
|
||||||
SyslogSuccess
|
SyslogSuccess implemented verified
|
||||||
|
|
||||||
1.0.0
|
1.0.0
|
||||||
Convert dkim-milter-python config
|
|
||||||
No additional features planned
|
No additional features planned
|
||||||
|
|
||||||
Plannedataset type support:
|
Plannedataset type support (if needed):
|
||||||
db:/.db
|
db:/.db
|
||||||
mdb:
|
mdb:
|
||||||
|
|
||||||
@@ -52,9 +51,9 @@ AlwaysAddARHeader
|
|||||||
ChangeRootDirectory
|
ChangeRootDirectory
|
||||||
ClockDrift (requires dkimpy change)
|
ClockDrift (requires dkimpy change)
|
||||||
DNSTimeout (requires dkmpy change)
|
DNSTimeout (requires dkmpy change)
|
||||||
MacroList
|
|
||||||
MilterDebug
|
MilterDebug
|
||||||
MinimumKeyBits
|
MinimumKeyBits
|
||||||
|
OversignHeaders (may require dkimpy changes)
|
||||||
PeerList
|
PeerList
|
||||||
SignatureAlgorithm
|
SignatureAlgorithm
|
||||||
|
|
||||||
@@ -85,7 +84,6 @@ On-InternalError
|
|||||||
On-KeyNotFound
|
On-KeyNotFound
|
||||||
On-NoSignature
|
On-NoSignature
|
||||||
On-SignatureError
|
On-SignatureError
|
||||||
OversignHeaders
|
|
||||||
RemoveARAll
|
RemoveARAll
|
||||||
RemoveARFrom
|
RemoveARFrom
|
||||||
RemoveOldSignatures
|
RemoveOldSignatures
|
||||||
|
|||||||
+275
-220
@@ -25,15 +25,12 @@ import sys
|
|||||||
import syslog
|
import syslog
|
||||||
import Milter
|
import Milter
|
||||||
import dkim
|
import dkim
|
||||||
from dkim.dnsplug import get_txt
|
|
||||||
from dkim.util import parse_tag_value
|
|
||||||
import authres
|
import authres
|
||||||
import os
|
import os
|
||||||
import tempfile
|
import tempfile
|
||||||
import StringIO
|
import StringIO
|
||||||
import re
|
import re
|
||||||
from Milter.config import MilterConfigParser
|
from Milter.utils import parse_addr, parseaddr
|
||||||
from Milter.utils import iniplist,parse_addr,parseaddr
|
|
||||||
import dkimpy_milter.config as config
|
import dkimpy_milter.config as config
|
||||||
from dkimpy_milter.util import drop_privileges
|
from dkimpy_milter.util import drop_privileges
|
||||||
from dkimpy_milter.util import setExceptHook
|
from dkimpy_milter.util import setExceptHook
|
||||||
@@ -42,230 +39,286 @@ from dkimpy_milter.util import read_keyfile
|
|||||||
from dkimpy_milter.util import own_socketfile
|
from dkimpy_milter.util import own_socketfile
|
||||||
from dkimpy_milter.util import fold
|
from dkimpy_milter.util import fold
|
||||||
|
|
||||||
__version__ = "0.9.4"
|
__version__ = "0.9.6"
|
||||||
FWS = re.compile(r'\r?\n[ \t]+')
|
FWS = re.compile(r'\r?\n[ \t]+')
|
||||||
|
|
||||||
|
|
||||||
class dkimMilter(Milter.Base):
|
class dkimMilter(Milter.Base):
|
||||||
"Milter to check and sign DKIM. Each connection gets its own instance."
|
"Milter to check and sign DKIM. Each connection gets its own instance."
|
||||||
|
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
self.mailfrom = None
|
self.mailfrom = None
|
||||||
self.id = Milter.uniqueID()
|
self.id = Milter.uniqueID()
|
||||||
# we don't want config used to change during a connection
|
# we don't want config used to change during a connection
|
||||||
self.conf = milterconfig
|
self.conf = milterconfig
|
||||||
self.privatersa = privateRSA
|
self.privatersa = privateRSA
|
||||||
self.privateed25519 = privateEd25519
|
self.privateed25519 = privateEd25519
|
||||||
self.fp = None
|
self.fp = None
|
||||||
|
|
||||||
@Milter.noreply
|
@Milter.noreply
|
||||||
def connect(self,hostname,unused,hostaddr):
|
def connect(self, hostname, unused, hostaddr):
|
||||||
self.internal_connection = False
|
self.internal_connection = False
|
||||||
self.hello_name = None
|
self.external_connection = False
|
||||||
# sometimes people put extra space in sendmail config, so we strip
|
self.hello_name = None
|
||||||
self.receiver = self.getsymval('j').strip()
|
# sometimes people put extra space in sendmail config, so we strip
|
||||||
try:
|
self.receiver = self.getsymval('j').strip()
|
||||||
self.AuthservID = milterconfig['AuthservID']
|
try:
|
||||||
except:
|
self.AuthservID = milterconfig['AuthservID']
|
||||||
self.AuthservID = self.receiver
|
except:
|
||||||
if hostaddr and len(hostaddr) > 0:
|
self.AuthservID = self.receiver
|
||||||
ipaddr = hostaddr[0]
|
if hostaddr and len(hostaddr) > 0:
|
||||||
if milterconfig['InternalHostsObj']:
|
ipaddr = hostaddr[0]
|
||||||
if milterconfig['InternalHostsObj'].match(ipaddr):
|
if milterconfig['IntHosts']:
|
||||||
self.internal_connection = True
|
if milterconfig['IntHosts'].match(ipaddr):
|
||||||
else: ipaddr = ''
|
self.internal_connection = True
|
||||||
self.connectip = ipaddr
|
else:
|
||||||
if self.internal_connection:
|
ipaddr = ''
|
||||||
connecttype = 'INTERNAL'
|
self.connectip = ipaddr
|
||||||
else:
|
if milterconfig.get('MacroList') and not self.internal_connection:
|
||||||
connecttype = 'EXTERNAL'
|
macrolist = milterconfig.get('MacroList')
|
||||||
if milterconfig.get('Syslog'):
|
for macro in macrolist:
|
||||||
syslog.syslog("connect from {0} at {1} {2}".format(hostname,hostaddr,connecttype))
|
macroname = macro.split('|')[0]
|
||||||
return Milter.CONTINUE
|
macroname = '{' + macroname + '}'
|
||||||
|
macroresult = self.getsymval(macroname)
|
||||||
|
if ((len(macro.split('|')) == 1 and macroresult) or macroresult
|
||||||
|
in macro.split('|')[1:]):
|
||||||
|
self.internal_connection = True
|
||||||
|
if milterconfig.get('MacroListVerify'):
|
||||||
|
macrolist = milterconfig.get('MacroListVerify')
|
||||||
|
for macro in macrolist:
|
||||||
|
macroname = macro.split('|')[0]
|
||||||
|
macroname = '{' + macroname + '}'
|
||||||
|
macroresult = self.getsymval(macroname)
|
||||||
|
if ((len(macro.split('|')) == 1 and macroresult) or macroresult
|
||||||
|
in macro.split('|')[1:]):
|
||||||
|
self.external_connection = True
|
||||||
|
if self.internal_connection:
|
||||||
|
connecttype = 'INTERNAL'
|
||||||
|
else:
|
||||||
|
connecttype = 'EXTERNAL'
|
||||||
|
if milterconfig.get('Syslog') and milterconfig.get('debugLevel') >= 1:
|
||||||
|
syslog.syslog("connect from {0} at {1} {2}"
|
||||||
|
.format(hostname, hostaddr, connecttype))
|
||||||
|
return Milter.CONTINUE
|
||||||
|
|
||||||
# multiple messages can be received on a single connection
|
# multiple messages can be received on a single connection
|
||||||
# envfrom (MAIL FROM in the SMTP protocol) seems to mark the start
|
# envfrom (MAIL FROM in the SMTP protocol) seems to mark the start
|
||||||
# of each message.
|
# of each message.
|
||||||
@Milter.noreply
|
@Milter.noreply
|
||||||
def envfrom(self,f,*str):
|
def envfrom(self, f, *str):
|
||||||
if milterconfig.get('Syslog'):
|
if milterconfig.get('Syslog') and milterconfig.get('debugLevel') >= 2:
|
||||||
syslog.syslog("mail from: {0} {1}".format(f,str))
|
syslog.syslog("mail from: {0} {1}".format(f, str))
|
||||||
self.fp = StringIO.StringIO()
|
self.fp = StringIO.StringIO()
|
||||||
self.mailfrom = f
|
self.mailfrom = f
|
||||||
t = parse_addr(f)
|
t = parse_addr(f)
|
||||||
if len(t) == 2: t[1] = t[1].lower()
|
if len(t) == 2:
|
||||||
self.canon_from = '@'.join(t)
|
t[1] = t[1].lower()
|
||||||
self.user = self.getsymval('{auth_authen}')
|
self.canon_from = '@'.join(t)
|
||||||
self.has_dkim = 0
|
self.has_dkim = 0
|
||||||
self.author = None
|
self.author = None
|
||||||
self.arheaders = []
|
self.arheaders = []
|
||||||
self.arresults = []
|
self.arresults = []
|
||||||
'''if self.user:
|
return Milter.CONTINUE
|
||||||
# Very simple SMTP AUTH policy by default:
|
|
||||||
# any successful authentication is considered INTERNAL
|
|
||||||
self.internal_connection = True
|
|
||||||
auth_type = self.getsymval('{auth_type}')
|
|
||||||
ssl_bits = self.getsymval('{cipher_bits}')
|
|
||||||
if milterconfig.get('Syslog'):
|
|
||||||
syslog.syslog(
|
|
||||||
"SMTP AUTH:",self.user,"sslbits =",ssl_bits, auth_type,
|
|
||||||
"ssf =",self.getsymval('{auth_ssf}'), "INTERNAL"
|
|
||||||
)
|
|
||||||
# Detailed authorization policy is configured in the access file below.
|
|
||||||
self.arresults.append(
|
|
||||||
authres.SMTPAUTHAuthenticationResult(result = 'pass',
|
|
||||||
result_comment = auth_type+' sslbits='+ssl_bits, smtp_auth = self.user)
|
|
||||||
)'''
|
|
||||||
return Milter.CONTINUE
|
|
||||||
|
|
||||||
@Milter.noreply
|
@Milter.noreply
|
||||||
def header(self,name,val):
|
def header(self, name, val):
|
||||||
lname = name.lower()
|
lname = name.lower()
|
||||||
if lname == 'dkim-signature':
|
if lname == 'dkim-signature':
|
||||||
if milterconfig.get('Syslog'):
|
if (milterconfig.get('Syslog') and
|
||||||
syslog.syslog("{0}: {1}".format(name,val))
|
milterconfig.get('debugLevel') >= 1):
|
||||||
self.has_dkim += 1
|
syslog.syslog("{0}: {1}".format(name, val))
|
||||||
if lname == 'from':
|
self.has_dkim += 1
|
||||||
fname,self.author = parseaddr(val)
|
if lname == 'from':
|
||||||
self.fdomain = self.author.split('@')[1]
|
fname, self.author = parseaddr(val)
|
||||||
if milterconfig.get('Syslog'):
|
try:
|
||||||
syslog.syslog("{0}: {1}".format(name,val))
|
self.fdomain = self.author.split('@')[1]
|
||||||
elif lname == 'authentication-results':
|
except IndexError as er:
|
||||||
self.arheaders.append(val)
|
self.fdomain = '' # self.author was not a proper email address
|
||||||
if self.fp:
|
if (milterconfig.get('Syslog') and
|
||||||
self.fp.write("%s: %s\n" % (name,val))
|
milterconfig.get('debugLevel') >= 1):
|
||||||
return Milter.CONTINUE
|
syslog.syslog("{0}: {1}".format(name, val))
|
||||||
|
elif lname == 'authentication-results':
|
||||||
|
self.arheaders.append(val)
|
||||||
|
if self.fp:
|
||||||
|
self.fp.write("%s: %s\n" % (name, val))
|
||||||
|
return Milter.CONTINUE
|
||||||
|
|
||||||
@Milter.noreply
|
@Milter.noreply
|
||||||
def eoh(self):
|
def eoh(self):
|
||||||
if self.fp:
|
if self.fp:
|
||||||
self.fp.write("\n") # terminate headers
|
self.fp.write("\n") # terminate headers
|
||||||
self.bodysize = 0
|
self.bodysize = 0
|
||||||
return Milter.CONTINUE
|
return Milter.CONTINUE
|
||||||
|
|
||||||
@Milter.noreply
|
@Milter.noreply
|
||||||
def body(self,chunk): # copy body to temp file
|
def body(self, chunk): # copy body to temp file
|
||||||
if self.fp:
|
if self.fp:
|
||||||
self.fp.write(chunk) # IOError causes TEMPFAIL in milter
|
self.fp.write(chunk) # IOError causes TEMPFAIL in milter
|
||||||
self.bodysize += len(chunk)
|
self.bodysize += len(chunk)
|
||||||
return Milter.CONTINUE
|
return Milter.CONTINUE
|
||||||
|
|
||||||
def eom(self):
|
def eom(self):
|
||||||
if not self.fp:
|
if not self.fp:
|
||||||
return Milter.ACCEPT # no message collected - so no eom processing
|
return Milter.ACCEPT # no message collected - so no eom processing
|
||||||
# Remove existing Authentication-Results headers for our authserv_id
|
# Remove existing Authentication-Results headers for our authserv_id
|
||||||
for i,val in enumerate(self.arheaders,1):
|
for i, val in enumerate(self.arheaders, 1):
|
||||||
# FIXME: don't delete A-R headers from trusted MTAs
|
# FIXME: don't delete A-R headers from trusted MTAs
|
||||||
try:
|
try:
|
||||||
ar = authres.AuthenticationResultsHeader.parse_value(FWS.sub('',val))
|
ar = (authres.AuthenticationResultsHeader
|
||||||
if ar.authserv_id == self.AuthservID:
|
.parse_value(FWS.sub('', val)))
|
||||||
self.chgheader('authentication-results',i,'')
|
if ar.authserv_id == self.AuthservID:
|
||||||
if milterconfig.get('Syslog'):
|
self.chgheader('authentication-results', i, '')
|
||||||
syslog.syslog('REMOVE: {0}'.format(val))
|
if (milterconfig.get('Syslog') and
|
||||||
except:
|
milterconfig.get('debugLevel') >= 1):
|
||||||
# Don't error out on unparseable AR header fiels
|
syslog.syslog('REMOVE: {0}'.format(val))
|
||||||
pass
|
except:
|
||||||
# Check or sign DKIM
|
# Don't error out on unparseable AR header fiels
|
||||||
self.fp.seek(0)
|
pass
|
||||||
if milterconfig.get('Domain'):
|
# Check or sign DKIM
|
||||||
domain = milterconfig.get('Domain')
|
self.fp.seek(0)
|
||||||
else:
|
if milterconfig.get('Domain'):
|
||||||
domain = ''
|
domain = milterconfig.get('Domain')
|
||||||
if (self.fdomain in domain) and (not milterconfig.get('Mode') == 'v'):
|
else:
|
||||||
txt = self.fp.read()
|
domain = ''
|
||||||
self.sign_dkim(txt)
|
if ((self.fdomain in domain) and not milterconfig.get('Mode') == 'v'
|
||||||
result = None
|
and not self.external_connection):
|
||||||
if (self.has_dkim) and (not self.internal_connection) and (milterconfig.get('Mode') == 'v' or milterconfig.get('Mode') == 'sv'):
|
txt = self.fp.read()
|
||||||
txt = self.fp.read()
|
self.sign_dkim(txt)
|
||||||
self.check_dkim(txt)
|
if ((self.has_dkim) and (not self.internal_connection) and
|
||||||
else:
|
(milterconfig.get('Mode') == 'v' or
|
||||||
result = 'none'
|
milterconfig.get('Mode') == 'sv')):
|
||||||
if self.arresults:
|
txt = self.fp.read()
|
||||||
h = authres.AuthenticationResultsHeader(authserv_id = self.AuthservID,
|
self.check_dkim(txt)
|
||||||
results=self.arresults)
|
if self.arresults:
|
||||||
h = fold(str(h))
|
h = authres.AuthenticationResultsHeader(authserv_id=
|
||||||
if milterconfig.get('Syslog'):
|
self.AuthservID,
|
||||||
syslog.syslog(str(h))
|
results=self.arresults)
|
||||||
name,val = str(h).split(': ',1)
|
h = fold(str(h))
|
||||||
self.addheader(name,val,0)
|
if (milterconfig.get('Syslog') and
|
||||||
return Milter.CONTINUE
|
milterconfig.get('debugLevel') >= 2):
|
||||||
|
syslog.syslog(str(h))
|
||||||
|
name, val = str(h).split(': ', 1)
|
||||||
|
self.addheader(name, val, 0)
|
||||||
|
return Milter.CONTINUE
|
||||||
|
|
||||||
def sign_dkim(self,txt):
|
def sign_dkim(self, txt):
|
||||||
canon = milterconfig.get('Canonicalization')
|
canon = milterconfig.get('Canonicalization')
|
||||||
canonicalize = []
|
canonicalize = []
|
||||||
if len(canon.split('/')) == 2:
|
if len(canon.split('/')) == 2:
|
||||||
canonicalize.append(canon.split('/')[0])
|
canonicalize.append(canon.split('/')[0])
|
||||||
canonicalize.append(canon.split('/')[1])
|
canonicalize.append(canon.split('/')[1])
|
||||||
else:
|
else:
|
||||||
canonicalize.append(canon)
|
canonicalize.append(canon)
|
||||||
canonicalize.append(canon)
|
canonicalize.append(canon)
|
||||||
syslog.syslog('canonicalize: {0}'.format(canonicalize))
|
if (milterconfig.get('Syslog') and
|
||||||
try:
|
milterconfig.get('debugLevel') >= 1):
|
||||||
if privateRSA:
|
syslog.syslog('canonicalize: {0}'.format(canonicalize))
|
||||||
d = dkim.DKIM(txt)
|
try:
|
||||||
h = d.sign(milterconfig.get('Selector'), self.fdomain, privateRSA,
|
if privateRSA:
|
||||||
canonicalize=(canonicalize[0], canonicalize[1]))
|
d = dkim.DKIM(txt)
|
||||||
name,val = h.split(': ',1)
|
h = d.sign(milterconfig.get('Selector'), self.fdomain,
|
||||||
self.addheader(name,val.strip().replace('\r\n','\n'),0)
|
privateRSA, canonicalize=(canonicalize[0],
|
||||||
if privateEd25519:
|
canonicalize[1]))
|
||||||
d = dkim.DKIM(txt)
|
name, val = h.split(': ', 1)
|
||||||
h = d.sign(milterconfig.get('SelectorEd25519'), self.fdomain, privateEd25519,
|
self.addheader(name, val.strip().replace('\r\n', '\n'), 0)
|
||||||
canonicalize=(canonicalize[0], canonicalize[1]), signature_algorithm='ed25519-sha256')
|
if (milterconfig.get('Syslog') and
|
||||||
name,val = h.split(': ',1)
|
(milterconfig.get('SyslogSuccess')
|
||||||
self.addheader(name,val.strip().replace('\r\n','\n'),0)
|
or milterconfig.get('debugLevel') >= 1)):
|
||||||
except dkim.DKIMException as x:
|
syslog.syslog('{0}: {1} DKIM-Signature field added (s={2} '
|
||||||
if milterconfig.get('Syslog'):
|
'd={3})'.format(self.getsymval('i'),
|
||||||
syslog.syslog('DKIM: {0}'.format(x))
|
d.signature_fields.get(b'a'),
|
||||||
except Exception as x:
|
d.signature_fields.get(b's'),
|
||||||
if milterconfig.get('Syslog'):
|
d.domain))
|
||||||
syslog.syslog("sign_dkim: {0}".format(x))
|
if privateEd25519:
|
||||||
raise
|
d = dkim.DKIM(txt)
|
||||||
|
h = d.sign(milterconfig.get('SelectorEd25519'), self.fdomain,
|
||||||
def check_dkim(self,txt):
|
privateEd25519, canonicalize=(canonicalize[0],
|
||||||
res = False
|
canonicalize[1]),
|
||||||
conf = self.conf
|
signature_algorithm='ed25519-sha256')
|
||||||
for y in range(self.has_dkim): # Verify _ALL_ the signatures
|
name, val = h.split(': ', 1)
|
||||||
d = dkim.DKIM(txt)
|
self.addheader(name, val.strip().replace('\r\n', '\n'), 0)
|
||||||
try:
|
if (milterconfig.get('Syslog') and
|
||||||
res = d.verify(idx=y)
|
(milterconfig.get('SyslogSuccess')
|
||||||
if res:
|
or milterconfig.get('debugLevel') >= 1)):
|
||||||
self.dkim_comment = 'Good {0} bit {1} signature.'.format(d.keysize, d.signature_fields.get(b'a'))
|
syslog.syslog('{0}: {1} DKIM-Signature field added (s={2} '
|
||||||
else:
|
'd={3})'.format(self.getsymval('i'),
|
||||||
self.dkim_comment = 'Bad {0} bit {1} signature.'.format(d.keysize, d.signature_fields.get(b'a'))
|
d.signature_fields.get(b'a'),
|
||||||
except dkim.DKIMException as x:
|
d.signature_fields.get(b's'),
|
||||||
self.dkim_comment = str(x)
|
d.domain))
|
||||||
|
except dkim.DKIMException as x:
|
||||||
if milterconfig.get('Syslog'):
|
if milterconfig.get('Syslog'):
|
||||||
syslog.syslog('DKIM: {0}'.format(x))
|
syslog.syslog('DKIM: {0}'.format(x))
|
||||||
except Exception as x:
|
except Exception as x:
|
||||||
self.dkim_comment = str(x)
|
|
||||||
if milterconfig.get('Syslog'):
|
if milterconfig.get('Syslog'):
|
||||||
syslog.syslog("check_dkim: {0}".format(x))
|
syslog.syslog("sign_dkim: {0}".format(x))
|
||||||
self.header_i = d.signature_fields.get(b'i')
|
raise
|
||||||
self.header_d = d.signature_fields.get(b'd')
|
|
||||||
self.header_a = d.signature_fields.get(b'a')
|
def check_dkim(self, txt):
|
||||||
if res:
|
res = False
|
||||||
if milterconfig.get('Syslog'):
|
for y in range(self.has_dkim): # Verify _ALL_ the signatures
|
||||||
syslog.syslog('DKIM: Pass ({0})'.format(d.domain))
|
d = dkim.DKIM(txt)
|
||||||
self.dkim_domain = d.domain
|
try:
|
||||||
else:
|
res = d.verify(idx=y)
|
||||||
if milterconfig.get['DiagnosticDirectory']:
|
if res:
|
||||||
fd,fname = tempfile.mkstemp(".dkim")
|
if d.signature_fields.get(b'a') == 'ed25519-sha256':
|
||||||
with os.fdopen(fd,"w+b") as fp:
|
self.dkim_comment = ('Good {0} signature'
|
||||||
fp.write(txt)
|
.format(d.signature_fields
|
||||||
if milterconfig.get('Syslog'):
|
.get(b'a')))
|
||||||
syslog.syslog('DKIM: Fail (saved as {0})'.format(fname))
|
else:
|
||||||
else:
|
self.dkim_comment = ('Good {0} bit {1} signature'
|
||||||
syslog.syslog('DKIM: Fail ({0})'.format(d.domain))
|
.format(d.keysize,
|
||||||
if res:
|
d.signature_fields
|
||||||
result = 'pass'
|
.get(b'a')))
|
||||||
else:
|
else:
|
||||||
result = 'fail'
|
self.dkim_comment = ('Bad {0} bit {1} signature.'
|
||||||
res = False
|
.format(d.keysize,
|
||||||
self.arresults.append(
|
d.signature_fields.get(b'a')))
|
||||||
authres.DKIMAuthenticationResult(result=result,
|
except dkim.DKIMException as x:
|
||||||
header_i = self.header_i, header_d = self.header_d, header_a = self.header_a,
|
self.dkim_comment = str(x)
|
||||||
result_comment = self.dkim_comment)
|
if milterconfig.get('Syslog'):
|
||||||
)
|
syslog.syslog('DKIM: {0}'.format(x))
|
||||||
return
|
except Exception as x:
|
||||||
|
self.dkim_comment = str(x)
|
||||||
|
if milterconfig.get('Syslog'):
|
||||||
|
syslog.syslog("check_dkim: {0}".format(x))
|
||||||
|
self.header_i = d.signature_fields.get(b'i')
|
||||||
|
self.header_d = d.signature_fields.get(b'd')
|
||||||
|
self.header_a = d.signature_fields.get(b'a')
|
||||||
|
if res:
|
||||||
|
if (milterconfig.get('Syslog') and
|
||||||
|
(milterconfig.get('SyslogSuccess') or
|
||||||
|
milterconfig.get('debugLevel') >= 1)):
|
||||||
|
syslog.syslog('{0}: {1} DKIM signature verified (s={2} '
|
||||||
|
'd={3})'.format(self.getsymval('i'),
|
||||||
|
d.signature_fields.get(b'a'),
|
||||||
|
d.signature_fields.get(b's'),
|
||||||
|
d.domain))
|
||||||
|
self.dkim_domain = d.domain
|
||||||
|
else:
|
||||||
|
if milterconfig.get('DiagnosticDirectory'):
|
||||||
|
fd, fname = tempfile.mkstemp(".dkim")
|
||||||
|
with os.fdopen(fd, "w+b") as fp:
|
||||||
|
fp.write(txt)
|
||||||
|
if milterconfig.get('Syslog'):
|
||||||
|
syslog.syslog('DKIM: Fail (saved as {0})'
|
||||||
|
.format(fname))
|
||||||
|
else:
|
||||||
|
syslog.syslog('DKIM: Fail ({0})'.format(d.domain))
|
||||||
|
if res:
|
||||||
|
result = 'pass'
|
||||||
|
else:
|
||||||
|
result = 'fail'
|
||||||
|
res = False
|
||||||
|
self.arresults.append(
|
||||||
|
authres.DKIMAuthenticationResult(result=result,
|
||||||
|
header_i=self.header_i,
|
||||||
|
header_d=self.header_d,
|
||||||
|
header_a=self.header_a,
|
||||||
|
result_comment=
|
||||||
|
self.dkim_comment)
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
# Ugh, but there's no easy way around this.
|
# Ugh, but there's no easy way around this.
|
||||||
@@ -274,15 +327,16 @@ def main():
|
|||||||
global privateEd25519
|
global privateEd25519
|
||||||
privateRSA = False
|
privateRSA = False
|
||||||
privateEd25519 = False
|
privateEd25519 = False
|
||||||
configFile = '/etc/dkimpy-milter.conf'
|
configFile = '/usr/local/etc/dkimpy-milter.conf'
|
||||||
if len(sys.argv) > 1:
|
if len(sys.argv) > 1:
|
||||||
if sys.argv[1] in ( '-?', '--help', '-h' ):
|
if sys.argv[1] in ('-?', '--help', '-h'):
|
||||||
print('usage: dkimpy-milter [<configfilename>]')
|
print('usage: dkimpy-milter [<configfilename>]')
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
configFile = sys.argv[1]
|
configFile = sys.argv[1]
|
||||||
milterconfig = config._processConfigFile(filename = configFile)
|
milterconfig = config._processConfigFile(filename=configFile)
|
||||||
if milterconfig.get('Syslog'):
|
if milterconfig.get('Syslog'):
|
||||||
facility = eval("syslog.LOG_{0}".format(milterconfig.get('SyslogFacility').upper()))
|
facility = eval("syslog.LOG_{0}"
|
||||||
|
.format(milterconfig.get('SyslogFacility').upper()))
|
||||||
syslog.openlog(os.path.basename(sys.argv[0]), syslog.LOG_PID, facility)
|
syslog.openlog(os.path.basename(sys.argv[0]), syslog.LOG_PID, facility)
|
||||||
setExceptHook()
|
setExceptHook()
|
||||||
pid = write_pid(milterconfig)
|
pid = write_pid(milterconfig)
|
||||||
@@ -295,9 +349,10 @@ def main():
|
|||||||
miltername = 'dkimpy-filter'
|
miltername = 'dkimpy-filter'
|
||||||
socketname = milterconfig.get('Socket')
|
socketname = milterconfig.get('Socket')
|
||||||
if milterconfig.get('Syslog'):
|
if milterconfig.get('Syslog'):
|
||||||
syslog.syslog('dkimpy-milter started:{0} user:{1}'.format(pid,milterconfig.get('UserID')))
|
syslog.syslog('dkimpy-milter started:{0} user:{1}'
|
||||||
|
.format(pid, milterconfig.get('UserID')))
|
||||||
sys.stdout.flush()
|
sys.stdout.flush()
|
||||||
Milter.runmilter(miltername,socketname,240)
|
Milter.runmilter(miltername, socketname, 240)
|
||||||
own_socketfile(milterconfig)
|
own_socketfile(milterconfig)
|
||||||
drop_privileges(milterconfig)
|
drop_privileges(milterconfig)
|
||||||
|
|
||||||
|
|||||||
+104
-86
@@ -27,8 +27,6 @@
|
|||||||
import syslog
|
import syslog
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
import re
|
|
||||||
import urllib
|
|
||||||
import stat
|
import stat
|
||||||
import dkim
|
import dkim
|
||||||
import socket
|
import socket
|
||||||
@@ -37,26 +35,28 @@ from dnsplug import Session
|
|||||||
|
|
||||||
# default values
|
# default values
|
||||||
defaultConfigData = {
|
defaultConfigData = {
|
||||||
'Syslog' : 'yes',
|
'Syslog': 'yes',
|
||||||
'SyslogFacility' : 'mail',
|
'SyslogFacility': 'mail',
|
||||||
'UMask' : 007,
|
'UMask': 007,
|
||||||
'Mode' : 'sv',
|
'Mode': 'sv',
|
||||||
'Socket' : 'local:/var/run/dkimpy-milter/dkimpy-milter.sock',
|
'Socket': 'local:/var/run/dkimpy-milter/dkimpy-milter.sock',
|
||||||
'PidFile' : '/var/run/dkimpy-milter/dkimpy-milter.pid',
|
'PidFile': '/var/run/dkimpy-milter/dkimpy-milter.pid',
|
||||||
'UserID' : 'dkimpy-milter',
|
'UserID': 'dkimpy-milter',
|
||||||
'Canonicalization' : 'relaxed/simple',
|
'Canonicalization': 'relaxed/simple',
|
||||||
'InternalHosts' : '127.0.0.1',
|
'InternalHosts': '127.0.0.1',
|
||||||
'InternalHostsObj' : False,
|
'IntHosts': False,
|
||||||
'DiagnosticDirectory' : ''
|
'DiagnosticDirectory': '',
|
||||||
}
|
'MacroList': '',
|
||||||
|
'MacroListVerify': '',
|
||||||
|
'debugLevel': 0 # Undocumented config item for developer use
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
#################################
|
|
||||||
class ConfigException(Exception):
|
class ConfigException(Exception):
|
||||||
'''Exception raised when there's a configuration file error.'''
|
'''Exception raised when there's a configuration file error.'''
|
||||||
pass
|
pass
|
||||||
|
|
||||||
#################################
|
|
||||||
class HostsDataset(object):
|
class HostsDataset(object):
|
||||||
'''Hold a group of host related dataset objects'''
|
'''Hold a group of host related dataset objects'''
|
||||||
|
|
||||||
@@ -85,34 +85,41 @@ class HostsDataset(object):
|
|||||||
self.negative = True
|
self.negative = True
|
||||||
try:
|
try:
|
||||||
self.item = ipaddress.ip_address(unicode(self.item, "utf-8"))
|
self.item = ipaddress.ip_address(unicode(self.item, "utf-8"))
|
||||||
if isinstance(self.item, ipaddress.IPv4Address): self.isipv4 = True
|
if isinstance(self.item, ipaddress.IPv4Address):
|
||||||
elif isinstance(self.item, ipaddress.IPv6Address): self.isipv6 = True
|
self.isipv4 = True
|
||||||
|
elif isinstance(self.item, ipaddress.IPv6Address):
|
||||||
|
self.isipv6 = True
|
||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
try:
|
try:
|
||||||
self.item = ipaddress.ip_network(unicode(self.item, "utf-8"), strict=False)
|
self.item = ipaddress.ip_network(unicode
|
||||||
if isinstance(self.item, ipaddress.IPv4Network): self.isipv4cidr = True
|
(self.item, "utf-8"),
|
||||||
elif isinstance(self.item, ipaddress.IPv6Network): self.isipv6cidr = True
|
strict=False)
|
||||||
|
if isinstance(self.item, ipaddress.IPv4Network):
|
||||||
|
self.isipv4cidr = True
|
||||||
|
elif isinstance(self.item, ipaddress.IPv6Network):
|
||||||
|
self.isipv6cidr = True
|
||||||
except ValueError as e2:
|
except ValueError as e2:
|
||||||
if self.item[0] == '.' and len(self.item.split('.')) > 2:
|
if self.item[0] == '.' and len(self.item.split('.')) > 2:
|
||||||
self.isdomain = True
|
self.isdomain = True
|
||||||
elif len(self.item.split('.')) > 1: # It has a '.' in it
|
elif len(self.item.split('.')) > 1: # It has a '.' in it
|
||||||
self.ishostname = True
|
self.ishostname = True
|
||||||
else:
|
else:
|
||||||
raise ConfigException('Unknown dataset item: {0}'.format(item))
|
raise ConfigException('Unknown dataset item: {0}'
|
||||||
|
.format(item))
|
||||||
|
|
||||||
def match(self, connectip):
|
def match(self, connectip):
|
||||||
'''Check if the connect IP is part of the dataset'''
|
'''Check if the connect IP is part of the dataset'''
|
||||||
source = ipaddress.ip_address(unicode(connectip, "utf-8"))
|
source = ipaddress.ip_address(unicode(connectip, "utf-8"))
|
||||||
for item in self.dataset:
|
for item in self.dataset:
|
||||||
if item.isdomain or item.ishostname:
|
if item.isdomain or item.ishostname:
|
||||||
result = self.matchname(source) # Match host/domain names first
|
result = self.matchname(source) # Match host/domains first
|
||||||
if result:
|
if result:
|
||||||
return(result)
|
return(result)
|
||||||
elif item.isipv4 or item.isipv4cidr:
|
elif item.isipv4 or item.isipv4cidr: # Then IPv4/6 addresses or
|
||||||
if isinstance(source, ipaddress.IPv4Address): # Then IPv4/6 addresses
|
if isinstance(source, ipaddress.IPv4Address): # networks
|
||||||
return(self.match4(source)) # or networks depending
|
return(self.match4(source)) # depending on the item type
|
||||||
elif item.isipv6 or item.isipv6cidr: # on the item type and
|
elif item.isipv6 or item.isipv6cidr: # and connect type
|
||||||
if isinstance(source, ipaddress.IPv6Address): # connection type
|
if isinstance(source, ipaddress.IPv6Address):
|
||||||
return(self.match6(source))
|
return(self.match6(source))
|
||||||
|
|
||||||
def matchname(self, source):
|
def matchname(self, source):
|
||||||
@@ -126,7 +133,7 @@ class HostsDataset(object):
|
|||||||
for item in self.dataset:
|
for item in self.dataset:
|
||||||
if item.isdomain:
|
if item.isdomain:
|
||||||
for ptr in ptrlist:
|
for ptr in ptrlist:
|
||||||
# Strip the leading '.' off the domain name so exact match works.
|
# Strip the leading '.' off the domain name for exact match
|
||||||
if item.item[1:] == ptr[-len(item.item)+1:]:
|
if item.item[1:] == ptr[-len(item.item)+1:]:
|
||||||
matchdomain = True
|
matchdomain = True
|
||||||
negativedomain = item.negative
|
negativedomain = item.negative
|
||||||
@@ -211,21 +218,16 @@ class HostsDataset(object):
|
|||||||
match = False
|
match = False
|
||||||
return(match)
|
return(match)
|
||||||
|
|
||||||
def dump(self):
|
|
||||||
for item in self.dataset:
|
|
||||||
print 'name: {0} ip4: {1} cidr4: {2} ip6: {3} cidr6: {4} host: {5} domain: {6} negat: {7} type: {8}'.format(item.item,
|
|
||||||
item.isipv4, item.isipv4cidr, item.isipv6, item.isipv6cidr, item.ishostname, item.isdomain,
|
|
||||||
item.negative, type(item.item))
|
|
||||||
|
|
||||||
####################################################################
|
def _processConfigFile(filename=None, configdata=None, useSyslog=1,
|
||||||
def _processConfigFile(filename = None, configdata = None, useSyslog = 1,
|
useStderr=0):
|
||||||
useStderr = 0):
|
|
||||||
'''Load the specified config file, exit and log errors if it fails,
|
'''Load the specified config file, exit and log errors if it fails,
|
||||||
otherwise return a config dictionary.'''
|
otherwise return a config dictionary.'''
|
||||||
|
|
||||||
import config
|
import config
|
||||||
if configdata == None: configdata = config.defaultConfigData
|
if configdata is None:
|
||||||
if filename != None:
|
configdata = config.defaultConfigData
|
||||||
|
if filename is not None:
|
||||||
try:
|
try:
|
||||||
_readConfigFile(filename, configdata)
|
_readConfigFile(filename, configdata)
|
||||||
except Exception, e:
|
except Exception, e:
|
||||||
@@ -237,7 +239,7 @@ def _processConfigFile(filename = None, configdata = None, useSyslog = 1,
|
|||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
return(configdata)
|
return(configdata)
|
||||||
|
|
||||||
####################
|
|
||||||
def _find_boolean(item):
|
def _find_boolean(item):
|
||||||
if type(item) == int:
|
if type(item) == int:
|
||||||
item = str(item)
|
item = str(item)
|
||||||
@@ -248,14 +250,15 @@ def _find_boolean(item):
|
|||||||
else:
|
else:
|
||||||
raise dkim.ParameterError()
|
raise dkim.ParameterError()
|
||||||
return item
|
return item
|
||||||
####################
|
|
||||||
def _calculate_authserv_id(as_id):
|
|
||||||
|
def _make_authserv_id(as_id):
|
||||||
"""Determine AuthservID if needed"""
|
"""Determine AuthservID if needed"""
|
||||||
if as_id == 'HOSTNAME':
|
if as_id == 'HOSTNAME':
|
||||||
as_id = socket.gethostname()
|
as_id = socket.gethostname()
|
||||||
return as_id
|
return as_id
|
||||||
|
|
||||||
####################
|
|
||||||
def _dataset_to_list(dataset):
|
def _dataset_to_list(dataset):
|
||||||
"""Convert a dataset (as defined in dkimpymilter.8) and return a python
|
"""Convert a dataset (as defined in dkimpymilter.8) and return a python
|
||||||
list of values."""
|
list of values."""
|
||||||
@@ -291,78 +294,90 @@ def _dataset_to_list(dataset):
|
|||||||
else:
|
else:
|
||||||
return [dataset.strip().strip(',')]
|
return [dataset.strip().strip(',')]
|
||||||
if dataset[-3:] == '.db' or dataset[:3] == 'db:':
|
if dataset[-3:] == '.db' or dataset[:3] == 'db:':
|
||||||
# This is a Sleepycat (Oracle) DB dataset
|
# This is a Sleepycat (Oracle) DB dataset
|
||||||
import whichdb # Will need rewriting someday for python3
|
import whichdb # Will need rewriting someday for python3
|
||||||
if dataset[-3:] == '.db':
|
if dataset[-3:] == '.db':
|
||||||
dbname = dataset
|
dbname = dataset
|
||||||
elif dataset[:3] == 'db:':
|
elif dataset[:3] == 'db:':
|
||||||
dbname = dataset[3:]
|
dbname = dataset[3:]
|
||||||
else:
|
else:
|
||||||
raise dkim.ParameterError('Unimplmented dataset type: {0}'.format(type(dataset)))
|
raise dkim.ParameterError('Unimplmented dataset type: {0}'
|
||||||
|
.format(type(dataset)))
|
||||||
if whichdb.whichdb(dbname) != 'dbhash':
|
if whichdb.whichdb(dbname) != 'dbhash':
|
||||||
raise dkim.ParameterError('Unimplmented dataset type: {0}'.format(type(dataset)))
|
raise dkim.ParameterError('Unimplmented dataset type: {0}'
|
||||||
|
.format(type(dataset)))
|
||||||
#TODO replace this with code to use db maps
|
#TODO replace this with code to use db maps
|
||||||
raise dkim.ParameterError('Unsupported dataset db dataset not yet used: {0}'.format(type(dataset)))
|
raise dkim.ParameterError('Unsupported dataset db datase: {0}'
|
||||||
|
.format(type(dataset)))
|
||||||
|
|
||||||
raise dkim.ParameterError('Unimplmented dataset type: {0}'.format(type(dataset)))
|
raise dkim.ParameterError('Unimplmented dataset type: {0}'
|
||||||
|
.format(type(dataset)))
|
||||||
|
|
||||||
###############################################################
|
|
||||||
commentRx = re.compile(r'^(.*)#.*$')
|
def _readConfigFile(path, configData=None, configGlobal={}):
|
||||||
def _readConfigFile(path, configData = None, configGlobal = {}):
|
|
||||||
'''Reads a configuration file from the specified path, merging it
|
'''Reads a configuration file from the specified path, merging it
|
||||||
with the configuration data specified in configData. Returns a
|
with the configuration data specified in configData. Returns a
|
||||||
dictionary of name/value pairs based on configData and the values
|
dictionary of name/value pairs based on configData and the values
|
||||||
read from path.'''
|
read from path.'''
|
||||||
|
|
||||||
debugLevel = configGlobal.get('debugLevel', 0)
|
debugLevel = configGlobal.get('debugLevel', 0)
|
||||||
if debugLevel >= 5: syslog.syslog('readConfigFile: Loading "%s"' % path)
|
if debugLevel >= 5:
|
||||||
if configData == None: configData = {}
|
syslog.syslog('readConfigFile: Loading "%s"' % path)
|
||||||
|
if configData is None:
|
||||||
|
configData = {}
|
||||||
nameConversion = {
|
nameConversion = {
|
||||||
'AuthservID' : 'str',
|
'AuthservID': 'str',
|
||||||
'Syslog' : 'bool',
|
'Syslog': 'bool',
|
||||||
'SyslogFacility' : 'str',
|
'SyslogFacility': 'str',
|
||||||
'SyslogSuccess' : 'bool',
|
'SyslogSuccess': 'bool',
|
||||||
'UMask' : 'int',
|
'UMask': 'int',
|
||||||
'Mode' : 'str',
|
'Mode': 'str',
|
||||||
'Socket' : 'str',
|
'Socket': 'str',
|
||||||
'PidFile' : 'str',
|
'PidFile': 'str',
|
||||||
'UserID' : 'str',
|
'UserID': 'str',
|
||||||
'Domain' : 'dataset',
|
'Domain': 'dataset',
|
||||||
'KeyFile' : 'str',
|
'KeyFile': 'str',
|
||||||
'KeyFileEd25519' : 'str',
|
'KeyFileEd25519': 'str',
|
||||||
'Selector' : 'str',
|
'Selector': 'str',
|
||||||
'SelectorEd25519': 'str',
|
'SelectorEd25519': 'str',
|
||||||
'Canonicalization' : 'str',
|
'Canonicalization': 'str',
|
||||||
'InternalHosts' : 'dataset',
|
'InternalHosts': 'dataset',
|
||||||
'InternalHostsObj': 'bool',
|
'IntHosts': 'bool',
|
||||||
'DiagnosticDirectory' : 'str'
|
'DiagnosticDirectory': 'str',
|
||||||
}
|
'MacroList': 'dataset',
|
||||||
|
'MacroListVerify': 'dataset',
|
||||||
|
'debugLevel': 'int'
|
||||||
|
}
|
||||||
|
|
||||||
# check to see if it's a file
|
# check to see if it's a file
|
||||||
try:
|
try:
|
||||||
mode = os.stat(path)[0]
|
mode = os.stat(path)[0]
|
||||||
except OSError, e:
|
except OSError, e:
|
||||||
syslog.syslog(syslog.LOG_ERR,'ERROR stating "%s": %s' % ( path, e.strerror ))
|
syslog.syslog(syslog.LOG_ERR, 'ERROR stating "%s": %s'
|
||||||
|
% (path, e.strerror))
|
||||||
return(configData)
|
return(configData)
|
||||||
if not stat.S_ISREG(mode):
|
if not stat.S_ISREG(mode):
|
||||||
syslog.syslog(syslog.LOG_ERR,'ERROR: is not a file: "%s", mode=%s' % ( path, oct(mode) ))
|
syslog.syslog(syslog.LOG_ERR, 'ERROR: is not a file: "%s", mode=%s'
|
||||||
|
% (path, oct(mode)))
|
||||||
return(configData)
|
return(configData)
|
||||||
|
|
||||||
# load file
|
# load file
|
||||||
fp = open(path, 'r')
|
fp = open(path, 'r')
|
||||||
while 1:
|
while 1:
|
||||||
line = fp.readline()
|
line = fp.readline()
|
||||||
if not line: break
|
if not line:
|
||||||
|
break
|
||||||
|
|
||||||
# parse line
|
# parse line
|
||||||
line = line.split('#', 1)[0].strip()
|
line = line.split('#', 1)[0].strip()
|
||||||
if not line: continue
|
if not line:
|
||||||
|
continue
|
||||||
data = line.split()
|
data = line.split()
|
||||||
if len(data) != 2:
|
if len(data) != 2:
|
||||||
if len(data) == 1:
|
if len(data) == 1:
|
||||||
if debugLevel >= 1:
|
if debugLevel >= 1:
|
||||||
syslog.syslog('Configuration item "%s" not defined in file "%s"'
|
syslog.syslog('Config item "%s" not defined in file "%s"'
|
||||||
% ( line, path ))
|
% (line, path))
|
||||||
if len(data) == 1:
|
if len(data) == 1:
|
||||||
name = data
|
name = data
|
||||||
value = ''
|
value = ''
|
||||||
@@ -374,12 +389,14 @@ def _readConfigFile(path, configData = None, configGlobal = {}):
|
|||||||
|
|
||||||
# check validity of name
|
# check validity of name
|
||||||
conversion = nameConversion.get(name)
|
conversion = nameConversion.get(name)
|
||||||
if conversion == None:
|
if conversion is None:
|
||||||
syslog.syslog('ERROR: Unknown name "%s" in file "%s"' % ( name, path ))
|
syslog.syslog('ERROR: Unknown name "%s" in file "%s"'
|
||||||
|
% (name, path))
|
||||||
continue
|
continue
|
||||||
|
|
||||||
if debugLevel >= 5: syslog.syslog('readConfigFile: Found entry "%s=%s"'
|
if debugLevel >= 5:
|
||||||
% ( name, value ))
|
syslog.syslog('readConfigFile: Found entry "%s=%s"'
|
||||||
|
% (name, value))
|
||||||
if conversion == 'bool':
|
if conversion == 'bool':
|
||||||
configData[name] = _find_boolean(value)
|
configData[name] = _find_boolean(value)
|
||||||
elif conversion == 'str':
|
elif conversion == 'str':
|
||||||
@@ -389,12 +406,13 @@ def _readConfigFile(path, configData = None, configGlobal = {}):
|
|||||||
elif conversion == 'dataset':
|
elif conversion == 'dataset':
|
||||||
configData[name] = _dataset_to_list(value)
|
configData[name] = _dataset_to_list(value)
|
||||||
else:
|
else:
|
||||||
syslog.syslog(str('name: ' + name + ' value: ' + value + ' conversion: ' + conversion))
|
syslog.syslog(str('name: ' + name + ' value: ' + value +
|
||||||
|
' conversion: ' + conversion))
|
||||||
configData[name] = conversion(value)
|
configData[name] = conversion(value)
|
||||||
fp.close()
|
fp.close()
|
||||||
try:
|
try:
|
||||||
configData['AuthservID'] = _calculate_authserv_id(configData['AuthservID'])
|
configData['AuthservID'] = _make_authserv_id(configData['AuthservID'])
|
||||||
configData['InternalHostsObj'] = HostsDataset(configData['InternalHosts'])
|
configData['IntHosts'] = HostsDataset(configData['InternalHosts'])
|
||||||
except:
|
except:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|||||||
+19
-13
@@ -16,6 +16,7 @@
|
|||||||
# with this program; if not, write to the Free Software Foundation, Inc.,
|
# with this program; if not, write to the Free Software Foundation, Inc.,
|
||||||
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||||
|
|
||||||
|
|
||||||
def fold(header):
|
def fold(header):
|
||||||
"""Fold a header line into multiple crlf-separated lines at column 72.
|
"""Fold a header line into multiple crlf-separated lines at column 72.
|
||||||
Borrowed from dkimpy and updated to only add \n instead of \r\n because
|
Borrowed from dkimpy and updated to only add \n instead of \r\n because
|
||||||
@@ -46,9 +47,9 @@ def fold(header):
|
|||||||
j = i + 1
|
j = i + 1
|
||||||
pre += header[:j] + b"\n "
|
pre += header[:j] + b"\n "
|
||||||
header = header[j:]
|
header = header[j:]
|
||||||
namelen = 0
|
|
||||||
return pre + header
|
return pre + header
|
||||||
|
|
||||||
|
|
||||||
def user_group(userid):
|
def user_group(userid):
|
||||||
"""Return user and group from UserID"""
|
"""Return user and group from UserID"""
|
||||||
import grp
|
import grp
|
||||||
@@ -64,13 +65,14 @@ def user_group(userid):
|
|||||||
running_gid = grp.getgrnam(gidname).gr_gid
|
running_gid = grp.getgrnam(gidname).gr_gid
|
||||||
return running_uid, running_gid
|
return running_uid, running_gid
|
||||||
|
|
||||||
|
|
||||||
def drop_privileges(milterconfig):
|
def drop_privileges(milterconfig):
|
||||||
import os
|
import os
|
||||||
import syslog
|
import syslog
|
||||||
|
|
||||||
if os.getuid() != 0:
|
if os.getuid() != 0:
|
||||||
if milterconfig.get('Syslog'):
|
if milterconfig.get('Syslog'):
|
||||||
syslog.syslog('drop_privileges: Not running as root. Cannot drop permissions.')
|
syslog.syslog('drop_privileges: Not root. No action taken.')
|
||||||
return
|
return
|
||||||
|
|
||||||
# Get user and group
|
# Get user and group
|
||||||
@@ -86,9 +88,9 @@ def drop_privileges(milterconfig):
|
|||||||
# Set umask
|
# Set umask
|
||||||
old_umask = os.umask(milterconfig.get('UMask'))
|
old_umask = os.umask(milterconfig.get('UMask'))
|
||||||
|
|
||||||
#################
|
|
||||||
class ExceptHook:
|
class ExceptHook:
|
||||||
def __init__(self, useSyslog = 1, useStderr = 0):
|
def __init__(self, useSyslog=1, useStderr=0):
|
||||||
self.useSyslog = useSyslog
|
self.useSyslog = useSyslog
|
||||||
self.useStderr = useStderr
|
self.useStderr = useStderr
|
||||||
|
|
||||||
@@ -104,12 +106,11 @@ class ExceptHook:
|
|||||||
sys.stderr.write(line)
|
sys.stderr.write(line)
|
||||||
|
|
||||||
|
|
||||||
####################
|
|
||||||
def setExceptHook():
|
def setExceptHook():
|
||||||
import sys
|
import sys
|
||||||
sys.excepthook = ExceptHook(useSyslog = 1, useStderr = 1)
|
sys.excepthook = ExceptHook(useSyslog=1, useStderr=1)
|
||||||
|
|
||||||
|
|
||||||
####################
|
|
||||||
def write_pid(milterconfig):
|
def write_pid(milterconfig):
|
||||||
"""Write PID in pidfile. Will not overwrite an existing file."""
|
"""Write PID in pidfile. Will not overwrite an existing file."""
|
||||||
import os
|
import os
|
||||||
@@ -126,10 +127,11 @@ def write_pid(milterconfig):
|
|||||||
os.chown(piddir, user, group)
|
os.chown(piddir, user, group)
|
||||||
f = open(milterconfig.get('PidFile'), 'w')
|
f = open(milterconfig.get('PidFile'), 'w')
|
||||||
if milterconfig.get('Syslog'):
|
if milterconfig.get('Syslog'):
|
||||||
syslog.syslog('Missing pid dir created: {0}'.format(piddir))
|
syslog.syslog('PID dir created: {0}'.format(piddir))
|
||||||
else:
|
else:
|
||||||
if milterconfig.get('Syslog'):
|
if milterconfig.get('Syslog'):
|
||||||
syslog.syslog('Unable to write pidfle {0}. IOError: {1}'.format(milterconfig.get('PidFile'), e))
|
syslog.syslog('Unable to write pidfle {0}. IOError: {1}'
|
||||||
|
.format(milterconfig.get('PidFile'), e))
|
||||||
raise
|
raise
|
||||||
f.write(pid)
|
f.write(pid)
|
||||||
f.close()
|
f.close()
|
||||||
@@ -137,10 +139,13 @@ def write_pid(milterconfig):
|
|||||||
os.chown(milterconfig.get('PidFile'), user, group)
|
os.chown(milterconfig.get('PidFile'), user, group)
|
||||||
else:
|
else:
|
||||||
if milterconfig.get('Syslog'):
|
if milterconfig.get('Syslog'):
|
||||||
syslog.syslog('Unable to write pidfle {0}. File exists.'.format(milterconfig.get('PidFile')))
|
syslog.syslog('Unable to write pidfle {0}. File exists.'
|
||||||
raise RuntimeError('Unable to write pidfle {0}. File exists.'.format(milterconfig.get('PidFile')))
|
.format(milterconfig.get('PidFile')))
|
||||||
|
raise RuntimeError('Unable to write pidfle {0}. File exists.'
|
||||||
|
.format(milterconfig.get('PidFile')))
|
||||||
return pid
|
return pid
|
||||||
|
|
||||||
|
|
||||||
def own_socketfile(milterconfig):
|
def own_socketfile(milterconfig):
|
||||||
"""If socket is Unix socket, chown to UserID before dropping privileges"""
|
"""If socket is Unix socket, chown to UserID before dropping privileges"""
|
||||||
import os
|
import os
|
||||||
@@ -150,7 +155,7 @@ def own_socketfile(milterconfig):
|
|||||||
if milterconfig.get('Socket')[:6] == "local:":
|
if milterconfig.get('Socket')[:6] == "local:":
|
||||||
os.chown(milterconfig.get('Socket')[6:], user, group)
|
os.chown(milterconfig.get('Socket')[6:], user, group)
|
||||||
|
|
||||||
####################
|
|
||||||
def read_keyfile(milterconfig, keytype):
|
def read_keyfile(milterconfig, keytype):
|
||||||
"""Read private key from file."""
|
"""Read private key from file."""
|
||||||
import syslog
|
import syslog
|
||||||
@@ -163,7 +168,8 @@ def read_keyfile(milterconfig, keytype):
|
|||||||
keylist = f.readlines()
|
keylist = f.readlines()
|
||||||
except IOError as e:
|
except IOError as e:
|
||||||
if milterconfig.get('Syslog'):
|
if milterconfig.get('Syslog'):
|
||||||
syslog.syslog('Unable to read keyfile {0}. IOError: {1}'.format(keyfile, e))
|
syslog.syslog('Unable to read keyfile {0}. IOError: {1}'
|
||||||
|
.format(keyfile, e))
|
||||||
raise
|
raise
|
||||||
f.close()
|
f.close()
|
||||||
key = ''
|
key = ''
|
||||||
|
|||||||
@@ -255,13 +255,50 @@ all messages. Ignored if a
|
|||||||
is defined. [KeyTable NOT IMPLEMENTED]
|
is defined. [KeyTable NOT IMPLEMENTED]
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
.I KeyFileEd25119 (string)
|
.I KeyFileEd25519 (string)
|
||||||
Gives the location of a Ed25519 private key to be used for Ed25519 signing
|
Gives the location of a Ed25519 private key to be used for Ed25519 signing
|
||||||
all messages. File is the Base64 encoded output of RFC 8032 Ed25519 private Key
|
all messages. File is the Base64 encoded output of RFC 8032 Ed25519 private Key
|
||||||
generation (as used in dkimpy). Ignored if a
|
generation (as used in dkimpy). Ignored if a
|
||||||
.I KeyTableEd25519
|
.I KeyTableEd25519
|
||||||
is defined. [KeyTableEd25519 NOT IMPLEMENTED]
|
is defined. [KeyTableEd25519 NOT IMPLEMENTED]
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.I MacroList (dataset)
|
||||||
|
Defines a set of MTA-provided
|
||||||
|
.I macros
|
||||||
|
that should be checked to see if the sender has been determined to be a
|
||||||
|
local user and therefore whether or not the message should be signed. If
|
||||||
|
a
|
||||||
|
.I value
|
||||||
|
is specified matching a macro name in the data set, the value of the macro
|
||||||
|
must match a value specified (matching is case-sensitive), otherwise the
|
||||||
|
macro must be defined but may contain any value. The set is empty by
|
||||||
|
default, meaning macros are not considered when making the sign-verify
|
||||||
|
decision. The general format of the value is
|
||||||
|
.I value1[|value2[|...]];
|
||||||
|
if one or more value is defined then the macro must be set to one of the
|
||||||
|
listed values, otherwise the macro must be set but can contain any
|
||||||
|
value.
|
||||||
|
|
||||||
|
In order for the macro and its value to be available to the filter for
|
||||||
|
checking, the MTA must send it during the protocol exchange. This is either
|
||||||
|
accomplished via manual configuration of the MTA to send the desired macros
|
||||||
|
or, for MTA/filter combinations that support the feature, the filter can
|
||||||
|
request those macros that are of interest. The latter is a feature negotiated
|
||||||
|
at the time the filter receives a connection from the MTA and its availability
|
||||||
|
depends upon the version of milter used to compile the filter and the version
|
||||||
|
of the MTA making the connection.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.I MacroListVerify (dataset)
|
||||||
|
Defines a set of MTA-provided
|
||||||
|
.I macros
|
||||||
|
that should be checked to see if the sender has been determined to be an
|
||||||
|
external source and therefore whether or not the message should be signed.
|
||||||
|
Entries in this data set follow the same form as those of the
|
||||||
|
.I MacroList
|
||||||
|
option above. [this option is not inhereted from OpenDKIM]
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
.I Mode (string)
|
.I Mode (string)
|
||||||
Selects operating modes. The string is a concatenation of characters that
|
Selects operating modes. The string is a concatenation of characters that
|
||||||
|
|||||||
@@ -22,6 +22,13 @@ import dkimpy_milter
|
|||||||
|
|
||||||
description = "Domain Keys Identified Mail (DKIM) signing/verifying milter for Postfix/Sendmail."
|
description = "Domain Keys Identified Mail (DKIM) signing/verifying milter for Postfix/Sendmail."
|
||||||
|
|
||||||
|
kw = {} # Work-around for lack of 'or' requires in setuptools.
|
||||||
|
try:
|
||||||
|
import DNS
|
||||||
|
kw['install_requires'] = ['dkimpy>=0.7', 'pymilter', 'authres>=1.1.0', 'PyNaCl', 'ipaddress', 'PyDNS']
|
||||||
|
except ImportError: # If PyDNS is not installed, prefer dnspython
|
||||||
|
kw['install_requires'] = ['dkimpy>=0.7', 'pymilter', 'authres>=1.1.0', 'PyNaCl', 'ipaddress', 'dnspython']
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name='dkimpy-milter',
|
name='dkimpy-milter',
|
||||||
version=dkimpy_milter.__version__,
|
version=dkimpy_milter.__version__,
|
||||||
@@ -31,7 +38,7 @@ setup(
|
|||||||
description=description,
|
description=description,
|
||||||
download_url = "https://pypi.python.org/pypi/dkimpy-milter",
|
download_url = "https://pypi.python.org/pypi/dkimpy-milter",
|
||||||
classifiers= [
|
classifiers= [
|
||||||
'Development Status :: 3 - Alpha',
|
'Development Status :: 4 - Beta',
|
||||||
'Environment :: No Input/Output (Daemon)',
|
'Environment :: No Input/Output (Daemon)',
|
||||||
'Intended Audience :: System Administrators',
|
'Intended Audience :: System Administrators',
|
||||||
'License :: OSI Approved :: GNU General Public License (GPL)',
|
'License :: OSI Approved :: GNU General Public License (GPL)',
|
||||||
@@ -52,9 +59,9 @@ setup(
|
|||||||
data_files=[(os.path.join('share', 'man', 'man5'),
|
data_files=[(os.path.join('share', 'man', 'man5'),
|
||||||
['man/dkimpy-milter.conf.5']), (os.path.join('share', 'man', 'man8'),
|
['man/dkimpy-milter.conf.5']), (os.path.join('share', 'man', 'man8'),
|
||||||
['man/dkimpy-milter.8']), ('etc', ['etc/dkimpy-milter.conf']),
|
['man/dkimpy-milter.8']), ('etc', ['etc/dkimpy-milter.conf']),
|
||||||
(os.path.join('/lib', 'systemd', 'system'),
|
(os.path.join('lib', 'systemd', 'system'),
|
||||||
['system/dkimpy-milter.service']),(os.path.join('/etc', 'init.d'),
|
['system/dkimpy-milter.service']),(os.path.join('etc', 'init.d'),
|
||||||
['system/dkimpy-milter'])],
|
['system/dkimpy-milter'])],
|
||||||
install_requires = ['dkimpy>=0.7', 'pymilter', 'authres>=1.1.0', 'PyNaCl', 'ipaddress', 'dns'],
|
|
||||||
zip_safe = False,
|
zip_safe = False,
|
||||||
|
**kw
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ After=syslog.target network.target
|
|||||||
[Service]
|
[Service]
|
||||||
Type=simple
|
Type=simple
|
||||||
PIDFile=/var/run/dkimpy-milter/dkimpy-milter.pid
|
PIDFile=/var/run/dkimpy-milter/dkimpy-milter.pid
|
||||||
ExecStart=/usr/local/bin/dkimpy-milter
|
ExecStart=/usr/local/bin/dkimpy-milter /usr/local/etc/dkimpy-milter.conf
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=multi-user.target
|
WantedBy=multi-user.target
|
||||||
|
|||||||
Reference in New Issue
Block a user