Skip to main content

UserAuthenticator

Struct UserAuthenticator 

Source
pub struct UserAuthenticator { /* private fields */ }
Expand description

User authentication manager.

Implementations§

Source§

impl UserAuthenticator

Source

pub fn new(user_store: Box<dyn UserStore>) -> Self

Create a new user authenticator.

Source

pub fn with_session_expiry(self, expiry: Duration) -> Self

Create authenticator with custom session expiry.

Source

pub fn with_max_failed_attempts(self, max: u32) -> Self

Create authenticator with custom max failed attempts.

Source

pub fn register_user( &self, _username: &str, password: &str, identity: UserIdentity, ) -> Result<String, SecurityError>

Register a new user with Password + TOTP authentication.

Returns the TOTP secret (base32 encoded) for the user to configure their authenticator app. The username parameter is used as the lookup key - it should match identity.username.

Source

pub fn authenticate( &self, username: &str, credential: &Credential, ) -> Result<UserSession, SecurityError>

Authenticate a user and create a session.

Source

pub fn authenticate_password_only( &self, username: &str, password: &str, ) -> Result<UserSession, SecurityError>

Authenticate without TOTP (for testing or initial setup).

WARNING: This should only be used in development/testing or when TOTP is being initially configured.

Source

pub fn validate_session( &self, session_id: &SessionId, ) -> Result<UserIdentity, SecurityError>

Validate a session and return the user identity.

Source

pub fn get_session(&self, session_id: &SessionId) -> Option<UserSession>

Get a session by ID.

Source

pub fn invalidate_session(&self, session_id: &SessionId)

Invalidate (logout) a session.

Source

pub fn invalidate_user_sessions(&self, username: &str)

Invalidate all sessions for a user.

Source

pub fn cleanup_expired_sessions(&self)

Clean up expired sessions.

Source

pub fn active_session_count(&self) -> usize

Get count of active sessions.

Source

pub fn bind_session_to_device( &self, session_id: &SessionId, device_id: DeviceId, ) -> Result<(), SecurityError>

Bind a session to a device.

Source

pub fn unlock_account(&self, username: &str) -> Result<(), SecurityError>

Unlock a locked account (admin operation).

Source

pub fn disable_account(&self, username: &str) -> Result<(), SecurityError>

Disable an account (admin operation).

Source

pub fn change_password( &self, user_name: &str, old_password: &str, new_password: &str, ) -> Result<(), SecurityError>

Change a user’s password.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more