Fix/login limit (By Vincent) (#191)

This PR is originally by @Vincent23412 from #190 . Edited by @lancatlin
This commit is contained in:
Justin Lin authored and GitHub committed 2025-04-27 16:43:56 +08:00
commit 61cb36f357
7 files changed
+124 -14

No files matched your search

+3 -3
View File
@@ -24,6 +24,9 @@ ADMIN_PORT=3001
# TRUSTED_PROXIES=1.2.3.4 # TRUSTED_PROXIES=1.2.3.4
# valid configurations see isIP & isIPRange in https://github.com/validatorjs/validator.js?tab=readme-ov-file#validators # valid configurations see isIP & isIPRange in https://github.com/validatorjs/validator.js?tab=readme-ov-file#validators
# RATE_LIMIT_MAX_FAILED_ATTEMPTS=5
# RATE_LIMIT_LOCKOUT_TIME=10
# GOOGLE_CLIENT_ID= # GOOGLE_CLIENT_ID=
# GOOGLE_CLIENT_SECRET= # GOOGLE_CLIENT_SECRET=
# GITHUB_CLIENT_ID= # GITHUB_CLIENT_ID=
@@ -31,9 +34,6 @@ ADMIN_PORT=3001
# SURVEY_URL= # SURVEY_URL=
# BUG_REPORT_URL= # BUG_REPORT_URL=
# SURVEY_URL=
# BUG_REPORT_URL=
# Docker related config # Docker related config
# DOCKER_NETWORK=host # DOCKER_NETWORK=host
# QUEST_IMAGE=linuxodyssey/quest-base # QUEST_IMAGE=linuxodyssey/quest-base
+3 -3
View File
@@ -12,6 +12,9 @@ DOCKER_NETWORK=linux-odyssey-players-dev
# TRUSTED_PROXIES=1.2.3.4 # TRUSTED_PROXIES=1.2.3.4
# valid configurations see isIP & isIPRange in https://github.com/validatorjs/validator.js?tab=readme-ov-file#validators # valid configurations see isIP & isIPRange in https://github.com/validatorjs/validator.js?tab=readme-ov-file#validators
# RATE_LIMIT_MAX_FAILED_ATTEMPTS=5
# RATE_LIMIT_LOCKOUT_TIME=10
# GOOGLE_CLIENT_ID= # GOOGLE_CLIENT_ID=
# GOOGLE_CLIENT_SECRET= # GOOGLE_CLIENT_SECRET=
# GITHUB_CLIENT_ID= # GITHUB_CLIENT_ID=
@@ -19,9 +22,6 @@ DOCKER_NETWORK=linux-odyssey-players-dev
# SURVEY_URL= # SURVEY_URL=
# BUG_REPORT_URL= # BUG_REPORT_URL=
# SURVEY_URL=
# BUG_REPORT_URL=
# Docker related config # Docker related config
# DOCKER_NETWORK=host # DOCKER_NETWORK=host
# QUEST_IMAGE=linuxodyssey/quest-base # QUEST_IMAGE=linuxodyssey/quest-base
+1
View File
@@ -4,6 +4,7 @@ export { User, IUser } from './user.js'
export { Session, ISession } from './session.js' export { Session, ISession } from './session.js'
export { Command, ICommand } from './command.js' export { Command, ICommand } from './command.js'
export { UserProfile, IUserProfile, IProgress } from './userProfile.js' export { UserProfile, IUserProfile, IProgress } from './userProfile.js'
export { ILoginAttempt, LoginAttempt } from './loginAttempt.js'
export async function connectDB(uri: string) { export async function connectDB(uri: string) {
const db = await mongoose.connect(uri) const db = await mongoose.connect(uri)
+29
View File
@@ -0,0 +1,29 @@
import { model, Schema, Document } from 'mongoose'
export interface ILoginAttempt {
username: string
ip: string
userAgent: string
time: Date
success: boolean
message: string
}
export type LoginAttemptDocument = ILoginAttempt & Document
const LoginAttemptSchema = new Schema<LoginAttemptDocument>(
{
username: { type: String, required: true },
ip: { type: String, required: true },
userAgent: { type: String, required: true },
time: { type: Date, default: Date.now, required: true },
success: { type: Boolean, required: true },
message: { type: String },
},
{ timestamps: true }
)
export const LoginAttempt = model<LoginAttemptDocument>(
'LoginAttempt',
LoginAttemptSchema
)
+46 -6
View File
@@ -1,6 +1,7 @@
import { Router, Request, Response } from 'express' import { Router, Request, Response, Express } from 'express'
import passport from 'passport' import passport from 'passport'
import { NextFunction } from 'express-serve-static-core'
import { LoginAttempt } from '../../../../packages/models'
import enabledMethods from '../../auth/passport.js' import enabledMethods from '../../auth/passport.js'
import { import {
@@ -17,20 +18,59 @@ import {
registerFromSessionValidators, registerFromSessionValidators,
registerValidators, registerValidators,
} from '../validators/authValidator.js' } from '../validators/authValidator.js'
import { authenticateRateLimit } from '../../middleware/rateLimiter.js' import {
authenticateRateLimit,
rateLimitByAccount,
} from '../../middleware/rateLimiter.js'
const router = Router() const router = Router()
router.post( router.post(
'/login', '/login',
authenticateRateLimit, authenticateRateLimit,
rateLimitByAccount,
loginValidators, loginValidators,
passport.authenticate('local', { failureMessage: true }), (req: Request, res: Response, next: NextFunction): void => {
(req: Request, res: Response) => { passport.authenticate(
res.json({ message: 'success' }) 'local',
async (err: unknown, user: Express.User | false, info: any) => {
if (err) {
await recordLogin(req, false, 'passport error')
return next(err)
}
if (!user) {
const msg = info?.message || 'invalid credentials'
await recordLogin(req, false, msg)
return res.status(401).json({ message: msg })
}
req.logIn(user, async (loginErr: unknown) => {
if (loginErr) {
await recordLogin(req, false, 'login session failed')
return next(loginErr)
}
await recordLogin(req, true, 'login success')
return res.json({ message: 'success' })
})
return null
}
)(req, res, next)
} }
) )
async function recordLogin(req: Request, success: boolean, message: string) {
await LoginAttempt.create({
ip: req.ip,
userAgent: req.headers['user-agent'] || '',
success,
time: new Date(),
username: req.body.username,
message,
})
}
router.post('/register', authenticateRateLimit, registerValidators, register) router.post('/register', authenticateRateLimit, registerValidators, register)
router.post('/register-guest', authenticateRateLimit, registerGuest) router.post('/register-guest', authenticateRateLimit, registerGuest)
+7
View File
@@ -68,6 +68,13 @@ function createConfig() {
trustedProxies: getTrustProxies('TRUSTED_PROXIES'), trustedProxies: getTrustProxies('TRUSTED_PROXIES'),
surveyUrl: getUrl('SURVEY_URL'), surveyUrl: getUrl('SURVEY_URL'),
bugReportUrl: getUrl('BUG_REPORT_URL'), bugReportUrl: getUrl('BUG_REPORT_URL'),
rateLimit: {
maxFailedAttempts: Number(
process.env.RATE_LIMIT_MAX_FAILED_ATTEMPTS ?? 5
),
lockoutTime:
Number(process.env.RATE_LIMIT_LOCKOUT_TIME ?? 10) * 60 * 1000,
},
projectRoot, projectRoot,
+35 -2
View File
@@ -2,6 +2,8 @@ import rateLimit from 'express-rate-limit'
import type { Options } from 'express-rate-limit' import type { Options } from 'express-rate-limit'
import type { Request, Response, NextFunction } from 'express' import type { Request, Response, NextFunction } from 'express'
import config from '../config.js' import config from '../config.js'
import { LoginAttempt } from '../../../packages/models'
import logger from '../utils/logger.js'
function createRateLimiter(options: Partial<Options>) { function createRateLimiter(options: Partial<Options>) {
if (config.testing.enabled) { if (config.testing.enabled) {
@@ -11,12 +13,12 @@ function createRateLimiter(options: Partial<Options>) {
} }
export const globalRateLimit = createRateLimiter({ export const globalRateLimit = createRateLimiter({
windowMs: 60 * 1000, // 1 minute windowMs: 60 * 1000,
max: 100, max: 100,
}) })
export const authenticateRateLimit = createRateLimiter({ export const authenticateRateLimit = createRateLimiter({
windowMs: 2 * 60 * 1000, windowMs: 10 * 1000,
max: 5, max: 5,
}) })
@@ -27,3 +29,34 @@ export const sessionRateLimit = createRateLimiter({
return req.user ? (req.user as any)._id : req.ip || '' return req.user ? (req.user as any)._id : req.ip || ''
}, },
}) })
export async function rateLimitByAccount(
req: Request,
res: Response,
next: NextFunction
) {
const username = req.body.username?.trim()
if (!username) {
return next()
}
const since = new Date(Date.now() - config.rateLimit.lockoutTime)
const recentFailedCount = await LoginAttempt.countDocuments({
username,
success: false,
ip: req.ip,
time: { $gte: since },
})
if (recentFailedCount >= config.rateLimit.maxFailedAttempts) {
logger.warn(
`Too many failed login attempts for "${username}" from ${req.ip}`
)
return res.status(429).json({
error: 'Too many failed login attempts. Please try again later.',
})
}
return next()
}