web3-proxy/web3_proxy/src/frontend/authorization.rs

564 lines
21 KiB
Rust
Raw Normal View History

2022-09-23 00:03:37 +03:00
use super::errors::FrontendErrorResponse;
use crate::app::{UserKeyData, Web3ProxyApp};
use anyhow::Context;
2022-09-24 07:31:06 +03:00
use axum::headers::{authorization::Bearer, Origin, Referer, UserAgent};
2022-09-23 00:03:37 +03:00
use deferred_rate_limiter::DeferredRateLimitResult;
use entities::user_keys;
use ipnet::IpNet;
2022-09-24 07:31:06 +03:00
use redis_rate_limiter::redis::AsyncCommands;
2022-09-24 06:59:21 +03:00
use redis_rate_limiter::RedisRateLimitResult;
use sea_orm::{prelude::Decimal, ColumnTrait, DatabaseConnection, EntityTrait, QueryFilter};
2022-09-23 00:03:37 +03:00
use serde::Serialize;
2022-09-24 08:53:45 +03:00
use std::fmt::Display;
use std::{net::IpAddr, str::FromStr, sync::Arc};
2022-09-28 06:35:55 +03:00
use tokio::sync::{OwnedSemaphorePermit, Semaphore};
2022-09-23 00:03:37 +03:00
use tokio::time::Instant;
use tracing::{error, trace};
2022-09-24 08:53:45 +03:00
use ulid::Ulid;
2022-09-23 00:03:37 +03:00
use uuid::Uuid;
2022-09-24 08:53:45 +03:00
/// This lets us use UUID and ULID while we transition to only ULIDs
#[derive(Copy, Clone, Debug, Eq, PartialEq, serde::Serialize)]
pub enum UserKey {
Ulid(Ulid),
Uuid(Uuid),
}
impl UserKey {
pub fn new() -> Self {
Ulid::new().into()
}
}
impl Display for UserKey {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
// TODO: do this without dereferencing
let ulid: Ulid = (*self).into();
ulid.fmt(f)
}
}
impl Default for UserKey {
fn default() -> Self {
Self::new()
}
}
impl FromStr for UserKey {
type Err = anyhow::Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
if let Ok(ulid) = s.parse::<Ulid>() {
Ok(ulid.into())
} else if let Ok(uuid) = s.parse::<Uuid>() {
Ok(uuid.into())
} else {
Err(anyhow::anyhow!("UserKey was not a ULID or UUID"))
}
}
}
impl From<Ulid> for UserKey {
fn from(x: Ulid) -> Self {
UserKey::Ulid(x)
}
}
impl From<Uuid> for UserKey {
fn from(x: Uuid) -> Self {
UserKey::Uuid(x)
}
}
impl From<UserKey> for Ulid {
fn from(x: UserKey) -> Self {
match x {
UserKey::Ulid(x) => x,
UserKey::Uuid(x) => Ulid::from(x.as_u128()),
}
}
}
impl From<UserKey> for Uuid {
fn from(x: UserKey) -> Self {
match x {
UserKey::Ulid(x) => Uuid::from_u128(x.0),
UserKey::Uuid(x) => x,
}
}
}
2022-09-23 00:03:37 +03:00
#[derive(Debug)]
pub enum RateLimitResult {
/// contains the IP of the anonymous user
2022-09-28 06:35:55 +03:00
/// TODO: option inside or outside the arc?
AllowedIp(IpAddr, OwnedSemaphorePermit),
2022-09-23 00:03:37 +03:00
/// contains the user_key_id of an authenticated user
2022-09-28 06:35:55 +03:00
AllowedUser(UserKeyData, Option<OwnedSemaphorePermit>),
2022-09-23 00:03:37 +03:00
/// contains the IP and retry_at of the anonymous user
RateLimitedIp(IpAddr, Option<Instant>),
/// contains the user_key_id and retry_at of an authenticated user key
RateLimitedUser(UserKeyData, Option<Instant>),
/// This key is not in our database. Deny access!
UnknownKey,
}
#[derive(Debug, Serialize)]
pub struct AuthorizedKey {
pub ip: IpAddr,
pub origin: Option<String>,
pub user_key_id: u64,
pub log_revert_chance: Decimal,
2022-09-23 00:03:37 +03:00
// TODO: what else?
}
impl AuthorizedKey {
pub fn try_new(
ip: IpAddr,
origin: Option<Origin>,
2022-09-23 00:03:37 +03:00
referer: Option<Referer>,
user_agent: Option<UserAgent>,
user_data: UserKeyData,
2022-09-23 00:03:37 +03:00
) -> anyhow::Result<Self> {
// check ip
match &user_data.allowed_ips {
None => {}
Some(allowed_ips) => {
if !allowed_ips.iter().any(|x| x.contains(&ip)) {
return Err(anyhow::anyhow!("IP is not allowed!"));
}
}
}
// check origin
// TODO: do this with the Origin type instead of a String?
let origin = origin.map(|x| x.to_string());
match (&origin, &user_data.allowed_origins) {
(None, None) => {}
(Some(_), None) => {}
(None, Some(_)) => return Err(anyhow::anyhow!("Origin required")),
(Some(origin), Some(allowed_origins)) => {
let origin = origin.to_string();
if !allowed_origins.contains(&origin) {
return Err(anyhow::anyhow!("IP is not allowed!"));
}
}
}
// check referer
match (referer, &user_data.allowed_referers) {
(None, None) => {}
(Some(_), None) => {}
(None, Some(_)) => return Err(anyhow::anyhow!("Referer required")),
(Some(referer), Some(allowed_referers)) => {
if !allowed_referers.contains(&referer) {
return Err(anyhow::anyhow!("Referer is not allowed!"));
}
}
}
// check user_agent
match (user_agent, &user_data.allowed_user_agents) {
(None, None) => {}
(Some(_), None) => {}
(None, Some(_)) => return Err(anyhow::anyhow!("User agent required")),
(Some(user_agent), Some(allowed_user_agents)) => {
if !allowed_user_agents.contains(&user_agent) {
return Err(anyhow::anyhow!("User agent is not allowed!"));
}
}
}
2022-09-23 00:03:37 +03:00
Ok(Self {
ip,
origin,
2022-09-23 00:03:37 +03:00
user_key_id: user_data.user_key_id,
log_revert_chance: user_data.log_revert_chance,
2022-09-23 00:03:37 +03:00
})
}
}
#[derive(Debug, Serialize)]
pub enum AuthorizedRequest {
2022-09-24 10:04:11 +03:00
/// Request from this app
Internal,
2022-09-23 00:03:37 +03:00
/// Request from an anonymous IP address
2022-09-24 10:04:11 +03:00
Ip(#[serde(skip)] IpAddr),
2022-09-23 00:03:37 +03:00
/// Request from an authenticated and authorized user
2022-09-23 01:10:28 +03:00
User(#[serde(skip)] Option<DatabaseConnection>, AuthorizedKey),
2022-09-23 00:03:37 +03:00
}
2022-09-23 01:34:43 +03:00
impl AuthorizedRequest {
2022-09-24 10:04:11 +03:00
/// Only User has a database connection in case it needs to save a revert to the database.
pub fn db_conn(&self) -> Option<&DatabaseConnection> {
match self {
2022-09-24 10:04:11 +03:00
Self::Internal => None,
Self::Ip(_) => None,
Self::User(x, _) => x.as_ref(),
}
2022-09-23 01:34:43 +03:00
}
}
impl Display for &AuthorizedRequest {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
AuthorizedRequest::Internal => f.write_str("internal"),
AuthorizedRequest::Ip(x) => f.write_str(&format!("ip:{}", x)),
AuthorizedRequest::User(_, x) => f.write_str(&format!("user_key:{}", x.user_key_id)),
}
}
}
2022-09-24 06:59:21 +03:00
pub async fn login_is_authorized(
app: &Web3ProxyApp,
ip: IpAddr,
2022-09-28 06:35:55 +03:00
) -> Result<(AuthorizedRequest, OwnedSemaphorePermit), FrontendErrorResponse> {
2022-09-24 06:59:21 +03:00
// TODO: i think we could write an `impl From` for this
// TODO: move this to an AuthorizedUser extrator
2022-09-27 05:01:45 +03:00
let (ip, semaphore) = match app.rate_limit_login(ip).await? {
RateLimitResult::AllowedIp(x, semaphore) => (x, semaphore),
2022-09-24 06:59:21 +03:00
RateLimitResult::RateLimitedIp(x, retry_at) => {
return Err(FrontendErrorResponse::RateLimitedIp(x, retry_at));
}
// TODO: don't panic. give the user an error
x => unimplemented!("rate_limit_login shouldn't ever see these: {:?}", x),
};
2022-09-27 05:01:45 +03:00
Ok((AuthorizedRequest::Ip(ip), semaphore))
2022-09-24 06:59:21 +03:00
}
2022-09-24 07:31:06 +03:00
pub async fn bearer_is_authorized(
app: &Web3ProxyApp,
bearer: Bearer,
ip: IpAddr,
origin: Option<Origin>,
referer: Option<Referer>,
user_agent: Option<UserAgent>,
2022-09-28 06:35:55 +03:00
) -> Result<(AuthorizedRequest, Option<OwnedSemaphorePermit>), FrontendErrorResponse> {
2022-09-24 07:31:06 +03:00
let mut redis_conn = app.redis_conn().await.context("Getting redis connection")?;
// TODO: verify that bearer.token() is a Ulid?
let bearer_cache_key = format!("bearer:{}", bearer.token());
// turn bearer into a user key id
let user_key_id: u64 = redis_conn
.get(bearer_cache_key)
.await
.context("unknown bearer token")?;
let db_conn = app.db_conn().context("Getting database connection")?;
// turn user key id into a user key
let user_key_data = user_keys::Entity::find_by_id(user_key_id)
.one(db_conn)
.await
.context("fetching user key by id")?
.context("unknown user id")?;
2022-09-24 08:53:45 +03:00
key_is_authorized(
app,
user_key_data.api_key.into(),
ip,
origin,
referer,
user_agent,
)
.await
2022-09-24 07:31:06 +03:00
}
2022-09-23 00:03:37 +03:00
pub async fn ip_is_authorized(
app: &Web3ProxyApp,
ip: IpAddr,
2022-09-28 06:35:55 +03:00
) -> Result<(AuthorizedRequest, Option<OwnedSemaphorePermit>), FrontendErrorResponse> {
2022-09-23 00:03:37 +03:00
// TODO: i think we could write an `impl From` for this
// TODO: move this to an AuthorizedUser extrator
2022-09-27 05:01:45 +03:00
let (ip, semaphore) = match app.rate_limit_by_ip(ip).await? {
2022-09-28 06:35:55 +03:00
RateLimitResult::AllowedIp(ip, semaphore) => (ip, Some(semaphore)),
2022-09-23 00:03:37 +03:00
RateLimitResult::RateLimitedIp(x, retry_at) => {
return Err(FrontendErrorResponse::RateLimitedIp(x, retry_at));
}
// TODO: don't panic. give the user an error
x => unimplemented!("rate_limit_by_ip shouldn't ever see these: {:?}", x),
};
2022-09-28 06:35:55 +03:00
// semaphore won't ever be None, but its easier if key auth and ip auth work the same way
2022-09-27 05:01:45 +03:00
Ok((AuthorizedRequest::Ip(ip), semaphore))
2022-09-23 00:03:37 +03:00
}
pub async fn key_is_authorized(
app: &Web3ProxyApp,
2022-09-24 08:53:45 +03:00
user_key: UserKey,
2022-09-23 00:03:37 +03:00
ip: IpAddr,
origin: Option<Origin>,
2022-09-23 00:03:37 +03:00
referer: Option<Referer>,
user_agent: Option<UserAgent>,
2022-09-28 06:35:55 +03:00
) -> Result<(AuthorizedRequest, Option<OwnedSemaphorePermit>), FrontendErrorResponse> {
2022-09-23 00:03:37 +03:00
// check the rate limits. error if over the limit
2022-09-27 05:01:45 +03:00
let (user_data, semaphore) = match app.rate_limit_by_key(user_key).await? {
RateLimitResult::AllowedUser(x, semaphore) => (x, semaphore),
2022-09-23 00:03:37 +03:00
RateLimitResult::RateLimitedUser(x, retry_at) => {
return Err(FrontendErrorResponse::RateLimitedUser(x, retry_at));
}
RateLimitResult::UnknownKey => return Err(FrontendErrorResponse::UnknownKey),
// TODO: don't panic. give the user an error
x => unimplemented!("rate_limit_by_key shouldn't ever see these: {:?}", x),
};
let authorized_user = AuthorizedKey::try_new(ip, origin, referer, user_agent, user_data)?;
2022-09-23 00:03:37 +03:00
2022-09-23 01:10:28 +03:00
let db = app.db_conn.clone();
2022-09-27 05:01:45 +03:00
Ok((AuthorizedRequest::User(db, authorized_user), semaphore))
2022-09-23 00:03:37 +03:00
}
impl Web3ProxyApp {
2022-09-28 06:35:55 +03:00
pub async fn ip_semaphore(&self, ip: IpAddr) -> anyhow::Result<OwnedSemaphorePermit> {
let semaphore = self
.ip_semaphores
.get_with(ip, async move {
// TODO: get semaphore size from app config
let s = Semaphore::const_new(10);
Arc::new(s)
})
.await;
let semaphore_permit = semaphore.acquire_owned().await?;
Ok(semaphore_permit)
}
pub async fn user_key_semaphore(
&self,
user_data: &UserKeyData,
) -> anyhow::Result<Option<OwnedSemaphorePermit>> {
if let Some(max_concurrent_requests) = user_data.max_concurrent_requests {
let semaphore = self
.user_key_semaphores
2022-09-30 07:18:18 +03:00
.try_get_with(user_data.user_key_id, async move {
let s = Semaphore::const_new(max_concurrent_requests.try_into()?);
2022-09-28 06:35:55 +03:00
trace!("new semaphore for user_key_id {}", user_data.user_key_id);
2022-09-30 07:18:18 +03:00
Ok::<_, anyhow::Error>(Arc::new(s))
2022-09-28 06:35:55 +03:00
})
2022-09-30 07:18:18 +03:00
.await
// TODO: is this the best way to handle an arc
.map_err(|err| anyhow::anyhow!(err))?;
2022-09-28 06:35:55 +03:00
let semaphore_permit = semaphore.acquire_owned().await?;
Ok(Some(semaphore_permit))
} else {
Ok(None)
}
}
2022-09-24 06:59:21 +03:00
pub async fn rate_limit_login(&self, ip: IpAddr) -> anyhow::Result<RateLimitResult> {
// TODO: dry this up with rate_limit_by_key
2022-09-28 06:35:55 +03:00
let semaphore = self.ip_semaphore(ip).await?;
2022-09-24 06:59:21 +03:00
if let Some(rate_limiter) = &self.login_rate_limiter {
match rate_limiter.throttle_label(&ip.to_string(), None, 1).await {
2022-09-27 05:01:45 +03:00
Ok(RedisRateLimitResult::Allowed(_)) => {
Ok(RateLimitResult::AllowedIp(ip, semaphore))
}
2022-09-24 06:59:21 +03:00
Ok(RedisRateLimitResult::RetryAt(retry_at, _)) => {
// TODO: set headers so they know when they can retry
// TODO: debug or trace?
// this is too verbose, but a stat might be good
trace!(?ip, "login rate limit exceeded until {:?}", retry_at);
Ok(RateLimitResult::RateLimitedIp(ip, Some(retry_at)))
}
Ok(RedisRateLimitResult::RetryNever) => {
// TODO: i don't think we'll get here. maybe if we ban an IP forever? seems unlikely
trace!(?ip, "login rate limit is 0");
Ok(RateLimitResult::RateLimitedIp(ip, None))
}
Err(err) => {
// internal error, not rate limit being hit
// TODO: i really want axum to do this for us in a single place.
error!(?err, "login rate limiter is unhappy. allowing ip");
2022-09-27 05:01:45 +03:00
Ok(RateLimitResult::AllowedIp(ip, semaphore))
2022-09-24 06:59:21 +03:00
}
}
} else {
// TODO: if no redis, rate limit with a local cache? "warn!" probably isn't right
todo!("no rate limiter");
}
}
2022-09-23 00:03:37 +03:00
pub async fn rate_limit_by_ip(&self, ip: IpAddr) -> anyhow::Result<RateLimitResult> {
// TODO: dry this up with rate_limit_by_key
2022-09-28 06:35:55 +03:00
let semaphore = self.ip_semaphore(ip).await?;
2022-09-23 00:03:37 +03:00
if let Some(rate_limiter) = &self.frontend_ip_rate_limiter {
match rate_limiter.throttle(ip, None, 1).await {
2022-09-27 05:01:45 +03:00
Ok(DeferredRateLimitResult::Allowed) => {
Ok(RateLimitResult::AllowedIp(ip, semaphore))
}
2022-09-23 00:03:37 +03:00
Ok(DeferredRateLimitResult::RetryAt(retry_at)) => {
// TODO: set headers so they know when they can retry
// TODO: debug or trace?
// this is too verbose, but a stat might be good
trace!(?ip, "rate limit exceeded until {:?}", retry_at);
Ok(RateLimitResult::RateLimitedIp(ip, Some(retry_at)))
}
Ok(DeferredRateLimitResult::RetryNever) => {
// TODO: i don't think we'll get here. maybe if we ban an IP forever? seems unlikely
trace!(?ip, "rate limit is 0");
Ok(RateLimitResult::RateLimitedIp(ip, None))
}
Err(err) => {
// internal error, not rate limit being hit
// TODO: i really want axum to do this for us in a single place.
error!(?err, "rate limiter is unhappy. allowing ip");
2022-09-27 05:01:45 +03:00
Ok(RateLimitResult::AllowedIp(ip, semaphore))
2022-09-23 00:03:37 +03:00
}
}
} else {
// TODO: if no redis, rate limit with a local cache? "warn!" probably isn't right
todo!("no rate limiter");
}
}
// check the local cache for user data, or query the database
2022-09-24 08:53:45 +03:00
pub(crate) async fn user_data(&self, user_key: UserKey) -> anyhow::Result<UserKeyData> {
2022-09-23 00:03:37 +03:00
let user_data: Result<_, Arc<anyhow::Error>> = self
2022-09-27 05:01:45 +03:00
.user_key_cache
2022-09-24 08:53:45 +03:00
.try_get_with(user_key.into(), async move {
2022-09-23 00:03:37 +03:00
trace!(?user_key, "user_cache miss");
2022-09-24 07:31:06 +03:00
let db = self.db_conn().context("Getting database connection")?;
2022-09-23 00:03:37 +03:00
2022-09-24 08:53:45 +03:00
let user_uuid: Uuid = user_key.into();
2022-09-23 00:03:37 +03:00
// TODO: join the user table to this to return the User? we don't always need it
match user_keys::Entity::find()
2022-09-24 08:53:45 +03:00
.filter(user_keys::Column::ApiKey.eq(user_uuid))
2022-09-23 00:03:37 +03:00
.filter(user_keys::Column::Active.eq(true))
.one(db)
.await?
{
Some(user_key_model) => {
let allowed_ips: Option<Vec<IpNet>> =
user_key_model.allowed_ips.map(|allowed_ips| {
serde_json::from_str::<Vec<String>>(&allowed_ips)
.expect("allowed_ips should always parse")
.into_iter()
// TODO: try_for_each
.map(|x| {
x.parse::<IpNet>().expect("ip address should always parse")
})
.collect()
});
// TODO: should this be an Option<Vec<Origin>>?
let allowed_origins =
user_key_model.allowed_origins.map(|allowed_origins| {
serde_json::from_str::<Vec<String>>(&allowed_origins)
.expect("allowed_origins should always parse")
});
let allowed_referers =
user_key_model.allowed_referers.map(|allowed_referers| {
serde_json::from_str::<Vec<String>>(&allowed_referers)
.expect("allowed_referers should always parse")
.into_iter()
// TODO: try_for_each
.map(|x| {
x.parse::<Referer>().expect("referer should always parse")
})
.collect()
});
let allowed_user_agents =
user_key_model
.allowed_user_agents
.map(|allowed_user_agents| {
serde_json::from_str::<Vec<String>>(&allowed_user_agents)
.expect("allowed_user_agents should always parse")
.into_iter()
// TODO: try_for_each
.map(|x| {
x.parse::<UserAgent>()
.expect("user agent should always parse")
})
.collect()
});
2022-09-23 00:03:37 +03:00
Ok(UserKeyData {
user_key_id: user_key_model.id,
2022-09-28 06:35:55 +03:00
max_requests_per_period: user_key_model.requests_per_minute,
max_concurrent_requests: user_key_model.max_concurrent_requests,
allowed_ips,
allowed_origins,
allowed_referers,
allowed_user_agents,
log_revert_chance: user_key_model.log_revert_chance,
2022-09-23 00:03:37 +03:00
})
}
None => Ok(UserKeyData::default()),
2022-09-23 00:03:37 +03:00
}
})
.await;
2022-09-30 07:18:18 +03:00
// TODO: what's the best way to handle this arc? try_unwrap will not work
user_data.map_err(|err| anyhow::anyhow!(err))
2022-09-23 00:03:37 +03:00
}
2022-09-24 08:53:45 +03:00
pub async fn rate_limit_by_key(&self, user_key: UserKey) -> anyhow::Result<RateLimitResult> {
2022-09-23 00:03:37 +03:00
let user_data = self.user_data(user_key).await?;
if user_data.user_key_id == 0 {
return Ok(RateLimitResult::UnknownKey);
}
2022-09-28 06:35:55 +03:00
let semaphore = self.user_key_semaphore(&user_data).await?;
2022-09-27 05:01:45 +03:00
2022-09-28 06:35:55 +03:00
let user_max_requests_per_period = match user_data.max_requests_per_period {
None => {
2022-09-27 05:01:45 +03:00
return Ok(RateLimitResult::AllowedUser(user_data, semaphore));
}
2022-09-23 00:03:37 +03:00
Some(x) => x,
};
// user key is valid. now check rate limits
if let Some(rate_limiter) = &self.frontend_key_rate_limiter {
match rate_limiter
2022-09-24 08:53:45 +03:00
.throttle(user_key.into(), Some(user_max_requests_per_period), 1)
2022-09-23 00:03:37 +03:00
.await
{
2022-09-27 05:01:45 +03:00
Ok(DeferredRateLimitResult::Allowed) => {
Ok(RateLimitResult::AllowedUser(user_data, semaphore))
}
2022-09-23 00:03:37 +03:00
Ok(DeferredRateLimitResult::RetryAt(retry_at)) => {
// TODO: set headers so they know when they can retry
// TODO: debug or trace?
// this is too verbose, but a stat might be good
// TODO: keys are secrets! use the id instead
trace!(?user_key, "rate limit exceeded until {:?}", retry_at);
Ok(RateLimitResult::RateLimitedUser(user_data, Some(retry_at)))
}
Ok(DeferredRateLimitResult::RetryNever) => {
// TODO: keys are secret. don't log them!
trace!(?user_key, "rate limit is 0");
Ok(RateLimitResult::RateLimitedUser(user_data, None))
}
Err(err) => {
// internal error, not rate limit being hit
// TODO: i really want axum to do this for us in a single place.
error!(?err, "rate limiter is unhappy. allowing ip");
2022-09-27 05:01:45 +03:00
Ok(RateLimitResult::AllowedUser(user_data, semaphore))
2022-09-23 00:03:37 +03:00
}
}
} else {
// TODO: if no redis, rate limit with just a local cache?
// if we don't have redis, we probably don't have a db, so this probably will never happen
Err(anyhow::anyhow!("no redis. cannot rate limit"))
}
}
}