mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-17 17:00:15 +01:00
* feat: Implement Redis-based rate limiting, initially import limits * feat: Enhance rate limiters with Redis support and custom prefixes * chore: import orders * chore: update JSDoc for next middleware parameter type in ban and limiter middleware * feat: add logHeaders middleware to log forwarded headers in requests * refactor: change log level from info to debug for Redis rate limiters * feat: increase Redis max listeners and refactor session storage to use Keyv
100 lines
3.2 KiB
JavaScript
100 lines
3.2 KiB
JavaScript
const Keyv = require('keyv');
|
|
const rateLimit = require('express-rate-limit');
|
|
const { RedisStore } = require('rate-limit-redis');
|
|
const { ViolationTypes } = require('librechat-data-provider');
|
|
const logViolation = require('~/cache/logViolation');
|
|
const { isEnabled } = require('~/server/utils');
|
|
const keyvRedis = require('~/cache/keyvRedis');
|
|
const { logger } = require('~/config');
|
|
|
|
const getEnvironmentVariables = () => {
|
|
const FILE_UPLOAD_IP_MAX = parseInt(process.env.FILE_UPLOAD_IP_MAX) || 100;
|
|
const FILE_UPLOAD_IP_WINDOW = parseInt(process.env.FILE_UPLOAD_IP_WINDOW) || 15;
|
|
const FILE_UPLOAD_USER_MAX = parseInt(process.env.FILE_UPLOAD_USER_MAX) || 50;
|
|
const FILE_UPLOAD_USER_WINDOW = parseInt(process.env.FILE_UPLOAD_USER_WINDOW) || 15;
|
|
|
|
const fileUploadIpWindowMs = FILE_UPLOAD_IP_WINDOW * 60 * 1000;
|
|
const fileUploadIpMax = FILE_UPLOAD_IP_MAX;
|
|
const fileUploadIpWindowInMinutes = fileUploadIpWindowMs / 60000;
|
|
|
|
const fileUploadUserWindowMs = FILE_UPLOAD_USER_WINDOW * 60 * 1000;
|
|
const fileUploadUserMax = FILE_UPLOAD_USER_MAX;
|
|
const fileUploadUserWindowInMinutes = fileUploadUserWindowMs / 60000;
|
|
|
|
return {
|
|
fileUploadIpWindowMs,
|
|
fileUploadIpMax,
|
|
fileUploadIpWindowInMinutes,
|
|
fileUploadUserWindowMs,
|
|
fileUploadUserMax,
|
|
fileUploadUserWindowInMinutes,
|
|
};
|
|
};
|
|
|
|
const createFileUploadHandler = (ip = true) => {
|
|
const {
|
|
fileUploadIpMax,
|
|
fileUploadIpWindowInMinutes,
|
|
fileUploadUserMax,
|
|
fileUploadUserWindowInMinutes,
|
|
} = getEnvironmentVariables();
|
|
|
|
return async (req, res) => {
|
|
const type = ViolationTypes.FILE_UPLOAD_LIMIT;
|
|
const errorMessage = {
|
|
type,
|
|
max: ip ? fileUploadIpMax : fileUploadUserMax,
|
|
limiter: ip ? 'ip' : 'user',
|
|
windowInMinutes: ip ? fileUploadIpWindowInMinutes : fileUploadUserWindowInMinutes,
|
|
};
|
|
|
|
await logViolation(req, res, type, errorMessage);
|
|
res.status(429).json({ message: 'Too many file upload requests. Try again later' });
|
|
};
|
|
};
|
|
|
|
const createFileLimiters = () => {
|
|
const { fileUploadIpWindowMs, fileUploadIpMax, fileUploadUserWindowMs, fileUploadUserMax } =
|
|
getEnvironmentVariables();
|
|
|
|
const ipLimiterOptions = {
|
|
windowMs: fileUploadIpWindowMs,
|
|
max: fileUploadIpMax,
|
|
handler: createFileUploadHandler(),
|
|
};
|
|
|
|
const userLimiterOptions = {
|
|
windowMs: fileUploadUserWindowMs,
|
|
max: fileUploadUserMax,
|
|
handler: createFileUploadHandler(false),
|
|
keyGenerator: function (req) {
|
|
return req.user?.id; // Use the user ID or NULL if not available
|
|
},
|
|
};
|
|
|
|
if (isEnabled(process.env.USE_REDIS)) {
|
|
logger.debug('Using Redis for file upload rate limiters.');
|
|
const keyv = new Keyv({ store: keyvRedis });
|
|
const client = keyv.opts.store.redis;
|
|
const sendCommand = (...args) => client.call(...args);
|
|
const ipStore = new RedisStore({
|
|
sendCommand,
|
|
prefix: 'file_upload_ip_limiter:',
|
|
});
|
|
const userStore = new RedisStore({
|
|
sendCommand,
|
|
prefix: 'file_upload_user_limiter:',
|
|
});
|
|
ipLimiterOptions.store = ipStore;
|
|
userLimiterOptions.store = userStore;
|
|
}
|
|
|
|
const fileUploadIpLimiter = rateLimit(ipLimiterOptions);
|
|
const fileUploadUserLimiter = rateLimit(userLimiterOptions);
|
|
|
|
return { fileUploadIpLimiter, fileUploadUserLimiter };
|
|
};
|
|
|
|
module.exports = {
|
|
createFileLimiters,
|
|
};
|