mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-03-22 07:36:33 +01:00
ecd6d76bc8
* fix: Add removePorts keyGenerator to all IP-based rate limiters Six IP-based rate limiters are missing the `keyGenerator: removePorts` option that is already used by the auth-related limiters (login, register, resetPassword, verifyEmail). Without it, reverse proxies that include ports in X-Forwarded-For headers cause ERR_ERL_INVALID_IP_ADDRESS errors from express-rate-limit. Fixes #12318 * fix: make removePorts IPv6-safe to prevent rate-limit key collisions The original regex `/:\d+[^:]*$/` treated the last colon-delimited segment of bare IPv6 addresses as a port, mangling valid IPs (e.g. `::1` → `::`, `2001:db8::1` → `2001:db8::`). Distinct IPv6 clients could collapse into the same rate-limit bucket. Use `net.isIP()` as a fast path for already-valid IPs, then match bracketed IPv6+port and IPv4+port explicitly. Bare IPv6 addresses are now returned unchanged. Also fixes pre-existing property ordering inconsistency in ttsLimiters.js userLimiterOptions (keyGenerator before store). * refactor: move removePorts to packages/api as TypeScript, fix import order - Move removePorts implementation to packages/api/src/utils/removePorts.ts with proper Express Request typing - Reduce api/server/utils/removePorts.js to a thin re-export from @librechat/api for backward compatibility - Consolidate removePorts import with limiterCache from @librechat/api in all 6 limiter files, fixing import order (package imports shortest to longest, local imports longest to shortest) - Remove narrating inline comments per code style guidelines --------- Co-authored-by: Danny Avila <danny@librechat.ai>
80 lines
2.1 KiB
JavaScript
80 lines
2.1 KiB
JavaScript
const rateLimit = require('express-rate-limit');
|
|
const { ViolationTypes } = require('librechat-data-provider');
|
|
const { limiterCache, removePorts } = require('@librechat/api');
|
|
const denyRequest = require('~/server/middleware/denyRequest');
|
|
const { logViolation } = require('~/cache');
|
|
|
|
const {
|
|
MESSAGE_IP_MAX = 40,
|
|
MESSAGE_IP_WINDOW = 1,
|
|
MESSAGE_USER_MAX = 40,
|
|
MESSAGE_USER_WINDOW = 1,
|
|
MESSAGE_VIOLATION_SCORE: score,
|
|
} = process.env;
|
|
|
|
const ipWindowMs = MESSAGE_IP_WINDOW * 60 * 1000;
|
|
const ipMax = MESSAGE_IP_MAX;
|
|
const ipWindowInMinutes = ipWindowMs / 60000;
|
|
|
|
const userWindowMs = MESSAGE_USER_WINDOW * 60 * 1000;
|
|
const userMax = MESSAGE_USER_MAX;
|
|
const userWindowInMinutes = userWindowMs / 60000;
|
|
|
|
/**
|
|
* Creates either an IP/User message request rate limiter for excessive requests
|
|
* that properly logs and denies the violation.
|
|
*
|
|
* @param {boolean} [ip=true] - Whether to create an IP limiter or a user limiter.
|
|
* @returns {function} A rate limiter function.
|
|
*
|
|
*/
|
|
const createHandler = (ip = true) => {
|
|
return async (req, res) => {
|
|
const type = ViolationTypes.MESSAGE_LIMIT;
|
|
const errorMessage = {
|
|
type,
|
|
max: ip ? ipMax : userMax,
|
|
limiter: ip ? 'ip' : 'user',
|
|
windowInMinutes: ip ? ipWindowInMinutes : userWindowInMinutes,
|
|
};
|
|
|
|
await logViolation(req, res, type, errorMessage, score);
|
|
return await denyRequest(req, res, errorMessage);
|
|
};
|
|
};
|
|
|
|
/**
|
|
* Message request rate limiters
|
|
*/
|
|
const ipLimiterOptions = {
|
|
windowMs: ipWindowMs,
|
|
max: ipMax,
|
|
handler: createHandler(),
|
|
keyGenerator: removePorts,
|
|
store: limiterCache('message_ip_limiter'),
|
|
};
|
|
|
|
const userLimiterOptions = {
|
|
windowMs: userWindowMs,
|
|
max: userMax,
|
|
handler: createHandler(false),
|
|
keyGenerator: function (req) {
|
|
return req.user?.id;
|
|
},
|
|
store: limiterCache('message_user_limiter'),
|
|
};
|
|
|
|
/**
|
|
* Message request rate limiter by IP
|
|
*/
|
|
const messageIpLimiter = rateLimit(ipLimiterOptions);
|
|
|
|
/**
|
|
* Message request rate limiter by userId
|
|
*/
|
|
const messageUserLimiter = rateLimit(userLimiterOptions);
|
|
|
|
module.exports = {
|
|
messageIpLimiter,
|
|
messageUserLimiter,
|
|
};
|