Struct ClientAddressLayer 

pub struct ClientAddressLayer { /* private fields */ }

Resolves the client address of every request before the service it wraps sees it: puts the ClientAddress on the request and rewrites its forwarding headers, as the proxy does before its own guards.

The proxy applies it itself. Use it in a router of your own that mounts proxy parts such as the shield middleware directly, so they key by the client behind your trusted proxies rather than by the proxies’ own address. The peer comes from the ConnectInfo<SocketAddr> an axum server records (into_make_service_with_connect_info) or the TcpConnectInfo a tonic server does; without one the address is Resolution::Unavailable. required is not enforced here: read ClientAddress::resolution where it matters.

Examples

use structured_proxy::client_address::ClientAddressLayer;
use structured_proxy::config::ClientAddressConfig;

let mut trust = ClientAddressConfig::default();
trust.trusted_proxies = vec!["10.0.0.0/8".into()];
let app: axum::Router = axum::Router::new()
    .route("/", axum::routing::get(|| async { "ok" }))
    .layer(ClientAddressLayer::new(&trust).unwrap());

Implementations

impl ClientAddressLayer

pub fn new(config: &ClientAddressConfig) -> Result<Self>

The resolution config describes.

Errors

A trusted_proxies entry that is neither a CIDR range nor an address.

Trait Implementations

impl Clone for ClientAddressLayer

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 ClientAddressLayer

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

Formats the value using the given formatter.

impl<S> Layer<S> for ClientAddressLayer

type Service = ClientAddressService<S>

The wrapped service

fn layer(&self, inner: S) -> ClientAddressService<S>

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.