Skip to main content

HttpAuthorizer

rama_http::layer::auth

Struct HttpAuthorizer

pub struct HttpAuthorizer<A, C> { /* private fields */ }

Expand description

Utility type to allow you to use any Authorizer that works with Credentials to authorize the Authorization header, and return StatusCode::UNAUTHORIZED response with header::WWW_AUTHENTICATE for unauthorized request, tracing the original error for your convenience.

Implementations§

impl<A, C> HttpAuthorizer<A, C>

pub fn new(authorizer: A) -> Self

pub fn with_allow_anonymous(self, allow: bool) -> Self

Defines whether or not to allow anonymous.

This means that the request is will be authorized automatically, if no Authorization header was passed in.

pub fn set_allow_anonymous(&mut self, allow: bool) -> &mut Self

Defines whether or not to allow anonymous.

This means that the request is will be authorized automatically, if no Authorization header was passed in.

Trait Implementations§

impl<A, C> Authorizer<C> for HttpAuthorizer<A, C>
where A: Authorizer<C, Error: Debug>, C: Credentials + Send + 'static,

type Error = Response

Returned in case the credentials are not authorized.

async fn authorize(&self, credentials: C) -> AuthorizeResult<C, Self::Error>

Authorize the given credentials.

impl<A: Clone, C> Clone for HttpAuthorizer<A, C>

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<A: Debug, C> Debug for HttpAuthorizer<A, C>

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

Formats the value using the given formatter. Read more

impl From<Basic> for HttpAuthorizer<StaticAuthorizer<Basic>, Basic>

fn from(value: Basic) -> Self

Converts to this type from the input type.

impl From<Bearer> for HttpAuthorizer<StaticAuthorizer<Bearer>, Bearer>

fn from(value: Bearer) -> Self

Converts to this type from the input type.

impl From<RawToken> for HttpAuthorizer<StaticAuthorizer<RawToken>, RawToken>

fn from(value: RawToken) -> Self

Converts to this type from the input type.

impl<C: Credentials> From<Vec<C>> for HttpAuthorizer<Vec<C>, C>

fn from(value: Vec<C>) -> Self

Converts to this type from the input type.

impl<const N: usize, C: Credentials> From<[C; N]> for HttpAuthorizer<[C; N], C>

fn from(value: [C; N]) -> Self

Converts to this type from the input type.

impl<ReqBody, A, C> ValidateRequest<ReqBody> for HttpAuthorizer<A, C>
where ReqBody: Send + 'static, A: Authorizer<C, Error: Debug>, C: Credentials + Send + 'static,

type ResponseBody = Body

The body type used for responses to unvalidated requests.

async fn validate( &self, request: Request<ReqBody>, ) -> Result<Request<ReqBody>, Response<Self::ResponseBody>>

Validate the request. Read more

Auto Trait Implementations§

impl<A, C> Freeze for HttpAuthorizer<A, C>
where A: Freeze,

impl<A, C> RefUnwindSafe for HttpAuthorizer<A, C>
where A: RefUnwindSafe,

impl<A, C> Send for HttpAuthorizer<A, C>
where A: Send,

impl<A, C> Sync for HttpAuthorizer<A, C>
where A: Sync,

impl<A, C> Unpin for HttpAuthorizer<A, C>
where A: Unpin,

impl<A, C> UnsafeUnpin for HttpAuthorizer<A, C>
where A: UnsafeUnpin,

impl<A, C> UnwindSafe for HttpAuthorizer<A, C>
where A: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T, U> RamaFrom<T> for U
where U: From<T>,

fn rama_from(value: T) -> U

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

fn rama_into(self) -> U

impl<T, U> RamaTryFrom<T> for U
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more