From b6fe8572509b77d2002eaddf99d718e9b4835684 Mon Sep 17 00:00:00 2001 From: Jack DeVries <58614260+jdevries3133@users.noreply.github.com> Date: Wed, 29 Sep 2021 05:25:48 -0400 Subject: bpo-39039: tarfile raises descriptive exception from zlib.error (GH-27766) * during tarfile parsing, a zlib error indicates invalid data * tarfile.open now raises a descriptive exception from the zlib error * this makes it clear to the user that they may be trying to open a corrupted tar file --- Lib/tarfile.py | 9 +++++++++ Lib/test/test_tarfile.py | 14 ++++++++++++++ .../next/Library/2021-08-18-10-36-14.bpo-39039.A63LYh.rst | 2 ++ 3 files changed, 25 insertions(+) create mode 100644 Misc/NEWS.d/next/Library/2021-08-18-10-36-14.bpo-39039.A63LYh.rst diff --git a/Lib/tarfile.py b/Lib/tarfile.py index 18d415a..c1ee122 100755 --- a/Lib/tarfile.py +++ b/Lib/tarfile.py @@ -2349,6 +2349,15 @@ class TarFile(object): raise ReadError(str(e)) from None except SubsequentHeaderError as e: raise ReadError(str(e)) from None + except Exception as e: + try: + import zlib + if isinstance(e, zlib.error): + raise ReadError(f'zlib error: {e}') from None + else: + raise e + except ImportError: + raise e break if tarinfo is not None: diff --git a/Lib/test/test_tarfile.py b/Lib/test/test_tarfile.py index cfdda24..e4b5c52 100644 --- a/Lib/test/test_tarfile.py +++ b/Lib/test/test_tarfile.py @@ -20,6 +20,10 @@ try: except ImportError: gzip = None try: + import zlib +except ImportError: + zlib = None +try: import bz2 except ImportError: bz2 = None @@ -687,6 +691,16 @@ class MiscReadTestBase(CommonReadTest): self.assertEqual(m1.offset, m2.offset) self.assertEqual(m1.get_info(), m2.get_info()) + @unittest.skipIf(zlib is None, "requires zlib") + def test_zlib_error_does_not_leak(self): + # bpo-39039: tarfile.open allowed zlib exceptions to bubble up when + # parsing certain types of invalid data + with unittest.mock.patch("tarfile.TarInfo.fromtarfile") as mock: + mock.side_effect = zlib.error + with self.assertRaises(tarfile.ReadError): + tarfile.open(self.tarname) + + class MiscReadTest(MiscReadTestBase, unittest.TestCase): test_fail_comp = None diff --git a/Misc/NEWS.d/next/Library/2021-08-18-10-36-14.bpo-39039.A63LYh.rst b/Misc/NEWS.d/next/Library/2021-08-18-10-36-14.bpo-39039.A63LYh.rst new file mode 100644 index 0000000..7250055 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2021-08-18-10-36-14.bpo-39039.A63LYh.rst @@ -0,0 +1,2 @@ +tarfile.open raises :exc:`~tarfile.ReadError` when a zlib error occurs +during file extraction. -- cgit v0.12