Struct tower_http::auth::RequireAuthorizationLayer

pub struct RequireAuthorizationLayer<T> { /* private fields */ }

Available on crate feature auth only.

Layer that applies RequireAuthorization which authorizes all requests using the Authorization header.

See the module docs for an example.

Implementations

impl<ResBody> RequireAuthorizationLayer<Bearer<ResBody>>

pub fn bearer(token: &str) -> Selfwhere
    ResBody: Body + Default,

Authorize requests using a “bearer token”. Commonly used for OAuth 2.

The Authorization header is required to be Bearer {token}.

Panics

Panics if the token is not a valid HeaderValue.

impl<ResBody> RequireAuthorizationLayer<Basic<ResBody>>

pub fn basic(username: &str, password: &str) -> Selfwhere
    ResBody: Body + Default,

Authorize requests using a username and password pair.

The Authorization header is required to be Basic {credentials} where credentials is base64_encode("{username}:{password}").

Since the username and password is sent in clear text it is recommended to use HTTPS/TLS with this method. However use of HTTPS/TLS is not enforced by this middleware.

impl<T> RequireAuthorizationLayer<T>

pub fn custom(auth: T) -> RequireAuthorizationLayer<T>

Authorize requests using a custom scheme.

Trait Implementations

impl<T: Clone> Clone for RequireAuthorizationLayer<T>

fn clone(&self) -> RequireAuthorizationLayer<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for RequireAuthorizationLayer<T>

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

Formats the value using the given formatter.

impl<S, T> Layer<S> for RequireAuthorizationLayer<T>where
    T: Clone,

type Service = RequireAuthorization<S, T>

The wrapped service

fn layer(&self, inner: S) -> Self::Service

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