Struct actix_web_httpauth::extractors::basic::BasicAuth

pub struct BasicAuth(_);

Extractor for HTTP Basic auth.

Example

use actix_web::Result;
use actix_web_httpauth::extractors::basic::BasicAuth;

async fn index(auth: BasicAuth) -> String {
    format!("Hello, {}!", auth.user_id())
}

If authentication fails, this extractor fetches the Config instance from the app data in order to properly form the WWW-Authenticate response header.

Example

use actix_web::{web, App};
use actix_web_httpauth::extractors::basic::{BasicAuth, Config};

async fn index(auth: BasicAuth) -> String {
    format!("Hello, {}!", auth.user_id())
}

fn main() {
    let app = App::new()
        .app_data(Config::default().realm("Restricted area"))
        .service(web::resource("/index.html").route(web::get().to(index)));
}

Implementations

impl BasicAuth

pub fn user_id(&self) -> &Cow<'static, str>

Returns client’s user-ID.

pub fn password(&self) -> Option<&Cow<'static, str>>

Returns client’s password.

Trait Implementations

impl AuthExtractor for BasicAuth

type Error = AuthenticationError<Challenge>

The associated error which can be returned.

type Future = Ready<Result<Self, Self::Error>>

Future that resolves into extracted credentials type.

fn from_service_request(req: &ServiceRequest) -> Self::Future

Parse the authentication credentials from the actix’ ServiceRequest.

impl Clone for BasicAuth

fn clone(&self) -> BasicAuth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BasicAuth

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

Formats the value using the given formatter.

impl FromRequest for BasicAuth

type Future = Ready<Result<Self, Self::Error>>

Future that resolves to a Self.

type Config = Config

Configuration for this extractor.

type Error = AuthenticationError<Challenge>

The associated error which can be returned.

fn from_request(
    req: &HttpRequest,
    _: &mut Payload
) -> <Self as FromRequest>::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.

fn configure<F>(f: F) -> Self::Config where
    F: FnOnce(Self::Config) -> Self::Config, 

Create and configure config instance.