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