Compare commits
29 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 2d92b31272 | |||
| f93564931a | |||
| 2542f3f00f | |||
| a112e17f59 | |||
| 7af87824e3 | |||
| 8b91ff8dd3 | |||
| 0aa1e67be9 | |||
| 353be4662b | |||
| cc655cd988 | |||
| ec3b14e32b | |||
| b188c46efd | |||
| ece3b0253f | |||
| 062bc43f5a | |||
| cc6b7bd7b4 | |||
| 9bdf3925a3 | |||
| a299bab794 | |||
| 8460d03181 | |||
| ae88f3002a | |||
| f4745084c0 | |||
| 02387914a8 | |||
| 0da150f471 | |||
| d8e9620ad1 | |||
| c1155909be | |||
| 4ec55bed10 | |||
| b51d22f1a1 | |||
| 6b3db67a29 | |||
| 81da8ca422 | |||
| 72b3babfd8 | |||
| c63e14ddf3 |
@@ -1,5 +1,6 @@
|
|||||||
WEB_PROTOCOL=http
|
WEB_PROTOCOL=http
|
||||||
WEB_ADDRESS=localhost
|
WEB_ADDRESS=localhost
|
||||||
|
WEB_RESET_ADDRESS=localhost/reset
|
||||||
WEB_PORT=3200
|
WEB_PORT=3200
|
||||||
|
|
||||||
DB_HOSTNAME=database
|
DB_HOSTNAME=database
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ jobs:
|
|||||||
docker_image: krgamestudios/auth-server
|
docker_image: krgamestudios/auth-server
|
||||||
|
|
||||||
- name: Login to DockerHub
|
- name: Login to DockerHub
|
||||||
uses: docker/login-action@v1
|
uses: docker/login-action@v1
|
||||||
with:
|
with:
|
||||||
username: ${{ secrets.DOCKER_USERNAME }}
|
username: ${{ secrets.DOCKER_USERNAME }}
|
||||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||||
|
|||||||
+2
-2
@@ -1,9 +1,9 @@
|
|||||||
|
|
||||||
FROM node:15
|
FROM node:16
|
||||||
WORKDIR "/app"
|
WORKDIR "/app"
|
||||||
COPY package*.json ./
|
COPY package*.json ./
|
||||||
COPY . /app
|
|
||||||
RUN npm install --production
|
RUN npm install --production
|
||||||
|
COPY . /app
|
||||||
EXPOSE 3200
|
EXPOSE 3200
|
||||||
USER node
|
USER node
|
||||||
ENTRYPOINT ["bash", "-c"]
|
ENTRYPOINT ["bash", "-c"]
|
||||||
|
|||||||
@@ -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.
|
||||||
@@ -19,9 +21,19 @@ Content-Type: application/json
|
|||||||
"password": "helloworld"
|
"password": "helloworld"
|
||||||
}
|
}
|
||||||
|
|
||||||
//DOCS: Used for validating the email address 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
|
||||||
|
GET https://{HOOK_POST_VALIDATION}?accountIndex={index}
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
|
||||||
//DOCS: Login after validation
|
//DOCS: Login after validation
|
||||||
POST /auth/login
|
POST /auth/login
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
@@ -31,13 +43,17 @@ Content-Type: application/json
|
|||||||
"password": "helloworld"
|
"password": "helloworld"
|
||||||
}
|
}
|
||||||
|
|
||||||
//Result (access token's value is your authorization key below)
|
//DOCS: Result (access token's value is your authorization key below)
|
||||||
{
|
{
|
||||||
"accessToken": "abcde",
|
"accessToken": "abcde",
|
||||||
"refreshToken": "fghij"
|
"refreshToken": "fghij"
|
||||||
}
|
}
|
||||||
|
|
||||||
//Replace an expired authToken pair with these values
|
|
||||||
|
###
|
||||||
|
|
||||||
|
|
||||||
|
//DOCS: Replace an expired authToken pair with new values
|
||||||
POST /auth/token
|
POST /auth/token
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
|
|
||||||
@@ -45,6 +61,16 @@ Content-Type: application/json
|
|||||||
"token": "refreshToken"
|
"token": "refreshToken"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
//DOCS: Result
|
||||||
|
{
|
||||||
|
"accessToken": "abcde",
|
||||||
|
"refreshToken": "fghij"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
|
||||||
//DOCS: After this is called, the refresh route will no longer work
|
//DOCS: After this is called, the refresh route will no longer work
|
||||||
DELETE /auth/logout
|
DELETE /auth/logout
|
||||||
Authorization: Bearer accessToken
|
Authorization: Bearer accessToken
|
||||||
@@ -53,21 +79,32 @@ Authorization: Bearer accessToken
|
|||||||
"token": "refreshToken"
|
"token": "refreshToken"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
|
||||||
//DOCS: Retreives the private account data, results vary
|
//DOCS: Retreives the private account data, results vary
|
||||||
GET /auth/account
|
GET /auth/account
|
||||||
Authorization: Bearer accessToken
|
Authorization: Bearer accessToken
|
||||||
|
|
||||||
//Result
|
|
||||||
{
|
|
||||||
"accessToken": "abcde",
|
|
||||||
"refreshToken": "fghij"
|
|
||||||
}
|
|
||||||
|
|
||||||
//DOCS: Update account data, input varies, but is always JSON
|
###
|
||||||
|
|
||||||
|
|
||||||
|
//DOCS: Update account data
|
||||||
PATCH /auth/account
|
PATCH /auth/account
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Authorization: Bearer accessToken
|
Authorization: Bearer accessToken
|
||||||
|
|
||||||
|
{
|
||||||
|
"password": "helloworld",
|
||||||
|
"contact": true
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
|
||||||
//DOCS: Sets the timer, account will be deleted after 2 days
|
//DOCS: Sets the timer, account will be deleted after 2 days
|
||||||
DELETE /auth/account
|
DELETE /auth/account
|
||||||
Authorization: Bearer accessToken
|
Authorization: Bearer accessToken
|
||||||
@@ -76,4 +113,40 @@ Content-Type: application/json
|
|||||||
{
|
{
|
||||||
"password": "helloworld"
|
"password": "helloworld"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
|
||||||
|
//DOCS: Send the link to recover a forgotten password
|
||||||
|
POST /auth/recover
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"email": "kayneruse@gmail.com"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
|
||||||
|
//DOCS: Redirect the link to recover a password to the front-end
|
||||||
|
GET /auth/reset?token=<token>
|
||||||
|
|
||||||
|
//DOCS: Result
|
||||||
|
301 -> ${WEB_RESET_ADDRESS}?email=<email>&token=<token>
|
||||||
|
|
||||||
|
|
||||||
|
###
|
||||||
|
|
||||||
|
|
||||||
|
//DOCS: Resets a password for the given email, correct token is required
|
||||||
|
PATCH /auth/reset?email=<email>&token=<token>
|
||||||
|
|
||||||
|
{
|
||||||
|
"password": "password"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
###
|
||||||
```
|
```
|
||||||
|
|||||||
+8
-4
@@ -30,10 +30,12 @@ const question = (prompt, def = null) => {
|
|||||||
//project configuration
|
//project configuration
|
||||||
const appName = await question('App Name', 'auth');
|
const appName = await question('App Name', 'auth');
|
||||||
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 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,6 +71,8 @@ services:
|
|||||||
environment:
|
environment:
|
||||||
- WEB_PROTOCOL=https
|
- WEB_PROTOCOL=https
|
||||||
- WEB_ADDRESS=${appWebAddress}
|
- WEB_ADDRESS=${appWebAddress}
|
||||||
|
- HOOK_POST_VALIDATION=${postValidationHook}
|
||||||
|
- WEB_RESET_ADDRESS=${resetAddress}
|
||||||
- WEB_PORT=${appPort}
|
- WEB_PORT=${appPort}
|
||||||
- DB_HOSTNAME=database
|
- DB_HOSTNAME=database
|
||||||
- DB_DATABASE=${appName}
|
- DB_DATABASE=${appName}
|
||||||
@@ -83,7 +87,7 @@ services:
|
|||||||
- ADMIN_DEFAULT_PASSWORD=${appDefaultPass}
|
- ADMIN_DEFAULT_PASSWORD=${appDefaultPass}
|
||||||
- SECRET_ACCESS=${appSecretAccess}
|
- SECRET_ACCESS=${appSecretAccess}
|
||||||
- SECRET_REFRESH=${appSecretRefresh}
|
- SECRET_REFRESH=${appSecretRefresh}
|
||||||
networks:
|
networks:
|
||||||
- app-network
|
- app-network
|
||||||
depends_on:
|
depends_on:
|
||||||
- database
|
- database
|
||||||
@@ -94,7 +98,7 @@ services:
|
|||||||
MYSQL_USER: ${appDBUser}
|
MYSQL_USER: ${appDBUser}
|
||||||
MYSQL_PASSWORD: ${appDBPass}
|
MYSQL_PASSWORD: ${appDBPass}
|
||||||
MYSQL_ROOT_PASSWORD: ${dbRootPass}
|
MYSQL_ROOT_PASSWORD: ${dbRootPass}
|
||||||
networks:
|
networks:
|
||||||
- app-network
|
- app-network
|
||||||
volumes:
|
volumes:
|
||||||
- ./mysql:/var/lib/mysql
|
- ./mysql:/var/lib/mysql
|
||||||
@@ -126,7 +130,7 @@ networks:
|
|||||||
`;
|
`;
|
||||||
|
|
||||||
const dockerfile = `
|
const dockerfile = `
|
||||||
FROM node:15
|
FROM node:16
|
||||||
WORKDIR "/app"
|
WORKDIR "/app"
|
||||||
COPY package*.json ./
|
COPY package*.json ./
|
||||||
RUN npm install --production
|
RUN npm install --production
|
||||||
|
|||||||
Generated
+89
-113
@@ -1,21 +1,22 @@
|
|||||||
{
|
{
|
||||||
"name": "auth-server",
|
"name": "auth-server",
|
||||||
"version": "1.0.0",
|
"version": "1.4.12",
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"version": "1.0.0",
|
"name": "auth-server",
|
||||||
|
"version": "1.4.12",
|
||||||
"license": "ISC",
|
"license": "ISC",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"bcryptjs": "^2.4.3",
|
"bcryptjs": "^2.4.3",
|
||||||
"body-parser": "^1.19.0",
|
|
||||||
"cors": "^2.8.5",
|
"cors": "^2.8.5",
|
||||||
"dotenv": "^8.6.0",
|
"dotenv": "^8.6.0",
|
||||||
"express": "^4.17.1",
|
"express": "^4.17.1",
|
||||||
"jsonwebtoken": "^8.5.1",
|
"jsonwebtoken": "^8.5.1",
|
||||||
"mariadb": "^2.5.4",
|
"mariadb": "^2.5.4",
|
||||||
"node-cron": "^2.0.3",
|
"node-cron": "^2.0.3",
|
||||||
|
"node-fetch": "^2.6.6",
|
||||||
"nodemailer": "^6.6.3",
|
"nodemailer": "^6.6.3",
|
||||||
"sequelize": "^6.6.5"
|
"sequelize": "^6.6.5"
|
||||||
},
|
},
|
||||||
@@ -73,68 +74,18 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/ansi-align": {
|
"node_modules/ansi-align": {
|
||||||
"version": "3.0.0",
|
"version": "3.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz",
|
||||||
"integrity": "sha512-ZpClVKqXN3RGBmKibdfWzqCY4lnjEuoNzU5T0oEFpfd/z5qJHVarukridD4juLO2FXMiwUQxr9WqQtaYa8XRYw==",
|
"integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"string-width": "^3.0.0"
|
"string-width": "^4.1.0"
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/ansi-align/node_modules/ansi-regex": {
|
|
||||||
"version": "4.1.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz",
|
|
||||||
"integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==",
|
|
||||||
"dev": true,
|
|
||||||
"engines": {
|
|
||||||
"node": ">=6"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/ansi-align/node_modules/emoji-regex": {
|
|
||||||
"version": "7.0.3",
|
|
||||||
"resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz",
|
|
||||||
"integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==",
|
|
||||||
"dev": true
|
|
||||||
},
|
|
||||||
"node_modules/ansi-align/node_modules/is-fullwidth-code-point": {
|
|
||||||
"version": "2.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz",
|
|
||||||
"integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=",
|
|
||||||
"dev": true,
|
|
||||||
"engines": {
|
|
||||||
"node": ">=4"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/ansi-align/node_modules/string-width": {
|
|
||||||
"version": "3.1.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz",
|
|
||||||
"integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==",
|
|
||||||
"dev": true,
|
|
||||||
"dependencies": {
|
|
||||||
"emoji-regex": "^7.0.1",
|
|
||||||
"is-fullwidth-code-point": "^2.0.0",
|
|
||||||
"strip-ansi": "^5.1.0"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=6"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/ansi-align/node_modules/strip-ansi": {
|
|
||||||
"version": "5.2.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz",
|
|
||||||
"integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==",
|
|
||||||
"dev": true,
|
|
||||||
"dependencies": {
|
|
||||||
"ansi-regex": "^4.1.0"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=6"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/ansi-regex": {
|
"node_modules/ansi-regex": {
|
||||||
"version": "5.0.0",
|
"version": "5.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
|
||||||
"integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==",
|
"integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=8"
|
"node": ">=8"
|
||||||
@@ -1330,6 +1281,25 @@
|
|||||||
"node": ">=6.0.0"
|
"node": ">=6.0.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/node-fetch": {
|
||||||
|
"version": "2.6.7",
|
||||||
|
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz",
|
||||||
|
"integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==",
|
||||||
|
"dependencies": {
|
||||||
|
"whatwg-url": "^5.0.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": "4.x || >=6.0.0"
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"encoding": "^0.1.0"
|
||||||
|
},
|
||||||
|
"peerDependenciesMeta": {
|
||||||
|
"encoding": {
|
||||||
|
"optional": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/nodemailer": {
|
"node_modules/nodemailer": {
|
||||||
"version": "6.6.3",
|
"version": "6.6.3",
|
||||||
"resolved": "https://registry.npmjs.org/nodemailer/-/nodemailer-6.6.3.tgz",
|
"resolved": "https://registry.npmjs.org/nodemailer/-/nodemailer-6.6.3.tgz",
|
||||||
@@ -1960,6 +1930,11 @@
|
|||||||
"nodetouch": "bin/nodetouch.js"
|
"nodetouch": "bin/nodetouch.js"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/tr46": {
|
||||||
|
"version": "0.0.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz",
|
||||||
|
"integrity": "sha1-gYT9NH2snNwYWZLzpmIuFLnZq2o="
|
||||||
|
},
|
||||||
"node_modules/type-fest": {
|
"node_modules/type-fest": {
|
||||||
"version": "0.8.1",
|
"version": "0.8.1",
|
||||||
"resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz",
|
"resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz",
|
||||||
@@ -2080,9 +2055,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/validator": {
|
"node_modules/validator": {
|
||||||
"version": "13.6.0",
|
"version": "13.7.0",
|
||||||
"resolved": "https://registry.npmjs.org/validator/-/validator-13.6.0.tgz",
|
"resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz",
|
||||||
"integrity": "sha512-gVgKbdbHgtxpRyR8K0O6oFZPhhB5tT1jeEHZR0Znr9Svg03U0+r9DXWMrnRAB+HtCStDQKlaIZm42tVsVjqtjg==",
|
"integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw==",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">= 0.10"
|
"node": ">= 0.10"
|
||||||
}
|
}
|
||||||
@@ -2095,6 +2070,20 @@
|
|||||||
"node": ">= 0.8"
|
"node": ">= 0.8"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node_modules/webidl-conversions": {
|
||||||
|
"version": "3.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
|
||||||
|
"integrity": "sha1-JFNCdeKnvGvnvIZhHMFq4KVlSHE="
|
||||||
|
},
|
||||||
|
"node_modules/whatwg-url": {
|
||||||
|
"version": "5.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
|
||||||
|
"integrity": "sha1-lmRU6HZUYuN2RNNib2dCzotwll0=",
|
||||||
|
"dependencies": {
|
||||||
|
"tr46": "~0.0.3",
|
||||||
|
"webidl-conversions": "^3.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
"node_modules/widest-line": {
|
"node_modules/widest-line": {
|
||||||
"version": "3.1.0",
|
"version": "3.1.0",
|
||||||
"resolved": "https://registry.npmjs.org/widest-line/-/widest-line-3.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/widest-line/-/widest-line-3.1.0.tgz",
|
||||||
@@ -2190,58 +2179,18 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"ansi-align": {
|
"ansi-align": {
|
||||||
"version": "3.0.0",
|
"version": "3.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/ansi-align/-/ansi-align-3.0.1.tgz",
|
||||||
"integrity": "sha512-ZpClVKqXN3RGBmKibdfWzqCY4lnjEuoNzU5T0oEFpfd/z5qJHVarukridD4juLO2FXMiwUQxr9WqQtaYa8XRYw==",
|
"integrity": "sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"string-width": "^3.0.0"
|
"string-width": "^4.1.0"
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"ansi-regex": {
|
|
||||||
"version": "4.1.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz",
|
|
||||||
"integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==",
|
|
||||||
"dev": true
|
|
||||||
},
|
|
||||||
"emoji-regex": {
|
|
||||||
"version": "7.0.3",
|
|
||||||
"resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz",
|
|
||||||
"integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==",
|
|
||||||
"dev": true
|
|
||||||
},
|
|
||||||
"is-fullwidth-code-point": {
|
|
||||||
"version": "2.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz",
|
|
||||||
"integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=",
|
|
||||||
"dev": true
|
|
||||||
},
|
|
||||||
"string-width": {
|
|
||||||
"version": "3.1.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz",
|
|
||||||
"integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==",
|
|
||||||
"dev": true,
|
|
||||||
"requires": {
|
|
||||||
"emoji-regex": "^7.0.1",
|
|
||||||
"is-fullwidth-code-point": "^2.0.0",
|
|
||||||
"strip-ansi": "^5.1.0"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"strip-ansi": {
|
|
||||||
"version": "5.2.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz",
|
|
||||||
"integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==",
|
|
||||||
"dev": true,
|
|
||||||
"requires": {
|
|
||||||
"ansi-regex": "^4.1.0"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"ansi-regex": {
|
"ansi-regex": {
|
||||||
"version": "5.0.0",
|
"version": "5.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
|
||||||
"integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==",
|
"integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"ansi-styles": {
|
"ansi-styles": {
|
||||||
@@ -3182,6 +3131,14 @@
|
|||||||
"tz-offset": "0.0.1"
|
"tz-offset": "0.0.1"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"node-fetch": {
|
||||||
|
"version": "2.6.7",
|
||||||
|
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz",
|
||||||
|
"integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==",
|
||||||
|
"requires": {
|
||||||
|
"whatwg-url": "^5.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
"nodemailer": {
|
"nodemailer": {
|
||||||
"version": "6.6.3",
|
"version": "6.6.3",
|
||||||
"resolved": "https://registry.npmjs.org/nodemailer/-/nodemailer-6.6.3.tgz",
|
"resolved": "https://registry.npmjs.org/nodemailer/-/nodemailer-6.6.3.tgz",
|
||||||
@@ -3651,6 +3608,11 @@
|
|||||||
"nopt": "~1.0.10"
|
"nopt": "~1.0.10"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"tr46": {
|
||||||
|
"version": "0.0.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz",
|
||||||
|
"integrity": "sha1-gYT9NH2snNwYWZLzpmIuFLnZq2o="
|
||||||
|
},
|
||||||
"type-fest": {
|
"type-fest": {
|
||||||
"version": "0.8.1",
|
"version": "0.8.1",
|
||||||
"resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz",
|
"resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.8.1.tgz",
|
||||||
@@ -3744,15 +3706,29 @@
|
|||||||
"integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg=="
|
"integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg=="
|
||||||
},
|
},
|
||||||
"validator": {
|
"validator": {
|
||||||
"version": "13.6.0",
|
"version": "13.7.0",
|
||||||
"resolved": "https://registry.npmjs.org/validator/-/validator-13.6.0.tgz",
|
"resolved": "https://registry.npmjs.org/validator/-/validator-13.7.0.tgz",
|
||||||
"integrity": "sha512-gVgKbdbHgtxpRyR8K0O6oFZPhhB5tT1jeEHZR0Znr9Svg03U0+r9DXWMrnRAB+HtCStDQKlaIZm42tVsVjqtjg=="
|
"integrity": "sha512-nYXQLCBkpJ8X6ltALua9dRrZDHVYxjJ1wgskNt1lH9fzGjs3tgojGSCBjmEPwkWS1y29+DrizMTW19Pr9uB2nw=="
|
||||||
},
|
},
|
||||||
"vary": {
|
"vary": {
|
||||||
"version": "1.1.2",
|
"version": "1.1.2",
|
||||||
"resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz",
|
"resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz",
|
||||||
"integrity": "sha1-IpnwLG3tMNSllhsLn3RSShj2NPw="
|
"integrity": "sha1-IpnwLG3tMNSllhsLn3RSShj2NPw="
|
||||||
},
|
},
|
||||||
|
"webidl-conversions": {
|
||||||
|
"version": "3.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
|
||||||
|
"integrity": "sha1-JFNCdeKnvGvnvIZhHMFq4KVlSHE="
|
||||||
|
},
|
||||||
|
"whatwg-url": {
|
||||||
|
"version": "5.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
|
||||||
|
"integrity": "sha1-lmRU6HZUYuN2RNNib2dCzotwll0=",
|
||||||
|
"requires": {
|
||||||
|
"tr46": "~0.0.3",
|
||||||
|
"webidl-conversions": "^3.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
"widest-line": {
|
"widest-line": {
|
||||||
"version": "3.1.0",
|
"version": "3.1.0",
|
||||||
"resolved": "https://registry.npmjs.org/widest-line/-/widest-line-3.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/widest-line/-/widest-line-3.1.0.tgz",
|
||||||
|
|||||||
+36
-36
@@ -1,36 +1,36 @@
|
|||||||
{
|
{
|
||||||
"name": "auth-server",
|
"name": "auth-server",
|
||||||
"version": "1.3.1",
|
"version": "1.4.12",
|
||||||
"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": {
|
||||||
"start": "node server/server.js",
|
"start": "node server/server.js",
|
||||||
"dev": "npm run watch:server",
|
"dev": "npm run watch:server",
|
||||||
"watch:server": "nodemon . --ext js,jsx,json --ignore 'node_modules/*'"
|
"watch:server": "nodemon . --ext js,jsx,json --ignore 'node_modules/*'"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://github.com/krgamestudios/auth-server.git"
|
"url": "git+https://github.com/krgamestudios/auth-server.git"
|
||||||
},
|
},
|
||||||
"author": "Kayne Ruse",
|
"author": "Kayne Ruse",
|
||||||
"license": "ISC",
|
"license": "ISC",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/krgamestudios/auth-server/issues"
|
"url": "https://github.com/krgamestudios/auth-server/issues"
|
||||||
},
|
},
|
||||||
"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",
|
||||||
"body-parser": "^1.19.0",
|
"cors": "^2.8.5",
|
||||||
"cors": "^2.8.5",
|
"dotenv": "^8.6.0",
|
||||||
"dotenv": "^8.6.0",
|
"express": "^4.17.1",
|
||||||
"express": "^4.17.1",
|
"jsonwebtoken": "^8.5.1",
|
||||||
"jsonwebtoken": "^8.5.1",
|
"mariadb": "^2.5.4",
|
||||||
"mariadb": "^2.5.4",
|
"node-cron": "^2.0.3",
|
||||||
"node-cron": "^2.0.3",
|
"node-fetch": "^2.6.6",
|
||||||
"nodemailer": "^6.6.3",
|
"nodemailer": "^6.6.3",
|
||||||
"sequelize": "^6.6.5"
|
"sequelize": "^6.6.5"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"nodemon": "^2.0.12"
|
"nodemon": "^2.0.12"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ const route = async (req, res) => {
|
|||||||
//forcibly logout
|
//forcibly logout
|
||||||
tokens.destroy({
|
tokens.destroy({
|
||||||
where: {
|
where: {
|
||||||
username: req.body.username || ''
|
email: req.body.email || ''
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ router.use(tokenAuth);
|
|||||||
router.use(async (req, res, next) => {
|
router.use(async (req, res, next) => {
|
||||||
const record = await accounts.findOne({
|
const record = await accounts.findOne({
|
||||||
where: {
|
where: {
|
||||||
username: req.user.username || ''
|
email: req.user.email || ''
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
@@ -9,18 +9,26 @@ const { accounts } = require('../database/models');
|
|||||||
|
|
||||||
//auth/deletion
|
//auth/deletion
|
||||||
const route = async (req, res) => {
|
const route = async (req, res) => {
|
||||||
|
if (!req.body.password) {
|
||||||
|
return res.status(401).end('Missing password');
|
||||||
|
}
|
||||||
|
|
||||||
const account = await accounts.findOne({
|
const account = await accounts.findOne({
|
||||||
where: {
|
where: {
|
||||||
index: req.user.index
|
index: req.user.index || ''
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
if (!account) {
|
||||||
|
return res.status(401).end('Missing account');
|
||||||
|
}
|
||||||
|
|
||||||
//compare the user's password
|
//compare the user's password
|
||||||
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) {
|
||||||
return res.status(401).send('incorrect password');
|
return res.status(401).send('Incorrect password');
|
||||||
}
|
}
|
||||||
|
|
||||||
//set the deletion time (2 days from now)
|
//set the deletion time (2 days from now)
|
||||||
|
|||||||
@@ -4,12 +4,12 @@ const { accounts } = require('../database/models');
|
|||||||
const route = async (req, res) => {
|
const route = async (req, res) => {
|
||||||
const account = await accounts.findOne({
|
const account = await accounts.findOne({
|
||||||
where: {
|
where: {
|
||||||
index: req.user.index
|
index: req.user.index || ''
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
if (!account) {
|
if (!account) {
|
||||||
return res.status(401).send('Unknown account');
|
return res.status(401).end('Unknown account');
|
||||||
}
|
}
|
||||||
|
|
||||||
//respond with the private-facing data
|
//respond with the private-facing data
|
||||||
|
|||||||
@@ -3,13 +3,13 @@ const { accounts } = require('../database/models');
|
|||||||
|
|
||||||
//auth/update
|
//auth/update
|
||||||
const route = async (req, res) => {
|
const route = async (req, res) => {
|
||||||
//generate the password hash
|
if (!req.body.password) {
|
||||||
let hash;
|
return res.status(401).end('Missing password');
|
||||||
|
|
||||||
if (req.body.password) {
|
|
||||||
hash = await bcrypt.hash(req.body.password, await bcrypt.genSalt(11));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
//generate the password hash
|
||||||
|
let hash = await bcrypt.hash(req.body.password, await bcrypt.genSalt(11));
|
||||||
|
|
||||||
//update the account
|
//update the account
|
||||||
await accounts.update({
|
await accounts.update({
|
||||||
contact: req.body.contact,
|
contact: req.body.contact,
|
||||||
|
|||||||
@@ -14,13 +14,21 @@ router.post('/login', require('./login'));
|
|||||||
//refresh token
|
//refresh token
|
||||||
router.post('/token', require('./token'));
|
router.post('/token', require('./token'));
|
||||||
|
|
||||||
|
//password recover and reset
|
||||||
|
router.post('/recover', require('./password-recover'));
|
||||||
|
router.get('/reset', require('./password-redirect'));
|
||||||
|
router.patch('/reset', require('./password-reset'));
|
||||||
|
|
||||||
|
//logouts allowed when banned, and when the token itself is invalid
|
||||||
|
router.delete('/logout', require('./logout'));
|
||||||
|
|
||||||
//middleware
|
//middleware
|
||||||
router.use(tokenAuth);
|
router.use(tokenAuth);
|
||||||
|
|
||||||
router.use(async (req, res, next) => {
|
router.use(async (req, res, next) => {
|
||||||
const record = await accounts.findOne({
|
const record = await accounts.findOne({
|
||||||
where: {
|
where: {
|
||||||
username: req.user.username || ''
|
email: req.user.email || ''
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -36,7 +44,6 @@ router.use(async (req, res, next) => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
//basic account management (needs a token)
|
//basic account management (needs a token)
|
||||||
router.delete('/logout', require('./logout'));
|
|
||||||
router.get('/account', require('./account-query'));
|
router.get('/account', require('./account-query'));
|
||||||
router.patch('/account', require('./account-update'));
|
router.patch('/account', require('./account-update'));
|
||||||
router.delete('/account', require('./account-delete'));
|
router.delete('/account', require('./account-delete'));
|
||||||
|
|||||||
+14
-9
@@ -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 generate = require('../utilities/token-generate');
|
const tokenGenerate = require('../utilities/token-generate');
|
||||||
|
|
||||||
//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).send(validateErr);
|
return res.status(401).end(validateErr);
|
||||||
}
|
}
|
||||||
|
|
||||||
//get the existing account
|
//get the existing account
|
||||||
@@ -48,20 +48,25 @@ const route = async (req, res) => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
//generate the JWT
|
//generate the JWT
|
||||||
const tokens = generate(account.index, account.username, account.type, account.admin, account.mod);
|
const token = tokenGenerate(account.index, account.email, account.username, account.type, account.admin, account.mod);
|
||||||
|
|
||||||
//finally
|
//finally
|
||||||
res.status(200).json(tokens);
|
res.status(200).json(token);
|
||||||
};
|
};
|
||||||
|
|
||||||
const validateDetails = async (body) => {
|
const validateDetails = async (body) => {
|
||||||
//basic formatting (with an exception for the default admin account)
|
if (!body.email) {
|
||||||
if (!validateEmail(body.email) && body.email != `${process.env.ADMIN_DEFAULT_USERNAME}@${process.env.WEB_ADDRESS}`) {
|
return 'Missing email';
|
||||||
return 'invalid email';
|
|
||||||
}
|
}
|
||||||
|
|
||||||
//check for existing (banned)
|
if (!body.password) {
|
||||||
//TODO: restore banning
|
return 'Missing password';
|
||||||
|
}
|
||||||
|
|
||||||
|
//basic formatting (with an exception for the default admin account)
|
||||||
|
if (!validateEmail(body.email) && body.email != `${process.env.ADMIN_DEFAULT_USERNAME}@${process.env.WEB_ADDRESS}`) {
|
||||||
|
return 'Invalid email';
|
||||||
|
}
|
||||||
|
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
const destroy = require('../utilities/token-destroy');
|
const tokenDestroy = require('../utilities/token-destroy');
|
||||||
|
|
||||||
//auth/logout
|
//auth/logout
|
||||||
const route = (req, res) => {
|
const route = (req, res) => {
|
||||||
destroy(req.body.token);
|
tokenDestroy(req.body.token);
|
||||||
|
|
||||||
return res.status(200).end();
|
return res.status(200).end();
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -0,0 +1,106 @@
|
|||||||
|
//libraries
|
||||||
|
const nodemailer = require('nodemailer');
|
||||||
|
|
||||||
|
const { accounts, recovery } = require('../database/models');
|
||||||
|
|
||||||
|
//utilities
|
||||||
|
const uuid = require('../utilities/uuid');
|
||||||
|
const validateEmail = require('../utilities/validate-email');
|
||||||
|
|
||||||
|
//auth/recover
|
||||||
|
const route = async (req, res) => {
|
||||||
|
//validate details
|
||||||
|
const validateErr = await validateDetails(req.body);
|
||||||
|
if (validateErr) {
|
||||||
|
return res.status(401).end(validateErr);
|
||||||
|
}
|
||||||
|
|
||||||
|
//recovery token
|
||||||
|
const token = uuid(32);
|
||||||
|
|
||||||
|
//send the recovery email
|
||||||
|
const emailErr = await sendRecoveryEmail(req.body.email, token);
|
||||||
|
if (emailErr) {
|
||||||
|
return res.status(500).send(emailErr);
|
||||||
|
}
|
||||||
|
|
||||||
|
//save the token
|
||||||
|
await recovery.upsert({
|
||||||
|
email: req.body.email,
|
||||||
|
token: token
|
||||||
|
});
|
||||||
|
|
||||||
|
//finally
|
||||||
|
res.status(200).send("Recovery email sent!");
|
||||||
|
return null;
|
||||||
|
};
|
||||||
|
|
||||||
|
const validateDetails = async (body) => {
|
||||||
|
//basic formatting
|
||||||
|
if (!validateEmail(body.email)) {
|
||||||
|
return 'Invalid email';
|
||||||
|
}
|
||||||
|
|
||||||
|
//check for existing email
|
||||||
|
const emailRecord = await accounts.findOne({
|
||||||
|
where: {
|
||||||
|
email: body.email
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!emailRecord) {
|
||||||
|
return 'Invalid email';
|
||||||
|
}
|
||||||
|
|
||||||
|
//OK
|
||||||
|
return null;
|
||||||
|
};
|
||||||
|
|
||||||
|
const sendRecoveryEmail = async (email, token) => {
|
||||||
|
const addr = `${process.env.WEB_PROTOCOL}://${process.env.WEB_ADDRESS}/auth/reset?token=${token}`;
|
||||||
|
const msg = `Hello,
|
||||||
|
|
||||||
|
Please visit the following link to reset your password: ${addr}
|
||||||
|
|
||||||
|
If you did not request a password reset, you can safely ignore this message.
|
||||||
|
`;
|
||||||
|
|
||||||
|
let transporter, info;
|
||||||
|
|
||||||
|
//what exactly is a transport?
|
||||||
|
try {
|
||||||
|
transporter = nodemailer.createTransport({
|
||||||
|
host: process.env.MAIL_SMTP,
|
||||||
|
port: 465,
|
||||||
|
secure: true,
|
||||||
|
auth: {
|
||||||
|
user: process.env.MAIL_USERNAME,
|
||||||
|
pass: process.env.MAIL_PASSWORD
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
|
catch(e) {
|
||||||
|
return `failed to create a mail transport: ${e}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
// send mail with defined transport object
|
||||||
|
try {
|
||||||
|
info = await transporter.sendMail({
|
||||||
|
from: `recovery@${process.env.WEB_ADDRESS}`, //WARNING: google overwrites this
|
||||||
|
to: email,
|
||||||
|
subject: 'Password Recovery',
|
||||||
|
text: msg
|
||||||
|
});
|
||||||
|
}
|
||||||
|
catch(e) {
|
||||||
|
return `failed to send validation mail: ${e}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (info.accepted[0] != email) {
|
||||||
|
return 'recovery email failed to send';
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
};
|
||||||
|
|
||||||
|
module.exports = route;
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
const { accounts, recovery } = require('../database/models');
|
||||||
|
|
||||||
|
//auth/reset
|
||||||
|
const route = async (req, res) => {
|
||||||
|
//verify the recovery record exists
|
||||||
|
const record = await recovery.findOne({
|
||||||
|
where: {
|
||||||
|
token: req.query.token || ''
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!record) {
|
||||||
|
return res.status(401).end('Failed to recover a password');
|
||||||
|
}
|
||||||
|
|
||||||
|
//redirect to the front-end
|
||||||
|
res.redirect(`${process.env.WEB_PROTOCOL}://${process.env.WEB_RESET_ADDRESS}?email=${record.email}&token=${record.token}`);
|
||||||
|
return null;
|
||||||
|
};
|
||||||
|
|
||||||
|
module.exports = route;
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
//libraries
|
||||||
|
const bcrypt = require('bcryptjs');
|
||||||
|
|
||||||
|
const { accounts, recovery } = require('../database/models');
|
||||||
|
|
||||||
|
//auth/reset
|
||||||
|
const route = async (req, res) => {
|
||||||
|
//validate the given details
|
||||||
|
const validateErr = await validateDetails(req.query, req.body);
|
||||||
|
if (validateErr) {
|
||||||
|
return res.status(401).send(validateErr);
|
||||||
|
}
|
||||||
|
|
||||||
|
//generate the password hash
|
||||||
|
const hash = await bcrypt.hash(req.body.password, await bcrypt.genSalt(11));
|
||||||
|
|
||||||
|
//update the account data
|
||||||
|
await accounts.update({
|
||||||
|
hash: hash
|
||||||
|
}, {
|
||||||
|
where: {
|
||||||
|
email: req.query.email
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
//delete from the recovery table
|
||||||
|
await recovery.destroy({
|
||||||
|
where: {
|
||||||
|
email: req.query.email
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
res.status(200).end();
|
||||||
|
return null;
|
||||||
|
};
|
||||||
|
|
||||||
|
const validateDetails = async (query, body) => {
|
||||||
|
//verify the recovery record exists
|
||||||
|
const record = await recovery.findOne({
|
||||||
|
where: {
|
||||||
|
email: query.email,
|
||||||
|
token: query.token
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!record) {
|
||||||
|
return 'Failed to recover a password';
|
||||||
|
}
|
||||||
|
|
||||||
|
//validate password
|
||||||
|
if (!body.password) {
|
||||||
|
return 'Missing password';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (body.password.length < 8) {
|
||||||
|
return 'Password too short';
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
};
|
||||||
|
|
||||||
|
module.exports = route;
|
||||||
+20
-16
@@ -6,7 +6,6 @@ const Op = Sequelize.Op;
|
|||||||
|
|
||||||
const { accounts, pendingSignups } = require('../database/models');
|
const { accounts, pendingSignups } = require('../database/models');
|
||||||
|
|
||||||
|
|
||||||
//utilities
|
//utilities
|
||||||
const uuid = require('../utilities/uuid');
|
const uuid = require('../utilities/uuid');
|
||||||
const validateEmail = require('../utilities/validate-email');
|
const validateEmail = require('../utilities/validate-email');
|
||||||
@@ -46,16 +45,13 @@ const route = async (req, res) => {
|
|||||||
const validateDetails = async (body) => {
|
const validateDetails = async (body) => {
|
||||||
//basic formatting
|
//basic formatting
|
||||||
if (!validateEmail(body.email)) {
|
if (!validateEmail(body.email)) {
|
||||||
return 'invalid email';
|
return 'Invalid email';
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!validateUsername(body.username)) {
|
if (!validateUsername(body.username)) {
|
||||||
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: {
|
||||||
@@ -64,23 +60,31 @@ const validateDetails = async (body) => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
if (emailRecord) {
|
if (emailRecord) {
|
||||||
return 'email already exists';
|
return 'Email already exists';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!body.username) {
|
||||||
|
return 'Missing username';
|
||||||
}
|
}
|
||||||
|
|
||||||
//check for existing username
|
//check for existing username
|
||||||
const usernameRecord = await accounts.findOne({
|
const usernameRecord = await accounts.findOne({
|
||||||
where: {
|
where: {
|
||||||
username: body.username || ''
|
username: body.username
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
if (usernameRecord) {
|
if (usernameRecord) {
|
||||||
return 'username already exists';
|
return 'Username already exists';
|
||||||
}
|
}
|
||||||
|
|
||||||
//validate password
|
//validate password
|
||||||
|
if (!body.password) {
|
||||||
|
return 'Missing password';
|
||||||
|
}
|
||||||
|
|
||||||
if (body.password.length < 8) {
|
if (body.password.length < 8) {
|
||||||
return 'password too short';
|
return 'Password too short';
|
||||||
}
|
}
|
||||||
|
|
||||||
return null;
|
return null;
|
||||||
@@ -100,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;
|
||||||
|
|
||||||
|
|||||||
@@ -1,16 +1,16 @@
|
|||||||
const jwt = require('jsonwebtoken');
|
const jwt = require('jsonwebtoken');
|
||||||
|
|
||||||
const refresh = require('../utilities/token-refresh');
|
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;
|
const refreshToken = req.body.token;
|
||||||
|
|
||||||
return refresh(refreshToken, (err, tokens) => {
|
return tokenRefresh(refreshToken, (err, token) => {
|
||||||
if (err) {
|
if (err) {
|
||||||
return res.status(err).end();
|
return res.status(err).end();
|
||||||
}
|
}
|
||||||
|
|
||||||
return res.status(200).send(tokens);
|
return res.status(200).send(token);
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
const { pendingSignups, accounts } = require('../database/models');
|
const { pendingSignups, accounts } = require('../database/models');
|
||||||
|
const fetch = require('node-fetch');
|
||||||
|
|
||||||
//auth/validation
|
//auth/validation
|
||||||
const route = async (req, res) => {
|
const route = async (req, res) => {
|
||||||
@@ -11,15 +12,15 @@ const route = async (req, res) => {
|
|||||||
|
|
||||||
//check the given info
|
//check the given info
|
||||||
if (!info) {
|
if (!info) {
|
||||||
return res.status(401).send('validation failed');
|
return res.status(401).send('Validation failed');
|
||||||
}
|
}
|
||||||
|
|
||||||
if (info.token != req.query.token) {
|
if (info.token != req.query.token) {
|
||||||
return res.status(401).send('tokens do not match');
|
return res.status(401).send('Tokens do not match');
|
||||||
}
|
}
|
||||||
|
|
||||||
//move data to the accounts table
|
//move data to the accounts table
|
||||||
accounts.create({
|
const account = await accounts.create({
|
||||||
email: info.email,
|
email: info.email,
|
||||||
username: info.username,
|
username: info.username,
|
||||||
hash: info.hash,
|
hash: info.hash,
|
||||||
@@ -29,12 +30,23 @@ 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 || ''
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
//finally
|
//finally
|
||||||
res.status(200).send('Validation succeeded!');
|
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 (!probe.ok) {
|
||||||
|
console.error('Could not probe the post validation hook');
|
||||||
|
}
|
||||||
|
|
||||||
|
//discard the result
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
module.exports = route;
|
module.exports = route;
|
||||||
@@ -1,5 +1,6 @@
|
|||||||
module.exports = {
|
module.exports = {
|
||||||
tokens: require('./tokens'),
|
tokens: require('./tokens'),
|
||||||
accounts: require('./accounts'),
|
accounts: require('./accounts'),
|
||||||
pendingSignups: require('./pending-signups')
|
pendingSignups: require('./pending-signups'),
|
||||||
|
recovery: require('./recovery')
|
||||||
};
|
};
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
const sequelize = require('..');
|
||||||
|
|
||||||
|
module.exports = sequelize.define('recovery', {
|
||||||
|
token: 'varchar(320)',
|
||||||
|
email: 'varchar(320)'
|
||||||
|
});
|
||||||
@@ -3,5 +3,5 @@ const sequelize = require('..');
|
|||||||
|
|
||||||
module.exports = sequelize.define('tokens', {
|
module.exports = sequelize.define('tokens', {
|
||||||
token: 'varchar(320)',
|
token: 'varchar(320)',
|
||||||
username: 'varchar(320)' //TODO: why username?
|
email: 'varchar(320)'
|
||||||
});
|
});
|
||||||
|
|||||||
+32
-32
@@ -1,32 +1,32 @@
|
|||||||
//environment variables
|
//environment variables
|
||||||
require('dotenv').config();
|
require('dotenv').config();
|
||||||
|
|
||||||
//create the server
|
//create the server
|
||||||
const express = require('express');
|
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');
|
||||||
|
|
||||||
//config
|
//config
|
||||||
app.use(express.json());
|
app.use(express.json());
|
||||||
app.use(cors());
|
app.use(cors());
|
||||||
|
|
||||||
//database connection
|
//database connection
|
||||||
const database = require('./database');
|
const database = require('./database');
|
||||||
|
|
||||||
//access the admin
|
//access the admin
|
||||||
app.use('/admin', require('./admin'));
|
app.use('/admin', require('./admin'));
|
||||||
|
|
||||||
//access the auth
|
//access the auth
|
||||||
app.use('/auth', require('./auth'));
|
app.use('/auth', require('./auth'));
|
||||||
|
|
||||||
//error on access
|
//error on access
|
||||||
app.get('*', (req, res) => {
|
app.get('*', (req, res) => {
|
||||||
res.redirect('https://github.com/krgamestudios/auth-server');
|
res.redirect('https://github.com/krgamestudios/auth-server');
|
||||||
});
|
});
|
||||||
|
|
||||||
//startup
|
//startup
|
||||||
server.listen(process.env.WEB_PORT || 3200, async (err) => {
|
server.listen(process.env.WEB_PORT || 3200, async (err) => {
|
||||||
await database.sync();
|
await database.sync();
|
||||||
console.log(`listening to localhost:${process.env.WEB_PORT || 3200}`);
|
console.log(`listening to localhost:${process.env.WEB_PORT || 3200}`);
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -2,19 +2,20 @@ const jwt = require('jsonwebtoken');
|
|||||||
const { tokens } = require('../database/models');
|
const { tokens } = require('../database/models');
|
||||||
|
|
||||||
//generates a JWT token based on the given arguments
|
//generates a JWT token based on the given arguments
|
||||||
module.exports = (index, username, type, admin, mod) => {
|
module.exports = (index, email, username, type, admin, mod) => {
|
||||||
const content = {
|
const content = {
|
||||||
index,
|
index,
|
||||||
|
email,
|
||||||
username,
|
username,
|
||||||
type,
|
type,
|
||||||
admin,
|
admin,
|
||||||
mod,
|
mod,
|
||||||
};
|
};
|
||||||
|
|
||||||
const accessToken = jwt.sign(content, process.env.SECRET_ACCESS, { expiresIn: '10m' });
|
const accessToken = jwt.sign(content, process.env.SECRET_ACCESS, { expiresIn: '10m', issuer: 'auth' });
|
||||||
const refreshToken = jwt.sign(content, process.env.SECRET_REFRESH, { expiresIn: '30d' });
|
const refreshToken = jwt.sign(content, process.env.SECRET_REFRESH, { expiresIn: '30d', issuer: 'auth' });
|
||||||
|
|
||||||
tokens.create({ token: refreshToken, username: username });
|
tokens.create({ token: refreshToken, email: email });
|
||||||
|
|
||||||
return { accessToken, refreshToken };
|
return { accessToken, refreshToken };
|
||||||
};
|
};
|
||||||
@@ -4,12 +4,12 @@ const { tokens } = require('../database/models');
|
|||||||
const generate = require('./token-generate');
|
const generate = require('./token-generate');
|
||||||
const destroy = require('./token-destroy');
|
const destroy = require('./token-destroy');
|
||||||
|
|
||||||
module.exports = (token, callback) => {
|
module.exports = async (token, callback) => {
|
||||||
if (!token) {
|
if (!token) {
|
||||||
return callback(401);
|
return callback(401);
|
||||||
}
|
}
|
||||||
|
|
||||||
const tokenRecord = tokens.findOne({
|
const tokenRecord = await tokens.findOne({
|
||||||
where: {
|
where: {
|
||||||
token: token || ''
|
token: token || ''
|
||||||
}
|
}
|
||||||
@@ -24,7 +24,7 @@ module.exports = (token, callback) => {
|
|||||||
return callback(403);
|
return callback(403);
|
||||||
}
|
}
|
||||||
|
|
||||||
const result = generate(user.index, user.username, user.type, user.admin, user.mod);
|
const result = generate(user.index, user.email, user.username, user.type, user.admin, user.mod);
|
||||||
|
|
||||||
destroy(token);
|
destroy(token);
|
||||||
|
|
||||||
|
|||||||
+10
-10
@@ -1,34 +1,34 @@
|
|||||||
#Signup
|
#Signup
|
||||||
POST https://dev-auth.eggtrainer.com/auth/signup HTTP/1.1
|
POST https://dev-auth.krgamestudios.com/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"
|
||||||
}
|
}
|
||||||
|
|
||||||
###
|
###
|
||||||
|
|
||||||
#Login
|
#Login
|
||||||
POST https://dev-auth.eggtrainer.com/auth/login HTTP/1.1
|
POST https://dev-auth.krgamestudios.com/auth/login HTTP/1.1
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
|
|
||||||
{
|
{
|
||||||
"email": "kayneruse@gmail.com",
|
"email": "example@example.com",
|
||||||
"password": "helloworld"
|
"password": "helloworld"
|
||||||
}
|
}
|
||||||
|
|
||||||
###
|
###
|
||||||
|
|
||||||
#Query data
|
#Query data
|
||||||
GET https://dev-auth.eggtrainer.com/auth/account HTTP/1.1
|
GET https://dev-auth.krgamestudios.com/auth/account HTTP/1.1
|
||||||
Authorization: Bearer
|
Authorization: Bearer
|
||||||
|
|
||||||
###
|
###
|
||||||
|
|
||||||
#Logout
|
#Logout
|
||||||
DELETE https://dev-auth.eggtrainer.com/auth/logout HTTP/1.1
|
DELETE https://dev-auth.krgamestudios.com/auth/logout HTTP/1.1
|
||||||
Authorization: Bearer
|
Authorization: Bearer
|
||||||
|
|
||||||
{
|
{
|
||||||
@@ -38,7 +38,7 @@ Authorization: Bearer
|
|||||||
###
|
###
|
||||||
|
|
||||||
#Refresh
|
#Refresh
|
||||||
POST https://dev-auth.eggtrainer.com/auth/token HTTP/1.1
|
POST https://dev-auth.krgamestudios.com/auth/token HTTP/1.1
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
|
|
||||||
{
|
{
|
||||||
@@ -48,7 +48,7 @@ Content-Type: application/json
|
|||||||
###
|
###
|
||||||
|
|
||||||
#Update account data
|
#Update account data
|
||||||
PATCH https://dev-auth.eggtrainer.com/auth/update HTTP/1.1
|
PATCH https://dev-auth.krgamestudios.com/auth/update HTTP/1.1
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
Authorization: Bearer
|
Authorization: Bearer
|
||||||
|
|
||||||
@@ -59,7 +59,7 @@ Authorization: Bearer
|
|||||||
###
|
###
|
||||||
|
|
||||||
#Delete account
|
#Delete account
|
||||||
DELETE https://dev-auth.eggtrainer.com/auth/deletion HTTP/1.1
|
DELETE https://dev-auth.krgamestudios.com/auth/deletion HTTP/1.1
|
||||||
Authorization: Bearer
|
Authorization: Bearer
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
|
|
||||||
|
|||||||
@@ -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,7 +15,7 @@ POST http://127.0.0.1:3200/auth/login HTTP/1.1
|
|||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
|
|
||||||
{
|
{
|
||||||
"email": "kayneruse@gmail.com",
|
"email": "example@example.com",
|
||||||
"password": "helloworld"
|
"password": "helloworld"
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -66,3 +66,5 @@ Content-Type: application/json
|
|||||||
{
|
{
|
||||||
"password": "helloworld"
|
"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'@'%';
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
ALTER TABLE `accounts` CHANGE `id` `index` INT( 11 ) NOT NULL AUTO_INCREMENT;
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
DROP TABLE tokens;
|
||||||
@@ -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 authTokens 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
|
||||||
|
|
||||||
@@ -0,0 +1,127 @@
|
|||||||
|
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('');
|
||||||
|
const [refreshToken, setRefreshToken] = useState('');
|
||||||
|
|
||||||
|
//make the access and refresh tokens 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]);
|
||||||
|
|
||||||
|
//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: {
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
'Access-Control-Allow-Origin': '*',
|
||||||
|
'Authorization': `Bearer ${bearer}`
|
||||||
|
},
|
||||||
|
body: JSON.stringify({
|
||||||
|
token: refreshToken
|
||||||
|
})
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
//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
|
||||||
|
})
|
||||||
|
});
|
||||||
|
|
||||||
|
//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);
|
||||||
|
setRefreshToken(newAuth.refreshToken);
|
||||||
|
bearer = newAuth.accessToken;
|
||||||
|
}
|
||||||
|
|
||||||
|
//finally, delegate to fetch
|
||||||
|
return fetch(url, {
|
||||||
|
...(options || {}),
|
||||||
|
headers: {
|
||||||
|
...(options || { headers: {} }).headers,
|
||||||
|
'Authorization': `Bearer ${bearer}`
|
||||||
|
}
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
//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',
|
||||||
|
headers: {
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
'Access-Control-Allow-Origin': '*'
|
||||||
|
},
|
||||||
|
body: JSON.stringify({
|
||||||
|
token: refreshToken
|
||||||
|
})
|
||||||
|
});
|
||||||
|
|
||||||
|
//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);
|
||||||
|
setRefreshToken(newAuth.refreshToken);
|
||||||
|
|
||||||
|
//finally
|
||||||
|
return cb(newAuth.accessToken);
|
||||||
|
} else {
|
||||||
|
return cb(accessToken);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<TokenContext.Provider value={{ accessToken, refreshToken, setAccessToken, setRefreshToken, tokenFetch, tokenCallback, getPayload: () => decode(accessToken) }}>
|
||||||
|
{props.children}
|
||||||
|
</TokenContext.Provider>
|
||||||
|
)
|
||||||
|
};
|
||||||
|
|
||||||
|
export default TokenProvider;
|
||||||
Reference in New Issue
Block a user