Struct humphrey_auth::AuthProvider

pub struct AuthProvider<T>
where
    T: AuthDatabase,
{ /* private fields */ }

Represents an authentication provider. Contains a database of users and provides methods for managing authentication.

If the database needs to be used from elsewhere in the program, it is advisable to put the database behind an Arc and Mutex/RwLock and store a cloned reference to the database in the users field of this struct.

Implementations

impl<T> AuthProvider<T>

where T: AuthDatabase,

pub fn new(users: T) -> Self

Create a new authentication provider with the given database.

pub fn with_config(self, config: AuthConfig) -> Self

Use the given configuration for this authentication provider.

pub fn create_user( &mut self, password: impl AsRef<str> ) -> Result<String, AuthError>

Create a user with the given password. Returns the UID of the new user.

pub fn exists(&mut self, uid: impl AsRef<str>) -> bool

Returns true if the user with the given UID exists.

pub fn verify(&self, uid: impl AsRef<str>, password: impl AsRef<str>) -> bool

Verifies that the given password matches the password of the user with the given UID.

pub fn remove_user(&mut self, uid: impl AsRef<str>) -> Result<(), AuthError>

Removes the user with the given UID.

pub fn create_session( &mut self, uid: impl AsRef<str> ) -> Result<String, AuthError>

Creates a new session for the user with the given UID, returning the token.

The session will expire after the configured duration.

pub fn create_session_with_lifetime( &mut self, uid: impl AsRef<str>, lifetime: u64 ) -> Result<String, AuthError>

Creates a new session for the user with the given UID, returning the token.

The session will expire after the given lifetime (in seconds).

pub fn refresh_session( &mut self, token: impl AsRef<str> ) -> Result<(), AuthError>

Refreshes the session with the given token. If successful, the token will be set to expire after the configured duration.

pub fn invalidate_session(&mut self, token: impl AsRef<str>)

Invalidates the given token, if it exists.

pub fn invalidate_user_session(&mut self, uid: impl AsRef<str>)

Invalidates the session of the user with the given UID, if they have one.

pub fn get_uid_by_token( &self, token: impl AsRef<str> ) -> Result<String, AuthError>

Gets the UID of the user with the given token.

Trait Implementations

impl<T> Default for AuthProvider<T>

where T: AuthDatabase + Default,

fn default() -> AuthProvider<T>

Returns the “default value” for a type.