WebSocket: Remove hixie76 protocol implementation
[WebKit-https.git] / Source / WebCore / Modules / websockets / WebSocket.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 "WebSocket.h"
36
37 #include "Blob.h"
38 #include "BlobData.h"
39 #include "CloseEvent.h"
40 #include "ContentSecurityPolicy.h"
41 #include "DOMWindow.h"
42 #include "Event.h"
43 #include "EventException.h"
44 #include "EventListener.h"
45 #include "EventNames.h"
46 #include "ExceptionCode.h"
47 #include "Logging.h"
48 #include "MessageEvent.h"
49 #include "ScriptCallStack.h"
50 #include "ScriptExecutionContext.h"
51 #include "SecurityOrigin.h"
52 #include "ThreadableWebSocketChannel.h"
53 #include "WebSocketChannel.h"
54 #include <wtf/HashSet.h>
55 #include <wtf/OwnPtr.h>
56 #include <wtf/PassOwnPtr.h>
57 #include <wtf/StdLibExtras.h>
58 #include <wtf/text/CString.h>
59 #include <wtf/text/StringBuilder.h>
60 #include <wtf/text/WTFString.h>
61
62 using namespace std;
63
64 namespace WebCore {
65
66 const size_t maxReasonSizeInBytes = 123;
67
68 static inline bool isValidProtocolCharacter(UChar character)
69 {
70     // Hybi-10 says "(Subprotocol string must consist of) characters in the range U+0021 to U+007E not including
71     // separator characters as defined in [RFC2616]."
72     const UChar minimumProtocolCharacter = '!'; // U+0021.
73     const UChar maximumProtocolCharacter = '~'; // U+007E.
74     return character >= minimumProtocolCharacter && character <= maximumProtocolCharacter
75         && character != '"' && character != '(' && character != ')' && character != ',' && character != '/'
76         && !(character >= ':' && character <= '@') // U+003A - U+0040 (':', ';', '<', '=', '>', '?', '@').
77         && !(character >= '[' && character <= ']') // U+005B - U+005D ('[', '\\', ']').
78         && character != '{' && character != '}';
79 }
80
81 static bool isValidProtocolString(const String& protocol)
82 {
83     if (protocol.isEmpty())
84         return false;
85     for (size_t i = 0; i < protocol.length(); ++i) {
86         if (!isValidProtocolCharacter(protocol[i]))
87             return false;
88     }
89     return true;
90 }
91
92 static String encodeProtocolString(const String& protocol)
93 {
94     StringBuilder builder;
95     for (size_t i = 0; i < protocol.length(); i++) {
96         if (protocol[i] < 0x20 || protocol[i] > 0x7E)
97             builder.append(String::format("\\u%04X", protocol[i]));
98         else if (protocol[i] == 0x5c)
99             builder.append("\\\\");
100         else
101             builder.append(protocol[i]);
102     }
103     return builder.toString();
104 }
105
106 static String joinStrings(const Vector<String>& strings, const char* separator)
107 {
108     StringBuilder builder;
109     for (size_t i = 0; i < strings.size(); ++i) {
110         if (i)
111             builder.append(separator);
112         builder.append(strings[i]);
113     }
114     return builder.toString();
115 }
116
117 static unsigned long saturateAdd(unsigned long a, unsigned long b)
118 {
119     if (numeric_limits<unsigned long>::max() - a < b)
120         return numeric_limits<unsigned long>::max();
121     return a + b;
122 }
123
124 static bool webSocketsAvailable = false;
125
126 void WebSocket::setIsAvailable(bool available)
127 {
128     webSocketsAvailable = available;
129 }
130
131 bool WebSocket::isAvailable()
132 {
133     return webSocketsAvailable;
134 }
135
136 const char* WebSocket::subProtocolSeperator()
137 {
138     return ", ";
139 }
140
141 WebSocket::WebSocket(ScriptExecutionContext* context)
142     : ActiveDOMObject(context, this)
143     , m_state(CONNECTING)
144     , m_bufferedAmount(0)
145     , m_bufferedAmountAfterClose(0)
146     , m_binaryType(BinaryTypeBlob)
147     , m_subprotocol("")
148     , m_extensions("")
149 {
150 }
151
152 WebSocket::~WebSocket()
153 {
154     if (m_channel)
155         m_channel->disconnect();
156 }
157
158 PassRefPtr<WebSocket> WebSocket::create(ScriptExecutionContext* context)
159 {
160     RefPtr<WebSocket> webSocket(adoptRef(new WebSocket(context)));
161     webSocket->suspendIfNeeded();
162     return webSocket.release();
163 }
164
165 void WebSocket::connect(const String& url, ExceptionCode& ec)
166 {
167     Vector<String> protocols;
168     connect(url, protocols, ec);
169 }
170
171 void WebSocket::connect(const String& url, const String& protocol, ExceptionCode& ec)
172 {
173     Vector<String> protocols;
174     protocols.append(protocol);
175     connect(url, protocols, ec);
176 }
177
178 void WebSocket::connect(const String& url, const Vector<String>& protocols, ExceptionCode& ec)
179 {
180     LOG(Network, "WebSocket %p connect to %s", this, url.utf8().data());
181     m_url = KURL(KURL(), url);
182
183     if (!m_url.isValid()) {
184         scriptExecutionContext()->addConsoleMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Invalid url for WebSocket " + m_url.string(), scriptExecutionContext()->securityOrigin()->toString());
185         m_state = CLOSED;
186         ec = SYNTAX_ERR;
187         return;
188     }
189
190     if (!m_url.protocolIs("ws") && !m_url.protocolIs("wss")) {
191         scriptExecutionContext()->addConsoleMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong url scheme for WebSocket " + m_url.string(), scriptExecutionContext()->securityOrigin()->toString());
192         m_state = CLOSED;
193         ec = SYNTAX_ERR;
194         return;
195     }
196     if (m_url.hasFragmentIdentifier()) {
197         scriptExecutionContext()->addConsoleMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "URL has fragment component " + m_url.string(), scriptExecutionContext()->securityOrigin()->toString());
198         m_state = CLOSED;
199         ec = SYNTAX_ERR;
200         return;
201     }
202     if (!portAllowed(m_url)) {
203         scriptExecutionContext()->addConsoleMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "WebSocket port " + String::number(m_url.port()) + " blocked", scriptExecutionContext()->securityOrigin()->toString());
204         m_state = CLOSED;
205         ec = SECURITY_ERR;
206         return;
207     }
208
209     if (!scriptExecutionContext()->contentSecurityPolicy()->allowConnectToSource(m_url)) {
210         m_state = CLOSED;
211
212         // FIXME: Should this be throwing an exception?
213         ec = SECURITY_ERR;
214         return;
215     }
216
217     m_channel = ThreadableWebSocketChannel::create(scriptExecutionContext(), this);
218
219     // FIXME: There is a disagreement about restriction of subprotocols between WebSocket API and hybi-10 protocol
220     // draft. The former simply says "only characters in the range U+0021 to U+007E are allowed," while the latter
221     // imposes a stricter rule: "the elements MUST be non-empty strings with characters as defined in [RFC2616],
222     // and MUST all be unique strings."
223     //
224     // Here, we throw SYNTAX_ERR if the given protocols do not meet the latter criteria. This behavior does not
225     // comply with WebSocket API specification, but it seems to be the only reasonable way to handle this conflict.
226     for (size_t i = 0; i < protocols.size(); ++i) {
227         if (!isValidProtocolString(protocols[i])) {
228             scriptExecutionContext()->addConsoleMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Wrong protocol for WebSocket '" + encodeProtocolString(protocols[i]) + "'", scriptExecutionContext()->securityOrigin()->toString());
229             m_state = CLOSED;
230             ec = SYNTAX_ERR;
231             return;
232         }
233     }
234     HashSet<String> visited;
235     for (size_t i = 0; i < protocols.size(); ++i) {
236         if (visited.contains(protocols[i])) {
237             scriptExecutionContext()->addConsoleMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "WebSocket protocols contain duplicates: '" + encodeProtocolString(protocols[i]) + "'", scriptExecutionContext()->securityOrigin()->toString());
238             m_state = CLOSED;
239             ec = SYNTAX_ERR;
240             return;
241         }
242         visited.add(protocols[i]);
243     }
244
245     String protocolString;
246     if (!protocols.isEmpty())
247         protocolString = joinStrings(protocols, subProtocolSeperator());
248
249     m_channel->connect(m_url, protocolString);
250     ActiveDOMObject::setPendingActivity(this);
251 }
252
253 bool WebSocket::send(const String& message, ExceptionCode& ec)
254 {
255     LOG(Network, "WebSocket %p send %s", this, message.utf8().data());
256     if (m_state == CONNECTING) {
257         ec = INVALID_STATE_ERR;
258         return false;
259     }
260     // No exception is raised if the connection was once established but has subsequently been closed.
261     if (m_state == CLOSING || m_state == CLOSED) {
262         size_t payloadSize = message.utf8().length();
263         m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, payloadSize);
264         m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, getFramingOverhead(payloadSize));
265         return false;
266     }
267     ASSERT(m_channel);
268     ThreadableWebSocketChannel::SendResult result = m_channel->send(message);
269     if (result == ThreadableWebSocketChannel::InvalidMessage) {
270         scriptExecutionContext()->addConsoleMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "Websocket message contains invalid character(s).");
271         ec = SYNTAX_ERR;
272         return false;
273     }
274     return result == ThreadableWebSocketChannel::SendSuccess;
275 }
276
277 bool WebSocket::send(ArrayBuffer* binaryData, ExceptionCode& ec)
278 {
279     LOG(Network, "WebSocket %p send arraybuffer %p", this, binaryData);
280     ASSERT(binaryData);
281     if (m_state == CONNECTING) {
282         ec = INVALID_STATE_ERR;
283         return false;
284     }
285     if (m_state == CLOSING || m_state == CLOSED) {
286         unsigned payloadSize = binaryData->byteLength();
287         m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, payloadSize);
288         m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, getFramingOverhead(payloadSize));
289         return false;
290     }
291     ASSERT(m_channel);
292     return m_channel->send(*binaryData) == ThreadableWebSocketChannel::SendSuccess;
293 }
294
295 bool WebSocket::send(Blob* binaryData, ExceptionCode& ec)
296 {
297     LOG(Network, "WebSocket %p send blob %s", this, binaryData->url().string().utf8().data());
298     ASSERT(binaryData);
299     if (m_state == CONNECTING) {
300         ec = INVALID_STATE_ERR;
301         return false;
302     }
303     if (m_state == CLOSING || m_state == CLOSED) {
304         unsigned long payloadSize = static_cast<unsigned long>(binaryData->size());
305         m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, payloadSize);
306         m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, getFramingOverhead(payloadSize));
307         return false;
308     }
309     ASSERT(m_channel);
310     return m_channel->send(*binaryData) == ThreadableWebSocketChannel::SendSuccess;
311 }
312
313 void WebSocket::close(int code, const String& reason, ExceptionCode& ec)
314 {
315     if (code == WebSocketChannel::CloseEventCodeNotSpecified)
316         LOG(Network, "WebSocket %p close without code and reason", this);
317     else {
318         LOG(Network, "WebSocket %p close with code = %d, reason = %s", this, code, reason.utf8().data());
319         if (!(code == WebSocketChannel::CloseEventCodeNormalClosure || (WebSocketChannel::CloseEventCodeMinimumUserDefined <= code && code <= WebSocketChannel::CloseEventCodeMaximumUserDefined))) {
320             ec = INVALID_ACCESS_ERR;
321             return;
322         }
323         CString utf8 = reason.utf8(true);
324         if (utf8.length() > maxReasonSizeInBytes) {
325             scriptExecutionContext()->addConsoleMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "WebSocket close message is too long.");
326             ec = SYNTAX_ERR;
327             return;
328         }
329         // Checks whether reason is valid utf8.
330         if (utf8.isNull() && reason.length()) {
331             scriptExecutionContext()->addConsoleMessage(JSMessageSource, LogMessageType, ErrorMessageLevel, "WebSocket close message contains invalid character(s).");
332             ec = SYNTAX_ERR;
333             return;
334         }
335     }
336
337     if (m_state == CLOSING || m_state == CLOSED)
338         return;
339     if (m_state == CONNECTING) {
340         m_state = CLOSING;
341         m_channel->fail("WebSocket is closed before the connection is established.");
342         return;
343     }
344     m_state = CLOSING;
345     if (m_channel)
346         m_channel->close(code, reason);
347 }
348
349 const KURL& WebSocket::url() const
350 {
351     return m_url;
352 }
353
354 WebSocket::State WebSocket::readyState() const
355 {
356     return m_state;
357 }
358
359 unsigned long WebSocket::bufferedAmount() const
360 {
361     return saturateAdd(m_bufferedAmount, m_bufferedAmountAfterClose);
362 }
363
364 String WebSocket::protocol() const
365 {
366     return m_subprotocol;
367 }
368
369 String WebSocket::extensions() const
370 {
371     return m_extensions;
372 }
373
374 String WebSocket::binaryType() const
375 {
376     switch (m_binaryType) {
377     case BinaryTypeBlob:
378         return "blob";
379     case BinaryTypeArrayBuffer:
380         return "arraybuffer";
381     }
382     ASSERT_NOT_REACHED();
383     return String();
384 }
385
386 void WebSocket::setBinaryType(const String& binaryType, ExceptionCode& ec)
387 {
388     if (binaryType == "blob") {
389         m_binaryType = BinaryTypeBlob;
390         return;
391     }
392     if (binaryType == "arraybuffer") {
393         m_binaryType = BinaryTypeArrayBuffer;
394         return;
395     }
396     ec = SYNTAX_ERR;
397     return;
398 }
399
400 const AtomicString& WebSocket::interfaceName() const
401 {
402     return eventNames().interfaceForWebSocket;
403 }
404
405 ScriptExecutionContext* WebSocket::scriptExecutionContext() const
406 {
407     return ActiveDOMObject::scriptExecutionContext();
408 }
409
410 void WebSocket::contextDestroyed()
411 {
412     LOG(Network, "WebSocket %p scriptExecutionContext destroyed", this);
413     ASSERT(!m_channel);
414     ASSERT(m_state == CLOSED);
415     ActiveDOMObject::contextDestroyed();
416 }
417
418 bool WebSocket::canSuspend() const
419 {
420     return !m_channel;
421 }
422
423 void WebSocket::suspend(ReasonForSuspension)
424 {
425     if (m_channel)
426         m_channel->suspend();
427 }
428
429 void WebSocket::resume()
430 {
431     if (m_channel)
432         m_channel->resume();
433 }
434
435 void WebSocket::stop()
436 {
437     bool pending = hasPendingActivity();
438     if (m_channel)
439         m_channel->disconnect();
440     m_channel = 0;
441     m_state = CLOSED;
442     ActiveDOMObject::stop();
443     if (pending)
444         ActiveDOMObject::unsetPendingActivity(this);
445 }
446
447 void WebSocket::didConnect()
448 {
449     LOG(Network, "WebSocket %p didConnect", this);
450     if (m_state != CONNECTING) {
451         didClose(0, ClosingHandshakeIncomplete, WebSocketChannel::CloseEventCodeAbnormalClosure, "");
452         return;
453     }
454     ASSERT(scriptExecutionContext());
455     m_state = OPEN;
456     m_subprotocol = m_channel->subprotocol();
457     m_extensions = m_channel->extensions();
458     dispatchEvent(Event::create(eventNames().openEvent, false, false));
459 }
460
461 void WebSocket::didReceiveMessage(const String& msg)
462 {
463     LOG(Network, "WebSocket %p didReceiveMessage %s", this, msg.utf8().data());
464     if (m_state != OPEN && m_state != CLOSING)
465         return;
466     ASSERT(scriptExecutionContext());
467     dispatchEvent(MessageEvent::create(msg));
468 }
469
470 void WebSocket::didReceiveBinaryData(PassOwnPtr<Vector<char> > binaryData)
471 {
472     switch (m_binaryType) {
473     case BinaryTypeBlob: {
474         size_t size = binaryData->size();
475         RefPtr<RawData> rawData = RawData::create();
476         binaryData->swap(*rawData->mutableData());
477         OwnPtr<BlobData> blobData = BlobData::create();
478         blobData->appendData(rawData.release(), 0, BlobDataItem::toEndOfFile);
479         RefPtr<Blob> blob = Blob::create(blobData.release(), size);
480         dispatchEvent(MessageEvent::create(blob.release()));
481         break;
482     }
483
484     case BinaryTypeArrayBuffer:
485         dispatchEvent(MessageEvent::create(ArrayBuffer::create(binaryData->data(), binaryData->size())));
486         break;
487     }
488 }
489
490 void WebSocket::didReceiveMessageError()
491 {
492     LOG(Network, "WebSocket %p didReceiveErrorMessage", this);
493     ASSERT(scriptExecutionContext());
494     dispatchEvent(Event::create(eventNames().errorEvent, false, false));
495 }
496
497 void WebSocket::didUpdateBufferedAmount(unsigned long bufferedAmount)
498 {
499     LOG(Network, "WebSocket %p didUpdateBufferedAmount %lu", this, bufferedAmount);
500     if (m_state == CLOSED)
501         return;
502     m_bufferedAmount = bufferedAmount;
503 }
504
505 void WebSocket::didStartClosingHandshake()
506 {
507     LOG(Network, "WebSocket %p didStartClosingHandshake", this);
508     m_state = CLOSING;
509 }
510
511 void WebSocket::didClose(unsigned long unhandledBufferedAmount, ClosingHandshakeCompletionStatus closingHandshakeCompletion, unsigned short code, const String& reason)
512 {
513     LOG(Network, "WebSocket %p didClose", this);
514     if (!m_channel)
515         return;
516     bool wasClean = m_state == CLOSING && !unhandledBufferedAmount && closingHandshakeCompletion == ClosingHandshakeComplete && code != WebSocketChannel::CloseEventCodeAbnormalClosure;
517     m_state = CLOSED;
518     m_bufferedAmount = unhandledBufferedAmount;
519     ASSERT(scriptExecutionContext());
520     RefPtr<CloseEvent> event = CloseEvent::create(wasClean, code, reason);
521     dispatchEvent(event);
522     if (m_channel) {
523         m_channel->disconnect();
524         m_channel = 0;
525     }
526     if (hasPendingActivity())
527         ActiveDOMObject::unsetPendingActivity(this);
528 }
529
530 EventTargetData* WebSocket::eventTargetData()
531 {
532     return &m_eventTargetData;
533 }
534
535 EventTargetData* WebSocket::ensureEventTargetData()
536 {
537     return &m_eventTargetData;
538 }
539
540 size_t WebSocket::getFramingOverhead(size_t payloadSize)
541 {
542     static const size_t hybiBaseFramingOverhead = 2; // Every frame has at least two-byte header.
543     static const size_t hybiMaskingKeyLength = 4; // Every frame from client must have masking key.
544     static const size_t minimumPayloadSizeWithTwoByteExtendedPayloadLength = 126;
545     static const size_t minimumPayloadSizeWithEightByteExtendedPayloadLength = 0x10000;
546     size_t overhead = hybiBaseFramingOverhead + hybiMaskingKeyLength;
547     if (payloadSize >= minimumPayloadSizeWithEightByteExtendedPayloadLength)
548         overhead += 8;
549     else if (payloadSize >= minimumPayloadSizeWithTwoByteExtendedPayloadLength)
550         overhead += 2;
551     return overhead;
552 }
553
554 }  // namespace WebCore
555
556 #endif