Source/WebCore/websockets/WebSocketChannel.cpp

   1 /*
   2  * Copyright (C) 2011, 2012 Google Inc.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #include "config.h"
  32
  33 #if ENABLE(WEB_SOCKETS)
  34
  35 #include "WebSocketChannel.h"
  36
  37 #include "Blob.h"
  38 #include "CookieJar.h"
  39 #include "Document.h"
  40 #include "FileError.h"
  41 #include "FileReaderLoader.h"
  42 #include "InspectorInstrumentation.h"
  43 #include "Logging.h"
  44 #include "Page.h"
  45 #include "ProgressTracker.h"
  46 #include "ScriptCallStack.h"
  47 #include "ScriptExecutionContext.h"
  48 #include "Settings.h"
  49 #include "SocketStreamError.h"
  50 #include "SocketStreamHandle.h"
  51 #include "WebSocketChannelClient.h"
  52 #include "WebSocketHandshake.h"
  53
  54 #include <wtf/ArrayBuffer.h>
  55 #include <wtf/CryptographicallyRandomNumber.h>
  56 #include <wtf/Deque.h>
  57 #include <wtf/FastMalloc.h>
  58 #include <wtf/HashMap.h>
  59 #include <wtf/OwnPtr.h>
  60 #include <wtf/PassOwnPtr.h>
  61 #include <wtf/text/CString.h>
  62 #include <wtf/text/StringHash.h>
  63 #include <wtf/text/WTFString.h>
  64
  65 using namespace std;
  66
  67 namespace WebCore {
  68
  69 const double TCPMaximumSegmentLifetime = 2 * 60.0;
  70
  71 // Constants for hybi-10 frame format.
  72 const unsigned char finalBit = 0x80;
  73 const unsigned char compressBit = 0x40;
  74 const unsigned char reserved2Bit = 0x20;
  75 const unsigned char reserved3Bit = 0x10;
  76 const unsigned char opCodeMask = 0xF;
  77 const unsigned char maskBit = 0x80;
  78 const unsigned char payloadLengthMask = 0x7F;
  79 const size_t maxPayloadLengthWithoutExtendedLengthField = 125;
  80 const size_t payloadLengthWithTwoByteExtendedLengthField = 126;
  81 const size_t payloadLengthWithEightByteExtendedLengthField = 127;
  82 const size_t maskingKeyWidthInBytes = 4;
  83
  84 WebSocketChannel::WebSocketChannel(Document* document, WebSocketChannelClient* client)
  85     : m_document(document)
  86     , m_client(client)
  87     , m_buffer(0)
  88     , m_bufferSize(0)
  89     , m_resumeTimer(this, &WebSocketChannel::resumeTimerFired)
  90     , m_suspended(false)
  91     , m_closing(false)
  92     , m_receivedClosingHandshake(false)
  93     , m_closingTimer(this, &WebSocketChannel::closingTimerFired)
  94     , m_closed(false)
  95     , m_shouldDiscardReceivedData(false)
  96     , m_unhandledBufferedAmount(0)
  97     , m_identifier(0)
  98     , m_useHixie76Protocol(true)
  99     , m_hasContinuousFrame(false)
 100     , m_closeEventCode(CloseEventCodeAbnormalClosure)
 101     , m_outgoingFrameQueueStatus(OutgoingFrameQueueOpen)
 102 #if ENABLE(BLOB)
 103     , m_blobLoaderStatus(BlobLoaderNotStarted)
 104 #endif
 105 {
 106     if (Settings* settings = m_document->settings())
 107         m_useHixie76Protocol = settings->useHixie76WebSocketProtocol();
 108
 109     if (Page* page = m_document->page())
 110         m_identifier = page->progress()->createUniqueIdentifier();
 111 }
 112
 113 WebSocketChannel::~WebSocketChannel()
 114 {
 115     fastFree(m_buffer);
 116 }
 117
 118 bool WebSocketChannel::useHixie76Protocol()
 119 {
 120     return m_useHixie76Protocol;
 121 }
 122
 123 void WebSocketChannel::connect(const KURL& url, const String& protocol)
 124 {
 125     LOG(Network, "WebSocketChannel %p connect", this);
 126     ASSERT(!m_handle);
 127     ASSERT(!m_suspended);
 128     m_handshake = adoptPtr(new WebSocketHandshake(url, protocol, m_document, m_useHixie76Protocol));
 129     m_handshake->reset();
 130     if (m_identifier)
 131         InspectorInstrumentation::didCreateWebSocket(m_document, m_identifier, url, m_document->url());
 132     ref();
 133     m_handle = SocketStreamHandle::create(m_handshake->url(), this);
 134 }
 135
 136 String WebSocketChannel::subprotocol()
 137 {
 138     LOG(Network, "WebSocketChannel %p subprotocol", this);
 139     if (!m_handshake || m_handshake->mode() != WebSocketHandshake::Connected)
 140         return "";
 141     String serverProtocol = m_handshake->serverWebSocketProtocol();
 142     if (serverProtocol.isNull())
 143         return "";
 144     return serverProtocol;
 145 }
 146
 147 String WebSocketChannel::extensions()
 148 {
 149     LOG(Network, "WebSocketChannel %p extensions", this);
 150     if (!m_handshake || m_handshake->mode() != WebSocketHandshake::Connected)
 151         return "";
 152     String extensions = m_handshake->acceptedExtensions();
 153     if (extensions.isNull())
 154         return "";
 155     return extensions;
 156 }
 157
 158 bool WebSocketChannel::send(const String& message)
 159 {
 160     LOG(Network, "WebSocketChannel %p send %s", this, message.utf8().data());
 161     if (m_useHixie76Protocol) {
 162         CString utf8 = message.utf8();
 163         return sendFrameHixie76(utf8.data(), utf8.length());
 164     }
 165     enqueueTextFrame(message);
 166     // According to WebSocket API specification, WebSocket.send() should return void instead
 167     // of boolean. However, our implementation still returns boolean due to compatibility
 168     // concern (see bug 65850).
 169     // m_channel->send() may happen later, thus it's not always possible to know whether
 170     // the message has been sent to the socket successfully. In this case, we have no choice
 171     // but to return true.
 172     return true;
 173 }
 174
 175 bool WebSocketChannel::send(const ArrayBuffer& binaryData)
 176 {
 177     LOG(Network, "WebSocketChannel %p send arraybuffer %p", this, &binaryData);
 178     ASSERT(!m_useHixie76Protocol);
 179     enqueueRawFrame(WebSocketFrame::OpCodeBinary, static_cast<const char*>(binaryData.data()), binaryData.byteLength());
 180     return true;
 181 }
 182
 183 bool WebSocketChannel::send(const Blob& binaryData)
 184 {
 185     LOG(Network, "WebSocketChannel %p send blob %s", this, binaryData.url().string().utf8().data());
 186     ASSERT(!m_useHixie76Protocol);
 187     enqueueBlobFrame(WebSocketFrame::OpCodeBinary, binaryData);
 188     return true;
 189 }
 190
 191 bool WebSocketChannel::send(const char* data, int length)
 192 {
 193     LOG(Network, "WebSocketChannel %p send binary %p (%dB)", this, data, length);
 194     ASSERT(!m_useHixie76Protocol);
 195     enqueueRawFrame(WebSocketFrame::OpCodeBinary, data, length);
 196     return true;
 197 }
 198
 199 unsigned long WebSocketChannel::bufferedAmount() const
 200 {
 201     LOG(Network, "WebSocketChannel %p bufferedAmount", this);
 202     ASSERT(m_handle);
 203     ASSERT(!m_suspended);
 204     return m_handle->bufferedAmount();
 205 }
 206
 207 void WebSocketChannel::close(int code, const String& reason)
 208 {
 209     LOG(Network, "WebSocketChannel %p close", this);
 210     ASSERT(!m_suspended);
 211     if (!m_handle)
 212         return;
 213     startClosingHandshake(code, reason);
 214     if (m_closing && !m_closingTimer.isActive())
 215         m_closingTimer.startOneShot(2 * TCPMaximumSegmentLifetime);
 216 }
 217
 218 void WebSocketChannel::fail(const String& reason)
 219 {
 220     LOG(Network, "WebSocketChannel %p fail: %s", this, reason.utf8().data());
 221     ASSERT(!m_suspended);
 222     if (m_document)
 223         m_document->addConsoleMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, reason, m_handshake->clientOrigin());
 224     if (!m_useHixie76Protocol) {
 225         // Hybi-10 specification explicitly states we must not continue to handle incoming data
 226         // once the WebSocket connection is failed (section 7.1.7).
 227         // FIXME: Should we do this in hixie-76 too?
 228         m_shouldDiscardReceivedData = true;
 229         if (m_buffer)
 230             skipBuffer(m_bufferSize); // Save memory.
 231         m_hasContinuousFrame = false;
 232         m_continuousFrameData.clear();
 233     }
 234     if (m_handle && !m_closed)
 235         m_handle->disconnect(); // Will call didClose().
 236 }
 237
 238 void WebSocketChannel::disconnect()
 239 {
 240     LOG(Network, "WebSocketChannel %p disconnect", this);
 241     if (m_identifier && m_document)
 242         InspectorInstrumentation::didCloseWebSocket(m_document, m_identifier);
 243     if (m_handshake)
 244         m_handshake->clearScriptExecutionContext();
 245     m_client = 0;
 246     m_document = 0;
 247     if (m_handle)
 248         m_handle->disconnect();
 249 }
 250
 251 void WebSocketChannel::suspend()
 252 {
 253     m_suspended = true;
 254 }
 255
 256 void WebSocketChannel::resume()
 257 {
 258     m_suspended = false;
 259     if ((m_buffer || m_closed) && m_client && !m_resumeTimer.isActive())
 260         m_resumeTimer.startOneShot(0);
 261 }
 262
 263 void WebSocketChannel::didOpenSocketStream(SocketStreamHandle* handle)
 264 {
 265     LOG(Network, "WebSocketChannel %p didOpenSocketStream", this);
 266     ASSERT(handle == m_handle);
 267     if (!m_document)
 268         return;
 269     if (m_identifier)
 270         InspectorInstrumentation::willSendWebSocketHandshakeRequest(m_document, m_identifier, m_handshake->clientHandshakeRequest());
 271     CString handshakeMessage = m_handshake->clientHandshakeMessage();
 272     if (!handle->send(handshakeMessage.data(), handshakeMessage.length()))
 273         fail("Failed to send WebSocket handshake.");
 274 }
 275
 276 void WebSocketChannel::didCloseSocketStream(SocketStreamHandle* handle)
 277 {
 278     LOG(Network, "WebSocketChannel %p didCloseSocketStream", this);
 279     if (m_identifier && m_document)
 280         InspectorInstrumentation::didCloseWebSocket(m_document, m_identifier);
 281     ASSERT_UNUSED(handle, handle == m_handle || !m_handle);
 282     m_closed = true;
 283     if (m_closingTimer.isActive())
 284         m_closingTimer.stop();
 285     if (!m_useHixie76Protocol && m_outgoingFrameQueueStatus != OutgoingFrameQueueClosed)
 286         abortOutgoingFrameQueue();
 287     if (m_handle) {
 288         m_unhandledBufferedAmount = m_handle->bufferedAmount();
 289         if (m_suspended)
 290             return;
 291         WebSocketChannelClient* client = m_client;
 292         m_client = 0;
 293         m_document = 0;
 294         m_handle = 0;
 295         if (client)
 296             client->didClose(m_unhandledBufferedAmount, m_receivedClosingHandshake ? WebSocketChannelClient::ClosingHandshakeComplete : WebSocketChannelClient::ClosingHandshakeIncomplete, m_closeEventCode, m_closeEventReason);
 297     }
 298     deref();
 299 }
 300
 301 void WebSocketChannel::didReceiveSocketStreamData(SocketStreamHandle* handle, const char* data, int len)
 302 {
 303     LOG(Network, "WebSocketChannel %p didReceiveSocketStreamData %d", this, len);
 304     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
 305     ASSERT(handle == m_handle);
 306     if (!m_document) {
 307         return;
 308     }
 309     if (len <= 0) {
 310         handle->disconnect();
 311         return;
 312     }
 313     if (!m_client) {
 314         m_shouldDiscardReceivedData = true;
 315         handle->disconnect();
 316         return;
 317     }
 318     if (m_shouldDiscardReceivedData)
 319         return;
 320     if (!appendToBuffer(data, len)) {
 321         m_shouldDiscardReceivedData = true;
 322         fail("Ran out of memory while receiving WebSocket data.");
 323         return;
 324     }
 325     while (!m_suspended && m_client && m_buffer)
 326         if (!processBuffer())
 327             break;
 328 }
 329
 330 void WebSocketChannel::didUpdateBufferedAmount(SocketStreamHandle*, size_t bufferedAmount)
 331 {
 332     if (m_client)
 333         m_client->didUpdateBufferedAmount(bufferedAmount);
 334 }
 335
 336 void WebSocketChannel::didFailSocketStream(SocketStreamHandle* handle, const SocketStreamError& error)
 337 {
 338     LOG(Network, "WebSocketChannel %p didFailSocketStream", this);
 339     ASSERT(handle == m_handle || !m_handle);
 340     if (m_document) {
 341         String message;
 342         if (error.isNull())
 343             message = "WebSocket network error";
 344         else if (error.localizedDescription().isNull())
 345             message = "WebSocket network error: error code " + String::number(error.errorCode());
 346         else
 347             message = "WebSocket network error: " + error.localizedDescription();
 348         String failingURL = error.failingURL();
 349         ASSERT(failingURL.isNull() || m_handshake->url().string() == failingURL);
 350         if (failingURL.isNull())
 351             failingURL = m_handshake->url().string();
 352         m_document->addConsoleMessage(NetworkMessageSource, LogMessageType, ErrorMessageLevel, message, failingURL);
 353     }
 354     m_shouldDiscardReceivedData = true;
 355     handle->disconnect();
 356 }
 357
 358 void WebSocketChannel::didReceiveAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
 359 {
 360 }
 361
 362 void WebSocketChannel::didCancelAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
 363 {
 364 }
 365
 366 #if ENABLE(BLOB)
 367 void WebSocketChannel::didStartLoading()
 368 {
 369     LOG(Network, "WebSocketChannel %p didStartLoading", this);
 370     ASSERT(m_blobLoader);
 371     ASSERT(m_blobLoaderStatus == BlobLoaderStarted);
 372 }
 373
 374 void WebSocketChannel::didReceiveData()
 375 {
 376     LOG(Network, "WebSocketChannel %p didReceiveData", this);
 377     ASSERT(m_blobLoader);
 378     ASSERT(m_blobLoaderStatus == BlobLoaderStarted);
 379 }
 380
 381 void WebSocketChannel::didFinishLoading()
 382 {
 383     LOG(Network, "WebSocketChannel %p didFinishLoading", this);
 384     ASSERT(m_blobLoader);
 385     ASSERT(m_blobLoaderStatus == BlobLoaderStarted);
 386     m_blobLoaderStatus = BlobLoaderFinished;
 387     processOutgoingFrameQueue();
 388     deref();
 389 }
 390
 391 void WebSocketChannel::didFail(int errorCode)
 392 {
 393     LOG(Network, "WebSocketChannel %p didFail %d", this, errorCode);
 394     ASSERT(m_blobLoader);
 395     ASSERT(m_blobLoaderStatus == BlobLoaderStarted);
 396     m_blobLoader.clear();
 397     m_blobLoaderStatus = BlobLoaderFailed;
 398     fail("Failed to load Blob: error code = " + String::number(errorCode)); // FIXME: Generate human-friendly reason message.
 399     deref();
 400 }
 401 #endif
 402
 403 bool WebSocketChannel::appendToBuffer(const char* data, size_t len)
 404 {
 405     size_t newBufferSize = m_bufferSize + len;
 406     if (newBufferSize < m_bufferSize) {
 407         LOG(Network, "WebSocket buffer overflow (%lu+%lu)", static_cast<unsigned long>(m_bufferSize), static_cast<unsigned long>(len));
 408         return false;
 409     }
 410     char* newBuffer = 0;
 411     if (!tryFastMalloc(newBufferSize).getValue(newBuffer))
 412         return false;
 413
 414     if (m_buffer)
 415         memcpy(newBuffer, m_buffer, m_bufferSize);
 416     memcpy(newBuffer + m_bufferSize, data, len);
 417     fastFree(m_buffer);
 418     m_buffer = newBuffer;
 419     m_bufferSize = newBufferSize;
 420     return true;
 421 }
 422
 423 void WebSocketChannel::skipBuffer(size_t len)
 424 {
 425     ASSERT(len <= m_bufferSize);
 426     m_bufferSize -= len;
 427     if (!m_bufferSize) {
 428         fastFree(m_buffer);
 429         m_buffer = 0;
 430         return;
 431     }
 432     memmove(m_buffer, m_buffer + len, m_bufferSize);
 433 }
 434
 435 bool WebSocketChannel::processBuffer()
 436 {
 437     ASSERT(!m_suspended);
 438     ASSERT(m_client);
 439     ASSERT(m_buffer);
 440     LOG(Network, "WebSocketChannel %p processBuffer %lu", this, static_cast<unsigned long>(m_bufferSize));
 441
 442     if (m_shouldDiscardReceivedData)
 443         return false;
 444
 445     if (m_receivedClosingHandshake) {
 446         skipBuffer(m_bufferSize);
 447         return false;
 448     }
 449
 450     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
 451
 452     if (m_handshake->mode() == WebSocketHandshake::Incomplete) {
 453         int headerLength = m_handshake->readServerHandshake(m_buffer, m_bufferSize);
 454         if (headerLength <= 0)
 455             return false;
 456         if (m_handshake->mode() == WebSocketHandshake::Connected) {
 457             if (m_identifier)
 458                 InspectorInstrumentation::didReceiveWebSocketHandshakeResponse(m_document, m_identifier, m_handshake->serverHandshakeResponse());
 459             if (!m_handshake->serverSetCookie().isEmpty()) {
 460                 if (cookiesEnabled(m_document)) {
 461                     ExceptionCode ec; // Exception (for sandboxed documents) ignored.
 462                     m_document->setCookie(m_handshake->serverSetCookie(), ec);
 463                 }
 464             }
 465             // FIXME: handle set-cookie2.
 466             LOG(Network, "WebSocketChannel %p connected", this);
 467             skipBuffer(headerLength);
 468             m_client->didConnect();
 469             LOG(Network, "remaining in read buf %lu", static_cast<unsigned long>(m_bufferSize));
 470             return m_buffer;
 471         }
 472         ASSERT(m_handshake->mode() == WebSocketHandshake::Failed);
 473         LOG(Network, "WebSocketChannel %p connection failed", this);
 474         skipBuffer(headerLength);
 475         m_shouldDiscardReceivedData = true;
 476         fail(m_handshake->failureReason());
 477         return false;
 478     }
 479     if (m_handshake->mode() != WebSocketHandshake::Connected)
 480         return false;
 481
 482     if (m_useHixie76Protocol)
 483         return processFrameHixie76();
 484
 485     return processFrame();
 486 }
 487
 488 void WebSocketChannel::resumeTimerFired(Timer<WebSocketChannel>* timer)
 489 {
 490     ASSERT_UNUSED(timer, timer == &m_resumeTimer);
 491
 492     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
 493     while (!m_suspended && m_client && m_buffer)
 494         if (!processBuffer())
 495             break;
 496     if (!m_suspended && m_client && m_closed && m_handle)
 497         didCloseSocketStream(m_handle.get());
 498 }
 499
 500 void WebSocketChannel::startClosingHandshake(int code, const String& reason)
 501 {
 502     LOG(Network, "WebSocketChannel %p closing %d %d", this, m_closing, m_receivedClosingHandshake);
 503     if (m_closing)
 504         return;
 505     ASSERT(m_handle);
 506     if (m_useHixie76Protocol) {
 507         Vector<char> buf;
 508         buf.append('\xff');
 509         buf.append('\0');
 510         if (!m_handle->send(buf.data(), buf.size())) {
 511             m_handle->disconnect();
 512             return;
 513         }
 514     } else {
 515         Vector<char> buf;
 516         if (!m_receivedClosingHandshake && code != CloseEventCodeNotSpecified) {
 517             unsigned char highByte = code >> 8;
 518             unsigned char lowByte = code;
 519             buf.append(static_cast<char>(highByte));
 520             buf.append(static_cast<char>(lowByte));
 521             buf.append(reason.utf8().data(), reason.utf8().length());
 522         }
 523         enqueueRawFrame(WebSocketFrame::OpCodeClose, buf.data(), buf.size());
 524     }
 525     m_closing = true;
 526     if (m_client)
 527         m_client->didStartClosingHandshake();
 528 }
 529
 530 void WebSocketChannel::closingTimerFired(Timer<WebSocketChannel>* timer)
 531 {
 532     LOG(Network, "WebSocketChannel %p closing timer", this);
 533     ASSERT_UNUSED(timer, &m_closingTimer == timer);
 534     if (m_handle)
 535         m_handle->disconnect();
 536 }
 537
 538 WebSocketChannel::ParseFrameResult WebSocketChannel::parseFrame(WebSocketFrame& frame, const char*& frameEnd)
 539 {
 540     const char* p = m_buffer;
 541     const char* bufferEnd = m_buffer + m_bufferSize;
 542
 543     if (m_bufferSize < 2)
 544         return FrameIncomplete;
 545
 546     unsigned char firstByte = *p++;
 547     unsigned char secondByte = *p++;
 548
 549     bool final = firstByte & finalBit;
 550     bool compress = firstByte & compressBit;
 551     bool reserved2 = firstByte & reserved2Bit;
 552     bool reserved3 = firstByte & reserved3Bit;
 553     unsigned char opCode = firstByte & opCodeMask;
 554
 555     bool masked = secondByte & maskBit;
 556     uint64_t payloadLength64 = secondByte & payloadLengthMask;
 557     if (payloadLength64 > maxPayloadLengthWithoutExtendedLengthField) {
 558         int extendedPayloadLengthSize;
 559         if (payloadLength64 == payloadLengthWithTwoByteExtendedLengthField)
 560             extendedPayloadLengthSize = 2;
 561         else {
 562             ASSERT(payloadLength64 == payloadLengthWithEightByteExtendedLengthField);
 563             extendedPayloadLengthSize = 8;
 564         }
 565         if (bufferEnd - p < extendedPayloadLengthSize)
 566             return FrameIncomplete;
 567         payloadLength64 = 0;
 568         for (int i = 0; i < extendedPayloadLengthSize; ++i) {
 569             payloadLength64 <<= 8;
 570             payloadLength64 |= static_cast<unsigned char>(*p++);
 571         }
 572     }
 573
 574     // FIXME: UINT64_C(0x7FFFFFFFFFFFFFFF) should be used but it did not compile on Qt bots.
 575 #if COMPILER(MSVC)
 576     static const uint64_t maxPayloadLength = 0x7FFFFFFFFFFFFFFFui64;
 577 #else
 578     static const uint64_t maxPayloadLength = 0x7FFFFFFFFFFFFFFFull;
 579 #endif
 580     size_t maskingKeyLength = masked ? maskingKeyWidthInBytes : 0;
 581     if (payloadLength64 > maxPayloadLength || payloadLength64 + maskingKeyLength > numeric_limits<size_t>::max()) {
 582         fail("WebSocket frame length too large: " + String::number(payloadLength64) + " bytes");
 583         return FrameError;
 584     }
 585     size_t payloadLength = static_cast<size_t>(payloadLength64);
 586
 587     if (static_cast<size_t>(bufferEnd - p) < maskingKeyLength + payloadLength)
 588         return FrameIncomplete;
 589
 590     if (masked) {
 591         const char* maskingKey = p;
 592         char* payload = const_cast<char*>(p + maskingKeyWidthInBytes);
 593         for (size_t i = 0; i < payloadLength; ++i)
 594             payload[i] ^= maskingKey[i % maskingKeyWidthInBytes]; // Unmask the payload.
 595     }
 596
 597     frame.opCode = static_cast<WebSocketFrame::OpCode>(opCode);
 598     frame.final = final;
 599     frame.compress = compress;
 600     frame.reserved2 = reserved2;
 601     frame.reserved3 = reserved3;
 602     frame.masked = masked;
 603     frame.payload = p + maskingKeyLength;
 604     frame.payloadLength = payloadLength;
 605     frameEnd = p + maskingKeyLength + payloadLength;
 606     return FrameOK;
 607 }
 608
 609 bool WebSocketChannel::processFrame()
 610 {
 611     ASSERT(m_buffer);
 612
 613     WebSocketFrame frame;
 614     const char* frameEnd;
 615     if (parseFrame(frame, frameEnd) != FrameOK)
 616         return false;
 617
 618     ASSERT(m_buffer < frameEnd);
 619     ASSERT(frameEnd <= m_buffer + m_bufferSize);
 620
 621     // Validate the frame data.
 622     if (WebSocketFrame::isReservedOpCode(frame.opCode)) {
 623         fail("Unrecognized frame opcode: " + String::number(frame.opCode));
 624         return false;
 625     }
 626
 627     if (frame.reserved2 || frame.reserved3) {
 628         fail("One or more reserved bits are on: reserved2 = " + String::number(frame.reserved2) + ", reserved3 = " + String::number(frame.reserved3));
 629         return false;
 630     }
 631
 632     // All control frames must not be fragmented.
 633     if (WebSocketFrame::isControlOpCode(frame.opCode) && !frame.final) {
 634         fail("Received fragmented control frame: opcode = " + String::number(frame.opCode));
 635         return false;
 636     }
 637
 638     // All control frames must have a payload of 125 bytes or less, which means the frame must not contain
 639     // the "extended payload length" field.
 640     if (WebSocketFrame::isControlOpCode(frame.opCode) && frame.payloadLength > maxPayloadLengthWithoutExtendedLengthField) {
 641         fail("Received control frame having too long payload: " + String::number(frame.payloadLength) + " bytes");
 642         return false;
 643     }
 644
 645     // A new data frame is received before the previous continuous frame finishes.
 646     // Note that control frames are allowed to come in the middle of continuous frames.
 647     if (m_hasContinuousFrame && frame.opCode != WebSocketFrame::OpCodeContinuation && !WebSocketFrame::isControlOpCode(frame.opCode)) {
 648         fail("Received new data frame but previous continuous frame is unfinished.");
 649         return false;
 650     }
 651
 652     switch (frame.opCode) {
 653     case WebSocketFrame::OpCodeContinuation:
 654         // An unexpected continuation frame is received without any leading frame.
 655         if (!m_hasContinuousFrame) {
 656             fail("Received unexpected continuation frame.");
 657             return false;
 658         }
 659         m_continuousFrameData.append(frame.payload, frame.payloadLength);
 660         skipBuffer(frameEnd - m_buffer);
 661         if (frame.final) {
 662             // onmessage handler may eventually call the other methods of this channel,
 663             // so we should pretend that we have finished to read this frame and
 664             // make sure that the member variables are in a consistent state before
 665             // the handler is invoked.
 666             // Vector<char>::swap() is used here to clear m_continuousFrameData.
 667             OwnPtr<Vector<char> > continuousFrameData = adoptPtr(new Vector<char>);
 668             m_continuousFrameData.swap(*continuousFrameData);
 669             m_hasContinuousFrame = false;
 670             if (m_continuousFrameOpCode == WebSocketFrame::OpCodeText) {
 671                 String message;
 672                 if (continuousFrameData->size())
 673                     message = String::fromUTF8(continuousFrameData->data(), continuousFrameData->size());
 674                 else
 675                     message = "";
 676                 if (message.isNull())
 677                     fail("Could not decode a text frame as UTF-8.");
 678                 else
 679                     m_client->didReceiveMessage(message);
 680             } else if (m_continuousFrameOpCode == WebSocketFrame::OpCodeBinary)
 681                 m_client->didReceiveBinaryData(continuousFrameData.release());
 682         }
 683         break;
 684
 685     case WebSocketFrame::OpCodeText:
 686         if (frame.final) {
 687             String message;
 688             if (frame.payloadLength)
 689                 message = String::fromUTF8(frame.payload, frame.payloadLength);
 690             else
 691                 message = "";
 692             skipBuffer(frameEnd - m_buffer);
 693             if (message.isNull())
 694                 fail("Could not decode a text frame as UTF-8.");
 695             else
 696                 m_client->didReceiveMessage(message);
 697         } else {
 698             m_hasContinuousFrame = true;
 699             m_continuousFrameOpCode = WebSocketFrame::OpCodeText;
 700             ASSERT(m_continuousFrameData.isEmpty());
 701             m_continuousFrameData.append(frame.payload, frame.payloadLength);
 702             skipBuffer(frameEnd - m_buffer);
 703         }
 704         break;
 705
 706     case WebSocketFrame::OpCodeBinary:
 707         if (frame.final) {
 708             OwnPtr<Vector<char> > binaryData = adoptPtr(new Vector<char>(frame.payloadLength));
 709             memcpy(binaryData->data(), frame.payload, frame.payloadLength);
 710             skipBuffer(frameEnd - m_buffer);
 711             m_client->didReceiveBinaryData(binaryData.release());
 712         } else {
 713             m_hasContinuousFrame = true;
 714             m_continuousFrameOpCode = WebSocketFrame::OpCodeBinary;
 715             ASSERT(m_continuousFrameData.isEmpty());
 716             m_continuousFrameData.append(frame.payload, frame.payloadLength);
 717             skipBuffer(frameEnd - m_buffer);
 718         }
 719         break;
 720
 721     case WebSocketFrame::OpCodeClose:
 722         if (frame.payloadLength >= 2) {
 723             unsigned char highByte = static_cast<unsigned char>(frame.payload[0]);
 724             unsigned char lowByte = static_cast<unsigned char>(frame.payload[1]);
 725             m_closeEventCode = highByte << 8 | lowByte;
 726         } else
 727             m_closeEventCode = CloseEventCodeNoStatusRcvd;
 728         if (frame.payloadLength >= 3)
 729             m_closeEventReason = String::fromUTF8(&frame.payload[2], frame.payloadLength - 2);
 730         else
 731             m_closeEventReason = "";
 732         skipBuffer(frameEnd - m_buffer);
 733         m_receivedClosingHandshake = true;
 734         startClosingHandshake(m_closeEventCode, m_closeEventReason);
 735         if (m_closing) {
 736             m_outgoingFrameQueueStatus = OutgoingFrameQueueClosing;
 737             processOutgoingFrameQueue();
 738         }
 739         break;
 740
 741     case WebSocketFrame::OpCodePing:
 742         enqueueRawFrame(WebSocketFrame::OpCodePong, frame.payload, frame.payloadLength);
 743         skipBuffer(frameEnd - m_buffer);
 744         break;
 745
 746     case WebSocketFrame::OpCodePong:
 747         // A server may send a pong in response to our ping, or an unsolicited pong which is not associated with
 748         // any specific ping. Either way, there's nothing to do on receipt of pong.
 749         skipBuffer(frameEnd - m_buffer);
 750         break;
 751
 752     default:
 753         ASSERT_NOT_REACHED();
 754         skipBuffer(frameEnd - m_buffer);
 755         break;
 756     }
 757
 758     return m_buffer;
 759 }
 760
 761 bool WebSocketChannel::processFrameHixie76()
 762 {
 763     const char* nextFrame = m_buffer;
 764     const char* p = m_buffer;
 765     const char* end = p + m_bufferSize;
 766
 767     unsigned char frameByte = static_cast<unsigned char>(*p++);
 768     if ((frameByte & 0x80) == 0x80) {
 769         size_t length = 0;
 770         bool errorFrame = false;
 771         bool lengthFinished = false;
 772         while (p < end) {
 773             if (length > numeric_limits<size_t>::max() / 128) {
 774                 LOG(Network, "frame length overflow %lu", static_cast<unsigned long>(length));
 775                 errorFrame = true;
 776                 break;
 777             }
 778             size_t newLength = length * 128;
 779             unsigned char msgByte = static_cast<unsigned char>(*p);
 780             unsigned int lengthMsgByte = msgByte & 0x7f;
 781             if (newLength > numeric_limits<size_t>::max() - lengthMsgByte) {
 782                 LOG(Network, "frame length overflow %lu+%u", static_cast<unsigned long>(newLength), lengthMsgByte);
 783                 errorFrame = true;
 784                 break;
 785             }
 786             newLength += lengthMsgByte;
 787             if (newLength < length) { // sanity check
 788                 LOG(Network, "frame length integer wrap %lu->%lu", static_cast<unsigned long>(length), static_cast<unsigned long>(newLength));
 789                 errorFrame = true;
 790                 break;
 791             }
 792             length = newLength;
 793             ++p;
 794             if (!(msgByte & 0x80)) {
 795                 lengthFinished = true;
 796                 break;
 797             }
 798         }
 799         if (!errorFrame && !lengthFinished)
 800             return false;
 801         if (p + length < p) {
 802             LOG(Network, "frame buffer pointer wrap %p+%lu->%p", p, static_cast<unsigned long>(length), p + length);
 803             errorFrame = true;
 804         }
 805         if (errorFrame) {
 806             skipBuffer(m_bufferSize); // Save memory.
 807             m_shouldDiscardReceivedData = true;
 808             m_client->didReceiveMessageError();
 809             fail("WebSocket frame length too large");
 810             return false;
 811         }
 812         ASSERT(p + length >= p);
 813         if (p + length <= end) {
 814             p += length;
 815             nextFrame = p;
 816             ASSERT(nextFrame > m_buffer);
 817             skipBuffer(nextFrame - m_buffer);
 818             if (frameByte == 0xff && !length) {
 819                 m_receivedClosingHandshake = true;
 820                 startClosingHandshake(CloseEventCodeNotSpecified, "");
 821                 if (m_closing)
 822                     m_handle->close(); // close after sending FF 00.
 823             } else
 824                 m_client->didReceiveMessageError();
 825             return m_buffer;
 826         }
 827         return false;
 828     }
 829
 830     const char* msgStart = p;
 831     while (p < end && *p != '\xff')
 832         ++p;
 833     if (p < end && *p == '\xff') {
 834         int msgLength = p - msgStart;
 835         ++p;
 836         nextFrame = p;
 837         if (frameByte == 0x00) {
 838             String msg = String::fromUTF8(msgStart, msgLength);
 839             skipBuffer(nextFrame - m_buffer);
 840             m_client->didReceiveMessage(msg);
 841         } else {
 842             skipBuffer(nextFrame - m_buffer);
 843             m_client->didReceiveMessageError();
 844         }
 845         return m_buffer;
 846     }
 847     return false;
 848 }
 849
 850 void WebSocketChannel::enqueueTextFrame(const String& string)
 851 {
 852     ASSERT(!m_useHixie76Protocol);
 853     ASSERT(m_outgoingFrameQueueStatus == OutgoingFrameQueueOpen);
 854     OwnPtr<QueuedFrame> frame = adoptPtr(new QueuedFrame);
 855     frame->opCode = WebSocketFrame::OpCodeText;
 856     frame->frameType = QueuedFrameTypeString;
 857     frame->stringData = string;
 858     m_outgoingFrameQueue.append(frame.release());
 859     processOutgoingFrameQueue();
 860 }
 861
 862 void WebSocketChannel::enqueueRawFrame(WebSocketFrame::OpCode opCode, const char* data, size_t dataLength)
 863 {
 864     ASSERT(!m_useHixie76Protocol);
 865     ASSERT(m_outgoingFrameQueueStatus == OutgoingFrameQueueOpen);
 866     OwnPtr<QueuedFrame> frame = adoptPtr(new QueuedFrame);
 867     frame->opCode = opCode;
 868     frame->frameType = QueuedFrameTypeVector;
 869     frame->vectorData.resize(dataLength);
 870     if (dataLength)
 871         memcpy(frame->vectorData.data(), data, dataLength);
 872     m_outgoingFrameQueue.append(frame.release());
 873     processOutgoingFrameQueue();
 874 }
 875
 876 void WebSocketChannel::enqueueBlobFrame(WebSocketFrame::OpCode opCode, const Blob& blob)
 877 {
 878     ASSERT(!m_useHixie76Protocol);
 879     ASSERT(m_outgoingFrameQueueStatus == OutgoingFrameQueueOpen);
 880     OwnPtr<QueuedFrame> frame = adoptPtr(new QueuedFrame);
 881     frame->opCode = opCode;
 882     frame->frameType = QueuedFrameTypeBlob;
 883     frame->blobData = Blob::create(blob.url(), blob.type(), blob.size());
 884     m_outgoingFrameQueue.append(frame.release());
 885     processOutgoingFrameQueue();
 886 }
 887
 888 void WebSocketChannel::processOutgoingFrameQueue()
 889 {
 890     ASSERT(!m_useHixie76Protocol);
 891     if (m_outgoingFrameQueueStatus == OutgoingFrameQueueClosed)
 892         return;
 893
 894     while (!m_outgoingFrameQueue.isEmpty()) {
 895         OwnPtr<QueuedFrame> frame = m_outgoingFrameQueue.takeFirst();
 896         switch (frame->frameType) {
 897         case QueuedFrameTypeString: {
 898             CString utf8 = frame->stringData.utf8();
 899             if (!sendFrame(frame->opCode, utf8.data(), utf8.length()))
 900                 fail("Failed to send WebSocket frame.");
 901             break;
 902         }
 903
 904         case QueuedFrameTypeVector:
 905             if (!sendFrame(frame->opCode, frame->vectorData.data(), frame->vectorData.size()))
 906                 fail("Failed to send WebSocket frame.");
 907             break;
 908
 909         case QueuedFrameTypeBlob: {
 910 #if ENABLE(BLOB)
 911             switch (m_blobLoaderStatus) {
 912             case BlobLoaderNotStarted:
 913                 ref(); // Will be derefed after didFinishLoading() or didFail().
 914                 ASSERT(!m_blobLoader);
 915                 m_blobLoader = adoptPtr(new FileReaderLoader(FileReaderLoader::ReadAsArrayBuffer, this));
 916                 m_blobLoaderStatus = BlobLoaderStarted;
 917                 m_blobLoader->start(m_document, frame->blobData.get());
 918                 m_outgoingFrameQueue.prepend(frame.release());
 919                 return;
 920
 921             case BlobLoaderStarted:
 922             case BlobLoaderFailed:
 923                 m_outgoingFrameQueue.prepend(frame.release());
 924                 return;
 925
 926             case BlobLoaderFinished: {
 927                 RefPtr<ArrayBuffer> result = m_blobLoader->arrayBufferResult();
 928                 m_blobLoader.clear();
 929                 m_blobLoaderStatus = BlobLoaderNotStarted;
 930                 if (!sendFrame(frame->opCode, static_cast<const char*>(result->data()), result->byteLength()))
 931                     fail("Failed to send WebSocket frame.");
 932                 break;
 933             }
 934             }
 935 #else
 936             fail("FileReader is not available. Could not send a Blob as WebSocket binary message.");
 937 #endif
 938             break;
 939         }
 940
 941         default:
 942             ASSERT_NOT_REACHED();
 943             break;
 944         }
 945     }
 946
 947     ASSERT(m_outgoingFrameQueue.isEmpty());
 948     if (m_outgoingFrameQueueStatus == OutgoingFrameQueueClosing) {
 949         m_outgoingFrameQueueStatus = OutgoingFrameQueueClosed;
 950         m_handle->close();
 951     }
 952 }
 953
 954 void WebSocketChannel::abortOutgoingFrameQueue()
 955 {
 956     ASSERT(!m_useHixie76Protocol);
 957     m_outgoingFrameQueue.clear();
 958     m_outgoingFrameQueueStatus = OutgoingFrameQueueClosed;
 959 #if ENABLE(BLOB)
 960     if (m_blobLoaderStatus == BlobLoaderStarted) {
 961         m_blobLoader->cancel();
 962         didFail(FileError::ABORT_ERR);
 963     }
 964 #endif
 965 }
 966
 967 static void appendMaskedFramePayload(const WebSocketFrame& frame, Vector<char>& frameData)
 968 {
 969     size_t maskingKeyStart = frameData.size();
 970     frameData.grow(frameData.size() + maskingKeyWidthInBytes); // Add placeholder for masking key. Will be overwritten.
 971     size_t payloadStart = frameData.size();
 972     frameData.append(frame.payload, frame.payloadLength);
 973
 974     cryptographicallyRandomValues(frameData.data() + maskingKeyStart, maskingKeyWidthInBytes);
 975     for (size_t i = 0; i < frame.payloadLength; ++i)
 976         frameData[payloadStart + i] ^= frameData[maskingKeyStart + i % maskingKeyWidthInBytes];
 977 }
 978
 979 static void makeFrameData(const WebSocketFrame& frame, Vector<char>& frameData)
 980 {
 981     unsigned char firstByte = (frame.final ? finalBit : 0) | frame.opCode;
 982     if (frame.compress)
 983         firstByte |= compressBit;
 984     frameData.append(firstByte);
 985     if (frame.payloadLength <= maxPayloadLengthWithoutExtendedLengthField)
 986         frameData.append(maskBit | frame.payloadLength);
 987     else if (frame.payloadLength <= 0xFFFF) {
 988         frameData.append(maskBit | payloadLengthWithTwoByteExtendedLengthField);
 989         frameData.append((frame.payloadLength & 0xFF00) >> 8);
 990         frameData.append(frame.payloadLength & 0xFF);
 991     } else {
 992         frameData.append(maskBit | payloadLengthWithEightByteExtendedLengthField);
 993         char extendedPayloadLength[8];
 994         size_t remaining = frame.payloadLength;
 995         // Fill the length into extendedPayloadLength in the network byte order.
 996         for (int i = 0; i < 8; ++i) {
 997             extendedPayloadLength[7 - i] = remaining & 0xFF;
 998             remaining >>= 8;
 999         }
1000         ASSERT(!remaining);
1001         frameData.append(extendedPayloadLength, 8);
1002     }
1003
1004     appendMaskedFramePayload(frame, frameData);
1005 }
1006
1007 bool WebSocketChannel::sendFrame(WebSocketFrame::OpCode opCode, const char* data, size_t dataLength)
1008 {
1009     ASSERT(m_handle);
1010     ASSERT(!m_suspended);
1011
1012     ASSERT(!(opCode & ~opCodeMask)); // Checks whether "opCode" fits in the range of opCodes.
1013     WebSocketFrame frame(opCode, true, false, true, data, dataLength);
1014     Vector<char> frameData;
1015     makeFrameData(frame, frameData);
1016
1017     return m_handle->send(frameData.data(), frameData.size());
1018 }
1019
1020 bool WebSocketChannel::sendFrameHixie76(const char* data, size_t dataLength)
1021 {
1022     ASSERT(m_handle);
1023     ASSERT(!m_suspended);
1024
1025     Vector<char> frame;
1026     frame.append('\0'); // Frame type.
1027     frame.append(data, dataLength);
1028     frame.append('\xff'); // Frame end.
1029     return m_handle->send(frame.data(), frame.size());
1030 }
1031
1032 }  // namespace WebCore
1033
1034 #endif  // ENABLE(WEB_SOCKETS)