Skip to content

~95% on SimpleQA (e.g. Qwen3.6-27B on a 3090). Supports all local and cloud LLMs (llama.cpp, Ollama, Google, ...). 10+ search engines - arXiv, PubMed, your private documents. Everything Local & Encrypted.

4.2 KB
Raw Blame
"""Security utilities for Local Deep Research."""

from .data_sanitizer import (
    DataSanitizer,
    filter_research_metadata,
    redact_data,
    sanitize_data,
    strip_settings_snapshot,
)
from .egress.audit_hook import (
    active_egress_context,
    clear_active_context,
    get_active_context,
    install_audit_hook,
    is_installed as is_audit_hook_installed,
    set_active_context,
)
from .security_settings import get_security_default

# FileIntegrityManager / FAISSIndexVerifier are re-exported lazily in
# ``__getattr__`` below. Eager imports form a cycle through database.encrypted_db
# when the security package is imported during database bootstrap.
from .notification_validator import (
    NotificationURLValidator,
    NotificationURLValidationError,
)
from .safe_requests import safe_get, safe_post, SafeSession
from .ssrf_validator import (
    assert_base_url_safe,
    get_safe_url,
    is_ip_blocked,
    redact_url_for_log,
    url_authority_without_userinfo,
    validate_url,
)
from .url_validator import URLValidator
from .account_lockout import AccountLockoutManager, get_account_lockout_manager
from .password_validator import PasswordValidator
from .log_sanitizer import (
    failure_reason_for_log,
    redact_secrets,
    sanitize_error_details,
    sanitize_error_for_agent,
    sanitize_error_for_client,
    sanitize_error_message,
    sanitize_for_log,
    scrub_error,
    strip_control_chars,
)
from .filename_sanitizer import sanitize_filename, UnsafeFilenameError
from .client_safe_errors import (
    CLIENT_SAFE_DOWNLOAD_MESSAGES,
    client_safe_download_message,
)
from .module_whitelist import (
    get_safe_module_class,
    ModuleNotAllowedError,
    ALLOWED_MODULES,
)

# PathValidator requires werkzeug (Flask dependency), import conditionally
try:
    from .path_validator import PathValidator

    _has_path_validator = True
except ImportError:
    PathValidator = None  # type: ignore
    _has_path_validator = False

# FileUploadValidator requires pdfplumber, import conditionally
try:
    from .file_upload_validator import FileUploadValidator

    _has_file_upload_validator = True
except ImportError:
    FileUploadValidator = None  # type: ignore
    _has_file_upload_validator = False

__all__ = [
    "PathValidator",
    "DataSanitizer",
    "active_egress_context",
    "clear_active_context",
    "get_active_context",
    "install_audit_hook",
    "is_audit_hook_installed",
    "set_active_context",
    "sanitize_data",
    "redact_data",
    "filter_research_metadata",
    "strip_settings_snapshot",
    "get_security_default",
    "FileIntegrityManager",
    "FAISSIndexVerifier",
    "FileUploadValidator",
    "NotificationURLValidator",
    "NotificationURLValidationError",
    "URLValidator",
    "safe_get",
    "safe_post",
    "SafeSession",
    "validate_url",
    "get_safe_url",
    "is_ip_blocked",
    "assert_base_url_safe",
    "redact_url_for_log",
    "url_authority_without_userinfo",
    "get_safe_module_class",
    "ModuleNotAllowedError",
    "ALLOWED_MODULES",
    "AccountLockoutManager",
    "get_account_lockout_manager",
    "PasswordValidator",
    "failure_reason_for_log",
    "redact_secrets",
    "sanitize_error_details",
    "sanitize_error_for_agent",
    "sanitize_error_for_client",
    "sanitize_error_message",
    "sanitize_for_log",
    "scrub_error",
    "strip_control_chars",
    "CLIENT_SAFE_DOWNLOAD_MESSAGES",
    "client_safe_download_message",
    "sanitize_filename",
    "UnsafeFilenameError",
]


def __getattr__(name: str):
    """Lazily provide file-integrity exports without a package import cycle."""
    if name == "FileIntegrityManager":
        from .file_integrity.integrity_manager import FileIntegrityManager

        return FileIntegrityManager
    if name == "FAISSIndexVerifier":
        from .file_integrity.verifiers.faiss_verifier import FAISSIndexVerifier

        return FAISSIndexVerifier
    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")


# Install the process-wide socket.connect audit hook after all imports
# resolve. The hook is a no-op until a worker thread calls
# ``set_active_context(ctx)`` — importing this module has zero
# behavioral effect on code that does not opt in. Idempotent: subsequent
# imports do not re-install.
install_audit_hook()