Add option to run server over HTTPS (#631)

Co-authored-by: Chris Swithinbank <[email protected]>

Author: c-w

docs/documentation/api/Server.md

@@ -62,6 +62,24 @@ server.run(8000);
 server.run(8000, () => console.log("server running..."));
 ```
 
+##### With HTTPS
+
+```js
+const { Server } = require('boardgame.io/server');
+const fs = require('fs');
+
+const server = Server({
+  games: [game1, game2, ...],
+
+  https: {
+    cert: fs.readFileSync('/path/to/cert'),
+    key: fs.readFileSync('/path/to/key'),
+  },
+});
+
+server.run(8000);
+```
+
 ##### With custom authentication
 
 `generateCredentials` is called when a player joins a game with:

src/server/index.ts

@@ -26,6 +26,11 @@ interface ServerConfig {
   };
 }
 
+interface HttpsOptions {
+  cert: string;
+  key: string;
+}
+
 /**
  * Build config object from server run arguments.
  */
@@ -59,6 +64,7 @@ interface ServerOpts {
   transport?;
   authenticateCredentials?: ServerTypes.AuthenticateCredentials;
   generateCredentials?: ServerTypes.GenerateCredentials;
+  https?: HttpsOptions;
 }
 
 /**
@@ -69,13 +75,15 @@ interface ServerOpts {
  * @param transport - The interface with the clients.
  * @param authenticateCredentials - Function to test player credentials.
  * @param generateCredentials - Method for API to generate player credentials.
+ * @param https - HTTPS configuration options passed through to the TLS module.
  */
 export function Server({
   games,
   db,
   transport,
   authenticateCredentials,
   generateCredentials,
+  https,
 }: ServerOpts) {
   const app = new Koa();
 
@@ -91,7 +99,10 @@ export function Server({
       typeof authenticateCredentials === 'function'
         ? authenticateCredentials
         : true;
-    transport = SocketIO({ auth });
+    transport = SocketIO({
+      auth,
+      https,
+    });
   }
   transport.init(app, games);
 

src/server/transport/socketio.js

@@ -62,6 +62,7 @@ export function SocketIO({
   clientInfo = new Map(),
   roomInfo = new Map(),
   auth = true,
+  https,
 } = {}) {
   return {
     init: (app, games) => {
@@ -73,7 +74,7 @@ export function SocketIO({
       });
 
       app.context.io = io;
-      io.attach(app);
+      io.attach(app, !!https, https);
 
       for (const game of games) {
         const nsp = app._io.of(game.name);