Skip to content
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

Jump to bottom

Update NotContains match mode for Header and QueryParameters to support missing/empty values #2258

Merged
merged 6 commits into from
Sep 26, 2023
Merged

Update NotContains match mode for Header and QueryParameters to support missing/empty values #2258

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e9df128
handle empty query param value
evmurphy Sep 21, 2023
17d0d79
header match logic
evmurphy Sep 21, 2023
3fc75ba
more readable
evmurphy Sep 21, 2023
2578ae3
readable query logic
evmurphy Sep 22, 2023
aab51d7
leave NotExists logic unchanged
evmurphy Sep 26, 2023
e356ec7
Turn matching logic into a switch expression
MihaZupan Sep 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
62 changes: 44 additions & 18 deletions src/ReverseProxy/Routing/HeaderMatcherPolicy.cs
View file
Open in desktop
Expand Up @@ -70,28 +70,54 @@ public Task ApplyAsync(HttpContext httpContext, CandidateSet candidates)

foreach (var matcher in matchers)
{
var headerExistsInRequest = headers.TryGetValue(matcher.Name, out var requestHeaderValues);
if (headerExistsInRequest && !StringValues.IsNullOrEmpty(requestHeaderValues))
{
if (matcher.Mode is HeaderMatchMode.Exists)
{
continue;
}
var keyExists = headers.TryGetValue(matcher.Name, out var requestHeaderValues);
var valueIsEmpty = StringValues.IsNullOrEmpty(requestHeaderValues);

if (matcher.Mode is HeaderMatchMode.NotExists)
{
candidates.SetValidity(i, false);
var matched = false;
switch(matcher.Mode)
{
case HeaderMatchMode.Exists:
if (keyExists && !valueIsEmpty)
{
matched = true;
}
break;
}
case HeaderMatchMode.NotExists:
if (!keyExists || valueIsEmpty)
{
matched = true;
}
break;
case HeaderMatchMode.ExactHeader:
case HeaderMatchMode.HeaderPrefix:
if (keyExists && !valueIsEmpty)
{
matched = TryMatchExactOrPrefix(matcher, requestHeaderValues);
}
break;
case HeaderMatchMode.Contains:
if (keyExists && !valueIsEmpty)
{
matched = TryMatchContainsOrNotContains(matcher, requestHeaderValues);
}
break;
case HeaderMatchMode.NotContains:
if (keyExists && !valueIsEmpty)
{
matched = TryMatchContainsOrNotContains(matcher, requestHeaderValues);
}
else
{
matched = true;
}

if (matcher.Mode is HeaderMatchMode.ExactHeader or HeaderMatchMode.HeaderPrefix
? TryMatchExactOrPrefix(matcher, requestHeaderValues)
: TryMatchContainsOrNotContains(matcher, requestHeaderValues))
{
continue;
}
break;
default:
matched = false;
break;
}
else if (matcher.Mode is HeaderMatchMode.NotExists && !headerExistsInRequest)

if (matched)
{
continue;
}
Expand Down
48 changes: 37 additions & 11 deletions src/ReverseProxy/Routing/QueryParameterMatcherPolicy.cs
View file
Open in desktop
Expand Up @@ -69,18 +69,44 @@ public Task ApplyAsync(HttpContext httpContext, CandidateSet candidates)

foreach (var matcher in matchers)
{
if (query.TryGetValue(matcher.Name, out var requestQueryParameterValues) &&
!StringValues.IsNullOrEmpty(requestQueryParameterValues))
var keyExists = query.TryGetValue(matcher.Name, out var requestQueryParameterValues);
var valueIsEmpty = StringValues.IsNullOrEmpty(requestQueryParameterValues);

var matched = false;
switch (matcher.Mode)
{
case QueryParameterMatchMode.Exists:
if (keyExists && !valueIsEmpty)
{
matched = true;
}
break;
case QueryParameterMatchMode.Exact:
case QueryParameterMatchMode.Prefix:
case QueryParameterMatchMode.Contains:
if (keyExists && !valueIsEmpty)
{
matched = TryMatch(matcher, requestQueryParameterValues);
}
break;
case QueryParameterMatchMode.NotContains:
if (keyExists && !valueIsEmpty)
{
matched = TryMatch(matcher, requestQueryParameterValues);
}
else
{
matched = true;
}
break;
default:
matched = false;
break;
}

if (matched)
{
if (matcher.Mode is QueryParameterMatchMode.Exists)
{
continue;
}

if (TryMatch(matcher, requestQueryParameterValues))
{
continue;
}
continue;
}

candidates.SetValidity(i, false);
Expand Down
52 changes: 45 additions & 7 deletions test/ReverseProxy.Tests/Routing/HeaderMatcherPolicyTests.cs
View file
Open in desktop
Expand Up @@ -154,7 +154,7 @@ public void AppliesToEndpoints_NoMetadata_DoesNotApply()
[InlineData("", HeaderMatchMode.Exists, false)]
[InlineData("abc", HeaderMatchMode.Exists, true)]
[InlineData(null, HeaderMatchMode.NotExists, true)]
[InlineData("", HeaderMatchMode.NotExists, false)]
[InlineData("", HeaderMatchMode.NotExists, true)]
MihaZupan marked this conversation as resolved.
Show resolved Hide resolved
[InlineData("abc", HeaderMatchMode.NotExists, false)]
public async Task ApplyAsync_MatchingScenarios_AnyHeaderValue(string incomingHeaderValue, HeaderMatchMode mode, bool shouldMatch)
{
Expand Down Expand Up @@ -276,12 +276,14 @@ public async Task ApplyAsync_MatchingScenarios_AnyHeaderValue(string incomingHea
[InlineData("abc", HeaderMatchMode.Contains, false, "abc\"", true)]
[InlineData("abc", HeaderMatchMode.Contains, false, "\"abc\"", true)]
[InlineData("abc", HeaderMatchMode.Contains, false, "ab\"c", false)]
[InlineData("abc", HeaderMatchMode.NotContains, false, "", false)]
[InlineData("abc", HeaderMatchMode.NotContains, false, null, true)]
[InlineData("abc", HeaderMatchMode.NotContains, false, "", true)]
[InlineData("abc", HeaderMatchMode.NotContains, false, "ababc", false)]
[InlineData("abc", HeaderMatchMode.NotContains, false, "zaBCz", false)]
[InlineData("abc", HeaderMatchMode.NotContains, false, "dcbaabcd", false)]
[InlineData("abc", HeaderMatchMode.NotContains, false, "ababab", true)]
[InlineData("abc", HeaderMatchMode.NotContains, true, "", false)]
[InlineData("abc", HeaderMatchMode.NotContains, true, null, true)]
[InlineData("abc", HeaderMatchMode.NotContains, true, "", true)]
[InlineData("abc", HeaderMatchMode.NotContains, true, "abcc", false)]
[InlineData("abc", HeaderMatchMode.NotContains, true, "aaaBC", true)]
[InlineData("abc", HeaderMatchMode.NotContains, true, "bbabcdb", false)]
Expand Down Expand Up @@ -412,16 +414,16 @@ public async Task ApplyAsync_MatchingScenarios_AnyHeaderValue(string incomingHea
[InlineData("abc", "def", HeaderMatchMode.Contains, true, "\"abc, def\"", true)]
[InlineData("abc", "def", HeaderMatchMode.Contains, true, "\"abc\", def\"", true)]
[InlineData("abc", "def", HeaderMatchMode.Contains, true, "ab\"cde\"f", false)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, false, null, false)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, false, "", false)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, false, null, true)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, false, "", true)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, false, "aabc", false)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, false, "baBc", false)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, false, "ababcd", false)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, false, "dcabcD", false)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, false, "def", false)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, false, "ghi", true)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, true, null, false)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, true, "", false)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, true, null, true)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, true, "", true)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, true, "cabca", false)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, true, "aBCa", true)]
[InlineData("abc", "def", HeaderMatchMode.NotContains, true, "CaBCdd", true)]
Expand Down Expand Up @@ -461,6 +463,42 @@ public async Task ApplyAsync_MatchingScenarios_AnyHeaderValue(string incomingHea
Assert.Equal(shouldMatch, candidates.IsValidCandidate(0));
}

[Theory]
[InlineData(HeaderMatchMode.Contains, true, false)]
[InlineData(HeaderMatchMode.Contains, false, false)]
[InlineData(HeaderMatchMode.NotContains, true, true)]
[InlineData(HeaderMatchMode.NotContains, false, true)]
[InlineData(HeaderMatchMode.HeaderPrefix, true, false)]
[InlineData(HeaderMatchMode.HeaderPrefix, false, false)]
[InlineData(HeaderMatchMode.ExactHeader, true, false)]
[InlineData(HeaderMatchMode.ExactHeader, false, false)]
[InlineData(HeaderMatchMode.NotExists, true, true)]
[InlineData(HeaderMatchMode.NotExists, false, true)]
[InlineData(HeaderMatchMode.Exists, true, false)]
[InlineData(HeaderMatchMode.Exists, false, false)]
public async Task ApplyAsync_MatchingScenarios_MissingHeader(
HeaderMatchMode headerValueMatchMode,
bool isCaseSensitive,
bool shouldMatch)
{
var context = new DefaultHttpContext();

var headerValues = new[] { "bar" };
if (headerValueMatchMode == HeaderMatchMode.Exists
|| headerValueMatchMode == HeaderMatchMode.NotExists)
{
headerValues = null;
}

var endpoint = CreateEndpoint("foo", headerValues, headerValueMatchMode, isCaseSensitive);
var candidates = new CandidateSet(new[] { endpoint }, new RouteValueDictionary[1], new int[1]);
var sut = new HeaderMatcherPolicy();

await sut.ApplyAsync(context, candidates);

Assert.Equal(shouldMatch, candidates.IsValidCandidate(0));
}

[Theory]
[InlineData("Foo", "abc", HeaderMatchMode.ExactHeader, "ab, abc", true)]
[InlineData("Foo", "abc", HeaderMatchMode.ExactHeader, "ab; abc", false)]
Expand Down
51 changes: 45 additions & 6 deletions test/ReverseProxy.Tests/Routing/QueryMatcherPolicyTests.cs
View file
Open in desktop
Expand Up @@ -214,12 +214,12 @@ public async Task ApplyAsync_MatchingScenarios_AnyQueryParamValue(string incomin
[InlineData("abc", QueryParameterMatchMode.Prefix, true, "abcd", true)]
[InlineData("abc", QueryParameterMatchMode.Prefix, true, "aBCd", false)]
[InlineData("abc", QueryParameterMatchMode.Prefix, true, "ab", false)]
[InlineData("abc", QueryParameterMatchMode.NotContains, false, "", false)]
[InlineData("abc", QueryParameterMatchMode.NotContains, false, "", true)]
[InlineData("abc", QueryParameterMatchMode.NotContains, false, "aabc", false)]
[InlineData("abc", QueryParameterMatchMode.NotContains, false, "zaBCz", false)]
[InlineData("abc", QueryParameterMatchMode.NotContains, false, "sabcd", false)]
[InlineData("abc", QueryParameterMatchMode.NotContains, false, "aaab", true)]
[InlineData("abc", QueryParameterMatchMode.NotContains, true, "", false)]
[InlineData("abc", QueryParameterMatchMode.NotContains, true, "", true)]
[InlineData("abc", QueryParameterMatchMode.NotContains, true, "abcaa", false)]
[InlineData("abc", QueryParameterMatchMode.NotContains, true, "cbcaBC", true)]
[InlineData("abc", QueryParameterMatchMode.NotContains, true, "ababcd", false)]
Expand Down Expand Up @@ -325,7 +325,7 @@ public async Task ApplyAsync_MatchingScenarios_AnyQueryParamValue(string incomin
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, false, "aaa", true)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, false, "Abc", false)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, false, "def", false)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, false, "", false)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, false, "", true)]
[InlineData("abc", "def", QueryParameterMatchMode.Contains, true, "cabca", true)]
[InlineData("abc", "def", QueryParameterMatchMode.Contains, true, "aBCa", false)]
[InlineData("abc", "def", QueryParameterMatchMode.Contains, true, "CaBCdd", false)]
Expand All @@ -343,17 +343,17 @@ public async Task ApplyAsync_MatchingScenarios_AnyQueryParamValue(string incomin
[InlineData("abc", "ABC", QueryParameterMatchMode.Contains, true, "ABC;d", true)]
[InlineData("abc", "ABC", QueryParameterMatchMode.Contains, true, "abC;d", false)]
[InlineData("abc", "ABC", QueryParameterMatchMode.Contains, true, "abcABC;d", true)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, false, null, false)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, false, null, true)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, true, "aaa", true)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, true, "Abc", true)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, true, "def", false)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, true, "", false)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, true, "", true)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, false, "aabc", false)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, false, "baBc", false)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, false, "ababcd", false)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, false, "dcabcD", false)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, false, "ghi", true)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, true, null, false)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, true, null, true)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, true, "cabca", false)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, true, "aBCa", true)]
[InlineData("abc", "def", QueryParameterMatchMode.NotContains, true, "CaBCdd", true)]
Expand Down Expand Up @@ -394,6 +394,45 @@ public async Task ApplyAsync_MatchingScenarios_AnyQueryParamValue(string incomin
Assert.Equal(shouldMatch, candidates.IsValidCandidate(0));
}

/// <summary>
/// Test each match mode where the matched query param is non-existent in the request querystring.
/// </summary>
/// <param name="queryParamValueMatchMode">Match mode.</param>
/// <param name="isCaseSensitive">Test case sensitivity</param>
/// <param name="shouldMatch">Expected match result.</param>
[Theory]
[InlineData(QueryParameterMatchMode.NotContains, true, true)]
[InlineData(QueryParameterMatchMode.NotContains, false, true)]
[InlineData(QueryParameterMatchMode.Exists, true, false)]
[InlineData(QueryParameterMatchMode.Exists, false, false)]
[InlineData(QueryParameterMatchMode.Contains, true, false)]
[InlineData(QueryParameterMatchMode.Contains, false, false)]
[InlineData(QueryParameterMatchMode.Exact, true, false)]
[InlineData(QueryParameterMatchMode.Exact, false, false)]
[InlineData(QueryParameterMatchMode.Prefix, true, false)]
[InlineData(QueryParameterMatchMode.Prefix, false, false)]
public async Task ApplyAsync_MatchingScenarios_MissingParam(
QueryParameterMatchMode queryParamValueMatchMode,
bool isCaseSensitive,
bool shouldMatch)
{
var context = new DefaultHttpContext();

var queryParamValues = new[] { "bar" };
if (queryParamValueMatchMode == QueryParameterMatchMode.Exists)
{
queryParamValues = null;
}

var endpoint = CreateEndpoint("foo", queryParamValues, queryParamValueMatchMode, isCaseSensitive);
var candidates = new CandidateSet(new[] { endpoint }, new RouteValueDictionary[1], new int[1]);
var sut = new QueryParameterMatcherPolicy();

await sut.ApplyAsync(context, candidates);

Assert.Equal(shouldMatch, candidates.IsValidCandidate(0));
}

[Theory]
[InlineData(false, false, false)]
[InlineData(false, true, false)]
Expand Down