# Struct actix_web_httpauth::middleware::HttpAuthentication

source · [−]

    pub struct HttpAuthentication<T, F> where
        T: AuthExtractor,  { /* private fields */ }

Expand description

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.

## Implementations

source

### impl<T, F, O> HttpAuthentication<T, F> where
T: AuthExtractor,
F: Fn(ServiceRequest, T) -> O,
O: Future<Output = Result<ServiceRequest, Error>>,

source

#### pub fn with_fn(process_fn: F) -> HttpAuthentication<T, F>

Construct `HttpAuthentication` middleware with the provided auth extractor `T` and validation callback `F`.

source

### impl<F, O> HttpAuthentication<BasicAuth, F> where
F: Fn(ServiceRequest, BasicAuth) -> O,
O: Future<Output = Result<ServiceRequest, Error>>,

source

#### pub fn basic(process_fn: F) -> Self

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);

source

### impl<F, O> HttpAuthentication<BearerAuth, F> where
F: Fn(ServiceRequest, BearerAuth) -> O,
O: Future<Output = Result<ServiceRequest, Error>>,

source

#### pub fn bearer(process_fn: F) -> Self

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.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

source

### impl<T: Clone, F: Clone> Clone for HttpAuthentication<T, F> where
T: AuthExtractor,

source

#### fn clone(&self) -> HttpAuthentication<T, F>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from `source`. Read more

source

### impl<T: Debug, F: Debug> Debug for HttpAuthentication<T, F> where
T: AuthExtractor,

source

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

Formats the value using the given formatter. Read more

source

### impl<S, B, T, F, O> Transform<S, ServiceRequest> for HttpAuthentication<T, F> where
S: Service<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,
B: MessageBody + 'static,

#### type Response = ServiceResponse<EitherBody<B>>

Responses produced 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.

source

#### fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously

## Auto Trait Implementations

### impl<T, F> RefUnwindSafe for HttpAuthentication<T, F> where
F: RefUnwindSafe,
T: RefUnwindSafe,

### impl<T, F> Send for HttpAuthentication<T, F> where
F: Send + Sync,
T: Send,

### impl<T, F> Sync for HttpAuthentication<T, F> where
F: Send + Sync,
T: Sync,

### impl<T, F> Unpin for HttpAuthentication<T, F> where
T: Unpin,

### impl<T, F> UnwindSafe for HttpAuthentication<T, F> where
F: RefUnwindSafe,
T: UnwindSafe,

## Blanket Implementations

source

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

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

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

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

### impl<T> Instrument for T

source

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

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

source

#### fn in_current_span(self) -> Instrumented<Self>

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

source

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

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

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

source

### impl<T> Same<T> for T

#### type Output = T

Should always be `Self`

source

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

#### type Owned = T

The resulting type after obtaining ownership.

source

#### fn to_owned(&self) -> T

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

source

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

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

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

source

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

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

### 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.

const: unstable · source

#### 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

source

### impl<T> WithSubscriber for T

source

#### 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

source

#### fn with_current_subscriber(self) -> WithDispatch<Self>

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