Struct ClientIpConfig 

pub struct ClientIpConfig { /* private fields */ }

Settings that decide how a client IP is resolved from a request.

A config uses exactly one trust model, picked as the first step of ClientIpConfig::builder.

• Trust no proxy: no header is read, and every request resolves to the socket peer IP.
• Trusted proxies: headers are read only when the socket peer IP is inside one of the trusted CIDRs.
• Trust all proxies: every socket peer is treated as a trusted proxy.

The default config trusts no proxy.

The crate::ClientIp request guard reads this config out of Rocket’s managed state, so a built config has to be passed to rocket::build().manage(config).

Implementations

impl ClientIpConfig

pub const fn builder() -> ClientIpConfigBuilder

Start building a config by choosing a trust model.

pub fn trusted_proxy_rules(&self) -> &[TrustedProxyRule]

Return the trusted proxy rules, as they look after build-time merging.

This is empty unless the config was built with trusted proxy CIDRs.

pub fn chain_header_order(&self) -> &[ChainHeader]

Return the chain headers in the order they are tried.

This is empty when the config trusts no proxy, because no header is read at all.

pub const fn trust_all_proxy_mode(&self) -> Option<&TrustAllProxyMode>

Return the trust-all proxy settings, if that trust model is in use.

pub const fn trusts_all_proxies(&self) -> bool

Check whether this config treats every socket peer as a trusted proxy.

pub const fn trusts_no_proxy(&self) -> bool

Check whether this config reads no header at all and always answers with the socket peer IP.

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

Check whether an address is treated as a trusted proxy.

An IPv4-mapped IPv6 address is matched by its IPv4 form, on both sides of the comparison. A trusted proxy CIDR written as ::ffff:10.0.0.0/120 is rewritten to 10.0.0.0/24 while the config is built, so it matches the same addresses an IPv4 CIDR would. For the same reason an IPv6 CIDR such as ::/0 never matches an IPv4 peer, so both address families need their own CIDR.

This is always true in trust-all proxy mode, and always false when no proxy is trusted.

impl ClientIpConfig

pub fn resolve_client_ip( &self, headers: &HeaderMap<'_>, peer_ip: IpAddr, ) -> ClientIp

Resolve the client IP of a request from its headers and its socket peer IP.

Use this when the request does not come from Rocket, or when the ClientIp request guard is not convenient. The crate-level docs describe the full order in which the answer is chosen.

Trait Implementations

impl Clone for ClientIpConfig

fn clone(&self) -> ClientIpConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientIpConfig

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

Formats the value using the given formatter.

impl Default for ClientIpConfig

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ClientIpConfig

impl Hash for ClientIpConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ClientIpConfig

fn eq(&self, other: &ClientIpConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ClientIpConfig