Struct AuthConfig 

pub struct AuthConfig {

    pub token_lifetime: Duration,
    pub refresh_token_lifetime: Duration,
    pub enable_multi_factor: bool,
    pub issuer: String,
    pub audience: String,
    pub secret: Option<String>,
    pub storage: StorageConfig,
    pub rate_limiting: RateLimitConfig,
    pub security: SecurityConfig,
    pub cors: CorsConfig,
    pub audit: AuditConfig,
    pub enable_caching: bool,
    pub max_failed_attempts: u32,
    pub enable_rbac: bool,
    pub enable_middleware: bool,
    pub method_configs: HashMap<String, Value>,
    pub force_production_mode: bool,
}

Main configuration for the authentication framework.

Fields

token_lifetime: Duration

Default token lifetime

refresh_token_lifetime: Duration

Refresh token lifetime

enable_multi_factor: bool

Whether multi-factor authentication is enabled

issuer: String

JWT issuer for token validation

audience: String

JWT audience for token validation

secret: Option<String>

JWT secret key (optional - can be set via environment)

storage: StorageConfig

Storage configuration

rate_limiting: RateLimitConfig

Rate limiting configuration

security: SecurityConfig

Security configuration

cors: CorsConfig

CORS configuration used by all web framework integrations.

audit: AuditConfig

Audit logging configuration

enable_caching: bool

Whether framework-level caching helpers are enabled.

max_failed_attempts: u32

Maximum failed authentication attempts before a client should be blocked.

enable_rbac: bool

Whether RBAC helpers are enabled in the configuration model.

enable_middleware: bool

Whether framework middleware helpers are enabled in the configuration model.

method_configs: HashMap<String, Value>

Custom settings for different auth methods

force_production_mode: bool

Force production validation regardless of environment variables. Used in tests that explicitly verify production-mode error handling.

Implementations

impl AuthConfig

pub fn new() -> Self

Create a new configuration with default values.

AuthConfig supports two construction styles:

Fluent setter chain (simple cases)

use auth_framework::config::AuthConfig;
use std::time::Duration;

let config = AuthConfig::new()
    .token_lifetime(Duration::from_secs(3600))
    .secret("my-secret-key-at-least-32-chars-long!!");

Full builder (complex / multi-backend setups)

use auth_framework::prelude::*;

let auth = AuthFramework::builder()
    .with_jwt().secret("...").issuer("myapp").done()
    .with_storage().memory().done()
    .security_preset(SecurityPreset::HighSecurity)
    .build().await?;

See [AuthFramework::builder] and [AuthFramework::quick_start] for the full builder APIs.

pub fn from_env() -> Self

Build a configuration from common environment variables.

Reads the following environment variables (all optional):

Variable	Maps to
JWT_SECRET	secret / security.secret_key
DATABASE_URL	PostgreSQL storage (requires postgres-storage feature)
REDIS_URL	Redis storage (requires redis-storage feature)
AUTH_ISSUER	issuer
AUTH_AUDIENCE	audience

Missing variables are silently ignored and fall back to defaults.

Example

use auth_framework::config::AuthConfig;

// In tests or CI you can set the env vars beforehand:
// std::env::set_var("JWT_SECRET", "my-long-secret-key-for-jwt-signing!!");
let config = AuthConfig::from_env();

pub fn builder() -> AuthBuilder

Start the full AuthBuilder workflow.

This is a convenience alias for [AuthFramework::builder()] — use it when you want to configure storage, security presets, and sub-builders from a single fluent chain.

Example

use auth_framework::prelude::*;

let auth = AuthConfig::builder()
    .with_jwt().secret("...").done()
    .with_storage().memory().done()
    .build().await?;

For more organized configuration, consider AuthConfigBuilder which groups settings by concern (tokens, security, storage, features, etc.).

pub fn token_lifetime(self, lifetime: Duration) -> Self

Set the token lifetime.

Example

use auth_framework::config::AuthConfig;
use std::time::Duration;

let config = AuthConfig::new().token_lifetime(Duration::from_secs(1800));
assert_eq!(config.token_lifetime.as_secs(), 1800);

pub fn refresh_token_lifetime(self, lifetime: Duration) -> Self

Set the refresh token lifetime.

Example

use auth_framework::config::AuthConfig;
use std::time::Duration;

let config = AuthConfig::new().refresh_token_lifetime(Duration::from_secs(86400));
assert_eq!(config.refresh_token_lifetime.as_secs(), 86400);

pub fn enable_multi_factor(self, enabled: bool) -> Self

Enable or disable multi-factor authentication.

Example

use auth_framework::config::AuthConfig;

let config = AuthConfig::new().enable_multi_factor(true);
assert!(config.enable_multi_factor);

pub fn issuer(self, issuer: impl Into<String>) -> Self

Set the JWT issuer.

pub fn audience(self, audience: impl Into<String>) -> Self

Set the JWT audience.

pub fn secret(self, secret: impl Into<String>) -> Self

Set the JWT secret key.

pub fn require_mfa(self, required: bool) -> Self

Require MFA for all users.

Example

use auth_framework::config::AuthConfig;

let config = AuthConfig::new().require_mfa(true);
assert!(config.enable_multi_factor);

pub fn enable_caching(self, enabled: bool) -> Self

Enable caching.

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

Set maximum failed attempts.

Example

use auth_framework::config::AuthConfig;

let config = AuthConfig::new().max_failed_attempts(10);
assert_eq!(config.max_failed_attempts, 10);

pub fn enable_rbac(self, enabled: bool) -> Self

Enable RBAC.

Example

use auth_framework::config::AuthConfig;

let config = AuthConfig::new().enable_rbac(true);
assert!(config.enable_rbac);

pub fn enable_security_audit(self, enabled: bool) -> Self

Enable security audit.

Example

use auth_framework::config::AuthConfig;

let config = AuthConfig::new().enable_security_audit(true);
assert!(config.audit.enabled);

pub fn enable_middleware(self, enabled: bool) -> Self

Enable middleware.

Example

use auth_framework::config::AuthConfig;

let config = AuthConfig::new().enable_middleware(true);
assert!(config.enable_middleware);

pub fn force_production_mode(self) -> Self

Force production-mode validation, bypassing test-environment detection.

Used exclusively in tests that verify production-specific error handling without polluting the process-wide environment with ENVIRONMENT=production.

Example

use auth_framework::config::AuthConfig;

let config = AuthConfig::new().force_production_mode();

pub fn storage(self, storage: StorageConfig) -> Self

Set the storage configuration.

Example

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

let config = AuthConfig::new().storage(StorageConfig::Memory);

pub fn rate_limiting(self, config: RateLimitConfig) -> Self

Set rate limiting configuration.

Example

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

let config = AuthConfig::new().rate_limiting(RateLimitConfig::default());

pub fn security(self, config: SecurityConfig) -> Self

Set security configuration.

Example

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

let config = AuthConfig::new().security(SecurityConfig::secure());

pub fn cors(self, config: CorsConfig) -> Self

Set CORS configuration.

Example

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

let config = AuthConfig::new()
    .cors(CorsConfig::for_origins(["https://app.example.com"]));

pub fn audit(self, config: AuditConfig) -> Self

Set audit configuration.

Example

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

let config = AuthConfig::new().audit(AuditConfig::default());

pub fn method_config( self, method_name: impl Into<String>, config: impl Serialize, ) -> Result<Self>

Add configuration for a specific auth method.

Example

use auth_framework::config::AuthConfig;

let config = AuthConfig::new()
    .method_config("oauth2", serde_json::json!({
        "client_id": "my-client",
        "client_secret": "my-secret"
    }))
    .unwrap();

pub fn get_method_config<T>(&self, method_name: &str) -> Result<Option<T>>

where T: for<'de> Deserialize<'de>,

Get configuration for a specific auth method.

Example

use auth_framework::config::AuthConfig;

let config = AuthConfig::new();
let oauth: Option<serde_json::Value> = config.get_method_config("oauth2").unwrap();
assert!(oauth.is_none()); // no oauth2 config set yet

pub fn validate(&self) -> Result<()>

Validate the configuration.

Example

use auth_framework::config::AuthConfig;

let config = AuthConfig::new();
assert!(config.validate().is_ok());

Trait Implementations

impl Clone for AuthConfig

fn clone(&self) -> AuthConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AuthConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AuthConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AuthConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AuthConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for AuthConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.