Struct ForwardAuthLayer 

pub struct ForwardAuthLayer { /* private fields */ }

Available on crate feature auth only.

Middleware that delegates the allow/deny decision for every request to an external HTTP service. See the module docs for the full flow.

Implementations

impl ForwardAuthLayer

pub fn new(auth_url: impl Into<String>) -> ForwardAuthLayer

Create a layer that calls auth_url (a full http:///https:// URL, e.g. "http://auth.internal/verify") for every request.

Default timeout: 5000ms. HTTPS URLs require the http-client or http2 feature (same requirement as the outbound HTTP client itself).

pub fn identity_header(self, name: impl Into<String>) -> ForwardAuthLayer

The auth service’s response header naming the caller (e.g. X-User-Id): on a 2xx with that header the rest of the request runs as that user (Identity::user). Since 18.14.0.

pub fn copy_header(self, name: impl Into<String>) -> ForwardAuthLayer

Copy name from the auth service’s response onto the forwarded request when the auth service allows the request (2xx). Call multiple times to copy multiple headers. Headers not present on the auth service’s response are left untouched.

pub fn timeout_ms(self, ms: u64) -> ForwardAuthLayer

Override the auth service call timeout (default: 5000ms).

Trait Implementations

impl Middleware for ForwardAuthLayer

fn accepts_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

Headers only: a streamed body passes through untouched.

fn handle( &self, request: &Request, connection: &ConnectionInfo, next: &dyn Application, ) -> Result<Response, String>

fn runs_inline(&self, _request: &Request, _connection: &ConnectionInfo) -> bool

true when this layer’s own work for request never blocks (in-memory state, atomics, short mutexes) — see Application::runs_inline. A WithMiddleware stack runs inline only if every layer and the inner application agree. Default false.

fn is_passthrough( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when handle would do nothing for request but call next (e.g. a rate limit that isn’t configured). A WithMiddleware stack offers the inner application’s execute_async only if every layer passes the request through. Default false.

fn answers_streamed_body( &self, _request: &Request, _connection: &ConnectionInfo, ) -> bool

true when this layer answers request itself — it doesn’t call next — and reads its body as a stream (a proxy forwarding it as it arrives). The body is then streamed whatever the layers after it and the application would say. Requires accepts_streamed_body. Since 18.3.0.

fn layer_name(&self) -> &'static str

A short name for this layer, as tools that describe an app list it (Application::middleware_names): by default the type’s name without its module path or generic parameters (CacheLayer). Since 18.28.0.