Struct distant_net::common::authentication::AuthHandlerMap

pub struct AuthHandlerMap { /* private fields */ }

Implementation of AuthHandler that maintains a map of AuthMethodHandler implementations for specific methods, invoking on_challenge, on_verification, on_info, and on_error for a specific handler based on an associated id.

Implementations

impl AuthHandlerMap

pub fn new() -> Self

Creates a new, empty map of auth method handlers.

pub fn active_id(&self) -> &str

Returns the id of the active AuthMethodHandler.

pub fn set_active_id(&mut self, id: impl Into<String>)

Sets the active AuthMethodHandler by its id.

pub fn insert_method_handler<T: AuthMethodHandler + 'static>(
    &mut self,
    id: &'static str,
    handler: T
) -> Option<Box<dyn AuthMethodHandler>>

Inserts the specified handler into the map, associating it with id for determining the method that would trigger this handler.

pub fn remove_method_handler(
    &mut self,
    id: &'static str
) -> Option<Box<dyn AuthMethodHandler>>

Removes a handler with the associated id.

pub fn get_mut_active_method_handler_or_error(
    &mut self
) -> Result<&mut (dyn AuthMethodHandler + 'static)>

Retrieves a mutable reference to the active AuthMethodHandler with the specified id, returning an error if no handler for the active id is found.

pub fn get_mut_active_method_handler(
    &mut self
) -> Option<&mut (dyn AuthMethodHandler + 'static)>

Retrieves a mutable reference to the active AuthMethodHandler with the specified id.

pub fn get_mut_method_handler(
    &mut self,
    id: &str
) -> Option<&mut (dyn AuthMethodHandler + 'static)>

Retrieves a mutable reference to the AuthMethodHandler with the specified id.

impl AuthHandlerMap

pub fn with_static_key(self, key: impl Into<HeapSecretKey>) -> Self

Consumes the map, returning a new map that supports the static_key method.

Trait Implementations

impl AuthHandler for AuthHandlerMap

fn on_initialization<'life0, 'async_trait>(
    &'life0 mut self,
    initialization: Initialization
) -> Pin<Box<dyn Future<Output = Result<InitializationResponse>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Callback when authentication is beginning, providing available authentication methods and returning selected authentication methods to pursue.

fn on_start_method<'life0, 'async_trait>(
    &'life0 mut self,
    start_method: StartMethod
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Callback when authentication starts for a specific method.

fn on_finished<'life0, 'async_trait>(
    &'life0 mut self
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Callback when authentication is finished and no more requests will be received.

impl AuthMethodHandler for AuthHandlerMap

fn on_challenge<'life0, 'async_trait>(
    &'life0 mut self,
    challenge: Challenge
) -> Pin<Box<dyn Future<Output = Result<ChallengeResponse>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Callback when a challenge is received, returning answers to the given questions.

fn on_verification<'life0, 'async_trait>(
    &'life0 mut self,
    verification: Verification
) -> Pin<Box<dyn Future<Output = Result<VerificationResponse>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Callback when a verification request is received, returning true if approvided or false if unapproved.

fn on_info<'life0, 'async_trait>(
    &'life0 mut self,
    info: Info
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Callback when information is received. To fail, return an error from this function.

fn on_error<'life0, 'async_trait>(
    &'life0 mut self,
    error: Error
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Callback when an error is received. Regardless of the result returned, this will terminate the authenticator. In the situation where a custom error would be preferred, have this callback return an error.

impl Default for AuthHandlerMap

fn default() -> Self

Returns the “default value” for a type.