this repo has no description
1use axum::{
2 body::Body,
3 extract::ConnectInfo,
4 http::{HeaderMap, Request, StatusCode},
5 middleware::Next,
6 response::{IntoResponse, Response},
7 Json,
8};
9use governor::{
10 Quota, RateLimiter,
11 clock::DefaultClock,
12 state::{InMemoryState, NotKeyed, keyed::DefaultKeyedStateStore},
13};
14use std::{
15 net::SocketAddr,
16 num::NonZeroU32,
17 sync::Arc,
18};
19
20pub type KeyedRateLimiter = RateLimiter<String, DefaultKeyedStateStore<String>, DefaultClock>;
21pub type GlobalRateLimiter = RateLimiter<NotKeyed, InMemoryState, DefaultClock>;
22
23#[derive(Clone)]
24pub struct RateLimiters {
25 pub login: Arc<KeyedRateLimiter>,
26 pub oauth_token: Arc<KeyedRateLimiter>,
27 pub oauth_authorize: Arc<KeyedRateLimiter>,
28 pub password_reset: Arc<KeyedRateLimiter>,
29 pub account_creation: Arc<KeyedRateLimiter>,
30 pub refresh_session: Arc<KeyedRateLimiter>,
31 pub reset_password: Arc<KeyedRateLimiter>,
32 pub oauth_par: Arc<KeyedRateLimiter>,
33 pub oauth_introspect: Arc<KeyedRateLimiter>,
34 pub app_password: Arc<KeyedRateLimiter>,
35 pub email_update: Arc<KeyedRateLimiter>,
36}
37
38impl Default for RateLimiters {
39 fn default() -> Self {
40 Self::new()
41 }
42}
43
44impl RateLimiters {
45 pub fn new() -> Self {
46 Self {
47 login: Arc::new(RateLimiter::keyed(
48 Quota::per_minute(NonZeroU32::new(10).unwrap())
49 )),
50 oauth_token: Arc::new(RateLimiter::keyed(
51 Quota::per_minute(NonZeroU32::new(30).unwrap())
52 )),
53 oauth_authorize: Arc::new(RateLimiter::keyed(
54 Quota::per_minute(NonZeroU32::new(10).unwrap())
55 )),
56 password_reset: Arc::new(RateLimiter::keyed(
57 Quota::per_hour(NonZeroU32::new(5).unwrap())
58 )),
59 account_creation: Arc::new(RateLimiter::keyed(
60 Quota::per_hour(NonZeroU32::new(10).unwrap())
61 )),
62 refresh_session: Arc::new(RateLimiter::keyed(
63 Quota::per_minute(NonZeroU32::new(60).unwrap())
64 )),
65 reset_password: Arc::new(RateLimiter::keyed(
66 Quota::per_minute(NonZeroU32::new(10).unwrap())
67 )),
68 oauth_par: Arc::new(RateLimiter::keyed(
69 Quota::per_minute(NonZeroU32::new(30).unwrap())
70 )),
71 oauth_introspect: Arc::new(RateLimiter::keyed(
72 Quota::per_minute(NonZeroU32::new(30).unwrap())
73 )),
74 app_password: Arc::new(RateLimiter::keyed(
75 Quota::per_minute(NonZeroU32::new(10).unwrap())
76 )),
77 email_update: Arc::new(RateLimiter::keyed(
78 Quota::per_hour(NonZeroU32::new(5).unwrap())
79 )),
80 }
81 }
82
83 pub fn with_login_limit(mut self, per_minute: u32) -> Self {
84 self.login = Arc::new(RateLimiter::keyed(
85 Quota::per_minute(NonZeroU32::new(per_minute).unwrap_or(NonZeroU32::new(10).unwrap()))
86 ));
87 self
88 }
89
90 pub fn with_oauth_token_limit(mut self, per_minute: u32) -> Self {
91 self.oauth_token = Arc::new(RateLimiter::keyed(
92 Quota::per_minute(NonZeroU32::new(per_minute).unwrap_or(NonZeroU32::new(30).unwrap()))
93 ));
94 self
95 }
96
97 pub fn with_oauth_authorize_limit(mut self, per_minute: u32) -> Self {
98 self.oauth_authorize = Arc::new(RateLimiter::keyed(
99 Quota::per_minute(NonZeroU32::new(per_minute).unwrap_or(NonZeroU32::new(10).unwrap()))
100 ));
101 self
102 }
103
104 pub fn with_password_reset_limit(mut self, per_hour: u32) -> Self {
105 self.password_reset = Arc::new(RateLimiter::keyed(
106 Quota::per_hour(NonZeroU32::new(per_hour).unwrap_or(NonZeroU32::new(5).unwrap()))
107 ));
108 self
109 }
110
111 pub fn with_account_creation_limit(mut self, per_hour: u32) -> Self {
112 self.account_creation = Arc::new(RateLimiter::keyed(
113 Quota::per_hour(NonZeroU32::new(per_hour).unwrap_or(NonZeroU32::new(10).unwrap()))
114 ));
115 self
116 }
117}
118
119pub fn extract_client_ip(headers: &HeaderMap, addr: Option<SocketAddr>) -> String {
120 if let Some(forwarded) = headers.get("x-forwarded-for") {
121 if let Ok(value) = forwarded.to_str() {
122 if let Some(first_ip) = value.split(',').next() {
123 return first_ip.trim().to_string();
124 }
125 }
126 }
127
128 if let Some(real_ip) = headers.get("x-real-ip") {
129 if let Ok(value) = real_ip.to_str() {
130 return value.trim().to_string();
131 }
132 }
133
134 addr.map(|a| a.ip().to_string()).unwrap_or_else(|| "unknown".to_string())
135}
136
137fn rate_limit_response() -> Response {
138 (
139 StatusCode::TOO_MANY_REQUESTS,
140 Json(serde_json::json!({
141 "error": "RateLimitExceeded",
142 "message": "Too many requests. Please try again later."
143 })),
144 )
145 .into_response()
146}
147
148pub async fn login_rate_limit(
149 ConnectInfo(addr): ConnectInfo<SocketAddr>,
150 axum::extract::State(limiters): axum::extract::State<Arc<RateLimiters>>,
151 request: Request<Body>,
152 next: Next,
153) -> Response {
154 let client_ip = extract_client_ip(request.headers(), Some(addr));
155
156 if limiters.login.check_key(&client_ip).is_err() {
157 tracing::warn!(ip = %client_ip, "Login rate limit exceeded");
158 return rate_limit_response();
159 }
160
161 next.run(request).await
162}
163
164pub async fn oauth_token_rate_limit(
165 ConnectInfo(addr): ConnectInfo<SocketAddr>,
166 axum::extract::State(limiters): axum::extract::State<Arc<RateLimiters>>,
167 request: Request<Body>,
168 next: Next,
169) -> Response {
170 let client_ip = extract_client_ip(request.headers(), Some(addr));
171
172 if limiters.oauth_token.check_key(&client_ip).is_err() {
173 tracing::warn!(ip = %client_ip, "OAuth token rate limit exceeded");
174 return rate_limit_response();
175 }
176
177 next.run(request).await
178}
179
180pub async fn password_reset_rate_limit(
181 ConnectInfo(addr): ConnectInfo<SocketAddr>,
182 axum::extract::State(limiters): axum::extract::State<Arc<RateLimiters>>,
183 request: Request<Body>,
184 next: Next,
185) -> Response {
186 let client_ip = extract_client_ip(request.headers(), Some(addr));
187
188 if limiters.password_reset.check_key(&client_ip).is_err() {
189 tracing::warn!(ip = %client_ip, "Password reset rate limit exceeded");
190 return rate_limit_response();
191 }
192
193 next.run(request).await
194}
195
196pub async fn account_creation_rate_limit(
197 ConnectInfo(addr): ConnectInfo<SocketAddr>,
198 axum::extract::State(limiters): axum::extract::State<Arc<RateLimiters>>,
199 request: Request<Body>,
200 next: Next,
201) -> Response {
202 let client_ip = extract_client_ip(request.headers(), Some(addr));
203
204 if limiters.account_creation.check_key(&client_ip).is_err() {
205 tracing::warn!(ip = %client_ip, "Account creation rate limit exceeded");
206 return rate_limit_response();
207 }
208
209 next.run(request).await
210}
211
212#[cfg(test)]
213mod tests {
214 use super::*;
215
216 #[test]
217 fn test_rate_limiters_creation() {
218 let limiters = RateLimiters::new();
219 assert!(limiters.login.check_key(&"test".to_string()).is_ok());
220 }
221
222 #[test]
223 fn test_rate_limiter_exhaustion() {
224 let limiter = RateLimiter::keyed(Quota::per_minute(NonZeroU32::new(2).unwrap()));
225 let key = "test_ip".to_string();
226
227 assert!(limiter.check_key(&key).is_ok());
228 assert!(limiter.check_key(&key).is_ok());
229 assert!(limiter.check_key(&key).is_err());
230 }
231
232 #[test]
233 fn test_different_keys_have_separate_limits() {
234 let limiter = RateLimiter::keyed(Quota::per_minute(NonZeroU32::new(1).unwrap()));
235
236 assert!(limiter.check_key(&"ip1".to_string()).is_ok());
237 assert!(limiter.check_key(&"ip1".to_string()).is_err());
238 assert!(limiter.check_key(&"ip2".to_string()).is_ok());
239 }
240
241 #[test]
242 fn test_builder_pattern() {
243 let limiters = RateLimiters::new()
244 .with_login_limit(20)
245 .with_oauth_token_limit(60)
246 .with_password_reset_limit(3)
247 .with_account_creation_limit(5);
248
249 assert!(limiters.login.check_key(&"test".to_string()).is_ok());
250 }
251}