Skip to content

Have kestrel filter out pseudo headers #36166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 8, 2021
Merged

Have kestrel filter out pseudo headers #36166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 88 additions & 11 deletions src/Servers/Kestrel/Core/src/Internal/Http/HttpHeaders.Generated.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,14 @@ public override StringValues HeaderConnection
}
set
{
_bits |= 0x2L;
if (!StringValues.IsNullOrEmpty(value))
{
_bits |= 0x2L;
}
else
{
_bits &= ~0x2L;
}
_headers._Connection = value;
}
}
Expand All @@ -244,7 +251,14 @@ public StringValues HeaderHost
}
set
{
_bits |= 0x4L;
if (!StringValues.IsNullOrEmpty(value))
{
_bits |= 0x4L;
}
else
{
_bits &= ~0x4L;
}
_headers._Host = value;
}
}
Expand All @@ -261,7 +275,14 @@ public StringValues HeaderAuthority
}
set
{
_bits |= 0x10L;
if (!StringValues.IsNullOrEmpty(value))
{
_bits |= 0x10L;
}
else
{
_bits &= ~0x10L;
}
_headers._Authority = value;
}
}
Expand All @@ -278,7 +299,14 @@ public StringValues HeaderMethod
}
set
{
_bits |= 0x20L;
if (!StringValues.IsNullOrEmpty(value))
{
_bits |= 0x20L;
}
else
{
_bits &= ~0x20L;
}
_headers._Method = value;
}
}
Expand All @@ -295,7 +323,14 @@ public StringValues HeaderPath
}
set
{
_bits |= 0x40L;
if (!StringValues.IsNullOrEmpty(value))
{
_bits |= 0x40L;
}
else
{
_bits &= ~0x40L;
}
_headers._Path = value;
}
}
Expand All @@ -312,7 +347,14 @@ public StringValues HeaderScheme
}
set
{
_bits |= 0x80L;
if (!StringValues.IsNullOrEmpty(value))
{
_bits |= 0x80L;
}
else
{
_bits &= ~0x80L;
}
_headers._Scheme = value;
}
}
Expand All @@ -329,7 +371,14 @@ public StringValues HeaderTransferEncoding
}
set
{
_bits |= 0x20000000000L;
if (!StringValues.IsNullOrEmpty(value))
{
_bits |= 0x20000000000L;
}
else
{
_bits &= ~0x20000000000L;
}
_headers._TransferEncoding = value;
}
}
Expand Down Expand Up @@ -8234,7 +8283,14 @@ public override StringValues HeaderConnection
}
set
{
_bits |= 0x1L;
if (!StringValues.IsNullOrEmpty(value))
{
_bits |= 0x1L;
}
else
{
_bits &= ~0x1L;
}
_headers._Connection = value;
_headers._rawConnection = null;
}
Expand All @@ -8252,7 +8308,14 @@ public StringValues HeaderAllow
}
set
{
_bits |= 0x1000L;
if (!StringValues.IsNullOrEmpty(value))
{
_bits |= 0x1000L;
}
else
{
_bits &= ~0x1000L;
}
_headers._Allow = value;
}
}
Expand All @@ -8269,7 +8332,14 @@ public StringValues HeaderAltSvc
}
set
{
_bits |= 0x2000L;
if (!StringValues.IsNullOrEmpty(value))
{
_bits |= 0x2000L;
}
else
{
_bits &= ~0x2000L;
}
_headers._AltSvc = value;
_headers._rawAltSvc = null;
}
Expand All @@ -8287,7 +8357,14 @@ public StringValues HeaderTransferEncoding
}
set
{
_bits |= 0x100000000L;
if (!StringValues.IsNullOrEmpty(value))
{
_bits |= 0x100000000L;
}
else
{
_bits &= ~0x100000000L;
}
_headers._TransferEncoding = value;
_headers._rawTransferEncoding = null;
}
Expand Down
6 changes: 5 additions & 1 deletion src/Servers/Kestrel/Core/src/Internal/Http2/Http2Stream.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,13 +248,14 @@ private bool TryValidatePseudoHeaders()
// enabling the use of HTTP to interact with non - HTTP services.
// A common example is TLS termination.
var headerScheme = HttpRequestHeaders.HeaderScheme.ToString();
HttpRequestHeaders.HeaderScheme = default; // Suppress pseduo headers from the public headers collection.
if (!ReferenceEquals(headerScheme, Scheme) &&
!string.Equals(headerScheme, Scheme, StringComparison.OrdinalIgnoreCase))
{
if (!ServerOptions.AllowAlternateSchemes || !Uri.CheckSchemeName(headerScheme))
{
ResetAndAbort(new ConnectionAbortedException(
CoreStrings.FormatHttp2StreamErrorSchemeMismatch(HttpRequestHeaders.HeaderScheme, Scheme)), Http2ErrorCode.PROTOCOL_ERROR);
CoreStrings.FormatHttp2StreamErrorSchemeMismatch(headerScheme, Scheme)), Http2ErrorCode.PROTOCOL_ERROR);
return false;
}

Expand All @@ -264,6 +265,7 @@ private bool TryValidatePseudoHeaders()
// :path (and query) - Required
// Must start with / except may be * for OPTIONS
var path = HttpRequestHeaders.HeaderPath.ToString();
HttpRequestHeaders.HeaderPath = default; // Suppress pseduo headers from the public headers collection.
RawTarget = path;

// OPTIONS - https://tools.ietf.org/html/rfc7540#section-8.1.2.3
Expand Down Expand Up @@ -301,6 +303,7 @@ private bool TryValidateMethod()
{
// :method
_methodText = HttpRequestHeaders.HeaderMethod.ToString();
HttpRequestHeaders.HeaderMethod = default; // Suppress pseduo headers from the public headers collection.
Copy link
Member Author

@Tratcher Tratcher Apr 24, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We identified a bug with this approach in 6.0. On line 221 above, TryValidateMethod is skipped if the method was sent via static hpack index. That means we fail to remove it from the collection.

#38581 fixed this in inadvertently in 7.0 by bulk clearing the set bits in the collection itself rather than clearing the individual properties.

Method = HttpUtilities.GetKnownMethod(_methodText);

if (Method == HttpMethod.None)
Expand All @@ -327,6 +330,7 @@ private bool TryValidateAuthorityAndHost(out string hostText)
// Prefer this over Host

var authority = HttpRequestHeaders.HeaderAuthority;
HttpRequestHeaders.HeaderAuthority = default; // Suppress pseduo headers from the public headers collection.
var host = HttpRequestHeaders.HeaderHost;
if (!StringValues.IsNullOrEmpty(authority))
{
Expand Down
12 changes: 8 additions & 4 deletions src/Servers/Kestrel/Core/src/Internal/Http3/Http3Stream.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -787,12 +787,13 @@ private bool TryValidatePseudoHeaders()
// proxy or gateway can translate requests for non - HTTP schemes,
// enabling the use of HTTP to interact with non - HTTP services.
var headerScheme = HttpRequestHeaders.HeaderScheme.ToString();
HttpRequestHeaders.HeaderScheme = default; // Suppress pseduo headers from the public headers collection.
if (!ReferenceEquals(headerScheme, Scheme) &&
!string.Equals(headerScheme, Scheme, StringComparison.OrdinalIgnoreCase))
{
if (!ServerOptions.AllowAlternateSchemes || !Uri.CheckSchemeName(headerScheme))
{
var str = CoreStrings.FormatHttp3StreamErrorSchemeMismatch(RequestHeaders[HeaderNames.Scheme], Scheme);
var str = CoreStrings.FormatHttp3StreamErrorSchemeMismatch(headerScheme, Scheme);
Abort(new ConnectionAbortedException(str), Http3ErrorCode.ProtocolError);
return false;
}
Expand All @@ -802,7 +803,8 @@ private bool TryValidatePseudoHeaders()

// :path (and query) - Required
// Must start with / except may be * for OPTIONS
var path = RequestHeaders[HeaderNames.Path].ToString();
var path = HttpRequestHeaders.HeaderPath.ToString();
HttpRequestHeaders.HeaderPath = default; // Suppress pseduo headers from the public headers collection.
RawTarget = path;

// OPTIONS - https://tools.ietf.org/html/rfc7540#section-8.1.2.3
Expand Down Expand Up @@ -840,7 +842,8 @@ private bool TryValidatePseudoHeaders()
private bool TryValidateMethod()
{
// :method
_methodText = RequestHeaders[HeaderNames.Method].ToString();
_methodText = HttpRequestHeaders.HeaderMethod.ToString();
HttpRequestHeaders.HeaderMethod = default; // Suppress pseduo headers from the public headers collection.
Method = HttpUtilities.GetKnownMethod(_methodText);

if (Method == Http.HttpMethod.None)
Expand All @@ -866,7 +869,8 @@ private bool TryValidateAuthorityAndHost(out string hostText)
// :authority (optional)
// Prefer this over Host

var authority = RequestHeaders[HeaderNames.Authority];
var authority = HttpRequestHeaders.HeaderAuthority;
HttpRequestHeaders.HeaderAuthority = default; // Suppress pseduo headers from the public headers collection.
var host = HttpRequestHeaders.HeaderHost;
if (!StringValues.IsNullOrEmpty(authority))
{
Expand Down
9 changes: 8 additions & 1 deletion src/Servers/Kestrel/shared/KnownHeaders.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -843,7 +843,14 @@ internal partial class {loop.ClassName} : IHeaderDictionary
}}
set
{{
{header.SetBit()};
if (!StringValues.IsNullOrEmpty(value))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an existing bug in .NET 6 being fixed right?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this particular change go into 6.0 RC2?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, and yes I plan to backport this entire PR to rc2.

{{
{header.SetBit()};
}}
else
{{
{header.ClearBit()};
}}
_headers._{header.Identifier} = value; {(header.EnhancedSetter == false ? "" : $@"
_headers._raw{header.Identifier} = null;")}
}}")}
Expand Down
1 change: 1 addition & 0 deletions src/Servers/Kestrel/test/InMemory.FunctionalTests/Http2/Http2StreamTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,7 @@ public async Task HEADERS_Received_SchemeMismatchAllowed_Processed(string scheme
await InitializeConnectionAsync(context =>
{
Assert.Equal(scheme, context.Request.Scheme);
Assert.False(context.Request.Headers.ContainsKey(HeaderNames.Scheme));
return Task.CompletedTask;
});

Expand Down
44 changes: 42 additions & 2 deletions src/Servers/Kestrel/test/InMemory.FunctionalTests/Http2/Http2TestBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ protected static IEnumerable<KeyValuePair<string, string>> ReadRateRequestHeader
protected readonly Dictionary<string, string> _receivedHeaders = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
protected readonly Dictionary<string, string> _receivedTrailers = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
protected readonly Dictionary<string, string> _decodedHeaders = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
protected readonly RequestFields _receivedRequestFields = new RequestFields();
protected readonly HashSet<int> _abortedStreamIds = new HashSet<int>();
protected readonly object _abortedStreamIdsLock = new object();
protected readonly TaskCompletionSource _closingStateReached = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
Expand Down Expand Up @@ -195,6 +196,10 @@ public Http2TestBase()

_readHeadersApplication = context =>
{
_receivedRequestFields.Method = context.Request.Method;
_receivedRequestFields.Scheme = context.Request.Scheme;
_receivedRequestFields.Path = context.Request.Path.Value;
_receivedRequestFields.RawTarget = context.Features.Get<IHttpRequestFeature>().RawTarget;
foreach (var header in context.Request.Headers)
{
_receivedHeaders[header.Key] = header.Value.ToString();
Expand All @@ -217,6 +222,10 @@ public Http2TestBase()
Assert.True(context.Request.SupportsTrailers(), "SupportsTrailers");
Assert.True(context.Request.CheckTrailersAvailable(), "SupportsTrailers");

_receivedRequestFields.Method = context.Request.Method;
_receivedRequestFields.Scheme = context.Request.Scheme;
_receivedRequestFields.Path = context.Request.Path.Value;
_receivedRequestFields.RawTarget = context.Features.Get<IHttpRequestFeature>().RawTarget;
foreach (var header in context.Request.Headers)
{
_receivedHeaders[header.Key] = header.Value.ToString();
Expand Down Expand Up @@ -350,20 +359,23 @@ public Http2TestBase()
_echoMethodNoBody = context =>
{
Assert.False(context.Request.CanHaveBody());
Assert.False(context.Request.Headers.ContainsKey(HeaderNames.Method));
context.Response.Headers["Method"] = context.Request.Method;

return Task.CompletedTask;
};

_echoHost = context =>
{
Assert.False(context.Request.Headers.ContainsKey(HeaderNames.Authority));
context.Response.Headers.Host = context.Request.Headers.Host;

return Task.CompletedTask;
};

_echoPath = context =>
{
Assert.False(context.Request.Headers.ContainsKey(HeaderNames.Path));
context.Response.Headers["path"] = context.Request.Path.ToString();
context.Response.Headers["rawtarget"] = context.Features.Get<IHttpRequestFeature>().RawTarget;

Expand Down Expand Up @@ -1240,8 +1252,28 @@ protected void VerifyDecodedRequestHeaders(IEnumerable<KeyValuePair<string, stri
{
foreach (var header in expectedHeaders)
{
Assert.True(_receivedHeaders.TryGetValue(header.Key, out var value), header.Key);
Assert.Equal(header.Value, value, ignoreCase: true);
if (header.Key == HeaderNames.Method)
{
Assert.Equal(header.Value, _receivedRequestFields.Method);
}
else if (header.Key == HeaderNames.Authority)
{
Assert.True(_receivedHeaders.TryGetValue(HeaderNames.Host, out var host), header.Key);
Assert.Equal(header.Value, host);
}
else if (header.Key == HeaderNames.Scheme)
{
Assert.Equal(header.Value, _receivedRequestFields.Scheme);
}
else if (header.Key == HeaderNames.Path)
{
Assert.Equal(header.Value, _receivedRequestFields.RawTarget);
}
else
{
Assert.True(_receivedHeaders.TryGetValue(header.Key, out var value), header.Key);
Assert.Equal(header.Value, value, ignoreCase: true);
}
}
}

Expand Down Expand Up @@ -1390,5 +1422,13 @@ public long GetResponseDrainDeadline(long ticks, MinDataRate minRate)
return _realTimeoutControl.GetResponseDrainDeadline(ticks, minRate);
}
}

public class RequestFields
{
public string Method { get; set; }
public string Scheme { get; set; }
public string Path { get; set; }
public string RawTarget { get; set; }
}
}
}