Compare commits

...

33 Commits

Author SHA1 Message Date
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
Kayne Ruse 2542f3f00f Bumped version number 2022-01-15 02:29:46 +00:00
Kayne Ruse a112e17f59 Patched a potential crash 2022-01-15 02:28:55 +00:00
Kayne Ruse 7af87824e3 Added the TokenProvider as a useful tool 2021-12-23 14:24:13 +00:00
Kayne Ruse 8b91ff8dd3 Cleaned up tools and tests 2021-12-23 13:33:58 +00:00
Kayne Ruse 0aa1e67be9 Updated README.md 2021-12-21 19:37:57 +00:00
Kayne Ruse 353be4662b Bumped version number 2021-12-19 16:07:44 +00:00
Kayne Ruse cc655cd988 Merge remote-tracking branch 'refs/remotes/origin/main' 2021-12-19 16:06:30 +00:00
Kayne Ruse ec3b14e32b Removed excess logging 2021-12-19 16:06:23 +00:00
Kayne Ruse b188c46efd Merge pull request #9 from MatthewEvans91/remove-address-line
omit physical address line from validation email where no physical address provided
2021-12-20 03:04:03 +11:00
Matthew Evans ece3b0253f omit physical address line from validation email where no physical address provided 2021-12-18 18:47:44 -07:00
Kayne Ruse 062bc43f5a BUGFIX: sending account index via post validation hook 2021-12-11 11:54:13 +00:00
Kayne Ruse cc6b7bd7b4 Fixed an import/require problem 2021-12-11 10:11:56 +00:00
27 changed files with 1243 additions and 2306 deletions
+4
View File
@@ -2,6 +2,7 @@ WEB_PROTOCOL=http
WEB_ADDRESS=localhost WEB_ADDRESS=localhost
WEB_RESET_ADDRESS=localhost/reset WEB_RESET_ADDRESS=localhost/reset
WEB_PORT=3200 WEB_PORT=3200
WEB_ORIGIN=http://localhost:3001
DB_HOSTNAME=database DB_HOSTNAME=database
DB_DATABASE=auth DB_DATABASE=auth
@@ -30,3 +31,6 @@ SECRET_ACCESS=access
# Make sure this value is kept secret # 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"]
+1 -2
View File
@@ -1,5 +1,4 @@
FROM node:18
FROM node:16
WORKDIR "/app" WORKDIR "/app"
COPY package*.json ./ COPY package*.json ./
RUN npm install --production RUN npm install --production
+17 -19
View File
@@ -2,6 +2,8 @@
An API centric auth server. Uses Sequelize and mariaDB by default. An API centric auth server. Uses Sequelize and mariaDB by default.
This server is available via docker hub at krgamestudios/auth-server.
# Setup # 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.
@@ -26,8 +28,10 @@ Content-Type: application/json
//DOCS: Used for validating the email address specified above //DOCS: Used for validating the email address specified above
GET /auth/validation?username=example&token=12345678 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 //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
GET https://{HOOK_POST_VALIDATION}?accountIndex={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}
### ###
@@ -42,41 +46,35 @@ Content-Type: application/json
} }
//DOCS: Result (access token's value is your authorization key below) //DOCS: Result (access token's value is your authorization key below)
Set-Cookie: refreshToken
{ {
"accessToken": "abcde", "accessToken": "abcde"
"refreshToken": "fghij"
} }
### ###
//DOCS: Replace an expired authToken pair with new values //DOCS: Replace an expired accessToken with a new value
POST /auth/token POST /auth/token
Content-Type: application/json Cookie: refreshToken
{
"token": "refreshToken"
}
//DOCS: Result //DOCS: Result
Set-Cookie: refreshToken
{ {
"accessToken": "abcde", "accessToken": "abcde"
"refreshToken": "fghij"
} }
### ###
//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 DELETE /auth/logout
Authorization: Bearer accessToken Authorization: Bearer accessToken
Cookie: refreshToken
{
"token": "refreshToken"
}
### ###
@@ -121,7 +119,7 @@ POST /auth/recover
Content-Type: application/json Content-Type: application/json
{ {
"email": "kayneruse@gmail.com" "email": "example@example.com"
} }
+8 -5
View File
@@ -29,13 +29,15 @@ const question = (prompt, def = null) => {
(async () => { (async () => {
//project configuration //project configuration
const appName = await question('App Name', 'auth'); const appName = await question('App Name', 'auth');
const appWebProtocol = await question('Web Protocol', 'https');
const appWebAddress = await question('Web Addr', `${appName}.example.com`); 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 resetAddress = await question('Reset Addr', `example.com/reset`);
const appPort = await question('App Port', '3200'); const appPort = await question('App Port', '3200');
const appDBUser = await question('DB User', appName); const appDBUser = await question('DB User', appName);
const appDBPass = await question('DB Pass', uuid()); const appDBPass = await question('DB Pass', 'charizard');
const dbRootPass = await question('DB Root Pass'); const dbRootPass = await question('DB Root Pass');
const appMailSMTP = await question('Mail SMTP', 'smtp.example.com'); const appMailSMTP = await question('Mail SMTP', 'smtp.example.com');
@@ -69,9 +71,10 @@ services:
- "traefik.http.routers.${appName}router.service=${appName}service@docker" - "traefik.http.routers.${appName}router.service=${appName}service@docker"
- "traefik.http.services.${appName}service.loadbalancer.server.port=${appPort}" - "traefik.http.services.${appName}service.loadbalancer.server.port=${appPort}"
environment: environment:
- WEB_PROTOCOL=https - WEB_PROTOCOL=${appWebProtocol}
- WEB_ORIGIN=${appWebOrigin}
- WEB_ADDRESS=${appWebAddress} - WEB_ADDRESS=${appWebAddress}
- HOOK_POST_VALIDATION=${postValidationHook} - HOOK_POST_VALIDATION_ARRAY=${postValidationHookArray}
- WEB_RESET_ADDRESS=${resetAddress} - WEB_RESET_ADDRESS=${resetAddress}
- WEB_PORT=${appPort} - WEB_PORT=${appPort}
- DB_HOSTNAME=database - DB_HOSTNAME=database
@@ -130,7 +133,7 @@ networks:
`; `;
const dockerfile = ` const dockerfile = `
FROM node:16 FROM node:18
WORKDIR "/app" WORKDIR "/app"
COPY package*.json ./ COPY package*.json ./
RUN npm install --production RUN npm install --production
+878 -2152
View File
File diff suppressed because it is too large Load Diff
+6 -5
View File
@@ -1,6 +1,6 @@
{ {
"name": "auth-server", "name": "auth-server",
"version": "1.4.6", "version": "1.6.3",
"description": "An API centric auth server. Uses Sequelize and mariaDB by default.", "description": "An API centric auth server. Uses Sequelize and mariaDB by default.",
"main": "server/server.js", "main": "server/server.js",
"scripts": { "scripts": {
@@ -20,13 +20,14 @@
"homepage": "https://github.com/krgamestudios/auth-server#readme", "homepage": "https://github.com/krgamestudios/auth-server#readme",
"dependencies": { "dependencies": {
"bcryptjs": "^2.4.3", "bcryptjs": "^2.4.3",
"cookie-parser": "^1.4.6",
"cors": "^2.8.5", "cors": "^2.8.5",
"dotenv": "^8.6.0", "dotenv": "^16.0.1",
"express": "^4.17.1", "express": "^4.17.1",
"jsonwebtoken": "^8.5.1", "jsonwebtoken": "^8.5.1",
"mariadb": "^2.5.4", "mariadb": "^3.0.1",
"node-cron": "^2.0.3", "node-cron": "^3.0.1",
"node-fetch": "^3.1.0", "node-fetch": "^2.6.7",
"nodemailer": "^6.6.3", "nodemailer": "^6.6.3",
"sequelize": "^6.6.5" "sequelize": "^6.6.5"
}, },
+1 -1
View File
@@ -25,7 +25,7 @@ module.exports = async () => {
}); });
if (adminRecord == null) { 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({ await accounts.create({
email: `${process.env.ADMIN_DEFAULT_USERNAME}@${webAddress}`, email: `${process.env.ADMIN_DEFAULT_USERNAME}@${webAddress}`,
username: `${process.env.ADMIN_DEFAULT_USERNAME}`, username: `${process.env.ADMIN_DEFAULT_USERNAME}`,
+10 -5
View File
@@ -3,7 +3,7 @@ const utils = require('util');
const bcrypt = require('bcryptjs'); const bcrypt = require('bcryptjs');
const { accounts } = require('../database/models'); const { accounts } = require('../database/models');
const tokenGenerate = require('../utilities/token-generate'); const tokenGenerateRefresh = require('../utilities/token-generate-refresh');
//utilities //utilities
const validateEmail = require('../utilities/validate-email'); const validateEmail = require('../utilities/validate-email');
@@ -13,7 +13,7 @@ const route = async (req, res) => {
//validate the given details //validate the given details
const validateErr = await validateDetails(req.body); const validateErr = await validateDetails(req.body);
if (validateErr) { if (validateErr) {
return res.status(401).end(validateErr); return res.status(401).send(validateErr);
} }
//get the existing account //get the existing account
@@ -29,6 +29,7 @@ const route = async (req, res) => {
//compare passwords //compare passwords
const compare = utils.promisify(bcrypt.compare); 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) { if (!match) {
@@ -47,11 +48,15 @@ const route = async (req, res) => {
return res.status(403).send('this account has been banned'); return res.status(403).send('this account has been banned');
} }
//generate the JWT //generate the JWTs
const token = tokenGenerate(account.index, account.email, account.username, account.type, account.admin, account.mod); 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 //finally
res.status(200).json(token); res.status(200).send(accessToken);
return null;
}; };
const validateDetails = async (body) => { const validateDetails = async (body) => {
+4 -1
View File
@@ -2,7 +2,10 @@ const tokenDestroy = require('../utilities/token-destroy');
//auth/logout //auth/logout
const route = (req, res) => { const route = (req, res) => {
tokenDestroy(req.body.token); //stored in the cookie
tokenDestroy(req.cookies.refreshToken);
res.clearCookie('refreshToken');
return res.status(200).end(); return res.status(200).end();
}; };
+1 -1
View File
@@ -5,7 +5,7 @@ const route = async (req, res) => {
//verify the recovery record exists //verify the recovery record exists
const record = await recovery.findOne({ const record = await recovery.findOne({
where: { where: {
token: req.query.token token: req.query.token || ''
} }
}); });
+6 -9
View File
@@ -52,9 +52,6 @@ const validateDetails = async (body) => {
return 'Invalid username'; return 'Invalid username';
} }
//check for existing (banned)
//TODO: re-add banned email checks
//check for existing email //check for existing email
const emailRecord = await accounts.findOne({ const emailRecord = await accounts.findOne({
where: { where: {
@@ -107,12 +104,12 @@ const registerPendingSignup = async (body, hash, token) => {
const sendValidationEmail = async (email, username, token) => { const sendValidationEmail = async (email, username, token) => {
const addr = `${process.env.WEB_PROTOCOL}://${process.env.WEB_ADDRESS}/auth/validation?username=${username}&token=${token}`; const addr = `${process.env.WEB_PROTOCOL}://${process.env.WEB_ADDRESS}/auth/validation?username=${username}&token=${token}`;
const msg = `Hello ${username}! const msg =
`Hello ${username}!\n\n` +
Please visit the following link to validate your account: ${addr} `Please visit the following link to validate your account: ${addr}\n` +
(process.env.MAIL_PHYSICAL
You can contact us directly at our physical mailing address here: ${process.env.MAIL_PHYSICAL} ? `\nYou can contact us directly at our physical mailing address here: ${process.env.MAIL_PHYSICAL}\n`
`; : ``);
let transporter, info; let transporter, info;
+5 -4
View File
@@ -4,13 +4,14 @@ const tokenRefresh = require('../utilities/token-refresh');
//auth/token //auth/token
module.exports = async (req, res) => { module.exports = async (req, res) => {
const refreshToken = req.body.token; return tokenRefresh(req.cookies.refreshToken || '', (err, accessToken, refreshToken) => {
return tokenRefresh(refreshToken, (err, token) => {
if (err) { if (err) {
return res.status(err).end(); 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 });
}); });
}; };
+34 -9
View File
@@ -1,5 +1,6 @@
const { pendingSignups, accounts } = require('../database/models'); const { pendingSignups, accounts } = require('../database/models');
const fetch = require('node-fetch'); const fetch = require('node-fetch');
const jwt = require('jsonwebtoken');
//auth/validation //auth/validation
const route = async (req, res) => { const route = async (req, res) => {
@@ -20,7 +21,7 @@ const route = async (req, res) => {
} }
//move data to the accounts table //move data to the accounts table
const [account] = await accounts.upsert({ const account = await accounts.create({
email: info.email, email: info.email,
username: info.username, username: info.username,
hash: info.hash, hash: info.hash,
@@ -30,7 +31,7 @@ const route = async (req, res) => {
//delete the pending signup //delete the pending signup
pendingSignups.destroy({ pendingSignups.destroy({
where: { where: {
username: req.query.username || '' username: info.username || ''
} }
}); });
@@ -38,18 +39,42 @@ const route = async (req, res) => {
res.status(200).send('Validation succeeded!'); res.status(200).send('Validation succeeded!');
//post-validation hook //post-validation hook
if (process.env.HOOK_POST_VALIDATION) { if (process.env.HOOK_POST_VALIDATION_ARRAY) {
const probe = await fetch(`https://${process.env.HOOK_POST_VALIDATION}?accountIndex=${account.index}`); 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) { 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}`;
} else {
console.log('Validation hook probe successful'); //TODO: remove this
} }
//discard the result //discard the result
} else { });
console.log('No validation hook'); //TODO: remove this
await Promise.all(promises);
}
catch(e) {
console.error('HOOK_POST_VALIDATION_ARRAY is not a valid array of strings in JSON format: ' + e);
}
} }
}; };
+10 -1
View File
@@ -6,10 +6,19 @@ const express = require('express');
const app = express(); const app = express();
const server = require('http').Server(app); const server = require('http').Server(app);
const cors = require('cors'); const cors = require('cors');
const cookieParser = require('cookie-parser');
//config //config
app.use(express.json()); 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 //database connection
const database = require('./database'); const database = require('./database');
+4 -4
View File
@@ -3,13 +3,13 @@ const jwt = require('jsonwebtoken');
//middleware to authenticate the JWT token //middleware to authenticate the JWT token
module.exports = (req, res, next) => { module.exports = (req, res, next) => {
const authHeader = req.headers['authorization']; const authHeader = req.headers['authorization'];
const token = authHeader?.split (' ')[1]; //'Bearer token' const accessToken = authHeader?.split(' ')[1]; //'Bearer token'
if (!token) { if (!accessToken) {
return res.status(401).send('No token found'); 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) { if (err) {
return res.status(403).send(err); return res.status(403).send(err);
} }
+2 -2
View File
@@ -1,9 +1,9 @@
const { tokens } = require('../database/models'); const { tokens } = require('../database/models');
module.exports = (token) => { module.exports = (refreshToken) => {
tokens.destroy({ tokens.destroy({
where: { where: {
token: token || '' token: refreshToken || ''
} }
}); });
} }
@@ -12,6 +12,7 @@ module.exports = (index, email, username, type, admin, mod) => {
mod, mod,
}; };
//these are strings
const accessToken = jwt.sign(content, process.env.SECRET_ACCESS, { expiresIn: '10m', issuer: 'auth' }); 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' }); const refreshToken = jwt.sign(content, process.env.SECRET_REFRESH, { expiresIn: '30d', issuer: 'auth' });
+8 -8
View File
@@ -1,17 +1,17 @@
const jwt = require('jsonwebtoken'); const jwt = require('jsonwebtoken');
const { tokens } = require('../database/models'); const { tokens } = require('../database/models');
const generate = require('./token-generate'); const generate = require('./token-generate-refresh');
const destroy = require('./token-destroy'); const destroy = require('./token-destroy');
module.exports = async (token, callback) => { module.exports = async (oldRefreshToken, callback) => {
if (!token) { if (!oldRefreshToken) {
return callback(401); return callback(401);
} }
const tokenRecord = await tokens.findOne({ const tokenRecord = await tokens.findOne({
where: { where: {
token: token || '' token: oldRefreshToken || ''
} }
}); });
@@ -19,15 +19,15 @@ module.exports = async (token, callback) => {
return callback(403); return callback(403);
} }
jwt.verify(token, process.env.SECRET_REFRESH, (err, user) => { jwt.verify(oldRefreshToken, process.env.SECRET_REFRESH, (err, user) => {
if (err) { if (err) {
return callback(403); 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);
}); });
}; };
-68
View File
@@ -1,68 +0,0 @@
#Signup
POST https://dev-auth.eggtrainer.com/auth/signup HTTP/1.1
Content-Type: application/json
{
"email": "kayneruse@gmail.com",
"username": "Ratstail91",
"password": "helloworld"
}
###
#Login
POST https://dev-auth.eggtrainer.com/auth/login HTTP/1.1
Content-Type: application/json
{
"email": "kayneruse@gmail.com",
"password": "helloworld"
}
###
#Query data
GET https://dev-auth.eggtrainer.com/auth/account HTTP/1.1
Authorization: Bearer
###
#Logout
DELETE https://dev-auth.eggtrainer.com/auth/logout HTTP/1.1
Authorization: Bearer
{
"token": ""
}
###
#Refresh
POST https://dev-auth.eggtrainer.com/auth/token HTTP/1.1
Content-Type: application/json
{
"token": ""
}
###
#Update account data
PATCH https://dev-auth.eggtrainer.com/auth/update HTTP/1.1
Content-Type: application/json
Authorization: Bearer
{
"contact": "true"
}
###
#Delete account
DELETE https://dev-auth.eggtrainer.com/auth/deletion HTTP/1.1
Authorization: Bearer
Content-Type: application/json
{
"password": "helloworld"
}
@@ -1,4 +1,4 @@
#use this while debugging #use this while debugging
CREATE DATABASE IF NOT EXISTS auth; CREATE DATABASE IF NOT EXISTS auth;
CREATE USER IF NOT EXISTS 'auth'@'%' IDENTIFIED BY 'venusaur'; CREATE USER IF NOT EXISTS 'auth'@'%' IDENTIFIED BY 'charizard';
GRANT ALL PRIVILEGES ON auth.* TO 'auth'@'%'; GRANT ALL PRIVILEGES ON auth.* TO 'auth'@'%';
+68
View File
@@ -0,0 +1,68 @@
#Signup
POST https://dev-auth.krgamestudios.com/auth/signup HTTP/1.1
Content-Type: application/json
{
"email": "example@example.com",
"username": "Example",
"password": "helloworld"
}
###
#Login
POST https://dev-auth.krgamestudios.com/auth/login HTTP/1.1
Content-Type: application/json
{
"email": "example@example.com",
"password": "helloworld"
}
###
#Query data
GET https://dev-auth.krgamestudios.com/auth/account HTTP/1.1
Authorization: Bearer
###
#Logout
DELETE https://dev-auth.krgamestudios.com/auth/logout HTTP/1.1
Authorization: Bearer
{
"token": ""
}
###
#Refresh
POST https://dev-auth.krgamestudios.com/auth/token HTTP/1.1
Content-Type: application/json
{
"token": ""
}
###
#Update account data
PATCH https://dev-auth.krgamestudios.com/auth/update HTTP/1.1
Content-Type: application/json
Authorization: Bearer
{
"contact": "true"
}
###
#Delete account
DELETE https://dev-auth.krgamestudios.com/auth/deletion HTTP/1.1
Authorization: Bearer
Content-Type: application/json
{
"password": "helloworld"
}
@@ -3,8 +3,8 @@ POST http://127.0.0.1:3200/auth/signup HTTP/1.1
Content-Type: application/json Content-Type: application/json
{ {
"email": "kayneruse@gmail.com", "email": "example@example.com",
"username": "Ratstail91", "username": "Example",
"password": "helloworld" "password": "helloworld"
} }
@@ -15,8 +15,8 @@ POST http://127.0.0.1:3200/auth/login HTTP/1.1
Content-Type: application/json Content-Type: application/json
{ {
"email": "admin@example.com", "email": "example@example.com",
"password": "password" "password": "helloworld"
} }
### ###
+53
View File
@@ -0,0 +1,53 @@
# TokenProvider
The MERN-template utilizes React's `useContext()` hook to share the auth-server's access token, effectively globally. Here is a quick rundown of how it works.
# Enabling TokenProvider
To enable the TokenProvider component, wrap your App component with it, like so:
```jsx
import React from 'react';
import ReactDOM from 'react-dom';
import App from './pages/app';
import TokenProvider from './pages/utilities/token-provider';
ReactDOM.render(
<TokenProvider>
<App />
</TokenProvider>,
document.querySelector('#root')
);
```
# Accessing The Access Token
To access the access token from your app, you simply use the `useContext` hook, like so:
```jsx
import React, { useContext } from 'react';
import { TokenContext } from '../utilities/token-provider';
const Component = props => {
//context
const authTokens = useContext(TokenContext);
//use the access token
console.log(authTokens.accessToken);
return <div />;
};
export default Component;
```
# Most Useful Features Provided
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 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
+107
View File
@@ -0,0 +1,107 @@
import React, { useState, useEffect, createContext } from 'react';
import decode from 'jwt-decode';
export const TokenContext = createContext();
//DOCS: tokenFetch() and tokenCallback() are actually closures here
const TokenProvider = props => {
//state to be used
const [accessToken, setAccessToken] = useState('');
//make the access token persist between reloads
useEffect(() => {
setAccessToken(localStorage.getItem("accessToken") || '');
}, []);
//update the stored copies
useEffect(() => {
localStorage.setItem("accessToken", accessToken);
}, [accessToken]);
//wrap the default fetch function
const tokenFetch = async (url, options) => {
//use this?
let bearer = accessToken;
//if expired (10 minutes, normally)
const expired = new Date(decode(accessToken).exp * 1000) < Date.now();
if (expired) {
//BUGFIX: if logging out, just skip over the refresh token
if (url === `${process.env.AUTH_URI}/auth/logout`) {
return fetch(url, {
method: 'DELETE',
headers: {
'Authorization': `Bearer ${bearer}`
},
credentials: 'include'
});
}
//ping the auth server for a new access token
const response = await fetch(`${process.env.AUTH_URI}/auth/token`, {
method: 'POST',
credentials: 'include'
});
//any errors, throw them
if (!response.ok) {
throw `${response.status}: ${await response.text()}`;
}
//save the new auth stuff (setting bearer as well)
const newAuth = await response.json();
setAccessToken(newAuth.accessToken);
bearer = newAuth.accessToken;
}
//finally, delegate to fetch
return fetch(url, {
...(options || {}),
headers: {
...(options || { headers: {} }).headers,
'Authorization': `Bearer ${bearer}`
},
credentials: 'include'
});
};
//access the refreshed token via callback
const tokenCallback = async (cb) => {
//if expired (10 minutes, normally)
const expired = new Date(decode(accessToken).exp * 1000) < Date.now();
if (expired) {
//ping the auth server for a new token
const response = await fetch(`${process.env.AUTH_URI}/auth/token`, {
method: 'POST',
credentials: 'include'
});
//any errors, throw them
if (!response.ok) {
throw `${response.status}: ${await response.text()}`;
}
//save the new auth stuff (setting bearer as well)
const newAuth = await response.json();
setAccessToken(newAuth.accessToken);
//finally
return cb(newAuth.accessToken);
} else {
return cb(accessToken);
}
};
return (
<TokenContext.Provider value={{ accessToken, setAccessToken, tokenFetch, tokenCallback, getPayload: () => decode(accessToken) }}>
{props.children}
</TokenContext.Provider>
)
};
export default TokenProvider;