Fix #46123 - make the subProtocol nullable for HttpListenerContext::AcceptWebSocketAsync (#47402)

euantorano · web-flow · commit 9b9303678de0 · 2021-01-25T22:30:39.000-05:00
* Fix #46123 - make `subProtocol` nullable when dealing with WebSockets in HttpListener. * Update ref for System.Net.HttpListener
diff --git a/src/libraries/System.Net.HttpListener/ref/System.Net.HttpListener.cs b/src/libraries/System.Net.HttpListener/ref/System.Net.HttpListener.cs
@@ -45,10 +45,10 @@ internal HttpListenerContext() { }
         public System.Net.HttpListenerRequest Request { get { throw null; } }
         public System.Net.HttpListenerResponse Response { get { throw null; } }
         public System.Security.Principal.IPrincipal? User { get { throw null; } }
-        public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol) { throw null; }
-        public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol, int receiveBufferSize, System.TimeSpan keepAliveInterval) { throw null; }
-        public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol, int receiveBufferSize, System.TimeSpan keepAliveInterval, System.ArraySegment<byte> internalBuffer) { throw null; }
-        public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol, System.TimeSpan keepAliveInterval) { throw null; }
+        public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol) { throw null; }
+        public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol, int receiveBufferSize, System.TimeSpan keepAliveInterval) { throw null; }
+        public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol, int receiveBufferSize, System.TimeSpan keepAliveInterval, System.ArraySegment<byte> internalBuffer) { throw null; }
+        public System.Threading.Tasks.Task<System.Net.WebSockets.HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol, System.TimeSpan keepAliveInterval) { throw null; }
     }
     public partial class HttpListenerException : System.ComponentModel.Win32Exception
     {
diff --git a/src/libraries/System.Net.HttpListener/src/System/Net/HttpListenerContext.cs b/src/libraries/System.Net.HttpListener/src/System/Net/HttpListenerContext.cs
@@ -33,12 +33,12 @@ public HttpListenerResponse Response
             }
         }
 
-        public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol)
+        public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol)
         {
             return AcceptWebSocketAsync(subProtocol, HttpWebSocket.DefaultReceiveBufferSize, WebSocket.DefaultKeepAliveInterval);
         }
 
-        public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol, TimeSpan keepAliveInterval)
+        public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol, TimeSpan keepAliveInterval)
         {
             return AcceptWebSocketAsync(subProtocol, HttpWebSocket.DefaultReceiveBufferSize, keepAliveInterval);
         }
diff --git a/src/libraries/System.Net.HttpListener/src/System/Net/Managed/HttpListenerContext.Managed.cs b/src/libraries/System.Net.HttpListener/src/System/Net/Managed/HttpListenerContext.Managed.cs
@@ -86,13 +86,13 @@ internal static bool TryParseBasicAuth(string headerValue, out HttpStatusCode er
             }
         }
 
-        public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval)
+        public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval)
         {
             return HttpWebSocket.AcceptWebSocketAsyncCore(this, subProtocol, receiveBufferSize, keepAliveInterval);
         }
 
         [EditorBrowsable(EditorBrowsableState.Never)]
-        public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval, ArraySegment<byte> internalBuffer)
+        public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval, ArraySegment<byte> internalBuffer)
         {
             WebSocketValidate.ValidateArraySegment(internalBuffer, nameof(internalBuffer));
             HttpWebSocket.ValidateOptions(subProtocol, receiveBufferSize, HttpWebSocket.MinSendBufferSize, keepAliveInterval);
diff --git a/src/libraries/System.Net.HttpListener/src/System/Net/Managed/WebSockets/HttpWebSocket.Managed.cs b/src/libraries/System.Net.HttpListener/src/System/Net/Managed/WebSockets/HttpWebSocket.Managed.cs
@@ -10,7 +10,7 @@ internal static partial class HttpWebSocket
         private const string SupportedVersion = "13";
 
         internal static async Task<HttpListenerWebSocketContext> AcceptWebSocketAsyncCore(HttpListenerContext context,
-            string subProtocol,
+            string? subProtocol,
             int receiveBufferSize,
             TimeSpan keepAliveInterval,
             ArraySegment<byte>? internalBuffer = null)
diff --git a/src/libraries/System.Net.HttpListener/src/System/Net/WebSockets/HttpWebSocket.cs b/src/libraries/System.Net.HttpListener/src/System/Net/WebSockets/HttpWebSocket.cs
@@ -28,7 +28,7 @@ internal static string GetSecWebSocketAcceptString(string? secWebSocketKey)
 
         // return value here signifies if a Sec-WebSocket-Protocol header should be returned by the server.
         internal static bool ProcessWebSocketProtocolHeader(string? clientSecWebSocketProtocol,
-            string subProtocol,
+            string? subProtocol,
             out string acceptProtocol)
         {
             acceptProtocol = string.Empty;
@@ -76,7 +76,7 @@ internal static bool ProcessWebSocketProtocolHeader(string? clientSecWebSocketPr
                     subProtocol));
         }
 
-        internal static void ValidateOptions(string subProtocol, int receiveBufferSize, int sendBufferSize, TimeSpan keepAliveInterval)
+        internal static void ValidateOptions(string? subProtocol, int receiveBufferSize, int sendBufferSize, TimeSpan keepAliveInterval)
         {
             if (subProtocol != null)
             {
diff --git a/src/libraries/System.Net.HttpListener/src/System/Net/Windows/HttpListenerContext.Windows.cs b/src/libraries/System.Net.HttpListener/src/System/Net/Windows/HttpListenerContext.Windows.cs
@@ -48,7 +48,7 @@ internal void SetIdentity(IPrincipal principal, string? mutualAuthentication)
 
         internal ulong RequestId => Request.RequestId;
 
-        public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol,
+        public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol,
             int receiveBufferSize,
             TimeSpan keepAliveInterval)
         {
@@ -62,7 +62,7 @@ public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtoco
         }
 
         [EditorBrowsable(EditorBrowsableState.Never)]
-        public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol,
+        public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol,
             int receiveBufferSize,
             TimeSpan keepAliveInterval,
             ArraySegment<byte> internalBuffer)
diff --git a/src/libraries/System.Net.HttpListener/src/System/Net/Windows/WebSockets/HttpWebSocket.Windows.cs b/src/libraries/System.Net.HttpListener/src/System/Net/Windows/WebSockets/HttpWebSocket.Windows.cs
@@ -15,7 +15,7 @@ namespace System.Net.WebSockets
     internal static partial class HttpWebSocket
     {
         internal static Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(HttpListenerContext context,
-            string subProtocol,
+            string? subProtocol,
             int receiveBufferSize,
             TimeSpan keepAliveInterval,
             ArraySegment<byte> internalBuffer)
@@ -28,7 +28,7 @@ internal static Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(HttpList
         }
 
         private static async Task<HttpListenerWebSocketContext> AcceptWebSocketAsyncCore(HttpListenerContext context,
-            string subProtocol,
+            string? subProtocol,
             int receiveBufferSize,
             TimeSpan keepAliveInterval,
             ArraySegment<byte> internalBuffer)
diff --git a/src/libraries/System.Net.HttpListener/src/System/Net/Windows/WebSockets/ServerWebSocket.cs b/src/libraries/System.Net.HttpListener/src/System/Net/Windows/WebSockets/ServerWebSocket.cs
@@ -10,7 +10,7 @@ namespace System.Net.WebSockets
     internal sealed class ServerWebSocket : WebSocketBase
     {
         internal static WebSocket Create(Stream innerStream,
-            string subProtocol,
+            string? subProtocol,
             int receiveBufferSize,
             TimeSpan keepAliveInterval,
             ArraySegment<byte> internalBuffer)
@@ -37,7 +37,7 @@ internal static WebSocket Create(Stream innerStream,
         private readonly Interop.WebSocket.Property[] _properties;
 
         public ServerWebSocket(Stream innerStream,
-            string subProtocol,
+            string? subProtocol,
             int receiveBufferSize,
             TimeSpan keepAliveInterval,
             ArraySegment<byte> internalBuffer)
diff --git a/src/libraries/System.Net.HttpListener/src/System/Net/Windows/WebSockets/WebSocketBase.cs b/src/libraries/System.Net.HttpListener/src/System/Net/Windows/WebSockets/WebSocketBase.cs
@@ -22,7 +22,7 @@ internal abstract class WebSocketBase : WebSocket, IDisposable
         private readonly OutstandingOperationHelper _sendOutstandingOperationHelper;
         private readonly Stream _innerStream;
         private readonly IWebSocketStream? _innerStreamAsWebSocketStream;
-        private readonly string _subProtocol;
+        private readonly string? _subProtocol;
 
         // We are not calling Dispose method on this object in Cleanup method to avoid a race condition while one thread is calling disposing on
         // this object and another one is still using WaitAsync. According to Dev11 358715, this should be fine as long as we are not accessing the
@@ -54,7 +54,7 @@ internal abstract class WebSocketBase : WebSocket, IDisposable
         private Exception? _pendingException;
 
         protected WebSocketBase(Stream innerStream,
-            string subProtocol,
+            string? subProtocol,
             TimeSpan keepAliveInterval,
             WebSocketBuffer internalBuffer)
         {
@@ -113,7 +113,7 @@ public override WebSocketState State
             }
         }
 
-        public override string SubProtocol
+        public override string? SubProtocol
         {
             get
             {

Original file line number	Diff line number	Diff line change
`@@ -33,12 +33,12 @@ public HttpListenerResponse Response`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`
`36`		`- public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol)`
	`36`	`+ public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol)`
`37`	`37`	`{`
`38`	`38`	`return AcceptWebSocketAsync(subProtocol, HttpWebSocket.DefaultReceiveBufferSize, WebSocket.DefaultKeepAliveInterval);`
`39`	`39`	`}`
`40`	`40`
`41`		`- public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol, TimeSpan keepAliveInterval)`
	`41`	`+ public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol, TimeSpan keepAliveInterval)`
`42`	`42`	`{`
`43`	`43`	`return AcceptWebSocketAsync(subProtocol, HttpWebSocket.DefaultReceiveBufferSize, keepAliveInterval);`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -86,13 +86,13 @@ internal static bool TryParseBasicAuth(string headerValue, out HttpStatusCode er`
`86`	`86`	`}`
`87`	`87`	`}`
`88`	`88`
`89`		`- public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval)`
	`89`	`+ public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval)`
`90`	`90`	`{`
`91`	`91`	`return HttpWebSocket.AcceptWebSocketAsyncCore(this, subProtocol, receiveBufferSize, keepAliveInterval);`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`[EditorBrowsable(EditorBrowsableState.Never)]`
`95`		`- public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval, ArraySegment<byte> internalBuffer)`
	`95`	`+ public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol, int receiveBufferSize, TimeSpan keepAliveInterval, ArraySegment<byte> internalBuffer)`
`96`	`96`	`{`
`97`	`97`	`WebSocketValidate.ValidateArraySegment(internalBuffer, nameof(internalBuffer));`
`98`	`98`	`HttpWebSocket.ValidateOptions(subProtocol, receiveBufferSize, HttpWebSocket.MinSendBufferSize, keepAliveInterval);`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ internal static string GetSecWebSocketAcceptString(string? secWebSocketKey)`
`28`	`28`
`29`	`29`	`// return value here signifies if a Sec-WebSocket-Protocol header should be returned by the server.`
`30`	`30`	`internal static bool ProcessWebSocketProtocolHeader(string? clientSecWebSocketProtocol,`
`31`		`- string subProtocol,`
	`31`	`+ string? subProtocol,`
`32`	`32`	`out string acceptProtocol)`
`33`	`33`	`{`
`34`	`34`	`acceptProtocol = string.Empty;`
`@@ -76,7 +76,7 @@ internal static bool ProcessWebSocketProtocolHeader(string? clientSecWebSocketPr`
`76`	`76`	`subProtocol));`
`77`	`77`	`}`
`78`	`78`
`79`		`- internal static void ValidateOptions(string subProtocol, int receiveBufferSize, int sendBufferSize, TimeSpan keepAliveInterval)`
	`79`	`+ internal static void ValidateOptions(string? subProtocol, int receiveBufferSize, int sendBufferSize, TimeSpan keepAliveInterval)`
`80`	`80`	`{`
`81`	`81`	`if (subProtocol != null)`
`82`	`82`	`{`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ internal void SetIdentity(IPrincipal principal, string? mutualAuthentication)`
`48`	`48`
`49`	`49`	`internal ulong RequestId => Request.RequestId;`
`50`	`50`
`51`		`- public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol,`
	`51`	`+ public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol,`
`52`	`52`	`int receiveBufferSize,`
`53`	`53`	`TimeSpan keepAliveInterval)`
`54`	`54`	`{`
`@@ -62,7 +62,7 @@ public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtoco`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`[EditorBrowsable(EditorBrowsableState.Never)]`
`65`		`- public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string subProtocol,`
	`65`	`+ public Task<HttpListenerWebSocketContext> AcceptWebSocketAsync(string? subProtocol,`
`66`	`66`	`int receiveBufferSize,`
`67`	`67`	`TimeSpan keepAliveInterval,`
`68`	`68`	`ArraySegment<byte> internalBuffer)`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ internal abstract class WebSocketBase : WebSocket, IDisposable`
`22`	`22`	`private readonly OutstandingOperationHelper _sendOutstandingOperationHelper;`
`23`	`23`	`private readonly Stream _innerStream;`
`24`	`24`	`private readonly IWebSocketStream? _innerStreamAsWebSocketStream;`
`25`		`- private readonly string _subProtocol;`
	`25`	`+ private readonly string? _subProtocol;`
`26`	`26`
`27`	`27`	`// We are not calling Dispose method on this object in Cleanup method to avoid a race condition while one thread is calling disposing on`
`28`	`28`	`// this object and another one is still using WaitAsync. According to Dev11 358715, this should be fine as long as we are not accessing the`
`@@ -54,7 +54,7 @@ internal abstract class WebSocketBase : WebSocket, IDisposable`
`54`	`54`	`private Exception? _pendingException;`
`55`	`55`
`56`	`56`	`protected WebSocketBase(Stream innerStream,`
`57`		`- string subProtocol,`
	`57`	`+ string? subProtocol,`
`58`	`58`	`TimeSpan keepAliveInterval,`
`59`	`59`	`WebSocketBuffer internalBuffer)`
`60`	`60`	`{`
`@@ -113,7 +113,7 @@ public override WebSocketState State`
`113`	`113`	`}`
`114`	`114`	`}`
`115`	`115`
`116`		`- public override string SubProtocol`
	`116`	`+ public override string? SubProtocol`
`117`	`117`	`{`
`118`	`118`	`get`
`119`	`119`	`{`