#[cfg(feature = "credit-metering")]
use crate::credit::CreditConfig;
#[cfg(feature = "rate-limit-redis")]
use crate::strategy::rate_limiter_backend::RateLimitBackend;
#[cfg(feature = "web-cors")]
use crate::web::cors::CorsConfig;
#[cfg(feature = "web-csrf")]
use crate::web::csrf::CsrfConfig;
use confers::types::ConfigValue;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use tokio::sync::watch;
pub mod deprecation;
pub mod impls;
#[cfg(feature = "config-security-rules")]
mod security_rules;
pub const TOKEN_STYLES: &[&str] = &["uuid", "random_64", "simple", "jwt"];
pub const COOKIE_SAME_SITE_VALUES: &[&str] = &["Lax", "Strict", "None"];
pub const DEFAULT_TOKEN_NAME: &str = "garrison_token";
pub const DEFAULT_TIMEOUT: i64 = 2_592_000;
pub const DEFAULT_ACTIVE_TIMEOUT: i64 = -1;
#[cfg(feature = "development")]
pub const DEFAULT_COOKIE_SECURE: bool = false;
#[cfg(not(feature = "development"))]
pub const DEFAULT_COOKIE_SECURE: bool = true;
pub const DEFAULT_COOKIE_SAME_SITE: &str = "Lax";
pub const DEFAULT_JWT_ALGORITHM: &str = "HS256";
pub const JWT_ALGORITHMS: &[&str] = &["HS256", "HS384", "HS512", "RS256", "ES256", "EdDSA"];
pub const ARGON2_MIN_M_COST: u32 = 19_456;
pub const BCRYPT_MIN_COST: u32 = 10;
pub const BCRYPT_MAX_COST: u32 = 15;
pub const DEFAULT_ARGON2_POOL_SIZE: u32 = 1;
pub const ARGON2_POOL_SIZE_MIN: u32 = 1;
pub const ARGON2_POOL_SIZE_MAX: u32 = 256;
pub const PASSWORD_HASH_ALGORITHMS: &[&str] = &["argon2id", "bcrypt"];
pub const DEFAULT_SIGN_WINDOW_SECONDS: i64 = 300;
pub const DEFAULT_SSO_TICKET_TTL_SECONDS: u64 = 60;
pub const DEFAULT_JWKS_RETENTION_SECS: u64 = 7200;
pub const REMEMBER_ME_DEFAULT_TIMEOUT: i64 = 7_776_000;
pub const DEFAULT_SESSION_HOVER_TIMEOUT: i64 = -1;
pub const DEFAULT_FRONTEND_SEPARATION: bool = false;
pub const DEFAULT_IS_READ_BODY: bool = false;
pub const DEFAULT_AUTO_RENEWAL_THRESHOLD: i64 = -1;
pub const DEFAULT_TOKEN_MAP_CLEANUP_INTERVAL: i64 = 300;
pub const DEFAULT_LOGIN_TOKEN_MAP_PERSIST_INTERVAL_SECS: u64 = 0;
pub const DEFAULT_L1_CACHE_TTL_SECS: u64 = 30;
pub const DEFAULT_L2_CACHE_TTL_SECS: u64 = 300;
pub const DEFAULT_L1_CACHE_CAPACITY: u64 = 10_000;
pub const DEFAULT_ANON_SESSION_TIMEOUT_SECS: u64 = 1800;
pub const DEFAULT_IS_CONCURRENT: bool = true;
pub const DEFAULT_IS_SHARE: bool = false;
pub const DEFAULT_MAX_LOGIN_COUNT: u32 = 0;
pub const DEFAULT_LOGIN_ID_MAX_LEN: u32 = 255;
pub const DEFAULT_DEVICE_BINDING_MODE: &str = "disabled";
pub const DEVICE_BINDING_MODES: &[&str] = &["strict", "loose", "disabled"];
pub const DEFAULT_REPLACED_LOGIN_EXIT_MODE: &str = "old_device";
pub const DEFAULT_OVERFLOW_LOGOUT_MODE: &str = "logout";
pub const DEFAULT_RECENT_REUSE_BEHAVIOUR: &str = "theft_detected";
pub const DEFAULT_REFRESH_GRACE_PERIOD_SECS: i64 = 0;
pub const DEFAULT_REFRESH_GRACE_MAX_USES: u32 = 1;
pub const DEFAULT_ANOMALOUS_ANALYZER_INTERVAL_SECS: u64 = 3600;
pub const DEFAULT_ANOMALOUS_BURST_THRESHOLD: u32 = 5;
pub const ENV_PREFIX: &str = "GARRISON_";
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ReplacedLoginExitMode {
#[default]
OldDevice,
NewDevice,
}
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum OverflowLogoutMode {
#[default]
Logout,
Kickout,
Replaced,
}
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum SessionHijackMode {
#[default]
AlertOnly,
Kickout,
}
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum RecentReuseBehaviour {
#[default]
TheftDetected,
Unauthorised,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum TenantResolverKind {
Header,
Subdomain,
Claim,
}
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum AuditMaskMode {
Full,
#[default]
Partial,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(default)]
pub struct TenantIsolationConfig {
pub enabled: bool,
pub resolver: TenantResolverKind,
}
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(default)]
pub struct MfaConfig {
pub global_chain: Vec<String>,
pub per_client_chains: HashMap<String, Vec<String>>,
pub recovery_misuse_tolerance: u32,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(default)]
pub struct PasswordHasherConfig {
pub algorithm: String,
pub argon2_m_cost: u32,
pub argon2_t_cost: u32,
pub argon2_p_cost: u32,
pub bcrypt_cost: u32,
pub argon2_pool_size: u32,
pub allow_weak_argon2_params: bool,
}
#[cfg(feature = "protocol-zeroize")]
pub type JwtSecret = zeroize::Zeroizing<String>;
#[cfg(not(feature = "protocol-zeroize"))]
pub type JwtSecret = String;
#[derive(Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct GarrisonConfig {
pub token_name: String,
pub timeout: i64,
pub active_timeout: i64,
pub is_read_cookie: bool,
pub is_read_header: bool,
pub is_read_body: bool,
pub is_write_header: bool,
pub is_write_cookie: bool,
pub token_style: String,
pub throw_on_not_login: bool,
pub cookie_secure: bool,
pub cookie_same_site: String,
pub jwt_algorithm: String,
pub jwt_secret: JwtSecret,
pub jwt_rsa_private_key_pem: Option<String>,
pub jwt_ec_private_key_pem: Option<String>,
pub jwt_ed_private_key_pem: Option<String>,
pub sign_window_seconds: i64,
pub sso_ticket_ttl_seconds: u64,
pub jwks_retention_secs: u64,
pub remember_me_enabled: bool,
pub remember_me_timeout: i64,
pub seed_primary_amr: bool,
pub login_id_max_len: u32,
pub session_hover_timeout: i64,
pub frontend_separation: bool,
pub auto_renewal_threshold: i64,
pub token_map_cleanup_interval_secs: i64,
#[cfg(feature = "three-tier-cache")]
pub l1_cache_ttl_secs: u64,
#[cfg(feature = "three-tier-cache")]
pub l2_cache_ttl_secs: u64,
#[cfg(feature = "three-tier-cache")]
pub l1_cache_capacity: u64,
#[cfg(feature = "session-extra")]
pub login_token_map_persist_interval_secs: u64,
#[cfg(feature = "session-extra")]
pub anon_session_timeout: u64,
pub is_concurrent: bool,
pub is_share: bool,
pub max_login_count: u32,
pub device_binding_mode: String,
pub replaced_login_exit_mode: ReplacedLoginExitMode,
pub overflow_logout_mode: OverflowLogoutMode,
#[cfg(feature = "session-hijack-detection")]
pub session_hijack_mode: SessionHijackMode,
pub enable_jwt_revocation: bool,
pub recent_reuse_behaviour: RecentReuseBehaviour,
pub refresh_grace_period_secs: i64,
pub refresh_grace_max_uses: u32,
pub allow_stateless_jwt_no_revocation: bool,
pub require_tenant_bound_jwt: bool,
pub require_session_tenant_binding: bool,
pub audit_mask_mode: AuditMaskMode,
pub tenant_isolation: TenantIsolationConfig,
pub password_hasher: PasswordHasherConfig,
pub mfa: MfaConfig,
#[cfg(feature = "web-cors")]
pub cors_config: CorsConfig,
#[cfg(feature = "web-csrf")]
pub csrf_config: CsrfConfig,
#[cfg(feature = "rate-limit-redis")]
pub rate_limit_backend: RateLimitBackend,
#[cfg(feature = "firewall-waf")]
pub waf_enabled_hooks: Vec<String>,
#[cfg(feature = "firewall-waf")]
pub waf_white_paths: Vec<String>,
#[cfg(feature = "firewall-waf")]
pub waf_black_paths: Vec<String>,
#[cfg(feature = "firewall-waf")]
pub waf_allowed_hosts: Vec<String>,
#[cfg(feature = "firewall-waf")]
pub waf_allowed_methods: Vec<String>,
#[cfg(feature = "firewall-waf")]
pub waf_banned_headers: Vec<String>,
#[cfg(feature = "firewall-waf")]
pub waf_banned_params: Vec<String>,
#[cfg(feature = "sms-rate-limit")]
pub sms_hourly_limit: u32,
#[cfg(feature = "sms-rate-limit")]
pub sms_daily_limit: u32,
#[cfg(feature = "sms-rate-limit")]
pub sms_verify_max_attempts: u32,
#[cfg(feature = "sms-rate-limit")]
pub sms_unverified_threshold: u32,
#[cfg(feature = "email-verification")]
pub email_hourly_limit: u32,
#[cfg(feature = "email-verification")]
pub email_daily_limit: u32,
#[cfg(feature = "email-verification")]
pub email_verify_max_attempts: u32,
#[cfg(feature = "email-verification")]
pub email_unverified_threshold: u32,
#[cfg(feature = "email-verification")]
pub email_code_ttl: u64,
#[cfg(feature = "anomalous-detector-dual")]
pub anomalous_analyzer_interval_secs: u64,
#[cfg(feature = "anomalous-detector-dual")]
pub anomalous_analyzer_burst_threshold: u32,
#[cfg(feature = "credit-metering")]
pub credit: Option<CreditConfig>,
#[serde(skip)]
watcher: Option<watch::Sender<GarrisonConfig>>,
}
mod helpers;
pub(crate) use helpers::default_jwt_secret;
#[cfg(test)]
mod tests;