Struct AuthFramework 

pub struct AuthFramework { /* private fields */ }

Main authentication framework - now focused and modular

Implementations

impl AuthFramework

pub fn new(config: AuthConfig) -> Result<Self>

Create a new authentication framework.

Returns a descriptive error if the configuration is invalid rather than panicking, so callers can decide how to handle startup failures.

Equivalent to AuthFramework::try_new.

Example

use auth_framework::{AuthFramework, config::AuthConfig};

let fw = AuthFramework::new(AuthConfig::default())?;

pub fn try_new(config: AuthConfig) -> Result<Self>

Create a new authentication framework, returning an error instead of panicking.

This is the preferred constructor for library callers and server startup code where configuration errors should be handled gracefully rather than aborting the process.

Example

let fw = AuthFramework::try_new(AuthConfig::default())?;

pub fn replace_storage(&mut self, storage: Arc<dyn AuthStorage>)

Replace the storage backend with a custom implementation.

This will swap the internal storage Arc and recreate dependent managers so they use the provided storage instance.

pub fn new_with_storage( config: AuthConfig, storage: Arc<dyn AuthStorage>, ) -> Result<Self>

Convenience constructor that creates a framework with a custom storage instance.

Example

let fw = AuthFramework::new_with_storage(config, Arc::new(MyStorage::new()))?;

pub fn register_method( &mut self, name: impl Into<String>, method: AuthMethodEnum, )

Register an authentication method.

Example

fw.register_method("password", AuthMethodEnum::Password(PasswordAuth::default()));

pub async fn initialize(&mut self) -> Result<()>

Initialize the authentication framework.

Sets up default roles and marks the framework as ready. Must be called before authenticate or validate_token.

Example

fw.initialize().await?;

pub async fn authenticate( &self, method_name: &str, credential: Credential, ) -> Result<AuthResult>

Authenticate a user with the specified method.

Delegates to authenticate_with_metadata with empty metadata.

Example

let result = fw.authenticate("jwt", Credential::jwt(token)).await?;
match result {
    AuthResult::Success(token) => println!("authenticated"),
    AuthResult::MfaRequired(challenge) => println!("MFA needed"),
    AuthResult::Failure(msg) => eprintln!("failed: {msg}"),
}

pub async fn authenticate_with_metadata( &self, method_name: &str, credential: Credential, metadata: CredentialMetadata, ) -> Result<AuthResult>

Authenticate a user with the specified method and additional metadata.

Metadata can carry client IP, user-agent, and other contextual information for adaptive risk scoring and audit logging.

Example

let mut meta = CredentialMetadata::new();
meta.client_ip = Some("203.0.113.1".to_string());
let result = fw.authenticate_with_metadata("jwt", credential, meta).await?;

pub async fn complete_mfa( &self, challenge: MfaChallenge, mfa_code: &str, ) -> Result<AuthToken>

Complete multi-factor authentication.

Example

let token = fw.complete_mfa(challenge, "123456").await?;

pub async fn validate_token(&self, token: &AuthToken) -> Result<bool>

Validate a token.

Example

let valid = fw.validate_token(&token).await?;

pub async fn get_user_info(&self, token: &AuthToken) -> Result<UserInfo>

Get user information from a token.

Example

let info = fw.get_user_info(&token).await?;
println!("username: {}", info.username);

pub async fn check_permission( &self, token: &AuthToken, action: &str, resource: &str, ) -> Result<bool>

Check if a token has a specific permission.

Example

let allowed = fw.check_permission(&token, "read", "users").await?;

pub fn token_manager(&self) -> &TokenManager

Get the token manager.

Example

let tm = fw.token_manager();

pub fn mfa_manager(&self) -> &MfaManager

Get the MFA manager.

Example

let mfa = fw.mfa_manager();

pub fn session_manager(&self) -> &SessionManager

Get the session manager.

Example

let sm = fw.session_manager();

pub fn user_manager(&self) -> &UserManager

Get the user manager.

Example

let um = fw.user_manager();

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

Initiate SMS challenge (uses SMSKit).

Example

let challenge_id = fw.initiate_sms_challenge("user-1").await?;

pub async fn send_sms_code( &self, challenge_id: &str, phone_number: &str, ) -> Result<()>

Send SMS code (uses SMSKit).

Example

fw.send_sms_code(&challenge_id, "+1234567890").await?;

pub async fn generate_sms_code(&self, challenge_id: &str) -> Result<String>

Generate SMS code (uses SMSKit).

Example

let code = fw.generate_sms_code(&challenge_id).await?;

pub async fn verify_sms_code( &self, challenge_id: &str, code: &str, ) -> Result<bool>

Verify SMS code (uses SMSKit).

Example

let ok = fw.verify_sms_code(&challenge_id, "123456").await?;

pub async fn cleanup_expired_data(&self) -> Result<()>

Clean up expired data (sessions, MFA challenges, rate limiter entries).

Example

fw.cleanup_expired_data().await?;

pub async fn get_stats(&self) -> Result<AuthStats>

Get authentication framework statistics.

Example

let stats = fw.get_stats().await?;
println!("methods: {:?}", stats.registered_methods);