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