ee600d02ac
NetState.Send had three failure modes once the send buffer filled, none of
them visible:
- No writable space: GetSendBuffer returned false and the packet was
dropped with no log and no disconnect. The client stayed connected
while quietly missing game state.
- Some space but not enough: NetworkCompression.Compress hit its guard
and returned 0, so CommitWrite(0) ran and the packet was dropped the
same way.
- One to three bytes writable: Compress computes
safeOutputLength = (nuint)output.Length - 4, which underflows for
those sizes. The hot loop's bounds check never trips and it writes
past the span, corrupting the in-flight region of the ring buffer.
Reachable because callers only check for non-zero space.
Compress now refuses an output too small to bound, and Send reports
exhaustion instead of dropping: it logs and disconnects with the bytes
needed, writable, awaiting acknowledgement, and total capacity. Those
numbers separate a slow client holding the buffer from a buffer genuinely
too small for the shard, which is the case that warrants raising
network.sendBufferSize.
Tests cover the underflow via sentinel bytes around the output window and
were confirmed to fail without the guard.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
86 lines
2.6 KiB
C#
86 lines
2.6 KiB
C#
using System;
|
|
using Server.Network;
|
|
using Xunit;
|
|
|
|
namespace Server.Tests.Network;
|
|
|
|
/// <summary>
|
|
/// Bounds behaviour of the Huffman compressor when the destination is too small.
|
|
///
|
|
/// This is reachable in production: NetState only checks that the send buffer has *some* writable
|
|
/// space before handing the remainder to Compress, so a nearly-full buffer can offer a span of one
|
|
/// to three bytes. The internal guard is computed as an unsigned <c>output.Length - 4</c>, which
|
|
/// underflows for those sizes and stops bounding the writes at all.
|
|
/// </summary>
|
|
public class NetworkCompressionBoundsTests
|
|
{
|
|
[Theory]
|
|
[InlineData(0)]
|
|
[InlineData(1)]
|
|
[InlineData(2)]
|
|
[InlineData(3)]
|
|
public void RefusesOutputTooSmallToBound(int outputSize)
|
|
{
|
|
var input = new byte[64];
|
|
Array.Fill(input, (byte)'A');
|
|
|
|
// Sentinel-filled backing array; only the middle window is offered to the compressor, so
|
|
// any write past the span shows up as a modified sentinel rather than silent corruption.
|
|
var backing = new byte[256];
|
|
Array.Fill(backing, (byte)0xCC);
|
|
|
|
const int windowStart = 64;
|
|
var output = backing.AsSpan(windowStart, outputSize);
|
|
|
|
var written = NetworkCompression.Compress(input, output);
|
|
|
|
Assert.Equal(0, written);
|
|
|
|
for (var i = 0; i < backing.Length; i++)
|
|
{
|
|
Assert.Equal(0xCC, backing[i]);
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void StillCompressesWhenOutputIsLargeEnough()
|
|
{
|
|
var input = new byte[64];
|
|
Array.Fill(input, (byte)'A');
|
|
|
|
var output = new byte[256];
|
|
|
|
var written = NetworkCompression.Compress(input, output);
|
|
|
|
Assert.True(written > 0);
|
|
Assert.True(written <= output.Length);
|
|
}
|
|
|
|
[Fact]
|
|
public void ReportsFailureRatherThanOverrunningATightOutput()
|
|
{
|
|
// Large input against a small-but-bounded output: the guard is well-defined here, so this
|
|
// must fail cleanly rather than write past the end.
|
|
var input = new byte[4096];
|
|
Array.Fill(input, (byte)'A');
|
|
|
|
var backing = new byte[256];
|
|
Array.Fill(backing, (byte)0xCC);
|
|
|
|
const int windowStart = 64;
|
|
const int windowSize = 16;
|
|
var output = backing.AsSpan(windowStart, windowSize);
|
|
|
|
NetworkCompression.Compress(input, output);
|
|
|
|
for (var i = 0; i < windowStart; i++)
|
|
{
|
|
Assert.Equal(0xCC, backing[i]);
|
|
}
|
|
|
|
for (var i = windowStart + windowSize; i < backing.Length; i++)
|
|
{
|
|
Assert.Equal(0xCC, backing[i]);
|
|
}
|
|
}
|
|
}
|