Struct Config

pub struct Config { /* private fields */ }

Config for trusted proxies extractor

By default, it trusts the following:

• IPV4 Loopback
• IPV4 Private Networks
• IPV6 Loopback
• IPV6 Private Networks

It also trusts the Forwarded and X-Forwarded-For header by default.

Example

use trusted_proxies::Config;

let mut config = Config::new_local();
config.add_trusted_ip("168.10.0.0/16").unwrap();
config.trust_x_forwarded_host();

Implementations

impl Config

pub fn new() -> Self

Create a new TrustedProxies instance with no trusted proxies or headers

pub fn new_local() -> Self

Create a new TrustedProxies instance with local and private networks ip trusted and FORWARDED / X-Forwarded-For headers trusted

pub fn add_trusted_ip(&mut self, proxy: &str) -> Result<(), AddrParseError>

Add a trusted proxy to the list of trusted proxies

proxy can be an IP address or a CIDR

pub fn is_ip_trusted(&self, remote_addr: &IpAddr) -> bool

Check if a remote address is trusted given the list of trusted proxies

pub fn trust_forwarded(&mut self)

Trust the Forwarded header

pub fn trust_x_forwarded_for(&mut self)

Trust the X-Forwarded-For header

pub fn trust_x_forwarded_host(&mut self)

Trust the X-Forwarded-Host header to fetch the host and optionally the port

It is not recommended to trust this header as it can be easily spoofed, however you can trust it if you are behind a reverse proxy that always sets this header.

If there is multiple values in the header, the last one is used, even if there is multiple proxies in the chain.

If you need to get the original value with multiple proxies in the chain, you can use the Forwarded header that allows to do that in a secure way. See RFC7239 for more information.

pub fn trust_x_forwarded_proto(&mut self)

Trust the X-Forwarded-Proto header to fetch the scheme

It is not recommended to trust this header as it can be easily spoofed, however you can trust it if you are behind a reverse proxy that always sets this header.

If there is multiple values in the header, the last one is used, even if there is multiple proxies in the chain.

If you need to get the original value with multiple proxies in the chain, you can use the Forwarded header that allows to do that in a secure way. See RFC7239 for more information.

pub fn trust_x_forwarded_by(&mut self)

Trust the X-Forwarded-By header to identify the proxy that sent the request

It is not recommended to trust this header as it can be easily spoofed, however you can trust it if you are behind a reverse proxy that always sets this header.

If there is multiple values in the header, the last one is used, even if there is multiple proxies in the chain.

If you need to get the original value with multiple proxies in the chain, you can use the Forwarded header that allows to do that in a secure way. See RFC7239 for more information.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.