Skip to content

Rate limit per app/api-key on the authed endpoint #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Rate limit per app/api-key on the authed endpoint #314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4c51d6
configurable rate limits per authed app
haardikk21 Jun 10, 2025
5885d43
cleanup, resolve comments:
haardikk21 Jun 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 66 additions & 21 deletions crates/websocket-proxy/src/auth.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
use crate::auth::AuthenticationParseError::{
DuplicateAPIKeyArgument, DuplicateApplicationArgument, MissingAPIKeyArgument,
MissingApplicationArgument, NoData, TooManyComponents,
MissingApplicationArgument, MissingRateLimitArgument, NoData, TooManyComponents,
};
use std::collections::{HashMap, HashSet};

#[derive(Clone, Debug)]
pub struct Authentication {
key_to_application: HashMap<String, String>,
app_to_rate_limit: HashMap<String, usize>,
}

#[derive(Debug, PartialEq)]
pub enum AuthenticationParseError {
NoData(),
MissingApplicationArgument(String),
MissingAPIKeyArgument(String),
MissingRateLimitArgument(String),
TooManyComponents(String),
DuplicateApplicationArgument(String),
DuplicateAPIKeyArgument(String),
Expand All @@ -25,6 +27,7 @@ impl std::fmt::Display for AuthenticationParseError {
NoData() => write!(f, "No API Keys Provided"),
MissingApplicationArgument(arg) => write!(f, "Missing application argument: [{}]", arg),
MissingAPIKeyArgument(app) => write!(f, "Missing API Key argument: [{}]", app),
MissingRateLimitArgument(app) => write!(f, "Missing rate limit argument: [{}]", app),
TooManyComponents(app) => write!(f, "Too many components: [{}]", app),
DuplicateApplicationArgument(app) => {
write!(f, "Duplicate application argument: [{}]", app)
Expand All @@ -42,6 +45,7 @@ impl TryFrom<Vec<String>> for Authentication {
fn try_from(args: Vec<String>) -> Result<Self, Self::Error> {
let mut applications = HashSet::new();
let mut key_to_application: HashMap<String, String> = HashMap::new();
let mut app_to_rate_limit: HashMap<String, usize> = HashMap::new();

if args.is_empty() {
return Err(NoData());
Expand All @@ -61,6 +65,13 @@ impl TryFrom<Vec<String>> for Authentication {
return Err(MissingAPIKeyArgument(app.to_string()));
}

let rate_limit = parts
.next()
.ok_or(MissingRateLimitArgument(app.to_string()))?;
if rate_limit.is_empty() {
return Err(MissingRateLimitArgument(app.to_string()));
}

if parts.count() > 0 {
return Err(TooManyComponents(app.to_string()));
}
Expand All @@ -75,29 +86,42 @@ impl TryFrom<Vec<String>> for Authentication {

applications.insert(app.to_string());
key_to_application.insert(key.to_string(), app.to_string());
app_to_rate_limit.insert(app.to_string(), rate_limit.parse().unwrap());
}

Ok(Self { key_to_application })
Ok(Self {
key_to_application,
app_to_rate_limit,
})
}
}

impl Authentication {
pub fn none() -> Self {
Self {
key_to_application: HashMap::new(),
app_to_rate_limit: HashMap::new(),
}
}

#[allow(dead_code)]
pub fn new(api_keys: HashMap<String, String>) -> Self {
pub fn new(
api_keys: HashMap<String, String>,
app_to_rate_limit: HashMap<String, usize>,
) -> Self {
Self {
key_to_application: api_keys,
app_to_rate_limit,
}
}

pub fn get_application_for_key(&self, api_key: &String) -> Option<&String> {
self.key_to_application.get(api_key)
}

pub fn get_rate_limits(&self) -> HashMap<String, usize> {
self.app_to_rate_limit.clone()
}
}

#[cfg(test)]
Expand All @@ -107,69 +131,90 @@ mod tests {
#[test]
fn test_parsing() {
let auth = Authentication::try_from(vec![
"app1:key1".to_string(),
"app2:key2".to_string(),
"app3:key3".to_string(),
"app1:key1:10".to_string(),
"app2:key2:10".to_string(),
"app3:key3:10".to_string(),
])
.unwrap();

assert_eq!(auth.key_to_application.len(), 3);
assert_eq!(auth.key_to_application["key1"], "app1");
assert_eq!(auth.key_to_application["key2"], "app2");
assert_eq!(auth.key_to_application["key3"], "app3");
assert_eq!(auth.app_to_rate_limit.len(), 3);
assert_eq!(auth.app_to_rate_limit["app1"], 10);
assert_eq!(auth.app_to_rate_limit["app2"], 10);
assert_eq!(auth.app_to_rate_limit["app3"], 10);

let auth = Authentication::try_from(vec![
"app1:key1".to_string(),
"app1:key1:10".to_string(),
"".to_string(),
"app3:key3".to_string(),
"app3:key3:10".to_string(),
]);
assert!(auth.is_err());
assert_eq!(auth.unwrap_err(), MissingApplicationArgument("".into()));

let auth = Authentication::try_from(vec![
"app1:key1".to_string(),
"app1:key1:10".to_string(),
"app2".to_string(),
"app3:key3".to_string(),
"app3:key3:10".to_string(),
]);
assert!(auth.is_err());
assert_eq!(auth.unwrap_err(), MissingAPIKeyArgument("app2".into()));

let auth = Authentication::try_from(vec![
"app1:key1".to_string(),
":".to_string(),
"app1:key1:10".to_string(),
"app2:key2:10".to_string(),
"app3:key3".to_string(),
]);
assert!(auth.is_err());
assert_eq!(auth.unwrap_err(), MissingRateLimitArgument("app3".into()));

let auth = Authentication::try_from(vec![
"app1:key1:10".to_string(),
":".to_string(),
"app3:key3:10".to_string(),
]);
assert!(auth.is_err());
assert_eq!(auth.unwrap_err(), MissingApplicationArgument(":".into()));

let auth = Authentication::try_from(vec![
"app1:key1".to_string(),
"app1:key1:10".to_string(),
"app2:".to_string(),
"app3:key3".to_string(),
"app3:key3:10".to_string(),
]);
assert!(auth.is_err());
assert_eq!(auth.unwrap_err(), MissingAPIKeyArgument("app2".into()));

let auth = Authentication::try_from(vec![
"app1:key1".to_string(),
"app2:key2:unexpected2".to_string(),
"app3:key3".to_string(),
"app1:key1:10".to_string(),
"app2:key2:10".to_string(),
"app3:key3:".to_string(),
]);
assert!(auth.is_err());
assert_eq!(auth.unwrap_err(), MissingRateLimitArgument("app3".into()));

let auth = Authentication::try_from(vec![
"app1:key1:10".to_string(),
"app2:key2:10:unexpected2".to_string(),
"app3:key3:10".to_string(),
]);
assert!(auth.is_err());
assert_eq!(auth.unwrap_err(), TooManyComponents("app2".into()));

let auth = Authentication::try_from(vec![
"app1:key1".to_string(),
"app1:key3".to_string(),
"app2:key2".to_string(),
"app1:key1:10".to_string(),
"app1:key3:10".to_string(),
"app2:key2:10".to_string(),
]);
assert!(auth.is_err());
assert_eq!(
auth.unwrap_err(),
DuplicateApplicationArgument("app1".into())
);

let auth = Authentication::try_from(vec!["app1:key1".to_string(), "app2:key1".to_string()]);
let auth =
Authentication::try_from(vec!["app1:key1:10".to_string(), "app2:key1:10".to_string()]);
assert!(auth.is_err());
assert_eq!(auth.unwrap_err(), DuplicateAPIKeyArgument("app2".into()));
}
Expand Down
24 changes: 18 additions & 6 deletions crates/websocket-proxy/src/integration.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,12 @@ mod test {
let (sender, _) = broadcast::channel(5);
let metrics = Arc::new(Metrics::default());
let registry = Registry::new(sender.clone(), metrics.clone());
let rate_limited = Arc::new(InMemoryRateLimit::new(3, 10));
let app_rate_limits = if let Some(auth) = &auth {
auth.get_rate_limits()
} else {
HashMap::new()
};
let rate_limited = Arc::new(InMemoryRateLimit::new(3, 10, app_rate_limits));

Self {
received_messages: Arc::new(Mutex::new(HashMap::new())),
Expand Down Expand Up @@ -337,11 +342,18 @@ mod test {
#[tokio::test]
async fn test_authentication_allows_known_api_keys() {
let addr = TestHarness::alloc_port().await;
let auth = Authentication::new(HashMap::from([
("key1".to_string(), "app1".to_string()),
("key2".to_string(), "app2".to_string()),
("key3".to_string(), "app3".to_string()),
]));
let auth = Authentication::new(
HashMap::from([
("key1".to_string(), "app1".to_string()),
("key2".to_string(), "app2".to_string()),
("key3".to_string(), "app3".to_string()),
]),
HashMap::from([
("app1".to_string(), 10),
("app2".to_string(), 10),
("app3".to_string(), 10),
]),
);

let mut harness = TestHarness::new_with_auth(addr, Some(auth));
harness.start_server().await;
Expand Down
15 changes: 13 additions & 2 deletions crates/websocket-proxy/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ use clap::Parser;
use dotenvy::dotenv;
use metrics_exporter_prometheus::PrometheusBuilder;
use rate_limit::RedisRateLimit;
use std::collections::HashMap;
use std::io::Write;
use std::net::SocketAddr;
use std::sync::Arc;
Expand Down Expand Up @@ -66,9 +67,10 @@ struct Args {
long,
env,
default_value = "10",
help = "Maximum number of concurrently connected clients per IP"
help = "Maximum number of concurrently connected clients per IP. 0 here means no limit."
)]
per_ip_connection_limit: usize,

#[arg(
long,
env,
Expand Down Expand Up @@ -96,7 +98,7 @@ struct Args {
#[arg(long, env, default_value = "true")]
metrics: bool,

/// API Keys, if not provided will be an unauthenticated endpoint, should be in the format <app1>:<apiKey1>,<app2>:<apiKey2>,..
/// API Keys, if not provided will be an unauthenticated endpoint, should be in the format <app1>:<apiKey1>:<rateLimit1>,<app2>:<apiKey2>:<rateLimit2>,..
#[arg(long, env, value_delimiter = ',', help = "API keys to allow")]
api_keys: Vec<String>,

Expand Down Expand Up @@ -266,13 +268,20 @@ async fn main() {

let registry = Registry::new(sender, metrics.clone());

let app_rate_limits = if let Some(auth) = &authentication {
auth.get_rate_limits()
} else {
HashMap::new()
};

let rate_limiter = match &args.redis_url {
Some(redis_url) => {
info!(message = "Using Redis rate limiter", redis_url = redis_url);
match RedisRateLimit::new(
redis_url,
args.instance_connection_limit,
args.per_ip_connection_limit,
app_rate_limits.clone(),
&args.redis_key_prefix,
) {
Ok(limiter) => {
Expand All @@ -288,6 +297,7 @@ async fn main() {
Arc::new(InMemoryRateLimit::new(
args.instance_connection_limit,
args.per_ip_connection_limit,
app_rate_limits.clone(),
)) as Arc<dyn RateLimit>
}
}
Expand All @@ -297,6 +307,7 @@ async fn main() {
Arc::new(InMemoryRateLimit::new(
args.instance_connection_limit,
args.per_ip_connection_limit,
app_rate_limits,
)) as Arc<dyn RateLimit>
}
};
Expand Down
Loading
Loading