Struct AuthFramework

pub struct AuthFramework { /* private fields */ }

Main authentication framework.

Implementations

impl AuthFramework

pub fn new(config: AuthConfig) -> Self

Create a new authentication framework.

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

Register an authentication method.

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

Initialize the authentication framework.

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

Authenticate a user with the specified method.

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

Authenticate a user with the specified method and metadata.

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

Complete multi-factor authentication.

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

Validate a token.

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

Get user information from a token.

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

Check if a token has a specific permission.

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

Refresh a token.

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

Revoke a token.

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

Create a new API key for a user.

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

Validate an API key and return user information.

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

Revoke an API key.

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

Create a new session.

pub async fn get_session(&self, session_id: &str) -> Result<Option<SessionData>>

Get session information.

pub async fn delete_session(&self, session_id: &str) -> Result<()>

Delete a session.

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

Get all tokens for a user.

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

Clean up expired data.

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

Get authentication framework statistics.

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

Validate username format.

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

Validate display name format.

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

Validate user input.

pub async fn check_ip_rate_limit(&self, ip: &str) -> Result<bool>

Check IP rate limit.

pub async fn get_security_metrics(&self) -> Result<HashMap<String, u64>>

Get security metrics.

pub async fn create_auth_token( &self, user_id: impl Into<String>, scopes: Vec<String>, method_name: impl Into<String>, lifetime: Option<Duration>, ) -> Result<AuthToken>

Create an authentication token directly (useful for testing and demos).

Note: In production, tokens should be created through the authenticate method.

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

Generate TOTP secret for a user.

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

Generate TOTP QR code URL.

pub async fn generate_totp_code(&self, _secret: &str) -> Result<String>

Generate current TOTP code.

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

Verify TOTP code.

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

Register phone number for SMS MFA.

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

Initiate SMS challenge.

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

Generate SMS code.

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

Verify SMS code.

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

Register email for email MFA.

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

Initiate email challenge.

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

Generate email code.

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

Verify email code.

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

Generate backup codes.

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

Verify backup code.

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

Get remaining backup codes count.

pub async fn create_role(&self, role: Role) -> Result<()>

Create a new role.

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

Assign a role to a user.

pub async fn set_role_inheritance( &self, child_role: &str, parent_role: &str, ) -> Result<()>

Set role inheritance.

pub async fn grant_permission( &self, user_id: &str, action: &str, resource: &str, ) -> Result<()>

Grant permission to a user.

pub async fn revoke_permission( &self, user_id: &str, action: &str, resource: &str, ) -> Result<()>

Revoke permission from a user.

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

Check if user has a role.

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

Get effective permissions for a user.

pub async fn create_abac_policy( &self, name: &str, _description: &str, ) -> Result<()>

Create ABAC policy.

pub async fn map_user_attribute( &self, user_id: &str, attribute: &str, value: &str, ) -> Result<()>

Map user attribute.

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

Get user attribute.

pub async fn check_dynamic_permission( &self, user_id: &str, action: &str, resource: &str, _context: HashMap<String, String>, ) -> Result<bool>

Check dynamic permission.

pub async fn create_resource(&self, resource: &str) -> Result<()>

Create resource.

pub async fn delegate_permission( &self, delegator: &str, delegate: &str, permission: &str, resource: &str, duration: Duration, ) -> Result<()>

Delegate permission.

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

Get active delegations.

pub async fn get_permission_audit_logs( &self, _user_id: Option<&str>, _permission: Option<&str>, _limit: Option<usize>, ) -> Result<Vec<String>>

Get permission audit logs.

pub async fn get_permission_metrics(&self) -> Result<HashMap<String, u64>>

Get permission metrics.