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;

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

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

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

Methods

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.

pub fn from_service_request(
    req: &mut ServiceRequest,
    config: &Config
) -> Self::Future

Try to parse actix-web' ServiceRequest and fetch the BasicAuth from it.

Warning

This function is used right now for middleware creation only and might change or be totally removed, depends on actix-web = "1.0" release changes.

This issue will be resolved in the 0.3.0 release. Before that -- brace yourselves!

Trait Implementations

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 = 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::Future

Convert request to a Self

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

Convert request to a Self

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

Create and configure config instance.