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