1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
|
//
// ClientWebSocket.cs
//
// Authors:
// Jérémie Laval <jeremie dot laval at xamarin dot com>
//
// Copyright 2013 Xamarin Inc (http://www.xamarin.com).
//
// Lightly inspired from WebSocket4Net distributed under the Apache License 2.0
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
#if NET_4_5
using System;
using System.Net;
using System.Net.Sockets;
using System.Security.Principal;
using System.Security.Cryptography.X509Certificates;
using System.Runtime.CompilerServices;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using System.Globalization;
using System.Text;
using System.Security.Cryptography;
namespace System.Net.WebSockets
{
public class ClientWebSocket : WebSocket, IDisposable
{
const string Magic = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
const string VersionTag = "13";
ClientWebSocketOptions options;
WebSocketState state;
string subProtocol;
HttpWebRequest req;
WebConnection connection;
Socket underlyingSocket;
Random random = new Random ();
const int HeaderMaxLength = 14;
byte[] headerBuffer;
byte[] sendBuffer;
long remaining;
public ClientWebSocket ()
{
options = new ClientWebSocketOptions ();
state = WebSocketState.None;
headerBuffer = new byte[HeaderMaxLength];
}
public override void Dispose ()
{
if (connection != null)
connection.Close (false);
}
[MonoTODO]
public override void Abort ()
{
throw new NotImplementedException ();
}
public ClientWebSocketOptions Options {
get {
return options;
}
}
public override WebSocketState State {
get {
return state;
}
}
public override WebSocketCloseStatus? CloseStatus {
get {
if (state != WebSocketState.Closed)
return (WebSocketCloseStatus?)null;
return WebSocketCloseStatus.Empty;
}
}
public override string CloseStatusDescription {
get {
return null;
}
}
public override string SubProtocol {
get {
return subProtocol;
}
}
public async Task ConnectAsync (Uri uri, CancellationToken cancellationToken)
{
state = WebSocketState.Connecting;
var httpUri = new UriBuilder (uri);
if (uri.Scheme == "wss")
httpUri.Scheme = "https";
else
httpUri.Scheme = "http";
req = (HttpWebRequest)WebRequest.Create (httpUri.Uri);
req.ReuseConnection = true;
if (options.Cookies != null)
req.CookieContainer = options.Cookies;
if (options.CustomRequestHeaders.Count > 0) {
foreach (var header in options.CustomRequestHeaders)
req.Headers[header.Key] = header.Value;
}
var secKey = Convert.ToBase64String (Encoding.ASCII.GetBytes (Guid.NewGuid ().ToString ().Substring (0, 16)));
string expectedAccept = Convert.ToBase64String (SHA1.Create ().ComputeHash (Encoding.ASCII.GetBytes (secKey + Magic)));
req.Headers["Upgrade"] = "WebSocket";
req.Headers["Sec-WebSocket-Version"] = VersionTag;
req.Headers["Sec-WebSocket-Key"] = secKey;
req.Headers["Sec-WebSocket-Origin"] = uri.Host;
if (options.SubProtocols.Count > 0)
req.Headers["Sec-WebSocket-Protocol"] = string.Join (",", options.SubProtocols);
if (options.Credentials != null)
req.Credentials = options.Credentials;
if (options.ClientCertificates != null)
req.ClientCertificates = options.ClientCertificates;
if (options.Proxy != null)
req.Proxy = options.Proxy;
req.UseDefaultCredentials = options.UseDefaultCredentials;
req.Connection = "Upgrade";
HttpWebResponse resp = null;
try {
resp = (HttpWebResponse)(await req.GetResponseAsync ().ConfigureAwait (false));
} catch (Exception e) {
throw new WebSocketException (WebSocketError.Success, e);
}
connection = req.StoredConnection;
underlyingSocket = connection.socket;
if (resp.StatusCode != HttpStatusCode.SwitchingProtocols)
throw new WebSocketException ("The server returned status code '" + (int)resp.StatusCode + "' when status code '101' was expected");
if (!string.Equals (resp.Headers["Upgrade"], "WebSocket", StringComparison.OrdinalIgnoreCase)
|| !string.Equals (resp.Headers["Connection"], "Upgrade", StringComparison.OrdinalIgnoreCase)
|| !string.Equals (resp.Headers["Sec-WebSocket-Accept"], expectedAccept))
throw new WebSocketException ("HTTP header error during handshake");
if (resp.Headers["Sec-WebSocket-Protocol"] != null) {
if (!options.SubProtocols.Contains (resp.Headers["Sec-WebSocket-Protocol"]))
throw new WebSocketException (WebSocketError.UnsupportedProtocol);
subProtocol = resp.Headers["Sec-WebSocket-Protocol"];
}
state = WebSocketState.Open;
}
public override Task SendAsync (ArraySegment<byte> buffer, WebSocketMessageType messageType, bool endOfMessage, CancellationToken cancellationToken)
{
EnsureWebSocketConnected ();
ValidateArraySegment (buffer);
if (connection == null)
throw new WebSocketException (WebSocketError.Faulted);
var count = Math.Max (options.SendBufferSize, buffer.Count) + HeaderMaxLength;
if (sendBuffer == null || sendBuffer.Length != count)
sendBuffer = new byte[count];
return Task.Run (() => {
EnsureWebSocketState (WebSocketState.Open, WebSocketState.CloseReceived);
var maskOffset = WriteHeader (messageType, buffer, endOfMessage);
if (buffer.Count > 0)
MaskData (buffer, maskOffset);
//underlyingSocket.Send (headerBuffer, 0, maskOffset + 4, SocketFlags.None);
var headerLength = maskOffset + 4;
Array.Copy (headerBuffer, sendBuffer, headerLength);
underlyingSocket.Send (sendBuffer, 0, buffer.Count + headerLength, SocketFlags.None);
});
}
const int messageTypeText = 1;
const int messageTypeBinary = 2;
const int messageTypeClose = 8;
static WebSocketMessageType WireToMessageType (byte msgType)
{
if (msgType == messageTypeText)
return WebSocketMessageType.Text;
if (msgType == messageTypeBinary)
return WebSocketMessageType.Binary;
return WebSocketMessageType.Close;
}
static byte MessageTypeToWire (WebSocketMessageType type)
{
if (type == WebSocketMessageType.Text)
return messageTypeText;
if (type == WebSocketMessageType.Binary)
return messageTypeBinary;
return messageTypeClose;
}
public override Task<WebSocketReceiveResult> ReceiveAsync (ArraySegment<byte> buffer, CancellationToken cancellationToken)
{
EnsureWebSocketConnected ();
ValidateArraySegment (buffer);
return Task.Run (() => {
EnsureWebSocketState (WebSocketState.Open, WebSocketState.CloseSent);
bool isLast;
WebSocketMessageType type;
long length;
if (remaining == 0) {
// First read the two first bytes to know what we are doing next
connection.Read (req, headerBuffer, 0, 2);
isLast = (headerBuffer[0] >> 7) > 0;
var isMasked = (headerBuffer[1] >> 7) > 0;
int mask = 0;
type = WireToMessageType ((byte)(headerBuffer[0] & 0xF));
length = headerBuffer[1] & 0x7F;
int offset = 0;
if (length == 126) {
offset = 2;
connection.Read (req, headerBuffer, 2, offset);
length = (headerBuffer[2] << 8) | headerBuffer[3];
} else if (length == 127) {
offset = 8;
connection.Read (req, headerBuffer, 2, offset);
length = 0;
for (int i = 2; i <= 9; i++)
length = (length << 8) | headerBuffer[i];
}
if (isMasked) {
connection.Read (req, headerBuffer, 2 + offset, 4);
for (int i = 0; i < 4; i++) {
var pos = i + offset + 2;
mask = (mask << 8) | headerBuffer[pos];
}
}
} else {
isLast = (headerBuffer[0] >> 7) > 0;
type = WireToMessageType ((byte)(headerBuffer[0] & 0xF));
length = remaining;
}
if (type == WebSocketMessageType.Close) {
state = WebSocketState.Closed;
var tmpBuffer = new byte[length];
connection.Read (req, tmpBuffer, 0, tmpBuffer.Length);
var closeStatus = (WebSocketCloseStatus)(tmpBuffer[0] << 8 | tmpBuffer[1]);
var closeDesc = tmpBuffer.Length > 2 ? Encoding.UTF8.GetString (tmpBuffer, 2, tmpBuffer.Length - 2) : string.Empty;
return new WebSocketReceiveResult ((int)length, type, isLast, closeStatus, closeDesc);
} else {
var readLength = (int)(buffer.Count < length ? buffer.Count : length);
connection.Read (req, buffer.Array, buffer.Offset, readLength);
remaining = length - readLength;
return new WebSocketReceiveResult ((int)readLength, type, isLast && remaining == 0);
}
});
}
// The damn difference between those two methods is that CloseAsync will wait for server acknowledgement before completing
// while CloseOutputAsync will send the close packet and simply complete.
public async override Task CloseAsync (WebSocketCloseStatus closeStatus, string statusDescription, CancellationToken cancellationToken)
{
EnsureWebSocketConnected ();
await SendCloseFrame (closeStatus, statusDescription, cancellationToken).ConfigureAwait (false);
state = WebSocketState.CloseSent;
// TODO: figure what's exceptions are thrown if the server returns something faulty here
await ReceiveAsync (new ArraySegment<byte> (new byte[0]), cancellationToken).ConfigureAwait (false);
state = WebSocketState.Closed;
}
public async override Task CloseOutputAsync (WebSocketCloseStatus closeStatus, string statusDescription, CancellationToken cancellationToken)
{
EnsureWebSocketConnected ();
await SendCloseFrame (closeStatus, statusDescription, cancellationToken).ConfigureAwait (false);
state = WebSocketState.CloseSent;
}
async Task SendCloseFrame (WebSocketCloseStatus closeStatus, string statusDescription, CancellationToken cancellationToken)
{
var statusDescBuffer = string.IsNullOrEmpty (statusDescription) ? new byte[2] : new byte[2 + Encoding.UTF8.GetByteCount (statusDescription)];
statusDescBuffer[0] = (byte)(((ushort)closeStatus) >> 8);
statusDescBuffer[1] = (byte)(((ushort)closeStatus) & 0xFF);
if (!string.IsNullOrEmpty (statusDescription))
Encoding.UTF8.GetBytes (statusDescription, 0, statusDescription.Length, statusDescBuffer, 2);
await SendAsync (new ArraySegment<byte> (statusDescBuffer), WebSocketMessageType.Close, true, cancellationToken).ConfigureAwait (false);
}
int WriteHeader (WebSocketMessageType type, ArraySegment<byte> buffer, bool endOfMessage)
{
var opCode = MessageTypeToWire (type);
var length = buffer.Count;
headerBuffer[0] = (byte)(opCode | (endOfMessage ? 0 : 0x80));
if (length < 126) {
headerBuffer[1] = (byte)length;
} else if (length <= ushort.MaxValue) {
headerBuffer[1] = (byte)126;
headerBuffer[2] = (byte)(length / 256);
headerBuffer[3] = (byte)(length % 256);
} else {
headerBuffer[1] = (byte)127;
int left = length;
int unit = 256;
for (int i = 9; i > 1; i--) {
headerBuffer[i] = (byte)(left % unit);
left = left / unit;
}
}
var l = Math.Max (0, headerBuffer[1] - 125);
var maskOffset = 2 + l * l * 2;
GenerateMask (headerBuffer, maskOffset);
// Since we are client only, we always mask the payload
headerBuffer[1] |= 0x80;
return maskOffset;
}
void GenerateMask (byte[] mask, int offset)
{
mask[offset + 0] = (byte)random.Next (0, 255);
mask[offset + 1] = (byte)random.Next (0, 255);
mask[offset + 2] = (byte)random.Next (0, 255);
mask[offset + 3] = (byte)random.Next (0, 255);
}
void MaskData (ArraySegment<byte> buffer, int maskOffset)
{
var sendBufferOffset = maskOffset + 4;
for (var i = 0; i < buffer.Count; i++)
sendBuffer[i + sendBufferOffset] = (byte)(buffer.Array[buffer.Offset + i] ^ headerBuffer[maskOffset + (i % 4)]);
}
void EnsureWebSocketConnected ()
{
if (state < WebSocketState.Open)
throw new InvalidOperationException ("The WebSocket is not connected");
}
void EnsureWebSocketState (params WebSocketState[] validStates)
{
foreach (var validState in validStates)
if (state == validState)
return;
throw new WebSocketException ("The WebSocket is in an invalid state ('" + state + "') for this operation. Valid states are: " + string.Join (", ", validStates));
}
void ValidateArraySegment (ArraySegment<byte> segment)
{
if (segment.Array == null)
throw new ArgumentNullException ("buffer.Array");
if (segment.Offset < 0)
throw new ArgumentOutOfRangeException ("buffer.Offset");
if (segment.Offset + segment.Count > segment.Array.Length)
throw new ArgumentOutOfRangeException ("buffer.Count");
}
}
}
#endif
|