starred/WireMock.Net-wiremock
1
0
Fork 0
mirror of https://github.com/wiremock/WireMock.Net.git synced 2026-07-31 09:18:46 +02:00
Code Issues 32 Packages Projects Releases 10 Wiki Activity

Bug: Path matching fails when the URL contains encoded parts #128

New Issue
Closed
opened 2025-12-29 14:23:16 +01:00 by adam · 9 comments
adam commented 2025-12-29 14:23:16 +01:00
Owner
Copy Link
Copy Source

Originally created by @chrischu on GitHub (Aug 10, 2018).

When setting up a path matcher with a string containing URL-encoded values (e.g. Request.Create().UsingGet().WithPath("/path/a%20b")) the path matching no longer works. When looking at the request log in the FluentMockServer one can see that the request found does have the unencoded request URL ("/path/a b" instead of "/path/a%20b") and therefore the match isn't successful.

This seems to be due to a problem with OWIN decoding the URL (see https://github.com/aspnet/AspNetKatana/issues/208). This bug seems to no longer exist when using ASP.NET Core instead of OWIN, so switching to ASP.NET Core hosting would be a way to fix it, albeit a pretty expensive one I assume.

Originally created by @chrischu on GitHub (Aug 10, 2018). When setting up a path matcher with a string containing URL-encoded values (e.g. `Request.Create().UsingGet().WithPath("/path/a%20b")`) the path matching no longer works. When looking at the request log in the FluentMockServer one can see that the request found does have the unencoded request URL ("/path/a b" instead of "/path/a%20b") and therefore the match isn't successful. This seems to be due to a problem with OWIN decoding the URL (see https://github.com/aspnet/AspNetKatana/issues/208). This bug seems to no longer exist when using ASP.NET Core instead of OWIN, so switching to ASP.NET Core hosting would be a way to fix it, albeit a pretty expensive one I assume.
adam added the questionbug labels 2025-12-29 14:23:16 +01:00
adam closed this issue 2025-12-29 14:23:16 +01:00
adam commented 2025-12-29 14:23:17 +01:00
Author
Owner
Copy Link
Copy Source

@StefH commented on GitHub (Aug 10, 2018):

Currently OWIN is only used for net452 and net46. For netstandard1.3 and 2.0, Microsoft.AspNetCore is used.

Or do you mean something else?

@StefH commented on GitHub (Aug 10, 2018): Currently OWIN is only used for net452 and net46. For netstandard1.3 and 2.0, `Microsoft.AspNetCore` is used. Or do you mean something else?
adam commented 2025-12-29 14:23:17 +01:00
Author
Owner
Copy Link
Copy Source

@chrischu commented on GitHub (Aug 12, 2018):

Mhh I created a repro sample with .NET 4.7.2 that reproduces the problem: In the program I call the URL "/A%2fB" but WireMock.Net logs the call as "/A/B". When looking at the loaded modules in Debug mode it is also plainly visible that OWIN is used:
image

Am I doing something wrong?

After some more trials: Interestingly enough even when using "/A%252fB" as URL (%25 = URL-encoded %) the recorded URL is "/A/B" so OWIN seems to double-unencode the string. When using "/A%25252fB" the recorded URL is "/A%2fB" so the unencoding seems to stop at twice.

WireMockRepro.zip

@chrischu commented on GitHub (Aug 12, 2018): Mhh I created a repro sample with .NET 4.7.2 that reproduces the problem: In the program I call the URL "/A%2fB" but WireMock.Net logs the call as "/A/B". When looking at the loaded modules in Debug mode it is also plainly visible that OWIN is used: ![image](https://user-images.githubusercontent.com/447251/44005602-2210707c-9e76-11e8-8045-b85d17bbf674.png) Am I doing something wrong? After some more trials: Interestingly enough even when using "/A%252fB" as URL (%25 = URL-encoded %) the recorded URL is "/A/B" so OWIN seems to double-unencode the string. When using "/A%25252fB" the recorded URL is "/A%2fB" so the unencoding seems to stop at twice. [WireMockRepro.zip](https://github.com/WireMock-Net/WireMock.Net/files/2281258/WireMockRepro.zip)
adam commented 2025-12-29 14:23:18 +01:00
Author
Owner
Copy Link
Copy Source

@StefH commented on GitHub (Aug 13, 2018):

Currently OWIN is used for net452.

And because net 4.6.x and net 4.7.x fallback to this framework, the OWIN code is also used in your application.

I did a quick test with net 461, and it seems I can use the latest Microsoft.AspNetCore (version 2.x.x) there.

So I'll update WireMock.Net to use Microsoft.AspNetCore from 4.6.1 and up.

And for net452, maybe apply a hotfix / patch?

@StefH commented on GitHub (Aug 13, 2018): > Currently OWIN is used for net452. And because net 4.6.x and net 4.7.x fallback to this framework, the OWIN code is also used in your application. I did a quick test with net 461, and it seems I can use the latest Microsoft.AspNetCore (version 2.x.x) there. So I'll update WireMock.Net to use Microsoft.AspNetCore from 4.6.1 and up. And for net452, maybe apply a hotfix / patch?
adam commented 2025-12-29 14:23:19 +01:00
Author
Owner
Copy Link
Copy Source

@StefH commented on GitHub (Aug 16, 2018):

I fixed the code to use Microsoft.AspNetCore (for net461 and up) and I tried to reproduce your problem with these tests:

[Fact] //: TODO : this test fails???
public void Request_WithPath_EncodedSpaces()
{
    // Assign
    var spec = Request.Create().WithPath("/path/a b").UsingAnyMethod();

    // when
    var body = new BodyData();
    var request = new RequestMessage(new UrlDetails("http://localhost/path/a%2fb"), "GET", ClientIp, body);

    // then
    var requestMatchResult = new RequestMatchResult();
    Check.That(spec.GetMatchingScore(request, requestMatchResult)).IsEqualTo(1.0);
}

[Fact]
public void Request_WithPath_Spaces()
{
    // Assign
    var spec = Request.Create().WithPath("/path/a b").UsingAnyMethod();

    // when
    var body = new BodyData();
    var request = new RequestMessage(new UrlDetails("http://localhost/path/a b"), "GET", ClientIp, body);

    // then
    var requestMatchResult = new RequestMatchResult();
    Check.That(spec.GetMatchingScore(request, requestMatchResult)).IsEqualTo(1.0);
}

However I need some help from you to give me correct examples + expectations. Because now the Request_WithPath_EncodedSpaces still fails.

@StefH commented on GitHub (Aug 16, 2018): I fixed the code to use `Microsoft.AspNetCore` (for net461 and up) and I tried to reproduce your problem with these tests: ``` c# [Fact] //: TODO : this test fails??? public void Request_WithPath_EncodedSpaces() { // Assign var spec = Request.Create().WithPath("/path/a b").UsingAnyMethod(); // when var body = new BodyData(); var request = new RequestMessage(new UrlDetails("http://localhost/path/a%2fb"), "GET", ClientIp, body); // then var requestMatchResult = new RequestMatchResult(); Check.That(spec.GetMatchingScore(request, requestMatchResult)).IsEqualTo(1.0); } [Fact] public void Request_WithPath_Spaces() { // Assign var spec = Request.Create().WithPath("/path/a b").UsingAnyMethod(); // when var body = new BodyData(); var request = new RequestMessage(new UrlDetails("http://localhost/path/a b"), "GET", ClientIp, body); // then var requestMatchResult = new RequestMatchResult(); Check.That(spec.GetMatchingScore(request, requestMatchResult)).IsEqualTo(1.0); } ``` However I need some help from you to give me correct examples + expectations. Because now the `Request_WithPath_EncodedSpaces` still fails.
adam commented 2025-12-29 14:23:19 +01:00
Author
Owner
Copy Link
Copy Source

@chrischu commented on GitHub (Aug 16, 2018):

Cool!

I think that Request_WithPath_EncodedSpaces fails is to be expected. I don't expect it to work. The only case I expect to work is when at both ends the space is encoded (or not encoded like in the other test), like this:

[Fact]
public void Request_WithPath_EncodedSpaces()
{
    // Assign
    var spec = Request.Create().WithPath("/path/a%2fb").UsingAnyMethod();

    // when
    var body = new BodyData();
    var request = new RequestMessage(new UrlDetails("http://localhost/path/a%2fb"), "GET", ClientIp, body);

    // then
    var requestMatchResult = new RequestMatchResult();
    Check.That(spec.GetMatchingScore(request, requestMatchResult)).IsEqualTo(1.0);
}
@chrischu commented on GitHub (Aug 16, 2018): Cool! I think that `Request_WithPath_EncodedSpaces` fails is to be expected. I don't expect it to work. The only case I expect to work is when at both ends the space is encoded (or not encoded like in the other test), like this: ```csharp [Fact] public void Request_WithPath_EncodedSpaces() { // Assign var spec = Request.Create().WithPath("/path/a%2fb").UsingAnyMethod(); // when var body = new BodyData(); var request = new RequestMessage(new UrlDetails("http://localhost/path/a%2fb"), "GET", ClientIp, body); // then var requestMatchResult = new RequestMatchResult(); Check.That(spec.GetMatchingScore(request, requestMatchResult)).IsEqualTo(1.0); } ```
adam commented 2025-12-29 14:23:19 +01:00
Author
Owner
Copy Link
Copy Source

@StefH commented on GitHub (Aug 16, 2018):

https://github.com/WireMock-Net/WireMock.Net/pull/185

@StefH commented on GitHub (Aug 16, 2018): https://github.com/WireMock-Net/WireMock.Net/pull/185
adam commented 2025-12-29 14:23:19 +01:00
Author
Owner
Copy Link
Copy Source

@chrischu commented on GitHub (Aug 23, 2018):

I tried updating, but as expected (according to the test), the underlying problem is not fixed.

According to https://github.com/aspnet/AspNetKatana/issues/208 this is only a problem in OWIN, but apparently this problem persists. I also tried setting the configuration setting (system.net/settings/httpListener.unescapeRequestUrl) since apparently the decoding behavior automatically happens in HTTP.sys

I looked at a another project (https://github.com/hibri/HttpMock) to find out how they achieve the hosting of the HTTP server and they seem to be using Kayak (https://github.com/kayakhttp/kayak) which does not have that problem (I tried reproducing it, but couldn't).

Maybe it would be an option to also use Kayak in WireMock.Net?

@chrischu commented on GitHub (Aug 23, 2018): I tried updating, but as expected (according to the test), the underlying problem is not fixed. According to https://github.com/aspnet/AspNetKatana/issues/208 this is only a problem in OWIN, but apparently this problem persists. I also tried setting the configuration setting (system.net/settings/httpListener.unescapeRequestUrl) since apparently the decoding behavior automatically happens in HTTP.sys I looked at a another project (https://github.com/hibri/HttpMock) to find out how they achieve the hosting of the HTTP server and they seem to be using Kayak (https://github.com/kayakhttp/kayak) which does not have that problem (I tried reproducing it, but couldn't). Maybe it would be an option to also use Kayak in WireMock.Net?
adam commented 2025-12-29 14:23:20 +01:00
Author
Owner
Copy Link
Copy Source

@StefH commented on GitHub (Oct 12, 2018):

Kayak is very old and not updated recently?

@StefH commented on GitHub (Oct 12, 2018): Kayak is very old and not updated recently?
adam commented 2025-12-29 14:23:20 +01:00
Author
Owner
Copy Link
Copy Source

@StefH commented on GitHub (Jul 12, 2019):

Closing

@StefH commented on GitHub (Jul 12, 2019): Closing
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
bug
doc
doc
duplicate
feature
feature
invalid
pull-request
Mirrored from GitHub Pull Request
 question
wontfix
No labels bug question
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
adam (Adam Melkus)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/WireMock.Net-wiremock#128