uptime-kuma/server/rate-limiter.js

76 lines
2 KiB
JavaScript
Raw Normal View History

2021-10-23 11:35:13 +03:00
const { RateLimiter } = require("limiter");
const { log } = require("../src/util");
2021-10-23 11:35:13 +03:00
class KumaRateLimiter {
/**
* @param {object} config Rate limiter configuration object
*/
2021-10-23 11:35:13 +03:00
constructor(config) {
this.errorMessage = config.errorMessage;
this.rateLimiter = new RateLimiter(config);
}
/**
* Callback for pass
* @callback passCB
* @param {object} err Too many requests
*/
/**
* Should the request be passed through
* @param {passCB} callback Callback function to call with decision
* @param {number} num Number of tokens to remove
* @returns {Promise<boolean>} Should the request be allowed?
*/
2021-10-23 11:35:13 +03:00
async pass(callback, num = 1) {
const remainingRequests = await this.removeTokens(num);
log.info("rate-limit", "remaining requests: " + remainingRequests);
2021-10-23 11:35:13 +03:00
if (remainingRequests < 0) {
if (callback) {
callback({
ok: false,
msg: this.errorMessage,
});
}
return false;
}
return true;
}
/**
* Remove a given number of tokens
* @param {number} num Number of tokens to remove
* @returns {Promise<number>} Number of remaining tokens
*/
2021-10-23 11:35:13 +03:00
async removeTokens(num = 1) {
return await this.rateLimiter.removeTokens(num);
}
}
const loginRateLimiter = new KumaRateLimiter({
tokensPerInterval: 20,
interval: "minute",
fireImmediately: true,
errorMessage: "Too frequently, try again later."
});
const apiRateLimiter = new KumaRateLimiter({
tokensPerInterval: 60,
interval: "minute",
fireImmediately: true,
errorMessage: "Too frequently, try again later."
});
2022-03-29 12:38:48 +03:00
const twoFaRateLimiter = new KumaRateLimiter({
tokensPerInterval: 30,
interval: "minute",
fireImmediately: true,
errorMessage: "Too frequently, try again later."
});
2021-10-23 11:35:13 +03:00
module.exports = {
2022-03-29 12:38:48 +03:00
loginRateLimiter,
apiRateLimiter,
2022-03-29 12:38:48 +03:00
twoFaRateLimiter,
2021-10-23 11:35:13 +03:00
};