WebSocket: Add binaryType attribute
[WebKit-https.git] / Source / WebCore / websockets / WebSocketChannel.cpp
1 /*
2  * Copyright (C) 2011 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 "CookieJar.h"
38 #include "Document.h"
39 #include "InspectorInstrumentation.h"
40 #include "Logging.h"
41 #include "Page.h"
42 #include "ProgressTracker.h"
43 #include "ScriptCallStack.h"
44 #include "ScriptExecutionContext.h"
45 #include "Settings.h"
46 #include "SocketStreamError.h"
47 #include "SocketStreamHandle.h"
48 #include "WebSocketChannelClient.h"
49 #include "WebSocketHandshake.h"
50
51 #include <wtf/CryptographicallyRandomNumber.h>
52 #include <wtf/Deque.h>
53 #include <wtf/FastMalloc.h>
54 #include <wtf/HashMap.h>
55 #include <wtf/text/CString.h>
56 #include <wtf/text/StringHash.h>
57 #include <wtf/text/WTFString.h>
58
59 using namespace std;
60
61 namespace WebCore {
62
63 const double TCPMaximumSegmentLifetime = 2 * 60.0;
64
65 // Constants for hybi-10 frame format.
66 const unsigned char finalBit = 0x80;
67 const unsigned char reserved1Bit = 0x40;
68 const unsigned char reserved2Bit = 0x20;
69 const unsigned char reserved3Bit = 0x10;
70 const unsigned char opCodeMask = 0xF;
71 const unsigned char maskBit = 0x80;
72 const unsigned char payloadLengthMask = 0x7F;
73 const size_t maxPayloadLengthWithoutExtendedLengthField = 125;
74 const size_t payloadLengthWithTwoByteExtendedLengthField = 126;
75 const size_t payloadLengthWithEightByteExtendedLengthField = 127;
76 const size_t maskingKeyWidthInBytes = 4;
77
78 const WebSocketChannel::OpCode WebSocketChannel::OpCodeContinuation = 0x0;
79 const WebSocketChannel::OpCode WebSocketChannel::OpCodeText = 0x1;
80 const WebSocketChannel::OpCode WebSocketChannel::OpCodeBinary = 0x2;
81 const WebSocketChannel::OpCode WebSocketChannel::OpCodeClose = 0x8;
82 const WebSocketChannel::OpCode WebSocketChannel::OpCodePing = 0x9;
83 const WebSocketChannel::OpCode WebSocketChannel::OpCodePong = 0xA;
84
85 WebSocketChannel::WebSocketChannel(ScriptExecutionContext* context, WebSocketChannelClient* client)
86     : m_context(context)
87     , m_client(client)
88     , m_buffer(0)
89     , m_bufferSize(0)
90     , m_resumeTimer(this, &WebSocketChannel::resumeTimerFired)
91     , m_suspended(false)
92     , m_closing(false)
93     , m_receivedClosingHandshake(false)
94     , m_closingTimer(this, &WebSocketChannel::closingTimerFired)
95     , m_closed(false)
96     , m_shouldDiscardReceivedData(false)
97     , m_unhandledBufferedAmount(0)
98     , m_identifier(0)
99     , m_useHixie76Protocol(true)
100     , m_hasContinuousFrame(false)
101 {
102     ASSERT(m_context->isDocument());
103     Document* document = static_cast<Document*>(m_context);
104     if (Settings* settings = document->settings())
105         m_useHixie76Protocol = settings->useHixie76WebSocketProtocol();
106
107     if (Page* page = document->page())
108         m_identifier = page->progress()->createUniqueIdentifier();
109 }
110
111 WebSocketChannel::~WebSocketChannel()
112 {
113     fastFree(m_buffer);
114 }
115
116 bool WebSocketChannel::useHixie76Protocol()
117 {
118     return m_useHixie76Protocol;
119 }
120
121 void WebSocketChannel::connect(const KURL& url, const String& protocol)
122 {
123     LOG(Network, "WebSocketChannel %p connect", this);
124     ASSERT(!m_handle);
125     ASSERT(!m_suspended);
126     m_handshake = adoptPtr(new WebSocketHandshake(url, protocol, m_context, m_useHixie76Protocol));
127     m_handshake->reset();
128     if (m_identifier)
129         InspectorInstrumentation::didCreateWebSocket(m_context, m_identifier, url, m_context->url());
130     ref();
131     m_handle = SocketStreamHandle::create(m_handshake->url(), this);
132 }
133
134 bool WebSocketChannel::send(const String& message)
135 {
136     LOG(Network, "WebSocketChannel %p send %s", this, message.utf8().data());
137     CString utf8 = message.utf8();
138     if (m_useHixie76Protocol)
139         return sendFrameHixie76(utf8.data(), utf8.length());
140     return sendFrame(OpCodeText, utf8.data(), utf8.length());
141 }
142
143 unsigned long WebSocketChannel::bufferedAmount() const
144 {
145     LOG(Network, "WebSocketChannel %p bufferedAmount", this);
146     ASSERT(m_handle);
147     ASSERT(!m_suspended);
148     return m_handle->bufferedAmount();
149 }
150
151 void WebSocketChannel::close()
152 {
153     LOG(Network, "WebSocketChannel %p close", this);
154     ASSERT(!m_suspended);
155     if (!m_handle)
156         return;
157     startClosingHandshake();
158     if (m_closing && !m_closingTimer.isActive())
159         m_closingTimer.startOneShot(2 * TCPMaximumSegmentLifetime);
160 }
161
162 void WebSocketChannel::fail(const String& reason)
163 {
164     LOG(Network, "WebSocketChannel %p fail: %s", this, reason.utf8().data());
165     ASSERT(!m_suspended);
166     if (m_context)
167         m_context->addMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, reason, 0, m_handshake->clientOrigin(), 0);
168     if (!m_useHixie76Protocol) {
169         // Hybi-10 specification explicitly states we must not continue to handle incoming data
170         // once the WebSocket connection is failed (section 7.1.7).
171         // FIXME: Should we do this in hixie-76 too?
172         m_shouldDiscardReceivedData = true;
173         if (m_buffer)
174             skipBuffer(m_bufferSize); // Save memory.
175         m_hasContinuousFrame = false;
176         m_continuousFrameData.clear();
177     }
178     if (m_handle && !m_closed)
179         m_handle->disconnect(); // Will call didClose().
180 }
181
182 void WebSocketChannel::disconnect()
183 {
184     LOG(Network, "WebSocketChannel %p disconnect", this);
185     if (m_identifier && m_context)
186         InspectorInstrumentation::didCloseWebSocket(m_context, m_identifier);
187     if (m_handshake)
188         m_handshake->clearScriptExecutionContext();
189     m_client = 0;
190     m_context = 0;
191     if (m_handle)
192         m_handle->disconnect();
193 }
194
195 void WebSocketChannel::suspend()
196 {
197     m_suspended = true;
198 }
199
200 void WebSocketChannel::resume()
201 {
202     m_suspended = false;
203     if ((m_buffer || m_closed) && m_client && !m_resumeTimer.isActive())
204         m_resumeTimer.startOneShot(0);
205 }
206
207 void WebSocketChannel::didOpenSocketStream(SocketStreamHandle* handle)
208 {
209     LOG(Network, "WebSocketChannel %p didOpenSocketStream", this);
210     ASSERT(handle == m_handle);
211     if (!m_context)
212         return;
213     if (m_identifier)
214         InspectorInstrumentation::willSendWebSocketHandshakeRequest(m_context, m_identifier, m_handshake->clientHandshakeRequest());
215     CString handshakeMessage = m_handshake->clientHandshakeMessage();
216     if (!handle->send(handshakeMessage.data(), handshakeMessage.length()))
217         fail("Failed to send WebSocket handshake.");
218 }
219
220 void WebSocketChannel::didCloseSocketStream(SocketStreamHandle* handle)
221 {
222     LOG(Network, "WebSocketChannel %p didCloseSocketStream", this);
223     if (m_identifier && m_context)
224         InspectorInstrumentation::didCloseWebSocket(m_context, m_identifier);
225     ASSERT_UNUSED(handle, handle == m_handle || !m_handle);
226     m_closed = true;
227     if (m_closingTimer.isActive())
228         m_closingTimer.stop();
229     if (m_handle) {
230         m_unhandledBufferedAmount = m_handle->bufferedAmount();
231         if (m_suspended)
232             return;
233         WebSocketChannelClient* client = m_client;
234         m_client = 0;
235         m_context = 0;
236         m_handle = 0;
237         if (client)
238             client->didClose(m_unhandledBufferedAmount, m_receivedClosingHandshake ? WebSocketChannelClient::ClosingHandshakeComplete : WebSocketChannelClient::ClosingHandshakeIncomplete);
239     }
240     deref();
241 }
242
243 void WebSocketChannel::didReceiveSocketStreamData(SocketStreamHandle* handle, const char* data, int len)
244 {
245     LOG(Network, "WebSocketChannel %p didReceiveSocketStreamData %d", this, len);
246     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
247     ASSERT(handle == m_handle);
248     if (!m_context) {
249         return;
250     }
251     if (len <= 0) {
252         handle->disconnect();
253         return;
254     }
255     if (!m_client) {
256         m_shouldDiscardReceivedData = true;
257         handle->disconnect();
258         return;
259     }
260     if (m_shouldDiscardReceivedData)
261         return;
262     if (!appendToBuffer(data, len)) {
263         m_shouldDiscardReceivedData = true;
264         fail("Ran out of memory while receiving WebSocket data.");
265         return;
266     }
267     while (!m_suspended && m_client && m_buffer)
268         if (!processBuffer())
269             break;
270 }
271
272 void WebSocketChannel::didFailSocketStream(SocketStreamHandle* handle, const SocketStreamError& error)
273 {
274     LOG(Network, "WebSocketChannel %p didFailSocketStream", this);
275     ASSERT(handle == m_handle || !m_handle);
276     if (m_context) {
277         String message;
278         if (error.isNull())
279             message = "WebSocket network error";
280         else if (error.localizedDescription().isNull())
281             message = "WebSocket network error: error code " + String::number(error.errorCode());
282         else
283             message = "WebSocket network error: " + error.localizedDescription();
284         String failingURL = error.failingURL();
285         ASSERT(failingURL.isNull() || m_handshake->url().string() == failingURL);
286         if (failingURL.isNull())
287             failingURL = m_handshake->url().string();
288         m_context->addMessage(OtherMessageSource, NetworkErrorMessageType, ErrorMessageLevel, message, 0, failingURL, 0);
289     }
290     m_shouldDiscardReceivedData = true;
291     handle->disconnect();
292 }
293
294 void WebSocketChannel::didReceiveAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
295 {
296 }
297
298 void WebSocketChannel::didCancelAuthenticationChallenge(SocketStreamHandle*, const AuthenticationChallenge&)
299 {
300 }
301
302 bool WebSocketChannel::appendToBuffer(const char* data, size_t len)
303 {
304     size_t newBufferSize = m_bufferSize + len;
305     if (newBufferSize < m_bufferSize) {
306         LOG(Network, "WebSocket buffer overflow (%lu+%lu)", static_cast<unsigned long>(m_bufferSize), static_cast<unsigned long>(len));
307         return false;
308     }
309     char* newBuffer = 0;
310     if (!tryFastMalloc(newBufferSize).getValue(newBuffer))
311         return false;
312
313     if (m_buffer)
314         memcpy(newBuffer, m_buffer, m_bufferSize);
315     memcpy(newBuffer + m_bufferSize, data, len);
316     fastFree(m_buffer);
317     m_buffer = newBuffer;
318     m_bufferSize = newBufferSize;
319     return true;
320 }
321
322 void WebSocketChannel::skipBuffer(size_t len)
323 {
324     ASSERT(len <= m_bufferSize);
325     m_bufferSize -= len;
326     if (!m_bufferSize) {
327         fastFree(m_buffer);
328         m_buffer = 0;
329         return;
330     }
331     memmove(m_buffer, m_buffer + len, m_bufferSize);
332 }
333
334 bool WebSocketChannel::processBuffer()
335 {
336     ASSERT(!m_suspended);
337     ASSERT(m_client);
338     ASSERT(m_buffer);
339     LOG(Network, "WebSocketChannel %p processBuffer %lu", this, static_cast<unsigned long>(m_bufferSize));
340
341     if (m_shouldDiscardReceivedData)
342         return false;
343
344     if (m_receivedClosingHandshake) {
345         skipBuffer(m_bufferSize);
346         return false;
347     }
348
349     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
350
351     if (m_handshake->mode() == WebSocketHandshake::Incomplete) {
352         int headerLength = m_handshake->readServerHandshake(m_buffer, m_bufferSize);
353         if (headerLength <= 0)
354             return false;
355         if (m_handshake->mode() == WebSocketHandshake::Connected) {
356             if (m_identifier)
357                 InspectorInstrumentation::didReceiveWebSocketHandshakeResponse(m_context, m_identifier, m_handshake->serverHandshakeResponse());
358             if (!m_handshake->serverSetCookie().isEmpty()) {
359                 if (m_context->isDocument()) {
360                     Document* document = static_cast<Document*>(m_context);
361                     if (cookiesEnabled(document)) {
362                         ExceptionCode ec; // Exception (for sandboxed documents) ignored.
363                         document->setCookie(m_handshake->serverSetCookie(), ec);
364                     }
365                 }
366             }
367             // FIXME: handle set-cookie2.
368             LOG(Network, "WebSocketChannel %p connected", this);
369             skipBuffer(headerLength);
370             m_client->didConnect();
371             LOG(Network, "remaining in read buf %lu", static_cast<unsigned long>(m_bufferSize));
372             return m_buffer;
373         }
374         ASSERT(m_handshake->mode() == WebSocketHandshake::Failed);
375         LOG(Network, "WebSocketChannel %p connection failed", this);
376         skipBuffer(headerLength);
377         m_shouldDiscardReceivedData = true;
378         fail(m_handshake->failureReason());
379         return false;
380     }
381     if (m_handshake->mode() != WebSocketHandshake::Connected)
382         return false;
383
384     if (m_useHixie76Protocol)
385         return processFrameHixie76();
386
387     return processFrame();
388 }
389
390 void WebSocketChannel::resumeTimerFired(Timer<WebSocketChannel>* timer)
391 {
392     ASSERT_UNUSED(timer, timer == &m_resumeTimer);
393
394     RefPtr<WebSocketChannel> protect(this); // The client can close the channel, potentially removing the last reference.
395     while (!m_suspended && m_client && m_buffer)
396         if (!processBuffer())
397             break;
398     if (!m_suspended && m_client && m_closed && m_handle)
399         didCloseSocketStream(m_handle.get());
400 }
401
402 void WebSocketChannel::startClosingHandshake()
403 {
404     LOG(Network, "WebSocketChannel %p closing %d %d", this, m_closing, m_receivedClosingHandshake);
405     if (m_closing)
406         return;
407     ASSERT(m_handle);
408     bool sentSuccessfully;
409     if (m_useHixie76Protocol) {
410         Vector<char> buf;
411         buf.append('\xff');
412         buf.append('\0');
413         sentSuccessfully = m_handle->send(buf.data(), buf.size());
414     } else
415         sentSuccessfully = sendFrame(OpCodeClose, "", 0); // FIXME: Send status code and reason message.
416
417     if (!sentSuccessfully) {
418         m_handle->disconnect();
419         return;
420     }
421     m_closing = true;
422     if (m_client)
423         m_client->didStartClosingHandshake();
424 }
425
426 void WebSocketChannel::closingTimerFired(Timer<WebSocketChannel>* timer)
427 {
428     LOG(Network, "WebSocketChannel %p closing timer", this);
429     ASSERT_UNUSED(timer, &m_closingTimer == timer);
430     if (m_handle)
431         m_handle->disconnect();
432 }
433
434 WebSocketChannel::ParseFrameResult WebSocketChannel::parseFrame(FrameData& frame)
435 {
436     const char* p = m_buffer;
437     const char* bufferEnd = m_buffer + m_bufferSize;
438
439     if (m_bufferSize < 2)
440         return FrameIncomplete;
441
442     unsigned char firstByte = *p++;
443     unsigned char secondByte = *p++;
444
445     bool final = firstByte & finalBit;
446     bool reserved1 = firstByte & reserved1Bit;
447     bool reserved2 = firstByte & reserved2Bit;
448     bool reserved3 = firstByte & reserved3Bit;
449     OpCode opCode = firstByte & opCodeMask;
450
451     bool masked = secondByte & maskBit;
452     uint64_t payloadLength64 = secondByte & payloadLengthMask;
453     if (payloadLength64 > maxPayloadLengthWithoutExtendedLengthField) {
454         int extendedPayloadLengthSize;
455         if (payloadLength64 == payloadLengthWithTwoByteExtendedLengthField)
456             extendedPayloadLengthSize = 2;
457         else {
458             ASSERT(payloadLength64 == payloadLengthWithEightByteExtendedLengthField);
459             extendedPayloadLengthSize = 8;
460         }
461         if (bufferEnd - p < extendedPayloadLengthSize)
462             return FrameIncomplete;
463         payloadLength64 = 0;
464         for (int i = 0; i < extendedPayloadLengthSize; ++i) {
465             payloadLength64 <<= 8;
466             payloadLength64 |= static_cast<unsigned char>(*p++);
467         }
468     }
469
470     // FIXME: UINT64_C(0x7FFFFFFFFFFFFFFF) should be used but it did not compile on Qt bots.
471 #if COMPILER(MSVC)
472     static const uint64_t maxPayloadLength = 0x7FFFFFFFFFFFFFFFui64;
473 #else
474     static const uint64_t maxPayloadLength = 0x7FFFFFFFFFFFFFFFull;
475 #endif
476     size_t maskingKeyLength = masked ? maskingKeyWidthInBytes : 0;
477     if (payloadLength64 > maxPayloadLength || payloadLength64 + maskingKeyLength > numeric_limits<size_t>::max()) {
478         fail("WebSocket frame length too large: " + String::number(payloadLength64) + " bytes");
479         return FrameError;
480     }
481     size_t payloadLength = static_cast<size_t>(payloadLength64);
482
483     if (static_cast<size_t>(bufferEnd - p) < maskingKeyLength + payloadLength)
484         return FrameIncomplete;
485
486     if (masked) {
487         const char* maskingKey = p;
488         char* payload = const_cast<char*>(p + maskingKeyWidthInBytes);
489         for (size_t i = 0; i < payloadLength; ++i)
490             payload[i] ^= maskingKey[i % maskingKeyWidthInBytes]; // Unmask the payload.
491     }
492
493     frame.opCode = opCode;
494     frame.final = final;
495     frame.reserved1 = reserved1;
496     frame.reserved2 = reserved2;
497     frame.reserved3 = reserved3;
498     frame.masked = masked;
499     frame.payload = p + maskingKeyLength;
500     frame.payloadLength = payloadLength;
501     frame.frameEnd = p + maskingKeyLength + payloadLength;
502     return FrameOK;
503 }
504
505 bool WebSocketChannel::processFrame()
506 {
507     ASSERT(m_buffer);
508
509     FrameData frame;
510     if (parseFrame(frame) != FrameOK)
511         return false;
512
513     // Validate the frame data.
514     if (isReservedOpCode(frame.opCode)) {
515         fail("Unrecognized frame opcode: " + String::number(frame.opCode));
516         return false;
517     }
518
519     if (frame.reserved1 || frame.reserved2 || frame.reserved3) {
520         fail("One or more reserved bits are on: reserved1 = " + String::number(frame.reserved1) + ", reserved2 = " + String::number(frame.reserved2) + ", reserved3 = " + String::number(frame.reserved3));
521         return false;
522     }
523
524     // All control frames must not be fragmented.
525     if (isControlOpCode(frame.opCode) && !frame.final) {
526         fail("Received fragmented control frame: opcode = " + String::number(frame.opCode));
527         return false;
528     }
529
530     // All control frames must have a payload of 125 bytes or less, which means the frame must not contain
531     // the "extended payload length" field.
532     if (isControlOpCode(frame.opCode) && frame.payloadLength > maxPayloadLengthWithoutExtendedLengthField) {
533         fail("Received control frame having too long payload: " + String::number(frame.payloadLength) + " bytes");
534         return false;
535     }
536
537     // A new data frame is received before the previous continuous frame finishes.
538     // Note that control frames are allowed to come in the middle of continuous frames.
539     if (m_hasContinuousFrame && frame.opCode != OpCodeContinuation && !isControlOpCode(frame.opCode)) {
540         fail("Received new data frame but previous continuous frame is unfinished.");
541         return false;
542     }
543
544     switch (frame.opCode) {
545     case OpCodeContinuation:
546         // An unexpected continuation frame is received without any leading frame.
547         if (!m_hasContinuousFrame) {
548             fail("Received unexpected continuation frame.");
549             return false;
550         }
551         // Throw away content of a binary message because binary messages are not supported yet.
552         if (m_continuousFrameOpCode == OpCodeText)
553             m_continuousFrameData.append(frame.payload, frame.payloadLength);
554         skipBuffer(frame.frameEnd - m_buffer);
555         if (frame.final) {
556             // onmessage handler may eventually call the other methods of this channel,
557             // so we should pretend that we have finished to read this frame and
558             // make sure that the member variables are in a consistent state before
559             // the handler is invoked.
560             // Vector<char>::swap() is used here to clear m_continuousFrameData.
561             Vector<char> continuousFrameData;
562             m_continuousFrameData.swap(continuousFrameData);
563             m_hasContinuousFrame = false;
564             if (m_continuousFrameOpCode == OpCodeText) {
565                 String message;
566                 if (continuousFrameData.size())
567                     message = String::fromUTF8(continuousFrameData.data(), continuousFrameData.size());
568                 else
569                     message = "";
570                 if (message.isNull())
571                     fail("Could not decode a text frame as UTF-8.");
572                 else
573                     m_client->didReceiveMessage(message);
574             } else if (m_continuousFrameOpCode == OpCodeBinary) {
575                 ASSERT(m_continuousFrameData.isEmpty());
576                 fail("Received a binary frame which is not supported yet.");
577             }
578         }
579         break;
580
581     case OpCodeText:
582         if (frame.final) {
583             String message;
584             if (frame.payloadLength)
585                 message = String::fromUTF8(frame.payload, frame.payloadLength);
586             else
587                 message = "";
588             skipBuffer(frame.frameEnd - m_buffer);
589             if (message.isNull())
590                 fail("Could not decode a text frame as UTF-8.");
591             else
592                 m_client->didReceiveMessage(message);
593         } else {
594             m_hasContinuousFrame = true;
595             m_continuousFrameOpCode = OpCodeText;
596             ASSERT(m_continuousFrameData.isEmpty());
597             m_continuousFrameData.append(frame.payload, frame.payloadLength);
598             skipBuffer(frame.frameEnd - m_buffer);
599         }
600         break;
601
602     case OpCodeBinary:
603         if (frame.final)
604             fail("Received a binary frame which is not supported yet.");
605         else {
606             m_hasContinuousFrame = true;
607             m_continuousFrameOpCode = OpCodeBinary;
608             ASSERT(m_continuousFrameData.isEmpty());
609             // Do not store data of a binary message to m_continuousFrameData to save memory.
610             skipBuffer(frame.frameEnd - m_buffer);
611         }
612         break;
613
614     case OpCodeClose:
615         // FIXME: Handle payload.
616         skipBuffer(frame.frameEnd - m_buffer);
617         m_receivedClosingHandshake = true;
618         startClosingHandshake();
619         if (m_closing)
620             m_handle->close(); // Close after sending a close frame.
621         break;
622
623     case OpCodePing: {
624         bool result = sendFrame(OpCodePong, frame.payload, frame.payloadLength);
625         skipBuffer(frame.frameEnd - m_buffer);
626         if (!result)
627             fail("Failed to send a pong frame.");
628         break;
629     }
630
631     case OpCodePong:
632         // A server may send a pong in response to our ping, or an unsolicited pong which is not associated with
633         // any specific ping. Either way, there's nothing to do on receipt of pong.
634         skipBuffer(frame.frameEnd - m_buffer);
635         break;
636
637     default:
638         ASSERT_NOT_REACHED();
639         skipBuffer(frame.frameEnd - m_buffer);
640         break;
641     }
642
643     return m_buffer;
644 }
645
646 bool WebSocketChannel::processFrameHixie76()
647 {
648     const char* nextFrame = m_buffer;
649     const char* p = m_buffer;
650     const char* end = p + m_bufferSize;
651
652     unsigned char frameByte = static_cast<unsigned char>(*p++);
653     if ((frameByte & 0x80) == 0x80) {
654         size_t length = 0;
655         bool errorFrame = false;
656         while (p < end) {
657             if (length > numeric_limits<size_t>::max() / 128) {
658                 LOG(Network, "frame length overflow %lu", static_cast<unsigned long>(length));
659                 errorFrame = true;
660                 break;
661             }
662             size_t newLength = length * 128;
663             unsigned char msgByte = static_cast<unsigned char>(*p);
664             unsigned int lengthMsgByte = msgByte & 0x7f;
665             if (newLength > numeric_limits<size_t>::max() - lengthMsgByte) {
666                 LOG(Network, "frame length overflow %lu+%u", static_cast<unsigned long>(newLength), lengthMsgByte);
667                 errorFrame = true;
668                 break;
669             }
670             newLength += lengthMsgByte;
671             if (newLength < length) { // sanity check
672                 LOG(Network, "frame length integer wrap %lu->%lu", static_cast<unsigned long>(length), static_cast<unsigned long>(newLength));
673                 errorFrame = true;
674                 break;
675             }
676             length = newLength;
677             ++p;
678             if (!(msgByte & 0x80))
679                 break;
680         }
681         if (p + length < p) {
682             LOG(Network, "frame buffer pointer wrap %p+%lu->%p", p, static_cast<unsigned long>(length), p + length);
683             errorFrame = true;
684         }
685         if (errorFrame) {
686             skipBuffer(m_bufferSize); // Save memory.
687             m_shouldDiscardReceivedData = true;
688             m_client->didReceiveMessageError();
689             fail("WebSocket frame length too large");
690             return false;
691         }
692         ASSERT(p + length >= p);
693         if (p + length <= end) {
694             p += length;
695             nextFrame = p;
696             ASSERT(nextFrame > m_buffer);
697             skipBuffer(nextFrame - m_buffer);
698             if (frameByte == 0xff && !length) {
699                 m_receivedClosingHandshake = true;
700                 startClosingHandshake();
701                 if (m_closing)
702                     m_handle->close(); // close after sending FF 00.
703             } else
704                 m_client->didReceiveMessageError();
705             return m_buffer;
706         }
707         return false;
708     }
709
710     const char* msgStart = p;
711     while (p < end && *p != '\xff')
712         ++p;
713     if (p < end && *p == '\xff') {
714         int msgLength = p - msgStart;
715         ++p;
716         nextFrame = p;
717         if (frameByte == 0x00) {
718             String msg = String::fromUTF8(msgStart, msgLength);
719             skipBuffer(nextFrame - m_buffer);
720             m_client->didReceiveMessage(msg);
721         } else {
722             skipBuffer(nextFrame - m_buffer);
723             m_client->didReceiveMessageError();
724         }
725         return m_buffer;
726     }
727     return false;
728 }
729
730 bool WebSocketChannel::sendFrame(OpCode opCode, const char* data, size_t dataLength)
731 {
732     ASSERT(m_handle);
733     ASSERT(!m_suspended);
734
735     Vector<char> frame;
736     ASSERT(!(opCode & ~opCodeMask)); // Checks whether "opCode" fits in the range of opCodes.
737     frame.append(finalBit | opCode);
738     if (dataLength <= maxPayloadLengthWithoutExtendedLengthField)
739         frame.append(maskBit | dataLength);
740     else if (dataLength <= 0xFFFF) {
741         frame.append(maskBit | payloadLengthWithTwoByteExtendedLengthField);
742         frame.append((dataLength & 0xFF00) >> 8);
743         frame.append(dataLength & 0xFF);
744     } else {
745         frame.append(maskBit | payloadLengthWithEightByteExtendedLengthField);
746         char extendedPayloadLength[8];
747         size_t remaining = dataLength;
748         // Fill the length into extendedPayloadLength in the network byte order.
749         for (int i = 0; i < 8; ++i) {
750             extendedPayloadLength[7 - i] = remaining & 0xFF;
751             remaining >>= 8;
752         }
753         ASSERT(!remaining);
754         frame.append(extendedPayloadLength, 8);
755     }
756
757     // Mask the frame.
758     size_t maskingKeyStart = frame.size();
759     frame.grow(frame.size() + maskingKeyWidthInBytes); // Add placeholder for masking key. Will be overwritten.
760     size_t payloadStart = frame.size();
761     frame.append(data, dataLength);
762
763     cryptographicallyRandomValues(frame.data() + maskingKeyStart, maskingKeyWidthInBytes);
764     for (size_t i = 0; i < dataLength; ++i)
765         frame[payloadStart + i] ^= frame[maskingKeyStart + i % maskingKeyWidthInBytes];
766
767     return m_handle->send(frame.data(), frame.size());
768 }
769
770 bool WebSocketChannel::sendFrameHixie76(const char* data, size_t dataLength)
771 {
772     ASSERT(m_handle);
773     ASSERT(!m_suspended);
774
775     Vector<char> frame;
776     frame.append('\0'); // Frame type.
777     frame.append(data, dataLength);
778     frame.append('\xff'); // Frame end.
779     return m_handle->send(frame.data(), frame.size());
780 }
781
782 }  // namespace WebCore
783
784 #endif  // ENABLE(WEB_SOCKETS)