1059 lines
43 KiB
C#
1059 lines
43 KiB
C#
// Copyright (c) .NET Foundation. All rights reserved.
|
|
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
|
|
|
|
using System;
|
|
using System.Buffers;
|
|
using System.Buffers.Binary;
|
|
using System.Collections.Concurrent;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.IO.Pipelines;
|
|
using System.Linq;
|
|
using System.Reflection;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using Microsoft.AspNetCore.Connections;
|
|
using Microsoft.AspNetCore.Http;
|
|
using Microsoft.AspNetCore.Http.Features;
|
|
using Microsoft.AspNetCore.Server.Kestrel.Core.Features;
|
|
using Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Http;
|
|
using Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Http2;
|
|
using Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Http2.HPack;
|
|
using Microsoft.AspNetCore.Server.Kestrel.Core.Internal.Infrastructure;
|
|
using Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal;
|
|
using Microsoft.AspNetCore.Testing;
|
|
using Microsoft.Net.Http.Headers;
|
|
using Moq;
|
|
using Xunit;
|
|
using Xunit.Abstractions;
|
|
|
|
namespace Microsoft.AspNetCore.Server.Kestrel.Core.Tests
|
|
{
|
|
public class Http2TestBase : TestApplicationErrorLoggerLoggedTest, IDisposable, IHttpHeadersHandler
|
|
{
|
|
protected static readonly int MaxRequestHeaderFieldSize = 8192;
|
|
protected static readonly string _4kHeaderValue = new string('a', 4096);
|
|
|
|
protected static readonly IEnumerable<KeyValuePair<string, string>> _browserRequestHeaders = new[]
|
|
{
|
|
new KeyValuePair<string, string>(HeaderNames.Method, "GET"),
|
|
new KeyValuePair<string, string>(HeaderNames.Path, "/"),
|
|
new KeyValuePair<string, string>(HeaderNames.Scheme, "http"),
|
|
new KeyValuePair<string, string>(HeaderNames.Authority, "localhost:80"),
|
|
new KeyValuePair<string, string>("user-agent", "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:54.0) Gecko/20100101 Firefox/54.0"),
|
|
new KeyValuePair<string, string>("accept", "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8"),
|
|
new KeyValuePair<string, string>("accept-language", "en-US,en;q=0.5"),
|
|
new KeyValuePair<string, string>("accept-encoding", "gzip, deflate, br"),
|
|
new KeyValuePair<string, string>("upgrade-insecure-requests", "1"),
|
|
};
|
|
|
|
private readonly MemoryPool<byte> _memoryPool = KestrelMemoryPool.Create();
|
|
internal readonly DuplexPipe.DuplexPipePair _pair;
|
|
|
|
protected readonly Http2PeerSettings _clientSettings = new Http2PeerSettings();
|
|
protected readonly HPackEncoder _hpackEncoder = new HPackEncoder();
|
|
protected readonly HPackDecoder _hpackDecoder;
|
|
private readonly byte[] _headerEncodingBuffer = new byte[Http2PeerSettings.MinAllowedMaxFrameSize];
|
|
|
|
protected readonly ConcurrentDictionary<int, TaskCompletionSource<object>> _runningStreams = new ConcurrentDictionary<int, TaskCompletionSource<object>>();
|
|
protected readonly Dictionary<string, string> _receivedHeaders = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
|
|
protected readonly Dictionary<string, string> _decodedHeaders = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
|
|
protected readonly HashSet<int> _abortedStreamIds = new HashSet<int>();
|
|
protected readonly object _abortedStreamIdsLock = new object();
|
|
protected readonly TaskCompletionSource<object> _closingStateReached = new TaskCompletionSource<object>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
protected readonly TaskCompletionSource<object> _closedStateReached = new TaskCompletionSource<object>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
|
|
protected readonly RequestDelegate _noopApplication;
|
|
protected readonly RequestDelegate _readHeadersApplication;
|
|
protected readonly RequestDelegate _readTrailersApplication;
|
|
protected readonly RequestDelegate _bufferingApplication;
|
|
protected readonly RequestDelegate _echoApplication;
|
|
protected readonly RequestDelegate _echoWaitForAbortApplication;
|
|
protected readonly RequestDelegate _largeHeadersApplication;
|
|
protected readonly RequestDelegate _waitForAbortApplication;
|
|
protected readonly RequestDelegate _waitForAbortFlushingApplication;
|
|
protected readonly RequestDelegate _waitForAbortWithDataApplication;
|
|
protected readonly RequestDelegate _echoMethod;
|
|
protected readonly RequestDelegate _echoHost;
|
|
protected readonly RequestDelegate _echoPath;
|
|
|
|
protected Http2ConnectionContext _connectionContext;
|
|
protected Http2Connection _connection;
|
|
protected Task _connectionTask;
|
|
|
|
public Http2TestBase()
|
|
{
|
|
// Always dispatch test code back to the ThreadPool. This prevents deadlocks caused by continuing
|
|
// Http2Connection.ProcessRequestsAsync() loop with writer locks acquired. Run product code inline to make
|
|
// it easier to verify request frames are processed correctly immediately after sending the them.
|
|
var inputPipeOptions = new PipeOptions(
|
|
pool: _memoryPool,
|
|
readerScheduler: PipeScheduler.Inline,
|
|
writerScheduler: PipeScheduler.ThreadPool,
|
|
useSynchronizationContext: false
|
|
);
|
|
var outputPipeOptions = new PipeOptions(
|
|
pool: _memoryPool,
|
|
readerScheduler: PipeScheduler.ThreadPool,
|
|
writerScheduler: PipeScheduler.Inline,
|
|
useSynchronizationContext: false
|
|
);
|
|
|
|
_pair = DuplexPipe.CreateConnectionPair(inputPipeOptions, outputPipeOptions);
|
|
_hpackDecoder = new HPackDecoder((int)_clientSettings.HeaderTableSize, MaxRequestHeaderFieldSize);
|
|
|
|
_noopApplication = context => Task.CompletedTask;
|
|
|
|
_readHeadersApplication = context =>
|
|
{
|
|
foreach (var header in context.Request.Headers)
|
|
{
|
|
_receivedHeaders[header.Key] = header.Value.ToString();
|
|
}
|
|
|
|
return Task.CompletedTask;
|
|
};
|
|
|
|
_readTrailersApplication = async context =>
|
|
{
|
|
using (var ms = new MemoryStream())
|
|
{
|
|
// Consuming the entire request body guarantees trailers will be available
|
|
await context.Request.Body.CopyToAsync(ms);
|
|
}
|
|
|
|
foreach (var header in context.Request.Headers)
|
|
{
|
|
_receivedHeaders[header.Key] = header.Value.ToString();
|
|
}
|
|
};
|
|
|
|
_bufferingApplication = async context =>
|
|
{
|
|
var data = new List<byte>();
|
|
var buffer = new byte[1024];
|
|
var received = 0;
|
|
|
|
while ((received = await context.Request.Body.ReadAsync(buffer, 0, buffer.Length)) > 0)
|
|
{
|
|
data.AddRange(new ArraySegment<byte>(buffer, 0, received));
|
|
}
|
|
|
|
await context.Response.Body.WriteAsync(data.ToArray(), 0, data.Count);
|
|
};
|
|
|
|
_echoApplication = async context =>
|
|
{
|
|
var buffer = new byte[Http2PeerSettings.MinAllowedMaxFrameSize];
|
|
var received = 0;
|
|
|
|
while ((received = await context.Request.Body.ReadAsync(buffer, 0, buffer.Length)) > 0)
|
|
{
|
|
await context.Response.Body.WriteAsync(buffer, 0, received);
|
|
}
|
|
};
|
|
|
|
_echoWaitForAbortApplication = async context =>
|
|
{
|
|
var buffer = new byte[Http2PeerSettings.MinAllowedMaxFrameSize];
|
|
var received = 0;
|
|
|
|
while ((received = await context.Request.Body.ReadAsync(buffer, 0, buffer.Length)) > 0)
|
|
{
|
|
await context.Response.Body.WriteAsync(buffer, 0, received);
|
|
}
|
|
|
|
var sem = new SemaphoreSlim(0);
|
|
|
|
context.RequestAborted.Register(() =>
|
|
{
|
|
sem.Release();
|
|
});
|
|
|
|
await sem.WaitAsync().DefaultTimeout();
|
|
};
|
|
|
|
_largeHeadersApplication = context =>
|
|
{
|
|
foreach (var name in new[] { "a", "b", "c", "d", "e", "f", "g", "h" })
|
|
{
|
|
context.Response.Headers[name] = _4kHeaderValue;
|
|
}
|
|
|
|
return Task.CompletedTask;
|
|
};
|
|
|
|
_waitForAbortApplication = async context =>
|
|
{
|
|
var streamIdFeature = context.Features.Get<IHttp2StreamIdFeature>();
|
|
var sem = new SemaphoreSlim(0);
|
|
|
|
context.RequestAborted.Register(() =>
|
|
{
|
|
lock (_abortedStreamIdsLock)
|
|
{
|
|
_abortedStreamIds.Add(streamIdFeature.StreamId);
|
|
}
|
|
|
|
sem.Release();
|
|
});
|
|
|
|
await sem.WaitAsync().DefaultTimeout();
|
|
|
|
_runningStreams[streamIdFeature.StreamId].TrySetResult(null);
|
|
};
|
|
|
|
_waitForAbortFlushingApplication = async context =>
|
|
{
|
|
var streamIdFeature = context.Features.Get<IHttp2StreamIdFeature>();
|
|
var sem = new SemaphoreSlim(0);
|
|
|
|
context.RequestAborted.Register(() =>
|
|
{
|
|
lock (_abortedStreamIdsLock)
|
|
{
|
|
_abortedStreamIds.Add(streamIdFeature.StreamId);
|
|
}
|
|
|
|
sem.Release();
|
|
});
|
|
|
|
await sem.WaitAsync().DefaultTimeout();
|
|
|
|
await context.Response.Body.FlushAsync();
|
|
|
|
_runningStreams[streamIdFeature.StreamId].TrySetResult(null);
|
|
};
|
|
|
|
_waitForAbortWithDataApplication = async context =>
|
|
{
|
|
var streamIdFeature = context.Features.Get<IHttp2StreamIdFeature>();
|
|
var sem = new SemaphoreSlim(0);
|
|
|
|
context.RequestAborted.Register(() =>
|
|
{
|
|
lock (_abortedStreamIdsLock)
|
|
{
|
|
_abortedStreamIds.Add(streamIdFeature.StreamId);
|
|
}
|
|
|
|
sem.Release();
|
|
});
|
|
|
|
await sem.WaitAsync().DefaultTimeout();
|
|
|
|
await context.Response.Body.WriteAsync(new byte[10], 0, 10);
|
|
|
|
_runningStreams[streamIdFeature.StreamId].TrySetResult(null);
|
|
};
|
|
|
|
_echoMethod = context =>
|
|
{
|
|
context.Response.Headers["Method"] = context.Request.Method;
|
|
|
|
return Task.CompletedTask;
|
|
};
|
|
|
|
_echoHost = context =>
|
|
{
|
|
context.Response.Headers[HeaderNames.Host] = context.Request.Headers[HeaderNames.Host];
|
|
|
|
return Task.CompletedTask;
|
|
};
|
|
|
|
_echoPath = context =>
|
|
{
|
|
context.Response.Headers["path"] = context.Request.Path.ToString();
|
|
context.Response.Headers["rawtarget"] = context.Features.Get<IHttpRequestFeature>().RawTarget;
|
|
|
|
return Task.CompletedTask;
|
|
};
|
|
}
|
|
|
|
public override void Initialize(MethodInfo methodInfo, object[] testMethodArguments, ITestOutputHelper testOutputHelper)
|
|
{
|
|
base.Initialize(methodInfo, testMethodArguments, testOutputHelper);
|
|
|
|
var mockKestrelTrace = new Mock<IKestrelTrace>();
|
|
mockKestrelTrace
|
|
.Setup(m => m.Http2ConnectionClosing(It.IsAny<string>()))
|
|
.Callback(() => _closingStateReached.SetResult(null));
|
|
mockKestrelTrace
|
|
.Setup(m => m.Http2ConnectionClosed(It.IsAny<string>(), It.IsAny<int>()))
|
|
.Callback(() => _closedStateReached.SetResult(null));
|
|
|
|
_connectionContext = new Http2ConnectionContext
|
|
{
|
|
ConnectionContext = Mock.Of<ConnectionContext>(),
|
|
ConnectionFeatures = new FeatureCollection(),
|
|
ServiceContext = new TestServiceContext(LoggerFactory, mockKestrelTrace.Object),
|
|
MemoryPool = _memoryPool,
|
|
Transport = _pair.Transport
|
|
};
|
|
|
|
_connection = new Http2Connection(_connectionContext);
|
|
}
|
|
|
|
public override void Dispose()
|
|
{
|
|
_pair.Application.Input.Complete();
|
|
_pair.Application.Output.Complete();
|
|
_pair.Transport.Input.Complete();
|
|
_pair.Transport.Output.Complete();
|
|
_memoryPool.Dispose();
|
|
|
|
base.Dispose();
|
|
}
|
|
|
|
void IHttpHeadersHandler.OnHeader(Span<byte> name, Span<byte> value)
|
|
{
|
|
_decodedHeaders[name.GetAsciiStringNonNullCharacters()] = value.GetAsciiOrUTF8StringNonNullCharacters();
|
|
}
|
|
|
|
protected async Task InitializeConnectionAsync(RequestDelegate application, int expectedSettingsCount = 2)
|
|
{
|
|
_connectionTask = _connection.ProcessRequestsAsync(new DummyApplication(application));
|
|
|
|
await SendPreambleAsync().ConfigureAwait(false);
|
|
await SendSettingsAsync();
|
|
|
|
await ExpectAsync(Http2FrameType.SETTINGS,
|
|
withLength: expectedSettingsCount * Http2FrameReader.SettingSize,
|
|
withFlags: 0,
|
|
withStreamId: 0);
|
|
|
|
await ExpectAsync(Http2FrameType.SETTINGS,
|
|
withLength: 0,
|
|
withFlags: (byte)Http2SettingsFrameFlags.ACK,
|
|
withStreamId: 0);
|
|
}
|
|
|
|
protected Task StartStreamAsync(int streamId, IEnumerable<KeyValuePair<string, string>> headers, bool endStream)
|
|
{
|
|
var writableBuffer = _pair.Application.Output;
|
|
var tcs = new TaskCompletionSource<object>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
_runningStreams[streamId] = tcs;
|
|
|
|
var frame = new Http2Frame();
|
|
frame.PrepareHeaders(Http2HeadersFrameFlags.NONE, streamId);
|
|
|
|
var buffer = _headerEncodingBuffer.AsSpan();
|
|
var done = _hpackEncoder.BeginEncode(headers, buffer, out var length);
|
|
frame.PayloadLength = length;
|
|
|
|
if (done)
|
|
{
|
|
frame.HeadersFlags = Http2HeadersFrameFlags.END_HEADERS;
|
|
}
|
|
|
|
if (endStream)
|
|
{
|
|
frame.HeadersFlags |= Http2HeadersFrameFlags.END_STREAM;
|
|
}
|
|
|
|
Http2FrameWriter.WriteHeader(frame, writableBuffer);
|
|
writableBuffer.Write(buffer.Slice(0, length));
|
|
|
|
while (!done)
|
|
{
|
|
frame.PrepareContinuation(Http2ContinuationFrameFlags.NONE, streamId);
|
|
|
|
done = _hpackEncoder.Encode(buffer, out length);
|
|
frame.PayloadLength = length;
|
|
|
|
if (done)
|
|
{
|
|
frame.ContinuationFlags = Http2ContinuationFrameFlags.END_HEADERS;
|
|
}
|
|
|
|
Http2FrameWriter.WriteHeader(frame, writableBuffer);
|
|
writableBuffer.Write(buffer.Slice(0, length));
|
|
}
|
|
|
|
return FlushAsync(writableBuffer);
|
|
}
|
|
|
|
/* https://tools.ietf.org/html/rfc7540#section-6.2
|
|
+---------------+
|
|
|Pad Length? (8)|
|
|
+-+-------------+-----------------------------------------------+
|
|
| Header Block Fragment (*) ...
|
|
+---------------------------------------------------------------+
|
|
| Padding (*) ...
|
|
+---------------------------------------------------------------+
|
|
*/
|
|
protected Task SendHeadersWithPaddingAsync(int streamId, IEnumerable<KeyValuePair<string, string>> headers, byte padLength, bool endStream)
|
|
{
|
|
var writableBuffer = _pair.Application.Output;
|
|
var tcs = new TaskCompletionSource<object>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
_runningStreams[streamId] = tcs;
|
|
|
|
var frame = new Http2Frame();
|
|
|
|
frame.PrepareHeaders(Http2HeadersFrameFlags.END_HEADERS | Http2HeadersFrameFlags.PADDED, streamId);
|
|
frame.HeadersPadLength = padLength;
|
|
|
|
var extendedHeaderLength = 1; // Padding length field
|
|
var buffer = _headerEncodingBuffer.AsSpan();
|
|
var extendedHeader = buffer.Slice(0, extendedHeaderLength);
|
|
extendedHeader[0] = padLength;
|
|
var payload = buffer.Slice(extendedHeaderLength, buffer.Length - padLength - extendedHeaderLength);
|
|
|
|
_hpackEncoder.BeginEncode(headers, payload, out var length);
|
|
var padding = buffer.Slice(extendedHeaderLength + length, padLength);
|
|
padding.Fill(0);
|
|
|
|
frame.PayloadLength = extendedHeaderLength + length + padLength;
|
|
|
|
if (endStream)
|
|
{
|
|
frame.HeadersFlags |= Http2HeadersFrameFlags.END_STREAM;
|
|
}
|
|
|
|
Http2FrameWriter.WriteHeader(frame, writableBuffer);
|
|
writableBuffer.Write(buffer.Slice(0, frame.PayloadLength));
|
|
return FlushAsync(writableBuffer);
|
|
}
|
|
|
|
/* https://tools.ietf.org/html/rfc7540#section-6.2
|
|
+-+-------------+-----------------------------------------------+
|
|
|E| Stream Dependency? (31) |
|
|
+-+-------------+-----------------------------------------------+
|
|
| Weight? (8) |
|
|
+-+-------------+-----------------------------------------------+
|
|
| Header Block Fragment (*) ...
|
|
+---------------------------------------------------------------+
|
|
*/
|
|
protected Task SendHeadersWithPriorityAsync(int streamId, IEnumerable<KeyValuePair<string, string>> headers, byte priority, int streamDependency, bool endStream)
|
|
{
|
|
var writableBuffer = _pair.Application.Output;
|
|
var tcs = new TaskCompletionSource<object>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
_runningStreams[streamId] = tcs;
|
|
|
|
var frame = new Http2Frame();
|
|
frame.PrepareHeaders(Http2HeadersFrameFlags.END_HEADERS | Http2HeadersFrameFlags.PRIORITY, streamId);
|
|
frame.HeadersPriorityWeight = priority;
|
|
frame.HeadersStreamDependency = streamDependency;
|
|
|
|
var extendedHeaderLength = 5; // stream dependency + weight
|
|
var buffer = _headerEncodingBuffer.AsSpan();
|
|
var extendedHeader = buffer.Slice(0, extendedHeaderLength);
|
|
Bitshifter.WriteUInt31BigEndian(extendedHeader, (uint)streamDependency);
|
|
extendedHeader[4] = priority;
|
|
var payload = buffer.Slice(extendedHeaderLength);
|
|
|
|
_hpackEncoder.BeginEncode(headers, payload, out var length);
|
|
|
|
frame.PayloadLength = extendedHeaderLength + length;
|
|
|
|
if (endStream)
|
|
{
|
|
frame.HeadersFlags |= Http2HeadersFrameFlags.END_STREAM;
|
|
}
|
|
|
|
Http2FrameWriter.WriteHeader(frame, writableBuffer);
|
|
writableBuffer.Write(buffer.Slice(0, frame.PayloadLength));
|
|
return FlushAsync(writableBuffer);
|
|
}
|
|
|
|
/* https://tools.ietf.org/html/rfc7540#section-6.2
|
|
+---------------+
|
|
|Pad Length? (8)|
|
|
+-+-------------+-----------------------------------------------+
|
|
|E| Stream Dependency? (31) |
|
|
+-+-------------+-----------------------------------------------+
|
|
| Weight? (8) |
|
|
+-+-------------+-----------------------------------------------+
|
|
| Header Block Fragment (*) ...
|
|
+---------------------------------------------------------------+
|
|
| Padding (*) ...
|
|
+---------------------------------------------------------------+
|
|
*/
|
|
protected Task SendHeadersWithPaddingAndPriorityAsync(int streamId, IEnumerable<KeyValuePair<string, string>> headers, byte padLength, byte priority, int streamDependency, bool endStream)
|
|
{
|
|
var writableBuffer = _pair.Application.Output;
|
|
var tcs = new TaskCompletionSource<object>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
_runningStreams[streamId] = tcs;
|
|
|
|
var frame = new Http2Frame();
|
|
frame.PrepareHeaders(Http2HeadersFrameFlags.END_HEADERS | Http2HeadersFrameFlags.PADDED | Http2HeadersFrameFlags.PRIORITY, streamId);
|
|
frame.HeadersPadLength = padLength;
|
|
frame.HeadersPriorityWeight = priority;
|
|
frame.HeadersStreamDependency = streamDependency;
|
|
|
|
var extendedHeaderLength = 6; // pad length + stream dependency + weight
|
|
var buffer = _headerEncodingBuffer.AsSpan();
|
|
var extendedHeader = buffer.Slice(0, extendedHeaderLength);
|
|
extendedHeader[0] = padLength;
|
|
Bitshifter.WriteUInt31BigEndian(extendedHeader.Slice(1), (uint)streamDependency);
|
|
extendedHeader[5] = priority;
|
|
var payload = buffer.Slice(extendedHeaderLength, buffer.Length - padLength - extendedHeaderLength);
|
|
|
|
_hpackEncoder.BeginEncode(headers, payload, out var length);
|
|
var padding = buffer.Slice(extendedHeaderLength + length, padLength);
|
|
padding.Fill(0);
|
|
|
|
frame.PayloadLength = extendedHeaderLength + length + padLength;
|
|
|
|
if (endStream)
|
|
{
|
|
frame.HeadersFlags |= Http2HeadersFrameFlags.END_STREAM;
|
|
}
|
|
|
|
Http2FrameWriter.WriteHeader(frame, writableBuffer);
|
|
writableBuffer.Write(buffer.Slice(0, frame.PayloadLength));
|
|
return FlushAsync(writableBuffer);
|
|
}
|
|
|
|
protected Task WaitForAllStreamsAsync()
|
|
{
|
|
return Task.WhenAll(_runningStreams.Values.Select(tcs => tcs.Task)).DefaultTimeout();
|
|
}
|
|
|
|
protected Task SendAsync(ReadOnlySpan<byte> span)
|
|
{
|
|
var writableBuffer = _pair.Application.Output;
|
|
writableBuffer.Write(span);
|
|
return FlushAsync(writableBuffer);
|
|
}
|
|
|
|
protected static async Task FlushAsync(PipeWriter writableBuffer)
|
|
{
|
|
await writableBuffer.FlushAsync();
|
|
}
|
|
|
|
protected Task SendPreambleAsync() => SendAsync(new ArraySegment<byte>(Http2Connection.ClientPreface));
|
|
|
|
protected async Task SendSettingsAsync()
|
|
{
|
|
var writableBuffer = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
frame.PrepareSettings(Http2SettingsFrameFlags.NONE);
|
|
var settings = _clientSettings.GetNonProtocolDefaults();
|
|
var payload = new byte[settings.Count * Http2FrameReader.SettingSize];
|
|
frame.PayloadLength = payload.Length;
|
|
Http2FrameWriter.WriteSettings(settings, payload);
|
|
Http2FrameWriter.WriteHeader(frame, writableBuffer);
|
|
await SendAsync(payload);
|
|
}
|
|
|
|
protected async Task SendSettingsAckWithInvalidLengthAsync(int length)
|
|
{
|
|
var writableBuffer = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
frame.PrepareSettings(Http2SettingsFrameFlags.ACK);
|
|
frame.PayloadLength = length;
|
|
Http2FrameWriter.WriteHeader(frame, writableBuffer);
|
|
await SendAsync(new byte[length]);
|
|
}
|
|
|
|
protected async Task SendSettingsWithInvalidStreamIdAsync(int streamId)
|
|
{
|
|
var writableBuffer = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
frame.PrepareSettings(Http2SettingsFrameFlags.NONE);
|
|
frame.StreamId = streamId;
|
|
var settings = _clientSettings.GetNonProtocolDefaults();
|
|
var payload = new byte[settings.Count * Http2FrameReader.SettingSize];
|
|
frame.PayloadLength = payload.Length;
|
|
Http2FrameWriter.WriteSettings(settings, payload);
|
|
Http2FrameWriter.WriteHeader(frame, writableBuffer);
|
|
await SendAsync(payload);
|
|
}
|
|
|
|
protected async Task SendSettingsWithInvalidLengthAsync(int length)
|
|
{
|
|
var writableBuffer = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
frame.PrepareSettings(Http2SettingsFrameFlags.NONE);
|
|
|
|
frame.PayloadLength = length;
|
|
var payload = new byte[length];
|
|
Http2FrameWriter.WriteHeader(frame, writableBuffer);
|
|
await SendAsync(payload);
|
|
}
|
|
|
|
protected async Task SendSettingsWithInvalidParameterValueAsync(Http2SettingsParameter parameter, uint value)
|
|
{
|
|
var writableBuffer = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
frame.PrepareSettings(Http2SettingsFrameFlags.NONE);
|
|
frame.PayloadLength = 6;
|
|
var payload = new byte[Http2FrameReader.SettingSize];
|
|
payload[0] = (byte)((ushort)parameter >> 8);
|
|
payload[1] = (byte)(ushort)parameter;
|
|
payload[2] = (byte)(value >> 24);
|
|
payload[3] = (byte)(value >> 16);
|
|
payload[4] = (byte)(value >> 8);
|
|
payload[5] = (byte)value;
|
|
|
|
Http2FrameWriter.WriteHeader(frame, writableBuffer);
|
|
await SendAsync(payload);
|
|
}
|
|
|
|
protected Task SendPushPromiseFrameAsync()
|
|
{
|
|
var writableBuffer = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
frame.PayloadLength = 0;
|
|
frame.Type = Http2FrameType.PUSH_PROMISE;
|
|
frame.StreamId = 1;
|
|
|
|
Http2FrameWriter.WriteHeader(frame, writableBuffer);
|
|
return FlushAsync(writableBuffer);
|
|
}
|
|
|
|
protected async Task<bool> SendHeadersAsync(int streamId, Http2HeadersFrameFlags flags, IEnumerable<KeyValuePair<string, string>> headers)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
|
|
frame.PrepareHeaders(flags, streamId);
|
|
var buffer = _headerEncodingBuffer.AsMemory();
|
|
var done = _hpackEncoder.BeginEncode(headers, buffer.Span, out var length);
|
|
frame.PayloadLength = length;
|
|
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
await SendAsync(buffer.Span.Slice(0, length));
|
|
|
|
return done;
|
|
}
|
|
|
|
protected async Task SendHeadersAsync(int streamId, Http2HeadersFrameFlags flags, byte[] headerBlock)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
|
|
frame.PrepareHeaders(flags, streamId);
|
|
frame.PayloadLength = headerBlock.Length;
|
|
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
await SendAsync(headerBlock);
|
|
}
|
|
|
|
protected async Task SendInvalidHeadersFrameAsync(int streamId, int payloadLength, byte padLength)
|
|
{
|
|
Assert.True(padLength >= payloadLength, $"{nameof(padLength)} must be greater than or equal to {nameof(payloadLength)} to create an invalid frame.");
|
|
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
|
|
frame.PrepareHeaders(Http2HeadersFrameFlags.PADDED, streamId);
|
|
frame.PayloadLength = payloadLength;
|
|
var payload = new byte[payloadLength];
|
|
if (payloadLength > 0)
|
|
{
|
|
payload[0] = padLength;
|
|
}
|
|
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
await SendAsync(payload);
|
|
}
|
|
|
|
protected async Task SendIncompleteHeadersFrameAsync(int streamId)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
|
|
frame.PrepareHeaders(Http2HeadersFrameFlags.END_HEADERS, streamId);
|
|
frame.PayloadLength = 3;
|
|
var payload = new byte[3];
|
|
// Set up an incomplete Literal Header Field w/ Incremental Indexing frame,
|
|
// with an incomplete new name
|
|
payload[0] = 0;
|
|
payload[1] = 2;
|
|
payload[2] = (byte)'a';
|
|
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
await SendAsync(payload);
|
|
}
|
|
|
|
protected async Task<bool> SendContinuationAsync(int streamId, Http2ContinuationFrameFlags flags)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
|
|
frame.PrepareContinuation(flags, streamId);
|
|
var buffer = _headerEncodingBuffer.AsMemory();
|
|
var done = _hpackEncoder.Encode(buffer.Span, out var length);
|
|
frame.PayloadLength = length;
|
|
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
await SendAsync(buffer.Span.Slice(0, length));
|
|
|
|
return done;
|
|
}
|
|
|
|
protected async Task SendContinuationAsync(int streamId, Http2ContinuationFrameFlags flags, byte[] payload)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
|
|
frame.PrepareContinuation(flags, streamId);
|
|
frame.PayloadLength = payload.Length;
|
|
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
await SendAsync(payload);
|
|
}
|
|
|
|
protected Task SendEmptyContinuationFrameAsync(int streamId, Http2ContinuationFrameFlags flags)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
|
|
frame.PrepareContinuation(flags, streamId);
|
|
frame.PayloadLength = 0;
|
|
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
return FlushAsync(outputWriter);
|
|
}
|
|
|
|
protected async Task SendIncompleteContinuationFrameAsync(int streamId)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
|
|
frame.PrepareContinuation(Http2ContinuationFrameFlags.END_HEADERS, streamId);
|
|
frame.PayloadLength = 3;
|
|
var payload = new byte[3];
|
|
// Set up an incomplete Literal Header Field w/ Incremental Indexing frame,
|
|
// with an incomplete new name
|
|
payload[0] = 0;
|
|
payload[1] = 2;
|
|
payload[2] = (byte)'a';
|
|
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
await SendAsync(payload);
|
|
}
|
|
|
|
protected Task SendDataAsync(int streamId, Memory<byte> data, bool endStream)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
|
|
frame.PrepareData(streamId);
|
|
frame.PayloadLength = data.Length;
|
|
frame.DataFlags = endStream ? Http2DataFrameFlags.END_STREAM : Http2DataFrameFlags.NONE;
|
|
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
return SendAsync(data.Span);
|
|
}
|
|
|
|
protected async Task SendDataWithPaddingAsync(int streamId, Memory<byte> data, byte padLength, bool endStream)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
|
|
frame.PrepareData(streamId, padLength);
|
|
frame.PayloadLength = data.Length + 1 + padLength;
|
|
|
|
if (endStream)
|
|
{
|
|
frame.DataFlags |= Http2DataFrameFlags.END_STREAM;
|
|
}
|
|
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
outputWriter.GetSpan(1)[0] = padLength;
|
|
outputWriter.Advance(1);
|
|
await SendAsync(data.Span);
|
|
await SendAsync(new byte[padLength]);
|
|
}
|
|
|
|
protected Task SendInvalidDataFrameAsync(int streamId, int frameLength, byte padLength)
|
|
{
|
|
Assert.True(padLength >= frameLength, $"{nameof(padLength)} must be greater than or equal to {nameof(frameLength)} to create an invalid frame.");
|
|
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
|
|
frame.PrepareData(streamId);
|
|
frame.DataFlags = Http2DataFrameFlags.PADDED;
|
|
frame.PayloadLength = frameLength;
|
|
var payload = new byte[frameLength];
|
|
if (frameLength > 0)
|
|
{
|
|
payload[0] = padLength;
|
|
}
|
|
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
return SendAsync(payload);
|
|
}
|
|
|
|
protected Task SendPingAsync(Http2PingFrameFlags flags)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var pingFrame = new Http2Frame();
|
|
pingFrame.PreparePing(flags);
|
|
Http2FrameWriter.WriteHeader(pingFrame, outputWriter);
|
|
return SendAsync(new byte[8]); // Empty payload
|
|
}
|
|
|
|
protected Task SendPingWithInvalidLengthAsync(int length)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var pingFrame = new Http2Frame();
|
|
pingFrame.PreparePing(Http2PingFrameFlags.NONE);
|
|
pingFrame.PayloadLength = length;
|
|
Http2FrameWriter.WriteHeader(pingFrame, outputWriter);
|
|
return SendAsync(new byte[length]);
|
|
}
|
|
|
|
protected Task SendPingWithInvalidStreamIdAsync(int streamId)
|
|
{
|
|
Assert.NotEqual(0, streamId);
|
|
|
|
var outputWriter = _pair.Application.Output;
|
|
var pingFrame = new Http2Frame();
|
|
pingFrame.PreparePing(Http2PingFrameFlags.NONE);
|
|
pingFrame.StreamId = streamId;
|
|
Http2FrameWriter.WriteHeader(pingFrame, outputWriter);
|
|
return SendAsync(new byte[pingFrame.PayloadLength]);
|
|
}
|
|
|
|
/* https://tools.ietf.org/html/rfc7540#section-6.3
|
|
+-+-------------------------------------------------------------+
|
|
|E| Stream Dependency (31) |
|
|
+-+-------------+-----------------------------------------------+
|
|
| Weight (8) |
|
|
+-+-------------+
|
|
*/
|
|
protected Task SendPriorityAsync(int streamId, int streamDependency = 0)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var priorityFrame = new Http2Frame();
|
|
priorityFrame.PreparePriority(streamId, streamDependency: streamDependency, exclusive: false, weight: 0);
|
|
|
|
var payload = new byte[priorityFrame.PayloadLength].AsSpan();
|
|
Bitshifter.WriteUInt31BigEndian(payload, (uint)streamDependency);
|
|
payload[4] = 0; // Weight
|
|
|
|
Http2FrameWriter.WriteHeader(priorityFrame, outputWriter);
|
|
return SendAsync(payload);
|
|
}
|
|
|
|
protected Task SendInvalidPriorityFrameAsync(int streamId, int length)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var priorityFrame = new Http2Frame();
|
|
priorityFrame.PreparePriority(streamId, streamDependency: 0, exclusive: false, weight: 0);
|
|
priorityFrame.PayloadLength = length;
|
|
|
|
Http2FrameWriter.WriteHeader(priorityFrame, outputWriter);
|
|
return SendAsync(new byte[length]);
|
|
}
|
|
|
|
/* https://tools.ietf.org/html/rfc7540#section-6.4
|
|
+---------------------------------------------------------------+
|
|
| Error Code (32) |
|
|
+---------------------------------------------------------------+
|
|
*/
|
|
protected Task SendRstStreamAsync(int streamId)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var rstStreamFrame = new Http2Frame();
|
|
rstStreamFrame.PrepareRstStream(streamId, Http2ErrorCode.CANCEL);
|
|
var payload = new byte[rstStreamFrame.PayloadLength];
|
|
BinaryPrimitives.WriteUInt32BigEndian(payload, (uint)Http2ErrorCode.CANCEL);
|
|
|
|
Http2FrameWriter.WriteHeader(rstStreamFrame, outputWriter);
|
|
return SendAsync(payload);
|
|
}
|
|
|
|
protected Task SendInvalidRstStreamFrameAsync(int streamId, int length)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
frame.PrepareRstStream(streamId, Http2ErrorCode.CANCEL);
|
|
frame.PayloadLength = length;
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
return SendAsync(new byte[length]);
|
|
}
|
|
|
|
protected Task SendGoAwayAsync()
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
frame.PrepareGoAway(0, Http2ErrorCode.NO_ERROR);
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
return SendAsync(new byte[frame.PayloadLength]);
|
|
}
|
|
|
|
protected Task SendInvalidGoAwayFrameAsync()
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
frame.PrepareGoAway(0, Http2ErrorCode.NO_ERROR);
|
|
frame.StreamId = 1;
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
return SendAsync(new byte[frame.PayloadLength]);
|
|
}
|
|
|
|
protected Task SendWindowUpdateAsync(int streamId, int sizeIncrement)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
frame.PrepareWindowUpdate(streamId, sizeIncrement);
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
var buffer = outputWriter.GetSpan(4);
|
|
Bitshifter.WriteUInt31BigEndian(buffer, (uint)sizeIncrement);
|
|
outputWriter.Advance(4);
|
|
return FlushAsync(outputWriter);
|
|
}
|
|
|
|
protected Task SendInvalidWindowUpdateAsync(int streamId, int sizeIncrement, int length)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
frame.PrepareWindowUpdate(streamId, sizeIncrement);
|
|
frame.PayloadLength = length;
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
return SendAsync(new byte[length]);
|
|
}
|
|
|
|
protected Task SendUnknownFrameTypeAsync(int streamId, int frameType)
|
|
{
|
|
var outputWriter = _pair.Application.Output;
|
|
var frame = new Http2Frame();
|
|
frame.StreamId = streamId;
|
|
frame.Type = (Http2FrameType)frameType;
|
|
frame.PayloadLength = 0;
|
|
Http2FrameWriter.WriteHeader(frame, outputWriter);
|
|
return FlushAsync(outputWriter);
|
|
}
|
|
|
|
protected async Task<Http2FrameWithPayload> ReceiveFrameAsync(uint maxFrameSize = Http2PeerSettings.DefaultMaxFrameSize)
|
|
{
|
|
var frame = new Http2FrameWithPayload();
|
|
|
|
while (true)
|
|
{
|
|
var result = await _pair.Application.Input.ReadAsync().AsTask().DefaultTimeout();
|
|
var buffer = result.Buffer;
|
|
var consumed = buffer.Start;
|
|
var examined = buffer.Start;
|
|
|
|
try
|
|
{
|
|
Assert.True(buffer.Length > 0);
|
|
|
|
if (Http2FrameReader.ReadFrame(buffer, frame, maxFrameSize, out var framePayload))
|
|
{
|
|
consumed = examined = framePayload.End;
|
|
frame.Payload = framePayload.ToArray();
|
|
return frame;
|
|
}
|
|
else
|
|
{
|
|
examined = buffer.End;
|
|
}
|
|
|
|
if (result.IsCompleted)
|
|
{
|
|
throw new IOException("The reader completed without returning a frame.");
|
|
}
|
|
}
|
|
finally
|
|
{
|
|
_pair.Application.Input.AdvanceTo(consumed, examined);
|
|
}
|
|
}
|
|
}
|
|
|
|
protected async Task<Http2FrameWithPayload> ExpectAsync(Http2FrameType type, int withLength, byte withFlags, int withStreamId)
|
|
{
|
|
var frame = await ReceiveFrameAsync((uint)withLength);
|
|
|
|
Assert.Equal(type, frame.Type);
|
|
Assert.Equal(withLength, frame.PayloadLength);
|
|
Assert.Equal(withFlags, frame.Flags);
|
|
Assert.Equal(withStreamId, frame.StreamId);
|
|
|
|
return frame;
|
|
}
|
|
|
|
protected Task StopConnectionAsync(int expectedLastStreamId, bool ignoreNonGoAwayFrames)
|
|
{
|
|
_pair.Application.Output.Complete();
|
|
|
|
return WaitForConnectionStopAsync(expectedLastStreamId, ignoreNonGoAwayFrames);
|
|
}
|
|
|
|
protected Task WaitForConnectionStopAsync(int expectedLastStreamId, bool ignoreNonGoAwayFrames)
|
|
{
|
|
return WaitForConnectionErrorAsync<Exception>(ignoreNonGoAwayFrames, expectedLastStreamId, Http2ErrorCode.NO_ERROR, expectedErrorMessage: null);
|
|
}
|
|
|
|
protected void VerifyGoAway(Http2Frame frame, int expectedLastStreamId, Http2ErrorCode expectedErrorCode)
|
|
{
|
|
Assert.Equal(Http2FrameType.GOAWAY, frame.Type);
|
|
Assert.Equal(8, frame.PayloadLength);
|
|
Assert.Equal(0, frame.Flags);
|
|
Assert.Equal(0, frame.StreamId);
|
|
Assert.Equal(expectedLastStreamId, frame.GoAwayLastStreamId);
|
|
Assert.Equal(expectedErrorCode, frame.GoAwayErrorCode);
|
|
}
|
|
|
|
protected async Task WaitForConnectionErrorAsync<TException>(bool ignoreNonGoAwayFrames, int expectedLastStreamId, Http2ErrorCode expectedErrorCode, string expectedErrorMessage)
|
|
where TException : Exception
|
|
{
|
|
var frame = await ReceiveFrameAsync();
|
|
|
|
if (ignoreNonGoAwayFrames)
|
|
{
|
|
while (frame.Type != Http2FrameType.GOAWAY)
|
|
{
|
|
frame = await ReceiveFrameAsync();
|
|
}
|
|
}
|
|
|
|
VerifyGoAway(frame, expectedLastStreamId, expectedErrorCode);
|
|
|
|
if (expectedErrorMessage != null)
|
|
{
|
|
var message = Assert.Single(TestApplicationErrorLogger.Messages, m => m.Exception is TException);
|
|
Assert.Contains(expectedErrorMessage, message.Exception.Message);
|
|
}
|
|
|
|
await _connectionTask;
|
|
_pair.Application.Output.Complete();
|
|
}
|
|
|
|
protected async Task WaitForStreamErrorAsync(int expectedStreamId, Http2ErrorCode expectedErrorCode, string expectedErrorMessage)
|
|
{
|
|
var frame = await ReceiveFrameAsync();
|
|
|
|
Assert.Equal(Http2FrameType.RST_STREAM, frame.Type);
|
|
Assert.Equal(4, frame.PayloadLength);
|
|
Assert.Equal(0, frame.Flags);
|
|
Assert.Equal(expectedStreamId, frame.StreamId);
|
|
Assert.Equal(expectedErrorCode, frame.RstStreamErrorCode);
|
|
|
|
if (expectedErrorMessage != null)
|
|
{
|
|
Assert.Contains(TestApplicationErrorLogger.Messages, m => m.Exception?.Message.Contains(expectedErrorMessage) ?? false);
|
|
}
|
|
}
|
|
|
|
protected void VerifyDecodedRequestHeaders(IEnumerable<KeyValuePair<string, string>> expectedHeaders)
|
|
{
|
|
foreach (var header in expectedHeaders)
|
|
{
|
|
Assert.True(_receivedHeaders.TryGetValue(header.Key, out var value), header.Key);
|
|
Assert.Equal(header.Value, value, ignoreCase: true);
|
|
}
|
|
}
|
|
|
|
public class Http2FrameWithPayload : Http2Frame
|
|
{
|
|
public Http2FrameWithPayload() : base()
|
|
{
|
|
}
|
|
|
|
// This does not contain extended headers
|
|
public Memory<byte> Payload { get; set; }
|
|
|
|
public ReadOnlySequence<byte> PayloadSequence => new ReadOnlySequence<byte>(Payload);
|
|
}
|
|
}
|
|
}
|