Struct actix_web_httpauth::middleware::HttpAuthentication
source · pub struct HttpAuthentication<T, F>where
T: FromRequest,{ /* 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: FromRequest,
F: Fn(ServiceRequest, T) -> O,
O: Future<Output = Result<ServiceRequest, (Error, ServiceRequest)>>,
impl<T, F, O> HttpAuthentication<T, F>where
T: FromRequest,
F: Fn(ServiceRequest, T) -> O,
O: Future<Output = Result<ServiceRequest, (Error, ServiceRequest)>>,
sourcepub fn with_fn(process_fn: F) -> HttpAuthentication<T, F>
pub fn with_fn(process_fn: F) -> HttpAuthentication<T, F>
Construct HttpAuthentication
middleware with the provided auth extractor T
and
validation callback F
.
This function can be used to implement optional authentication and/or custom responses to missing authentication.
§Examples
§Required Basic Auth
async fn validator(
req: ServiceRequest,
credentials: BasicAuth,
) -> Result<ServiceRequest, (actix_web::Error, ServiceRequest)> {
eprintln!("{credentials:?}");
if credentials.user_id().contains('x') {
return Err((actix_web::error::ErrorBadRequest("user ID contains x"), req));
}
Ok(req)
}
§Optional Bearer Auth
async fn validator(
req: ServiceRequest,
credentials: Option<BearerAuth>,
) -> Result<ServiceRequest, (actix_web::Error, ServiceRequest)> {
let Some(credentials) = credentials else {
return Err((actix_web::error::ErrorBadRequest("no bearer header"), req));
};
eprintln!("{credentials:?}");
if credentials.token().contains('x') {
return Err((actix_web::error::ErrorBadRequest("token contains x"), req));
}
Ok(req)
}
source§impl<F, O> HttpAuthentication<BasicAuth, F>where
F: Fn(ServiceRequest, BasicAuth) -> O,
O: Future<Output = Result<ServiceRequest, (Error, ServiceRequest)>>,
impl<F, O> HttpAuthentication<BasicAuth, F>where
F: Fn(ServiceRequest, BasicAuth) -> O,
O: Future<Output = Result<ServiceRequest, (Error, ServiceRequest)>>,
sourcepub fn basic(process_fn: F) -> Self
pub fn basic(process_fn: F) -> Self
Construct HttpAuthentication
middleware for the HTTP “Basic” authentication scheme.
§Examples
// 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, ServiceRequest)> {
// 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, ServiceRequest)>>,
impl<F, O> HttpAuthentication<BearerAuth, F>where
F: Fn(ServiceRequest, BearerAuth) -> O,
O: Future<Output = Result<ServiceRequest, (Error, ServiceRequest)>>,
sourcepub fn bearer(process_fn: F) -> Self
pub fn bearer(process_fn: F) -> Self
Construct HttpAuthentication
middleware for the HTTP “Bearer” authentication scheme.
§Examples
async fn validator(
req: ServiceRequest,
credentials: BearerAuth
) -> Result<ServiceRequest, (Error, ServiceRequest)> {
if credentials.token() == "mF_9.B5f-4.1JqM" {
Ok(req)
} else {
let config = req.app_data::<bearer::Config>()
.cloned()
.unwrap_or_default()
.scope("urn:example:channel=HBO&urn:example:rating=G,PG-13");
Err((AuthenticationError::from(config).into(), req))
}
}
let middleware = HttpAuthentication::bearer(validator);
Trait Implementations§
source§impl<T, F: Clone> Clone for HttpAuthentication<T, F>where
T: FromRequest + Clone,
impl<T, F: Clone> Clone for HttpAuthentication<T, F>where
T: FromRequest + Clone,
source§fn clone(&self) -> HttpAuthentication<T, F>
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)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<T, F: Debug> Debug for HttpAuthentication<T, F>where
T: FromRequest + Debug,
impl<T, F: Debug> Debug for HttpAuthentication<T, F>where
T: FromRequest + Debug,
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, ServiceRequest)>> + 'static,
T: FromRequest + 'static,
B: MessageBody + 'static,
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, ServiceRequest)>> + 'static,
T: FromRequest + 'static,
B: MessageBody + 'static,
§type Response = ServiceResponse<EitherBody<B>>
type Response = ServiceResponse<EitherBody<B>>
Responses produced by the service.
§type Transform = AuthenticationMiddleware<S, F, T>
type Transform = AuthenticationMiddleware<S, F, T>
The
TransformService
value created by this factory§type Future = Ready<Result<<HttpAuthentication<T, F> as Transform<S, ServiceRequest>>::Transform, <HttpAuthentication<T, F> as Transform<S, ServiceRequest>>::InitError>>
type Future = Ready<Result<<HttpAuthentication<T, F> as Transform<S, ServiceRequest>>::Transform, <HttpAuthentication<T, F> as Transform<S, ServiceRequest>>::InitError>>
The future response value.
source§fn new_transform(&self, service: S) -> Self::Future
fn new_transform(&self, service: S) -> Self::Future
Creates and returns a new Transform component, asynchronously
Auto Trait Implementations§
impl<T, F> Freeze for HttpAuthentication<T, F>
impl<T, F> RefUnwindSafe for HttpAuthentication<T, F>where
T: RefUnwindSafe,
F: RefUnwindSafe,
impl<T, F> Send for HttpAuthentication<T, F>
impl<T, F> Sync for HttpAuthentication<T, F>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)