Pillow/Tests/test_decompression_bomb.py

104 lines
3.0 KiB
Python
Raw Normal View History

import pytest
2014-05-27 13:40:52 +04:00
from PIL import Image
2020-03-28 04:51:28 +03:00
from .helper import hopper
2014-09-05 13:36:24 +04:00
TEST_FILE = "Tests/images/hopper.ppm"
2014-05-27 13:40:52 +04:00
2014-06-23 12:22:25 +04:00
ORIGINAL_LIMIT = Image.MAX_IMAGE_PIXELS
2014-05-27 13:40:52 +04:00
2020-03-28 04:51:28 +03:00
class TestDecompressionBomb:
@classmethod
2020-12-31 08:25:46 +03:00
def teardown_class(cls):
2014-06-23 12:22:25 +04:00
Image.MAX_IMAGE_PIXELS = ORIGINAL_LIMIT
def test_no_warning_small_file(self):
# Implicit assert: no warning.
# A warning would cause a failure.
Improve handling of file resources Follow Python's file object semantics. User code is responsible for closing resources (usually through a context manager) in a deterministic way. To achieve this, remove __del__ functions. These functions used to closed open file handlers in an attempt to silence Python ResourceWarnings. However, using __del__ has the following drawbacks: - __del__ isn't called until the object's reference count reaches 0. Therefore, resource handlers remain open or in use longer than necessary. - The __del__ method isn't guaranteed to execute on system exit. See the Python documentation: https://docs.python.org/3/reference/datamodel.html#object.__del__ > It is not guaranteed that __del__() methods are called for objects > that still exist when the interpreter exits. - Exceptions that occur inside __del__ are ignored instead of raised. This has the potential of hiding bugs. This is also in the Python documentation: > Warning: Due to the precarious circumstances under which __del__() > methods are invoked, exceptions that occur during their execution > are ignored, and a warning is printed to sys.stderr instead. Instead, always close resource handlers when they are no longer in use. This will close the file handler at a specified point in the user's code and not wait until the interpreter chooses to. It is always guaranteed to run. And, if an exception occurs while closing the file handler, the bug will not be ignored. Now, when code receives a ResourceWarning, it will highlight an area that is mishandling resources. It should not simply be silenced, but fixed by closing resources with a context manager. All warnings that were emitted during tests have been cleaned up. To enable warnings, I passed the `-Wa` CLI option to Python. This exposed some mishandling of resources in ImageFile.__init__() and SpiderImagePlugin.loadImageSeries(), they too were fixed.
2019-05-25 19:30:58 +03:00
with Image.open(TEST_FILE):
pass
2014-05-27 13:40:52 +04:00
def test_no_warning_no_limit(self):
# Arrange
# Turn limit off
Image.MAX_IMAGE_PIXELS = None
2020-02-12 19:29:19 +03:00
assert Image.MAX_IMAGE_PIXELS is None
2014-05-27 13:40:52 +04:00
# Act / Assert
# Implicit assert: no warning.
# A warning would cause a failure.
Improve handling of file resources Follow Python's file object semantics. User code is responsible for closing resources (usually through a context manager) in a deterministic way. To achieve this, remove __del__ functions. These functions used to closed open file handlers in an attempt to silence Python ResourceWarnings. However, using __del__ has the following drawbacks: - __del__ isn't called until the object's reference count reaches 0. Therefore, resource handlers remain open or in use longer than necessary. - The __del__ method isn't guaranteed to execute on system exit. See the Python documentation: https://docs.python.org/3/reference/datamodel.html#object.__del__ > It is not guaranteed that __del__() methods are called for objects > that still exist when the interpreter exits. - Exceptions that occur inside __del__ are ignored instead of raised. This has the potential of hiding bugs. This is also in the Python documentation: > Warning: Due to the precarious circumstances under which __del__() > methods are invoked, exceptions that occur during their execution > are ignored, and a warning is printed to sys.stderr instead. Instead, always close resource handlers when they are no longer in use. This will close the file handler at a specified point in the user's code and not wait until the interpreter chooses to. It is always guaranteed to run. And, if an exception occurs while closing the file handler, the bug will not be ignored. Now, when code receives a ResourceWarning, it will highlight an area that is mishandling resources. It should not simply be silenced, but fixed by closing resources with a context manager. All warnings that were emitted during tests have been cleaned up. To enable warnings, I passed the `-Wa` CLI option to Python. This exposed some mishandling of resources in ImageFile.__init__() and SpiderImagePlugin.loadImageSeries(), they too were fixed.
2019-05-25 19:30:58 +03:00
with Image.open(TEST_FILE):
pass
2014-05-27 13:40:52 +04:00
def test_warning(self):
# Set limit to trigger warning on the test file
2018-03-06 11:53:07 +03:00
Image.MAX_IMAGE_PIXELS = 128 * 128 - 1
2020-02-12 19:29:19 +03:00
assert Image.MAX_IMAGE_PIXELS == 128 * 128 - 1
2014-05-27 13:40:52 +04:00
Improve handling of file resources Follow Python's file object semantics. User code is responsible for closing resources (usually through a context manager) in a deterministic way. To achieve this, remove __del__ functions. These functions used to closed open file handlers in an attempt to silence Python ResourceWarnings. However, using __del__ has the following drawbacks: - __del__ isn't called until the object's reference count reaches 0. Therefore, resource handlers remain open or in use longer than necessary. - The __del__ method isn't guaranteed to execute on system exit. See the Python documentation: https://docs.python.org/3/reference/datamodel.html#object.__del__ > It is not guaranteed that __del__() methods are called for objects > that still exist when the interpreter exits. - Exceptions that occur inside __del__ are ignored instead of raised. This has the potential of hiding bugs. This is also in the Python documentation: > Warning: Due to the precarious circumstances under which __del__() > methods are invoked, exceptions that occur during their execution > are ignored, and a warning is printed to sys.stderr instead. Instead, always close resource handlers when they are no longer in use. This will close the file handler at a specified point in the user's code and not wait until the interpreter chooses to. It is always guaranteed to run. And, if an exception occurs while closing the file handler, the bug will not be ignored. Now, when code receives a ResourceWarning, it will highlight an area that is mishandling resources. It should not simply be silenced, but fixed by closing resources with a context manager. All warnings that were emitted during tests have been cleaned up. To enable warnings, I passed the `-Wa` CLI option to Python. This exposed some mishandling of resources in ImageFile.__init__() and SpiderImagePlugin.loadImageSeries(), they too were fixed.
2019-05-25 19:30:58 +03:00
def open():
with Image.open(TEST_FILE):
pass
pytest.warns(Image.DecompressionBombWarning, open)
2017-02-17 18:07:14 +03:00
def test_exception(self):
# Set limit to trigger exception on the test file
2018-03-06 11:53:07 +03:00
Image.MAX_IMAGE_PIXELS = 64 * 128 - 1
2020-02-12 19:29:19 +03:00
assert Image.MAX_IMAGE_PIXELS == 64 * 128 - 1
2020-02-12 19:29:19 +03:00
with pytest.raises(Image.DecompressionBombError):
Improve handling of file resources Follow Python's file object semantics. User code is responsible for closing resources (usually through a context manager) in a deterministic way. To achieve this, remove __del__ functions. These functions used to closed open file handlers in an attempt to silence Python ResourceWarnings. However, using __del__ has the following drawbacks: - __del__ isn't called until the object's reference count reaches 0. Therefore, resource handlers remain open or in use longer than necessary. - The __del__ method isn't guaranteed to execute on system exit. See the Python documentation: https://docs.python.org/3/reference/datamodel.html#object.__del__ > It is not guaranteed that __del__() methods are called for objects > that still exist when the interpreter exits. - Exceptions that occur inside __del__ are ignored instead of raised. This has the potential of hiding bugs. This is also in the Python documentation: > Warning: Due to the precarious circumstances under which __del__() > methods are invoked, exceptions that occur during their execution > are ignored, and a warning is printed to sys.stderr instead. Instead, always close resource handlers when they are no longer in use. This will close the file handler at a specified point in the user's code and not wait until the interpreter chooses to. It is always guaranteed to run. And, if an exception occurs while closing the file handler, the bug will not be ignored. Now, when code receives a ResourceWarning, it will highlight an area that is mishandling resources. It should not simply be silenced, but fixed by closing resources with a context manager. All warnings that were emitted during tests have been cleaned up. To enable warnings, I passed the `-Wa` CLI option to Python. This exposed some mishandling of resources in ImageFile.__init__() and SpiderImagePlugin.loadImageSeries(), they too were fixed.
2019-05-25 19:30:58 +03:00
with Image.open(TEST_FILE):
pass
2019-09-29 07:14:38 +03:00
def test_exception_ico(self):
2020-02-12 19:29:19 +03:00
with pytest.raises(Image.DecompressionBombError):
2019-09-29 07:14:38 +03:00
Image.open("Tests/images/decompression_bomb.ico")
def test_exception_gif(self):
2020-02-12 19:29:19 +03:00
with pytest.raises(Image.DecompressionBombError):
2019-09-29 07:14:38 +03:00
Image.open("Tests/images/decompression_bomb.gif")
def test_exception_bmp(self):
with pytest.raises(Image.DecompressionBombError):
Image.open("Tests/images/bmp/b/reallybig.bmp")
2018-03-03 12:54:00 +03:00
2020-03-28 04:51:28 +03:00
class TestDecompressionCrop:
@classmethod
def setup_class(self):
2020-03-27 11:50:51 +03:00
width, height = 128, 128
Image.MAX_IMAGE_PIXELS = height * width * 4 - 1
2017-02-17 18:07:14 +03:00
2020-03-28 04:51:28 +03:00
@classmethod
def teardown_class(self):
2017-02-17 18:07:14 +03:00
Image.MAX_IMAGE_PIXELS = ORIGINAL_LIMIT
def testEnlargeCrop(self):
# Crops can extend the extents, therefore we should have the
# same decompression bomb warnings on them.
2020-03-27 11:50:51 +03:00
with hopper() as src:
box = (0, 0, src.width * 2, src.height * 2)
pytest.warns(Image.DecompressionBombWarning, src.crop, box)
2014-05-27 13:40:52 +04:00
2018-08-23 16:40:46 +03:00
def test_crop_decompression_checks(self):
im = Image.new("RGB", (100, 100))
2019-06-13 18:53:42 +03:00
good_values = ((-9999, -9999, -9990, -9990), (-999, -999, -990, -990))
2018-08-23 16:40:46 +03:00
2019-06-13 18:53:42 +03:00
warning_values = ((-160, -160, 99, 99), (160, 160, -99, -99))
2018-08-23 16:40:46 +03:00
2019-06-13 18:53:42 +03:00
error_values = ((-99909, -99990, 99999, 99999), (99909, 99990, -99999, -99999))
2018-08-23 16:40:46 +03:00
for value in good_values:
2020-02-12 19:29:19 +03:00
assert im.crop(value).size == (9, 9)
2018-08-23 16:40:46 +03:00
for value in warning_values:
pytest.warns(Image.DecompressionBombWarning, im.crop, value)
2018-08-23 16:40:46 +03:00
for value in error_values:
2020-02-12 19:29:19 +03:00
with pytest.raises(Image.DecompressionBombError):
2018-08-23 16:40:46 +03:00
im.crop(value)