Struct Trusted

pub struct Trusted<'a> {
    pub host: Option<&'a str>,
    pub scheme: Option<&'a str>,
    pub by: Option<&'a str>,
    pub ip: IpAddr,
}

Trusted data extracted from a request

Values returned by this struct are trusted and can be used to determine the real client information, given your configuration.

Example

use trusted_proxies::{Config, Trusted};

let config = Config::new_local();
let mut request = http::Request::get("/").body(()).unwrap();
request.headers_mut().insert(http::header::FORWARDED, "for=1.2.3.4; proto=https; by=myproxy; host=mydomain.com:8080".parse().unwrap());
let socket_ip_addr = core::net::IpAddr::from([127, 0, 0, 1]);

let trusted = Trusted::from(socket_ip_addr, &request, &config);

assert_eq!(trusted.scheme(), Some("https"));
assert_eq!(trusted.host(), Some("mydomain.com"));
assert_eq!(trusted.port(), Some(8080));
assert_eq!(trusted.ip(), core::net::IpAddr::from([1, 2, 3, 4]));

Fields

host: Option<&'a str>

scheme: Option<&'a str>

by: Option<&'a str>

ip: IpAddr

Implementations

impl<'a> Trusted<'a>

pub fn scheme(&self) -> Option<&str>

Get the scheme of the request

pub fn host_with_port(&self) -> Option<&str>

Get the host and potential port of the request

pub fn host(&self) -> Option<&str>

Get the host of the request (without port)

pub fn port(&self) -> Option<u16>

Get the port of the request

pub fn by(&self) -> Option<&str>

Get the proxy that forwarded the request

pub fn ip(&self) -> IpAddr

Get first untrusted IP address from the request, which should be in most cases the real client IP address

pub fn from<T: RequestInformation>( ip_addr: IpAddr, request: &'a T, config: &Config, ) -> Self

Create a new Trusted struct from a peer address, a request and a configuration

Trait Implementations

impl<'a> Clone for Trusted<'a>

fn clone(&self) -> Trusted<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Trusted<'a>

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

Formats the value using the given formatter.