• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1import unittest
2import base64
3import binascii
4import os
5from array import array
6from test.support import os_helper
7from test.support import script_helper
8
9
10class LegacyBase64TestCase(unittest.TestCase):
11
12    # Legacy API is not as permissive as the modern API
13    def check_type_errors(self, f):
14        self.assertRaises(TypeError, f, "")
15        self.assertRaises(TypeError, f, [])
16        multidimensional = memoryview(b"1234").cast('B', (2, 2))
17        self.assertRaises(TypeError, f, multidimensional)
18        int_data = memoryview(b"1234").cast('I')
19        self.assertRaises(TypeError, f, int_data)
20
21    def test_encodebytes(self):
22        eq = self.assertEqual
23        eq(base64.encodebytes(b"www.python.org"), b"d3d3LnB5dGhvbi5vcmc=\n")
24        eq(base64.encodebytes(b"a"), b"YQ==\n")
25        eq(base64.encodebytes(b"ab"), b"YWI=\n")
26        eq(base64.encodebytes(b"abc"), b"YWJj\n")
27        eq(base64.encodebytes(b""), b"")
28        eq(base64.encodebytes(b"abcdefghijklmnopqrstuvwxyz"
29                               b"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
30                               b"0123456789!@#0^&*();:<>,. []{}"),
31           b"YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXpBQkNE"
32           b"RUZHSElKS0xNTk9QUVJTVFVWV1hZWjAxMjM0\nNT"
33           b"Y3ODkhQCMwXiYqKCk7Ojw+LC4gW117fQ==\n")
34        # Non-bytes
35        eq(base64.encodebytes(bytearray(b'abc')), b'YWJj\n')
36        eq(base64.encodebytes(memoryview(b'abc')), b'YWJj\n')
37        eq(base64.encodebytes(array('B', b'abc')), b'YWJj\n')
38        self.check_type_errors(base64.encodebytes)
39
40    def test_decodebytes(self):
41        eq = self.assertEqual
42        eq(base64.decodebytes(b"d3d3LnB5dGhvbi5vcmc=\n"), b"www.python.org")
43        eq(base64.decodebytes(b"YQ==\n"), b"a")
44        eq(base64.decodebytes(b"YWI=\n"), b"ab")
45        eq(base64.decodebytes(b"YWJj\n"), b"abc")
46        eq(base64.decodebytes(b"YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXpBQkNE"
47                               b"RUZHSElKS0xNTk9QUVJTVFVWV1hZWjAxMjM0\nNT"
48                               b"Y3ODkhQCMwXiYqKCk7Ojw+LC4gW117fQ==\n"),
49           b"abcdefghijklmnopqrstuvwxyz"
50           b"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
51           b"0123456789!@#0^&*();:<>,. []{}")
52        eq(base64.decodebytes(b''), b'')
53        # Non-bytes
54        eq(base64.decodebytes(bytearray(b'YWJj\n')), b'abc')
55        eq(base64.decodebytes(memoryview(b'YWJj\n')), b'abc')
56        eq(base64.decodebytes(array('B', b'YWJj\n')), b'abc')
57        self.check_type_errors(base64.decodebytes)
58
59    def test_encode(self):
60        eq = self.assertEqual
61        from io import BytesIO, StringIO
62        infp = BytesIO(b'abcdefghijklmnopqrstuvwxyz'
63                       b'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
64                       b'0123456789!@#0^&*();:<>,. []{}')
65        outfp = BytesIO()
66        base64.encode(infp, outfp)
67        eq(outfp.getvalue(),
68           b'YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXpBQkNE'
69           b'RUZHSElKS0xNTk9QUVJTVFVWV1hZWjAxMjM0\nNT'
70           b'Y3ODkhQCMwXiYqKCk7Ojw+LC4gW117fQ==\n')
71        # Non-binary files
72        self.assertRaises(TypeError, base64.encode, StringIO('abc'), BytesIO())
73        self.assertRaises(TypeError, base64.encode, BytesIO(b'abc'), StringIO())
74        self.assertRaises(TypeError, base64.encode, StringIO('abc'), StringIO())
75
76    def test_decode(self):
77        from io import BytesIO, StringIO
78        infp = BytesIO(b'd3d3LnB5dGhvbi5vcmc=')
79        outfp = BytesIO()
80        base64.decode(infp, outfp)
81        self.assertEqual(outfp.getvalue(), b'www.python.org')
82        # Non-binary files
83        self.assertRaises(TypeError, base64.encode, StringIO('YWJj\n'), BytesIO())
84        self.assertRaises(TypeError, base64.encode, BytesIO(b'YWJj\n'), StringIO())
85        self.assertRaises(TypeError, base64.encode, StringIO('YWJj\n'), StringIO())
86
87
88class BaseXYTestCase(unittest.TestCase):
89
90    # Modern API completely ignores exported dimension and format data and
91    # treats any buffer as a stream of bytes
92    def check_encode_type_errors(self, f):
93        self.assertRaises(TypeError, f, "")
94        self.assertRaises(TypeError, f, [])
95
96    def check_decode_type_errors(self, f):
97        self.assertRaises(TypeError, f, [])
98
99    def check_other_types(self, f, bytes_data, expected):
100        eq = self.assertEqual
101        b = bytearray(bytes_data)
102        eq(f(b), expected)
103        # The bytearray wasn't mutated
104        eq(b, bytes_data)
105        eq(f(memoryview(bytes_data)), expected)
106        eq(f(array('B', bytes_data)), expected)
107        # XXX why is b64encode hardcoded here?
108        self.check_nonbyte_element_format(base64.b64encode, bytes_data)
109        self.check_multidimensional(base64.b64encode, bytes_data)
110
111    def check_multidimensional(self, f, data):
112        padding = b"\x00" if len(data) % 2 else b""
113        bytes_data = data + padding # Make sure cast works
114        shape = (len(bytes_data) // 2, 2)
115        multidimensional = memoryview(bytes_data).cast('B', shape)
116        self.assertEqual(f(multidimensional), f(bytes_data))
117
118    def check_nonbyte_element_format(self, f, data):
119        padding = b"\x00" * ((4 - len(data)) % 4)
120        bytes_data = data + padding # Make sure cast works
121        int_data = memoryview(bytes_data).cast('I')
122        self.assertEqual(f(int_data), f(bytes_data))
123
124
125    def test_b64encode(self):
126        eq = self.assertEqual
127        # Test default alphabet
128        eq(base64.b64encode(b"www.python.org"), b"d3d3LnB5dGhvbi5vcmc=")
129        eq(base64.b64encode(b'\x00'), b'AA==')
130        eq(base64.b64encode(b"a"), b"YQ==")
131        eq(base64.b64encode(b"ab"), b"YWI=")
132        eq(base64.b64encode(b"abc"), b"YWJj")
133        eq(base64.b64encode(b""), b"")
134        eq(base64.b64encode(b"abcdefghijklmnopqrstuvwxyz"
135                            b"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
136                            b"0123456789!@#0^&*();:<>,. []{}"),
137           b"YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXpBQkNE"
138           b"RUZHSElKS0xNTk9QUVJTVFVWV1hZWjAxMjM0NT"
139           b"Y3ODkhQCMwXiYqKCk7Ojw+LC4gW117fQ==")
140        # Test with arbitrary alternative characters
141        eq(base64.b64encode(b'\xd3V\xbeo\xf7\x1d', altchars=b'*$'), b'01a*b$cd')
142        eq(base64.b64encode(b'\xd3V\xbeo\xf7\x1d', altchars=bytearray(b'*$')),
143           b'01a*b$cd')
144        eq(base64.b64encode(b'\xd3V\xbeo\xf7\x1d', altchars=memoryview(b'*$')),
145           b'01a*b$cd')
146        eq(base64.b64encode(b'\xd3V\xbeo\xf7\x1d', altchars=array('B', b'*$')),
147           b'01a*b$cd')
148        # Non-bytes
149        self.check_other_types(base64.b64encode, b'abcd', b'YWJjZA==')
150        self.check_encode_type_errors(base64.b64encode)
151        self.assertRaises(TypeError, base64.b64encode, b"", altchars="*$")
152        # Test standard alphabet
153        eq(base64.standard_b64encode(b"www.python.org"), b"d3d3LnB5dGhvbi5vcmc=")
154        eq(base64.standard_b64encode(b"a"), b"YQ==")
155        eq(base64.standard_b64encode(b"ab"), b"YWI=")
156        eq(base64.standard_b64encode(b"abc"), b"YWJj")
157        eq(base64.standard_b64encode(b""), b"")
158        eq(base64.standard_b64encode(b"abcdefghijklmnopqrstuvwxyz"
159                                     b"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
160                                     b"0123456789!@#0^&*();:<>,. []{}"),
161           b"YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXpBQkNE"
162           b"RUZHSElKS0xNTk9QUVJTVFVWV1hZWjAxMjM0NT"
163           b"Y3ODkhQCMwXiYqKCk7Ojw+LC4gW117fQ==")
164        # Non-bytes
165        self.check_other_types(base64.standard_b64encode,
166                               b'abcd', b'YWJjZA==')
167        self.check_encode_type_errors(base64.standard_b64encode)
168        # Test with 'URL safe' alternative characters
169        eq(base64.urlsafe_b64encode(b'\xd3V\xbeo\xf7\x1d'), b'01a-b_cd')
170        # Non-bytes
171        self.check_other_types(base64.urlsafe_b64encode,
172                               b'\xd3V\xbeo\xf7\x1d', b'01a-b_cd')
173        self.check_encode_type_errors(base64.urlsafe_b64encode)
174
175    def test_b64decode(self):
176        eq = self.assertEqual
177
178        tests = {b"d3d3LnB5dGhvbi5vcmc=": b"www.python.org",
179                 b'AA==': b'\x00',
180                 b"YQ==": b"a",
181                 b"YWI=": b"ab",
182                 b"YWJj": b"abc",
183                 b"YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXpBQkNE"
184                 b"RUZHSElKS0xNTk9QUVJTVFVWV1hZWjAxMjM0\nNT"
185                 b"Y3ODkhQCMwXiYqKCk7Ojw+LC4gW117fQ==":
186
187                 b"abcdefghijklmnopqrstuvwxyz"
188                 b"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
189                 b"0123456789!@#0^&*();:<>,. []{}",
190                 b'': b'',
191                 }
192        for data, res in tests.items():
193            eq(base64.b64decode(data), res)
194            eq(base64.b64decode(data.decode('ascii')), res)
195        # Non-bytes
196        self.check_other_types(base64.b64decode, b"YWJj", b"abc")
197        self.check_decode_type_errors(base64.b64decode)
198
199        # Test with arbitrary alternative characters
200        tests_altchars = {(b'01a*b$cd', b'*$'): b'\xd3V\xbeo\xf7\x1d',
201                          }
202        for (data, altchars), res in tests_altchars.items():
203            data_str = data.decode('ascii')
204            altchars_str = altchars.decode('ascii')
205
206            eq(base64.b64decode(data, altchars=altchars), res)
207            eq(base64.b64decode(data_str, altchars=altchars), res)
208            eq(base64.b64decode(data, altchars=altchars_str), res)
209            eq(base64.b64decode(data_str, altchars=altchars_str), res)
210
211        # Test standard alphabet
212        for data, res in tests.items():
213            eq(base64.standard_b64decode(data), res)
214            eq(base64.standard_b64decode(data.decode('ascii')), res)
215        # Non-bytes
216        self.check_other_types(base64.standard_b64decode, b"YWJj", b"abc")
217        self.check_decode_type_errors(base64.standard_b64decode)
218
219        # Test with 'URL safe' alternative characters
220        tests_urlsafe = {b'01a-b_cd': b'\xd3V\xbeo\xf7\x1d',
221                         b'': b'',
222                         }
223        for data, res in tests_urlsafe.items():
224            eq(base64.urlsafe_b64decode(data), res)
225            eq(base64.urlsafe_b64decode(data.decode('ascii')), res)
226        # Non-bytes
227        self.check_other_types(base64.urlsafe_b64decode, b'01a-b_cd',
228                               b'\xd3V\xbeo\xf7\x1d')
229        self.check_decode_type_errors(base64.urlsafe_b64decode)
230
231    def test_b64decode_padding_error(self):
232        self.assertRaises(binascii.Error, base64.b64decode, b'abc')
233        self.assertRaises(binascii.Error, base64.b64decode, 'abc')
234
235    def test_b64decode_invalid_chars(self):
236        # issue 1466065: Test some invalid characters.
237        tests = ((b'%3d==', b'\xdd'),
238                 (b'$3d==', b'\xdd'),
239                 (b'[==', b''),
240                 (b'YW]3=', b'am'),
241                 (b'3{d==', b'\xdd'),
242                 (b'3d}==', b'\xdd'),
243                 (b'@@', b''),
244                 (b'!', b''),
245                 (b"YWJj\n", b"abc"),
246                 (b'YWJj\nYWI=', b'abcab'))
247        funcs = (
248            base64.b64decode,
249            base64.standard_b64decode,
250            base64.urlsafe_b64decode,
251        )
252        for bstr, res in tests:
253            for func in funcs:
254                with self.subTest(bstr=bstr, func=func):
255                    self.assertEqual(func(bstr), res)
256                    self.assertEqual(func(bstr.decode('ascii')), res)
257            with self.assertRaises(binascii.Error):
258                base64.b64decode(bstr, validate=True)
259            with self.assertRaises(binascii.Error):
260                base64.b64decode(bstr.decode('ascii'), validate=True)
261
262        # Normal alphabet characters not discarded when alternative given
263        res = b'\xFB\xEF\xBE\xFF\xFF\xFF'
264        self.assertEqual(base64.b64decode(b'++[[//]]', b'[]'), res)
265        self.assertEqual(base64.urlsafe_b64decode(b'++--//__'), res)
266
267    def test_b32encode(self):
268        eq = self.assertEqual
269        eq(base64.b32encode(b''), b'')
270        eq(base64.b32encode(b'\x00'), b'AA======')
271        eq(base64.b32encode(b'a'), b'ME======')
272        eq(base64.b32encode(b'ab'), b'MFRA====')
273        eq(base64.b32encode(b'abc'), b'MFRGG===')
274        eq(base64.b32encode(b'abcd'), b'MFRGGZA=')
275        eq(base64.b32encode(b'abcde'), b'MFRGGZDF')
276        # Non-bytes
277        self.check_other_types(base64.b32encode, b'abcd', b'MFRGGZA=')
278        self.check_encode_type_errors(base64.b32encode)
279
280    def test_b32decode(self):
281        eq = self.assertEqual
282        tests = {b'': b'',
283                 b'AA======': b'\x00',
284                 b'ME======': b'a',
285                 b'MFRA====': b'ab',
286                 b'MFRGG===': b'abc',
287                 b'MFRGGZA=': b'abcd',
288                 b'MFRGGZDF': b'abcde',
289                 }
290        for data, res in tests.items():
291            eq(base64.b32decode(data), res)
292            eq(base64.b32decode(data.decode('ascii')), res)
293        # Non-bytes
294        self.check_other_types(base64.b32decode, b'MFRGG===', b"abc")
295        self.check_decode_type_errors(base64.b32decode)
296
297    def test_b32decode_casefold(self):
298        eq = self.assertEqual
299        tests = {b'': b'',
300                 b'ME======': b'a',
301                 b'MFRA====': b'ab',
302                 b'MFRGG===': b'abc',
303                 b'MFRGGZA=': b'abcd',
304                 b'MFRGGZDF': b'abcde',
305                 # Lower cases
306                 b'me======': b'a',
307                 b'mfra====': b'ab',
308                 b'mfrgg===': b'abc',
309                 b'mfrggza=': b'abcd',
310                 b'mfrggzdf': b'abcde',
311                 }
312
313        for data, res in tests.items():
314            eq(base64.b32decode(data, True), res)
315            eq(base64.b32decode(data.decode('ascii'), True), res)
316
317        self.assertRaises(binascii.Error, base64.b32decode, b'me======')
318        self.assertRaises(binascii.Error, base64.b32decode, 'me======')
319
320        # Mapping zero and one
321        eq(base64.b32decode(b'MLO23456'), b'b\xdd\xad\xf3\xbe')
322        eq(base64.b32decode('MLO23456'), b'b\xdd\xad\xf3\xbe')
323
324        map_tests = {(b'M1023456', b'L'): b'b\xdd\xad\xf3\xbe',
325                     (b'M1023456', b'I'): b'b\x1d\xad\xf3\xbe',
326                     }
327        for (data, map01), res in map_tests.items():
328            data_str = data.decode('ascii')
329            map01_str = map01.decode('ascii')
330
331            eq(base64.b32decode(data, map01=map01), res)
332            eq(base64.b32decode(data_str, map01=map01), res)
333            eq(base64.b32decode(data, map01=map01_str), res)
334            eq(base64.b32decode(data_str, map01=map01_str), res)
335            self.assertRaises(binascii.Error, base64.b32decode, data)
336            self.assertRaises(binascii.Error, base64.b32decode, data_str)
337
338    def test_b32decode_error(self):
339        tests = [b'abc', b'ABCDEF==', b'==ABCDEF']
340        prefixes = [b'M', b'ME', b'MFRA', b'MFRGG', b'MFRGGZA', b'MFRGGZDF']
341        for i in range(0, 17):
342            if i:
343                tests.append(b'='*i)
344            for prefix in prefixes:
345                if len(prefix) + i != 8:
346                    tests.append(prefix + b'='*i)
347        for data in tests:
348            with self.subTest(data=data):
349                with self.assertRaises(binascii.Error):
350                    base64.b32decode(data)
351                with self.assertRaises(binascii.Error):
352                    base64.b32decode(data.decode('ascii'))
353
354    def test_b32hexencode(self):
355        test_cases = [
356            # to_encode, expected
357            (b'',      b''),
358            (b'\x00',  b'00======'),
359            (b'a',     b'C4======'),
360            (b'ab',    b'C5H0===='),
361            (b'abc',   b'C5H66==='),
362            (b'abcd',  b'C5H66P0='),
363            (b'abcde', b'C5H66P35'),
364        ]
365        for to_encode, expected in test_cases:
366            with self.subTest(to_decode=to_encode):
367                self.assertEqual(base64.b32hexencode(to_encode), expected)
368
369    def test_b32hexencode_other_types(self):
370        self.check_other_types(base64.b32hexencode, b'abcd', b'C5H66P0=')
371        self.check_encode_type_errors(base64.b32hexencode)
372
373    def test_b32hexdecode(self):
374        test_cases = [
375            # to_decode, expected, casefold
376            (b'',         b'',      False),
377            (b'00======', b'\x00',  False),
378            (b'C4======', b'a',     False),
379            (b'C5H0====', b'ab',    False),
380            (b'C5H66===', b'abc',   False),
381            (b'C5H66P0=', b'abcd',  False),
382            (b'C5H66P35', b'abcde', False),
383            (b'',         b'',      True),
384            (b'00======', b'\x00',  True),
385            (b'C4======', b'a',     True),
386            (b'C5H0====', b'ab',    True),
387            (b'C5H66===', b'abc',   True),
388            (b'C5H66P0=', b'abcd',  True),
389            (b'C5H66P35', b'abcde', True),
390            (b'c4======', b'a',     True),
391            (b'c5h0====', b'ab',    True),
392            (b'c5h66===', b'abc',   True),
393            (b'c5h66p0=', b'abcd',  True),
394            (b'c5h66p35', b'abcde', True),
395        ]
396        for to_decode, expected, casefold in test_cases:
397            with self.subTest(to_decode=to_decode, casefold=casefold):
398                self.assertEqual(base64.b32hexdecode(to_decode, casefold),
399                                 expected)
400                self.assertEqual(base64.b32hexdecode(to_decode.decode('ascii'),
401                                 casefold), expected)
402
403    def test_b32hexdecode_other_types(self):
404        self.check_other_types(base64.b32hexdecode, b'C5H66===', b'abc')
405        self.check_decode_type_errors(base64.b32hexdecode)
406
407    def test_b32hexdecode_error(self):
408        tests = [b'abc', b'ABCDEF==', b'==ABCDEF', b'c4======']
409        prefixes = [b'M', b'ME', b'MFRA', b'MFRGG', b'MFRGGZA', b'MFRGGZDF']
410        for i in range(0, 17):
411            if i:
412                tests.append(b'='*i)
413            for prefix in prefixes:
414                if len(prefix) + i != 8:
415                    tests.append(prefix + b'='*i)
416        for data in tests:
417            with self.subTest(to_decode=data):
418                with self.assertRaises(binascii.Error):
419                    base64.b32hexdecode(data)
420                with self.assertRaises(binascii.Error):
421                    base64.b32hexdecode(data.decode('ascii'))
422
423
424    def test_b16encode(self):
425        eq = self.assertEqual
426        eq(base64.b16encode(b'\x01\x02\xab\xcd\xef'), b'0102ABCDEF')
427        eq(base64.b16encode(b'\x00'), b'00')
428        # Non-bytes
429        self.check_other_types(base64.b16encode, b'\x01\x02\xab\xcd\xef',
430                               b'0102ABCDEF')
431        self.check_encode_type_errors(base64.b16encode)
432
433    def test_b16decode(self):
434        eq = self.assertEqual
435        eq(base64.b16decode(b'0102ABCDEF'), b'\x01\x02\xab\xcd\xef')
436        eq(base64.b16decode('0102ABCDEF'), b'\x01\x02\xab\xcd\xef')
437        eq(base64.b16decode(b'00'), b'\x00')
438        eq(base64.b16decode('00'), b'\x00')
439        # Lower case is not allowed without a flag
440        self.assertRaises(binascii.Error, base64.b16decode, b'0102abcdef')
441        self.assertRaises(binascii.Error, base64.b16decode, '0102abcdef')
442        # Case fold
443        eq(base64.b16decode(b'0102abcdef', True), b'\x01\x02\xab\xcd\xef')
444        eq(base64.b16decode('0102abcdef', True), b'\x01\x02\xab\xcd\xef')
445        # Non-bytes
446        self.check_other_types(base64.b16decode, b"0102ABCDEF",
447                               b'\x01\x02\xab\xcd\xef')
448        self.check_decode_type_errors(base64.b16decode)
449        eq(base64.b16decode(bytearray(b"0102abcdef"), True),
450           b'\x01\x02\xab\xcd\xef')
451        eq(base64.b16decode(memoryview(b"0102abcdef"), True),
452           b'\x01\x02\xab\xcd\xef')
453        eq(base64.b16decode(array('B', b"0102abcdef"), True),
454           b'\x01\x02\xab\xcd\xef')
455        # Non-alphabet characters
456        self.assertRaises(binascii.Error, base64.b16decode, '0102AG')
457        # Incorrect "padding"
458        self.assertRaises(binascii.Error, base64.b16decode, '010')
459
460    def test_a85encode(self):
461        eq = self.assertEqual
462
463        tests = {
464            b'': b'',
465            b"www.python.org": b'GB\\6`E-ZP=Df.1GEb>',
466            bytes(range(255)): b"""!!*-'"9eu7#RLhG$k3[W&.oNg'GVB"(`=52*$$"""
467               b"""(B+<_pR,UFcb-n-Vr/1iJ-0JP==1c70M3&s#]4?Ykm5X@_(6q'R884cE"""
468               b"""H9MJ8X:f1+h<)lt#=BSg3>[:ZC?t!MSA7]@cBPD3sCi+'.E,fo>FEMbN"""
469               b"""G^4U^I!pHnJ:W<)KS>/9Ll%"IN/`jYOHG]iPa.Q$R$jD4S=Q7DTV8*TU"""
470               b"""nsrdW2ZetXKAY/Yd(L?['d?O\\@K2_]Y2%o^qmn*`5Ta:aN;TJbg"GZd"""
471               b"""*^:jeCE.%f\\,!5gtgiEi8N\\UjQ5OekiqBum-X60nF?)@o_%qPq"ad`"""
472               b"""r;HT""",
473            b"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
474                b"0123456789!@#0^&*();:<>,. []{}":
475                b'@:E_WAS,RgBkhF"D/O92EH6,BF`qtRH$VbC6UX@47n?3D92&&T'
476                b":Jand;cHat='/U/0JP==1c70M3&r-I,;<FN.OZ`-3]oSW/g+A(H[P",
477            b"no padding..": b'DJpY:@:Wn_DJ(RS',
478            b"zero compression\0\0\0\0": b'H=_,8+Cf>,E,oN2F(oQ1z',
479            b"zero compression\0\0\0": b'H=_,8+Cf>,E,oN2F(oQ1!!!!',
480            b"Boundary:\0\0\0\0": b'6>q!aA79M(3WK-[!!',
481            b"Space compr:    ": b';fH/TAKYK$D/aMV+<VdL',
482            b'\xff': b'rr',
483            b'\xff'*2: b's8N',
484            b'\xff'*3: b's8W*',
485            b'\xff'*4: b's8W-!',
486            }
487
488        for data, res in tests.items():
489            eq(base64.a85encode(data), res, data)
490            eq(base64.a85encode(data, adobe=False), res, data)
491            eq(base64.a85encode(data, adobe=True), b'<~' + res + b'~>', data)
492
493        self.check_other_types(base64.a85encode, b"www.python.org",
494                               b'GB\\6`E-ZP=Df.1GEb>')
495
496        self.assertRaises(TypeError, base64.a85encode, "")
497
498        eq(base64.a85encode(b"www.python.org", wrapcol=7, adobe=False),
499           b'GB\\6`E-\nZP=Df.1\nGEb>')
500        eq(base64.a85encode(b"\0\0\0\0www.python.org", wrapcol=7, adobe=False),
501           b'zGB\\6`E\n-ZP=Df.\n1GEb>')
502        eq(base64.a85encode(b"www.python.org", wrapcol=7, adobe=True),
503           b'<~GB\\6`\nE-ZP=Df\n.1GEb>\n~>')
504
505        eq(base64.a85encode(b' '*8, foldspaces=True, adobe=False), b'yy')
506        eq(base64.a85encode(b' '*7, foldspaces=True, adobe=False), b'y+<Vd')
507        eq(base64.a85encode(b' '*6, foldspaces=True, adobe=False), b'y+<U')
508        eq(base64.a85encode(b' '*5, foldspaces=True, adobe=False), b'y+9')
509
510    def test_b85encode(self):
511        eq = self.assertEqual
512
513        tests = {
514            b'': b'',
515            b'www.python.org': b'cXxL#aCvlSZ*DGca%T',
516            bytes(range(255)): b"""009C61O)~M2nh-c3=Iws5D^j+6crX17#SKH9337X"""
517                b"""AR!_nBqb&%C@Cr{EG;fCFflSSG&MFiI5|2yJUu=?KtV!7L`6nNNJ&ad"""
518                b"""OifNtP*GA-R8>}2SXo+ITwPvYU}0ioWMyV&XlZI|Y;A6DaB*^Tbai%j"""
519                b"""czJqze0_d@fPsR8goTEOh>41ejE#<ukdcy;l$Dm3n3<ZJoSmMZprN9p"""
520                b"""q@|{(sHv)}tgWuEu(7hUw6(UkxVgH!yuH4^z`?@9#Kp$P$jQpf%+1cv"""
521                b"""(9zP<)YaD4*xB0K+}+;a;Njxq<mKk)=;`X~?CtLF@bU8V^!4`l`1$(#"""
522                b"""{Qdp""",
523            b"""abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"""
524                b"""0123456789!@#0^&*();:<>,. []{}""":
525                b"""VPa!sWoBn+X=-b1ZEkOHadLBXb#`}nd3r%YLqtVJM@UIZOH55pPf$@("""
526                b"""Q&d$}S6EqEFflSSG&MFiI5{CeBQRbjDkv#CIy^osE+AW7dwl""",
527            b'no padding..': b'Zf_uPVPs@!Zf7no',
528            b'zero compression\x00\x00\x00\x00': b'dS!BNAY*TBaB^jHb7^mG00000',
529            b'zero compression\x00\x00\x00': b'dS!BNAY*TBaB^jHb7^mG0000',
530            b"""Boundary:\x00\x00\x00\x00""": b"""LT`0$WMOi7IsgCw00""",
531            b'Space compr:    ': b'Q*dEpWgug3ZE$irARr(h',
532            b'\xff': b'{{',
533            b'\xff'*2: b'|Nj',
534            b'\xff'*3: b'|Ns9',
535            b'\xff'*4: b'|NsC0',
536        }
537
538        for data, res in tests.items():
539            eq(base64.b85encode(data), res)
540
541        self.check_other_types(base64.b85encode, b"www.python.org",
542                               b'cXxL#aCvlSZ*DGca%T')
543
544    def test_a85decode(self):
545        eq = self.assertEqual
546
547        tests = {
548            b'': b'',
549            b'GB\\6`E-ZP=Df.1GEb>': b'www.python.org',
550            b"""! ! * -'"\n\t\t9eu\r\n7#  RL\vhG$k3[W&.oNg'GVB"(`=52*$$"""
551               b"""(B+<_pR,UFcb-n-Vr/1iJ-0JP==1c70M3&s#]4?Ykm5X@_(6q'R884cE"""
552               b"""H9MJ8X:f1+h<)lt#=BSg3>[:ZC?t!MSA7]@cBPD3sCi+'.E,fo>FEMbN"""
553               b"""G^4U^I!pHnJ:W<)KS>/9Ll%"IN/`jYOHG]iPa.Q$R$jD4S=Q7DTV8*TU"""
554               b"""nsrdW2ZetXKAY/Yd(L?['d?O\\@K2_]Y2%o^qmn*`5Ta:aN;TJbg"GZd"""
555               b"""*^:jeCE.%f\\,!5gtgiEi8N\\UjQ5OekiqBum-X60nF?)@o_%qPq"ad`"""
556               b"""r;HT""": bytes(range(255)),
557            b"""@:E_WAS,RgBkhF"D/O92EH6,BF`qtRH$VbC6UX@47n?3D92&&T:Jand;c"""
558                b"""Hat='/U/0JP==1c70M3&r-I,;<FN.OZ`-3]oSW/g+A(H[P""":
559                b'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234'
560                b'56789!@#0^&*();:<>,. []{}',
561            b'DJpY:@:Wn_DJ(RS': b'no padding..',
562            b'H=_,8+Cf>,E,oN2F(oQ1z': b'zero compression\x00\x00\x00\x00',
563            b'H=_,8+Cf>,E,oN2F(oQ1!!!!': b'zero compression\x00\x00\x00',
564            b'6>q!aA79M(3WK-[!!': b"Boundary:\x00\x00\x00\x00",
565            b';fH/TAKYK$D/aMV+<VdL': b'Space compr:    ',
566            b'rr': b'\xff',
567            b's8N': b'\xff'*2,
568            b's8W*': b'\xff'*3,
569            b's8W-!': b'\xff'*4,
570            }
571
572        for data, res in tests.items():
573            eq(base64.a85decode(data), res, data)
574            eq(base64.a85decode(data, adobe=False), res, data)
575            eq(base64.a85decode(data.decode("ascii"), adobe=False), res, data)
576            eq(base64.a85decode(b'<~' + data + b'~>', adobe=True), res, data)
577            eq(base64.a85decode(data + b'~>', adobe=True), res, data)
578            eq(base64.a85decode('<~%s~>' % data.decode("ascii"), adobe=True),
579               res, data)
580
581        eq(base64.a85decode(b'yy', foldspaces=True, adobe=False), b' '*8)
582        eq(base64.a85decode(b'y+<Vd', foldspaces=True, adobe=False), b' '*7)
583        eq(base64.a85decode(b'y+<U', foldspaces=True, adobe=False), b' '*6)
584        eq(base64.a85decode(b'y+9', foldspaces=True, adobe=False), b' '*5)
585
586        self.check_other_types(base64.a85decode, b'GB\\6`E-ZP=Df.1GEb>',
587                               b"www.python.org")
588
589    def test_b85decode(self):
590        eq = self.assertEqual
591
592        tests = {
593            b'': b'',
594            b'cXxL#aCvlSZ*DGca%T': b'www.python.org',
595            b"""009C61O)~M2nh-c3=Iws5D^j+6crX17#SKH9337X"""
596                b"""AR!_nBqb&%C@Cr{EG;fCFflSSG&MFiI5|2yJUu=?KtV!7L`6nNNJ&ad"""
597                b"""OifNtP*GA-R8>}2SXo+ITwPvYU}0ioWMyV&XlZI|Y;A6DaB*^Tbai%j"""
598                b"""czJqze0_d@fPsR8goTEOh>41ejE#<ukdcy;l$Dm3n3<ZJoSmMZprN9p"""
599                b"""q@|{(sHv)}tgWuEu(7hUw6(UkxVgH!yuH4^z`?@9#Kp$P$jQpf%+1cv"""
600                b"""(9zP<)YaD4*xB0K+}+;a;Njxq<mKk)=;`X~?CtLF@bU8V^!4`l`1$(#"""
601                b"""{Qdp""": bytes(range(255)),
602            b"""VPa!sWoBn+X=-b1ZEkOHadLBXb#`}nd3r%YLqtVJM@UIZOH55pPf$@("""
603                b"""Q&d$}S6EqEFflSSG&MFiI5{CeBQRbjDkv#CIy^osE+AW7dwl""":
604                b"""abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"""
605                b"""0123456789!@#0^&*();:<>,. []{}""",
606            b'Zf_uPVPs@!Zf7no': b'no padding..',
607            b'dS!BNAY*TBaB^jHb7^mG00000': b'zero compression\x00\x00\x00\x00',
608            b'dS!BNAY*TBaB^jHb7^mG0000': b'zero compression\x00\x00\x00',
609            b"""LT`0$WMOi7IsgCw00""": b"""Boundary:\x00\x00\x00\x00""",
610            b'Q*dEpWgug3ZE$irARr(h': b'Space compr:    ',
611            b'{{': b'\xff',
612            b'|Nj': b'\xff'*2,
613            b'|Ns9': b'\xff'*3,
614            b'|NsC0': b'\xff'*4,
615        }
616
617        for data, res in tests.items():
618            eq(base64.b85decode(data), res)
619            eq(base64.b85decode(data.decode("ascii")), res)
620
621        self.check_other_types(base64.b85decode, b'cXxL#aCvlSZ*DGca%T',
622                               b"www.python.org")
623
624    def test_a85_padding(self):
625        eq = self.assertEqual
626
627        eq(base64.a85encode(b"x", pad=True), b'GQ7^D')
628        eq(base64.a85encode(b"xx", pad=True), b"G^'2g")
629        eq(base64.a85encode(b"xxx", pad=True), b'G^+H5')
630        eq(base64.a85encode(b"xxxx", pad=True), b'G^+IX')
631        eq(base64.a85encode(b"xxxxx", pad=True), b'G^+IXGQ7^D')
632
633        eq(base64.a85decode(b'GQ7^D'), b"x\x00\x00\x00")
634        eq(base64.a85decode(b"G^'2g"), b"xx\x00\x00")
635        eq(base64.a85decode(b'G^+H5'), b"xxx\x00")
636        eq(base64.a85decode(b'G^+IX'), b"xxxx")
637        eq(base64.a85decode(b'G^+IXGQ7^D'), b"xxxxx\x00\x00\x00")
638
639    def test_b85_padding(self):
640        eq = self.assertEqual
641
642        eq(base64.b85encode(b"x", pad=True), b'cmMzZ')
643        eq(base64.b85encode(b"xx", pad=True), b'cz6H+')
644        eq(base64.b85encode(b"xxx", pad=True), b'czAdK')
645        eq(base64.b85encode(b"xxxx", pad=True), b'czAet')
646        eq(base64.b85encode(b"xxxxx", pad=True), b'czAetcmMzZ')
647
648        eq(base64.b85decode(b'cmMzZ'), b"x\x00\x00\x00")
649        eq(base64.b85decode(b'cz6H+'), b"xx\x00\x00")
650        eq(base64.b85decode(b'czAdK'), b"xxx\x00")
651        eq(base64.b85decode(b'czAet'), b"xxxx")
652        eq(base64.b85decode(b'czAetcmMzZ'), b"xxxxx\x00\x00\x00")
653
654    def test_a85decode_errors(self):
655        illegal = (set(range(32)) | set(range(118, 256))) - set(b' \t\n\r\v')
656        for c in illegal:
657            with self.assertRaises(ValueError, msg=bytes([c])):
658                base64.a85decode(b'!!!!' + bytes([c]))
659            with self.assertRaises(ValueError, msg=bytes([c])):
660                base64.a85decode(b'!!!!' + bytes([c]), adobe=False)
661            with self.assertRaises(ValueError, msg=bytes([c])):
662                base64.a85decode(b'<~!!!!' + bytes([c]) + b'~>', adobe=True)
663
664        self.assertRaises(ValueError, base64.a85decode,
665                                      b"malformed", adobe=True)
666        self.assertRaises(ValueError, base64.a85decode,
667                                      b"<~still malformed", adobe=True)
668
669        # With adobe=False (the default), Adobe framing markers are disallowed
670        self.assertRaises(ValueError, base64.a85decode,
671                                      b"<~~>")
672        self.assertRaises(ValueError, base64.a85decode,
673                                      b"<~~>", adobe=False)
674        base64.a85decode(b"<~~>", adobe=True)  # sanity check
675
676        self.assertRaises(ValueError, base64.a85decode,
677                                      b"abcx", adobe=False)
678        self.assertRaises(ValueError, base64.a85decode,
679                                      b"abcdey", adobe=False)
680        self.assertRaises(ValueError, base64.a85decode,
681                                      b"a b\nc", adobe=False, ignorechars=b"")
682
683        self.assertRaises(ValueError, base64.a85decode, b's', adobe=False)
684        self.assertRaises(ValueError, base64.a85decode, b's8', adobe=False)
685        self.assertRaises(ValueError, base64.a85decode, b's8W', adobe=False)
686        self.assertRaises(ValueError, base64.a85decode, b's8W-', adobe=False)
687        self.assertRaises(ValueError, base64.a85decode, b's8W-"', adobe=False)
688
689    def test_b85decode_errors(self):
690        illegal = list(range(33)) + \
691                  list(b'"\',./:[\\]') + \
692                  list(range(128, 256))
693        for c in illegal:
694            with self.assertRaises(ValueError, msg=bytes([c])):
695                base64.b85decode(b'0000' + bytes([c]))
696
697        self.assertRaises(ValueError, base64.b85decode, b'|')
698        self.assertRaises(ValueError, base64.b85decode, b'|N')
699        self.assertRaises(ValueError, base64.b85decode, b'|Ns')
700        self.assertRaises(ValueError, base64.b85decode, b'|NsC')
701        self.assertRaises(ValueError, base64.b85decode, b'|NsC1')
702
703    def test_decode_nonascii_str(self):
704        decode_funcs = (base64.b64decode,
705                        base64.standard_b64decode,
706                        base64.urlsafe_b64decode,
707                        base64.b32decode,
708                        base64.b16decode,
709                        base64.b85decode,
710                        base64.a85decode)
711        for f in decode_funcs:
712            self.assertRaises(ValueError, f, 'with non-ascii \xcb')
713
714    def test_ErrorHeritage(self):
715        self.assertTrue(issubclass(binascii.Error, ValueError))
716
717    def test_RFC4648_test_cases(self):
718        # test cases from RFC 4648 section 10
719        b64encode = base64.b64encode
720        b32hexencode = base64.b32hexencode
721        b32encode = base64.b32encode
722        b16encode = base64.b16encode
723
724        self.assertEqual(b64encode(b""), b"")
725        self.assertEqual(b64encode(b"f"), b"Zg==")
726        self.assertEqual(b64encode(b"fo"), b"Zm8=")
727        self.assertEqual(b64encode(b"foo"), b"Zm9v")
728        self.assertEqual(b64encode(b"foob"), b"Zm9vYg==")
729        self.assertEqual(b64encode(b"fooba"), b"Zm9vYmE=")
730        self.assertEqual(b64encode(b"foobar"), b"Zm9vYmFy")
731
732        self.assertEqual(b32encode(b""), b"")
733        self.assertEqual(b32encode(b"f"), b"MY======")
734        self.assertEqual(b32encode(b"fo"), b"MZXQ====")
735        self.assertEqual(b32encode(b"foo"), b"MZXW6===")
736        self.assertEqual(b32encode(b"foob"), b"MZXW6YQ=")
737        self.assertEqual(b32encode(b"fooba"), b"MZXW6YTB")
738        self.assertEqual(b32encode(b"foobar"), b"MZXW6YTBOI======")
739
740        self.assertEqual(b32hexencode(b""), b"")
741        self.assertEqual(b32hexencode(b"f"), b"CO======")
742        self.assertEqual(b32hexencode(b"fo"), b"CPNG====")
743        self.assertEqual(b32hexencode(b"foo"), b"CPNMU===")
744        self.assertEqual(b32hexencode(b"foob"), b"CPNMUOG=")
745        self.assertEqual(b32hexencode(b"fooba"), b"CPNMUOJ1")
746        self.assertEqual(b32hexencode(b"foobar"), b"CPNMUOJ1E8======")
747
748        self.assertEqual(b16encode(b""), b"")
749        self.assertEqual(b16encode(b"f"), b"66")
750        self.assertEqual(b16encode(b"fo"), b"666F")
751        self.assertEqual(b16encode(b"foo"), b"666F6F")
752        self.assertEqual(b16encode(b"foob"), b"666F6F62")
753        self.assertEqual(b16encode(b"fooba"), b"666F6F6261")
754        self.assertEqual(b16encode(b"foobar"), b"666F6F626172")
755
756
757class TestMain(unittest.TestCase):
758    def tearDown(self):
759        if os.path.exists(os_helper.TESTFN):
760            os.unlink(os_helper.TESTFN)
761
762    def get_output(self, *args):
763        return script_helper.assert_python_ok('-m', 'base64', *args).out
764
765    def test_encode_decode(self):
766        output = self.get_output('-t')
767        self.assertSequenceEqual(output.splitlines(), (
768            b"b'Aladdin:open sesame'",
769            br"b'QWxhZGRpbjpvcGVuIHNlc2FtZQ==\n'",
770            b"b'Aladdin:open sesame'",
771        ))
772
773    def test_encode_file(self):
774        with open(os_helper.TESTFN, 'wb') as fp:
775            fp.write(b'a\xffb\n')
776        output = self.get_output('-e', os_helper.TESTFN)
777        self.assertEqual(output.rstrip(), b'Yf9iCg==')
778
779    def test_encode_from_stdin(self):
780        with script_helper.spawn_python('-m', 'base64', '-e') as proc:
781            out, err = proc.communicate(b'a\xffb\n')
782        self.assertEqual(out.rstrip(), b'Yf9iCg==')
783        self.assertIsNone(err)
784
785    def test_decode(self):
786        with open(os_helper.TESTFN, 'wb') as fp:
787            fp.write(b'Yf9iCg==')
788        output = self.get_output('-d', os_helper.TESTFN)
789        self.assertEqual(output.rstrip(), b'a\xffb')
790
791if __name__ == '__main__':
792    unittest.main()
793