Struct AuthState 

pub struct AuthState { /* private fields */ }

Authentication middleware state. Cloning it shares the state.

Implementations

impl AuthState

pub fn new(config: AuthConfig) -> Self

pub fn is_enabled(&self) -> bool

Check if authentication is enabled

pub async fn verify_credentials(&self, username: &str, password: &str) -> bool

Verify credentials from an unknown client address.

Equivalent to check with no client address, returning whether the credentials were accepted.

pub async fn check( &self, client: Option<IpAddr>, username: &str, password: &str, ) -> Verdict

Check username and password for a request from client.

A locked-out client gets Verdict::LockedOut without its credentials being looked at. Otherwise a failure is counted against the client, and a success clears its failures.

pub async fn is_locked_out(&self, username: &str) -> bool

Whether username is locked out when connecting from an unknown address.

pub async fn is_locked_out_from( &self, client: Option<IpAddr>, username: &str, ) -> bool

Whether username is locked out when connecting from client.

pub async fn cleanup_expired_attempts(&self)

Drop failure records whose lockout has expired, and expired verifications.

pub fn tracked_clients(&self) -> usize

The number of clients with failure records (for tests and monitoring).

Trait Implementations

impl Clone for AuthState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthState

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

Formats the value using the given formatter.