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

1406 lines
51 KiB
Rust
Raw Normal View History

2022-10-18 00:47:58 +03:00
//! Utilities for authorization of logged in and anonymous users.
2023-03-03 04:39:50 +03:00
use super::rpc_proxy_ws::ProxyMode;
use crate::app::{Web3ProxyApp, APP_USER_AGENT};
2023-07-10 06:13:03 +03:00
use crate::balance::Balance;
use crate::caches::RegisteredUserRateLimitKey;
use crate::errors::{Web3ProxyError, Web3ProxyErrorContext, Web3ProxyResult};
use crate::jsonrpc::{JsonRpcForwardedResponse, JsonRpcRequest};
use crate::rpcs::blockchain::Web3ProxyBlock;
use crate::rpcs::one::Web3Rpc;
use crate::stats::{AppStat, BackendRequests, RpcQueryStats};
2022-10-31 23:05:58 +03:00
use crate::user_token::UserBearerToken;
use anyhow::Context;
2023-05-31 09:52:12 +03:00
use axum::headers::authorization::Bearer;
2022-10-27 00:39:26 +03:00
use axum::headers::{Header, Origin, Referer, UserAgent};
2022-10-11 08:13:00 +03:00
use chrono::Utc;
use core::fmt;
2022-09-23 00:03:37 +03:00
use deferred_rate_limiter::DeferredRateLimitResult;
use derivative::Derivative;
use derive_more::From;
2023-07-10 06:13:03 +03:00
use entities::{login, rpc_key, user, user_tier};
use ethers::types::{Bytes, U64};
2022-12-28 09:11:18 +03:00
use ethers::utils::keccak256;
use futures::TryFutureExt;
use hashbrown::HashMap;
2022-10-27 00:39:26 +03:00
use http::HeaderValue;
use ipnet::IpNet;
use migration::sea_orm::prelude::Decimal;
2023-07-10 06:13:03 +03:00
use migration::sea_orm::{ColumnTrait, DatabaseConnection, EntityTrait, QueryFilter};
use rdkafka::message::{Header as KafkaHeader, OwnedHeaders as KafkaOwnedHeaders, OwnedMessage};
use rdkafka::producer::{FutureProducer, FutureRecord};
use rdkafka::util::Timeout as KafkaTimeout;
2022-12-28 09:11:18 +03:00
use redis_rate_limiter::redis::AsyncCommands;
2022-09-24 06:59:21 +03:00
use redis_rate_limiter::RedisRateLimitResult;
use serde::{Deserialize, Serialize};
use std::borrow::Cow;
2022-09-24 08:53:45 +03:00
use std::fmt::Display;
2023-05-24 00:40:34 +03:00
use std::hash::{Hash, Hasher};
use std::mem;
use std::num::NonZeroU64;
use std::sync::atomic::{self, AtomicBool, AtomicI64, AtomicU64, AtomicUsize};
use std::time::Duration;
2022-09-24 08:53:45 +03:00
use std::{net::IpAddr, str::FromStr, sync::Arc};
use tokio::sync::RwLock as AsyncRwLock;
use tokio::sync::{OwnedSemaphorePermit, Semaphore};
use tokio::task::JoinHandle;
2022-09-23 00:03:37 +03:00
use tokio::time::Instant;
use tracing::{error, trace, warn};
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
2023-06-30 22:53:21 +03:00
/// TODO: custom deserialize that can also go from String to Ulid
#[derive(Copy, Clone, Debug, Deserialize, Eq, PartialEq)]
2022-11-01 21:54:39 +03:00
pub enum RpcSecretKey {
2022-09-24 08:53:45 +03:00
Ulid(Ulid),
Uuid(Uuid),
}
/// always serialize as a ULID.
impl Serialize for RpcSecretKey {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
match self {
Self::Ulid(x) => x.serialize(serializer),
Self::Uuid(x) => {
let x: Ulid = x.to_owned().into();
x.serialize(serializer)
}
}
}
}
/// TODO: should this have IpAddr and Origin or AuthorizationChecks?
2022-10-10 07:15:07 +03:00
#[derive(Debug)]
pub enum RateLimitResult {
Allowed(Authorization, Option<OwnedSemaphorePermit>),
RateLimited(
Authorization,
/// when their rate limit resets and they can try more requests
Option<Instant>,
),
2022-10-10 07:15:07 +03:00
/// This key is not in our database. Deny access!
UnknownKey,
}
#[derive(Clone, Debug)]
2022-12-12 07:39:54 +03:00
pub enum AuthorizationType {
Internal,
Frontend,
}
/// TODO: move this
#[derive(Clone, Debug, Default, From)]
pub struct AuthorizationChecks {
/// database id of the primary user. 0 if anon
/// TODO: do we need this? its on the authorization so probably not
/// TODO: `Option<NonZeroU64>`? they are actual zeroes some places in the db now
pub user_id: u64,
/// locally cached balance that may drift slightly if the user is on multiple servers
pub latest_balance: Arc<AsyncRwLock<Balance>>,
/// the key used (if any)
pub rpc_secret_key: Option<RpcSecretKey>,
/// database id of the rpc key
/// if this is None, then this request is being rate limited by ip
pub rpc_secret_key_id: Option<NonZeroU64>,
/// if None, allow unlimited queries. inherited from the user_tier
pub max_requests_per_period: Option<u64>,
// if None, allow unlimited concurrent requests. inherited from the user_tier
pub max_concurrent_requests: Option<u32>,
/// if None, allow any Origin
pub allowed_origins: Option<Vec<Origin>>,
/// if None, allow any Referer
pub allowed_referers: Option<Vec<Referer>>,
/// if None, allow any UserAgent
pub allowed_user_agents: Option<Vec<UserAgent>>,
/// if None, allow any IP Address
pub allowed_ips: Option<Vec<IpNet>>,
/// Chance to save reverting eth_call, eth_estimateGas, and eth_sendRawTransaction to the database.
/// depending on the caller, errors might be expected. this keeps us from bloating our database
/// u16::MAX == 100%
pub log_revert_chance: u16,
/// if true, transactions are broadcast only to private mempools.
/// IMPORTANT! Once confirmed by a miner, they will be public on the blockchain!
pub private_txs: bool,
pub proxy_mode: ProxyMode,
}
/// TODO: include the authorization checks in this?
2022-10-27 00:39:26 +03:00
#[derive(Clone, Debug)]
pub struct Authorization {
pub checks: AuthorizationChecks,
pub db_conn: Option<DatabaseConnection>,
2022-10-10 07:15:07 +03:00
pub ip: IpAddr,
2022-10-27 00:39:26 +03:00
pub origin: Option<Origin>,
pub referer: Option<Referer>,
pub user_agent: Option<UserAgent>,
2022-12-12 07:39:54 +03:00
pub authorization_type: AuthorizationType,
2022-10-10 07:15:07 +03:00
}
pub struct KafkaDebugLogger {
topic: String,
key: Vec<u8>,
headers: KafkaOwnedHeaders,
producer: FutureProducer,
num_requests: AtomicUsize,
num_responses: AtomicUsize,
}
/// Ulids and Uuids matching the same bits hash the same
2023-05-24 00:40:34 +03:00
impl Hash for RpcSecretKey {
fn hash<H: Hasher>(&self, state: &mut H) {
let x = match self {
Self::Ulid(x) => x.0,
Self::Uuid(x) => x.as_u128(),
};
x.hash(state);
}
}
impl fmt::Debug for KafkaDebugLogger {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("KafkaDebugLogger")
.field("topic", &self.topic)
.finish_non_exhaustive()
}
}
type KafkaLogResult = Result<(i32, i64), (rdkafka::error::KafkaError, OwnedMessage)>;
impl KafkaDebugLogger {
fn try_new(
app: &Web3ProxyApp,
authorization: Arc<Authorization>,
head_block_num: Option<&U64>,
kafka_topic: &str,
request_ulid: Ulid,
) -> Option<Arc<Self>> {
let kafka_producer = app.kafka_producer.clone()?;
let kafka_topic = kafka_topic.to_string();
let rpc_secret_key_id = authorization
.checks
.rpc_secret_key_id
.map(|x| x.get())
.unwrap_or_default();
let kafka_key =
rmp_serde::to_vec(&rpc_secret_key_id).expect("ids should always serialize with rmp");
let chain_id = app.config.chain_id;
let head_block_num = head_block_num
.copied()
.or_else(|| app.balanced_rpcs.head_block_num());
// TODO: would be nice to have the block hash too
// another item is added with the response, so initial_capacity is +1 what is needed here
let kafka_headers = KafkaOwnedHeaders::new_with_capacity(6)
.insert(KafkaHeader {
key: "rpc_secret_key_id",
value: authorization
.checks
.rpc_secret_key_id
.map(|x| x.to_string())
.as_ref(),
})
.insert(KafkaHeader {
key: "ip",
value: Some(&authorization.ip.to_string()),
})
.insert(KafkaHeader {
key: "request_ulid",
value: Some(&request_ulid.to_string()),
})
.insert(KafkaHeader {
key: "head_block_num",
value: head_block_num.map(|x| x.to_string()).as_ref(),
})
.insert(KafkaHeader {
key: "chain_id",
value: Some(&chain_id.to_le_bytes()),
});
// save the key and headers for when we log the response
let x = Self {
topic: kafka_topic,
key: kafka_key,
headers: kafka_headers,
producer: kafka_producer,
num_requests: 0.into(),
num_responses: 0.into(),
};
let x = Arc::new(x);
Some(x)
}
fn background_log(&self, payload: Vec<u8>) -> JoinHandle<KafkaLogResult> {
let topic = self.topic.clone();
let key = self.key.clone();
let producer = self.producer.clone();
let headers = self.headers.clone();
let f = async move {
let record = FutureRecord::to(&topic)
.key(&key)
.payload(&payload)
.headers(headers);
let produce_future =
producer.send(record, KafkaTimeout::After(Duration::from_secs(5 * 60)));
let kafka_response = produce_future.await;
if let Err((err, msg)) = kafka_response.as_ref() {
error!("produce kafka request: {} - {:?}", err, msg);
// TODO: re-queue the msg? log somewhere else like a file on disk?
// TODO: this is bad and should probably trigger an alarm
};
kafka_response
};
tokio::spawn(f)
}
/// for opt-in debug usage, log the request to kafka
/// TODO: generic type for request
pub fn log_debug_request(&self, request: &JsonRpcRequest) -> JoinHandle<KafkaLogResult> {
// TODO: is rust message pack a good choice? try rkyv instead
let payload =
rmp_serde::to_vec(&request).expect("requests should always serialize with rmp");
self.num_requests.fetch_add(1, atomic::Ordering::AcqRel);
self.background_log(payload)
}
pub fn log_debug_response<R>(&self, response: &R) -> JoinHandle<KafkaLogResult>
where
R: serde::Serialize,
{
let payload =
rmp_serde::to_vec(&response).expect("requests should always serialize with rmp");
self.num_responses.fetch_add(1, atomic::Ordering::AcqRel);
self.background_log(payload)
}
}
#[derive(Debug, Derivative)]
#[derivative(Default)]
2022-10-10 07:15:07 +03:00
pub struct RequestMetadata {
/// TODO: set archive_request during the new instead of after
/// TODO: this is more complex than "requires a block older than X height". different types of data can be pruned differently
2022-11-03 02:14:16 +03:00
pub archive_request: AtomicBool,
pub authorization: Option<Arc<Authorization>>,
pub chain_id: u64,
pub request_ulid: Ulid,
/// Size of the JSON request. Does not include headers or things like that.
pub request_bytes: usize,
/// The JSON-RPC request method.
pub method: Cow<'static, str>,
/// Instant that the request was received (or at least close to it)
/// We use Instant and not timestamps to avoid problems with leap seconds and similar issues
#[derivative(Default(value = "Instant::now()"))]
pub start_instant: Instant,
2022-12-20 02:59:01 +03:00
/// if this is empty, there was a cache_hit
/// otherwise, it is populated with any rpc servers that were used by this request
pub backend_requests: BackendRequests,
/// The number of times the request got stuck waiting because no servers were synced
2022-10-25 06:41:59 +03:00
pub no_servers: AtomicU64,
/// If handling the request hit an application error
/// This does not count things like a transcation reverting or a malformed request
pub error_response: AtomicBool,
/// Size in bytes of the JSON response. Does not include headers or things like that.
pub response_bytes: AtomicU64,
/// How many milliseconds it took to respond to the request
pub response_millis: AtomicU64,
/// What time the (first) response was proxied.
/// TODO: think about how to store response times for ProxyMode::Versus
pub response_timestamp: AtomicI64,
/// True if the response required querying a backup RPC
/// RPC aggregators that query multiple providers to compare response may use this header to ignore our response.
pub response_from_backup_rpc: AtomicBool,
/// If the request is invalid or received a jsonrpc error response (excluding reverts)
pub user_error_response: AtomicBool,
2022-10-10 07:15:07 +03:00
/// ProxyMode::Debug logs requests and responses with Kafka
/// TODO: maybe this shouldn't be determined by ProxyMode. A request param should probably enable this
pub kafka_debug_logger: Option<Arc<KafkaDebugLogger>>,
/// Cancel-safe channel for sending stats to the buffer
pub stat_sender: Option<flume::Sender<AppStat>>,
}
2022-10-10 07:15:07 +03:00
impl Default for Authorization {
fn default() -> Self {
Authorization::internal(None).unwrap()
}
}
impl RequestMetadata {
pub fn proxy_mode(&self) -> ProxyMode {
self.authorization
.as_ref()
.map(|x| x.checks.proxy_mode)
.unwrap_or_default()
}
/// this may drift slightly if multiple servers are handling the same users, but should be close
pub async fn latest_balance(&self) -> Option<Decimal> {
if let Some(x) = self.authorization.as_ref() {
let x = x.checks.latest_balance.read().await.remaining();
Some(x)
} else {
None
}
}
}
#[derive(From)]
pub enum RequestOrMethod<'a> {
/// jsonrpc method (or similar label) and the size that the request should count as (sometimes 0)
Method(&'a str, usize),
Request(&'a JsonRpcRequest),
}
impl<'a> RequestOrMethod<'a> {
fn method(&self) -> Cow<'static, str> {
let x = match self {
Self::Request(x) => x.method.to_string(),
Self::Method(x, _) => x.to_string(),
};
x.into()
}
fn jsonrpc_request(&self) -> Option<&JsonRpcRequest> {
match self {
Self::Request(x) => Some(x),
_ => None,
}
}
fn num_bytes(&self) -> usize {
match self {
RequestOrMethod::Method(_, num_bytes) => *num_bytes,
RequestOrMethod::Request(x) => x.num_bytes(),
}
}
}
impl<'a> From<&'a str> for RequestOrMethod<'a> {
fn from(value: &'a str) -> Self {
Self::Method(value, 0)
}
}
// TODO: i think a trait is actually the right thing to use here
#[derive(From)]
pub enum ResponseOrBytes<'a> {
Json(&'a serde_json::Value),
Response(&'a JsonRpcForwardedResponse),
Bytes(usize),
}
impl<'a> From<u64> for ResponseOrBytes<'a> {
fn from(value: u64) -> Self {
Self::Bytes(value as usize)
}
}
impl ResponseOrBytes<'_> {
pub fn num_bytes(&self) -> usize {
match self {
Self::Json(x) => serde_json::to_string(x)
.expect("this should always serialize")
.len(),
Self::Response(x) => serde_json::to_string(x)
.expect("this should always serialize")
.len(),
Self::Bytes(num_bytes) => *num_bytes,
}
}
}
impl RequestMetadata {
pub async fn new<'a, R: Into<RequestOrMethod<'a>>>(
app: &Web3ProxyApp,
authorization: Arc<Authorization>,
request: R,
head_block: Option<&Web3ProxyBlock>,
) -> Arc<Self> {
let request = request.into();
let method = request.method();
let request_bytes = request.num_bytes();
// TODO: modify the request here? I don't really like that very much. but its a sure way to get archive_request set correctly
// TODO: add the Ulid at the haproxy or amazon load balancer level? investigate OpenTelemetry
let request_ulid = Ulid::new();
let kafka_debug_logger = if matches!(authorization.checks.proxy_mode, ProxyMode::Debug) {
KafkaDebugLogger::try_new(
app,
authorization.clone(),
head_block.map(|x| x.number()),
"web3_proxy:rpc",
request_ulid,
)
} else {
None
};
if let Some(ref kafka_debug_logger) = kafka_debug_logger {
if let Some(request) = request.jsonrpc_request() {
// TODO: channels might be more ergonomic than spawned futures
// spawned things run in parallel easier but generally need more Arcs
kafka_debug_logger.log_debug_request(request);
} else {
// there probably isn't a new request attached to this metadata.
// this happens with websocket subscriptions
}
}
let x = Self {
2022-11-03 02:14:16 +03:00
archive_request: false.into(),
authorization: Some(authorization),
2022-12-20 02:59:01 +03:00
backend_requests: Default::default(),
chain_id: app.config.chain_id,
error_response: false.into(),
kafka_debug_logger,
method,
no_servers: 0.into(),
request_bytes,
request_ulid,
response_bytes: 0.into(),
response_from_backup_rpc: false.into(),
response_millis: 0.into(),
response_timestamp: 0.into(),
start_instant: Instant::now(),
stat_sender: app.stat_sender.clone(),
user_error_response: false.into(),
};
Arc::new(x)
}
pub fn backend_rpcs_used(&self) -> Vec<Arc<Web3Rpc>> {
self.backend_requests.lock().clone()
}
pub fn try_send_stat(mut self) -> Web3ProxyResult<Option<Self>> {
if let Some(stat_sender) = self.stat_sender.take() {
2023-07-08 07:58:00 +03:00
trace!(?self, "sending stat");
let stat: RpcQueryStats = self.try_into()?;
let stat: AppStat = stat.into();
2023-07-08 07:58:00 +03:00
if let Err(err) = stat_sender.try_send(stat) {
error!(?err, "failed sending stat");
// TODO: return it? that seems like it might cause an infinite loop
2023-05-13 02:02:43 +03:00
// TODO: but dropping stats is bad... hmm... i guess better to undercharge customers than overcharge
};
2023-07-08 07:58:00 +03:00
trace!("stat sent successfully");
Ok(None)
} else {
Ok(Some(self))
}
}
pub fn add_response<'a, R: Into<ResponseOrBytes<'a>>>(&'a self, response: R) {
// TODO: fetch? set? should it be None in a Mutex? or a OnceCell?
let response = response.into();
let num_bytes = response.num_bytes() as u64;
self.response_bytes
.fetch_add(num_bytes, atomic::Ordering::AcqRel);
self.response_millis.fetch_add(
self.start_instant.elapsed().as_millis() as u64,
atomic::Ordering::AcqRel,
);
// TODO: record first or last timestamp? really, we need multiple
self.response_timestamp
.store(Utc::now().timestamp(), atomic::Ordering::Release);
if let Some(kafka_debug_logger) = self.kafka_debug_logger.as_ref() {
if let ResponseOrBytes::Response(response) = response {
kafka_debug_logger.log_debug_response(response);
}
}
}
pub fn try_send_arc_stat(self: Arc<Self>) -> anyhow::Result<Option<Arc<Self>>> {
match Arc::try_unwrap(self) {
Ok(x) => {
let not_sent = x.try_send_stat()?.map(Arc::new);
Ok(not_sent)
}
Err(not_sent) => {
trace!(
"could not send stat while {} arcs are active",
Arc::strong_count(&not_sent)
);
Ok(Some(not_sent))
}
}
}
// TODO: helper function to duplicate? needs to clear request_bytes, and all the atomics tho...
}
// TODO: is this where the panic comes from?
impl Drop for RequestMetadata {
fn drop(&mut self) {
if self.stat_sender.is_some() {
// turn `&mut self` into `self`
let x = mem::take(self);
2023-06-29 07:30:00 +03:00
trace!(?self, "request metadata dropped without stat send");
let _ = x.try_send_stat();
}
2022-10-10 07:15:07 +03:00
}
}
2022-11-01 21:54:39 +03:00
impl RpcSecretKey {
2022-09-24 08:53:45 +03:00
pub fn new() -> Self {
Ulid::new().into()
}
}
2022-11-01 21:54:39 +03:00
impl Default for RpcSecretKey {
2022-10-26 00:10:05 +03:00
fn default() -> Self {
Self::new()
}
}
2022-11-01 21:54:39 +03:00
impl Display for RpcSecretKey {
2022-09-24 08:53:45 +03:00
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
// TODO: do this without dereferencing
let ulid: Ulid = (*self).into();
ulid.fmt(f)
}
}
2022-11-01 21:54:39 +03:00
impl FromStr for RpcSecretKey {
type Err = Web3ProxyError;
2022-09-24 08:53:45 +03:00
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 {
2022-10-10 07:15:07 +03:00
// TODO: custom error type so that this shows as a 400
Err(Web3ProxyError::InvalidUserKey)
2022-09-24 08:53:45 +03:00
}
}
}
2022-11-01 21:54:39 +03:00
impl From<Ulid> for RpcSecretKey {
2022-09-24 08:53:45 +03:00
fn from(x: Ulid) -> Self {
2022-11-01 21:54:39 +03:00
RpcSecretKey::Ulid(x)
2022-09-24 08:53:45 +03:00
}
}
2022-11-01 21:54:39 +03:00
impl From<Uuid> for RpcSecretKey {
2022-09-24 08:53:45 +03:00
fn from(x: Uuid) -> Self {
2022-11-01 21:54:39 +03:00
RpcSecretKey::Uuid(x)
2022-09-24 08:53:45 +03:00
}
}
2022-11-01 21:54:39 +03:00
impl From<RpcSecretKey> for Ulid {
fn from(x: RpcSecretKey) -> Self {
2022-09-24 08:53:45 +03:00
match x {
2022-11-01 21:54:39 +03:00
RpcSecretKey::Ulid(x) => x,
RpcSecretKey::Uuid(x) => Ulid::from(x.as_u128()),
2022-09-24 08:53:45 +03:00
}
}
}
2022-11-01 21:54:39 +03:00
impl From<RpcSecretKey> for Uuid {
fn from(x: RpcSecretKey) -> Self {
2022-09-24 08:53:45 +03:00
match x {
2022-11-01 21:54:39 +03:00
RpcSecretKey::Ulid(x) => Uuid::from_u128(x.0),
RpcSecretKey::Uuid(x) => x,
2022-09-24 08:53:45 +03:00
}
}
}
impl Authorization {
pub fn internal(db_conn: Option<DatabaseConnection>) -> Web3ProxyResult<Self> {
let authorization_checks = AuthorizationChecks {
// any error logs on a local (internal) query are likely problems. log them all
2023-06-13 05:13:06 +03:00
log_revert_chance: 100,
// default for everything else should be fine. we don't have a user_id or ip to give
..Default::default()
};
let ip: IpAddr = "127.0.0.1".parse().expect("localhost should always parse");
let user_agent = UserAgent::from_str(APP_USER_AGENT).ok();
Self::try_new(
authorization_checks,
db_conn,
&ip,
None,
None,
user_agent.as_ref(),
2022-12-12 07:39:54 +03:00
AuthorizationType::Internal,
)
}
pub fn external(
allowed_origin_requests_per_period: &HashMap<String, u64>,
db_conn: Option<DatabaseConnection>,
ip: &IpAddr,
origin: Option<&Origin>,
2023-03-03 04:39:50 +03:00
proxy_mode: ProxyMode,
referer: Option<&Referer>,
user_agent: Option<&UserAgent>,
) -> Web3ProxyResult<Self> {
// some origins can override max_requests_per_period for anon users
// TODO: i don't like the `to_string` here
let max_requests_per_period = origin
.map(|origin| {
allowed_origin_requests_per_period
.get(&origin.to_string())
.cloned()
})
.unwrap_or_default();
let authorization_checks = AuthorizationChecks {
max_requests_per_period,
2023-03-03 04:39:50 +03:00
proxy_mode,
..Default::default()
};
Self::try_new(
authorization_checks,
db_conn,
ip,
origin,
referer,
user_agent,
2022-12-12 07:39:54 +03:00
AuthorizationType::Frontend,
)
}
2023-03-03 04:39:50 +03:00
#[allow(clippy::too_many_arguments)]
2022-09-23 00:03:37 +03:00
pub fn try_new(
authorization_checks: AuthorizationChecks,
db_conn: Option<DatabaseConnection>,
ip: &IpAddr,
origin: Option<&Origin>,
referer: Option<&Referer>,
user_agent: Option<&UserAgent>,
2022-12-12 07:39:54 +03:00
authorization_type: AuthorizationType,
) -> Web3ProxyResult<Self> {
// check ip
match &authorization_checks.allowed_ips {
None => {}
Some(allowed_ips) => {
if !allowed_ips.iter().any(|x| x.contains(ip)) {
return Err(Web3ProxyError::IpNotAllowed(ip.to_owned()));
}
}
}
// check origin
match (origin, &authorization_checks.allowed_origins) {
(None, None) => {}
(Some(_), None) => {}
(None, Some(_)) => return Err(Web3ProxyError::OriginRequired),
(Some(origin), Some(allowed_origins)) => {
2022-10-27 00:39:26 +03:00
if !allowed_origins.contains(origin) {
return Err(Web3ProxyError::OriginNotAllowed(origin.to_owned()));
}
}
}
// check referer
match (referer, &authorization_checks.allowed_referers) {
(None, None) => {}
(Some(_), None) => {}
(None, Some(_)) => return Err(Web3ProxyError::RefererRequired),
(Some(referer), Some(allowed_referers)) => {
if !allowed_referers.contains(referer) {
return Err(Web3ProxyError::RefererNotAllowed(referer.to_owned()));
}
}
}
// check user_agent
match (user_agent, &authorization_checks.allowed_user_agents) {
(None, None) => {}
(Some(_), None) => {}
(None, Some(_)) => return Err(Web3ProxyError::UserAgentRequired),
(Some(user_agent), Some(allowed_user_agents)) => {
if !allowed_user_agents.contains(user_agent) {
return Err(Web3ProxyError::UserAgentNotAllowed(user_agent.to_owned()));
}
}
}
2022-09-23 00:03:37 +03:00
Ok(Self {
checks: authorization_checks,
db_conn,
ip: *ip,
origin: origin.cloned(),
referer: referer.cloned(),
user_agent: user_agent.cloned(),
authorization_type,
2022-09-23 00:03:37 +03:00
})
}
}
/// rate limit logins only by ip.
/// we want all origins and referers and user agents to count together
pub async fn login_is_authorized(app: &Web3ProxyApp, ip: IpAddr) -> Web3ProxyResult<Authorization> {
2023-03-03 04:39:50 +03:00
let authorization = match app.rate_limit_login(ip, ProxyMode::Best).await? {
RateLimitResult::Allowed(authorization, None) => authorization,
RateLimitResult::RateLimited(authorization, retry_at) => {
return Err(Web3ProxyError::RateLimited(authorization, retry_at));
2022-09-24 06:59:21 +03:00
}
// TODO: don't panic. give the user an error
x => unimplemented!("rate_limit_login shouldn't ever see these: {:?}", x),
};
Ok(authorization)
2022-09-24 06:59:21 +03:00
}
/// semaphore won't ever be None, but its easier if key auth and ip auth work the same way
/// keep the semaphore alive until the user's request is entirely complete
2022-09-23 00:03:37 +03:00
pub async fn ip_is_authorized(
2022-12-28 09:11:18 +03:00
app: &Arc<Web3ProxyApp>,
ip: &IpAddr,
origin: Option<&Origin>,
2023-03-03 04:39:50 +03:00
proxy_mode: ProxyMode,
) -> Web3ProxyResult<(Authorization, Option<OwnedSemaphorePermit>)> {
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
let (authorization, semaphore) = match app
2023-03-03 04:39:50 +03:00
.rate_limit_by_ip(
&app.config.allowed_origin_requests_per_period,
ip,
origin,
proxy_mode,
)
.await?
{
RateLimitResult::Allowed(authorization, semaphore) => (authorization, semaphore),
RateLimitResult::RateLimited(authorization, retry_at) => {
2022-12-28 06:43:02 +03:00
// TODO: in the background, emit a stat (maybe simplest to use a channel?)
return Err(Web3ProxyError::RateLimited(authorization, retry_at));
2022-09-23 00:03:37 +03:00
}
// TODO: don't panic. give the user an error
x => unimplemented!("rate_limit_by_ip shouldn't ever see these: {:?}", x),
};
// in the background, add the ip to a recent_users map
2022-12-28 09:11:18 +03:00
if app.config.public_recent_ips_salt.is_some() {
let app = app.clone();
let ip = *ip;
2022-12-28 09:11:18 +03:00
let f = async move {
let now = Utc::now().timestamp();
if let Ok(mut redis_conn) = app.redis_conn().await {
2022-12-29 09:21:09 +03:00
let salt = app
.config
.public_recent_ips_salt
.as_ref()
.expect("public_recent_ips_salt must exist in here");
2022-12-28 09:11:18 +03:00
2022-12-29 09:21:09 +03:00
let salted_ip = format!("{}:{}", salt, ip);
2022-12-28 09:11:18 +03:00
2022-12-29 09:21:09 +03:00
let hashed_ip = Bytes::from(keccak256(salted_ip.as_bytes()));
2022-12-28 09:11:18 +03:00
2022-12-29 09:21:09 +03:00
let recent_ip_key = format!("recent_users:ip:{}", app.config.chain_id);
2022-12-28 09:11:18 +03:00
2022-12-29 09:21:09 +03:00
redis_conn
.zadd(recent_ip_key, hashed_ip.to_string(), now)
.await?;
};
2022-12-28 09:11:18 +03:00
Ok::<_, Web3ProxyError>(())
2022-12-28 09:11:18 +03:00
}
.map_err(|err| {
2023-06-29 07:30:00 +03:00
warn!(?err, "background update of recent_users:ip failed");
2022-12-28 09:11:18 +03:00
err
});
tokio::spawn(f);
}
2022-12-28 06:43:02 +03:00
Ok((authorization, semaphore))
2022-09-23 00:03:37 +03:00
}
/// like app.rate_limit_by_rpc_key but converts to a Web3ProxyError;
/// keep the semaphore alive until the user's request is entirely complete
2022-09-23 00:03:37 +03:00
pub async fn key_is_authorized(
app: &Arc<Web3ProxyApp>,
rpc_key: &RpcSecretKey,
ip: &IpAddr,
origin: Option<&Origin>,
2023-03-03 04:39:50 +03:00
proxy_mode: ProxyMode,
referer: Option<&Referer>,
user_agent: Option<&UserAgent>,
) -> Web3ProxyResult<(Authorization, Option<OwnedSemaphorePermit>)> {
2022-09-23 00:03:37 +03:00
// check the rate limits. error if over the limit
// TODO: i think this should be in an "impl From" or "impl Into"
let (authorization, semaphore) = match app
2023-03-03 04:39:50 +03:00
.rate_limit_by_rpc_key(ip, origin, proxy_mode, referer, rpc_key, user_agent)
.await?
{
RateLimitResult::Allowed(authorization, semaphore) => (authorization, semaphore),
RateLimitResult::RateLimited(authorization, retry_at) => {
return Err(Web3ProxyError::RateLimited(authorization, retry_at));
2022-09-23 00:03:37 +03:00
}
RateLimitResult::UnknownKey => return Err(Web3ProxyError::UnknownKey),
2022-09-23 00:03:37 +03:00
};
// TODO: DRY and maybe optimize the hashing
// in the background, add the ip to a recent_users map
if app.config.public_recent_ips_salt.is_some() {
let app = app.clone();
let user_id = authorization.checks.user_id;
let f = async move {
let now = Utc::now().timestamp();
if let Ok(mut redis_conn) = app.redis_conn().await {
2022-12-29 09:21:09 +03:00
let salt = app
.config
.public_recent_ips_salt
.as_ref()
.expect("public_recent_ips_salt must exist in here");
2022-12-29 09:21:09 +03:00
let salted_user_id = format!("{}:{}", salt, user_id);
2022-12-29 09:21:09 +03:00
let hashed_user_id = Bytes::from(keccak256(salted_user_id.as_bytes()));
2022-12-29 10:16:35 +03:00
let recent_user_id_key = format!("recent_users:id:{}", app.config.chain_id);
2022-12-29 09:21:09 +03:00
redis_conn
.zadd(recent_user_id_key, hashed_user_id.to_string(), now)
.await?;
}
Ok::<_, Web3ProxyError>(())
}
.map_err(|err| {
2023-06-29 07:30:00 +03:00
warn!(?err, "background update of recent_users:id failed");
err
});
tokio::spawn(f);
}
Ok((authorization, semaphore))
2022-09-23 00:03:37 +03:00
}
impl Web3ProxyApp {
2022-10-27 03:12:42 +03:00
/// Limit the number of concurrent requests from the given ip address.
pub async fn ip_semaphore(&self, ip: &IpAddr) -> Web3ProxyResult<Option<OwnedSemaphorePermit>> {
2022-10-25 07:01:41 +03:00
if let Some(max_concurrent_requests) = self.config.public_max_concurrent_requests {
let semaphore = self
.ip_semaphores
2023-06-08 03:26:38 +03:00
.get_with_by_ref(ip, async {
2022-10-25 07:01:41 +03:00
// TODO: set max_concurrent_requests dynamically based on load?
2022-10-25 07:31:18 +03:00
let s = Semaphore::new(max_concurrent_requests);
2023-06-08 03:26:38 +03:00
Arc::new(s)
2022-10-25 07:01:41 +03:00
})
2023-06-08 03:26:38 +03:00
.await;
2022-10-25 07:01:41 +03:00
let semaphore_permit = semaphore.acquire_owned().await?;
Ok(Some(semaphore_permit))
} else {
Ok(None)
}
2022-09-28 06:35:55 +03:00
}
2023-05-24 00:40:34 +03:00
/// Limit the number of concurrent requests for a given user across all of their keys
/// keep the semaphore alive until the user's request is entirely complete
2023-05-24 00:40:34 +03:00
pub async fn user_semaphore(
2022-09-28 06:35:55 +03:00
&self,
authorization_checks: &AuthorizationChecks,
ip: &IpAddr,
) -> Web3ProxyResult<Option<OwnedSemaphorePermit>> {
if let Some(max_concurrent_requests) = authorization_checks.max_concurrent_requests {
let user_id = authorization_checks
.user_id
.try_into()
2023-05-18 23:34:22 +03:00
.or(Err(Web3ProxyError::UserIdZero))?;
2022-09-28 06:35:55 +03:00
let semaphore = self
2023-05-24 00:40:34 +03:00
.user_semaphores
.get_with_by_ref(&(user_id, *ip), async move {
2022-10-25 07:31:18 +03:00
let s = Semaphore::new(max_concurrent_requests as usize);
2023-06-08 03:26:38 +03:00
Arc::new(s)
2022-09-28 06:35:55 +03:00
})
2023-06-08 03:26:38 +03:00
.await;
2022-10-10 07:15:07 +03:00
2022-09-28 06:35:55 +03:00
let semaphore_permit = semaphore.acquire_owned().await?;
Ok(Some(semaphore_permit))
} else {
2023-05-24 00:40:34 +03:00
// unlimited concurrency
2022-09-28 06:35:55 +03:00
Ok(None)
}
}
2022-10-26 00:10:05 +03:00
/// Verify that the given bearer token and address are allowed to take the specified action.
/// This includes concurrent request limiting.
/// keep the semaphore alive until the user's request is entirely complete
pub async fn bearer_is_authorized(&self, bearer: Bearer) -> Web3ProxyResult<user::Model> {
2022-12-14 05:13:23 +03:00
// get the user id for this bearer token
let user_bearer_token = UserBearerToken::try_from(bearer)?;
// get the attached address from the database for the given auth_token.
let db_replica = self.db_replica()?;
2022-10-26 00:10:05 +03:00
2022-12-14 05:13:23 +03:00
let user_bearer_uuid: Uuid = user_bearer_token.into();
2022-10-26 00:10:05 +03:00
2022-12-14 05:13:23 +03:00
let user = user::Entity::find()
.left_join(login::Entity)
.filter(login::Column::BearerToken.eq(user_bearer_uuid))
.one(db_replica.as_ref())
2022-10-26 00:10:05 +03:00
.await
.web3_context("fetching user from db by bearer token")?
.web3_context("unknown bearer token")?;
2022-10-26 00:10:05 +03:00
Ok(user)
2022-10-26 00:10:05 +03:00
}
2023-03-03 04:39:50 +03:00
pub async fn rate_limit_login(
&self,
ip: IpAddr,
proxy_mode: ProxyMode,
) -> Web3ProxyResult<RateLimitResult> {
// TODO: dry this up with rate_limit_by_rpc_key?
// we don't care about user agent or origin or referer
let authorization = Authorization::external(
&self.config.allowed_origin_requests_per_period,
self.db_conn().ok().cloned(),
&ip,
None,
2023-03-03 04:39:50 +03:00
proxy_mode,
None,
None,
)?;
// no semaphore is needed here because login rate limits are low
// TODO: are we sure do not we want a semaphore here?
let semaphore = None;
// TODO: if ip is on the local network, always allow?
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 {
Ok(RedisRateLimitResult::Allowed(_)) => {
Ok(RateLimitResult::Allowed(authorization, 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
2022-11-12 11:24:32 +03:00
// // trace!(?ip, "login rate limit exceeded until {:?}", retry_at);
Ok(RateLimitResult::RateLimited(authorization, Some(retry_at)))
2022-09-24 06:59:21 +03:00
}
Ok(RedisRateLimitResult::RetryNever) => {
// TODO: i don't think we'll get here. maybe if we ban an IP forever? seems unlikely
2022-11-12 11:24:32 +03:00
// // trace!(?ip, "login rate limit is 0");
Ok(RateLimitResult::RateLimited(authorization, None))
2022-09-24 06:59:21 +03:00
}
Err(err) => {
// internal error, not rate limit being hit
// TODO: i really want axum to do this for us in a single place.
2022-11-12 11:24:32 +03:00
error!("login rate limiter is unhappy. allowing ip. err={:?}", err);
2022-09-27 05:01:45 +03:00
Ok(RateLimitResult::Allowed(authorization, None))
2022-09-24 06:59:21 +03:00
}
}
} else {
// TODO: if no redis, rate limit with a local cache? "warn!" probably isn't right
Ok(RateLimitResult::Allowed(authorization, None))
2022-09-24 06:59:21 +03:00
}
}
/// origin is included because it can override the default rate limits
2022-10-21 23:59:05 +03:00
pub async fn rate_limit_by_ip(
&self,
allowed_origin_requests_per_period: &HashMap<String, u64>,
ip: &IpAddr,
origin: Option<&Origin>,
2023-03-03 04:39:50 +03:00
proxy_mode: ProxyMode,
) -> Web3ProxyResult<RateLimitResult> {
2023-05-31 08:31:35 +03:00
if ip.is_loopback() {
// TODO: localhost being unlimited should be optional
let authorization = Authorization::internal(self.db_conn().ok().cloned())?;
2023-05-31 08:31:35 +03:00
return Ok(RateLimitResult::Allowed(authorization, None));
}
// ip rate limits don't check referer or user agent
2023-03-31 14:43:41 +03:00
// they do check origin because we can override rate limits for some origins
let authorization = Authorization::external(
allowed_origin_requests_per_period,
self.db_conn().ok().cloned(),
ip,
origin,
2023-03-03 04:39:50 +03:00
proxy_mode,
None,
None,
)?;
2022-09-28 06:35:55 +03:00
2022-09-23 00:03:37 +03:00
if let Some(rate_limiter) = &self.frontend_ip_rate_limiter {
match rate_limiter
.throttle(*ip, authorization.checks.max_requests_per_period, 1)
.await
{
2022-09-27 05:01:45 +03:00
Ok(DeferredRateLimitResult::Allowed) => {
// rate limit allowed us. check concurrent request limits
let semaphore = self.ip_semaphore(ip).await?;
Ok(RateLimitResult::Allowed(authorization, semaphore))
2022-09-27 05:01:45 +03:00
}
2022-09-23 00:03:37 +03:00
Ok(DeferredRateLimitResult::RetryAt(retry_at)) => {
// TODO: set headers so they know when they can retry
2022-11-12 11:24:32 +03:00
// // trace!(?ip, "rate limit exceeded until {:?}", retry_at);
Ok(RateLimitResult::RateLimited(authorization, Some(retry_at)))
2022-09-23 00:03:37 +03:00
}
Ok(DeferredRateLimitResult::RetryNever) => {
// TODO: i don't think we'll get here. maybe if we ban an IP forever? seems unlikely
2022-11-12 11:24:32 +03:00
// // trace!(?ip, "rate limit is 0");
Ok(RateLimitResult::RateLimited(authorization, None))
2022-09-23 00:03:37 +03:00
}
Err(err) => {
// this an internal error of some kind, not the rate limit being hit
2022-09-23 00:03:37 +03:00
// TODO: i really want axum to do this for us in a single place.
2022-11-12 11:24:32 +03:00
error!("rate limiter is unhappy. allowing ip. err={:?}", err);
2022-09-27 05:01:45 +03:00
// at least we can still check the semaphore
let semaphore = self.ip_semaphore(ip).await?;
Ok(RateLimitResult::Allowed(authorization, semaphore))
2022-09-23 00:03:37 +03:00
}
}
} else {
// no redis, but we can still check the ip semaphore
let semaphore = self.ip_semaphore(ip).await?;
2022-09-23 00:03:37 +03:00
// TODO: if no redis, rate limit with a local cache? "warn!" probably isn't right
Ok(RateLimitResult::Allowed(authorization, semaphore))
2022-09-23 00:03:37 +03:00
}
}
/// Get the balance for the user.
///
/// If a subuser calls this function, the subuser needs to have first attained the user_id that the rpc key belongs to.
/// This function should be called anywhere where balance is required (i.e. only rpc calls, I believe ... non-rpc calls don't really require balance)
pub(crate) async fn balance_checks(
&self,
user_id: u64,
) -> Web3ProxyResult<Arc<AsyncRwLock<Balance>>> {
self.user_balance_cache
.try_get_with(user_id, async move {
let db_replica = self.db_replica()?;
2023-07-10 06:13:03 +03:00
let x = match Balance::try_from_db(db_replica.as_ref(), user_id).await? {
None => Err(Web3ProxyError::InvalidUserKey),
Some(x) => Ok(x),
}?;
trace!("Balance for cache retrieved from database is {:?}", x);
Ok(Arc::new(AsyncRwLock::new(x)))
})
.await
.map_err(Into::into)
}
2022-09-23 00:03:37 +03:00
// check the local cache for user data, or query the database
pub(crate) async fn authorization_checks(
2022-11-01 21:54:39 +03:00
&self,
2023-03-03 04:39:50 +03:00
proxy_mode: ProxyMode,
rpc_secret_key: &RpcSecretKey,
) -> Web3ProxyResult<AuthorizationChecks> {
2023-05-24 00:40:34 +03:00
self.rpc_secret_key_cache
.try_get_with_by_ref(rpc_secret_key, async move {
// trace!(?rpc_secret_key, "user cache miss");
2022-09-23 00:03:37 +03:00
let db_replica = self.db_replica()?;
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
2022-11-01 21:54:39 +03:00
// TODO: join on secondary users
// TODO: join on user tier
match rpc_key::Entity::find()
.filter(rpc_key::Column::SecretKey.eq(<Uuid>::from(*rpc_secret_key)))
2022-11-01 21:54:39 +03:00
.filter(rpc_key::Column::Active.eq(true))
.one(db_replica.as_ref())
2022-09-23 00:03:37 +03:00
.await?
{
2022-10-27 03:12:42 +03:00
Some(rpc_key_model) => {
2022-10-27 00:39:26 +03:00
// TODO: move these splits into helper functions
// TODO: can we have sea orm handle this for us?
let allowed_ips: Option<Vec<IpNet>> =
2022-10-27 03:12:42 +03:00
if let Some(allowed_ips) = rpc_key_model.allowed_ips {
2022-10-27 00:39:26 +03:00
let x = allowed_ips
.split(',')
.map(|x| x.trim().parse::<IpNet>())
2022-10-27 00:39:26 +03:00
.collect::<Result<Vec<_>, _>>()?;
Some(x)
} else {
None
};
let allowed_origins: Option<Vec<Origin>> =
2022-10-27 03:12:42 +03:00
if let Some(allowed_origins) = rpc_key_model.allowed_origins {
2022-10-27 00:39:26 +03:00
// TODO: do this without collecting twice?
let x = allowed_origins
.split(',')
.map(|x| HeaderValue::from_str(x.trim()))
2022-10-27 00:39:26 +03:00
.collect::<Result<Vec<_>, _>>()?
.into_iter()
2022-10-27 00:39:26 +03:00
.map(|x| Origin::decode(&mut [x].iter()))
.collect::<Result<Vec<_>, _>>()?;
Some(x)
} else {
None
};
let allowed_referers: Option<Vec<Referer>> =
2022-10-27 03:12:42 +03:00
if let Some(allowed_referers) = rpc_key_model.allowed_referers {
2022-10-27 00:39:26 +03:00
let x = allowed_referers
.split(',')
.map(|x| {
x.trim()
.parse::<Referer>()
.or(Err(Web3ProxyError::InvalidReferer))
})
2022-10-27 00:39:26 +03:00
.collect::<Result<Vec<_>, _>>()?;
Some(x)
} else {
None
};
let allowed_user_agents: Option<Vec<UserAgent>> =
2022-10-27 03:12:42 +03:00
if let Some(allowed_user_agents) = rpc_key_model.allowed_user_agents {
2022-10-27 00:39:26 +03:00
let x: Result<Vec<_>, _> = allowed_user_agents
.split(',')
.map(|x| {
x.trim()
.parse::<UserAgent>()
.or(Err(Web3ProxyError::InvalidUserAgent))
})
2022-10-27 00:39:26 +03:00
.collect();
Some(x?)
} else {
None
};
2022-09-23 00:03:37 +03:00
// Get the user_tier
let user_model = user::Entity::find_by_id(rpc_key_model.user_id)
.one(db_replica.as_ref())
.await?
.web3_context(
"user model was not found, but every rpc_key should have a user",
)?;
let mut user_tier_model = user_tier::Entity::find_by_id(
user_model.user_tier_id,
)
.one(db_replica.as_ref())
.await?
.web3_context(
"related user tier not found, but every user should have a tier",
)?;
let latest_balance = self.balance_checks(rpc_key_model.user_id).await?;
// TODO: Do the logic here, as to how to treat the user, based on balance and initial check
// Clear the cache (not the login!) in the stats if a tier-change happens (clear, but don't modify roles)
if let Some(downgrade_user_tier) = user_tier_model.downgrade_tier_id {
let balance = latest_balance.read().await.clone();
// only consider the user premium if they have paid at least $10 and have a balance > $.01
// otherwise, set user_tier_model to the downograded tier
if balance.total_deposits < Decimal::from(10)
|| balance.remaining() < Decimal::new(1, 2)
{
2023-06-25 01:24:46 +03:00
// TODO: include boolean to mark that the user is downgraded
user_tier_model =
user_tier::Entity::find_by_id(downgrade_user_tier)
.one(db_replica.as_ref())
.await?
.web3_context(format!(
"downgrade user tier ({}) is missing!",
downgrade_user_tier
))?;
}
}
let rpc_key_id =
Some(rpc_key_model.id.try_into().context("db ids are never 0")?);
Ok(AuthorizationChecks {
allowed_ips,
allowed_origins,
allowed_referers,
allowed_user_agents,
latest_balance,
// TODO: is floating point math going to scale this correctly?
log_revert_chance: (rpc_key_model.log_revert_chance * u16::MAX as f64)
as u16,
2022-11-01 22:12:57 +03:00
max_concurrent_requests: user_tier_model.max_concurrent_requests,
max_requests_per_period: user_tier_model.max_requests_per_period,
2023-01-12 01:51:01 +03:00
private_txs: rpc_key_model.private_txs,
2023-03-03 04:39:50 +03:00
proxy_mode,
rpc_secret_key: Some(*rpc_secret_key),
rpc_secret_key_id: rpc_key_id,
user_id: rpc_key_model.user_id,
2022-09-23 00:03:37 +03:00
})
}
None => Ok(AuthorizationChecks::default()),
2022-09-23 00:03:37 +03:00
}
})
2023-05-24 00:40:34 +03:00
.await
2023-06-08 03:26:38 +03:00
.map_err(Into::into)
2022-09-23 00:03:37 +03:00
}
/// Authorized the ip/origin/referer/useragent and rate limit and concurrency
pub async fn rate_limit_by_rpc_key(
2022-11-01 21:54:39 +03:00
&self,
ip: &IpAddr,
origin: Option<&Origin>,
2023-03-03 04:39:50 +03:00
proxy_mode: ProxyMode,
referer: Option<&Referer>,
rpc_key: &RpcSecretKey,
user_agent: Option<&UserAgent>,
) -> Web3ProxyResult<RateLimitResult> {
2023-03-03 04:39:50 +03:00
let authorization_checks = self.authorization_checks(proxy_mode, rpc_key).await?;
2022-09-23 00:03:37 +03:00
// if no rpc_key_id matching the given rpc was found, then we can't rate limit by key
2023-01-19 03:17:43 +03:00
if authorization_checks.rpc_secret_key_id.is_none() {
2022-09-23 00:03:37 +03:00
return Ok(RateLimitResult::UnknownKey);
}
// only allow this rpc_key to run a limited amount of concurrent requests
// TODO: rate limit should be BEFORE the semaphore!
let semaphore = self.user_semaphore(&authorization_checks, ip).await?;
let authorization = Authorization::try_new(
authorization_checks,
self.db_conn().ok().cloned(),
ip,
origin,
referer,
user_agent,
2022-12-12 07:39:54 +03:00
AuthorizationType::Frontend,
)?;
2022-09-27 05:01:45 +03:00
2022-09-23 00:03:37 +03:00
// user key is valid. now check rate limits
if let Some(user_max_requests_per_period) = authorization.checks.max_requests_per_period {
if let Some(rate_limiter) = &self.frontend_registered_user_rate_limiter {
match rate_limiter
.throttle(
RegisteredUserRateLimitKey(authorization.checks.user_id, *ip),
Some(user_max_requests_per_period),
1,
)
.await
{
Ok(DeferredRateLimitResult::Allowed) => {
return Ok(RateLimitResult::Allowed(authorization, semaphore))
}
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
// TODO: emit a stat
// trace!(?rpc_key, "rate limit exceeded until {:?}", retry_at);
return Ok(RateLimitResult::RateLimited(authorization, Some(retry_at)));
}
Ok(DeferredRateLimitResult::RetryNever) => {
// TODO: keys are secret. don't log them!
// trace!(?rpc_key, "rate limit is 0");
// TODO: emit a stat
return Ok(RateLimitResult::RateLimited(authorization, 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 rpc_key");
2022-09-27 05:01:45 +03:00
return Ok(RateLimitResult::Allowed(authorization, semaphore));
}
2022-09-23 00:03:37 +03:00
}
} else {
// TODO: if no redis, rate limit with just a local cache?
2022-09-23 00:03:37 +03:00
}
}
Ok(RateLimitResult::Allowed(authorization, semaphore))
2022-09-23 00:03:37 +03:00
}
}
2023-01-19 03:17:43 +03:00
impl Authorization {
pub async fn check_again(
&self,
app: &Arc<Web3ProxyApp>,
) -> Web3ProxyResult<(Arc<Self>, Option<OwnedSemaphorePermit>)> {
2023-01-19 03:17:43 +03:00
// TODO: we could probably do this without clones. but this is easy
let (a, s) = if let Some(ref rpc_secret_key) = self.checks.rpc_secret_key {
2023-01-19 03:17:43 +03:00
key_is_authorized(
app,
rpc_secret_key,
&self.ip,
self.origin.as_ref(),
2023-03-03 04:39:50 +03:00
self.checks.proxy_mode,
self.referer.as_ref(),
self.user_agent.as_ref(),
2023-01-19 03:17:43 +03:00
)
.await?
} else {
ip_is_authorized(app, &self.ip, self.origin.as_ref(), self.checks.proxy_mode).await?
2023-01-19 03:17:43 +03:00
};
let a = Arc::new(a);
Ok((a, s))
}
}