[−][src]Struct actori_web_httpauth::middleware::HttpAuthentication
Middleware for checking HTTP authentication.
If there is no Authorization
header in the request,
this middleware returns an error immediately,
without calling the F
callback.
Otherwise, it will pass both the request and
the parsed credentials into it.
In case of successful validation F
callback
is required to return the ServiceRequest
back.
Methods
impl<T, F, O> HttpAuthentication<T, F> where
T: AuthExtractor,
F: Fn(ServiceRequest, T) -> O,
O: Future<Output = Result<ServiceRequest, Error>>,
[src]
T: AuthExtractor,
F: Fn(ServiceRequest, T) -> O,
O: Future<Output = Result<ServiceRequest, Error>>,
pub fn with_fn(process_fn: F) -> HttpAuthentication<T, F>
[src]
Construct HttpAuthentication
middleware
with the provided auth extractor T
and
validation callback F
.
impl<F, O> HttpAuthentication<BasicAuth, F> where
F: Fn(ServiceRequest, BasicAuth) -> O,
O: Future<Output = Result<ServiceRequest, Error>>,
[src]
F: Fn(ServiceRequest, BasicAuth) -> O,
O: Future<Output = Result<ServiceRequest, Error>>,
pub fn basic(process_fn: F) -> Self
[src]
Construct HttpAuthentication
middleware for the HTTP "Basic"
authentication scheme.
Example
// In this example validator returns immediately, // but since it is required to return anything // that implements `IntoFuture` trait, // it can be extended to query database // or to do something else in a async manner. async fn validator( req: ServiceRequest, credentials: BasicAuth, ) -> Result<ServiceRequest, Error> { // All users are great and more than welcome! Ok(req) } let middleware = HttpAuthentication::basic(validator);
impl<F, O> HttpAuthentication<BearerAuth, F> where
F: Fn(ServiceRequest, BearerAuth) -> O,
O: Future<Output = Result<ServiceRequest, Error>>,
[src]
F: Fn(ServiceRequest, BearerAuth) -> O,
O: Future<Output = Result<ServiceRequest, Error>>,
pub fn bearer(process_fn: F) -> Self
[src]
Construct HttpAuthentication
middleware for the HTTP "Bearer"
authentication scheme.
Example
async fn validator(req: ServiceRequest, credentials: BearerAuth) -> Result<ServiceRequest, Error> { if credentials.token() == "mF_9.B5f-4.1JqM" { Ok(req) } else { let config = req.app_data::<Config>() .map(|data| data.get_ref().clone()) .unwrap_or_else(Default::default) .scope("urn:example:channel=HBO&urn:example:rating=G,PG-13"); Err(AuthenticationError::from(config).into()) } } let middleware = HttpAuthentication::bearer(validator);
Trait Implementations
impl<T: Clone, F: Clone> Clone for HttpAuthentication<T, F> where
T: AuthExtractor,
[src]
T: AuthExtractor,
fn clone(&self) -> HttpAuthentication<T, F>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T: Debug, F: Debug> Debug for HttpAuthentication<T, F> where
T: AuthExtractor,
[src]
T: AuthExtractor,
impl<S, B, T, F, O> Transform<S> for HttpAuthentication<T, F> where
S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
S::Future: 'static,
F: Fn(ServiceRequest, T) -> O + 'static,
O: Future<Output = Result<ServiceRequest, Error>> + 'static,
T: AuthExtractor + 'static,
[src]
S: Service<Request = ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
S::Future: 'static,
F: Fn(ServiceRequest, T) -> O + 'static,
O: Future<Output = Result<ServiceRequest, Error>> + 'static,
T: AuthExtractor + 'static,
type Request = ServiceRequest
Requests handled by the service.
type Response = ServiceResponse<B>
Responses given by the service.
type Error = Error
Errors produced by the service.
type Transform = AuthenticationMiddleware<S, F, T>
The TransformService
value created by this factory
type InitError = ()
Errors produced while building a transform service.
type Future = Ready<Result<Self::Transform, Self::InitError>>
The future response value.
fn new_transform(&self, service: S) -> Self::Future
[src]
fn map_init_err<F, E>(self, f: F) -> TransformMapInitErr<Self, S, F, E> where
F: Fn(Self::InitError) -> E + Clone,
[src]
F: Fn(Self::InitError) -> E + Clone,
Auto Trait Implementations
impl<T, F> RefUnwindSafe for HttpAuthentication<T, F> where
F: RefUnwindSafe,
T: RefUnwindSafe,
F: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, F> Send for HttpAuthentication<T, F> where
F: Send + Sync,
T: Send,
F: Send + Sync,
T: Send,
impl<T, F> Sync for HttpAuthentication<T, F> where
F: Send + Sync,
T: Sync,
F: Send + Sync,
T: Sync,
impl<T, F> Unpin for HttpAuthentication<T, F> where
T: Unpin,
T: Unpin,
impl<T, F> UnwindSafe for HttpAuthentication<T, F> where
F: RefUnwindSafe,
T: UnwindSafe,
F: RefUnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
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>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
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>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,