Fix ClientWebSocket close handshake when using proxy (dotnet/corefx#36928)
authorDavid Shulman <david.shulman@microsoft.com>
Wed, 17 Apr 2019 00:15:30 +0000 (17:15 -0700)
committerGitHub <noreply@github.com>
Wed, 17 Apr 2019 00:15:30 +0000 (17:15 -0700)
commit5f3d25be72c0c92a72355ed5ce52239272c53357
tree3ff54940f6b6c969bf34681b1e45a92d6a344061
parentabb400d670454f65c9022f0997a5e7dd8ac56df2
Fix ClientWebSocket close handshake when using proxy (dotnet/corefx#36928)

When the client websocket was going through a proxy, it would sometimes transition to the
'Aborted' state and not the 'Closed' state after a successful closing handshake.

I first opened this bug a year ago but finally was able to get back to it and root cause the
problem. The problem only occured with the managed websocket. The .NET Framework did not have
this problem. And some proxies didn't cause a problem with managed websocket (such as Fiddler).

The root cause is a misinterpretation of RFC 6455, Section 7.1.1. This describes the behavior
of how the websocket's TCP connection should be closed. The most graceful way is to wait for
the server to initiate the close of the socket. In cases where it is taking too long to wait
for the server to start the TCP close, then the client can start the TCP close of the socket.

But no matter how the socket is finally closed, the websocket state should transition to 'Closed'
as soon as a valid closing handshake was performed (i.e. close frames both sent and received).
And this occurs before any logic for closing the TCP connection.

The code in managed websocket has a timer to wait 1 second for the server to start a close. If
the timer finishes, then the managed websocket calls an Abort() method to close the socket. This
ends up transitioning the websocket to an 'Aborted' state which is incorrect. The state should
only be moved to the 'Aborted' state if a closing handshake was not completed.

I added a new test to support this change and moved the LoopbackProxyServer code to Common.

Fixes dotnet/corefx#28027

Commit migrated from https://github.com/dotnet/corefx/commit/0c9684c2c4057908cf697a366a3b1527326e507d
src/libraries/Common/src/System/Net/WebSockets/ManagedWebSocket.cs
src/libraries/Common/tests/System/Net/Http/LoopbackProxyServer.cs [moved from src/libraries/System.Net.Http/tests/FunctionalTests/LoopbackProxyServer.cs with 99% similarity]
src/libraries/System.Net.Http/tests/FunctionalTests/System.Net.Http.Functional.Tests.csproj
src/libraries/System.Net.WebSockets.Client/tests/ConnectTest.cs
src/libraries/System.Net.WebSockets.Client/tests/System.Net.WebSockets.Client.Tests.csproj