Struct distant_net::common::authentication::StaticKeyAuthMethodHandler

pub struct StaticKeyAuthMethodHandler { /* private fields */ }

Implementation of AuthMethodHandler that answers challenge requests using a static HeapSecretKey. All other portions of method authentication are handled by another AuthMethodHandler.

Implementations

impl StaticKeyAuthMethodHandler

pub fn new<T: AuthMethodHandler + 'static>(
    key: impl Into<HeapSecretKey>,
    handler: T
) -> Self

Creates a new StaticKeyAuthMethodHandler that responds to challenges using a static key. All other requests are passed to the handler.

pub fn simple(key: impl Into<HeapSecretKey>) -> Self

Creates a new StaticKeyAuthMethodHandler that responds to challenges using a static key. All other requests are passed automatically, meaning that verification is always approvide and info/errors are ignored.

Trait Implementations

impl AuthMethodHandler for StaticKeyAuthMethodHandler

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.