/* * Copyright (C) 2011 Google Inc. All rights reserved. * Copyright (C) 2015-2016 Apple Inc. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following disclaimer * in the documentation and/or other materials provided with the * distribution. * * Neither the name of Google Inc. nor the names of its * contributors may be used to endorse or promote products derived from * this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #include "config.h" #include "WebSocket.h" #include "headers.h" // #include "Blob.h" #include "CloseEvent.h" // #include "ContentSecurityPolicy.h" // #include "DOMWindow.h" // #include "Document.h" #include "Event.h" #include "EventListener.h" #include "EventNames.h" // #include "Frame.h" // #include "FrameLoader.h" // #include "FrameLoaderClient.h" // #include "InspectorInstrumentation.h" // #include "Logging.h" #include "MessageEvent.h" // #include "MixedContentChecker.h" // #include "ResourceLoadObserver.h" // #include "ScriptController.h" #include "ScriptExecutionContext.h" // #include "SecurityOrigin.h" // #include "SocketProvider.h" // #include "ThreadableWebSocketChannel.h" // #include "WebSocketChannel.h" // #include "WorkerGlobalScope.h" // #include "WorkerLoaderProxy.h" // #include "WorkerThread.h" #include #include #include #include #include // #include #include // #include #include #include #include #include // #if USE(WEB_THREAD) // #include "WebCoreThreadRun.h" // #endif namespace WebCore { WTF_MAKE_ISO_ALLOCATED_IMPL(WebSocket); static size_t getFramingOverhead(size_t payloadSize) { static const size_t hybiBaseFramingOverhead = 2; // Every frame has at least two-byte header. static const size_t hybiMaskingKeyLength = 4; // Every frame from client must have masking key. static const size_t minimumPayloadSizeWithTwoByteExtendedPayloadLength = 126; static const size_t minimumPayloadSizeWithEightByteExtendedPayloadLength = 0x10000; size_t overhead = hybiBaseFramingOverhead + hybiMaskingKeyLength; if (payloadSize >= minimumPayloadSizeWithEightByteExtendedPayloadLength) overhead += 8; else if (payloadSize >= minimumPayloadSizeWithTwoByteExtendedPayloadLength) overhead += 2; return overhead; } const size_t maxReasonSizeInBytes = 123; static inline bool isValidProtocolCharacter(UChar character) { // Hybi-10 says "(Subprotocol string must consist of) characters in the range U+0021 to U+007E not including // separator characters as defined in [RFC2616]." const UChar minimumProtocolCharacter = '!'; // U+0021. const UChar maximumProtocolCharacter = '~'; // U+007E. return character >= minimumProtocolCharacter && character <= maximumProtocolCharacter && character != '"' && character != '(' && character != ')' && character != ',' && character != '/' && !(character >= ':' && character <= '@') // U+003A - U+0040 (':', ';', '<', '=', '>', '?', '@'). && !(character >= '[' && character <= ']') // U+005B - U+005D ('[', '\\', ']'). && character != '{' && character != '}'; } static bool isValidProtocolString(StringView protocol) { if (protocol.isEmpty()) return false; for (auto codeUnit : protocol.codeUnits()) { if (!isValidProtocolCharacter(codeUnit)) return false; } return true; } static String encodeProtocolString(const String& protocol) { StringBuilder builder; for (size_t i = 0; i < protocol.length(); i++) { if (protocol[i] < 0x20 || protocol[i] > 0x7E) builder.append("\\u", hex(protocol[i], 4)); else if (protocol[i] == 0x5c) builder.append("\\\\"); else builder.append(protocol[i]); } return builder.toString(); } static String joinStrings(const Vector& strings, const char* separator) { StringBuilder builder; for (size_t i = 0; i < strings.size(); ++i) { if (i) builder.append(separator); builder.append(strings[i]); } return builder.toString(); } static unsigned saturateAdd(unsigned a, unsigned b) { if (std::numeric_limits::max() - a < b) return std::numeric_limits::max(); return a + b; } ASCIILiteral WebSocket::subprotocolSeparator() { return ", "_s; } WebSocket::WebSocket(ScriptExecutionContext& context) : ContextDestructionObserver(&context) , m_subprotocol(emptyString()) , m_extensions(emptyString()) { } WebSocket::~WebSocket() { if (m_upgradeClient != nullptr) { void* upgradeClient = m_upgradeClient; if (m_isSecure) { Bun__WebSocketHTTPSClient__cancel(upgradeClient); } else { Bun__WebSocketHTTPClient__cancel(upgradeClient); } } switch (m_connectedWebSocketKind) { case ConnectedWebSocketKind::Client: { Bun__WebSocketClient__finalize(this->m_connectedWebSocket.client); break; } case ConnectedWebSocketKind::ClientSSL: { Bun__WebSocketClientTLS__finalize(this->m_connectedWebSocket.clientSSL); break; } case ConnectedWebSocketKind::Server: { this->m_connectedWebSocket.server->end(None); break; } case ConnectedWebSocketKind::ServerSSL: { this->m_connectedWebSocket.serverSSL->end(None); break; } default: { break; } } } ExceptionOr> WebSocket::create(ScriptExecutionContext& context, const String& url) { return create(context, url, Vector {}); } ExceptionOr> WebSocket::create(ScriptExecutionContext& context, const String& url, const Vector& protocols) { if (url.isNull()) return Exception { SyntaxError }; auto socket = adoptRef(*new WebSocket(context)); // socket->suspendIfNeeded(); auto result = socket->connect(url, protocols); // auto result = socket->connect(url, protocols); if (result.hasException()) return result.releaseException(); return socket; } ExceptionOr> WebSocket::create(ScriptExecutionContext& context, const String& url, const String& protocol) { return create(context, url, Vector { 1, protocol }); } ExceptionOr WebSocket::connect(const String& url) { return connect(url, Vector {}); } ExceptionOr WebSocket::connect(const String& url, const String& protocol) { return connect(url, Vector { 1, protocol }); } void WebSocket::failAsynchronously() { // queueTaskKeepingObjectAlive(*this, TaskSource::WebSocket, [this] { // We must block this connection. Instead of throwing an exception, we indicate this // using the error event. But since this code executes as part of the WebSocket's // constructor, we have to wait until the constructor has completed before firing the // event; otherwise, users can't connect to the event. this->dispatchErrorEventIfNeeded(); // this->(); // this->stop(); // }); } static String resourceName(const URL& url) { auto path = url.path(); auto result = makeString( path, path.isEmpty() ? "/" : "", url.queryWithLeadingQuestionMark()); ASSERT(!result.isEmpty()); ASSERT(!result.contains(' ')); return result; } static String hostName(const URL& url, bool secure) { ASSERT(url.protocolIs("wss") == secure); if (url.port() && ((!secure && url.port().value() != 80) || (secure && url.port().value() != 443))) return makeString(asASCIILowercase(url.host()), ':', url.port().value()); return url.host().convertToASCIILowercase(); } ExceptionOr WebSocket::connect(const String& url, const Vector& protocols) { LOG(Network, "WebSocket %p connect() url='%s'", this, url.utf8().data()); m_url = URL { url }; ASSERT(scriptExecutionContext()); auto& context = *scriptExecutionContext(); if (!m_url.isValid()) { // context.addConsoleMessage(MessageSource::JS, MessageLevel::Error, ); m_state = CLOSED; return Exception { SyntaxError, makeString("Invalid url for WebSocket "_s, m_url.stringCenterEllipsizedToLength()) }; } bool is_secure = m_url.protocolIs("wss"_s); if (!m_url.protocolIs("ws"_s) && !is_secure) { // context.addConsoleMessage(MessageSource::JS, MessageLevel::Error, ); m_state = CLOSED; return Exception { SyntaxError, makeString("Wrong url scheme for WebSocket "_s, m_url.stringCenterEllipsizedToLength()) }; } if (m_url.hasFragmentIdentifier()) { // context.addConsoleMessage(MessageSource::JS, MessageLevel::Error, ); m_state = CLOSED; return Exception { SyntaxError, makeString("URL has fragment component "_s, m_url.stringCenterEllipsizedToLength()) }; } // ASSERT(context.contentSecurityPolicy()); // auto& contentSecurityPolicy = *context.contentSecurityPolicy(); // contentSecurityPolicy.upgradeInsecureRequestIfNeeded(m_url, ContentSecurityPolicy::InsecureRequestType::Load); // if (!portAllowed(m_url)) { // String message; // if (m_url.port()) // message = makeString("WebSocket port ", m_url.port().value(), " blocked"); // else // message = "WebSocket without port blocked"_s; // context.addConsoleMessage(MessageSource::JS, MessageLevel::Error, message); // failAsynchronously(); // return {}; // } // FIXME: Convert this to check the isolated world's Content Security Policy once webkit.org/b/104520 is solved. // if (!context.shouldBypassMainWorldContentSecurityPolicy() && !contentSecurityPolicy.allowConnectToSource(m_url)) { // m_state = CLOSED; // // FIXME: Should this be throwing an exception? // return Exception { SecurityError }; // } // FIXME: There is a disagreement about restriction of subprotocols between WebSocket API and hybi-10 protocol // draft. The former simply says "only characters in the range U+0021 to U+007E are allowed," while the latter // imposes a stricter rule: "the elements MUST be non-empty strings with characters as defined in [RFC2616], // and MUST all be unique strings." // // Here, we throw SyntaxError if the given protocols do not meet the latter criteria. This behavior does not // comply with WebSocket API specification, but it seems to be the only reasonable way to handle this conflict. for (auto& protocol : protocols) { if (!isValidProtocolString(protocol)) { // context.addConsoleMessage(MessageSource::JS, MessageLevel::Error, ); m_state = CLOSED; return Exception { SyntaxError, makeString("Wrong protocol for WebSocket '"_s, encodeProtocolString(protocol), "'"_s) }; } } HashSet visited; for (auto& protocol : protocols) { if (!visited.add(protocol).isNewEntry) { // context.addConsoleMessage(MessageSource::JS, MessageLevel::Error, ); m_state = CLOSED; return Exception { SyntaxError, makeString("WebSocket protocols contain duplicates:"_s, encodeProtocolString(protocol), "'"_s) }; } } // RunLoop::main().dispatch([targetURL = m_url.isolatedCopy(), mainFrameURL = context.url().isolatedCopy()]() { // ResourceLoadObserver::shared().logWebSocketLoading(targetURL, mainFrameURL); // }); // if (is(context)) { // Document& document = downcast(context); // RefPtr frame = document.frame(); // // FIXME: make the mixed content check equivalent to the non-document mixed content check currently in WorkerThreadableWebSocketChannel::Bridge::connect() // if (!frame || !MixedContentChecker::canRunInsecureContent(*frame, document.securityOrigin(), m_url)) { // failAsynchronously(); // return { }; // } // } String protocolString; if (!protocols.isEmpty()) protocolString = joinStrings(protocols, subprotocolSeparator()); ZigString host = Zig::toZigString(m_url.host()); auto resource = resourceName(m_url); ZigString path = Zig::toZigString(resource); ZigString clientProtocolString = Zig::toZigString(protocolString); uint16_t port = is_secure ? 443 : 80; if (auto userPort = m_url.port()) { port = userPort.value(); } m_isSecure = is_secure; if (is_secure) { us_socket_context_t* ctx = scriptExecutionContext()->webSocketContext(); RELEASE_ASSERT(ctx); this->m_upgradeClient = Bun__WebSocketHTTPSClient__connect(scriptExecutionContext()->jsGlobalObject(), ctx, this, &host, port, &path, &clientProtocolString); } else { us_socket_context_t* ctx = scriptExecutionContext()->webSocketContext(); RELEASE_ASSERT(ctx); this->m_upgradeClient = Bun__WebSocketHTTPClient__connect(scriptExecutionContext()->jsGlobalObject(), ctx, this, &host, port, &path, &clientProtocolString); } if (this->m_upgradeClient == nullptr) { // context.addConsoleMessage(MessageSource::JS, MessageLevel::Error, ); m_state = CLOSED; return Exception { SyntaxError, "WebSocket connection failed"_s }; } m_state = CONNECTING; // #if ENABLE(INTELLIGENT_TRACKING_PREVENTION) // auto reportRegistrableDomain = [domain = RegistrableDomain(m_url).isolatedCopy()](auto& context) mutable { // if (auto* frame = downcast(context).frame()) // frame->loader().client().didLoadFromRegistrableDomain(WTFMove(domain)); // }; // if (is(context)) // reportRegistrableDomain(context); // else // downcast(context).thread().workerLoaderProxy().postTaskToLoader(WTFMove(reportRegistrableDomain)); // #endif // m_pendingActivity = makePendingActivity(*this); return {}; } ExceptionOr WebSocket::send(const String& message) { LOG(Network, "WebSocket %p send() Sending String '%s'", this, message.utf8().data()); if (m_state == CONNECTING) return Exception { InvalidStateError }; // No exception is raised if the connection was once established but has subsequently been closed. if (m_state == CLOSING || m_state == CLOSED) { auto utf8 = message.utf8(StrictConversionReplacingUnpairedSurrogatesWithFFFD); size_t payloadSize = utf8.length(); m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, payloadSize); m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, getFramingOverhead(payloadSize)); return {}; } if (message.length() > 0) this->sendWebSocketString(message); return {}; } ExceptionOr WebSocket::send(ArrayBuffer& binaryData) { LOG(Network, "WebSocket %p send() Sending ArrayBuffer %p", this, &binaryData); if (m_state == CONNECTING) return Exception { InvalidStateError }; if (m_state == CLOSING || m_state == CLOSED) { unsigned payloadSize = binaryData.byteLength(); m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, payloadSize); m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, getFramingOverhead(payloadSize)); return {}; } char* data = static_cast(binaryData.data()); size_t length = binaryData.byteLength(); if (length > 0) this->sendWebSocketData(data, length); return {}; } ExceptionOr WebSocket::send(ArrayBufferView& arrayBufferView) { LOG(Network, "WebSocket %p send() Sending ArrayBufferView %p", this, &arrayBufferView); if (m_state == CONNECTING) return Exception { InvalidStateError }; if (m_state == CLOSING || m_state == CLOSED) { unsigned payloadSize = arrayBufferView.byteLength(); m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, payloadSize); m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, getFramingOverhead(payloadSize)); return {}; } auto buffer = arrayBufferView.unsharedBuffer().get(); char* baseAddress = reinterpret_cast(buffer->data()) + arrayBufferView.byteOffset(); size_t length = arrayBufferView.byteLength(); if (length > 0) this->sendWebSocketData(baseAddress, length); return {}; } // ExceptionOr WebSocket::send(Blob& binaryData) // { // LOG(Network, "WebSocket %p send() Sending Blob '%s'", this, binaryData.url().stringCenterEllipsizedToLength().utf8().data()); // if (m_state == CONNECTING) // return Exception { InvalidStateError }; // if (m_state == CLOSING || m_state == CLOSED) { // unsigned payloadSize = static_cast(binaryData.size()); // m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, payloadSize); // m_bufferedAmountAfterClose = saturateAdd(m_bufferedAmountAfterClose, getFramingOverhead(payloadSize)); // return {}; // } // m_bufferedAmount = saturateAdd(m_bufferedAmount, binaryData.size()); // ASSERT(m_channel); // m_channel->send(binaryData); // return {}; // } void WebSocket::sendWebSocketData(const char* baseAddress, size_t length) { uWS::OpCode opCode = uWS::OpCode::BINARY; switch (m_connectedWebSocketKind) { case ConnectedWebSocketKind::Client: { Bun__WebSocketClient__writeBinaryData(this->m_connectedWebSocket.client, reinterpret_cast(baseAddress), length); // this->m_connectedWebSocket.client->send({ baseAddress, length }, opCode); // this->m_bufferedAmount = this->m_connectedWebSocket.client->getBufferedAmount(); break; } case ConnectedWebSocketKind::ClientSSL: { Bun__WebSocketClientTLS__writeBinaryData(this->m_connectedWebSocket.clientSSL, reinterpret_cast(baseAddress), length); break; } case ConnectedWebSocketKind::Server: { this->m_connectedWebSocket.server->send({ baseAddress, length }, opCode); this->m_bufferedAmount = this->m_connectedWebSocket.server->getBufferedAmount(); break; } case ConnectedWebSocketKind::ServerSSL: { this->m_connectedWebSocket.serverSSL->send({ baseAddress, length }, opCode); this->m_bufferedAmount = this->m_connectedWebSocket.serverSSL->getBufferedAmount(); break; } default: { RELEASE_ASSERT_NOT_REACHED(); } } } void WebSocket::sendWebSocketString(const String& message) { switch (m_connectedWebSocketKind) { case ConnectedWebSocketKind::Client: { auto zigStr = Zig::toZigString(message); Bun__WebSocketClient__writeString(this->m_connectedWebSocket.client, &zigStr); // this->m_connectedWebSocket.client->send({ baseAddress, length }, opCode); // this->m_bufferedAmount = this->m_connectedWebSocket.client->getBufferedAmount(); break; } case ConnectedWebSocketKind::ClientSSL: { auto zigStr = Zig::toZigString(message); Bun__WebSocketClientTLS__writeString(this->m_connectedWebSocket.clientSSL, &zigStr); break; } case ConnectedWebSocketKind::Server: { auto utf8 = message.utf8(StrictConversionReplacingUnpairedSurrogatesWithFFFD); this->m_connectedWebSocket.server->send({ utf8.data(), utf8.length() }, uWS::OpCode::TEXT); this->m_bufferedAmount = this->m_connectedWebSocket.server->getBufferedAmount(); break; } case ConnectedWebSocketKind::ServerSSL: { auto utf8 = message.utf8(StrictConversionReplacingUnpairedSurrogatesWithFFFD); this->m_connectedWebSocket.serverSSL->send({ utf8.data(), utf8.length() }, uWS::OpCode::TEXT); this->m_bufferedAmount = this->m_connectedWebSocket.serverSSL->getBufferedAmount(); break; } default: { RELEASE_ASSERT_NOT_REACHED(); } } } ExceptionOr WebSocket::close(std::optional optionalCode, const String& reason) { int code = optionalCode ? optionalCode.value() : static_cast(0); if (code == 0) LOG(Network, "WebSocket %p close() without code and reason", this); else { LOG(Network, "WebSocket %p close() code=%d reason='%s'", this, code, reason.utf8().data()); // if (!(code == WebSocketChannel::CloseEventCodeNormalClosure || (WebSocketChannel::CloseEventCodeMinimumUserDefined <= code && code <= WebSocketChannel::CloseEventCodeMaximumUserDefined))) // return Exception { InvalidAccessError }; if (reason.length() > maxReasonSizeInBytes) { // scriptExecutionContext()->addConsoleMessage(MessageSource::JS, MessageLevel::Error, "WebSocket close message is too long."_s); return Exception { SyntaxError, "WebSocket close message is too long."_s }; } } if (m_state == CLOSING || m_state == CLOSED) return {}; if (m_state == CONNECTING) { m_state = CLOSING; if (m_upgradeClient != nullptr) { void* upgradeClient = m_upgradeClient; m_upgradeClient = nullptr; if (m_isSecure) { Bun__WebSocketHTTPSClient__cancel(upgradeClient); } else { Bun__WebSocketHTTPClient__cancel(upgradeClient); } } return {}; } m_state = CLOSING; switch (m_connectedWebSocketKind) { case ConnectedWebSocketKind::Client: { ZigString reasonZigStr = Zig::toZigString(reason); Bun__WebSocketClient__close(this->m_connectedWebSocket.client, code, &reasonZigStr); // this->m_bufferedAmount = this->m_connectedWebSocket.client->getBufferedAmount(); break; } case ConnectedWebSocketKind::ClientSSL: { ZigString reasonZigStr = Zig::toZigString(reason); Bun__WebSocketClientTLS__close(this->m_connectedWebSocket.clientSSL, code, &reasonZigStr); // this->m_bufferedAmount = this->m_connectedWebSocket.clientSSL->getBufferedAmount(); break; } case ConnectedWebSocketKind::Server: { // this->m_connectedWebSocket.server->end(code, { utf8.data(), utf8.length() }); // this->m_bufferedAmount = this->m_connectedWebSocket.server->getBufferedAmount(); break; } case ConnectedWebSocketKind::ServerSSL: { // this->m_connectedWebSocket.serverSSL->end(code, { utf8.data(), utf8.length() }); // this->m_bufferedAmount = this->m_connectedWebSocket.serverSSL->getBufferedAmount(); break; } default: { break; } } this->m_connectedWebSocketKind = ConnectedWebSocketKind::None; return {}; } const URL& WebSocket::url() const { return m_url; } WebSocket::State WebSocket::readyState() const { return m_state; } unsigned WebSocket::bufferedAmount() const { return saturateAdd(m_bufferedAmount, m_bufferedAmountAfterClose); } String WebSocket::protocol() const { return m_subprotocol; } String WebSocket::extensions() const { return m_extensions; } String WebSocket::binaryType() const { switch (m_binaryType) { // case BinaryType::Blob: // return "blob"_s; case BinaryType::ArrayBuffer: return "arraybuffer"_s; } ASSERT_NOT_REACHED(); return String(); } ExceptionOr WebSocket::setBinaryType(const String& binaryType) { // if (binaryType == "blob") { // m_binaryType = BinaryType::Blob; // return {}; // } if (binaryType == "arraybuffer") { m_binaryType = BinaryType::ArrayBuffer; return {}; } // scriptExecutionContext()->addConsoleMessage(MessageSource::JS, MessageLevel::Error, "'" + binaryType + "' is not a valid value for binaryType; binaryType remains unchanged."); return Exception { SyntaxError, makeString("'"_s, binaryType, "' is not a valid value for binaryType; binaryType remains unchanged."_s) }; } EventTargetInterface WebSocket::eventTargetInterface() const { return WebSocketEventTargetInterfaceType; } ScriptExecutionContext* WebSocket::scriptExecutionContext() const { return ContextDestructionObserver::scriptExecutionContext(); } // void WebSocket::contextDestroyed() // { // LOG(Network, "WebSocket %p contextDestroyed()", this); // ASSERT(!m_channel); // ASSERT(m_state == CLOSED); // // ActiveDOMObject::contextDestroyed(); // } // void WebSocket::suspend(ReasonForSuspension reason) // { // // if (!m_channel) // // return; // // if (reason == ReasonForSuspension::BackForwardCache) { // // // This will cause didClose() to be called. // // m_channel->fail("WebSocket is closed due to suspension."_s); // // return; // // } // // m_channel->suspend(); // } // void WebSocket::resume() // { // // if (m_channel) // // m_channel->resume(); // } // void WebSocket::stop() // { // if (m_channel) // m_channel->disconnect(); // m_channel = nullptr; // m_state = CLOSED; // // ActiveDOMObject::stop(); // // m_pendingActivity = nullptr; // } // const char* WebSocket::activeDOMObjectName() const // { // return "WebSocket"; // } void WebSocket::didConnect() { LOG(Network, "WebSocket %p didConnect()", this); // queueTaskKeepingObjectAlive(*this, TaskSource::WebSocket, [this] { if (m_state == CLOSED) return; if (m_state != CONNECTING) { didClose(0, 0, emptyString()); return; } m_state = OPEN; if (auto* context = scriptExecutionContext()) { if (this->hasEventListeners("open"_s)) { // the main reason for dispatching on a separate tick is to handle when you haven't yet attached an event listener dispatchEvent(Event::create(eventNames().openEvent, Event::CanBubble::No, Event::IsCancelable::No)); } else { context->postTask([this, protectedThis = Ref { *this }](ScriptExecutionContext& context) { ASSERT(scriptExecutionContext()); // m_subprotocol = m_channel->subprotocol(); // m_extensions = m_channel->extensions(); protectedThis->dispatchEvent(Event::create(eventNames().openEvent, Event::CanBubble::No, Event::IsCancelable::No)); // }); }); } } } void WebSocket::didReceiveMessage(String&& message) { LOG(Network, "WebSocket %p didReceiveMessage() Text message '%s'", this, message.utf8().data()); // queueTaskKeepingObjectAlive(*this, TaskSource::WebSocket, [this, message = WTFMove(message)]() mutable { if (m_state != OPEN) return; // if (UNLIKELY(InspectorInstrumentation::hasFrontends())) { // if (auto* inspector = m_channel->channelInspector()) { // auto utf8Message = message.utf8(); // inspector->didReceiveWebSocketFrame(WebSocketChannelInspector::createFrame(utf8Message.dataAsUInt8Ptr(), utf8Message.length(), WebSocketFrame::OpCode::OpCodeText)); // } // } if (this->hasEventListeners("message"_s)) { // the main reason for dispatching on a separate tick is to handle when you haven't yet attached an event listener dispatchEvent(MessageEvent::create(WTFMove(message), m_url.string())); return; } if (auto* context = scriptExecutionContext()) { context->postTask([this, message_ = message, protectedThis = Ref { *this }](ScriptExecutionContext& context) { ASSERT(scriptExecutionContext()); protectedThis->dispatchEvent(MessageEvent::create(message_, protectedThis->m_url.string())); }); } // }); } void WebSocket::didReceiveBinaryData(Vector&& binaryData) { LOG(Network, "WebSocket %p didReceiveBinaryData() %u byte binary message", this, static_cast(binaryData.size())); // queueTaskKeepingObjectAlive(*this, TaskSource::WebSocket, [this, binaryData = WTFMove(binaryData)]() mutable { if (m_state != OPEN) return; // if (UNLIKELY(InspectorInstrumentation::hasFrontends())) { // if (auto* inspector = m_channel->channelInspector()) // inspector->didReceiveWebSocketFrame(WebSocketChannelInspector::createFrame(binaryData.data(), binaryData.size(), WebSocketFrame::OpCode::OpCodeBinary)); // } switch (m_binaryType) { // case BinaryType::Blob: // // FIXME: We just received the data from NetworkProcess, and are sending it back. This is inefficient. // dispatchEvent(MessageEvent::create(Blob::create(scriptExecutionContext(), WTFMove(binaryData), emptyString()), SecurityOrigin::create(m_url)->toString())); // break; case BinaryType::ArrayBuffer: { if (this->hasEventListeners("message"_s)) { // the main reason for dispatching on a separate tick is to handle when you haven't yet attached an event listener dispatchEvent(MessageEvent::create(ArrayBuffer::create(binaryData.data(), binaryData.size()), m_url.string())); return; } if (auto* context = scriptExecutionContext()) { context->postTask([this, binaryData = binaryData, protectedThis = Ref { *this }](ScriptExecutionContext& context) { ASSERT(scriptExecutionContext()); protectedThis->dispatchEvent(MessageEvent::create(ArrayBuffer::create(binaryData.data(), binaryData.size()), m_url.string())); }); } break; } } // }); } void WebSocket::didReceiveMessageError(WTF::StringImpl::StaticStringImpl* reason) { LOG(Network, "WebSocket %p didReceiveErrorMessage()", this); // queueTaskKeepingObjectAlive(*this, TaskSource::WebSocket, [this, reason = WTFMove(reason)] { if (m_state == CLOSED) return; m_state = CLOSED; if (auto* context = scriptExecutionContext()) { context->postTask([this, reason, protectedThis = Ref { *this }](ScriptExecutionContext& context) { ASSERT(scriptExecutionContext()); // if (UNLIKELY(InspectorInstrumentation::hasFrontends())) { // if (auto* inspector = m_channel->channelInspector()) // inspector->didReceiveWebSocketFrameError(reason); // } // FIXME: As per https://html.spec.whatwg.org/multipage/web-sockets.html#feedback-from-the-protocol:concept-websocket-closed, we should synchronously fire a close event. dispatchEvent(CloseEvent::create(false, 0, WTF::String(reason))); }); } } void WebSocket::didUpdateBufferedAmount(unsigned bufferedAmount) { LOG(Network, "WebSocket %p didUpdateBufferedAmount() New bufferedAmount is %u", this, bufferedAmount); if (m_state == CLOSED) return; m_bufferedAmount = bufferedAmount; } void WebSocket::didStartClosingHandshake() { LOG(Network, "WebSocket %p didStartClosingHandshake()", this); // queueTaskKeepingObjectAlive(*this, TaskSource::WebSocket, [this] { if (m_state == CLOSED) return; m_state = CLOSING; // }); } void WebSocket::didClose(unsigned unhandledBufferedAmount, unsigned short code, const String& reason) { LOG(Network, "WebSocket %p didClose()", this); if (this->m_connectedWebSocketKind == ConnectedWebSocketKind::None) return; // queueTaskKeepingObjectAlive(*this, TaskSource::WebSocket, [this, unhandledBufferedAmount, closingHandshakeCompletion, code, reason] { // if (!m_channel) // return; // if (UNLIKELY(InspectorInstrumentation::hasFrontends())) { // if (auto* inspector = m_channel->channelInspector()) { // WebSocketFrame closingFrame(WebSocketFrame::OpCodeClose, true, false, false); // inspector->didReceiveWebSocketFrame(closingFrame); // inspector->didCloseWebSocket(); // } // } bool wasClean = m_state == CLOSING && !unhandledBufferedAmount && code != 0; // WebSocketChannel::CloseEventCodeAbnormalClosure; m_state = CLOSED; m_bufferedAmount = unhandledBufferedAmount; ASSERT(scriptExecutionContext()); this->m_connectedWebSocketKind = ConnectedWebSocketKind::None; this->m_upgradeClient = nullptr; if (auto* context = scriptExecutionContext()) { context->postTask([this, code, wasClean, reason, protectedThis = Ref { *this }](ScriptExecutionContext& context) { ASSERT(scriptExecutionContext()); protectedThis->dispatchEvent(CloseEvent::create(wasClean, code, reason)); }); } // m_pendingActivity = nullptr; // }); } // void WebSocket::didUpgradeURL() // { // ASSERT(m_url.protocolIs("ws")); // m_url.setProtocol("wss"); // } void WebSocket::dispatchErrorEventIfNeeded() { if (m_dispatchedErrorEvent) return; m_dispatchedErrorEvent = true; if (auto* context = scriptExecutionContext()) { context->postTask([this, protectedThis = Ref { *this }](ScriptExecutionContext& context) { ASSERT(scriptExecutionContext()); protectedThis->dispatchEvent(Event::create(eventNames().errorEvent, Event::CanBubble::No, Event::IsCancelable::No)); }); } } void WebSocket::didConnect(us_socket_t* socket, char* bufferedData, size_t bufferedDataSize) { this->m_upgradeClient = nullptr; if (m_isSecure) { us_socket_context_t* ctx = (us_socket_context_t*)this->scriptExecutionContext()->connnectedWebSocketContext(); this->m_connectedWebSocket.clientSSL = Bun__WebSocketClientTLS__init(this, socket, ctx, this->scriptExecutionContext()->jsGlobalObject()); this->m_connectedWebSocketKind = ConnectedWebSocketKind::ClientSSL; } else { us_socket_context_t* ctx = (us_socket_context_t*)this->scriptExecutionContext()->connnectedWebSocketContext(); this->m_connectedWebSocket.client = Bun__WebSocketClient__init(this, socket, ctx, this->scriptExecutionContext()->jsGlobalObject()); this->m_connectedWebSocketKind = ConnectedWebSocketKind::Client; } this->didConnect(); } void WebSocket::didFailWithErrorCode(int32_t code) { if (m_state == CLOSED) return; this->m_upgradeClient = nullptr; this->m_connectedWebSocketKind = ConnectedWebSocketKind::None; this->m_connectedWebSocket.client = nullptr; switch (code) { // cancel case 0: { break; } // invalid_response case 1: { auto message = MAKE_STATIC_STRING_IMPL("Invalid response"); didReceiveMessageError(message); break; } // expected_101_status_code case 2: { auto message = MAKE_STATIC_STRING_IMPL("Expected 101 status code"); didReceiveMessageError(message); break; } // missing_upgrade_header case 3: { auto message = MAKE_STATIC_STRING_IMPL("Missing upgrade header"); didReceiveMessageError(message); break; } // missing_connection_header case 4: { auto message = MAKE_STATIC_STRING_IMPL("Missing connection header"); didReceiveMessageError(message); break; } // missing_websocket_accept_header case 5: { auto message = MAKE_STATIC_STRING_IMPL("Missing websocket accept header"); didReceiveMessageError(message); break; } // invalid_upgrade_header case 6: { auto message = MAKE_STATIC_STRING_IMPL("Invalid upgrade header"); didReceiveMessageError(message); break; } // invalid_connection_header case 7: { auto message = MAKE_STATIC_STRING_IMPL("Invalid connection header"); didReceiveMessageError(message); break; } // invalid_websocket_version case 8: { auto message = MAKE_STATIC_STRING_IMPL("Invalid websocket version"); didReceiveMessageError(message); break; } // mismatch_websocket_accept_header case 9: { auto message = MAKE_STATIC_STRING_IMPL("Mismatch websocket accept header"); didReceiveMessageError(message); break; } // missing_client_protocol case 10: { auto message = MAKE_STATIC_STRING_IMPL("Missing client protocol"); didReceiveMessageError(message); break; } // mismatch_client_protocol case 11: { auto message = MAKE_STATIC_STRING_IMPL("Mismatch client protocol"); didReceiveMessageError(message); break; } // timeout case 12: { auto message = MAKE_STATIC_STRING_IMPL("Timeout"); didReceiveMessageError(message); break; } // closed case 13: { auto message = MAKE_STATIC_STRING_IMPL("Closed by client"); didReceiveMessageError(message); break; } // failed_to_write case 14: { auto message = MAKE_STATIC_STRING_IMPL("Failed to write"); didReceiveMessageError(message); break; } // failed_to_connect case 15: { auto message = MAKE_STATIC_STRING_IMPL("Failed to connect"); didReceiveMessageError(message); break; } // headers_too_large case 16: { auto message = MAKE_STATIC_STRING_IMPL("Headers too large"); didReceiveMessageError(message); break; } // ended case 17: { auto message = MAKE_STATIC_STRING_IMPL("Closed by server"); didReceiveMessageError(message); break; } // failed_to_allocate_memory case 18: { auto message = MAKE_STATIC_STRING_IMPL("Failed to allocate memory"); didReceiveMessageError(message); break; } // control_frame_is_fragmented case 19: { auto message = MAKE_STATIC_STRING_IMPL("Protocol error - control frame is fragmented"); didReceiveMessageError(message); break; } // invalid_control_frame case 20: { auto message = MAKE_STATIC_STRING_IMPL("Protocol error - invalid control frame"); didReceiveMessageError(message); break; } // compression_unsupported case 21: { auto message = MAKE_STATIC_STRING_IMPL("Compression not implemented yet"); didReceiveMessageError(message); break; } // unexpected_mask_from_server case 22: { auto message = MAKE_STATIC_STRING_IMPL("Protocol error - unexpected mask from server"); didReceiveMessageError(message); break; } // expected_control_frame case 23: { auto message = MAKE_STATIC_STRING_IMPL("Protocol error - expected control frame"); didReceiveMessageError(message); break; } // unsupported_control_frame case 24: { auto message = MAKE_STATIC_STRING_IMPL("Protocol error - unsupported control frame"); didReceiveMessageError(message); break; } // unexpected_opcode case 25: { auto message = MAKE_STATIC_STRING_IMPL("Protocol error - unexpected opcode"); didReceiveMessageError(message); break; } // invalid_utf8 case 26: { auto message = MAKE_STATIC_STRING_IMPL("Server sent invalid UTF8"); didReceiveMessageError(message); break; } } m_state = CLOSED; } } // namespace WebCore extern "C" void WebSocket__didConnect(WebCore::WebSocket* webSocket, us_socket_t* socket, char* bufferedData, size_t len) { webSocket->didConnect(socket, bufferedData, len); } extern "C" void WebSocket__didCloseWithErrorCode(WebCore::WebSocket* webSocket, int32_t errorCode) { webSocket->didFailWithErrorCode(errorCode); } extern "C" void WebSocket__didReceiveText(WebCore::WebSocket* webSocket, bool clone, const ZigString* str) { WTF::String wtf_str = Zig::toString(*str); if (clone) { wtf_str = wtf_str.isolatedCopy(); } webSocket->didReceiveMessage(WTFMove(wtf_str)); } extern "C" void WebSocket__didReceiveBytes(WebCore::WebSocket* webSocket, uint8_t* bytes, size_t len) { webSocket->didReceiveBinaryData({ bytes, len }); }