1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
//! An extension to limit the amount of requests sent from a single IP that will be handled by the server.
use std::collections::HashMap;
use std::fmt;
use std::net::IpAddr;
use std::sync::{
atomic::{AtomicU64, Ordering},
RwLock,
};
use crate::internal::common::epoch;
use crate::Status;
use crate::{
middleware::{MiddleResult, Middleware},
Content, Request, Response,
};
// Handler Type
type Handler = Box<dyn Fn(&Request) -> Option<Response> + Send + Sync>;
/// Limit the amount of requests handled by the server.
pub struct RateLimiter {
/// Requests Per Req_Timeout
req_limit: u64,
/// Time of last reset
last_reset: AtomicU64,
/// How often to reset the counters (sec)
req_timeout: u64,
/// Table that maps an IP to a list of request timestamps
// requests: RwLock<HashMap<IpAddr, Vec<u64>>>,
requests: RwLock<HashMap<IpAddr, u64>>,
/// Handler for when the limit is reached.
/// If the handler returns None, the request will be processed normally.
handler: Handler,
}
impl RateLimiter {
/// Make a new RateLimiter.
///
/// Default limit is 10 and timeout is 60
pub fn new() -> RateLimiter {
RateLimiter {
last_reset: AtomicU64::new(0),
req_limit: 10,
req_timeout: 60,
requests: RwLock::new(HashMap::new()),
handler: Box::new(|_| {
Some(
Response::new()
.status(Status::TooManyRequests)
.text("Too Many Requests")
.content(Content::TXT),
)
}),
}
}
/// Set the request limit per timeout
/// Attach the rate limiter to a server.
/// ## Example
/// ```rust,no_run
/// // Import Lib
/// use afire::{Server, extension::RateLimiter, Middleware};
///
/// // Create a new server
/// let mut server = Server::<()>::new("localhost", 1234);
///
/// // Add a rate limiter
/// RateLimiter::new()
/// // Override limit to 100 requests
/// .limit(100)
/// // Attach it to the server
/// .attach(&mut server);
///
/// // Start Server
/// // This is blocking
/// server.start().unwrap();
/// ```
pub fn limit(self, limit: u64) -> RateLimiter {
RateLimiter {
req_limit: limit,
..self
}
}
/// Set the Ratelimit refresh period
/// ## Example
/// ```rust,no_run
/// // Import Lib
/// use afire::{Server, extension::RateLimiter, Middleware};
///
/// // Create a new server
/// let mut server = Server::<()>::new("localhost", 1234);
///
/// // Add a rate limiter
/// RateLimiter::new()
/// // Override timeout to 60 seconds
/// .timeout(60)
/// // Attach it to the server
/// .attach(&mut server);
///
/// // Start Server
/// // This is blocking
/// server.start().unwrap();
/// ```
pub fn timeout(self, timeout: u64) -> RateLimiter {
RateLimiter {
req_timeout: timeout,
..self
}
}
/// Define a Custom Handler for when a client has exceeded the ratelimit.
/// If the handler returns None, the request will be processed normally.
/// ## Example
/// ```rust,no_run
/// // Import Lib
/// use afire::{Server, Response, extension::RateLimiter, Middleware};
///
/// // Create a new server
/// let mut server = Server::<()>::new("localhost", 1234);
///
/// // Add a rate limiter
/// RateLimiter::new()
/// // Override the handler for requests exceeding the limit
/// .handler(Box::new(|_req| Some(Response::new().text("much request"))))
/// // Attach it to the server
/// .attach(&mut server);
///
/// // Start Server
/// // This is blocking
/// server.start().unwrap();
/// ```
pub fn handler(self, handler: Handler) -> RateLimiter {
RateLimiter { handler, ..self }
}
/// Count a request.
fn add_request(&self, ip: IpAddr) {
let mut req = self.requests.write().unwrap();
let count = req.get(&ip).unwrap_or(&0) + 1;
req.insert(ip, count);
}
/// Check if request table needs to be cleared.
fn check_reset(&self) {
let time = epoch().as_secs();
if self.last_reset.load(Ordering::Acquire) + self.req_timeout <= time {
self.requests.write().unwrap().clear();
self.last_reset.store(time, Ordering::Release);
}
}
/// Check if the request limit has been reached for an ip.
fn is_over_limit(&self, ip: IpAddr) -> bool {
self.requests.read().unwrap().get(&ip).unwrap_or(&0) >= &self.req_limit
}
}
impl Middleware for RateLimiter {
fn pre(&self, req: &mut Request) -> MiddleResult {
if self.is_over_limit(req.address.ip()) {
if let Some(i) = (self.handler)(req) {
return MiddleResult::Send(i);
}
}
MiddleResult::Continue
}
fn end(&self, req: &Request, _res: &Response) {
self.check_reset();
self.add_request(req.address.ip());
}
}
impl Default for RateLimiter {
fn default() -> Self {
Self::new()
}
}
// Allow printing of RateLimiter for debugging
impl fmt::Debug for RateLimiter {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("RateLimiter")
.field("req_limit", &self.req_limit)
.field("req_timeout", &self.req_timeout)
.field("last_reset", &self.last_reset)
.field("requests", &self.requests)
.finish()
}
}