NetCoreServer/source/NetCoreServer/WebSocket.cs at master · cdprf/NetCoreServer · GitHub

Repository navigation

History

645 lines (570 loc) · 25 KB

Raw

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

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

using System;

using System.Text;

using System.Security.Cryptography;

using System.Collections.Generic;

using System.Threading;

using System.Linq;

namespace NetCoreServer

{

/// <summary>

/// WebSocket utility class

/// </summary>

public class WebSocket : IWebSocket

{

private readonly IWebSocket _wsHandler;

/// <summary>

/// Initialize a new WebSocket

/// </summary>

/// <param name="wsHandler">WebSocket handler</param>

public WebSocket(IWebSocket wsHandler) { _wsHandler = wsHandler; ClearWsBuffers(); InitWsNonce(); }

/// <summary>

/// Final frame

/// </summary>

public const byte WS_FIN = 0x80;

/// <summary>

/// Text frame

/// </summary>

public const byte WS_TEXT = 0x01;

/// <summary>

/// Binary frame

/// </summary>

public const byte WS_BINARY = 0x02;

/// <summary>

/// Close frame

/// </summary>

public const byte WS_CLOSE = 0x08;

/// <summary>

/// Ping frame

/// </summary>

public const byte WS_PING = 0x09;

/// <summary>

/// Pong frame

/// </summary>

public const byte WS_PONG = 0x0A;

/// <summary>

/// Perform WebSocket client upgrade

/// </summary>

/// <param name="response">WebSocket upgrade HTTP response</param>

/// <param name="id">WebSocket client Id</param>

/// <returns>'true' if the WebSocket was successfully upgrade, 'false' if the WebSocket was not upgrade</returns>

public bool PerformClientUpgrade(HttpResponse response, Guid id)

{

if (response.Status != 101)

return false;

bool error = false;

bool accept = false;

bool connection = false;

bool upgrade = false;

// Validate WebSocket handshake headers

for (int i = 0; i < response.Headers; i++)

{

var header = response.Header(i);

var key = header.Item1;

var value = header.Item2;

if (string.Compare(key, "Connection", StringComparison.OrdinalIgnoreCase) == 0)

{

if (string.Compare(value, "Upgrade", StringComparison.OrdinalIgnoreCase) != 0)

{

error = true;

_wsHandler.OnWsError("Invalid WebSocket handshaked response: 'Connection' header value must be 'Upgrade'");

break;

}

connection = true;

}

else if (string.Compare(key, "Upgrade", StringComparison.OrdinalIgnoreCase) == 0)

{

if (string.Compare(value, "websocket", StringComparison.OrdinalIgnoreCase) != 0)

{

error = true;

_wsHandler.OnWsError("Invalid WebSocket handshaked response: 'Upgrade' header value must be 'websocket'");

break;

}

upgrade = true;

}

else if (string.Compare(key, "Sec-WebSocket-Accept", StringComparison.OrdinalIgnoreCase) == 0)

{

// Calculate the original WebSocket hash

string wskey = Convert.ToBase64String(WsNonce) + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";

string wshash;

using (SHA1 sha1 = SHA1.Create())

{

wshash = Encoding.UTF8.GetString(sha1.ComputeHash(Encoding.UTF8.GetBytes(wskey)));

}

// Get the received WebSocket hash

wskey = Encoding.UTF8.GetString(Convert.FromBase64String(value));

// Compare original and received hashes

if (string.Compare(wskey, wshash, StringComparison.InvariantCulture) != 0)

{

error = true;

_wsHandler.OnWsError("Invalid WebSocket handshaked response: 'Sec-WebSocket-Accept' value validation failed");

break;

}

accept = true;

}

// Failed to perform WebSocket handshake

if (!accept || !connection || !upgrade)

{

if (!error)

_wsHandler.OnWsError("Invalid WebSocket response");

return false;

}

// WebSocket successfully handshaked!

WsHandshaked = true;

WsRandom.NextBytes(WsSendMask);

_wsHandler.OnWsConnected(response);

return true;

}

/// <summary>

/// Perform WebSocket server upgrade

/// </summary>

/// <param name="request">WebSocket upgrade HTTP request</param>

/// <param name="response">WebSocket upgrade HTTP response</param>

/// <returns>'true' if the WebSocket was successfully upgrade, 'false' if the WebSocket was not upgrade</returns>

public bool PerformServerUpgrade(HttpRequest request, HttpResponse response)

{

if (request.Method != "GET")

return false;

bool error = false;

bool connection = false;

bool upgrade = false;

bool wsKey = false;

bool wsVersion = false;

string accept = "";

// Validate WebSocket handshake headers

for (int i = 0; i < request.Headers; i++)

{

var header = request.Header(i);

var key = header.Item1;

var value = header.Item2;

if (string.Compare(key, "Connection", StringComparison.OrdinalIgnoreCase) == 0)

{

if ((string.Compare(value, "Upgrade", StringComparison.OrdinalIgnoreCase) != 0) && (string.Compare(value.RemoveWhiteSpace(), "keep-alive,Upgrade", StringComparison.OrdinalIgnoreCase) != 0))

{

error = true;

response.MakeErrorResponse(400, "Invalid WebSocket handshaked request: 'Connection' header value must be 'Upgrade' or 'keep-alive, Upgrade'");

break;

}

connection = true;

}

else if (string.Compare(key, "Upgrade", StringComparison.OrdinalIgnoreCase) == 0)

{

if (string.Compare(value, "websocket", StringComparison.OrdinalIgnoreCase) != 0)

{

error = true;

response.MakeErrorResponse(400, "Invalid WebSocket handshaked request: 'Upgrade' header value must be 'websocket'");

break;

}

upgrade = true;

}

else if (string.Compare(key, "Sec-WebSocket-Key", StringComparison.OrdinalIgnoreCase) == 0)

{

if (string.IsNullOrEmpty(value))

{

error = true;

response.MakeErrorResponse(400, "Invalid WebSocket handshaked request: 'Sec-WebSocket-Key' header value must be non empty");

break;

}

// Calculate the original WebSocket hash

string wskey = value + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";

byte[] wshash;

using (SHA1 sha1 = SHA1.Create())

{

wshash = sha1.ComputeHash(Encoding.UTF8.GetBytes(wskey));

}

accept = Convert.ToBase64String(wshash);

wsKey = true;

}

else if (string.Compare(key, "Sec-WebSocket-Version", StringComparison.OrdinalIgnoreCase) == 0)

{

if (string.Compare(value, "13", StringComparison.OrdinalIgnoreCase) != 0)

{

error = true;

response.MakeErrorResponse(400, "Invalid WebSocket handshaked request: 'Sec-WebSocket-Version' header value must be '13'");

break;

}

wsVersion = true;

}

// Filter out non WebSocket handshake requests

if (!connection && !upgrade && !wsKey && !wsVersion)

return false;

// Failed to perform WebSocket handshake

if (!connection || !upgrade || !wsKey || !wsVersion)

{

if (!error)

response.MakeErrorResponse(400, "Invalid WebSocket response");

_wsHandler.SendUpgrade(response);

return false;

}

// Prepare WebSocket upgrade success response

response.Clear();

response.SetBegin(101);

response.SetHeader("Connection", "Upgrade");

response.SetHeader("Upgrade", "websocket");

response.SetHeader("Sec-WebSocket-Accept", accept);

// Validate WebSocket upgrade request and response

if (!_wsHandler.OnWsConnecting(request, response))

return false;

// Set body of the WebSocket upgrade response

response.SetBody();

// Send WebSocket upgrade response

_wsHandler.SendUpgrade(response);

// WebSocket successfully handshaked!

WsHandshaked = true;

Array.Fill(WsSendMask, (byte)0);

_wsHandler.OnWsConnected(request);

return true;

}

/// <summary>

/// Prepare WebSocket send frame

/// </summary>

/// <param name="opcode">WebSocket opcode</param>

/// <param name="mask">WebSocket mask</param>

/// <param name="buffer">Buffer to send as a span of bytes</param>

/// <param name="status">WebSocket status (default is 0)</param>

public void PrepareSendFrame(byte opcode, bool mask, ReadOnlySpan<byte> buffer, int status = 0)

{

// Check if we need to store additional 2 bytes of close status frame

bool storeStatus = ((opcode & WS_CLOSE) == WS_CLOSE) && ((buffer.Length > 0) || (status != 0));

long size = storeStatus ? (buffer.Length + 2) : buffer.Length;

// Clear the previous WebSocket send buffer

WsSendBuffer.Clear();

// Append WebSocket frame opcode

WsSendBuffer.Append(opcode);

// Append WebSocket frame size

if (size <= 125)

WsSendBuffer.Append((byte)(((int)size & 0xFF) | (mask ? 0x80 : 0)));

else if (size <= 65535)

{

WsSendBuffer.Append((byte)(126 | (mask ? 0x80 : 0)));

WsSendBuffer.Append((byte)((size >> 8) & 0xFF));

WsSendBuffer.Append((byte)(size & 0xFF));

}

else

{

WsSendBuffer.Append((byte)(127 | (mask ? 0x80 : 0)));

for (int i = 7; i >= 0; i--)

WsSendBuffer.Append((byte)((size >> (8 * i)) & 0xFF));

}

if (mask)

{

// Append WebSocket frame mask

WsSendBuffer.Append(WsSendMask);

}

// Resize WebSocket frame buffer

long offset = WsSendBuffer.Size;

WsSendBuffer.Resize(WsSendBuffer.Size + size);

int index = 0;

// Append WebSocket close status

// RFC 6455: If there is a body, the first two bytes of the body MUST

// be a 2-byte unsigned integer (in network byte order) representing

// a status code with value code.

if (storeStatus)

{

index += 2;

WsSendBuffer.Data[offset + 0] = (byte)(((status >> 8) & 0xFF) ^ WsSendMask[0]);

WsSendBuffer.Data[offset + 1] = (byte)((status & 0xFF) ^ WsSendMask[1]);

}

// Mask WebSocket frame content

for (int i = index; i < size; i++)

WsSendBuffer.Data[offset + i] = (byte)(buffer[i - index] ^ WsSendMask[i % 4]);

}

/// <summary>

/// Prepare WebSocket send frame

/// </summary>

/// <param name="buffer">Buffer to send</param>

/// <param name="offset">Buffer offset</param>

/// <param name="size">Buffer size</param>

public void PrepareReceiveFrame(byte[] buffer, long offset, long size)

{

lock (WsReceiveLock)

{

int index = 0;

// Clear received data after WebSocket frame was processed

if (WsFrameReceived)

{

WsFrameReceived = false;

WsHeaderSize = 0;

WsPayloadSize = 0;

WsReceiveFrameBuffer.Clear();

Array.Clear(WsReceiveMask, 0, WsReceiveMask.Length);

}

if (WsFinalReceived)

{

WsFinalReceived = false;

WsReceiveFinalBuffer.Clear();

}

while (size > 0)

{

// Clear received data after WebSocket frame was processed

if (WsFrameReceived)

{

WsFrameReceived = false;

WsHeaderSize = 0;

WsPayloadSize = 0;

WsReceiveFrameBuffer.Clear();

Array.Clear(WsReceiveMask, 0, WsReceiveMask.Length);

}

if (WsFinalReceived)

{

WsFinalReceived = false;

WsReceiveFinalBuffer.Clear();

}

// Prepare WebSocket frame opcode and mask flag

if (WsReceiveFrameBuffer.Size < 2)

{

for (long i = 0; i < 2; i++, index++, size--)

{

if (size == 0)

return;

WsReceiveFrameBuffer.Append(buffer[offset + index]);

}

byte opcode = (byte)(WsReceiveFrameBuffer[0] & 0x0F);

bool fin = ((WsReceiveFrameBuffer[0] >> 7) & 0x01) != 0;

bool mask = ((WsReceiveFrameBuffer[1] >> 7) & 0x01) != 0;

long payload = (long)WsReceiveFrameBuffer[1] & (~0x80);

// Prepare WebSocket opcode

WsOpcode = (opcode != 0) ? opcode : WsOpcode;

// Prepare WebSocket frame size

if (payload <= 125)

{

WsHeaderSize = 2 + (mask ? 4 : 0);

WsPayloadSize = payload;

}

else if (payload == 126)

{

if (WsReceiveFrameBuffer.Size < 4)

{

for (long i = 0; i < 2; i++, index++, size--)

{

if (size == 0)

return;

WsReceiveFrameBuffer.Append(buffer[offset + index]);

}

payload = (((long)WsReceiveFrameBuffer[2] << 8) | ((long)WsReceiveFrameBuffer[3] << 0));

WsHeaderSize = 4 + (mask ? 4 : 0);

WsPayloadSize = payload;

}

else if (payload == 127)

{

if (WsReceiveFrameBuffer.Size < 10)

{

for (long i = 0; i < 8; i++, index++, size--)

{

if (size == 0)

return;

WsReceiveFrameBuffer.Append(buffer[offset + index]);

}

WsHeaderSize = 10 + (mask ? 4 : 0);

WsPayloadSize = payload;

}

// Prepare WebSocket frame mask

if (mask)

{

if (WsReceiveFrameBuffer.Size < WsHeaderSize)

{

for (long i = 0; i < 4; i++, index++, size--)

{

if (size == 0)

return;

WsReceiveFrameBuffer.Append(buffer[offset + index]);

WsReceiveMask[i] = buffer[offset + index];

}

long total = WsHeaderSize + WsPayloadSize;

long length = Math.Min(total - WsReceiveFrameBuffer.Size, size);

// Prepare WebSocket frame payload

WsReceiveFrameBuffer.Append(buffer[((int)offset + index)..((int)offset + index + (int)length)]);

index += (int)length;

size -= length;

// Process WebSocket frame

if (WsReceiveFrameBuffer.Size == total)

{

// Unmask WebSocket frame content

if (mask)

{

for (long i = 0; i < WsPayloadSize; i++)

WsReceiveFinalBuffer.Append((byte)(WsReceiveFrameBuffer[WsHeaderSize + i] ^ WsReceiveMask[i % 4]));

}

else

WsReceiveFinalBuffer.Append(WsReceiveFrameBuffer.AsSpan().Slice((int)WsHeaderSize, (int)WsPayloadSize));

WsFrameReceived = true;

// Finalize WebSocket frame

if (fin)

{

WsFinalReceived = true;

switch (WsOpcode)

{

case WS_PING:

{

// Call the WebSocket ping handler

_wsHandler.OnWsPing(WsReceiveFinalBuffer.Data, 0, WsReceiveFinalBuffer.Size);

break;

}

case WS_PONG:

{

// Call the WebSocket pong handler

_wsHandler.OnWsPong(WsReceiveFinalBuffer.Data, 0, WsReceiveFinalBuffer.Size);

break;

}

case WS_CLOSE:

{

int sindex = 0;

int status = 1000;

// Read WebSocket close status

if (WsReceiveFinalBuffer.Size >= 2)

{

sindex += 2;

status = (((int)WsReceiveFinalBuffer[0] << 8) | ((int)WsReceiveFinalBuffer[1] << 0));

}

// Call the WebSocket close handler

_wsHandler.OnWsClose(WsReceiveFinalBuffer.Data, sindex, WsReceiveFinalBuffer.Size - sindex, status);

break;

}

case WS_BINARY:

case WS_TEXT:

{

// Call the WebSocket received handler

_wsHandler.OnWsReceived(WsReceiveFinalBuffer.Data, 0, WsReceiveFinalBuffer.Size);

break;

}

/// <summary>

/// Required WebSocket receive frame size

/// </summary>

public long RequiredReceiveFrameSize()

{

lock (WsReceiveLock)

{

if (WsFrameReceived)

return 0;

// Required WebSocket frame opcode and mask flag

if (WsReceiveFrameBuffer.Size < 2)

return 2 - WsReceiveFrameBuffer.Size;

bool mask = ((WsReceiveFrameBuffer[1] >> 7) & 0x01) != 0;

long payload = (long)WsReceiveFrameBuffer[1] & (~0x80);

// Required WebSocket frame size

if ((payload == 126) && (WsReceiveFrameBuffer.Size < 4))

return 4 - WsReceiveFrameBuffer.Size;

if ((payload == 127) && (WsReceiveFrameBuffer.Size < 10))

return 10 - WsReceiveFrameBuffer.Size;

// Required WebSocket frame mask

if ((mask) && (WsReceiveFrameBuffer.Size < WsHeaderSize))

return WsHeaderSize - WsReceiveFrameBuffer.Size;

// Required WebSocket frame payload

return WsHeaderSize + WsPayloadSize - WsReceiveFrameBuffer.Size;

}

/// <summary>

/// Clear WebSocket send/receive buffers

/// </summary>

public void ClearWsBuffers()

{

// Clear the receive buffer

bool acquiredReceiveLock = false;

try

{

// Sometimes on disconnect the receive lock could be taken by receive thread.

// In this case we'll skip the receive buffer clearing. It will happen on

// re-connect then or in GC.

Monitor.TryEnter(WsReceiveLock, ref acquiredReceiveLock);

if (acquiredReceiveLock)

{

WsFrameReceived = false;

WsFinalReceived = false;

WsHeaderSize = 0;

WsPayloadSize = 0;

WsReceiveFrameBuffer.Clear();

WsReceiveFinalBuffer.Clear();

Array.Clear(WsReceiveMask, 0, WsReceiveMask.Length);

}

finally

{

if (acquiredReceiveLock)

Monitor.Exit(WsReceiveLock);

}

// Clear the send buffer

lock (WsSendLock)

{

WsSendBuffer.Clear();

Array.Clear(WsSendMask, 0, WsSendMask.Length);

}

/// <summary>

/// Initialize WebSocket random nonce

/// </summary>

public void InitWsNonce() => WsRandom.NextBytes(WsNonce);

/// <summary>

/// Handshaked flag

/// </summary>

internal bool WsHandshaked;

/// <summary>

/// Received frame flag

/// </summary>

internal bool WsFrameReceived;

/// <summary>

/// Received final flag

/// </summary>

internal bool WsFinalReceived;

/// <summary>

/// Received frame opcode

/// </summary>

internal byte WsOpcode;

/// <summary>

/// Received frame header size

/// </summary>

internal long WsHeaderSize;

/// <summary>

/// Received frame payload size

/// </summary>

internal long WsPayloadSize;

/// <summary>

/// Receive buffer lock

/// </summary>

internal readonly object WsReceiveLock = new object();

/// <summary>

/// Receive frame buffer

/// </summary>

internal readonly Buffer WsReceiveFrameBuffer = new Buffer();

/// <summary>

/// Receive final buffer

/// </summary>

internal readonly Buffer WsReceiveFinalBuffer = new Buffer();

/// <summary>

/// Receive mask

/// </summary>

internal readonly byte[] WsReceiveMask = new byte[4];

/// <summary>

/// Send buffer lock

/// </summary>

internal readonly object WsSendLock = new object();

/// <summary>

/// Send buffer

/// </summary>

internal readonly Buffer WsSendBuffer = new Buffer();

/// <summary>

/// Send mask

/// </summary>

internal readonly byte[] WsSendMask = new byte[4];

/// <summary>

/// WebSocket random generator

/// </summary>

internal readonly Random WsRandom = new Random();

/// <summary>

/// WebSocket random nonce of 16 bytes

/// </summary>

internal readonly byte[] WsNonce = new byte[16];

}

NetCoreServer/source/NetCoreServer/WebSocket.cs at master · cdprf/NetCoreServer · GitHub

Repository navigation

Expand file tree

Breadcrumbs

WebSocket.cs

Latest commit

History

Breadcrumbs

WebSocket.cs

File metadata and controls