Image.Load() throws InvalidImageContentException: CRC Error. PNG IDAT chunk is corrupt!

Question

Image.Load() throws InvalidImageContentException: CRC Error. PNG IDAT chunk is corrupt!

oskarlindman opened this issue 7 months ago · comments

Oskar Lindman commented 7 months ago

Prerequisites

I have written a descriptive issue title
I have verified that I am running the latest version of ImageSharp
I have verified if the problem exist in both DEBUG and RELEASE mode
I have searched open and closed issues to ensure it has not already been reported

ImageSharp version

3.0.2

Other ImageSharp packages and versions

None

Environment (Operating system, version and so on)

Windows 11 Version 22H2

.NET Framework version

.net 7

Description

I have two png images that opens fine with System.Drawing.Common, but that fails to open with ImageSharp, and instead throw an InvalidImageContentException: CRC Error. PNG IDAT chunk is corrupt! Both files can be viewed in windows.

Steps to Reproduce

Just point to the filePath with Image.Open(filePath) and it should throw the exception when running the code.

 at SixLabors.ImageSharp.Formats.Png.PngThrowHelper.ThrowInvalidChunkCrc(String chunkTypeName)
   at SixLabors.ImageSharp.Formats.Png.PngDecoderCore.ValidateChunk(PngChunk& chunk)
   at SixLabors.ImageSharp.Formats.Png.PngDecoderCore.TryReadChunk(PngChunk& chunk)
   at SixLabors.ImageSharp.Formats.Png.PngDecoderCore.Decode[TPixel](BufferedReadStream stream, CancellationToken cancellationToken)
   at SixLabors.ImageSharp.Formats.ImageDecoderUtilities.Decode[TPixel](IImageDecoderInternals decoder, Configuration configuration, Stream stream, Func`3 largeImageExceptionFactory, CancellationToken cancellationToken)
   at SixLabors.ImageSharp.Formats.ImageDecoderUtilities.Decode[TPixel](IImageDecoderInternals decoder, Configuration configuration, Stream stream, CancellationToken cancellationToken)
   at SixLabors.ImageSharp.Formats.Png.PngDecoder.Decode[TPixel](DecoderOptions options, Stream stream, CancellationToken cancellationToken)
   at SixLabors.ImageSharp.Formats.Png.PngDecoder.Decode(DecoderOptions options, Stream stream, CancellationToken cancellationToken)
   at SixLabors.ImageSharp.Formats.ImageDecoder.<>c__DisplayClass1_0.<Decode>b__0(Stream s)
   at SixLabors.ImageSharp.Formats.ImageDecoder.<WithSeekableStream>g__PeformActionAndResetPosition|11_0[T](Stream s, Int64 position, <>c__DisplayClass11_0`1& )
   at SixLabors.ImageSharp.Formats.ImageDecoder.WithSeekableStream[T](DecoderOptions options, Stream stream, Func`2 action)
   at SixLabors.ImageSharp.Formats.ImageDecoder.Decode(DecoderOptions options, Stream stream)
   at SixLabors.ImageSharp.Image.Decode(DecoderOptions options, Stream stream)
   at SixLabors.ImageSharp.Image.<>c__DisplayClass80_0.<Load>b__0(Stream s)
   at SixLabors.ImageSharp.Image.WithSeekableStream[T](DecoderOptions options, Stream stream, Func`2 action)
   at SixLabors.ImageSharp.Image.Load(DecoderOptions options, Stream stream)
   at SixLabors.ImageSharp.Image.Load(DecoderOptions options, String path)
   at SixLabors.ImageSharp.Image.Load(String path)

Images

James Jackson-South · Answer 1 · Thu Oct 26 2023 12:09:29 GMT+0800 (China Standard Time)

The IDAT is indeed corrupt.

We'll need to have a look at libpng to see if they have some special handling of this.

https://www.nayuki.io/page/png-file-chunk-inspector

Dirk Lemstra · Answer 2 · Thu Oct 26 2023 15:45:00 GMT+0800 (China Standard Time)

Libpng also "throws an exceptions":

C:\Users\Dirk\Desktop>magick 277674454-e24cc769-3dbd-420b-977f-7f7b6dbec05c.png info:
magick: Expected 4 bytes; found 0 bytes `277674454-e24cc769-3dbd-420b-977f-7f7b6dbec05c.png' @ warning/png.c/MagickPNGWarningHandler/1526.
magick: Read Exception `277674454-e24cc769-3dbd-420b-977f-7f7b6dbec05c.png' @ error/png.c/MagickPNGErrorHandler/1492.

Sven Claesson · Answer 3 · Mon Nov 06 2023 23:02:09 GMT+0800 (China Standard Time)

This file, and the two above can be partially displayed by chrome, that uses libpng

James Jackson-South · Answer 4 · Tue Nov 07 2023 03:58:34 GMT+0800 (China Standard Time)

Can they be opened by other imaging libraries? Chrome looks to have turned of the safety checks. (There’s a compiler option in libpng)

Sven Claesson · Answer 5 · Tue Nov 07 2023 17:35:56 GMT+0800 (China Standard Time)

MagicScalar uses libpng and can handle the last image that i posted

MagicScalar uses vcpkg precompiled version of libpng. What is the compiler option called can't seam to find it here?

James Jackson-South · Answer 6 · Tue Nov 07 2023 18:29:58 GMT+0800 (China Standard Time)

Ah not a compiler option it seems. Look for png_set_crc_action

http://www.libpng.org/pub/png/libpng-manual.txt

Sven Claesson · Answer 7 · Tue Nov 07 2023 18:40:50 GMT+0800 (China Standard Time)

So this explains why it works in MagicScalar then.

Would it be possible to consider this for ImageSharp?

Sven Claesson · Answer 8 · Thu Nov 09 2023 04:36:13 GMT+0800 (China Standard Time)

After further investigation into MagicScaler, it turns out that using default settings on windows will result in native WIC codecs being used. This png codec is forgiving.
~~Instead when libpng is used with "codecs.UseLibpng()" no CRC error is thrown but the resulting image is all black.~~
nevermind. this works as expected.

Any input?

James Jackson-South · Answer 9 · Thu Nov 09 2023 18:48:33 GMT+0800 (China Standard Time)

This is precisely the kind of thing I designed ISpecializedDecoderOptions for. There's no reason we cannot define rules for handling Crc and Adler validation on decode.

Would you be interested in creating a PR?

Sven Claesson · Answer 10 · Fri Nov 10 2023 21:19:17 GMT+0800 (China Standard Time)

Tried it a bit but got stuck by the fact that IDAT and IEND is considered critical chunks and found no way of ignoring that fact if the file is truncated, IDAT is cut off and IEND is missing.

Maybe you have some pointers for me here
PR not yet posted to here because it is work in progress still.

James Jackson-South · Answer 11 · Fri Nov 24 2023 20:12:46 GMT+0800 (China Standard Time)

Sorry for the slow reply @svenclaesson I've been off the boil for the last few weeks with sickness.

If you actually open a PR I can commit directly to your fork to help finish it off.

Erik White · Answer 12 · Tue Mar 05 2024 17:55:20 GMT+0800 (China Standard Time)

@JimBobSquarePants What is the easiest way to make use of the new options? Ideally I would like to be able to pass something through via Image.Identify or Image.Load, but they only take a basic DecoderOptions.

Would it be reasonable to add overloads that take ISpecializedDecoderOptions since that already contains a DecoderOptions property? Or maybe some other concept of aggregated specialized decoder options?

James Jackson-South · Answer 13 · Tue Mar 05 2024 20:50:35 GMT+0800 (China Standard Time)

@JimBobSquarePants What is the easiest way to make use of the new options? Ideally I would like to be able to pass something through via Image.Identify or Image.Load, but they only take a basic DecoderOptions.

Would it be reasonable to add overloads that take ISpecializedDecoderOptions since that already contains a DecoderOptions property? Or maybe some other concept of aggregated specialized decoder options?

Ideally, we'd add a general equivalent to DecoderOptions but we're stuck with the problem of what to choose... The specialized, or general version of the enum. Implementing it would require a breaking change to either remove or make nullable the specialized enum.

Erik White · Answer 14 · Wed Mar 06 2024 17:43:48 GMT+0800 (China Standard Time)

Just so I understand, you would like to add a new property to DecoderOptions, a new enum e.g. CrcChunkHandling.
This could then be used in place of PngCrcChunkHandling, and maybe also in other decoders?

Maybe the new one could be added and mapped to the specialized enum to save a breaking change? If I get time I could make an attempt at that.