tsai
/
ImageSharp
mirror of https://github.com/SixLabors/ImageSharp
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Add sanitation and make tests parametric.

pull/1286/head
James Jackson-South 6 years ago
parent
881b79b00f
commit
91a978336b
3 changed files with 153 additions and 72 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 11
      src/ImageSharp/Formats/Jpeg/JpegDecoderCore.cs
  2. 5
      src/ImageSharp/IO/BufferedReadStream.cs
  3. 209
      tests/ImageSharp.Tests/IO/BufferedReadStreamTests.cs

11
src/ImageSharp/Formats/Jpeg/JpegDecoderCore.cs
View File

@ -514,6 +514,11 @@ namespace SixLabors.ImageSharp.Formats.Jpeg
// TODO: thumbnail // TODO: thumbnail
if (remaining > 0) if (remaining > 0)
{ {
if (stream.Position + remaining >= stream.Length)
{
JpegThrowHelper.ThrowInvalidImageContentException("Bad App0 Marker length.");
}
stream.Skip(remaining); stream.Skip(remaining);
} }
} }
@ -533,6 +538,11 @@ namespace SixLabors.ImageSharp.Formats.Jpeg
return; return;
} }
if (stream.Position + remaining >= stream.Length)
{
JpegThrowHelper.ThrowInvalidImageContentException("Bad App1 Marker length.");
}
var profile = new byte[remaining]; var profile = new byte[remaining];
stream.Read(profile, 0, remaining); stream.Read(profile, 0, remaining);
@ -550,6 +560,7 @@ namespace SixLabors.ImageSharp.Formats.Jpeg
this.ExtendProfile(ref this.exifData, profile.AsSpan(Exif00).ToArray()); this.ExtendProfile(ref this.exifData, profile.AsSpan(Exif00).ToArray());
} }
} }
} }
/// <summary> /// <summary>

5
src/ImageSharp/IO/BufferedReadStream.cs
View File

@ -50,8 +50,8 @@ namespace SixLabors.ImageSharp.IO
} }
this.BaseStream = stream; this.BaseStream = stream;
this.Position = (int)stream.Position;
this.Length = stream.Length; this.Length = stream.Length;
this.Position = (int)stream.Position;
this.BufferSize = configuration.StreamProcessingBufferSize; this.BufferSize = configuration.StreamProcessingBufferSize;
this.maxBufferIndex = this.BufferSize - 1; this.maxBufferIndex = this.BufferSize - 1;
this.readBuffer = ArrayPool<byte>.Shared.Rent(this.BufferSize); this.readBuffer = ArrayPool<byte>.Shared.Rent(this.BufferSize);
@ -86,6 +86,9 @@ namespace SixLabors.ImageSharp.IO
[MethodImpl(MethodImplOptions.NoInlining)] [MethodImpl(MethodImplOptions.NoInlining)]
set set
{ {
Guard.MustBeGreaterThanOrEqualTo(value, 0, nameof(this.Position));
Guard.MustBeLessThan(value, this.Length, nameof(this.Position));
// Only reset readBufferIndex if we are out of bounds of our working buffer // Only reset readBufferIndex if we are out of bounds of our working buffer
// otherwise we should simply move the value by the diff. // otherwise we should simply move the value by the diff.
if (this.IsInReadBuffer(value, out long index)) if (this.IsInReadBuffer(value, out long index))

209
tests/ImageSharp.Tests/IO/BufferedReadStreamTests.cs
View File

@ -11,18 +11,27 @@ namespace SixLabors.ImageSharp.Tests.IO
public class BufferedReadStreamTests public class BufferedReadStreamTests
{ {
private readonly Configuration configuration; private readonly Configuration configuration;
private readonly int bufferSize;
public BufferedReadStreamTests() public BufferedReadStreamTests()
{ {
this.configuration = Configuration.Default; this.configuration = Configuration.CreateDefaultInstance();
this.bufferSize = this.configuration.StreamProcessingBufferSize;
} }
[Fact] public static readonly TheoryData<int> BufferSizes =
public void BufferedStreamCanReadSingleByteFromOrigin() new TheoryData<int>()
{
1, 2, 4, 8,
16, 97, 503,
719, 1024,
8096, 64768
};
[Theory]
[MemberData(nameof(BufferSizes))]
public void BufferedStreamCanReadSingleByteFromOrigin(int bufferSize)
{ {
using (MemoryStream stream = this.CreateTestStream(this.bufferSize * 3)) this.configuration.StreamProcessingBufferSize = bufferSize;
using (MemoryStream stream = this.CreateTestStream(bufferSize * 3))
{ {
byte[] expected = stream.ToArray(); byte[] expected = stream.ToArray();
using (var reader = new BufferedReadStream(this.configuration, stream)) using (var reader = new BufferedReadStream(this.configuration, stream))
@ -30,7 +39,7 @@ namespace SixLabors.ImageSharp.Tests.IO
Assert.Equal(expected[0], reader.ReadByte()); Assert.Equal(expected[0], reader.ReadByte());
// We've read a whole chunk but increment by 1 in our reader. // We've read a whole chunk but increment by 1 in our reader.
Assert.Equal(this.bufferSize, stream.Position); Assert.True(stream.Position >= bufferSize);
Assert.Equal(1, reader.Position); Assert.Equal(1, reader.Position);
} }
@ -39,13 +48,15 @@ namespace SixLabors.ImageSharp.Tests.IO
} }
} }
[Fact] [Theory]
public void BufferedStreamCanReadSingleByteFromOffset() [MemberData(nameof(BufferSizes))]
public void BufferedStreamCanReadSingleByteFromOffset(int bufferSize)
{ {
using (MemoryStream stream = this.CreateTestStream(this.bufferSize * 3)) this.configuration.StreamProcessingBufferSize = bufferSize;
using (MemoryStream stream = this.CreateTestStream(bufferSize * 3))
{ {
byte[] expected = stream.ToArray(); byte[] expected = stream.ToArray();
const int offset = 5; int offset = expected.Length / 2;
using (var reader = new BufferedReadStream(this.configuration, stream)) using (var reader = new BufferedReadStream(this.configuration, stream))
{ {
reader.Position = offset; reader.Position = offset;
@ -53,7 +64,7 @@ namespace SixLabors.ImageSharp.Tests.IO
Assert.Equal(expected[offset], reader.ReadByte()); Assert.Equal(expected[offset], reader.ReadByte());
// We've read a whole chunk but increment by 1 in our reader. // We've read a whole chunk but increment by 1 in our reader.
Assert.Equal(this.bufferSize + offset, stream.Position); Assert.Equal(bufferSize + offset, stream.Position);
Assert.Equal(offset + 1, reader.Position); Assert.Equal(offset + 1, reader.Position);
} }
@ -61,10 +72,12 @@ namespace SixLabors.ImageSharp.Tests.IO
} }
} }
[Fact] [Theory]
public void BufferedStreamCanReadSubsequentSingleByteCorrectly() [MemberData(nameof(BufferSizes))]
public void BufferedStreamCanReadSubsequentSingleByteCorrectly(int bufferSize)
{ {
using (MemoryStream stream = this.CreateTestStream(this.bufferSize * 3)) this.configuration.StreamProcessingBufferSize = bufferSize;
using (MemoryStream stream = this.CreateTestStream(bufferSize * 3))
{ {
byte[] expected = stream.ToArray(); byte[] expected = stream.ToArray();
int i; int i;
@ -75,19 +88,19 @@ namespace SixLabors.ImageSharp.Tests.IO
Assert.Equal(expected[i], reader.ReadByte()); Assert.Equal(expected[i], reader.ReadByte());
Assert.Equal(i + 1, reader.Position); Assert.Equal(i + 1, reader.Position);
if (i < this.bufferSize) if (i < bufferSize)
{ {
Assert.Equal(stream.Position, this.bufferSize); Assert.Equal(stream.Position, bufferSize);
} }
else if (i >= this.bufferSize && i < this.bufferSize * 2) else if (i >= bufferSize && i < bufferSize * 2)
{ {
// We should have advanced to the second chunk now. // We should have advanced to the second chunk now.
Assert.Equal(stream.Position, this.bufferSize * 2); Assert.Equal(stream.Position, bufferSize * 2);
} }
else else
{ {
// We should have advanced to the third chunk now. // We should have advanced to the third chunk now.
Assert.Equal(stream.Position, this.bufferSize * 3); Assert.Equal(stream.Position, bufferSize * 3);
} }
} }
} }
@ -96,10 +109,12 @@ namespace SixLabors.ImageSharp.Tests.IO
} }
} }
[Fact] [Theory]
public void BufferedStreamCanReadMultipleBytesFromOrigin() [MemberData(nameof(BufferSizes))]
public void BufferedStreamCanReadMultipleBytesFromOrigin(int bufferSize)
{ {
using (MemoryStream stream = this.CreateTestStream(this.bufferSize * 3)) this.configuration.StreamProcessingBufferSize = bufferSize;
using (MemoryStream stream = this.CreateTestStream(bufferSize * 3))
{ {
var buffer = new byte[2]; var buffer = new byte[2];
byte[] expected = stream.ToArray(); byte[] expected = stream.ToArray();
@ -110,95 +125,127 @@ namespace SixLabors.ImageSharp.Tests.IO
Assert.Equal(expected[1], buffer[1]); Assert.Equal(expected[1], buffer[1]);
// We've read a whole chunk but increment by the buffer length in our reader. // We've read a whole chunk but increment by the buffer length in our reader.
Assert.Equal(stream.Position, this.bufferSize); Assert.True(stream.Position >= bufferSize);
Assert.Equal(buffer.Length, reader.Position); Assert.Equal(buffer.Length, reader.Position);
} }
} }
} }
[Fact] [Theory]
public void BufferedStreamCanReadSubsequentMultipleByteCorrectly() [MemberData(nameof(BufferSizes))]
public void BufferedStreamCanReadSubsequentMultipleByteCorrectly(int bufferSize)
{ {
using (MemoryStream stream = this.CreateTestStream(this.bufferSize * 3)) this.configuration.StreamProcessingBufferSize = bufferSize;
using (MemoryStream stream = this.CreateTestStream(bufferSize * 3))
{ {
const int increment = 2;
var buffer = new byte[2]; var buffer = new byte[2];
byte[] expected = stream.ToArray(); byte[] expected = stream.ToArray();
using (var reader = new BufferedReadStream(this.configuration, stream)) using (var reader = new BufferedReadStream(this.configuration, stream))
{ {
for (int i = 0, o = 0; i < expected.Length / 2; i++, o += 2) for (int i = 0, o = 0; i < expected.Length / increment; i++, o += increment)
{ {
Assert.Equal(2, reader.Read(buffer, 0, 2)); // Check values are correct.
Assert.Equal(increment, reader.Read(buffer, 0, increment));
Assert.Equal(expected[o], buffer[0]); Assert.Equal(expected[o], buffer[0]);
Assert.Equal(expected[o + 1], buffer[1]); Assert.Equal(expected[o + 1], buffer[1]);
Assert.Equal(o + 2, reader.Position); Assert.Equal(o + increment, reader.Position);
// These tests ensure that we are correctly reading
// our buffer in chunks of the given size.
int offset = i * increment;
int offset = i * 2; // First chunk.
if (offset < this.bufferSize) if (offset < bufferSize)
{ {
Assert.Equal(stream.Position, this.bufferSize); // We've read an entire chunk once and are
// now reading from that chunk.
Assert.True(stream.Position >= bufferSize);
continue;
} }
else if (offset >= this.bufferSize && offset < this.bufferSize * 2)
{ // Second chunk
// We should have advanced to the second chunk now. if (offset < bufferSize * 2)
Assert.Equal(stream.Position, this.bufferSize * 2);
}
else
{ {
// We should have advanced to the third chunk now. Assert.True(stream.Position > bufferSize);
Assert.Equal(stream.Position, this.bufferSize * 3);
// Odd buffer size with even increments can
// jump to the third chunk on final read.
Assert.True(stream.Position <= bufferSize * 3);
continue;
} }
// Third chunk
Assert.True(stream.Position > bufferSize * 2);
} }
} }
} }
} }
[Fact] [Theory]
public void BufferedStreamCanReadSubsequentMultipleByteSpanCorrectly() [MemberData(nameof(BufferSizes))]
public void BufferedStreamCanReadSubsequentMultipleByteSpanCorrectly(int bufferSize)
{ {
using (MemoryStream stream = this.CreateTestStream(this.bufferSize * 3)) this.configuration.StreamProcessingBufferSize = bufferSize;
using (MemoryStream stream = this.CreateTestStream(bufferSize * 3))
{ {
const int increment = 2;
Span<byte> buffer = new byte[2]; Span<byte> buffer = new byte[2];
byte[] expected = stream.ToArray(); byte[] expected = stream.ToArray();
using (var reader = new BufferedReadStream(this.configuration, stream)) using (var reader = new BufferedReadStream(this.configuration, stream))
{ {
for (int i = 0, o = 0; i < expected.Length / 2; i++, o += 2) for (int i = 0, o = 0; i < expected.Length / increment; i++, o += increment)
{ {
Assert.Equal(2, reader.Read(buffer, 0, 2)); // Check values are correct.
Assert.Equal(increment, reader.Read(buffer, 0, increment));
Assert.Equal(expected[o], buffer[0]); Assert.Equal(expected[o], buffer[0]);
Assert.Equal(expected[o + 1], buffer[1]); Assert.Equal(expected[o + 1], buffer[1]);
Assert.Equal(o + 2, reader.Position); Assert.Equal(o + increment, reader.Position);
int offset = i * 2; // These tests ensure that we are correctly reading
if (offset < this.bufferSize) // our buffer in chunks of the given size.
{ int offset = i * increment;
Assert.Equal(stream.Position, this.bufferSize);
} // First chunk.
else if (offset >= this.bufferSize && offset < this.bufferSize * 2) if (offset < bufferSize)
{ {
// We should have advanced to the second chunk now. // We've read an entire chunk once and are
Assert.Equal(stream.Position, this.bufferSize * 2); // now reading from that chunk.
Assert.True(stream.Position >= bufferSize);
continue;
} }
else
// Second chunk
if (offset < bufferSize * 2)
{ {
// We should have advanced to the third chunk now. Assert.True(stream.Position > bufferSize);
Assert.Equal(stream.Position, this.bufferSize * 3);
// Odd buffer size with even increments can
// jump to the third chunk on final read.
Assert.True(stream.Position <= bufferSize * 3);
continue;
} }
// Third chunk
Assert.True(stream.Position > bufferSize * 2);
} }
} }
} }
} }
[Fact] [Theory]
public void BufferedStreamCanSkip() [MemberData(nameof(BufferSizes))]
public void BufferedStreamCanSkip(int bufferSize)
{ {
using (MemoryStream stream = this.CreateTestStream(this.bufferSize * 3)) this.configuration.StreamProcessingBufferSize = bufferSize;
using (MemoryStream stream = this.CreateTestStream(bufferSize * 4))
{ {
byte[] expected = stream.ToArray(); byte[] expected = stream.ToArray();
using (var reader = new BufferedReadStream(this.configuration, stream)) using (var reader = new BufferedReadStream(this.configuration, stream))
{ {
int skip = 50; int skip = 1;
int plusOne = 1; int plusOne = 1;
int skip2 = this.bufferSize; int skip2 = bufferSize;
// Skip // Skip
reader.Skip(skip); reader.Skip(skip);
@ -221,14 +268,17 @@ namespace SixLabors.ImageSharp.Tests.IO
} }
} }
[Fact] [Theory]
public void BufferedStreamReadsSmallStream() [MemberData(nameof(BufferSizes))]
public void BufferedStreamReadsSmallStream(int bufferSize)
{ {
this.configuration.StreamProcessingBufferSize = bufferSize;
// Create a stream smaller than the default buffer length // Create a stream smaller than the default buffer length
using (MemoryStream stream = this.CreateTestStream(this.bufferSize / 4)) using (MemoryStream stream = this.CreateTestStream(Math.Max(1, bufferSize / 4)))
{ {
byte[] expected = stream.ToArray(); byte[] expected = stream.ToArray();
const int offset = 5; int offset = expected.Length / 2;
using (var reader = new BufferedReadStream(this.configuration, stream)) using (var reader = new BufferedReadStream(this.configuration, stream))
{ {
reader.Position = offset; reader.Position = offset;
@ -236,7 +286,7 @@ namespace SixLabors.ImageSharp.Tests.IO
Assert.Equal(expected[offset], reader.ReadByte()); Assert.Equal(expected[offset], reader.ReadByte());
// We've read a whole length of the stream but increment by 1 in our reader. // We've read a whole length of the stream but increment by 1 in our reader.
Assert.Equal(this.bufferSize / 4, stream.Position); Assert.Equal(Math.Max(1, bufferSize / 4), stream.Position);
Assert.Equal(offset + 1, reader.Position); Assert.Equal(offset + 1, reader.Position);
} }
@ -244,10 +294,12 @@ namespace SixLabors.ImageSharp.Tests.IO
} }
} }
[Fact] [Theory]
public void BufferedStreamReadsCanReadAllAsSingleByteFromOrigin() [MemberData(nameof(BufferSizes))]
public void BufferedStreamReadsCanReadAllAsSingleByteFromOrigin(int bufferSize)
{ {
using (MemoryStream stream = this.CreateTestStream(this.bufferSize * 3)) this.configuration.StreamProcessingBufferSize = bufferSize;
using (MemoryStream stream = this.CreateTestStream(bufferSize * 3))
{ {
byte[] expected = stream.ToArray(); byte[] expected = stream.ToArray();
using (var reader = new BufferedReadStream(this.configuration, stream)) using (var reader = new BufferedReadStream(this.configuration, stream))
@ -260,6 +312,21 @@ namespace SixLabors.ImageSharp.Tests.IO
} }
} }
[Theory]
[MemberData(nameof(BufferSizes))]
public void BufferedStreamThrowsOnBadPosition(int bufferSize)
{
this.configuration.StreamProcessingBufferSize = bufferSize;
using (MemoryStream stream = this.CreateTestStream(bufferSize))
{
using (var reader = new BufferedReadStream(this.configuration, stream))
{
Assert.Throws<ArgumentOutOfRangeException>(() => reader.Position = -stream.Length);
Assert.Throws<ArgumentOutOfRangeException>(() => reader.Position = stream.Length);
}
}
}
private MemoryStream CreateTestStream(int length) private MemoryStream CreateTestStream(int length)
{ {
var buffer = new byte[length]; var buffer = new byte[length];

Write Preview
Loading…
Cancel
Save