Bullboard auth (#11)

* Added bull-board auth using passport.js

* Minor changes

* update .gitignore

Co-authored-by: SysSn13 <sudesh18@iitg.ac.in>

Author: VidithM

.env.example

@@ -11,3 +11,7 @@ API_RATE_LIMIT=20
 BACKGROUND=0
 REDIS_URL=redis://127.0.0.1:6379
 THREAD_CNT=4
+
+BULLBOARD_USERNAME=bull-board
+BULLBOARD_PASS=admin
+SESSION_SECRET=keyboard-key

.gitignore

@@ -1,3 +1,3 @@
 .env
 node_modules
-.snyk
+.snyk

README.md

@@ -180,6 +180,14 @@ BACKGROUND: Whether to run the background or not. (0 or 1)
 REDIS_URL: Connection string for redis.
 
 THREAD_CNT: Number of threads for prediction.(default: 4)
+
+# bull-board auth
+BULLBOARD_USERNAME: username for bull-board login
+
+BULLBOARD_PASS: password for bull-board login
+
+SESSION_SECRET: secret to hash the session
+
 ```
 
 ## Browser extension

main.js

@@ -3,7 +3,11 @@ if (process.env.NODE_ENV !== "production") {
 }
 const express = require("express");
 const rateLimit = require("express-rate-limit");
+const unless = require("express-unless");
+
 const expressLayouts = require("express-ejs-layouts");
+expressLayouts.unless = unless;
+
 const bodyParser = require("body-parser");
 
 // database
@@ -32,23 +36,40 @@ app.use(limiter);
 // body limit
 app.use(express.json({ limit: "10kb" }));
 
+app.set("view engine", "ejs");
+app.set("views", __dirname + "/views");
+app.use(bodyParser.urlencoded({ extended: true }));
+app.use(express.static("public"));
+app.use(
+    expressLayouts.unless({
+        path: [/\/bull-board*/],
+    })
+);
+
 // background
 if (process.env.BACKGROUND == true) {
     const { bullBoardServerAdapter } = require("./background");
-    app.use("/bull-board", bullBoardServerAdapter.getRouter());
+    const { ensureLoggedIn } = require("connect-ensure-login");
+    const passport = require("passport");
+    const session = require("express-session");
+    app.use(session({ secret: process.env.SESSION_SECRET }));
+    app.use(passport.initialize({}));
+    app.use(passport.session({}));
+    const authRouter = require("./routes/auth");
+    app.use("/login", authRouter);
+    app.use(
+        "/bull-board",
+        ensureLoggedIn("/login"),
+        bullBoardServerAdapter.getRouter()
+    );
     console.info("BACKGROUND is up.");
 }
 
 // web
 if (process.env.WEB == true) {
-    const webRouter = require("./web");
-    app.set("view engine", "ejs");
-    app.set("views", __dirname + "/views");
     app.set("layout", "layouts/layout");
     app.set("layout extractScripts", true);
-    app.use(expressLayouts);
-    app.use(bodyParser.urlencoded({ extended: true }));
-    app.use(express.static("public"));
+    const webRouter = require("./web");
     app.use("/", webRouter);
     console.info("WEB is up.");
 }
@@ -69,6 +90,13 @@ if (!process.env.API_DISABLED) {
     console.info("API is up.");
 }
 
+// 404 page
+app.use((req, res) => {
+    res.status(404).render("errors/404", {
+        title: "404 Not Found",
+    });
+});
+
 const port = process.env.PORT || 8080;
 
 app.listen(port, (err) => {