Added a typecheck to password field

.envdev

@@ -2,6 +2,7 @@ WEB_PROTOCOL=http
 WEB_ADDRESS=localhost
 WEB_RESET_ADDRESS=localhost/reset
 WEB_PORT=3200
+WEB_ORIGIN=http://localhost:3001
 
 DB_HOSTNAME=database
 DB_DATABASE=auth
@@ -30,3 +31,6 @@ SECRET_ACCESS=access
 
 # Make sure this value is kept secret
 SECRET_REFRESH=refresh
+
+# Post-signup hook JSON array (MUST include http:// or https://)
+HOOK_POST_VALIDATION_ARRAY=

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+# These are supported funding model platforms
+
+patreon: krgamestudios
+ko_fi: krgamestudios
+custom: ["https://www.paypal.com/donate/?hosted_button_id=73Q82T2ZHV8AA"]

Dockerfile

@@ -1,5 +1,5 @@
 
-FROM node:16
+FROM node:18-bullseye-slim
 WORKDIR "/app"
 COPY package*.json ./
 RUN npm install --production

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2021 Kayne Ruse, KR Game Studios
+Copyright (c) 2021-2023 Kayne Ruse, KR Game Studios
 
 This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.
 

README.md

@@ -28,8 +28,10 @@ Content-Type: application/json
 //DOCS: Used for validating the email address specified above
 GET /auth/validation?username=example&token=12345678
 
-//DOCS: If the environment variable HOOK_POST_VALIDATION is set to a URL, then the server will send a GET message to that URL with the newly created account's index
-GET https://{HOOK_POST_VALIDATION}?accountIndex={index}
+//DOCS: If the environment variable HOOK_POST_VALIDATION_ARRAY is set to a JSON array of valid URLs, then the server will send a GET message to each URL with the newly created account's index
+//DOCS: The GET requests will have a JWT authorization header
+HOOK_POST_VALIDATION_ARRAY=["http://example.com", "http://example2.com"]
+GET {HOOK_POST_VALIDATION_ARRAY[i]}?accountIndex={index}
 
 ###
 
@@ -44,41 +46,35 @@ Content-Type: application/json
 }
 
 //DOCS: Result (access token's value is your authorization key below)
+Set-Cookie: refreshToken
+
 {
-	"accessToken": "abcde",
-	"refreshToken": "fghij"
+	"accessToken": "abcde"
 }
 
 
 ###
 
 
-//DOCS: Replace an expired authToken pair with new values
+//DOCS: Replace an expired accessToken with a new value
 POST /auth/token
-Content-Type: application/json
-
-{
-	"token": "refreshToken"
-}
+Cookie: refreshToken
 
 //DOCS: Result
+Set-Cookie: refreshToken
+
 {
-	"accessToken": "abcde",
-	"refreshToken": "fghij"
+	"accessToken": "abcde"
 }
 
 
 ###
 
 
-//DOCS: After this is called, the refresh route will no longer work
+//DOCS: After this is called, the /auth/token route will no longer work
 DELETE /auth/logout
 Authorization: Bearer accessToken
-
-{
-	"token": "refreshToken"
-}
-
+Cookie: refreshToken
 
 ###
 
@@ -123,7 +119,7 @@ POST /auth/recover
 Content-Type: application/json
 
 {
-	"email": "kayneruse@gmail.com"
+	"email": "example@example.com"
 }
 
 

configure-script.js

@@ -29,8 +29,10 @@ const question = (prompt, def = null) => {
 (async () => {
 	//project configuration
 	const appName = await question('App Name', 'auth');
+	const appWebProtocol = await question('Web Protocol', 'https');
 	const appWebAddress = await question('Web Addr', `${appName}.example.com`);
-	const postValidationHook = await question('Post Validation Hook', '');
+	const appWebOrigin = await question('Web Origin', `${appWebProtocol}://example.com`); //TODO: clean these up properly
+	const postValidationHookArray = await question('Post Validation Hook Array', '');
 	const resetAddress = await question('Reset Addr', `example.com/reset`);
 	const appPort = await question('App Port', '3200');
 
@@ -69,9 +71,10 @@ services:
       - "traefik.http.routers.${appName}router.service=${appName}service@docker"
       - "traefik.http.services.${appName}service.loadbalancer.server.port=${appPort}"
     environment:
-      - WEB_PROTOCOL=https
+      - WEB_PROTOCOL=${appWebProtocol}
+      - WEB_ORIGIN=${appWebOrigin}
       - WEB_ADDRESS=${appWebAddress}
-      - HOOK_POST_VALIDATION=${postValidationHook}
+      - HOOK_POST_VALIDATION_ARRAY=${postValidationHookArray}
       - WEB_RESET_ADDRESS=${resetAddress}
       - WEB_PORT=${appPort}
       - DB_HOSTNAME=database
@@ -130,7 +133,7 @@ networks:
 `;
 
 	const dockerfile = `
-FROM node:16
+FROM node:18-bullseye-slim
 WORKDIR "/app"
 COPY package*.json ./
 RUN npm install --production

package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth-server",
-  "version": "1.4.11",
+  "version": "1.7.4",
   "description": "An API centric auth server. Uses Sequelize and mariaDB by default.",
   "main": "server/server.js",
   "scripts": {
@@ -20,17 +20,18 @@
   "homepage": "https://github.com/krgamestudios/auth-server#readme",
   "dependencies": {
     "bcryptjs": "^2.4.3",
+    "cookie-parser": "^1.4.6",
     "cors": "^2.8.5",
-    "dotenv": "^8.6.0",
-    "express": "^4.17.1",
-    "jsonwebtoken": "^8.5.1",
-    "mariadb": "^2.5.4",
-    "node-cron": "^2.0.3",
-    "node-fetch": "^2.6.6",
-    "nodemailer": "^6.6.3",
-    "sequelize": "^6.6.5"
+    "dotenv": "^16.0.3",
+    "express": "^4.18.2",
+    "jsonwebtoken": "^9.0.0",
+    "mariadb": "^3.1.1",
+    "node-cron": "^3.0.2",
+    "node-fetch": "^2.6.9",
+    "nodemailer": "^6.9.1",
+    "sequelize": "^6.31.1"
   },
   "devDependencies": {
-    "nodemon": "^2.0.12"
+    "nodemon": "^2.0.22"
   }
 }

server/admin/default-account.js

@@ -25,7 +25,7 @@ module.exports = async () => {
 	});
 
 	if (adminRecord == null) {
-		const webAddress = process.env.WEB_ADDRESS == 'localhost' ? 'example.com' : process.env.WEB_ADDRESS; //can't log in as "localhost"
+		const webAddress = process.env.WEB_ADDRESS == 'localhost:3000' ? 'example.com' : process.env.WEB_ADDRESS; //can't log in as "localhost"
 		await accounts.create({
 			email: `${process.env.ADMIN_DEFAULT_USERNAME}@${webAddress}`,
 			username: `${process.env.ADMIN_DEFAULT_USERNAME}`,

server/auth/login.js

@@ -3,7 +3,7 @@ const utils = require('util');
 const bcrypt = require('bcryptjs');
 
 const { accounts } = require('../database/models');
-const tokenGenerate = require('../utilities/token-generate');
+const tokenGenerateRefresh = require('../utilities/token-generate-refresh');
 
 //utilities
 const validateEmail = require('../utilities/validate-email');
@@ -13,7 +13,7 @@ const route = async (req, res) => {
 	//validate the given details
 	const validateErr = await validateDetails(req.body);
 	if (validateErr) {
-		return res.status(401).end(validateErr);
+		return res.status(401).send(validateErr);
 	}
 
 	//get the existing account
@@ -29,6 +29,7 @@ const route = async (req, res) => {
 
 	//compare passwords
 	const compare = utils.promisify(bcrypt.compare);
+
 	const match = await compare(req.body.password, account.hash);
 
 	if (!match) {
@@ -47,11 +48,15 @@ const route = async (req, res) => {
 		return res.status(403).send('this account has been banned');
 	}
 
-	//generate the JWT
-	const token = tokenGenerate(account.index, account.email, account.username, account.type, account.admin, account.mod);
+	//generate the JWTs
+	const { accessToken, refreshToken } = tokenGenerateRefresh(account.index, account.email, account.username, account.type, account.admin, account.mod);
+
+	//set the cookie
+	res.cookie('refreshToken', refreshToken, { path: '/', httpOnly: true, secure: true, sameSite: 'none', maxAge: 60 * 60 * 24 * 30 * 1000 }); //30 days
 
 	//finally
-	res.status(200).json(token);
+	res.status(200).send(accessToken);
+	return null;
 };
 
 const validateDetails = async (body) => {

server/auth/logout.js

@@ -2,7 +2,10 @@ const tokenDestroy = require('../utilities/token-destroy');
 
 //auth/logout
 const route = (req, res) => {
-	tokenDestroy(req.body.token);
+	//stored in the cookie
+	tokenDestroy(req.cookies.refreshToken);
+
+	res.clearCookie('refreshToken');
 
 	return res.status(200).end();
 };

server/auth/signup.js

@@ -83,6 +83,10 @@ const validateDetails = async (body) => {
 		return 'Missing password';
 	}
 
+	if (typeof body.password != "string") {
+		return 'Invalid password';
+	}
+
 	if (body.password.length < 8) {
 		return 'Password too short';
 	}

server/auth/token.js

@@ -4,13 +4,14 @@ const tokenRefresh = require('../utilities/token-refresh');
 
 //auth/token
 module.exports = async (req, res) => {
-	const refreshToken = req.body.token;
-
-	return tokenRefresh(refreshToken, (err, token) => {
+	return tokenRefresh(req.cookies.refreshToken || '', (err, accessToken, refreshToken) => {
 		if (err) {
 			return res.status(err).end();
 		}
 
-		return res.status(200).send(token);
+		//set the cookie
+		res.cookie('refreshToken', refreshToken, { path: '/', httpOnly: true, secure: true, sameSite: 'none', maxAge: 60 * 60 * 24 * 30 * 1000 }); //30 days
+
+		return res.status(200).send({ accessToken });
 	});
 };

server/auth/validation.js

@@ -1,5 +1,6 @@
 const { pendingSignups, accounts } = require('../database/models');
 const fetch = require('node-fetch');
+const jwt = require('jsonwebtoken');
 
 //auth/validation
 const route = async (req, res) => {
@@ -38,14 +39,42 @@ const route = async (req, res) => {
 	res.status(200).send('Validation succeeded!');
 
 	//post-validation hook
-	if (process.env.HOOK_POST_VALIDATION) {
-		const probe = await fetch(`https://${process.env.HOOK_POST_VALIDATION}?accountIndex=${account.index}`);
+	if (process.env.HOOK_POST_VALIDATION_ARRAY) {
+		try {
+			hooks = JSON.parse(process.env.HOOK_POST_VALIDATION_ARRAY);
+
+			if (!Array.isArray(hooks)) {
+				throw 'isArray() check failed';
+			}
+
+			//authenticate the hooks
+			const bearer = jwt.sign({ type: 'hook authentication' }, process.env.SECRET_ACCESS, { expiresIn: '5m', issuer: 'auth' });
+
+			//promise for each given hook
+			const promises = hooks.map(async hook => {
+				if (typeof hook != 'string') {
+					throw 'hook is not a string';
+				}
+
+				const probe = await fetch(`${hook}?accountIndex=${account.index}`, {
+					method: 'GET',
+					headers: {
+						'Authorization': `Bearer ${bearer}`
+					}
+				});
 
 				if (!probe.ok) {
-			console.error('Could not probe the post validation hook');
+					throw `Could not probe the post validation hook: ${hook} with accountIndex = ${account.index}`;
 				}
 
 				//discard the result
+			});
+
+			await Promise.all(promises);
+		}
+		catch(e) {
+			console.error('HOOK_POST_VALIDATION_ARRAY is not a valid array of strings in JSON format: ' + e);
+		}
 	}
 };
 

server/server.js

@@ -6,10 +6,19 @@ const express = require('express');
 const app = express();
 const server = require('http').Server(app);
 const cors = require('cors');
+const cookieParser = require('cookie-parser');
 
 //config
 app.use(express.json());
-app.use(cors());
+
+app.use(cors({
+	credentials: true,
+	origin: [`${process.env.WEB_ORIGIN}`],
+	allowedHeaders: ['Origin', 'X-Requested-With', 'Content-Type', 'Accept', 'Authorization', 'Set-Cookie'],
+	exposedHeaders: ['Origin', 'X-Requested-With', 'Content-Type', 'Accept', 'Authorization', 'Set-Cookie'],
+}));
+
+app.use(cookieParser());
 
 //database connection
 const database = require('./database');

server/utilities/token-auth.js

@@ -3,13 +3,13 @@ const jwt = require('jsonwebtoken');
 //middleware to authenticate the JWT token
 module.exports = (req, res, next) => {
 	const authHeader = req.headers['authorization'];
-	const token = authHeader?.split (' ')[1]; //'Bearer token'
+	const accessToken = authHeader?.split(' ')[1]; //'Bearer token'
 
-	if (!token) {
-		return res.status(401).send('No token found');
+	if (!accessToken) {
+		return res.status(401).send('No access token found');
 	}
 
-	return jwt.verify(token, process.env.SECRET_ACCESS, (err, user) => {
+	return jwt.verify(accessToken, process.env.SECRET_ACCESS, (err, user) => {
 		if (err) {
 			return res.status(403).send(err);
 		}

server/utilities/token-destroy.js

@@ -1,9 +1,9 @@
 const { tokens } = require('../database/models');
 
-module.exports = (token) => {
+module.exports = (refreshToken) => {
 	tokens.destroy({
 		where: {
-			token: token || ''
+			token: refreshToken || ''
 		}
 	});
 }

server/utilities/token-generate-refresh.js

@@ -12,6 +12,7 @@ module.exports = (index, email, username, type, admin, mod) => {
 		mod,
 	};
 
+	//these are strings
 	const accessToken = jwt.sign(content, process.env.SECRET_ACCESS, { expiresIn: '10m', issuer: 'auth' });
 	const refreshToken = jwt.sign(content, process.env.SECRET_REFRESH, { expiresIn: '30d', issuer: 'auth' });
 

server/utilities/token-refresh.js

@@ -1,17 +1,17 @@
 const jwt = require('jsonwebtoken');
 const { tokens } = require('../database/models');
 
-const generate = require('./token-generate');
+const generate = require('./token-generate-refresh');
 const destroy = require('./token-destroy');
 
-module.exports = async (token, callback) => {
-	if (!token) {
+module.exports = async (oldRefreshToken, callback) => {
+	if (!oldRefreshToken) {
 		return callback(401);
 	}
 
 	const tokenRecord = await tokens.findOne({
 		where: {
-			token: token || ''
+			token: oldRefreshToken || ''
 		}
 	});
 
@@ -19,15 +19,15 @@ module.exports = async (token, callback) => {
 		return callback(403);
 	}
 
-	jwt.verify(token, process.env.SECRET_REFRESH, (err, user) => {
+	jwt.verify(oldRefreshToken, process.env.SECRET_REFRESH, (err, user) => {
 		if (err) {
 			return callback(403);
 		}
 
-		const result = generate(user.index, user.email, user.username, user.type, user.admin, user.mod);
+		const { accessToken, refreshToken } = generate(user.index, user.email, user.username, user.type, user.admin, user.mod);
 
-		destroy(token);
+		destroy(oldRefreshToken);
 
-		return callback(null, result);
+		return callback(null, accessToken, refreshToken);
 	});
 };

tools/react/README.md

@@ -47,7 +47,7 @@ export default Component;
 The most useful features provided by TokenProvider are:
 
 * `tokenFetch()`, which wraps the `fetch()` API to ensure that your access token is valid
-* `tokenCallback()`, which passes the authTokens as a parameter to any function passed into it
+* `tokenCallback()`, which passes the accessToken as a parameter to any function passed into it
 * `getPayload()`, which returns the payload of the accessToken (including as "email", "username", "admin", and "mod")
 * `accessToken`, this will be falsy if the user is not logged in
 

tools/react/token-provider.jsx

@@ -8,19 +8,27 @@ export const TokenContext = createContext();
 const TokenProvider = props => {
 	//state to be used
 	const [accessToken, setAccessToken] = useState('');
-	const [refreshToken, setRefreshToken] = useState('');
 
-	//make the access and refresh tokens persist between reloads
+	//force a logout under certain conditions
+	const forceLogout = () => {
+		localStorage.removeItem("accessToken");
+		setAccessToken("");
+	};
+
+	//make the access token persist between reloads
 	useEffect(() => {
 		setAccessToken(localStorage.getItem("accessToken") || '');
-		setRefreshToken(localStorage.getItem("refreshToken") || '');
 	}, []);
 
 	//update the stored copies
 	useEffect(() => {
 		localStorage.setItem("accessToken", accessToken);
-		localStorage.setItem("refreshToken", refreshToken);
-	}, [accessToken, refreshToken]);
+	}, [accessToken]);
+
+	//force a logout if refresh token is too old
+	if (accessToken && (new Date(Date.now() - 60 * 60 * 24 * 30 * 1000).getTime() > decode(accessToken).exp * 1000)) {
+		forceLogout();
+	}
 
 	//wrap the default fetch function
 	const tokenFetch = async (url, options) => {
@@ -36,30 +44,23 @@ const TokenProvider = props => {
 				return fetch(url, {
 					method: 'DELETE',
 					headers: {
-						'Content-Type': 'application/json',
-						'Access-Control-Allow-Origin': '*',
 						'Authorization': `Bearer ${bearer}`
 					},
-					body: JSON.stringify({
-						token: refreshToken
-					})
+					credentials: 'include'
 				});
 			}
 
-			//ping the auth server for a new token
+			//ping the auth server for a new access token
 			const response = await fetch(`${process.env.AUTH_URI}/auth/token`, {
 				method: 'POST',
-				headers: {
-					'Content-Type': 'application/json',
-					'Access-Control-Allow-Origin': '*'
-				},
-				body: JSON.stringify({
-					token: refreshToken
-				})
+				credentials: 'include'
 			});
 
 			//any errors, throw them
 			if (!response.ok) {
+				if (response.status == 403) {
+					forceLogout();
+				}
 				throw `${response.status}: ${await response.text()}`;
 			}
 
@@ -67,7 +68,6 @@ const TokenProvider = props => {
 			const newAuth = await response.json();
 
 			setAccessToken(newAuth.accessToken);
-			setRefreshToken(newAuth.refreshToken);
 			bearer = newAuth.accessToken;
 		}
 
@@ -77,7 +77,8 @@ const TokenProvider = props => {
 			headers: {
 				...(options || { headers: {} }).headers,
 				'Authorization': `Bearer ${bearer}`
-			}
+			},
+			credentials: 'include'
 		});
 	};
 
@@ -90,17 +91,14 @@ const TokenProvider = props => {
 			//ping the auth server for a new token
 			const response = await fetch(`${process.env.AUTH_URI}/auth/token`, {
 				method: 'POST',
-				headers: {
-					'Content-Type': 'application/json',
-					'Access-Control-Allow-Origin': '*'
-				},
-				body: JSON.stringify({
-					token: refreshToken
-				})
+				credentials: 'include'
 			});
 
 			//any errors, throw them
 			if (!response.ok) {
+				if (response.status == 403) {
+					forceLogout();
+				}
 				throw `${response.status}: ${await response.text()}`;
 			}
 
@@ -108,7 +106,6 @@ const TokenProvider = props => {
 			const newAuth = await response.json();
 
 			setAccessToken(newAuth.accessToken);
-			setRefreshToken(newAuth.refreshToken);
 
 			//finally
 			return cb(newAuth.accessToken);
@@ -118,7 +115,7 @@ const TokenProvider = props => {
 	};
 
 	return (
-		<TokenContext.Provider value={{ accessToken, refreshToken, setAccessToken, setRefreshToken, tokenFetch, tokenCallback, getPayload: () => decode(accessToken) }}>
+		<TokenContext.Provider value={{ accessToken, setAccessToken, tokenFetch, tokenCallback, getPayload: () => decode(accessToken) }}>
 			{props.children}
 		</TokenContext.Provider>
 	)