Struct TrustedProxyIpKeyExtractor 

pub struct TrustedProxyIpKeyExtractor { /* private fields */ }

Implementations

impl TrustedProxyIpKeyExtractor

pub fn new(trusted_proxies: &[String]) -> Self

Builds an extractor from raw trusted proxy entries.

Entries may be CIDR ranges or single IP addresses. Invalid entries are skipped by aster_forge_utils::net::parse_trusted_proxies after logging a warning.

pub fn from_trusted(trusted: Vec<IpNet>) -> Self

Builds an extractor from an already parsed trusted proxy list.

pub fn with_rejection_response<F>(self, factory: F) -> Self

where F: Fn(u64, HttpResponseBuilder) -> HttpResponse + Send + Sync + 'static,

Uses a product-provided response factory when the request exceeds its quota.

The factory receives the retry delay in whole seconds and the response builder created by actix-governor. Products can use this to preserve their response envelope and error code without reimplementing trusted-proxy extraction.

pub fn is_trusted(&self, ip: IpAddr) -> bool

Returns whether the provided IP is trusted as a proxy.

pub fn real_ip(&self, req: &ServiceRequest, peer: IpAddr) -> IpAddr

Resolves the client IP for a request and direct peer IP.

Trait Implementations

impl Clone for TrustedProxyIpKeyExtractor

fn clone(&self) -> TrustedProxyIpKeyExtractor

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TrustedProxyIpKeyExtractor

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl KeyExtractor for TrustedProxyIpKeyExtractor

type Key = IpAddr

The type of the key.

type KeyExtractionError = SimpleKeyExtractionError<&'static str>

The type of the error that can occur if key extraction from the request fails.

fn extract( &self, req: &ServiceRequest, ) -> Result<Self::Key, Self::KeyExtractionError>

Extraction method, will return KeyExtractionError response when the extract failed

fn exceed_rate_limit_response( &self, negative: &NotUntil<QuantaInstant>, response: HttpResponseBuilder, ) -> HttpResponse

The content you want to show it when the rate limit is exceeded. You can calculate the time at which a caller can expect the next positive rate-limiting result by using [NotUntil]. The [HttpResponseBuilder] allows you to build a fully customized [HttpResponse] in case of an error.

fn whitelisted_keys(&self) -> Vec<Self::Key>

Returns a list of whitelisted keys. If a key is in this list, it will never be rate-limited.