Struct oxide_auth::primitives::registrar::RegisteredClient

pub struct RegisteredClient<'a> { /* fields omitted */ }

Recombines an EncodedClient and a PasswordPolicy to check authentication.

Methods

impl<'a> RegisteredClient<'a>

pub fn new(client: &'a EncodedClient, policy: &'a dyn PasswordPolicy) -> Self

Binds a client and a policy reference together.

The policy should be the same or equivalent to the policy used to create the encoded client data, as otherwise authentication will obviously not work.

pub fn check_authentication(
    &self,
    passphrase: Option<&[u8]>
) -> Result<(), Unspecified>

Try to authenticate with the client and passphrase. This check will success if either the client is public and no passphrase was provided or if the client is confidential and the passphrase matches.