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