Added a TLS client and a node example to complement

Author: holywyvern

.vscode/settings.json

@@ -11,6 +11,60 @@
         "queue": "cpp",
         "xstring": "cpp",
         "iostream": "cpp",
-        "mutex": "cpp"
+        "mutex": "cpp",
+        "algorithm": "cpp",
+        "array": "cpp",
+        "atomic": "cpp",
+        "chrono": "cpp",
+        "cmath": "cpp",
+        "cstddef": "cpp",
+        "cstdint": "cpp",
+        "cstdio": "cpp",
+        "cstdlib": "cpp",
+        "cstring": "cpp",
+        "ctime": "cpp",
+        "cwchar": "cpp",
+        "deque": "cpp",
+        "exception": "cpp",
+        "functional": "cpp",
+        "initializer_list": "cpp",
+        "iomanip": "cpp",
+        "ios": "cpp",
+        "iosfwd": "cpp",
+        "istream": "cpp",
+        "iterator": "cpp",
+        "limits": "cpp",
+        "list": "cpp",
+        "locale": "cpp",
+        "map": "cpp",
+        "new": "cpp",
+        "ostream": "cpp",
+        "ratio": "cpp",
+        "stdexcept": "cpp",
+        "streambuf": "cpp",
+        "string": "cpp",
+        "thread": "cpp",
+        "tuple": "cpp",
+        "type_traits": "cpp",
+        "typeinfo": "cpp",
+        "unordered_map": "cpp",
+        "unordered_set": "cpp",
+        "utility": "cpp",
+        "vector": "cpp",
+        "xfacet": "cpp",
+        "xfunctional": "cpp",
+        "xhash": "cpp",
+        "xiosbase": "cpp",
+        "xlocbuf": "cpp",
+        "xlocinfo": "cpp",
+        "xlocmon": "cpp",
+        "xlocnum": "cpp",
+        "xloctime": "cpp",
+        "xmemory": "cpp",
+        "xmemory0": "cpp",
+        "xstddef": "cpp",
+        "xtr1common": "cpp",
+        "xtree": "cpp",
+        "xutility": "cpp"
     }
 }

CMakeLists.txt

@@ -12,6 +12,7 @@ add_library(ws MODULE
   src/lua_ws_client.cpp 
   src/lua_ws_server.cpp
   src/lua_ws_server_channel.cpp
+  src/lua_wss_client.cpp
   src/lua_ws.cpp
 )
 

README.md

@@ -67,9 +67,24 @@ For example:
 local client = ws.newClient("localhost:8080/game")
 ```
 
+
 Creates a client than will connect to localhost (the local machine) at port 8080 on the "game"
 namespace.
 
+If you need to connect using TLS for security reasons,
+you can also create a secure version of the client socket.
+
+```lua
+local client = ws.newTlsClient("localhost:8080/game", true)
+```
+
+The second argument (false by default) is if you should validate
+the certificate of the server.
+
+On development you may want to use self signed certificates,
+if that's the case, put it to false, However, you should 
+always put it as true in production.
+
 Then you should start the server:
 
 ```lua

examples/wss_client.lua

@@ -0,0 +1,22 @@
+local ws = require("ws")
+
+local client = ws.newTlsClient("localhost:8080/test", false)
+
+client:connect()
+
+local connected = true
+
+while connected do 
+    local ev = client:checkQueue()
+    if ev then 
+        print(ev.type .. ": " .. ev.message)
+        if ev.type == "error" or ev.type == "close" then 
+            connected = false
+        end
+        if ev.type == "open" then 
+            client:sendMessage("hello")
+        end
+    end
+end
+
+print("Connection closed")

examples/wss_server/.gitignore

@@ -0,0 +1,2 @@
+node_modules
+keys

examples/wss_server/index.js

@@ -0,0 +1,25 @@
+const https = require('https');
+const fs = require('fs');
+const path = require("path");
+
+const WebSocket = require('ws');
+
+// Remember to generate your keys and put it inside a keys folder.
+// For this example, they can be self silgned.
+// As an example, you may use this using OpenSSL:
+// openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout private.pem -out public.pem
+const server = https.createServer({
+  cert: fs.readFileSync(path.join(__dirname, 'keys', 'public.pem')),
+  key: fs.readFileSync(path.join(__dirname, 'keys', 'private.pem'))
+});
+
+const wss = new WebSocket.Server({ server });
+
+wss.on('connection', function connection (ws) {
+  console.log("User connected");
+  ws.on('message', function message (msg) {
+    console.log(`Message from user: ${msg}.`);
+  });
+});
+
+server.listen(8080);

examples/wss_server/package-lock.json

@@ -0,0 +1,15 @@
+{
+  "name": "wss_server",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "ws": "^5.1.1"
+  }
+}

examples/wss_server/package.json

@@ -0,0 +1,49 @@
+#ifndef LUA_WSS_CLIENT
+#define LUA_WSS_CLIENT
+
+#include <queue>
+#include <mutex>
+
+#include "lua.hpp"
+#include "client_wss.hpp"
+
+class WssClientMessage {
+public:
+	int type;
+	std::string message;
+	WssClientMessage(int type, std::string message);
+	std::string getTypeName();
+};
+
+class WssClient : public SimpleWeb::SocketClient<SimpleWeb::WSS>
+{
+  public:
+	  WssClient(const std::string &server_port_path, bool certificate) noexcept;
+    bool _serverOpen;
+    std::mutex _queueMutex;
+    std::queue<WssClientMessage> _messageQueue;
+	  std::shared_ptr<std::thread> thread; 
+	  void popMessage(lua_State *L);
+    void pushMessage(int type, std::string message);
+    void sendMessage(std::string message);
+};
+
+class LuaWssClient
+{
+public:
+  static const char className[];
+  static const luaL_reg methods[];
+  // Lua VM functions
+  static WssClient *check(lua_State *L, int narg);
+  static void setup(lua_State *L);
+  static int create(lua_State *L);
+  static int  gc(lua_State *L);
+  // Lua Methods
+  static int connect(lua_State *L);
+  static int close(lua_State *L);
+  static int checkQueue(lua_State *L);
+  static int sendMessage(lua_State *L);
+  static int isOpen(lua_State *L);
+};
+
+#endif

include/lua_wss_client.hpp

@@ -1,5 +1,6 @@
 #include "lua.hpp"
 #include "lua_ws_client.hpp"
+#include "lua_wss_client.hpp"
 #include "lua_ws_server.hpp"
 #include "lua_ws_server_channel.hpp"
 
@@ -13,8 +14,11 @@ extern "C" LUALIB_API LOVE_WS_EXPORT int
 luaopen_ws(lua_State *L)
 {
     lua_newtable(L);
+	// Plain websockets
     LuaWsClient::setup(L);
     LuaWsServer::setup(L);
 	LuaWsServerChannel::setup(L);
+	// Secure websockets
+	LuaWssClient::setup(L);
     return 1;
 }