Struct UserManager 

pub struct UserManager { /* private fields */ }

User manager for handling user operations.

Example

use auth_framework::auth_modular::UserManager;
let um = UserManager::new(storage.clone());
let uid = um.register_user("alice", "alice@example.com", "Str0ng!Pass").await?;

Implementations

impl UserManager

pub fn new(storage: Arc<dyn AuthStorage>) -> Self

Create a new user manager.

Example

let um = UserManager::new(storage.clone());

pub async fn create_api_key( &self, user_id: &str, expires_in: Option<Duration>, ) -> Result<String>

Create API key for a user.

Example

let key = um.create_api_key("user-1", Some(Duration::from_secs(86400))).await?;

pub async fn validate_api_key(&self, api_key: &str) -> Result<UserInfo>

Validate API key and return user information.

Example

let info = um.validate_api_key("ak_abc123").await?;
println!("user: {}", info.username);

pub async fn revoke_api_key(&self, api_key: &str) -> Result<()>

Revoke API key.

Example

um.revoke_api_key("ak_abc123").await?;

pub async fn validate_username(&self, username: &str) -> Result<bool>

Validate username format.

Example

assert!(um.validate_username("alice").await?);
assert!(!um.validate_username("").await?);

pub async fn validate_display_name(&self, display_name: &str) -> Result<bool>

Validate display name format.

Example

assert!(um.validate_display_name("Alice B.").await?);

pub async fn validate_password_strength(&self, password: &str) -> Result<bool>

Validate password strength using security policy.

Requires Strong or VeryStrong to protect production deployments.

Example

assert!(um.validate_password_strength("C0mpl3x!Pa$$word").await?);
assert!(!um.validate_password_strength("weak").await?);

pub async fn validate_user_input(&self, input: &str) -> Result<bool>

Validate user input for security.

Combines a character whitelist with pattern checks for common injection vectors. Rejects HTML tags, null bytes, path traversal sequences, template injection markers, and dangerous URI schemes.

Example

assert!(um.validate_user_input("hello world").await?);
assert!(!um.validate_user_input("<script>alert(1)</script>").await?);

pub async fn get_user_info(&self, user_id: &str) -> Result<UserInfo>

Get user information by ID.

Example

let info = um.get_user_info("user-1").await?;
println!("username: {}", info.username);

pub async fn list_users( &self, limit: Option<usize>, offset: Option<usize>, active_only: bool, ) -> Result<Vec<UserInfo>>

List users from the canonical user index.

Example

let users = um.list_users(Some(10), Some(0), true).await?;
for u in &users { println!("{}", u.username); }

pub async fn user_exists(&self, user_id: &str) -> Result<bool>

Check if user exists.

Example

if um.user_exists("user-1").await? {
    println!("user found");
}

pub async fn register_user( &self, username: &str, email: &str, password: &str, ) -> Result<String>

Register a new user, creating all required storage records.

Example

let uid = um.register_user("alice", "alice@example.com", "Str0ng!Pass").await?;
println!("registered user: {}", uid);

pub async fn delete_user(&self, username: &str) -> Result<()>

Delete a user and all associated storage records.

Example

um.delete_user("alice").await?;

pub async fn delete_user_by_id(&self, user_id: &str) -> Result<()>

Delete a user by canonical user ID.

Example

um.delete_user_by_id("user-1").await?;

pub async fn update_user_roles( &self, user_id: &str, roles: &[String], ) -> Result<()>

Update the roles assigned to a user.

Example

um.update_user_roles("user-1", &["admin".into(), "editor".into()]).await?;

pub async fn set_user_active(&self, user_id: &str, active: bool) -> Result<()>

Enable or disable a user account.

Example

um.set_user_active("user-1", false).await?; // disable

pub async fn update_user_email(&self, user_id: &str, email: &str) -> Result<()>

Update the email address stored on a user.

Example

um.update_user_email("user-1", "new@example.com").await?;

pub async fn verify_user_password( &self, user_id: &str, password: &str, ) -> Result<bool>

Verify a user’s password against the stored bcrypt hash.

Example

let ok = um.verify_user_password("user-1", "secret").await?;
assert!(ok);

pub async fn get_username_by_id(&self, user_id: &str) -> Result<String>

Resolve a user_id to its username.

Example

let name = um.get_username_by_id("user-1").await?;

pub async fn username_exists(&self, username: &str) -> Result<bool>

Check whether a username is already taken.

Example

if um.username_exists("alice").await? {
    println!("taken");
}

pub async fn email_exists(&self, email: &str) -> Result<bool>

Check whether an email address is already registered.

Example

if um.email_exists("a@b.com").await? {
    println!("already registered");
}

pub async fn get_user_by_username( &self, username: &str, ) -> Result<HashMap<String, Value>>

Fetch raw user data by username.

Example

let data = um.get_user_by_username("alice").await?;
println!("email: {:?}", data.get("email"));

pub async fn get_user_profile(&self, user_id: &str) -> Result<ProviderProfile>

Get a sanitised user profile (no password hash) for display/API.

Example

let profile = um.get_user_profile("user-1").await?;
println!("email: {:?}", profile.email);

pub async fn get_user_roles(&self, user_id: &str) -> Result<Vec<String>>

Get a user’s roles/scopes from storage, returning ["user"] as fallback.

Example

let roles = um.get_user_roles("user-1").await?;
assert!(roles.contains(&"user".to_string()));

pub async fn verify_login_credentials( &self, username: &str, password: &str, ) -> Result<Option<CredentialCheckResult>>

Verify username/password credentials in a timing-safe manner.

Returns Ok(None) when the credentials are invalid — a dummy Argon2 verification is always executed when the username is not found, so callers cannot distinguish missing users from wrong passwords via timing. Returns Ok(Some(result)) on success.

Example

match um.verify_login_credentials("alice", "password123").await? {
    Some(cred) => println!("user_id={}, mfa={}", cred.user_id, cred.mfa_enabled),
    None => println!("invalid credentials"),
}

pub async fn update_user_password( &self, username: &str, new_password: &str, ) -> Result<()>

Update a user’s password by username.

Example

um.update_user_password("alice", "N3wStr0ng!Pass").await?;

pub async fn update_user_password_by_id( &self, user_id: &str, new_password: &str, ) -> Result<()>

Update a user password by canonical user ID.

Example

um.update_user_password_by_id("user-1", "N3wStr0ng!Pass").await?;