Updated admin and mod flag system

This should make it easier to set time zones and enable database logging.

Related to krgamestudios/MERN-template#16

.envdev

@@ -6,15 +6,26 @@ DB_HOSTNAME=database
 DB_DATABASE=auth
 DB_USERNAME=auth
 DB_PASSWORD=venusaur
-DB_TIMEZONE=Australia/Sydney
 
 MAIL_SMTP=smtp.example.com
 MAIL_USERNAME=foobar@example.com
 MAIL_PASSWORD=examplepassword
 MAIL_PHYSICAL=42 Placeholder Ave, Placeholder, 0000, USA
 
+# Give this a value to generate the default admin account
 ADMIN_DEFAULT_USERNAME=admin
+
+# Give this a value to generate the default admin account (must be at least 8 characters)
 ADMIN_DEFAULT_PASSWORD=password
 
+# Select a "TZ database name" that suits your needs: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+DB_TIMEZONE=Australia/Sydney
+
+# Give this any value to enable database logging (such as "true")
+DB_LOGGING=
+
+# Make sure this value matches the system that you connect to
 SECRET_ACCESS=access
-SECRET_REFRESH=refresh
+
+# Make sure this value is kept secret
+SECRET_REFRESH=refresh

Dockerfile

@@ -1,3 +1,4 @@
+
 FROM node:15
 WORKDIR "/app"
 COPY package*.json ./

README.md

@@ -4,9 +4,7 @@ An API centric auth server. Uses Sequelize and mariaDB by default.
 
 # Setup
 
-TODO: Dockerize this project
-
-TODO: Write setup instructions, once dockerized
+There are multiple ways to run this app - it can run on it's own via `npm start` (for production) or `npm run dev` (for development). it can also run inside docker using `docker-compose up --build` - run `node configure-script.js` to generate docker-compose.yml.
 
 # API
 
@@ -39,9 +37,13 @@ Content-Type: application/json
 	"refreshToken": "fghij"
 }
 
-//DOCS: Retreives the private account data, results vary
-GET /auth/account
-Authorization: Bearer accessToken
+//Replace an expired authToken pair with these values
+POST /auth/token
+Content-Type: application/json
+
+{
+	"token": "refreshToken"
+}
 
 //DOCS: After this is called, the refresh route will no longer work
 DELETE /auth/logout
@@ -51,13 +53,9 @@ Authorization: Bearer accessToken
 	"token": "refreshToken"
 }
 
-//Replace an expired authToken pair with these values
-POST /auth/token
-Content-Type: application/json
-
-{
-	"token": "refreshToken"
-}
+//DOCS: Retreives the private account data, results vary
+GET /auth/account
+Authorization: Bearer accessToken
 
 //Result
 {
@@ -66,17 +64,16 @@ Content-Type: application/json
 }
 
 //DOCS: Update account data, input varies, but is always JSON
-PATCH /auth/update
+PATCH /auth/account
 Content-Type: application/json
 Authorization: Bearer accessToken
 
 //DOCS: Sets the timer, account will be deleted after 2 days
-DELETE /auth/deletion
+DELETE /auth/account
 Authorization: Bearer accessToken
 Content-Type: application/json
 
 {
 	"password": "helloworld"
 }
-
 ```

configure-script.js

@@ -54,7 +54,7 @@ const question = (prompt, def = null) => {
 version: '3'
 
 services:
-  app:
+  ${appName}:
     build:
       context: .
     ports:
@@ -98,7 +98,9 @@ services:
       - app-network
     volumes:
       - ./mysql:/var/lib/mysql
-  traefik:
+      - ./startup.sql:/docker-entrypoint-initdb.d/startup.sql:ro
+  traefik_${appName}:
+    container_name: ${appName}_traefik
     image: "traefik:v2.4"
     container_name: "traefik"
     command:
@@ -116,7 +118,6 @@ services:
     volumes:
       - "./letsencrypt:/letsencrypt"
       - "/var/run/docker.sock:/var/run/docker.sock:ro"
-      - "./startup.sql:/docker-entrypoint-initdb.d/startup.sql:ro"
     networks:
       - app-network
 networks:
@@ -133,13 +134,13 @@ COPY . /app
 EXPOSE ${appPort}
 USER node
 ENTRYPOINT ["bash", "-c"]
-CMD ["sleep 10 && npm start"]	
+CMD ["sleep 10 && npm start"]
 `;
 
 	const sqlfile = `
 CREATE DATABASE IF NOT EXISTS ${appName};
 CREATE USER IF NOT EXISTS '${appDBUser}'@'%' IDENTIFIED BY '${appDBPass}';
-GRANT ALL PRIVILEGES ON ${appName}.* TO '${appDBUser}'@'%';	
+GRANT ALL PRIVILEGES ON ${appName}.* TO '${appDBUser}'@'%';
 `;
 
 	fs.writeFileSync('docker-compose.yml', ymlfile);

package-lock.json

@@ -50,9 +50,9 @@
       "integrity": "sha512-wE2v81i4C4Ol09RtsWFAqg3BUitWbHSpSlIo+bNdsCJijO9sjme+zm+73ZMCa/qMC8UEERxzGbvmr1cffo2SiQ=="
     },
     "node_modules/@types/node": {
-      "version": "14.14.31",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.31.tgz",
-      "integrity": "sha512-vFHy/ezP5qI0rFgJ7aQnjDXwAMrG0KqqIH7tQG5PPv3BWBayOPIQNBjVc/P6hhdZfMx51REc6tfDNXHUio893g=="
+      "version": "14.14.35",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.35.tgz",
+      "integrity": "sha512-Lt+wj8NVPx0zUmUwumiVXapmaLUcAk3yPuHCFVXras9k5VT9TdhJqKqGVUQCD60OTMCl0qxJ57OiTL0Mic3Iag=="
     },
     "node_modules/abbrev": {
       "version": "1.1.1",
@@ -760,9 +760,9 @@
       }
     },
     "node_modules/glob-parent": {
-      "version": "5.1.1",
-      "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.1.tgz",
-      "integrity": "sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ==",
+      "version": "5.1.2",
+      "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz",
+      "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==",
       "dev": true,
       "dependencies": {
         "is-glob": "^4.0.1"
@@ -1013,9 +1013,9 @@
       }
     },
     "node_modules/is-path-inside": {
-      "version": "3.0.2",
-      "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.2.tgz",
-      "integrity": "sha512-/2UGPSgmtqwo1ktx8NDHjuPwZWmHhO+gj0f93EkhLB5RgW9RZevWYYlIkS6zePc6U2WpOdQYIwHe9YC4DWEBVg==",
+      "version": "3.0.3",
+      "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz",
+      "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==",
       "dev": true,
       "engines": {
         "node": ">=8"
@@ -1407,9 +1407,6 @@
       },
       "bin": {
         "nopt": "bin/nopt.js"
-      },
-      "engines": {
-        "node": "*"
       }
     },
     "node_modules/normalize-path": {
@@ -1752,9 +1749,9 @@
       "integrity": "sha512-tgp+dl5cGk28utYktBsrFqA7HKgrhgPsg6Z/EfhWI4gl1Hwq8B/GmY/0oXZ6nF8hDVesS/FpnYaD/kOWhYQvyg=="
     },
     "node_modules/sequelize": {
-      "version": "6.5.0",
-      "resolved": "https://registry.npmjs.org/sequelize/-/sequelize-6.5.0.tgz",
-      "integrity": "sha512-owBt8fnzVy8E1OvyCyfCdVk7OOLyPVrBCMEf+CvRReC5oCyo+UqeXCtwaex9L6LM9ifZ1i3TG3sFeM5MgLK0CQ==",
+      "version": "6.6.2",
+      "resolved": "https://registry.npmjs.org/sequelize/-/sequelize-6.6.2.tgz",
+      "integrity": "sha512-H/zrzmTK+tis9PJaSigkuXI57nKBvNCtPQol0yxCvau1iWLzSOuq8t3tMOVeQ+Ep8QH2HoD9/+FCCIAqzUr/BQ==",
       "dependencies": {
         "debug": "^4.1.1",
         "dottie": "^2.0.0",
@@ -1824,9 +1821,9 @@
       "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
     },
     "node_modules/sequelize/node_modules/semver": {
-      "version": "7.3.4",
-      "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.4.tgz",
-      "integrity": "sha512-tCfb2WLjqFAtXn4KEdxIhalnRtoKFN7nAwj0B3ZXCbQloV2tq5eDbcTmT68JJD3nRJq24/XgxtQKFIpQdtvmVw==",
+      "version": "7.3.5",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz",
+      "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==",
       "dependencies": {
         "lru-cache": "^6.0.0"
       },
@@ -2185,9 +2182,9 @@
       "integrity": "sha512-wE2v81i4C4Ol09RtsWFAqg3BUitWbHSpSlIo+bNdsCJijO9sjme+zm+73ZMCa/qMC8UEERxzGbvmr1cffo2SiQ=="
     },
     "@types/node": {
-      "version": "14.14.31",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.31.tgz",
-      "integrity": "sha512-vFHy/ezP5qI0rFgJ7aQnjDXwAMrG0KqqIH7tQG5PPv3BWBayOPIQNBjVc/P6hhdZfMx51REc6tfDNXHUio893g=="
+      "version": "14.14.35",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-14.14.35.tgz",
+      "integrity": "sha512-Lt+wj8NVPx0zUmUwumiVXapmaLUcAk3yPuHCFVXras9k5VT9TdhJqKqGVUQCD60OTMCl0qxJ57OiTL0Mic3Iag=="
     },
     "abbrev": {
       "version": "1.1.1",
@@ -2747,9 +2744,9 @@
       }
     },
     "glob-parent": {
-      "version": "5.1.1",
-      "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.1.tgz",
-      "integrity": "sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ==",
+      "version": "5.1.2",
+      "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz",
+      "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==",
       "dev": true,
       "requires": {
         "is-glob": "^4.0.1"
@@ -2934,9 +2931,9 @@
       "dev": true
     },
     "is-path-inside": {
-      "version": "3.0.2",
-      "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.2.tgz",
-      "integrity": "sha512-/2UGPSgmtqwo1ktx8NDHjuPwZWmHhO+gj0f93EkhLB5RgW9RZevWYYlIkS6zePc6U2WpOdQYIwHe9YC4DWEBVg==",
+      "version": "3.0.3",
+      "resolved": "https://registry.npmjs.org/is-path-inside/-/is-path-inside-3.0.3.tgz",
+      "integrity": "sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==",
       "dev": true
     },
     "is-typedarray": {
@@ -3524,9 +3521,9 @@
       }
     },
     "sequelize": {
-      "version": "6.5.0",
-      "resolved": "https://registry.npmjs.org/sequelize/-/sequelize-6.5.0.tgz",
-      "integrity": "sha512-owBt8fnzVy8E1OvyCyfCdVk7OOLyPVrBCMEf+CvRReC5oCyo+UqeXCtwaex9L6LM9ifZ1i3TG3sFeM5MgLK0CQ==",
+      "version": "6.6.2",
+      "resolved": "https://registry.npmjs.org/sequelize/-/sequelize-6.6.2.tgz",
+      "integrity": "sha512-H/zrzmTK+tis9PJaSigkuXI57nKBvNCtPQol0yxCvau1iWLzSOuq8t3tMOVeQ+Ep8QH2HoD9/+FCCIAqzUr/BQ==",
       "requires": {
         "debug": "^4.1.1",
         "dottie": "^2.0.0",
@@ -3557,9 +3554,9 @@
           "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
         },
         "semver": {
-          "version": "7.3.4",
-          "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.4.tgz",
-          "integrity": "sha512-tCfb2WLjqFAtXn4KEdxIhalnRtoKFN7nAwj0B3ZXCbQloV2tq5eDbcTmT68JJD3nRJq24/XgxtQKFIpQdtvmVw==",
+          "version": "7.3.5",
+          "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz",
+          "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==",
           "requires": {
             "lru-cache": "^6.0.0"
           }

server/admin/default-account.js

@@ -20,16 +20,18 @@ module.exports = async () => {
 	//check for an existing admin account
 	const adminRecord = await accounts.findOne({
 		where: {
-			privilege: 'administrator'
+			admin: true
 		}
 	});
 
 	if (adminRecord == null) {
 		await accounts.create({
-			privilege: 'administrator',
 			email: `${process.env.ADMIN_DEFAULT_USERNAME}@${process.env.WEB_ADDRESS}`,
 			username: `${process.env.ADMIN_DEFAULT_USERNAME}`,
-			hash: await bcrypt.hash(`${process.env.ADMIN_DEFAULT_PASSWORD}`, await bcrypt.genSalt(11))
+			hash: await bcrypt.hash(`${process.env.ADMIN_DEFAULT_PASSWORD}`, await bcrypt.genSalt(11)),
+			type: 'normal',
+			admin: true,
+			mod: true
 		});
 
 		console.warn(`Created default admin account (email: ${process.env.ADMIN_DEFAULT_USERNAME}@${process.env.WEB_ADDRESS}; password: ${process.env.ADMIN_DEFAULT_PASSWORD})`);

server/admin/grant-admin.js

@@ -0,0 +1,25 @@
+const { accounts } = require('../database/models');
+const Sequelize = require('sequelize');
+const Op = Sequelize.Op;
+
+//admin/admin
+const route = async (req, res) => {
+	const updated = await accounts.update({
+		admin: true,
+		mod: true
+	}, {
+		where: {
+			username: {
+				[Op.eq]: req.body.username
+			}
+		}
+	});
+
+	if (!updated[0]) {
+		return res.status(500).send('Failed to set admin status');
+	}
+
+	res.status(200).end();
+};
+
+module.exports = route;

server/admin/grant-mod.js

@@ -0,0 +1,24 @@
+const { accounts } = require('../database/models');
+const Sequelize = require('sequelize');
+const Op = Sequelize.Op;
+
+//admin/mod
+const route = async (req, res) => {
+	const updated = await accounts.update({
+		mod: true
+	}, {
+		where: {
+			username: {
+				[Op.eq]: req.body.username
+			}
+		}
+	});
+
+	if (!updated[0]) {
+		return res.status(500).send('Failed to set mod status');
+	}
+
+	res.status(200).end();
+};
+
+module.exports = route;

server/admin/index.js

@@ -1,3 +1,25 @@
-module.exports = {
-	defaultAccount: require('./default-account')
-};
+const express = require('express');
+const router = express.Router();
+
+//middleware
+const tokenAuth = require('../utilities/token-auth');
+
+router.use(tokenAuth);
+router.use((req, res, next) => {
+	//check the user's admin status
+	if (!req.user.admin) {
+		return res.status(401).send('Admin only');
+	}
+
+	next();
+});
+
+require('./default-account')(); //generate the default accouunt
+
+//basic route management
+router.post('/admin', require('./grant-admin'));
+router.delete('/admin', require('./remove-admin'));
+router.post('/mod', require('./grant-mod'));
+router.delete('/mod', require('./remove-mod'));
+
+module.exports = router;

server/admin/remove-admin.js

@@ -0,0 +1,24 @@
+const { accounts } = require('../database/models');
+const Sequelize = require('sequelize');
+const Op = Sequelize.Op;
+
+//admin/admin
+const route = async (req, res) => {
+	const updated = await accounts.update({
+		admin: false
+	}, {
+		where: {
+			username: {
+				[Op.eq]: req.body.username
+			}
+		}
+	});
+
+	if (!updated[0]) {
+		return res.status(500).send('Failed to set admin status');
+	}
+
+	res.status(200).end();
+};
+
+module.exports = route;

server/admin/remove-mod.js

@@ -0,0 +1,25 @@
+const { accounts } = require('../database/models');
+const Sequelize = require('sequelize');
+const Op = Sequelize.Op;
+
+//admin/admin
+const route = async (req, res) => {
+	const updated = await accounts.update({
+		admin: false,
+		mod: false
+	}, {
+		where: {
+			username: {
+				[Op.eq]: req.body.username
+			}
+		}
+	});
+
+	if (!updated[0]) {
+		return res.status(500).send('Failed to set mod status');
+	}
+
+	res.status(200).end();
+};
+
+module.exports = route;

server/auth/account-delete.js

@@ -17,7 +17,7 @@ const route = async (req, res) => {
 
 	//compare the user's password
 	const compare = utils.promisify(bcrypt.compare);
-	const match = await compare(req.body.password, account.hash);
+	const match = await compare(req.body.password || '', account.hash);
 
 	if (!match) {
 		return res.status(401).send('incorrect password');

server/auth/account-query.js

@@ -9,12 +9,12 @@ const route = async (req, res) => {
 	});
 
 	if (!account) {
-		res.status(401).send('Unknown account');
+		return res.status(401).send('Unknown account');
 	}
 
 	//respond with the private-facing data
-	res.status(200).json({
-		contact: await account.contact
+	return res.status(200).json({
+		contact: account.contact
 	});
 };
 

server/auth/index.js

@@ -2,7 +2,7 @@ const express = require('express');
 const router = express.Router();
 
 //middleware
-const authToken = require('../utilities/token-auth');
+const tokenAuth = require('../utilities/token-auth');
 
 //signup -> validate -> login all without a token
 router.post('/signup', require('./signup'));
@@ -13,12 +13,12 @@ router.post('/login', require('./login'));
 router.post('/token', require('./token'));
 
 //middleware
-router.use(authToken);
+router.use(tokenAuth);
 
 //basic account management (needs a token)
 router.delete('/logout', require('./logout'));
-router.get('/account', require('./account'));
-router.patch('/update', require('./update'));
-router.delete('/deletion', require('./deletion'));
+router.get('/account', require('./account-query'));
+router.patch('/account', require('./account-update'));
+router.delete('/account', require('./account-delete'));
 
 module.exports = router;

server/auth/login.js

@@ -43,7 +43,7 @@ const route = async (req, res) => {
 	});
 
 	//generate the JWT
-	const tokens = generate(account.id, account.username, account.privilege);
+	const tokens = generate(account.id, account.username, account.type, account.admin, account.mod);
 
 	//finally
 	res.status(200).json(tokens);

server/database/index.js

@@ -4,7 +4,7 @@ const sequelize = new Sequelize(process.env.DB_DATABASE, process.env.DB_USERNAME
 	host: process.env.DB_HOSTNAME,
 	dialect: 'mariadb',
 	timezone: process.env.DB_TIMEZONE,
-	logging: false
+	logging: process.env.DB_LOGGING ? console.log : false
 });
 
 sequelize.sync();

server/database/models/accounts.js

@@ -10,12 +10,6 @@ module.exports = sequelize.define('accounts', {
 		unique: true
 	},
 
-	privilege: {
-		type: Sequelize.ENUM,
-		values: ['administrator', 'moderator', 'alpha', 'beta', 'gamma', 'normal'],
-		defaultValue: 'normal'
-	},
-
 	email: {
 		type: 'varchar(320)',
 		unique: true
@@ -28,6 +22,24 @@ module.exports = sequelize.define('accounts', {
 
 	hash: 'varchar(100)', //for passwords
 
+	type: {
+		type: Sequelize.ENUM,
+		values: ['normal', 'alpha', 'beta', 'gamma'],
+		defaultValue: 'normal'
+	},
+
+	admin: {
+		type: Sequelize.BOOLEAN,
+		allowNull: false,
+		defaultValue: false
+	},
+
+	mod: {
+		type: Sequelize.BOOLEAN,
+		allowNull: false,
+		defaultValue: false
+	},
+
 	contact: {
 		type: Sequelize.BOOLEAN,
 		allowNull: false,

server/server.js

@@ -15,8 +15,8 @@ app.use(cors());
 //database connection
 const database = require('./database');
 
-const admin = require('./admin');
-admin.defaultAccount();
+//access the admin
+app.use('/admin', require('./admin'));
 
 //access the auth
 app.use('/auth', require('./auth'));

server/utilities/token-auth.js

@@ -6,16 +6,16 @@ module.exports = (req, res, next) => {
 	const token = authHeader?.split (' ')[1]; //'Bearer token'
 
 	if (!token) {
-		return res.status(401).end();
+		return res.status(401).send('No token found');
 	}
 
-	jwt.verify(token, process.env.SECRET_ACCESS, (err, user) => {
+	return jwt.verify(token, process.env.SECRET_ACCESS, (err, user) => {
 		if (err) {
-			return res.status(403).end();
+			return res.status(403).send(err);
 		}
 
 		req.user = user;
 
-		next();
+		return next();
 	});
 };

server/utilities/token-generate.js

@@ -2,11 +2,13 @@ const jwt = require('jsonwebtoken');
 const { tokens } = require('../database/models');
 
 //generates a JWT token based on the given arguments
-module.exports = (id, username, privilege) => {
+module.exports = (id, username, type, admin, mod) => {
 	const content = {
 		id,
 		username,
-		privilege
+		type,
+		admin,
+		mod,
 	};
 
 	const accessToken = jwt.sign(content, process.env.SECRET_ACCESS, { expiresIn: '10m' });

server/utilities/token-refresh.js

@@ -24,7 +24,7 @@ module.exports = (token, callback) => {
 			return callback(403);
 		}
 
-		const result = generate(user.id, user.username, user.privilege);
+		const result = generate(user.id, user.username, user.type, user.admin, user.mod);
 
 		destroy(token);