summaryrefslogtreecommitdiffstats
path: root/Lib/test/test_email/test_defect_handling.py
blob: d3df1e4b470079f31ea399ca191006337936d56b (plain)
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
import textwrap
import unittest
from email._policybase import Compat32
from email import errors
from test.test_email import TestEmailBase


class TestMessageDefectDetectionBase:

    dup_boundary_msg = textwrap.dedent("""\
        Subject: XX
        From: xx@xx.dk
        To: XX
        Mime-version: 1.0
        Content-type: multipart/mixed;
           boundary="MS_Mac_OE_3071477847_720252_MIME_Part"

        --MS_Mac_OE_3071477847_720252_MIME_Part
        Content-type: multipart/alternative;
           boundary="MS_Mac_OE_3071477847_720252_MIME_Part"

        --MS_Mac_OE_3071477847_720252_MIME_Part
        Content-type: text/plain; charset="ISO-8859-1"
        Content-transfer-encoding: quoted-printable

        text

        --MS_Mac_OE_3071477847_720252_MIME_Part
        Content-type: text/html; charset="ISO-8859-1"
        Content-transfer-encoding: quoted-printable

        <HTML></HTML>

        --MS_Mac_OE_3071477847_720252_MIME_Part--

        --MS_Mac_OE_3071477847_720252_MIME_Part
        Content-type: image/gif; name="xx.gif";
        Content-disposition: attachment
        Content-transfer-encoding: base64

        Some removed base64 encoded chars.

        --MS_Mac_OE_3071477847_720252_MIME_Part--

        """)

    def test_same_boundary_inner_outer(self):
        # XXX better would be to actually detect the duplicate.
        msg = self._str_msg(self.dup_boundary_msg)
        inner = msg.get_payload(0)
        self.assertTrue(hasattr(inner, 'defects'))
        self.assertEqual(len(self.get_defects(inner)), 1)
        self.assertTrue(isinstance(self.get_defects(inner)[0],
                                   errors.StartBoundaryNotFoundDefect))

    def test_same_boundary_inner_outer_raises_on_defect(self):
        with self.assertRaises(errors.StartBoundaryNotFoundDefect):
            self._str_msg(self.dup_boundary_msg,
                policy=self.policy.clone(raise_on_defect=True))

    no_boundary_msg = textwrap.dedent("""\
        Date: Fri, 6 Apr 2001 09:23:06 -0800 (GMT-0800)
        From: foobar
        Subject: broken mail
        MIME-Version: 1.0
        Content-Type: multipart/report; report-type=delivery-status;

        --JAB03225.986577786/zinfandel.lacita.com

        One part

        --JAB03225.986577786/zinfandel.lacita.com
        Content-Type: message/delivery-status

        Header: Another part

        --JAB03225.986577786/zinfandel.lacita.com--
        """)

    def test_multipart_no_boundary(self):
        msg = self._str_msg(self.no_boundary_msg)
        self.assertTrue(isinstance(msg.get_payload(), str))
        self.assertEqual(len(self.get_defects(msg)), 2)
        self.assertTrue(isinstance(self.get_defects(msg)[0],
                                   errors.NoBoundaryInMultipartDefect))
        self.assertTrue(isinstance(self.get_defects(msg)[1],
                                   errors.MultipartInvariantViolationDefect))

    def test_multipart_no_boundary_raise_on_defect(self):
        with self.assertRaises(errors.NoBoundaryInMultipartDefect):
            self._str_msg(self.no_boundary_msg,
                policy=self.policy.clone(raise_on_defect=True))

    multipart_msg = textwrap.dedent("""\
        Date: Wed, 14 Nov 2007 12:56:23 GMT
        From: foo@bar.invalid
        To: foo@bar.invalid
        Subject: Content-Transfer-Encoding: base64 and multipart
        MIME-Version: 1.0
        Content-Type: multipart/mixed;
            boundary="===============3344438784458119861=="{}

        --===============3344438784458119861==
        Content-Type: text/plain

        Test message

        --===============3344438784458119861==
        Content-Type: application/octet-stream
        Content-Transfer-Encoding: base64

        YWJj

        --===============3344438784458119861==--
        """)

    def test_multipart_invalid_cte(self):
        msg = self._str_msg(
            self.multipart_msg.format("\nContent-Transfer-Encoding: base64"))
        self.assertEqual(len(self.get_defects(msg)), 1)
        self.assertIsInstance(self.get_defects(msg)[0],
            errors.InvalidMultipartContentTransferEncodingDefect)

    def test_multipart_invalid_cte_raise_on_defect(self):
        with self.assertRaises(
                errors.InvalidMultipartContentTransferEncodingDefect):
            self._str_msg(
                self.multipart_msg.format(
                    "\nContent-Transfer-Encoding: base64"),
                policy=self.policy.clone(raise_on_defect=True))

    def test_multipart_no_cte_no_defect(self):
        msg = self._str_msg(self.multipart_msg.format(''))
        self.assertEqual(len(self.get_defects(msg)), 0)

    def test_multipart_valid_cte_no_defect(self):
        for cte in ('7bit', '8bit', 'BINary'):
            msg = self._str_msg(
                self.multipart_msg.format("\nContent-Transfer-Encoding: "+cte))
            self.assertEqual(len(self.get_defects(msg)), 0, "cte="+cte)

    lying_multipart_msg = textwrap.dedent("""\
        From: "Allison Dunlap" <xxx@example.com>
        To: yyy@example.com
        Subject: 64423
        Date: Sun, 11 Jul 2004 16:09:27 -0300
        MIME-Version: 1.0
        Content-Type: multipart/alternative;

        Blah blah blah
        """)

    def test_lying_multipart(self):
        msg = self._str_msg(self.lying_multipart_msg)
        self.assertTrue(hasattr(msg, 'defects'))
        self.assertEqual(len(self.get_defects(msg)), 2)
        self.assertTrue(isinstance(self.get_defects(msg)[0],
                                   errors.NoBoundaryInMultipartDefect))
        self.assertTrue(isinstance(self.get_defects(msg)[1],
                                   errors.MultipartInvariantViolationDefect))

    def test_lying_multipart_raise_on_defect(self):
        with self.assertRaises(errors.NoBoundaryInMultipartDefect):
            self._str_msg(self.lying_multipart_msg,
                policy=self.policy.clone(raise_on_defect=True))

    missing_start_boundary_msg = textwrap.dedent("""\
        Content-Type: multipart/mixed; boundary="AAA"
        From: Mail Delivery Subsystem <xxx@example.com>
        To: yyy@example.com

        --AAA

        Stuff

        --AAA
        Content-Type: message/rfc822

        From: webmaster@python.org
        To: zzz@example.com
        Content-Type: multipart/mixed; boundary="BBB"

        --BBB--

        --AAA--

        """)

    def test_missing_start_boundary(self):
        # The message structure is:
        #
        # multipart/mixed
        #    text/plain
        #    message/rfc822
        #        multipart/mixed [*]
        #
        # [*] This message is missing its start boundary
        outer = self._str_msg(self.missing_start_boundary_msg)
        bad = outer.get_payload(1).get_payload(0)
        self.assertEqual(len(self.get_defects(bad)), 1)
        self.assertTrue(isinstance(self.get_defects(bad)[0],
                                   errors.StartBoundaryNotFoundDefect))

    def test_missing_start_boundary_raise_on_defect(self):
        with self.assertRaises(errors.StartBoundaryNotFoundDefect):
            self._str_msg(self.missing_start_boundary_msg,
                          policy=self.policy.clone(raise_on_defect=True))

    def test_first_line_is_continuation_header(self):
        msg = self._str_msg(' Line 1\nSubject: test\n\nbody')
        self.assertEqual(msg.keys(), ['Subject'])
        self.assertEqual(msg.get_payload(), 'body')
        self.assertEqual(len(self.get_defects(msg)), 1)
        self.assertDefectsEqual(self.get_defects(msg),
                                 [errors.FirstHeaderLineIsContinuationDefect])
        self.assertEqual(self.get_defects(msg)[0].line, ' Line 1\n')

    def test_first_line_is_continuation_header_raise_on_defect(self):
        with self.assertRaises(errors.FirstHeaderLineIsContinuationDefect):
            self._str_msg(' Line 1\nSubject: test\n\nbody\n',
                          policy=self.policy.clone(raise_on_defect=True))

    def test_missing_header_body_separator(self):
        # Our heuristic if we see a line that doesn't look like a header (no
        # leading whitespace but no ':') is to assume that the blank line that
        # separates the header from the body is missing, and to stop parsing
        # headers and start parsing the body.
        msg = self._str_msg('Subject: test\nnot a header\nTo: abc\n\nb\n')
        self.assertEqual(msg.keys(), ['Subject'])
        self.assertEqual(msg.get_payload(), 'not a header\nTo: abc\n\nb\n')
        self.assertDefectsEqual(self.get_defects(msg),
                                [errors.MissingHeaderBodySeparatorDefect])

    def test_missing_header_body_separator_raise_on_defect(self):
        with self.assertRaises(errors.MissingHeaderBodySeparatorDefect):
            self._str_msg('Subject: test\nnot a header\nTo: abc\n\nb\n',
                          policy=self.policy.clone(raise_on_defect=True))

    badly_padded_base64_payload = textwrap.dedent("""\
        Subject: test
        MIME-Version: 1.0
        Content-Type: text/plain; charset="utf-8"
        Content-Transfer-Encoding: base64

        dmk
        """)

    def test_bad_padding_in_base64_payload(self):
        msg = self._str_msg(self.badly_padded_base64_payload)
        self.assertEqual(msg.get_payload(decode=True), b'vi')
        self.assertDefectsEqual(self.get_defects(msg),
                                [errors.InvalidBase64PaddingDefect])

    def test_bad_padding_in_base64_payload_raise_on_defect(self):
        msg = self._str_msg(self.badly_padded_base64_payload,
                            policy=self.policy.clone(raise_on_defect=True))
        with self.assertRaises(errors.InvalidBase64PaddingDefect):
            msg.get_payload(decode=True)

    invalid_chars_in_base64_payload = textwrap.dedent("""\
        Subject: test
        MIME-Version: 1.0
        Content-Type: text/plain; charset="utf-8"
        Content-Transfer-Encoding: base64

        dm\x01k===
        """)

    def test_invalid_chars_in_base64_payload(self):
        msg = self._str_msg(self.invalid_chars_in_base64_payload)
        self.assertEqual(msg.get_payload(decode=True), b'vi')
        self.assertDefectsEqual(self.get_defects(msg),
                                [errors.InvalidBase64CharactersDefect])

    def test_invalid_chars_in_base64_payload_raise_on_defect(self):
        msg = self._str_msg(self.invalid_chars_in_base64_payload,
                            policy=self.policy.clone(raise_on_defect=True))
        with self.assertRaises(errors.InvalidBase64CharactersDefect):
            msg.get_payload(decode=True)


class TestMessageDefectDetection(TestMessageDefectDetectionBase, TestEmailBase):

    def get_defects(self, obj):
        return obj.defects


class TestMessageDefectDetectionCapture(TestMessageDefectDetectionBase,
                                        TestEmailBase):

    class CapturePolicy(Compat32):
        captured = None
        def register_defect(self, obj, defect):
            self.captured.append(defect)

    def setUp(self):
        self.policy = self.CapturePolicy(captured=list())

    def get_defects(self, obj):
        return self.policy.captured


if __name__ == '__main__':
    unittest.main()