Merge pull request #132 from AlecM33/html-page-rate-limit

rate limit routes to html pages
This commit is contained in:
Alec
2022-12-10 23:56:38 -05:00
committed by GitHub
4 changed files with 59 additions and 68 deletions

View File

@@ -6,33 +6,9 @@ const socketManager = new (require('../modules/SocketManager.js'))().getInstance
const gameManager = new (require('../modules/GameManager.js'))().getInstance(); const gameManager = new (require('../modules/GameManager.js'))().getInstance();
const globals = require('../config/globals.js'); const globals = require('../config/globals.js');
const cors = require('cors'); const cors = require('cors');
const rateLimit = require('express-rate-limit').default;
const KEY = process.env.NODE_ENV.trim() === 'development'
? globals.MOCK_AUTH
: process.env.ADMIN_KEY;
const apiLimiter = rateLimit({
windowMs: 60000,
max: 50,
standardHeaders: true,
legacyHeaders: false
});
if (process.env.NODE_ENV.trim() === 'production') {
router.use(apiLimiter);
}
router.use(cors(globals.CORS)); router.use(cors(globals.CORS));
router.use((req, res, next) => {
if (isAuthorized(req)) {
next();
} else {
res.status(401).send('You are not authorized to make this request.');
}
});
router.post('/sockets/broadcast', (req, res, next) => { router.post('/sockets/broadcast', (req, res, next) => {
globals.CONTENT_TYPE_VALIDATOR(req, res, next); globals.CONTENT_TYPE_VALIDATOR(req, res, next);
}); });
@@ -52,16 +28,4 @@ router.get('/games/state', function (req, res) {
res.status(200).send(gamesArray); res.status(200).send(gamesArray);
}); });
/* validates Bearer Auth */
function isAuthorized (req) {
const header = req.headers.authorization;
if (header) {
const token = header.split(/\s+/).pop() || '';
const decodedToken = Buffer.from(token, 'base64').toString();
return decodedToken.trim() === KEY.trim();
}
return false;
}
module.exports = router; module.exports = router;

View File

@@ -9,16 +9,13 @@ const cors = require('cors');
const gameManager = new GameManager().getInstance(); const gameManager = new GameManager().getInstance();
const apiLimiter = rateLimit({ const gameCreationLimit = process.env.NODE_ENV.trim() === 'production'
windowMs: 60000, ? 20
max: 100, : 1000;
standardHeaders: true,
legacyHeaders: false
});
const gameEndpointLimiter = rateLimit({ // further limit the rate of game creation to 30 games per 10 minutes. const gameEndpointLimiter = rateLimit({
windowMs: 600000, windowMs: 600000,
max: 30, max: gameCreationLimit,
standardHeaders: true, standardHeaders: true,
legacyHeaders: false legacyHeaders: false
}); });
@@ -38,12 +35,7 @@ router.patch('/restart', (req, res, next) => {
globals.CONTENT_TYPE_VALIDATOR(req, res, next); globals.CONTENT_TYPE_VALIDATOR(req, res, next);
}); });
if (process.env.NODE_ENV.trim() === 'production') { router.post('/create', gameEndpointLimiter, function (req, res) {
router.use(apiLimiter);
router.use('/create', gameEndpointLimiter);
}
router.post('/create', function (req, res) {
logger.debug('Received request to create new game: ' + JSON.stringify(req.body, null, 4)); logger.debug('Received request to create new game: ' + JSON.stringify(req.body, null, 4));
const gameCreationPromise = gameManager.createGame(req.body, false); const gameCreationPromise = gameManager.createGame(req.body, false);
gameCreationPromise.then((result) => { gameCreationPromise.then((result) => {

View File

@@ -6,7 +6,9 @@ const fs = require('fs');
const crypto = require('crypto'); const crypto = require('crypto');
const SocketManager = require('./SocketManager.js'); const SocketManager = require('./SocketManager.js');
const GameManager = require('./GameManager.js'); const GameManager = require('./GameManager.js');
const globals = require('../config/globals.js');
const { ENVIRONMENT } = require('../config/globals.js'); const { ENVIRONMENT } = require('../config/globals.js');
const rateLimit = require('express-rate-limit').default;
const ServerBootstrapper = { const ServerBootstrapper = {
@@ -93,22 +95,33 @@ const ServerBootstrapper = {
}, },
establishRouting: (app, express) => { establishRouting: (app, express) => {
/* api endpoints */ const standardRateLimit = rateLimit({
const games = require('../api/GamesAPI'); windowMs: 60000,
const admin = require('../api/AdminAPI'); max: 100,
app.use('/api/games', games); standardHeaders: true,
app.use('/api/admin', admin); legacyHeaders: false
});
/* serve all the app's pages */ // API endpoints
app.use('/manifest.json', (req, res) => { app.use('/api/games', standardRateLimit, require('../api/GamesAPI'));
app.use('/api/admin', (req, res, next) => {
if (isAuthorized(req)) {
next();
} else {
res.status(401).send('You are not authorized to make this request.');
}
}, standardRateLimit, require('../api/AdminAPI'));
// miscellaneous assets
app.use('/manifest.json', standardRateLimit, (req, res) => {
res.sendFile(path.join(__dirname, '../../manifest.json')); res.sendFile(path.join(__dirname, '../../manifest.json'));
}); });
app.use('/favicon.ico', (req, res) => { app.use('/favicon.ico', standardRateLimit, (req, res) => {
res.sendFile(path.join(__dirname, '../../client/favicon_package/favicon.ico')); res.sendFile(path.join(__dirname, '../../client/favicon_package/favicon.ico'));
}); });
app.use('/apple-touch-icon.png', (req, res) => { app.use('/apple-touch-icon.png', standardRateLimit, (req, res) => {
res.sendFile(path.join(__dirname, '../../client/favicon_package/apple-touch-icon.png')); res.sendFile(path.join(__dirname, '../../client/favicon_package/apple-touch-icon.png'));
}); });
@@ -121,14 +134,28 @@ const ServerBootstrapper = {
app.use('/images', express.static(path.join(__dirname, '../../client/src/images'))); app.use('/images', express.static(path.join(__dirname, '../../client/src/images')));
app.use('/styles', express.static(path.join(__dirname, '../../client/src/styles'))); app.use('/styles', express.static(path.join(__dirname, '../../client/src/styles')));
app.use('/webfonts', express.static(path.join(__dirname, '../../client/src/webfonts'))); app.use('/webfonts', express.static(path.join(__dirname, '../../client/src/webfonts')));
app.use('/robots.txt', (req, res) => { app.use('/robots.txt', standardRateLimit, (req, res) => {
res.sendFile(path.join(__dirname, '../../client/robots.txt')); res.sendFile(path.join(__dirname, '../../client/robots.txt'));
}); });
app.use(function (req, res) { app.use(standardRateLimit, function (req, res) {
res.sendFile(path.join(__dirname, '../../client/src/views/404.html')); res.sendFile(path.join(__dirname, '../../client/src/views/404.html'));
}); });
} }
}; };
function isAuthorized (req) {
const KEY = process.env.NODE_ENV.trim() === 'development'
? globals.MOCK_AUTH
: process.env.ADMIN_KEY;
const header = req.headers.authorization;
if (header) {
const token = header.split(/\s+/).pop() || '';
const decodedToken = Buffer.from(token, 'base64').toString();
return decodedToken.trim() === KEY?.trim();
}
return false;
}
module.exports = ServerBootstrapper; module.exports = ServerBootstrapper;

View File

@@ -1,32 +1,40 @@
const express = require('express'); const express = require('express');
const router = express.Router({ strict: true }); const router = express.Router({ strict: true });
const path = require('path'); const path = require('path');
const rateLimit = require('express-rate-limit').default;
router.get('/', function (request, response) { const htmlPageLimiter = rateLimit({
windowMs: 60000,
max: 100,
standardHeaders: true,
legacyHeaders: false
});
router.get('/', htmlPageLimiter, function (request, response) {
response.sendFile(path.join(__dirname, '../../client/src/views/home.html')); response.sendFile(path.join(__dirname, '../../client/src/views/home.html'));
}); });
router.get('/create', function (request, response) { router.get('/create', htmlPageLimiter, function (request, response) {
response.sendFile(path.join(__dirname, '../../client/src/views/create.html')); response.sendFile(path.join(__dirname, '../../client/src/views/create.html'));
}); });
router.get('/join/:code', function (request, response) { router.get('/join/:code', htmlPageLimiter, function (request, response) {
response.sendFile(path.join(__dirname, '../../client/src/views/join.html')); response.sendFile(path.join(__dirname, '../../client/src/views/join.html'));
}); });
router.get('/how-to-use', function (request, response) { router.get('/how-to-use', htmlPageLimiter, function (request, response) {
response.sendFile(path.join(__dirname, '../../client/src/views/how-to-use.html')); response.sendFile(path.join(__dirname, '../../client/src/views/how-to-use.html'));
}); });
router.get('/game/:code', function (request, response) { router.get('/game/:code', htmlPageLimiter, function (request, response) {
response.sendFile(path.join(__dirname, '../../client/src/views/game.html')); response.sendFile(path.join(__dirname, '../../client/src/views/game.html'));
}); });
router.get('/liveness_check', (req, res) => { router.get('/liveness_check', htmlPageLimiter, (req, res) => {
res.sendStatus(200); res.sendStatus(200);
}); });
router.get('/readiness_check', (req, res) => { router.get('/readiness_check', htmlPageLimiter, (req, res) => {
res.sendStatus(200); res.sendStatus(200);
}); });