public HttpNegotiationQueue(WebSocketListenerConfig configuration)
{
Guard.ParameterCannotBeNull(configuration, nameof(configuration));
_configuration = configuration;
_cancel = new CancellationTokenSource();
_semaphore = new SemaphoreSlim(configuration.Options.ParallelNegotiations);
_sockets = new BufferBlock <Socket>(new DataflowBlockOptions()
{
BoundedCapacity = configuration.Options.NegotiationQueueCapacity,
CancellationToken = _cancel.Token
});
_negotiations = new BufferBlock <WebSocketNegotiationResult>(new DataflowBlockOptions()
{
BoundedCapacity = configuration.Options.NegotiationQueueCapacity,
CancellationToken = _cancel.Token
});
_cancel.Token.Register(_sockets.Complete);
_cancel.Token.Register(_negotiations.Complete);
_handShaker = new WebSocketHandshaker(configuration);
WorkAsync();
}
public void WebSocketHandshaker_CanUnderstandEncodedCookies()
{
var config = new WebSocketListenerConfig(new WebSocketListenerOptions());
config.Standards.RegisterStandard(new WebSocketFactoryRfc6455());
var handshaker = new WebSocketHandshaker(config);
using (var ms = new MemoryStream())
{
using (var sw = new StreamWriter(ms, Encoding.ASCII, 1024, true))
{
sw.WriteLine(@"GET /chat HTTP/1.1");
sw.WriteLine(@"Host: server.example.com");
sw.WriteLine(@"Upgrade: websocket");
sw.WriteLine(@"Connection: Upgrade");
sw.WriteLine(@"Cookie: key=This%20is%20encoded.");
sw.WriteLine(@"Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==");
sw.WriteLine(@"Sec-WebSocket-Version: 13");
sw.WriteLine(@"Origin: http://example.com");
}
var position = ms.Position;
ms.Seek(0, SeekOrigin.Begin);
var result = handshaker.HandshakeAsync(ms).Result;
Assert.IsNotNull(result);
Assert.IsTrue(result.IsValid);
Assert.AreEqual(1, result.Request.Cookies.Count);
Assert.AreEqual("This is encoded.", result.Request.Cookies[0].Value);
}
}
WebSocketHandshake GenerateSimpleHandshake()
{
var config = new WebSocketListenerConfig(new WebSocketListenerOptions());
config.Standards.RegisterStandard(new WebSocketFactoryRfc6455());
WebSocketHandshaker handshaker = new WebSocketHandshaker(config);
using (var ms = new MemoryStream())
{
using (var sw = new StreamWriter(ms, Encoding.ASCII, 1024, true))
{
sw.WriteLine(@"GET /chat HTTP/1.1");
sw.WriteLine(@"Host: server.example.com");
sw.WriteLine(@"Upgrade: websocket");
sw.WriteLine(@"Connection: Upgrade");
sw.WriteLine(@"Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==");
sw.WriteLine(@"Sec-WebSocket-Version: 13");
sw.WriteLine(@"Origin: http://example.com");
}
ms.Seek(0, SeekOrigin.Begin);
return(handshaker.HandshakeAsync(ms).Result);
}
}
public void WebSocketHandshaker_FailsWhenBadExtensionRequest()
{
var extension = new Mock <IWebSocketMessageExtension>();
extension.Setup(x => x.Name).Returns("test-extension");
WebSocketExtension ext = new WebSocketExtension("test-extension", new List <WebSocketExtensionOption>(new[] { new WebSocketExtensionOption()
{
ClientAvailableOption = false, Name = "optionA"
} }));
IWebSocketMessageExtensionContext ctx;
extension.Setup(x => x.TryNegotiate(It.IsAny <WebSocketHttpRequest>(), out ext, out ctx))
.Returns(true);
var config = new WebSocketListenerConfig(new WebSocketListenerOptions()
{
SubProtocols = new[] { "superchat" }
});
config.Standards.RegisterStandard(new WebSocketFactoryRfc6455());
config.MessageExtensions.RegisterExtension(extension.Object);
var handshaker = new WebSocketHandshaker(config);
using (var ms = new MemoryStream())
{
using (var sw = new StreamWriter(ms, Encoding.ASCII, 1024, true))
{
sw.WriteLine(@"GET /chat HTTP/1.1");
sw.WriteLine(@"Host: server.example.com");
sw.WriteLine(@"Upgrade: websocket");
sw.WriteLine(@"Connection: Upgrade");
sw.WriteLine(@"Cookie: key=W9g/8FLW8RAFqSCWBvB9Ag==#5962c0ace89f4f780aa2a53febf2aae5;");
sw.WriteLine(@"Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==");
sw.WriteLine(@"Sec-WebSocket-Protocol: chat, superchat");
sw.WriteLine(@"Sec-WebSocket-Extensions: test-extension;;Dsf,,optionA");
sw.WriteLine(@"Sec-WebSocket-Version: 13");
sw.WriteLine(@"Origin: http://example.com");
}
var position = ms.Position;
ms.Seek(0, SeekOrigin.Begin);
var result = handshaker.HandshakeAsync(ms).Result;
Assert.IsTrue(result.IsWebSocketRequest);
Assert.IsTrue(result.IsVersionSupported);
Assert.IsTrue(result.NegotiatedMessageExtensions.Count() == 0);
ms.Seek(position, SeekOrigin.Begin);
StringBuilder sb = new StringBuilder();
sb.AppendLine(@"HTTP/1.1 400 Bad Request");
sb.AppendLine();
using (var sr = new StreamReader(ms))
{
var s = sr.ReadToEnd();
Assert.AreEqual(sb.ToString(), s);
}
}
}
public void WebSocketHandshaker_CanReturnCookies()
{
var config = new WebSocketListenerConfig(new WebSocketListenerOptions()
{
OnHttpNegotiation = async(request, response) =>
{
response.Cookies.Add(new System.Net.Cookie("name1", "value1"));
response.Cookies.Add(new System.Net.Cookie("name2", "value2"));
}
});
config.Standards.RegisterStandard(new WebSocketFactoryRfc6455());
var handshaker = new WebSocketHandshaker(config);
using (var ms = new MemoryStream())
{
using (var sw = new StreamWriter(ms, Encoding.ASCII, 1024, true))
{
sw.WriteLine(@"GET /chat HTTP/1.1");
sw.WriteLine(@"Host: server.example.com");
sw.WriteLine(@"Upgrade: websocket");
sw.WriteLine(@"Connection: Upgrade");
sw.WriteLine(@"Cookie: key=W9g/8FLW8RAFqSCWBvB9Ag==#5962c0ace89f4f780aa2a53febf2aae5;");
sw.WriteLine(@"Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==");
sw.WriteLine(@"Sec-WebSocket-Version: 13");
sw.WriteLine(@"Origin: http://example.com");
}
var position = ms.Position;
ms.Seek(0, SeekOrigin.Begin);
var result = handshaker.HandshakeAsync(ms).Result;
Assert.IsNotNull(result);
ms.Seek(position, SeekOrigin.Begin);
StringBuilder sb = new StringBuilder();
sb.AppendLine(@"HTTP/1.1 101 Switching Protocols");
sb.AppendLine(@"Upgrade: websocket");
sb.AppendLine(@"Connection: Upgrade");
sb.AppendLine(@"Set-Cookie: name1=value1");
sb.AppendLine(@"Set-Cookie: name2=value2");
sb.AppendLine(@"Sec-WebSocket-Accept: HSmrc0sMlYUkAGmm5OPpG2HaGWk=");
sb.AppendLine();
using (var sr = new StreamReader(ms))
{
var s = sr.ReadToEnd();
Assert.AreEqual(sb.ToString(), s);
}
}
}
public void WebSocketHandshaker_CanDoSimpleHandshake()
{
var config = new WebSocketListenerConfig(new WebSocketListenerOptions());
config.Standards.RegisterStandard(new WebSocketFactoryRfc6455());
var handshaker = new WebSocketHandshaker(config);
using (var ms = new MemoryStream())
{
using (var sw = new StreamWriter(ms, Encoding.ASCII, 1024, true))
{
sw.WriteLine(@"GET /chat HTTP/1.1");
sw.WriteLine(@"Host: server.example.com");
sw.WriteLine(@"Upgrade: websocket");
sw.WriteLine(@"Connection: Upgrade");
sw.WriteLine(@"Cookie: key=W9g/8FLW8RAFqSCWBvB9Ag==#5962c0ace89f4f780aa2a53febf2aae5;");
sw.WriteLine(@"Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==");
sw.WriteLine(@"Sec-WebSocket-Version: 13");
sw.WriteLine(@"Origin: http://example.com");
}
var position = ms.Position;
ms.Seek(0, SeekOrigin.Begin);
var result = handshaker.HandshakeAsync(ms).Result;
Assert.IsNotNull(result);
Assert.IsTrue(result.IsWebSocketRequest);
Assert.IsTrue(result.IsVersionSupported);
Assert.AreEqual(new Uri("http://example.com"), result.Request.Headers.Origin);
Assert.AreEqual("server.example.com", result.Request.Headers["Host"]);
Assert.AreEqual(@"/chat", result.Request.RequestUri.ToString());
Assert.AreEqual(1, result.Request.Cookies.Count);
var cookie = result.Request.Cookies[0];
Assert.AreEqual("key", cookie.Name);
Assert.AreEqual(@"W9g/8FLW8RAFqSCWBvB9Ag==#5962c0ace89f4f780aa2a53febf2aae5", cookie.Value);
ms.Seek(position, SeekOrigin.Begin);
StringBuilder sb = new StringBuilder();
sb.AppendLine(@"HTTP/1.1 101 Switching Protocols");
sb.AppendLine(@"Upgrade: websocket");
sb.AppendLine(@"Connection: Upgrade");
sb.AppendLine(@"Sec-WebSocket-Accept: HSmrc0sMlYUkAGmm5OPpG2HaGWk=");
sb.AppendLine();
using (var sr = new StreamReader(ms))
{
var s = sr.ReadToEnd();
Assert.AreEqual(sb.ToString(), s);
}
}
}
public void WebSocketHandshaker_CanIndicateANonWebSocketConnection()
{
var extension = new Mock <IWebSocketMessageExtension>();
extension.Setup(x => x.Name).Returns("test-extension");
WebSocketExtension ext = new WebSocketExtension("test-extension", new List <WebSocketExtensionOption>(new[] { new WebSocketExtensionOption()
{
ClientAvailableOption = false, Name = "optionA"
} }));
IWebSocketMessageExtensionContext ctx;
extension.Setup(x => x.TryNegotiate(It.IsAny <WebSocketHttpRequest>(), out ext, out ctx))
.Returns(true);
var config = new WebSocketListenerConfig(new WebSocketListenerOptions()
{
SubProtocols = new[] { "superchat" }
});
config.Standards.RegisterStandard(new WebSocketFactoryRfc6455());
config.MessageExtensions.RegisterExtension(extension.Object);
var handshaker = new WebSocketHandshaker(config);
using (var ms = new MemoryStream())
{
using (var sw = new StreamWriter(ms, Encoding.ASCII, 1024, true))
{
sw.WriteLine(@"GET /chat HTTP/1.1");
sw.WriteLine(@"Host: server.example.com");
}
var position = ms.Position;
ms.Seek(0, SeekOrigin.Begin);
var result = handshaker.HandshakeAsync(ms).Result;
Assert.IsNotNull(result);
Assert.IsFalse(result.IsWebSocketRequest);
Assert.IsFalse(result.IsVersionSupported);
ms.Seek(position, SeekOrigin.Begin);
StringBuilder sb = new StringBuilder();
sb.AppendLine(@"HTTP/1.1 400 Bad Request");
sb.AppendLine();
using (var sr = new StreamReader(ms))
{
var s = sr.ReadToEnd();
Assert.AreEqual(sb.ToString(), s);
}
}
}
public void WebSocketHandshaker_DoesNotFailWhenSubProtocolRequestedButNoMatch()
{
var config = new WebSocketListenerConfig(new WebSocketListenerOptions()
{
SubProtocols = new[] { "superchatx" }
});
config.Standards.RegisterStandard(new WebSocketFactoryRfc6455());
var handshaker = new WebSocketHandshaker(config);
using (var ms = new MemoryStream())
{
using (var sw = new StreamWriter(ms, Encoding.ASCII, 1024, true))
{
sw.WriteLine(@"GET /chat HTTP/1.1");
sw.WriteLine(@"Host: server.example.com");
sw.WriteLine(@"Upgrade: websocket");
sw.WriteLine(@"Connection: Upgrade");
sw.WriteLine(@"Cookie: key=W9g/8FLW8RAFqSCWBvB9Ag==#5962c0ace89f4f780aa2a53febf2aae5;");
sw.WriteLine(@"Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==");
sw.WriteLine(@"Sec-WebSocket-Protocol: chat, superchat");
sw.WriteLine(@"Sec-WebSocket-Version: 13");
sw.WriteLine(@"Origin: http://example.com");
}
var position = ms.Position;
ms.Seek(0, SeekOrigin.Begin);
var result = handshaker.HandshakeAsync(ms).Result;
Assert.IsNotNull(result);
Assert.IsTrue(result.IsWebSocketRequest);
Assert.IsTrue(result.IsVersionSupported);
Assert.IsNull(result.Error);
Assert.IsTrue(result.IsValid);
Assert.IsNull(result.Response.WebSocketProtocol);
ms.Seek(position, SeekOrigin.Begin);
StringBuilder sb = new StringBuilder();
sb.AppendLine(@"HTTP/1.1 101 Switching Protocols");
sb.AppendLine(@"Upgrade: websocket");
sb.AppendLine(@"Connection: Upgrade");
sb.AppendLine(@"Sec-WebSocket-Accept: HSmrc0sMlYUkAGmm5OPpG2HaGWk=");
sb.AppendLine();
using (var sr = new StreamReader(ms))
{
var s = sr.ReadToEnd();
Assert.AreEqual(sb.ToString(), s);
}
}
}
public void WebSocketHandshaker_CanDetectReturnCookieErrors()
{
var config = new WebSocketListenerConfig(new WebSocketListenerOptions()
{
OnHttpNegotiation = (req, res) => { throw new Exception("dummy"); }
});
config.Standards.RegisterStandard(new WebSocketFactoryRfc6455());
var handshaker = new WebSocketHandshaker(config);
using (var ms = new MemoryStream())
{
using (var sw = new StreamWriter(ms, Encoding.ASCII, 1024, true))
{
sw.WriteLine(@"GET /chat HTTP/1.1");
sw.WriteLine(@"Host: server.example.com");
sw.WriteLine(@"Upgrade: websocket");
sw.WriteLine(@"Connection: Upgrade");
sw.WriteLine(@"Cookie: key=W9g/8FLW8RAFqSCWBvB9Ag==#5962c0ace89f4f780aa2a53febf2aae5;");
sw.WriteLine(@"Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==");
sw.WriteLine(@"Sec-WebSocket-Version: 13");
sw.WriteLine(@"Origin: http://example.com");
}
var position = ms.Position;
ms.Seek(0, SeekOrigin.Begin);
var result = handshaker.HandshakeAsync(ms).Result;
Assert.IsNotNull(result);
Assert.IsFalse(result.IsValid);
Assert.IsNotNull(result.Error);
ms.Seek(position, SeekOrigin.Begin);
StringBuilder sb = new StringBuilder();
sb.AppendLine(@"HTTP/1.1 500 Internal Server Error");
sb.AppendLine();
using (var sr = new StreamReader(ms))
{
var s = sr.ReadToEnd();
Assert.AreEqual(sb.ToString(), s);
}
}
}
public void WebSocketHandshaker_CanNegotiateAnExtension()
{
var extension = new Mock <IWebSocketMessageExtension>();
extension.Setup(x => x.Name).Returns("test-extension");
WebSocketExtension ext = new WebSocketExtension("test-extension");
IWebSocketMessageExtensionContext ctx;
extension.Setup(x => x.TryNegotiate(It.IsAny <WebSocketHttpRequest>(), out ext, out ctx))
.Returns(true);
var config = new WebSocketListenerConfig(new WebSocketListenerOptions()
{
SubProtocols = new[] { "superchat" }
});
config.MessageExtensions.RegisterExtension(extension.Object);
config.Standards.RegisterStandard(new WebSocketFactoryRfc6455());
var handshaker = new WebSocketHandshaker(config);
using (var ms = new MemoryStream())
{
using (var sw = new StreamWriter(ms, Encoding.ASCII, 1024, true))
{
sw.WriteLine(@"GET /chat HTTP/1.1");
sw.WriteLine(@"Host: server.example.com");
sw.WriteLine(@"Upgrade: websocket");
sw.WriteLine(@"Connection: Upgrade");
sw.WriteLine(@"Cookie: key=W9g/8FLW8RAFqSCWBvB9Ag==#5962c0ace89f4f780aa2a53febf2aae5;");
sw.WriteLine(@"Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==");
sw.WriteLine(@"Sec-WebSocket-Protocol: chat, superchat");
sw.WriteLine(@"Sec-WebSocket-Extensions: test-extension");
sw.WriteLine(@"Sec-WebSocket-Version: 13");
sw.WriteLine(@"Origin: http://example.com");
}
var position = ms.Position;
ms.Seek(0, SeekOrigin.Begin);
var result = handshaker.HandshakeAsync(ms).Result;
Assert.IsNotNull(result);
Assert.IsTrue(result.IsWebSocketRequest);
Assert.AreEqual(new Uri("http://example.com"), result.Request.Headers.Origin);
Assert.AreEqual("superchat", result.Response.WebSocketProtocol);
ms.Seek(position, SeekOrigin.Begin);
StringBuilder sb = new StringBuilder();
sb.AppendLine(@"HTTP/1.1 101 Switching Protocols");
sb.AppendLine(@"Upgrade: websocket");
sb.AppendLine(@"Connection: Upgrade");
sb.AppendLine(@"Sec-WebSocket-Accept: HSmrc0sMlYUkAGmm5OPpG2HaGWk=");
sb.AppendLine(@"Sec-WebSocket-Protocol: superchat");
sb.AppendLine(@"Sec-WebSocket-Extensions: test-extension");
sb.AppendLine();
using (var sr = new StreamReader(ms))
{
var s = sr.ReadToEnd();
Assert.AreEqual(sb.ToString(), s);
}
}
}
