shadowcat 2.0.0__py3-none-any.whl

agent/core/config.py

@@ -0,0 +1,106 @@
+"""Configuration management for ShadowCat using Pydantic."""
+
+from pathlib import Path
+from typing import Any, Literal
+
+from pydantic import AliasChoices, Field
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+# User-global config written by ``shadowcat config``. Used as the lowest-priority
+# fallback so a pip-installed CLI works from any directory without a local .env.
+_USER_ENV = str(Path.home() / ".shadowcat" / ".env")
+
+
+class ShadowCatConfig(BaseSettings):
+    """Main configuration for ShadowCat."""
+
+    model_config = SettingsConfigDict(
+        # Read several files; later entries override earlier ones. So precedence
+        # (highest first) is: real env vars > project `.env.auth` > project `.env`
+        # > user-global `~/.shadowcat/.env`. The global file is the fallback for
+        # the pip-installed CLI; project files override it for local dev.
+        env_file=(_USER_ENV, ".env", ".env.auth"),
+        env_file_encoding="utf-8",
+        case_sensitive=False,
+        extra="ignore",
+        populate_by_name=True,
+    )
+
+    # LLM Configuration
+    llm_model: str = Field(
+        default="",
+        validation_alias=AliasChoices("MODEL", "LLM_MODEL"),
+        description="Model identifier for OpenRouter (e.g. anthropic/claude-3-5-sonnet)",
+    )
+
+    openrouter_api_key: str | None = Field(
+        default=None,
+        validation_alias=AliasChoices("OPENROUTER_API_KEY"),
+        description="OpenRouter API key (https://openrouter.ai/keys)",
+    )
+
+    # Agent Configuration
+    max_iterations: int = Field(default=300, description="Maximum iterations for the agent")
+
+    working_directory: Path = Field(
+        default_factory=lambda: Path.cwd() / "workspace",
+        description="Working directory for agent operations",
+    )
+
+    # Target Configuration
+    target: str = Field(
+        ...,  # Required
+        description="Target for penetration testing (URL, IP, domain, or path)",
+    )
+
+    custom_instruction: str | None = Field(
+        default=None, description="Optional custom instructions for the agent"
+    )
+
+    # Interface Configuration
+    interface_mode: Literal["tui", "cli"] = Field(
+        default="tui", description="Interface mode: TUI (interactive) or CLI (headless)"
+    )
+
+    verbose: bool = Field(default=True, description="Enable verbose output")
+
+    def __init__(self, **data: Any) -> None:
+        """Initialize configuration."""
+        super().__init__(**data)
+
+        # Create working directory if it doesn't exist
+        # Ignore permission errors if directory already exists
+        try:
+            self.working_directory.mkdir(parents=True, exist_ok=True)
+        except (PermissionError, OSError):
+            # Directory already exists or we don't have permission to create it
+            # This is fine if the directory is already available
+            if not self.working_directory.exists():
+                raise
+
+    @property
+    def system_prompt_path(self) -> Path:
+        """Get path to system prompt file."""
+        return Path(__file__).parent.parent / "prompts" / "pentesting.py"
+
+    @classmethod
+    def from_env(cls, **overrides: object) -> "ShadowCatConfig":
+        """Create config from environment variables with optional overrides."""
+        return cls(**overrides)
+
+
+def load_config(**overrides: object) -> ShadowCatConfig:
+    """
+    Load configuration from environment with optional overrides.
+
+    Args:
+        **overrides: Keyword arguments to override config values
+
+    Returns:
+        ShadowCatConfig instance
+
+    Example:
+        >>> config = load_config(target="example.com", verbose=True)
+    """
+    # Create config with overrides
+    return ShadowCatConfig.from_env(**overrides)