Compare commits

...

7 Commits

Author SHA1 Message Date
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
17 changed files with 583 additions and 1644 deletions
+1
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
+10 -16
View File
@@ -46,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"
}
### ###
+4 -1
View File
@@ -29,6 +29,8 @@ 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 appWebOrigin = await question('Web Origin', `${appWebProtocol}://example.com`); //TODO: clean these up properly
const appWebAddress = await question('Web Addr', `${appName}.example.com`); const appWebAddress = await question('Web Addr', `${appName}.example.com`);
const postValidationHookArray = await question('Post Validation Hook Array', ''); 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`);
@@ -69,7 +71,8 @@ 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_ARRAY=${postValidationHookArray} - HOOK_POST_VALIDATION_ARRAY=${postValidationHookArray}
- WEB_RESET_ADDRESS=${resetAddress} - WEB_RESET_ADDRESS=${resetAddress}
+514 -1573
View File
File diff suppressed because it is too large Load Diff
+2 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "auth-server", "name": "auth-server",
"version": "1.4.14", "version": "1.6.2",
"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": {
@@ -21,6 +21,7 @@
"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": "^8.6.0",
"express": "^4.17.1", "express": "^4.17.1",
+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}`,
+6 -3
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');
@@ -49,10 +49,13 @@ const route = async (req, res) => {
} }
//generate the JWTs //generate the JWTs
const tokens = 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(tokens); res.status(200).send(accessToken);
return null; return null;
}; };
+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();
}; };
+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 });
}); });
}; };
+2 -2
View File
@@ -64,13 +64,13 @@ const route = async (req, res) => {
}); });
if (!probe.ok) { if (!probe.ok) {
throw `Could not probe the post validation hook: ${hook}`; throw `Could not probe the post validation hook: ${hook} with accountIndex = ${account.index}`;
} }
//discard the result //discard the result
}); });
Promise.all(promises); await Promise.all(promises);
} }
catch(e) { catch(e) {
console.error('HOOK_POST_VALIDATION_ARRAY is not a valid array of strings in JSON format: ' + 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 || ''
} }
}); });
} }
+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);
}); });
}; };
+1 -1
View File
@@ -47,7 +47,7 @@ export default Component;
The most useful features provided by TokenProvider are: The most useful features provided by TokenProvider are:
* `tokenFetch()`, which wraps the `fetch()` API to ensure that your access token is valid * `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") * `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 * `accessToken`, this will be falsy if the user is not logged in
+9 -26
View File
@@ -8,19 +8,16 @@ export const TokenContext = createContext();
const TokenProvider = props => { const TokenProvider = props => {
//state to be used //state to be used
const [accessToken, setAccessToken] = useState(''); const [accessToken, setAccessToken] = useState('');
const [refreshToken, setRefreshToken] = useState('');
//make the access and refresh tokens persist between reloads //make the access token persist between reloads
useEffect(() => { useEffect(() => {
setAccessToken(localStorage.getItem("accessToken") || ''); setAccessToken(localStorage.getItem("accessToken") || '');
setRefreshToken(localStorage.getItem("refreshToken") || '');
}, []); }, []);
//update the stored copies //update the stored copies
useEffect(() => { useEffect(() => {
localStorage.setItem("accessToken", accessToken); localStorage.setItem("accessToken", accessToken);
localStorage.setItem("refreshToken", refreshToken); }, [accessToken]);
}, [accessToken, refreshToken]);
//wrap the default fetch function //wrap the default fetch function
const tokenFetch = async (url, options) => { const tokenFetch = async (url, options) => {
@@ -36,24 +33,16 @@ const TokenProvider = props => {
return fetch(url, { return fetch(url, {
method: 'DELETE', method: 'DELETE',
headers: { headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${bearer}` 'Authorization': `Bearer ${bearer}`
}, },
body: JSON.stringify({ credentials: 'include'
token: refreshToken
})
}); });
} }
//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`, { const response = await fetch(`${process.env.AUTH_URI}/auth/token`, {
method: 'POST', method: 'POST',
headers: { credentials: 'include'
'Content-Type': 'application/json'
},
body: JSON.stringify({
token: refreshToken
})
}); });
//any errors, throw them //any errors, throw them
@@ -65,7 +54,6 @@ const TokenProvider = props => {
const newAuth = await response.json(); const newAuth = await response.json();
setAccessToken(newAuth.accessToken); setAccessToken(newAuth.accessToken);
setRefreshToken(newAuth.refreshToken);
bearer = newAuth.accessToken; bearer = newAuth.accessToken;
} }
@@ -75,7 +63,8 @@ const TokenProvider = props => {
headers: { headers: {
...(options || { headers: {} }).headers, ...(options || { headers: {} }).headers,
'Authorization': `Bearer ${bearer}` 'Authorization': `Bearer ${bearer}`
} },
credentials: 'include'
}); });
}; };
@@ -88,12 +77,7 @@ const TokenProvider = props => {
//ping the auth server for a new token //ping the auth server for a new token
const response = await fetch(`${process.env.AUTH_URI}/auth/token`, { const response = await fetch(`${process.env.AUTH_URI}/auth/token`, {
method: 'POST', method: 'POST',
headers: { credentials: 'include'
'Content-Type': 'application/json'
},
body: JSON.stringify({
token: refreshToken
})
}); });
//any errors, throw them //any errors, throw them
@@ -105,7 +89,6 @@ const TokenProvider = props => {
const newAuth = await response.json(); const newAuth = await response.json();
setAccessToken(newAuth.accessToken); setAccessToken(newAuth.accessToken);
setRefreshToken(newAuth.refreshToken);
//finally //finally
return cb(newAuth.accessToken); return cb(newAuth.accessToken);
@@ -115,7 +98,7 @@ const TokenProvider = props => {
}; };
return ( 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} {props.children}
</TokenContext.Provider> </TokenContext.Provider>
) )