Compare commits

..

62 Commits

Author SHA1 Message Date
Kayne Ruse 215b5a9341 Bump dependencies 2025-09-10 14:06:28 +10:00
dependabot[bot] 9b2d03bdaf Bump nodemailer from 7.0.5 to 7.0.6
Bumps [nodemailer](https://github.com/nodemailer/nodemailer) from 7.0.5 to 7.0.6.
- [Release notes](https://github.com/nodemailer/nodemailer/releases)
- [Changelog](https://github.com/nodemailer/nodemailer/blob/master/CHANGELOG.md)
- [Commits](https://github.com/nodemailer/nodemailer/compare/v7.0.5...v7.0.6)

---
updated-dependencies:
- dependency-name: nodemailer
  dependency-version: 7.0.6
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-10 13:03:04 +10:00
dependabot[bot] 82aa61a36d Bump dotenv from 17.2.1 to 17.2.2
Bumps [dotenv](https://github.com/motdotla/dotenv) from 17.2.1 to 17.2.2.
- [Changelog](https://github.com/motdotla/dotenv/blob/master/CHANGELOG.md)
- [Commits](https://github.com/motdotla/dotenv/compare/v17.2.1...v17.2.2)

---
updated-dependencies:
- dependency-name: dotenv
  dependency-version: 17.2.2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2025-09-10 12:59:32 +10:00
Kayne Ruse 79f987b8b6 Experimenting with dependabot 2025-09-09 18:56:16 +10:00
Kayne Ruse 174a56ac53 Updated dependencies 2025-07-26 03:57:44 +10:00
Ratstail91 0bc7cb11f0 Fully tested the remote database
Added configurable hostname for default account email
2024-05-03 09:26:12 +10:00
Ratstail91 6859b36ae0 UNTESTED: Updated all dependencies 2024-05-03 07:07:58 +10:00
Ratstail91 0ce2a552d8 UNTESTED: Added database port as a configurable option
Also updated license field in package.json
2024-04-15 21:03:16 +10:00
Ratstail91 eb64f6c2e7 Updated dependencies 2024-04-15 17:11:51 +10:00
Ratstail91 7429c4a1ee HOTFIX: how long was this broken? 2024-01-01 11:57:43 +11:00
Ratstail91 ee705c6d43 HOTFIX: I hate everything right now 2023-12-24 07:06:20 +11:00
Ratstail91 58bc3f6b9d HOTFIX: don't test in prod 2023-12-24 06:43:05 +11:00
Ratstail91 288e584cbd Hotfixes all the way down 2023-12-24 05:38:27 +11:00
Ratstail91 8ab786b934 Hotfix a hotfix 2023-12-24 05:00:49 +11:00
Ratstail91 72a4b0e101 HOTFIX: kick banned accounts 2023-12-24 04:48:28 +11:00
Ratstail91 59c610bdd8 Fixed Date API bug 2023-12-24 02:48:07 +11:00
Ratstail91 1908413bd2 Updated libraries, docker engine version, docker distro version 2023-12-23 23:49:11 +11:00
Kayne Ruse 3c790f51c7 Bump 2023-06-27 04:26:58 +10:00
Kayne Ruse 44e19154ab Fixed a nasty async race condition 2023-06-27 04:25:52 +10:00
Kayne Ruse fd0c40d444 Docker behaviour changed, fixed 2023-06-26 23:19:53 +10:00
Kayne Ruse d3e90f7d5d Updated dependencies, bumped patch version 2023-06-26 23:05:26 +10:00
Kayne Ruse 98887eecce Fixed a logout bug 2023-06-26 22:26:06 +10:00
Kayne Ruse 95e6bd178e Fixed a filename typo 2023-05-27 23:56:22 +10:00
Kayne Ruse ac7c8d04ed Last patch today, I'm happy with this rn 2023-05-15 11:33:32 +10:00
Kayne Ruse fd44712e37 BUGFIX: clashing pending signups fixed 2023-05-15 11:02:51 +10:00
Kayne Ruse b3c7f7cb5e Added ip-banning middleware, under development 2023-05-15 10:38:10 +10:00
Kayne Ruse db03373892 Spam attack throttling added 2023-05-15 09:13:09 +10:00
Kayne Ruse 267ecaa705 Added a typecheck to password field 2023-05-15 08:03:54 +10:00
Kayne Ruse 3a8cfd39ed BUGFIX: force a logout if refresh token is too old 2023-05-05 03:56:24 +10:00
Kayne Ruse b157ef18ff Updated dependencies 2023-05-03 21:31:30 +10:00
Kayne Ruse 500035284f Updated depencencies, bumped version 2023-03-25 01:49:17 +11:00
Kayne Ruse c5360a70d6 Updated dependencies 2023-03-19 02:52:44 +11:00
Kayne Ruse cf4c8a0f99 Updated dependencies 2023-02-21 09:30:12 +11:00
Kayne Ruse 21527d8931 Updated dependencies, License 2023-01-12 08:08:27 +11:00
Kayne Ruse a54e802942 Bumped version number 2023-01-04 12:56:04 +00:00
Kayne Ruse f8abd9110d Switched to a slim docker distro 2023-01-04 23:51:43 +11:00
Kayne Ruse 406345ada1 Updated libraries 2022-12-31 19:02:27 +00:00
Kayne Ruse d79a70d66f Bumped version number 2022-12-01 12:07:10 +00:00
Kayne Ruse cec30620ec BUGFIX: clear out old refresh tokens 2022-12-01 12:06:20 +00:00
Kayne Ruse 763efb75bf Updated dependencies 2022-11-29 05:06:10 +00:00
Kayne Ruse 77260d5d30 Updated dependencies 2022-11-13 02:15:31 +00:00
Kayne Ruse 157bb5dd90 Updated dependencies 2022-08-01 10:39:30 +01:00
Kayne Ruse 20657fda22 Minor tweak 2022-07-26 13:37:10 +01:00
Kayne Ruse 168bc695b6 Tweaked WEB_ORIGIN 2022-07-26 11:49:34 +01:00
Kayne Ruse a197073bb1 Fixed origin issue in production environment 2022-07-26 11:07:32 +01:00
Kayne Ruse 35d1a48f02 Cookies are working 2022-07-26 10:29:57 +01:00
Kayne Ruse 2b2e65d43e Cookies are working 2022-07-26 10:06:46 +01:00
Kayne Ruse 678d55779d Testing cookies 2022-07-25 15:55:58 +01:00
Kayne Ruse 76fdbc0d13 BUG: tracking down a post validation hook bug 2022-07-24 19:01:47 +01:00
Kayne Ruse 39ddd8158a Updated dependencies 2022-07-23 11:48:36 +01:00
Kayne Ruse 50f0996fb7 Updated configure-script.js 2022-06-15 23:38:56 +01:00
Kayne Ruse 89b2b6ed7b Patched a security hole in the validation hooks 2022-06-15 23:33:06 +01:00
Kayne Ruse 8a5957d6b4 Integration test in place 2022-06-11 01:06:48 +01:00
Kayne Ruse 423a4652c1 Chipping away at writing the tests 2022-06-11 00:32:51 +01:00
Kayne Ruse 7f9274eb3f Bumped patch version 2022-06-10 17:25:07 +01:00
Kayne Ruse 4043507e01 Updated dependencies 2022-06-10 17:09:26 +01:00
Kayne Ruse 12fb02484a Fixed usage of fetch API 2022-06-10 17:01:20 +01:00
Kayne Ruse 49179de73b Updated dependencies 2022-05-30 06:49:23 +01:00
Kayne Ruse 89ea67456d Wrote a couple simple tests 2022-03-02 15:35:14 +00:00
Kayne Ruse 46152032bb Added FUNDING.yml 2022-02-13 07:49:06 +11:00
Kayne Ruse 2d92b31272 Dependancy patch 2022-01-27 09:35:06 +11:00
Kayne Ruse f93564931a Updated libraries 2022-01-20 13:45:40 +11:00
33 changed files with 2075 additions and 3923 deletions
+11 -2
View File
@@ -2,8 +2,11 @@ WEB_PROTOCOL=http
WEB_ADDRESS=localhost
WEB_RESET_ADDRESS=localhost/reset
WEB_PORT=3200
WEB_ORIGIN=http://localhost:3001
DB_HOSTNAME=localhost
DB_PORTNAME=3306
DB_HOSTNAME=database
DB_DATABASE=auth
DB_USERNAME=auth
DB_PASSWORD=charizard
@@ -19,6 +22,9 @@ ADMIN_DEFAULT_USERNAME=admin
# Give this a value to generate the default admin account (must be at least 8 characters)
ADMIN_DEFAULT_PASSWORD=password
# Give this a value to generate teh default admin account (must be a valid domain name, to pass the initial email check)
ADMIN_DEFAULT_HOSTNAME=example.com
# Select a "TZ database name" that suits your needs: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
DB_TIMEZONE=Australia/Sydney
@@ -29,4 +35,7 @@ DB_LOGGING=
SECRET_ACCESS=access
# Make sure this value is kept secret
SECRET_REFRESH=refresh
SECRET_REFRESH=refresh
# Post-signup hook JSON array (MUST include http:// or https://)
HOOK_POST_VALIDATION_ARRAY=
+5
View File
@@ -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"]
+10
View File
@@ -0,0 +1,10 @@
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
+2 -2
View File
@@ -1,7 +1,7 @@
FROM node:16
FROM node:22-bookworm-slim
WORKDIR "/app"
COPY package*.json ./
COPY package*.json /app
RUN npm install --production
COPY . /app
EXPOSE 3200
+1 -1
View File
@@ -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.
+17 -21
View File
@@ -6,7 +6,7 @@ This server is available via docker hub at krgamestudios/auth-server.
# Setup
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 and startup.sql.
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 and startup.sql.
# API
@@ -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,46 +46,40 @@ 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
###
//DOCS: Retreives the private account data, results vary
//DOCS: Retrieves the private account data, results vary
GET /auth/account
Authorization: Bearer accessToken
@@ -123,7 +119,7 @@ POST /auth/recover
Content-Type: application/json
{
"email": "kayneruse@gmail.com"
"email": "example@example.com"
}
+63 -29
View File
@@ -29,11 +29,32 @@ 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');
//configure the database address
let dbLocation = '';
while (typeof dbLocation != 'string' || /^[le]/i.test(dbLocation[0]) == false) {
dbLocation = await question('[l]ocal or [e]xternal database?');
}
let appDBHost = '';
let appDBPort = '';
if (/^[l]/i.test(dbLocation[0])) {
appDBHost = 'database';
appDBPort = '3306';
}
else {
appDBHost = await question('DB Host');
appDBPort = await question('DB Port', '3306');
}
//configure the database account
const appDBUser = await question('DB User', appName);
const appDBPass = await question('DB Pass', 'charizard');
const dbRootPass = await question('DB Root Pass');
@@ -44,6 +65,7 @@ const question = (prompt, def = null) => {
const appMailPhysical = await question('Mail Physical');
const appDefaultUser = await question('App Default User', '');
const appDefaultHost = await question('App Default Host', '');
const appDefaultPass = await question('App Default Pass', '');
const appSecretAccess = await question('Access Token Secret', uuid(32));
@@ -53,28 +75,28 @@ const question = (prompt, def = null) => {
//generate the files
const ymlfile = `
version: '3'
services:
${appName}:
build:
context: .
ports:
- "${appPort}"
- ${appPort}
labels:
- "traefik.enable=true"
- "traefik.http.routers.${appName}router.rule=Host(\`${appWebAddress}\`)"
- "traefik.http.routers.${appName}router.entrypoints=websecure"
- "traefik.http.routers.${appName}router.tls.certresolver=myresolver"
- "traefik.http.routers.${appName}router.service=${appName}service@docker"
- "traefik.http.services.${appName}service.loadbalancer.server.port=${appPort}"
- traefik.enable=true
- traefik.http.routers.${appName}router.rule=Host(\`${appWebAddress}\`)
- traefik.http.routers.${appName}router.entrypoints=websecure
- traefik.http.routers.${appName}router.tls.certresolver=myresolver
- 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
- DB_HOSTNAME=${appDBHost}
- DB_PORTNAME=${appDBPort}
- DB_DATABASE=${appName}
- DB_USERNAME=${appDBUser}
- DB_PASSWORD=${appDBPass}
@@ -84,17 +106,23 @@ services:
- MAIL_PASSWORD=${appMailPass}
- MAIL_PHYSICAL=${appMailPhysical}
- ADMIN_DEFAULT_USERNAME=${appDefaultUser}
- ADMIN_DEFAULT_HOSTNAME=${appDefaultHost}
- ADMIN_DEFAULT_PASSWORD=${appDefaultPass}
- SECRET_ACCESS=${appSecretAccess}
- SECRET_REFRESH=${appSecretRefresh}
volumes:
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
networks:
- app-network
- app-network${ appDBHost != 'database' ? '' : `
depends_on:
- database
database:
image: mariadb:latest
environment:
MYSQL_DATABASE: ${appName}
MYSQL_TCP_PORT: ${appDBPort}
MYSQL_USER: ${appDBUser}
MYSQL_PASSWORD: ${appDBPass}
MYSQL_ROOT_PASSWORD: ${dbRootPass}
@@ -103,34 +131,40 @@ services:
volumes:
- ./mysql:/var/lib/mysql
- ./startup.sql:/docker-entrypoint-initdb.d/startup.sql:ro
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro`}
traefik_${appName}:
container_name: ${appName}_traefik
image: "traefik:v2.4"
container_name: "traefik"
image: traefik:latest
container_name: traefik
command:
- "--log.level=ERROR"
- "--api.insecure=false"
- "--providers.docker=true"
- "--providers.docker.exposedbydefault=false"
- "--entrypoints.websecure.address=:443"
- "--certificatesresolvers.myresolver.acme.tlschallenge=true"
- "--certificatesresolvers.myresolver.acme.email=${supportEmail}"
- "--certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json"
- --log.level=ERROR
- --api.insecure=false
- --providers.docker=true
- --providers.docker.exposedbydefault=false
- --entrypoints.websecure.address=:443
- --certificatesresolvers.myresolver.acme.tlschallenge=true
- --certificatesresolvers.myresolver.acme.email=${supportEmail}
- --certificatesresolvers.myresolver.acme.storage=/letsencrypt/acme.json
ports:
- "80:80"
- "443:443"
- 80:80
- 443:443
volumes:
- "./letsencrypt:/letsencrypt"
- "/var/run/docker.sock:/var/run/docker.sock:ro"
- ./letsencrypt:/letsencrypt
- /var/run/docker.sock:/var/run/docker.sock:ro
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
networks:
- app-network
networks:
app-network:
driver: bridge
`;
const dockerfile = `
FROM node:16
FROM node:22-bookworm-slim
WORKDIR "/app"
COPY package*.json ./
RUN npm install --production
+1704 -3771
View File
File diff suppressed because it is too large Load Diff
+13 -12
View File
@@ -1,6 +1,6 @@
{
"name": "auth-server",
"version": "1.4.10",
"version": "1.8.7",
"description": "An API centric auth server. Uses Sequelize and mariaDB by default.",
"main": "server/server.js",
"scripts": {
@@ -13,24 +13,25 @@
"url": "git+https://github.com/krgamestudios/auth-server.git"
},
"author": "Kayne Ruse",
"license": "ISC",
"license": "Zlib",
"bugs": {
"url": "https://github.com/krgamestudios/auth-server/issues"
},
"homepage": "https://github.com/krgamestudios/auth-server#readme",
"dependencies": {
"bcryptjs": "^2.4.3",
"bcryptjs": "^3.0.2",
"cookie-parser": "^1.4.7",
"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": "^17.2.2",
"express": "^5.1.0",
"jsonwebtoken": "^9.0.2",
"mariadb": "^3.4.5",
"node-cron": "^4.2.1",
"node-fetch": "^3.3.2",
"nodemailer": "^7.0.6",
"sequelize": "^6.37.7"
},
"devDependencies": {
"nodemon": "^2.0.12"
"nodemon": "^3.1.10"
}
}
+3 -4
View File
@@ -7,7 +7,7 @@ module.exports = async () => {
await sequelize.sync(); //this whole file is just one big BUGFIX
//validate env variables
if (!process.env.ADMIN_DEFAULT_USERNAME || !process.env.ADMIN_DEFAULT_PASSWORD) {
if (!process.env.ADMIN_DEFAULT_USERNAME || !process.env.ADMIN_DEFAULT_HOSTNAME || !process.env.ADMIN_DEFAULT_PASSWORD) {
//skip this if arguments are missing
return;
}
@@ -25,9 +25,8 @@ 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"
await accounts.create({
email: `${process.env.ADMIN_DEFAULT_USERNAME}@${webAddress}`,
email: `${process.env.ADMIN_DEFAULT_USERNAME}@${process.env.ADMIN_DEFAULT_HOSTNAME}`,
username: `${process.env.ADMIN_DEFAULT_USERNAME}`,
hash: await bcrypt.hash(`${process.env.ADMIN_DEFAULT_PASSWORD}`, await bcrypt.genSalt(11)),
type: 'normal',
@@ -35,6 +34,6 @@ module.exports = async () => {
mod: true
});
console.warn(`Created default admin account (email: ${process.env.ADMIN_DEFAULT_USERNAME}@${webAddress}; password: ${process.env.ADMIN_DEFAULT_PASSWORD})`);
console.warn(`Created default admin account (email: ${process.env.ADMIN_DEFAULT_USERNAME}@${process.env.ADMIN_DEFAULT_HOSTNAME}; password: ${process.env.ADMIN_DEFAULT_PASSWORD})`);
}
};
+11 -6
View File
@@ -5,15 +5,13 @@ const { accounts } = require('../database/models');
//middleware
const tokenAuth = require('../utilities/token-auth');
const tokenDecode = require('../utilities/token-decode');
//signup -> validate -> login all without a token
router.post('/signup', require('./signup'));
router.get('/validation', require('./validation'));
router.post('/login', require('./login'));
//refresh token
router.post('/token', require('./token'));
//password recover and reset
router.post('/recover', require('./password-recover'));
router.get('/reset', require('./password-redirect'));
@@ -22,13 +20,14 @@ router.patch('/reset', require('./password-reset'));
//logouts allowed when banned, and when the token itself is invalid
router.delete('/logout', require('./logout'));
//middleware
router.use(tokenAuth);
//authenticate token
router.use(tokenDecode);
//middleware
router.use(async (req, res, next) => {
const record = await accounts.findOne({
where: {
email: req.user.email || ''
email: req.user?.email || ''
}
});
@@ -43,6 +42,12 @@ router.use(async (req, res, next) => {
next();
});
//refresh token
router.post('/token', require('./token'));
//authenticate token
router.use(tokenAuth);
//basic account management (needs a token)
router.get('/account', require('./account-query'));
router.patch('/account', require('./account-update'));
+10 -5
View File
@@ -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 } = await 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) => {
+4 -1
View File
@@ -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();
};
+45 -1
View File
@@ -19,6 +19,13 @@ const route = async (req, res) => {
return res.status(401).send(validateErr);
}
//script throttle
const throttle = await checkThrottle(req.body.email);
if (throttle) {
console.warn(`Spam Throttled\t${req.body.email} (${req.body.username})`);
return res.status(401).send(throttle);
}
//generate the password hash
const hash = await bcrypt.hash(req.body.password, await bcrypt.genSalt(11));
@@ -83,6 +90,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';
}
@@ -90,8 +101,41 @@ const validateDetails = async (body) => {
return null;
};
const checkThrottle = async (email) => {
//check email delay
const prev = await pendingSignups.findOne({
where: {
email: email,
}
});
const DateOffset = ( offset ) => { //Thanks, SO!
return new Date( +new Date + offset );
}
if (!!prev && prev.updatedAt > DateOffset( -5000 )) {
return "An unknown error occurred";
}
return null;
}
const registerPendingSignup = async (body, hash, token) => {
const record = await pendingSignups.upsert({
//BUGFIX: delete existing pending signups that clash
await pendingSignups.destroy({
where: {
email: body.email
}
});
await pendingSignups.destroy({
where: {
username: body.username
}
});
//record it
const record = await pendingSignups.create({
email: body.email,
username: body.username,
hash: hash,
+5 -6
View File
@@ -1,16 +1,15 @@
const jwt = require('jsonwebtoken');
const tokenRefresh = require('../utilities/token-refresh');
//auth/token
module.exports = async (req, res) => {
const refreshToken = req.body.token;
return tokenRefresh(refreshToken, (err, token) => {
return await 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 });
});
};
+36 -7
View File
@@ -1,5 +1,6 @@
const { pendingSignups, accounts } = require('../database/models');
const fetch = require('node-fetch');
const fetch = (...args) => import('node-fetch').then(({default: fetch}) => fetch(...args));
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 (!probe.ok) {
console.error('Could not probe the post validation hook');
if (!Array.isArray(hooks)) {
throw 'post validation hook 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) {
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);
}
//discard the result
}
};
+1 -2
View File
@@ -2,11 +2,10 @@ const Sequelize = require('sequelize');
const sequelize = new Sequelize(process.env.DB_DATABASE, process.env.DB_USERNAME, process.env.DB_PASSWORD, {
host: process.env.DB_HOSTNAME,
port: process.env.DB_PORTNAME,
dialect: 'mariadb',
timezone: process.env.DB_TIMEZONE,
logging: process.env.DB_LOGGING ? console.log : false
});
sequelize.sync();
module.exports = sequelize;
@@ -0,0 +1,17 @@
const Sequelize = require('sequelize');
const sequelize = require('..');
//DOCS: this isn't set by anything - it's a stub for now
module.exports = sequelize.define('bannedIPAddresses', {
content: {
type: 'varchar(320)',
unique: true
},
expiry: {
type: 'DATETIME',
allowNull: true,
defaultValue: null
},
});
+2 -1
View File
@@ -2,5 +2,6 @@ module.exports = {
tokens: require('./tokens'),
accounts: require('./accounts'),
pendingSignups: require('./pending-signups'),
recovery: require('./recovery')
recovery: require('./recovery'),
bannedIPAddresses: require("./banned-ip-addresses"),
};
+15 -2
View File
@@ -6,14 +6,26 @@ 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');
//ip-based management
app.use(require('./utilities/banned-ip-addresses-middleware'));
//access the admin
app.use('/admin', require('./admin'));
@@ -21,7 +33,7 @@ app.use('/admin', require('./admin'));
app.use('/auth', require('./auth'));
//error on access
app.get('*', (req, res) => {
app.get('/{*any}', (req, res) => {
res.redirect('https://github.com/krgamestudios/auth-server');
});
@@ -29,4 +41,5 @@ app.get('*', (req, res) => {
server.listen(process.env.WEB_PORT || 3200, async (err) => {
await database.sync();
console.log(`listening to localhost:${process.env.WEB_PORT || 3200}`);
console.log(`database located at ${process.env.DB_HOSTNAME || '<default>'}:${process.env.DB_PORTNAME || '<default>'}`);
});
@@ -0,0 +1,33 @@
const { Op } = require("sequelize");
const { bannedIPAddresses } = require('../database/models');
//middleware to manage banned IP addresses
module.exports = async (req, res, next) => {
const address = req.header('x-forwarded-for') || req.socket.remoteAddress;
const record = await bannedIPAddresses.findOne({
where: {
content: address,
expiry: {
[Op.or]: {
//future or forever
[Op.gt]: Date.now(),
[Op.eq]: null,
}
}
}
});
//log the access timestamp
const date = new Date();
if (!!record) {
console.log(`IP blocked\t${address}\t\t\t${date.toTimeString()}`);
return res.status(403).send("IP address banned");
}
// console.log(`IP allowed\t${address}\t\t\t${date.toTimeString()}`);
return next();
};
+4 -4
View File
@@ -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 provided');
}
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);
}
+17
View File
@@ -0,0 +1,17 @@
const jwt = require('jsonwebtoken');
//middleware to decode the JWT token
module.exports = (req, res, next) => {
const authHeader = req.headers['authorization'];
const accessToken = authHeader?.split(' ')[1]; //'Bearer token'
if (!accessToken) {
return res.status(401).send('No access token provided');
}
const decoded = jwt.decode(accessToken);
req.user = decoded;
return next();
};
+3 -3
View File
@@ -1,9 +1,9 @@
const { tokens } = require('../database/models');
module.exports = (token) => {
tokens.destroy({
module.exports = async (refreshToken) => {
await tokens.destroy({
where: {
token: token || ''
token: refreshToken || ''
}
});
}
@@ -2,7 +2,7 @@ const jwt = require('jsonwebtoken');
const { tokens } = require('../database/models');
//generates a JWT token based on the given arguments
module.exports = (index, email, username, type, admin, mod) => {
module.exports = async (index, email, username, type, admin, mod) => {
const content = {
index,
email,
@@ -12,10 +12,11 @@ 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' });
tokens.create({ token: refreshToken, email: email });
await tokens.create({ token: refreshToken, email: email });
return { accessToken, refreshToken };
};
+8 -8
View File
@@ -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, async (err, user) => {
if (err) {
return callback(403);
}
const result = generate(user.index, user.email, user.username, user.type, user.admin, user.mod);
await destroy(oldRefreshToken);
destroy(token);
const { accessToken, refreshToken } = await generate(user.index, user.email, user.username, user.type, user.admin, user.mod);
return callback(null, result);
return await callback(null, accessToken, refreshToken);
});
};
+2 -2
View File
@@ -1,4 +1,4 @@
#use this while debugging
CREATE DATABASE IF NOT EXISTS auth;
CREATE USER IF NOT EXISTS 'auth'@'%' IDENTIFIED BY 'charizard';
CREATE DATABASE auth;
CREATE USER 'auth'@'%' IDENTIFIED BY 'charizard';
GRANT ALL PRIVILEGES ON auth.* TO 'auth'@'%';
-1
View File
@@ -1 +0,0 @@
ALTER TABLE `accounts` CHANGE `id` `index` INT( 11 ) NOT NULL AUTO_INCREMENT;
-1
View File
@@ -1 +0,0 @@
DROP TABLE tokens;
+1 -1
View File
@@ -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
+29 -28
View File
@@ -1,5 +1,5 @@
import React, { useState, useEffect, createContext } from 'react';
import decode from 'jwt-decode';
import { jwtDecode } from 'jwt-decode';
export const TokenContext = createContext();
@@ -8,19 +8,22 @@ 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]);
//wrap the default fetch function
const tokenFetch = async (url, options) => {
@@ -28,7 +31,7 @@ const TokenProvider = props => {
let bearer = accessToken;
//if expired (10 minutes, normally)
const expired = new Date(decode(accessToken).exp * 1000) < Date.now();
const expired = new Date(jwtDecode(accessToken).exp) < Date.now() / 1000;
if (expired) {
//BUGFIX: if logging out, just skip over the refresh token
@@ -36,30 +39,26 @@ 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': '*'
'Authorization': `Bearer ${bearer}`
},
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 +66,6 @@ const TokenProvider = props => {
const newAuth = await response.json();
setAccessToken(newAuth.accessToken);
setRefreshToken(newAuth.refreshToken);
bearer = newAuth.accessToken;
}
@@ -77,30 +75,34 @@ const TokenProvider = props => {
headers: {
...(options || { headers: {} }).headers,
'Authorization': `Bearer ${bearer}`
}
},
credentials: 'include'
});
};
//access the refreshed token via callback
const tokenCallback = async (cb) => {
//use this?
let bearer = accessToken;
//if expired (10 minutes, normally)
const expired = new Date(decode(accessToken).exp * 1000) < Date.now();
const expired = new Date(jwtDecode(accessToken).exp) < Date.now() / 1000;
if (expired) {
//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': '*'
'Authorization': `Bearer ${bearer}`
},
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 +110,6 @@ const TokenProvider = props => {
const newAuth = await response.json();
setAccessToken(newAuth.accessToken);
setRefreshToken(newAuth.refreshToken);
//finally
return cb(newAuth.accessToken);
@@ -118,7 +119,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: () => jwtDecode(accessToken) }}>
{props.children}
</TokenContext.Provider>
)