Struct ClientAddressConfig 

#[non_exhaustive]
pub struct ClientAddressConfig {
    pub trusted_proxies: Vec<String>,
    pub header: ForwardingHeader,
    pub required: bool,
    pub forward: ForwardConfig,
}

How the client’s address is resolved, for every consumer of it at once (the rate limits, the hooks, the fallback, the upstream), and what the upstream receives of it.

client_address:
  trusted_proxies: ["10.0.0.0/8", "192.0.2.10"]
  header: x_forwarded_for
  required: false
  forward:
    x_forwarded_for: verified
    client_header: x-real-ip
    audit_header: null

The connection’s peer is the client unless it is a trusted proxy; only then is header read, so an address a client asserts itself never counts. The defaults trust no proxy: the right setting for a proxy that faces its clients directly. Resolution and forward are independent: the rate limits and the hooks always use the resolved address, whatever is forwarded.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

trusted_proxies: Vec<String>

Proxies trusted to report the client’s address: CIDR ranges, or bare addresses for one host. An IPv4-mapped IPv6 peer (::ffff:10.0.0.1) matches its IPv4 range. An entry that is neither stops the proxy at startup.

header: ForwardingHeader

The header trusted proxies report the client’s address in.

required: bool

Refuse a request whose client address cannot be resolved: no connection information (INTERNAL, 500), or a trusted proxy’s report that cannot be read (INVALID_ARGUMENT, 400). Off: such a request goes on with no address.

forward: ForwardConfig

What the upstream receives of the client’s address.

Trait Implementations

impl Clone for ClientAddressConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientAddressConfig

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

Formats the value using the given formatter.

impl Default for ClientAddressConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientAddressConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.