Struct BasicAuthZone 

pub struct BasicAuthZone {
    pub zone_prefix: WebRoute,
    pub login_path: WebRoute,
    pub logout_path: WebRoute,
    pub post_auth_redirect: Arc<RedirectTargetConfig>,
    pub realm: String,
    /* private fields */
}

Fields

zone_prefix: WebRoute

login_path: WebRoute

logout_path: WebRoute

post_auth_redirect: Arc<RedirectTargetConfig>

realm: String

Implementations

impl BasicAuthZone

pub fn from_isolated_config( config: BasicAuthZoneConfig, ) -> BasicAuthContextResult<Self>

pub fn from_context_config( config: BasicAuthZoneConfig, context: &BasicAuthContext<impl BasicAuthCred + Serialize + for<'a> Deserialize<'a>>, ) -> BasicAuthContextResult<Self>

pub fn challenge_header_value(&self) -> String

Returns WWW-Authenticate header value for the configured realm.

pub fn is_zone_path(&self, request_path: &str) -> bool

Returns true when request path is inside configured middleware zone.

pub fn is_login_path(&self, request_path: &str) -> bool

pub fn is_logout_path(&self, request_path: &str) -> bool

pub fn should_attach_challenge_header( &self, request_path: &str, status: StatusCode, ) -> bool

Rule for whether a WWW-Authenticate challenge header should be attached.

Only emit challenge when unauthorized response comes from login_path.

pub fn login_challenge_protocol_response(&self) -> BasicAuthProtocolResponse

Build the challenge response for login trigger route.

pub fn login_challenge_response(&self) -> HttpResponse

pub fn login_success_response( &self, requested_post_auth_redirect_uri: Option<&str>, ) -> Result<HttpResponse, BasicAuthContextError>

Build success redirect response for a successful /basic/login authentication.

pub fn logout_poison_protocol_response(&self) -> BasicAuthProtocolResponse

Build logout poisoning response.

MUST be 401 without WWW-Authenticate.

pub fn logout_poison_response(&self) -> HttpResponse

pub fn unauthorized_protocol_response_for_path( &self, request_path: &str, ) -> BasicAuthProtocolResponse

Build unauthorized response for generic handler paths.

• for login_path: 401 with challenge header.
• for all other paths: plain 401 without challenge header.

pub fn unauthorized_response_for_path(&self, request_path: &str) -> HttpResponse

pub fn resolve_post_auth_redirect_uri( &self, requested_post_auth_redirect_uri: Option<&str>, ) -> Result<WebRoute, BasicAuthContextError>

Trait Implementations

impl Clone for BasicAuthZone

fn clone(&self) -> BasicAuthZone

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BasicAuthZone

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

Formats the value using the given formatter.