Struct ForwardConfig 

#[non_exhaustive]
pub struct ForwardConfig {
    pub x_forwarded_for: XForwardedFor,
    pub client_header: Option<String>,
    pub audit_header: Option<String>,
}

What the upstream (and the fallback) receives of the client’s address.

The defaults give an upstream nothing a client can forge: a verified X-Forwarded-For whose first element is the client, and the address in X-Real-IP. Every header named here is written by the proxy alone; a guard (JWT claim headers, ext_authz, the auth decider) cannot set it.

Behind	Setting
nginx, $proxy_add_x_forwarded_for and X-Real-IP	x_forwarded_for: append, client_header: x-real-ip
Envoy, use_remote_address	append, client_header: x-envoy-external-address
HAProxy, option forwardfor	append
AWS ALB append / preserve / remove	the mode of the same name
Cloudflare	append, client_header: cf-connecting-ip
Traefik, Caddy	verified (stricter), or append

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.

x_forwarded_for: XForwardedFor

What X-Forwarded-For carries upstream.

client_header: Option<String>

The header the resolved address is written to, replacing any value the request carried; absent when no address resolved. None (null in YAML) writes none. A text gRPC metadata key (not ending in -bin) other than x-forwarded-for and forwarded. Default: x-real-ip.

audit_header: Option<String>

A header receiving the X-Forwarded-For field lines exactly as the request carried them, before any change: for logs and audits only, since nothing in it is verified. Off by default. A text gRPC metadata key (not ending in -bin) other than x-forwarded-for, x-real-ip, forwarded and client_header, e.g. x-original-forwarded-for.

Trait Implementations

impl Clone for ForwardConfig

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 ForwardConfig

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

Formats the value using the given formatter.

impl Default for ForwardConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ForwardConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.