API Reference Overview¶

FastAPI Guard consists of several core components:

Core Components¶

SecurityMiddleware: The main middleware that handles all security features
IPBanManager: Manages IP banning functionality
IPInfoManager: Handles IP geolocation using IPInfo's database
SusPatterns: Manages suspicious patterns for threat detection
CloudManager: Handles cloud provider IP range detection
Utilities: Helper functions for logging and request analysis
RedisManager: Handles Redis connections and atomic operations

Key Classes¶

from guard.middleware import SecurityMiddleware
from guard.models import SecurityConfig
from guard.handlers.cloud_handler import CloudManager
from guard.handlers.ipban_handler import IPBanManager
from guard.handlers.ipinfo_handler import IPInfoManager
from guard.handlers.redis_handler import RedisManager
from guard.sus_patterns import SusPatterns

Configuration Model¶

The SecurityConfig class is the central configuration point:

class SecurityConfig:
    def __init__(
        self,
        ipinfo_token: str,
        whitelist: Optional[List[str]] = None,
        blacklist: List[str] = [],
        blocked_countries: List[str] = [],
        whitelist_countries: List[str] = [],
        blocked_user_agents: List[str] = [],
        auto_ban_threshold: int = 5,
        auto_ban_duration: int = 3600,
        rate_limit: int = 100,
        rate_limit_window: int = 60,
        enable_cors: bool = False,
        # ... other parameters
    ):
        # ... initialization