1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-27 21:17:45 +00:00

Services: Add a WebSocket service

The WebSocket service isolates communication with a WebSocket to its
own isolated process. Similar to other isolating services, it has its
own user and group.
This commit is contained in:
DexesTTP 2021-04-24 01:46:49 +02:00 committed by Linus Groh
parent c11ca9df33
commit 62ed26164b
16 changed files with 582 additions and 1 deletions

View file

@ -1,11 +1,15 @@
set(SOURCES
Client.cpp
Download.cpp
WebSocket.cpp
WebSocketClient.cpp
)
set(GENERATED_SOURCES
../../Services/ProtocolServer/ProtocolClientEndpoint.h
../../Services/ProtocolServer/ProtocolServerEndpoint.h
../../Services/WebSocket/WebSocketClientEndpoint.h
../../Services/WebSocket/WebSocketServerEndpoint.h
)
serenity_lib(LibProtocol protocol)

View file

@ -0,0 +1,70 @@
/*
* Copyright (c) 2021, Dex <dexes.ttp@gmail.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <LibProtocol/WebSocket.h>
#include <LibProtocol/WebSocketClient.h>
namespace Protocol {
WebSocket::WebSocket(WebSocketClient& client, i32 connection_id)
: m_client(client)
, m_connection_id(connection_id)
{
}
WebSocket::ReadyState WebSocket::ready_state()
{
return (WebSocket::ReadyState)m_client->ready_state({}, *this);
}
void WebSocket::send(ByteBuffer binary_or_text_message, bool is_text)
{
m_client->send({}, *this, move(binary_or_text_message), is_text);
}
void WebSocket::send(StringView text_message)
{
send(ByteBuffer::copy(text_message.bytes()), true);
}
void WebSocket::close(u16 code, String reason)
{
m_client->close({}, *this, code, move(reason));
}
void WebSocket::did_open(Badge<WebSocketClient>)
{
if (on_open)
on_open();
}
void WebSocket::did_receive(Badge<WebSocketClient>, ByteBuffer data, bool is_text)
{
if (on_message)
on_message(WebSocket::Message { move(data), is_text });
}
void WebSocket::did_error(Badge<WebSocketClient>, i32 error_code)
{
if (on_error)
on_error((WebSocket::Error)error_code);
}
void WebSocket::did_close(Badge<WebSocketClient>, u16 code, String reason, bool was_clean)
{
if (on_close)
on_close(code, move(reason), was_clean);
}
void WebSocket::did_request_certificates(Badge<WebSocketClient>)
{
if (on_certificate_requested) {
auto result = on_certificate_requested();
if (!m_client->set_certificate({}, *this, result.certificate, result.key))
dbgln("WebSocket: set_certificate failed");
}
}
}

View file

@ -0,0 +1,78 @@
/*
* Copyright (c) 2021, Dex <dexes.ttp@gmail.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Badge.h>
#include <AK/ByteBuffer.h>
#include <AK/Function.h>
#include <AK/RefCounted.h>
#include <AK/String.h>
#include <AK/WeakPtr.h>
#include <LibCore/Notifier.h>
#include <LibIPC/Forward.h>
namespace Protocol {
class WebSocketClient;
class WebSocket : public RefCounted<WebSocket> {
public:
struct CertificateAndKey {
String certificate;
String key;
};
struct Message {
ByteBuffer data;
bool is_text { false };
};
enum class Error {
CouldNotEstablishConnection,
ConnectionUpgradeFailed,
ServerClosedSocket,
};
enum class ReadyState {
Connecting = 0,
Open = 1,
Closing = 2,
Closed = 3,
};
static NonnullRefPtr<WebSocket> create_from_id(Badge<WebSocketClient>, WebSocketClient& client, i32 connection_id)
{
return adopt_ref(*new WebSocket(client, connection_id));
}
int id() const { return m_connection_id; }
ReadyState ready_state();
void send(ByteBuffer binary_or_text_message, bool is_text);
void send(StringView text_message);
void close(u16 code = 1005, String reason = {});
Function<void()> on_open;
Function<void(Message)> on_message;
Function<void(Error)> on_error;
Function<void(u16 code, String reason, bool was_clean)> on_close;
Function<CertificateAndKey()> on_certificate_requested;
void did_open(Badge<WebSocketClient>);
void did_receive(Badge<WebSocketClient>, ByteBuffer, bool);
void did_error(Badge<WebSocketClient>, i32);
void did_close(Badge<WebSocketClient>, u16, String, bool);
void did_request_certificates(Badge<WebSocketClient>);
private:
explicit WebSocket(WebSocketClient&, i32 connection_id);
WeakPtr<WebSocketClient> m_client;
int m_connection_id { -1 };
};
}

View file

@ -0,0 +1,100 @@
/*
* Copyright (c) 2021, Dex <dexes.ttp@gmail.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <LibProtocol/WebSocket.h>
#include <LibProtocol/WebSocketClient.h>
namespace Protocol {
WebSocketClient::WebSocketClient()
: IPC::ServerConnection<WebSocketClientEndpoint, WebSocketServerEndpoint>(*this, "/tmp/portal/websocket")
{
handshake();
}
void WebSocketClient::handshake()
{
send_sync<Messages::WebSocketServer::Greet>();
}
RefPtr<WebSocket> WebSocketClient::connect(const URL& url, const String& origin, const Vector<String>& protocols, const Vector<String>& extensions, const HashMap<String, String>& request_headers)
{
IPC::Dictionary header_dictionary;
for (auto& it : request_headers)
header_dictionary.add(it.key, it.value);
auto response = send_sync<Messages::WebSocketServer::Connect>(url, origin, protocols, extensions, header_dictionary);
auto connection_id = response->connection_id();
if (connection_id < 0)
return nullptr;
auto connection = WebSocket::create_from_id({}, *this, connection_id);
m_connections.set(connection_id, connection);
return connection;
}
u32 WebSocketClient::ready_state(Badge<WebSocket>, WebSocket& connection)
{
if (!m_connections.contains(connection.id()))
return (u32)WebSocket::ReadyState::Closed;
return send_sync<Messages::WebSocketServer::ReadyState>(connection.id())->ready_state();
}
void WebSocketClient::send(Badge<WebSocket>, WebSocket& connection, ByteBuffer data, bool is_text)
{
if (!m_connections.contains(connection.id()))
return;
post_message(Messages::WebSocketServer::Send(connection.id(), is_text, move(data)));
}
void WebSocketClient::close(Badge<WebSocket>, WebSocket& connection, u16 code, String message)
{
if (!m_connections.contains(connection.id()))
return;
post_message(Messages::WebSocketServer::Close(connection.id(), code, move(message)));
}
bool WebSocketClient::set_certificate(Badge<WebSocket>, WebSocket& connection, String certificate, String key)
{
if (!m_connections.contains(connection.id()))
return false;
return send_sync<Messages::WebSocketServer::SetCertificate>(connection.id(), move(certificate), move(key))->success();
}
void WebSocketClient::handle(const Messages::WebSocketClient::Connected& message)
{
auto maybe_connection = m_connections.get(message.connection_id());
if (maybe_connection.has_value())
maybe_connection.value()->did_open({});
}
void WebSocketClient::handle(const Messages::WebSocketClient::Received& message)
{
auto maybe_connection = m_connections.get(message.connection_id());
if (maybe_connection.has_value())
maybe_connection.value()->did_receive({}, message.data(), message.is_text());
}
void WebSocketClient::handle(const Messages::WebSocketClient::Errored& message)
{
auto maybe_connection = m_connections.get(message.connection_id());
if (maybe_connection.has_value())
maybe_connection.value()->did_error({}, message.message());
}
void WebSocketClient::handle(const Messages::WebSocketClient::Closed& message)
{
auto maybe_connection = m_connections.get(message.connection_id());
if (maybe_connection.has_value())
maybe_connection.value()->did_close({}, message.code(), message.reason(), message.clean());
}
void WebSocketClient::handle(const Messages::WebSocketClient::CertificateRequested& message)
{
auto maybe_connection = m_connections.get(message.connection_id());
if (maybe_connection.has_value())
maybe_connection.value()->did_request_certificates({});
}
}

View file

@ -0,0 +1,45 @@
/*
* Copyright (c) 2021, Dex <dexes.ttp@gmail.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/HashMap.h>
#include <LibIPC/ServerConnection.h>
#include <WebSocket/WebSocketClientEndpoint.h>
#include <WebSocket/WebSocketServerEndpoint.h>
namespace Protocol {
class WebSocket;
class WebSocketClient
: public IPC::ServerConnection<WebSocketClientEndpoint, WebSocketServerEndpoint>
, public WebSocketClientEndpoint {
C_OBJECT(WebSocketClient);
public:
virtual void handshake() override;
RefPtr<WebSocket> connect(const URL&, const String& origin = {}, const Vector<String>& protocols = {}, const Vector<String>& extensions = {}, const HashMap<String, String>& request_headers = {});
u32 ready_state(Badge<WebSocket>, WebSocket&);
void send(Badge<WebSocket>, WebSocket&, ByteBuffer, bool is_text);
void close(Badge<WebSocket>, WebSocket&, u16 code, String reason);
bool set_certificate(Badge<WebSocket>, WebSocket&, String, String);
private:
WebSocketClient();
virtual void handle(const Messages::WebSocketClient::Connected&) override;
virtual void handle(const Messages::WebSocketClient::Received&) override;
virtual void handle(const Messages::WebSocketClient::Errored&) override;
virtual void handle(const Messages::WebSocketClient::Closed&) override;
virtual void handle(const Messages::WebSocketClient::CertificateRequested&) override;
HashMap<i32, NonnullRefPtr<WebSocket>> m_connections;
};
}