LibWebSocket: Add a new websocket library

This library currently contains a basic WebSocket client that can
handle both standard TCP websockets and TLS websockets.

Userland/Libraries/LibWebSocket/Impl/AbstractWebSocketImpl.cpp

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2021, The SerenityOS developers.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. 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.
+ *
+ * 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 HOLDER 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 <LibWebSocket/Impl/AbstractWebSocketImpl.h>
+
+namespace WebSocket {
+
+AbstractWebSocketImpl::AbstractWebSocketImpl(Core::Object* parent)
+    : Object(parent)
+{
+}
+
+AbstractWebSocketImpl::~AbstractWebSocketImpl()
+{
+}
+
+}

Userland/Libraries/LibWebSocket/Impl/AbstractWebSocketImpl.h

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2021, The SerenityOS developers.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. 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.
+ *
+ * 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 HOLDER 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.
+ */
+
+#pragma once
+
+#include <AK/ByteBuffer.h>
+#include <AK/Span.h>
+#include <AK/String.h>
+#include <LibCore/Object.h>
+#include <LibWebSocket/ConnectionInfo.h>
+
+namespace WebSocket {
+
+class AbstractWebSocketImpl : public Core::Object {
+    C_OBJECT_ABSTRACT(AbstractWebSocketImpl);
+
+public:
+    virtual ~AbstractWebSocketImpl() override;
+    explicit AbstractWebSocketImpl(Core::Object* parent = nullptr);
+
+    virtual void connect(ConnectionInfo const&) = 0;
+
+    virtual bool can_read_line() = 0;
+    virtual String read_line(size_t size) = 0;
+
+    virtual bool can_read() = 0;
+    virtual ByteBuffer read(int max_size) = 0;
+
+    virtual bool send(ReadonlyBytes) = 0;
+
+    virtual bool eof() = 0;
+
+    virtual void discard_connection() = 0;
+
+    Function<void()> on_connected;
+    Function<void()> on_connection_error;
+    Function<void()> on_ready_to_read;
+};
+
+}

Userland/Libraries/LibWebSocket/Impl/TCPWebSocketConnectionImpl.cpp

@@ -0,0 +1,104 @@
+/*
+ * Copyright (c) 2021, The SerenityOS developers.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. 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.
+ *
+ * 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 HOLDER 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 <LibWebSocket/Impl/TCPWebSocketConnectionImpl.h>
+
+namespace WebSocket {
+
+TCPWebSocketConnectionImpl::TCPWebSocketConnectionImpl(Core::Object* parent)
+    : AbstractWebSocketImpl(parent)
+{
+}
+
+TCPWebSocketConnectionImpl::~TCPWebSocketConnectionImpl()
+{
+    discard_connection();
+}
+
+void TCPWebSocketConnectionImpl::connect(ConnectionInfo const& connection)
+{
+    VERIFY(!m_socket);
+    VERIFY(on_connected);
+    VERIFY(on_connection_error);
+    VERIFY(on_ready_to_read);
+    m_socket = Core::TCPSocket::construct(this);
+
+    m_notifier = Core::Notifier::construct(m_socket->fd(), Core::Notifier::Read);
+    m_notifier->on_ready_to_read = [this] {
+        on_ready_to_read();
+    };
+
+    m_socket->on_connected = [this] {
+        on_connected();
+    };
+    bool success = m_socket->connect(connection.url().host(), connection.url().port());
+    if (!success) {
+        deferred_invoke([this](auto&) {
+            on_connection_error();
+        });
+    }
+}
+
+bool TCPWebSocketConnectionImpl::send(ReadonlyBytes data)
+{
+    return m_socket->write(data);
+}
+
+bool TCPWebSocketConnectionImpl::can_read_line()
+{
+    return m_socket->can_read_line();
+}
+
+String TCPWebSocketConnectionImpl::read_line(size_t size)
+{
+    return m_socket->read_line(size);
+}
+
+bool TCPWebSocketConnectionImpl::can_read()
+{
+    return m_socket->can_read();
+}
+
+ByteBuffer TCPWebSocketConnectionImpl::read(int max_size)
+{
+    return m_socket->read(max_size);
+}
+
+bool TCPWebSocketConnectionImpl::eof()
+{
+    return m_socket->eof();
+}
+
+void TCPWebSocketConnectionImpl::discard_connection()
+{
+    if (!m_socket)
+        return;
+    m_socket->on_ready_to_read = nullptr;
+    remove_child(*m_socket);
+    m_socket = nullptr;
+}
+
+}

Userland/Libraries/LibWebSocket/Impl/TCPWebSocketConnectionImpl.h

@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2021, The SerenityOS developers.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. 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.
+ *
+ * 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 HOLDER 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.
+ */
+
+#pragma once
+
+#include <AK/ByteBuffer.h>
+#include <AK/Span.h>
+#include <AK/String.h>
+#include <LibCore/Notifier.h>
+#include <LibCore/Object.h>
+#include <LibCore/TCPSocket.h>
+#include <LibWebSocket/ConnectionInfo.h>
+#include <LibWebSocket/Impl/AbstractWebSocketImpl.h>
+
+namespace WebSocket {
+
+class TCPWebSocketConnectionImpl final : public AbstractWebSocketImpl {
+    C_OBJECT(TCPWebSocketConnectionImpl);
+
+public:
+    virtual ~TCPWebSocketConnectionImpl() override;
+    explicit TCPWebSocketConnectionImpl(Core::Object* parent = nullptr);
+
+    virtual void connect(ConnectionInfo const& connection) override;
+
+    virtual bool can_read_line() override;
+    virtual String read_line(size_t size) override;
+
+    virtual bool can_read() override;
+    virtual ByteBuffer read(int max_size) override;
+
+    virtual bool send(ReadonlyBytes data) override;
+
+    virtual bool eof() override;
+
+    virtual void discard_connection() override;
+
+private:
+    RefPtr<Core::Notifier> m_notifier;
+    RefPtr<Core::TCPSocket> m_socket;
+};
+
+}

Userland/Libraries/LibWebSocket/Impl/TLSv12WebSocketConnectionImpl.cpp

@@ -0,0 +1,118 @@
+/*
+ * Copyright (c) 2021, The SerenityOS developers.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. 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.
+ *
+ * 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 HOLDER 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 <LibWebSocket/Impl/TLSv12WebSocketConnectionImpl.h>
+
+namespace WebSocket {
+
+TLSv12WebSocketConnectionImpl::TLSv12WebSocketConnectionImpl(Core::Object* parent)
+    : AbstractWebSocketImpl(parent)
+{
+}
+
+TLSv12WebSocketConnectionImpl::~TLSv12WebSocketConnectionImpl()
+{
+    discard_connection();
+}
+
+void TLSv12WebSocketConnectionImpl::connect(ConnectionInfo const& connection)
+{
+    VERIFY(!m_socket);
+    VERIFY(on_connected);
+    VERIFY(on_connection_error);
+    VERIFY(on_ready_to_read);
+    m_socket = TLS::TLSv12::construct(this);
+
+    m_notifier = Core::Notifier::construct(m_socket->fd(), Core::Notifier::Read);
+    m_notifier->on_ready_to_read = [this] {
+        on_ready_to_read();
+    };
+
+    m_socket->set_root_certificates(DefaultRootCACertificates::the().certificates());
+    m_socket->on_tls_error = [this](TLS::AlertDescription) {
+        on_connection_error();
+    };
+    m_socket->on_tls_ready_to_write = [this] {
+        on_connected();
+    };
+    m_socket->on_tls_finished = [this] {
+        on_connection_error();
+    };
+    m_socket->on_tls_certificate_request = [this](auto&) {
+        // FIXME : Once we handle TLS certificate requests, handle it here as well.
+    };
+    bool success = m_socket->connect(connection.url().host(), connection.url().port());
+    if (!success) {
+        deferred_invoke([this](auto&) {
+            on_connection_error();
+        });
+    }
+}
+
+bool TLSv12WebSocketConnectionImpl::send(ReadonlyBytes data)
+{
+    return m_socket->write(data);
+}
+
+bool TLSv12WebSocketConnectionImpl::can_read_line()
+{
+    return m_socket->can_read_line();
+}
+
+String TLSv12WebSocketConnectionImpl::read_line(size_t size)
+{
+    return m_socket->read_line(size);
+}
+
+bool TLSv12WebSocketConnectionImpl::can_read()
+{
+    return m_socket->can_read();
+}
+
+ByteBuffer TLSv12WebSocketConnectionImpl::read(int max_size)
+{
+    return m_socket->read(max_size);
+}
+
+bool TLSv12WebSocketConnectionImpl::eof()
+{
+    return m_socket->eof();
+}
+
+void TLSv12WebSocketConnectionImpl::discard_connection()
+{
+    if (!m_socket)
+        return;
+    m_socket->on_tls_connected = nullptr;
+    m_socket->on_tls_error = nullptr;
+    m_socket->on_tls_finished = nullptr;
+    m_socket->on_tls_certificate_request = nullptr;
+    m_socket->on_ready_to_read = nullptr;
+    remove_child(*m_socket);
+    m_socket = nullptr;
+}
+
+}

Userland/Libraries/LibWebSocket/Impl/TLSv12WebSocketConnectionImpl.h

@@ -0,0 +1,65 @@
+/*
+ * Copyright (c) 2021, The SerenityOS developers.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. 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.
+ *
+ * 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 HOLDER 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.
+ */
+
+#pragma once
+
+#include <AK/ByteBuffer.h>
+#include <AK/Span.h>
+#include <AK/String.h>
+#include <LibCore/Object.h>
+#include <LibTLS/TLSv12.h>
+#include <LibWebSocket/ConnectionInfo.h>
+#include <LibWebSocket/Impl/AbstractWebSocketImpl.h>
+
+namespace WebSocket {
+
+class TLSv12WebSocketConnectionImpl final : public AbstractWebSocketImpl {
+    C_OBJECT(TLSv12WebSocketConnectionImpl);
+
+public:
+    virtual ~TLSv12WebSocketConnectionImpl() override;
+    explicit TLSv12WebSocketConnectionImpl(Core::Object* parent = nullptr);
+
+    void connect(ConnectionInfo const& connection) override;
+
+    virtual bool can_read_line() override;
+    virtual String read_line(size_t size) override;
+
+    virtual bool can_read() override;
+    virtual ByteBuffer read(int max_size) override;
+
+    virtual bool send(ReadonlyBytes data) override;
+
+    virtual bool eof() override;
+
+    virtual void discard_connection() override;
+
+private:
+    RefPtr<Core::Notifier> m_notifier;
+    RefPtr<TLS::TLSv12> m_socket;
+};
+
+}