1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
# Author: Stuart D. Gathman <stuart@bmsi.com>
# Copyright 2006 Business Management Systems, Inc.
# This module is free software, and you may redistribute it and/or modify
# it under the same terms as Python itself, so long as this copyright message
# and disclaimer are retained in their original form.
# Run SPF test cases in the YAML format specified by the SPF council.
import unittest
import socket
import sys
import spf
import re
try:
import yaml
except:
print("yaml can be found at http://pyyaml.org/")
print("Tested with PYYAML 3.04")
raise
zonedata = {}
RE_IP4 = re.compile(r'\.'.join(
[r'(?:\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])']*4)+'$')
def DNSLookup(name,qtype,strict=True,timeout=None):
try:
#print name,qtype
timeout = True
# emulate pydns-2.3.0 label processing
a = []
for label in name.split('.'):
if label:
if len(label) > 63:
raise spf.TempError('DNS label too long')
a.append(label)
name = '.'.join(a)
for i in zonedata[name.lower()]:
if i == 'TIMEOUT':
if timeout:
raise spf.TempError('DNS timeout')
return
t,v = i
if t == qtype:
timeout = False
if v == 'TIMEOUT':
if t == qtype:
raise spf.TempError('DNS timeout')
continue
# keep test zonedata human readable, but translate to simulate pydns
if t == 'AAAA':
v = spf.inet_pton(v)
yield ((name,t),v)
except KeyError:
if name.startswith('error.'):
raise spf.TempError('DNS timeout')
spf.DNSLookup = DNSLookup
class SPFTest(object):
def __init__(self,testid,scenario,data={}):
self.id = testid
self.scenario = scenario
self.explanation = None
self.spec = None
self.header = None
self.strict = True
self.receiver = None
self.comment = []
if 'result' not in data:
print(testid,'missing result')
for k,v in list(data.items()):
setattr(self,k,v)
if type(self.comment) is str:
self.comment = self.comment.splitlines()
def getrdata(r):
"Unpack rdata given as list of maps to list of tuples."
txt = [] # generated TXT records
gen = True
for m in r:
try:
for i in list(m.items()):
t,v = i
if t == 'TXT':
gen = False # no generated TXT records
elif t == 'SPF' and gen:
txt.append(('TXT',v))
if v != 'NONE':
if t in ('TXT','SPF') and type(v) == str:
yield (t,(v,))
else:
yield i
except:
yield m
if gen:
for i in txt:
yield i
def loadZone(data):
return dict([
(d.lower(), list(getrdata(r))) for d,r in list(data['zonedata'].items())
])
class SPFScenario(object):
def __init__(self,filename=None,data={}):
self.id = None
self.filename = filename
self.comment = []
self.zonedata = {}
self.tests = {}
if data:
self.zonedata= loadZone(data)
#print self.zonedata
for t,v in list(data['tests'].items()):
self.tests[t] = SPFTest(t,self,v)
if 'id' in data:
self.id = data['id']
if 'comment' in data:
self.comment = data['comment'].splitlines()
def addDNS(self,name,val):
self.zonedata.setdefault(name,[]).append(val)
def addTest(self,test):
self.tests[test.id] = test
def loadYAML(fname):
"Load testcases in YAML format. Return map of SPFTests by name."
fp = open(fname,'rb')
try:
tests = {}
for s in yaml.safe_load_all(fp):
scenario = SPFScenario(fname,data=s)
for k,v in list(scenario.tests.items()):
tests[k] = v
return tests
finally: fp.close()
oldresults = { 'unknown': 'permerror', 'error': 'temperror' }
verbose = 0
class SPFTestCase(unittest.TestCase):
def setUp(self):
global zonedata
self.savezonedata = zonedata
def tearDown(self):
global zonedata
zonedata = self.savezonedata
def runTest(self,tests):
global zonedata
passed,failed = 0,0
for t in tests:
zonedata = t.scenario.zonedata
q = spf.query(i=t.host, s=t.mailfrom, h=t.helo, strict=t.strict)
q.set_default_explanation('DEFAULT')
res,code,exp = q.check()
if res in oldresults:
res = oldresults[res]
ok = True
if res != t.result and res not in t.result:
if verbose: print(t.result,'!=',res)
ok = False
elif res != t.result and res != t.result[0]:
print("WARN: %s in %s, %s: %s preferred to %s" % (
t.id,t.scenario.filename,t.spec,t.result[0],res))
if t.explanation is not None and t.explanation != exp:
if verbose: print(t.explanation,'!=',exp)
ok = False
if t.header:
self.assertEqual(t.header,q.get_header(res,receiver=t.receiver))
if ok:
passed += 1
else:
failed += 1
print("%s in %s failed, %s" % (t.id,t.scenario.filename,t.spec))
if verbose and not t.explanation: print(exp)
if verbose > 1: print(t.scenario.zonedata)
if failed:
print("%d passed" % passed,"%d failed" % failed)
def testYAML(self):
self.runTest(list(loadYAML('test.yml').values()))
def testRFC(self):
self.runTest(list(loadYAML('rfc4408-tests.yml').values()))
def testInvalidSPF(self):
i, s, h = '1.2.3.4','sender@domain','helo'
q = spf.query(i=i, s=s, h=h, receiver='localhost', strict=False)
res,code,txt = q.check('v=spf1...')
self.assertEquals('none',res)
q = spf.query(i=i, s=s, h=h, receiver='localhost', strict=2)
res,code,txt = q.check('v=spf1...')
self.assertEquals('ambiguous',res)
def suite():
suite = unittest.makeSuite(SPFTestCase,'test')
import doctest
suite.addTest(doctest.DocTestSuite(spf))
return suite
if __name__ == '__main__':
tc = None
for i in sys.argv[1:]:
if i == '-v':
verbose += 1
continue
if not tc:
tc = SPFTestCase()
t = loadYAML('rfc4408-tests.yml')
if not t.has_key(i):
t = loadYAML('test.yml')
tc.runTest([t[i]])
if not tc:
fp = open('doctest.yml','rb')
try:
zonedata = loadZone(next(yaml.safe_load_all(fp)))
finally: fp.close()
#print zonedata
suite = suite()
unittest.TextTestRunner().run(suite)
|
