Userland: Add telws, a CLI REPL to connect to WebSockets

Userland/Utilities/CMakeLists.txt

@@ -40,6 +40,7 @@ target_link_libraries(pro LibProtocol)
 target_link_libraries(shot LibGUI)
 target_link_libraries(su LibCrypt)
 target_link_libraries(tar LibArchive LibCompress)
+target_link_libraries(telws LibCrypto LibTLS LibWebSocket LibLine)
 target_link_libraries(test-crypto LibCrypto LibTLS LibLine)
 target_link_libraries(test-compress LibCompress)
 target_link_libraries(test-fuzz LibCore LibGemini LibGfx LibHTTP LibIPC LibJS LibMarkdown LibShell)

Userland/Utilities/telws.cpp

@@ -0,0 +1,168 @@
+/*
+ * 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 <AK/Base64.h>
+#include <AK/Format.h>
+#include <AK/URL.h>
+#include <LibCore/ArgsParser.h>
+#include <LibCore/EventLoop.h>
+#include <LibCore/File.h>
+#include <LibCore/Notifier.h>
+#include <LibLine/Editor.h>
+#include <LibWebSocket/ConnectionInfo.h>
+#include <LibWebSocket/Message.h>
+#include <LibWebSocket/WebSocket.h>
+
+int main(int argc, char** argv)
+{
+ if (pledge("stdio unix inet accept rpath wpath cpath fattr tty sigaction", nullptr) < 0) {
+ perror("pledge");
+ return 1;
+ }
+
+ Core::ArgsParser args_parser;
+
+ String origin;
+ String url_string;
+
+ args_parser.add_positional_argument(url_string, "URL to connect to", "url", Core::ArgsParser::Required::Yes);
+ args_parser.add_option(origin, "URL to use as origin", "origin", 'o', "origin");
+
+ args_parser.parse(argc, argv);
+
+ URL url(url_string);
+
+ if (!url.is_valid()) {
+ warnln("The given URL is not valid");
+ return 1;
+ }
+
+ Core::EventLoop loop;
+ RefPtr<Line::Editor> editor = Line::Editor::construct();
+ bool should_quit = false;
+
+ if (pledge("stdio unix inet accept rpath wpath tty sigaction", nullptr) < 0) {
+ perror("pledge");
+ return 1;
+ }
+
+ if (unveil(nullptr, nullptr) < 0) {
+ perror("unveil");
+ return 1;
+ }
+
+ WebSocket::ConnectionInfo connection_info(url);
+ connection_info.set_origin(origin);
+
+ auto socket = WebSocket::WebSocket::create(connection_info);
+ socket->on_open = [&]() {
+ outln("[WebSocket opened]"sv);
+ };
+ socket->on_error = [&](auto error) {
+ outln("[WebSocket Error : {}]", (unsigned)error);
+ };
+ socket->on_message = [&](auto message) {
+ if (!message.is_text()) {
+ outln("[Received binary data : {} bytes]", message.data().size());
+ return;
+ }
+ outln("[Received utf8 text] {}", String(ReadonlyBytes(message.data())));
+ };
+ socket->on_close = [&](auto code, auto message, bool was_clean) {
+ outln("[Server {} closed connection : '{}' (code {})]",
+ was_clean ? "cleanly" : "dirtily",
+ message,
+ code);
+ should_quit = true;
+ Core::EventLoop::current().quit(0);
+ };
+ socket->start();
+
+ outln("Started server. Commands :");
+ outln("- '<text>' send the text as message");
+ outln("- '.text <data>' send the text as message");
+ outln("- '.base64 <data>' send the binary data from a base64-encoded string as message");
+ outln("- '.exit' Ask to exit the server");
+ outln("- '.forceexit' Exit the server");
+ while (!should_quit) {
+ auto line_or_error = editor->get_line(">");
+ if (line_or_error.is_error()) {
+ continue;
+ }
+ auto line = line_or_error.value();
+ if (line.is_empty())
+ continue;
+
+ if (line.starts_with(".")) {
+ if (line.starts_with(".text ")) {
+ editor->add_to_history(line);
+ if (socket->ready_state() != WebSocket::ReadyState::Open) {
+ outln("Could not send message : socket is not open.");
+ continue;
+ }
+ socket->send(WebSocket::Message(line.substring(6)));
+ continue;
+ }
+ if (line.starts_with(".base64 ")) {
+ editor->add_to_history(line);
+ if (socket->ready_state() != WebSocket::ReadyState::Open) {
+ outln("Could not send message : socket is not open.");
+ continue;
+ }
+ auto base64_data = line.substring(8);
+ auto buffer = decode_base64(base64_data);
+ socket->send(WebSocket::Message(buffer, false));
+ continue;
+ }
+ if (line == ".exit") {
+ editor->add_to_history(line);
+ if (socket->ready_state() != WebSocket::ReadyState::Open) {
+ outln("Socket is not open. Exiting.");
+ should_quit = true;
+ continue;
+ }
+ socket->close();
+ continue;
+ }
+ if (line == ".forceexit") {
+ editor->add_to_history(line);
+ if (socket->ready_state() == WebSocket::ReadyState::Open)
+ socket->close();
+ return 1;
+ }
+ outln("Unknown command : {}", line);
+ continue;
+ }
+ editor->add_to_history(line);
+ if (socket->ready_state() != WebSocket::ReadyState::Open) {
+ outln("Could not send message : socket is not open.");
+ continue;
+ }
+ socket->send(WebSocket::Message(line));
+ }
+
+ return 0;
+}