Struct AddAuthorization

pub struct AddAuthorization<S> { /* private fields */ }

Middleware that adds authorization all requests using the Authorization header.

See the module docs for an example.

You can also use SetRequestHeader if you have a use case that isn’t supported by this middleware.

Implementations

impl<S> AddAuthorization<S>

pub fn none(inner: S) -> Self

Create a new AddAuthorization that does not add any authorization.

Can be useful if you only want to add authorization for some branches of your service.

pub fn basic(inner: S, username: &str, password: &str) -> Self

Authorize requests using a username and password pair.

The Authorization header will be set to 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.

pub fn bearer(inner: S, token: &str) -> Self

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

The Authorization header will be set to Bearer {token}.

Panics

Panics if the token is not a valid HeaderValue.

pub fn get_ref(&self) -> &S

Gets a reference to the underlying service.

pub fn into_inner(self) -> S

Consumes self, returning the underlying service.

pub fn as_sensitive(self, sensitive: bool) -> Self

Mark the header as sensitive.

This can for example be used to hide the header value from logs.

pub fn set_as_sensitive(&mut self, sensitive: bool) -> &mut Self

Mark the header as sensitive.

This can for example be used to hide the header value from logs.

pub fn if_not_present(self, value: bool) -> Self

Preserve the existing Authorization header if it exists.

This can be useful if you want to use different authorization headers for different requests.

pub fn set_if_not_present(&mut self, value: bool) -> &mut Self

Preserve the existing Authorization header if it exists.

This can be useful if you want to use different authorization headers for different requests.

Trait Implementations

impl<S: Clone> Clone for AddAuthorization<S>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for AddAuthorization<S>

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

Formats the value using the given formatter.

impl<S, State, ReqBody, ResBody> Service<State, Request<ReqBody>> for AddAuthorization<S>

where S: Service<State, Request<ReqBody>, Response = Response<ResBody>>, ReqBody: Send + 'static, ResBody: Send + 'static, State: Clone + Send + Sync + 'static,

type Response = <S as Service<State, Request<ReqBody>>>::Response

The type of response returned by the service.

type Error = <S as Service<State, Request<ReqBody>>>::Error

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request<ReqBody>, ) -> Result<Self::Response, Self::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.