0xallam
4e0d0f35d9
Adds the env-var gate that lets users opt into the SDK harness without
disturbing the legacy default. Per PLAYBOOK §7.1, this is the cutover
mechanism: STRIX_USE_SDK_HARNESS=1 routes scans through run_strix_scan
(the Phase 5 entry point); anything else continues to use
StrixAgent.execute_scan.
- strix/interface/sdk_dispatch.py:
- should_use_sdk_harness(): truthy-string parse of the env var.
- _resolve_sandbox_image(): reads strix_image from Config; falls
back to "strix-sandbox:latest" with a warning if unset.
- _resolve_sources_path(): when --local-sources is given, mounts
its parent so the agent walks down to the source tree; otherwise
creates a per-run scratch dir under XDG_CACHE_HOME/strix/sources/.
Phase 6 will replace this with the legacy clone-into-container
flow once we port that.
- run_scan_via_sdk(): the adapter — translates the legacy CLI
(scan_config dict + argparse Namespace + Tracer) into the keyword
arguments run_strix_scan expects. Returns the SDK RunResult; lets
failures bubble up.
- strix/interface/cli.py: adds the dispatch branch inside the existing
Live/status loop. Legacy default unchanged; SDK path is reached only
when STRIX_USE_SDK_HARNESS is truthy. Two pre-existing lazy imports
hoisted to module level (cleanup_runtime + sdk_dispatch helpers) so
ruff is happy.
Pre-existing legacy lint/type issues surfaced when pre-commit checked
the edited cli.py and chased imports — fixed or ignored in passing:
- utils.py:1052 duplicate ``metadata`` annotation removed.
- utils.py:1251 unused ``# type: ignore[import-not-found]`` for yarl.
- main.py:456 ``panel_parts`` inferred type rejected later string
entries — explicit ``list[Text | str]`` annotation.
- utils.py:resolve_diff_scope_context PLR0912 (16 branches) per-file
ignore — branches map 1:1 to scope-mode × target-type combinations.
Tests: 18 new tests in tests/interface/test_sdk_dispatch.py — env
flag parsing parametrized over truthy/falsy variants, image lookup
with config hit + miss-with-warning, sources path resolution for
local_sources / alternative key names / scratch-dir creation, and
the adapter's kwarg handoff verified against a patched
run_strix_scan (run_name from args + run_name from scan_config
fallback + failure propagation).
Refs: PLAYBOOK.md §7.1 (cutover), §7.2 (rollback).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
461 lines
14 KiB
TOML
461 lines
14 KiB
TOML
[project]
|
|
name = "strix-agent"
|
|
version = "0.8.3"
|
|
description = "Open-source AI Hackers for your apps"
|
|
readme = "README.md"
|
|
license = "Apache-2.0"
|
|
requires-python = ">=3.12"
|
|
authors = [
|
|
{ name = "Strix", email = "hi@usestrix.com" },
|
|
]
|
|
keywords = [
|
|
"cybersecurity",
|
|
"security",
|
|
"vulnerability",
|
|
"scanner",
|
|
"pentest",
|
|
"agent",
|
|
"ai",
|
|
"cli",
|
|
]
|
|
classifiers = [
|
|
"Development Status :: 3 - Alpha",
|
|
"Intended Audience :: Information Technology",
|
|
"Intended Audience :: System Administrators",
|
|
"Topic :: Security",
|
|
"License :: OSI Approved :: Apache Software License",
|
|
"Environment :: Console",
|
|
"Programming Language :: Python",
|
|
"Programming Language :: Python :: 3",
|
|
"Programming Language :: Python :: 3 :: Only",
|
|
"Programming Language :: Python :: 3.12",
|
|
"Programming Language :: Python :: 3.13",
|
|
"Programming Language :: Python :: 3.14",
|
|
]
|
|
dependencies = [
|
|
"litellm[proxy]>=1.83.0",
|
|
"openai-agents[litellm]==0.14.6",
|
|
"tenacity>=9.0.0",
|
|
"pydantic[email]>=2.11.3",
|
|
"rich",
|
|
"docker>=7.1.0",
|
|
"textual>=6.0.0",
|
|
"xmltodict>=0.13.0",
|
|
"requests>=2.32.0",
|
|
"cvss>=3.2",
|
|
"traceloop-sdk>=0.53.0",
|
|
"opentelemetry-exporter-otlp-proto-http>=1.40.0",
|
|
"scrubadub>=2.0.1",
|
|
"defusedxml>=0.7.1",
|
|
]
|
|
|
|
[project.scripts]
|
|
strix = "strix.interface.main:main"
|
|
|
|
[project.optional-dependencies]
|
|
vertex = ["google-cloud-aiplatform>=1.38"]
|
|
sandbox = [
|
|
"fastapi",
|
|
"uvicorn",
|
|
"ipython>=9.3.0",
|
|
"openhands-aci>=0.3.0",
|
|
"playwright>=1.48.0",
|
|
"gql[requests]>=3.5.3",
|
|
"pyte>=0.8.1",
|
|
"libtmux>=0.46.2",
|
|
"numpydoc>=1.8.0",
|
|
]
|
|
|
|
[dependency-groups]
|
|
dev = [
|
|
"mypy>=1.16.0",
|
|
"ruff>=0.11.13",
|
|
"pyright>=1.1.401",
|
|
"pylint>=3.3.7",
|
|
"bandit>=1.8.3",
|
|
"pytest>=8.4.0",
|
|
"pytest-asyncio>=1.0.0",
|
|
"pytest-cov>=6.1.1",
|
|
"pytest-mock>=3.14.1",
|
|
"pre-commit>=4.2.0",
|
|
"black>=25.1.0",
|
|
"isort>=6.0.1",
|
|
"pyinstaller>=6.17.0; python_version >= '3.12' and python_version < '3.15'",
|
|
]
|
|
|
|
[build-system]
|
|
requires = ["hatchling"]
|
|
build-backend = "hatchling.build"
|
|
|
|
[tool.hatch.build.targets.wheel]
|
|
packages = ["strix"]
|
|
|
|
# ============================================================================
|
|
# Type Checking Configuration
|
|
# ============================================================================
|
|
|
|
[tool.mypy]
|
|
python_version = "3.12"
|
|
strict = true
|
|
strict_optional = true
|
|
warn_redundant_casts = true
|
|
warn_unused_ignores = true
|
|
warn_return_any = true
|
|
warn_unreachable = true
|
|
disallow_untyped_defs = true
|
|
disallow_any_generics = true
|
|
disallow_subclassing_any = true
|
|
disallow_untyped_calls = true
|
|
disallow_incomplete_defs = true
|
|
check_untyped_defs = true
|
|
disallow_untyped_decorators = true
|
|
no_implicit_optional = true
|
|
warn_unused_configs = true
|
|
show_error_codes = true
|
|
show_column_numbers = true
|
|
pretty = true
|
|
|
|
# Allow some flexibility for third-party libraries
|
|
[[tool.mypy.overrides]]
|
|
module = [
|
|
"litellm.*",
|
|
"tenacity.*",
|
|
"numpydoc.*",
|
|
"rich.*",
|
|
"IPython.*",
|
|
"openhands_aci.*",
|
|
"playwright.*",
|
|
"uvicorn.*",
|
|
"jinja2.*",
|
|
"pydantic_settings.*",
|
|
"jwt.*",
|
|
"httpx.*",
|
|
"gql.*",
|
|
"textual.*",
|
|
"pyte.*",
|
|
"libtmux.*",
|
|
"pytest.*",
|
|
"cvss.*",
|
|
"opentelemetry.*",
|
|
"scrubadub.*",
|
|
"traceloop.*",
|
|
"docker.*",
|
|
]
|
|
ignore_missing_imports = true
|
|
|
|
# Relax strict rules for test files (pytest decorators are not fully typed)
|
|
[[tool.mypy.overrides]]
|
|
module = ["tests.*"]
|
|
disallow_untyped_decorators = false
|
|
disallow_untyped_defs = false
|
|
# Test fixtures often build raw dicts that match SDK TypedDict unions
|
|
# structurally; type:ignore-per-line would be very noisy.
|
|
disable_error_code = [
|
|
"typeddict-item", # TypedDict key access on union variants
|
|
"typeddict-unknown-key",
|
|
"type-arg", # generic params on dict/MagicMock in test helpers
|
|
"no-untyped-call", # SDK has untyped __init__ in some places
|
|
"no-any-return", # test helpers often return Any from typed call_args
|
|
"arg-type", # fakes pass mocks where SDK wants strict types
|
|
"attr-defined", # fake objects monkey-patch attrs
|
|
]
|
|
|
|
# ============================================================================
|
|
# Ruff Configuration (Fast Python Linter & Formatter)
|
|
# ============================================================================
|
|
|
|
[tool.ruff]
|
|
target-version = "py312"
|
|
line-length = 100
|
|
extend-exclude = [
|
|
".git",
|
|
".mypy_cache",
|
|
".pytest_cache",
|
|
".ruff_cache",
|
|
"__pycache__",
|
|
"build",
|
|
"dist",
|
|
"migrations",
|
|
]
|
|
|
|
[tool.ruff.lint]
|
|
# Enable comprehensive rule sets
|
|
select = [
|
|
"E", # pycodestyle errors
|
|
"W", # pycodestyle warnings
|
|
"F", # Pyflakes
|
|
"I", # isort
|
|
"N", # pep8-naming
|
|
"UP", # pyupgrade
|
|
"YTT", # flake8-2020
|
|
"S", # flake8-bandit
|
|
"BLE", # flake8-blind-except
|
|
"FBT", # flake8-boolean-trap
|
|
"B", # flake8-bugbear
|
|
"A", # flake8-builtins
|
|
"COM", # flake8-commas
|
|
"C4", # flake8-comprehensions
|
|
"DTZ", # flake8-datetimez
|
|
"T10", # flake8-debugger
|
|
"EM", # flake8-errmsg
|
|
"FA", # flake8-future-annotations
|
|
"ISC", # flake8-implicit-str-concat
|
|
"ICN", # flake8-import-conventions
|
|
"G", # flake8-logging-format
|
|
"INP", # flake8-no-pep420
|
|
"PIE", # flake8-pie
|
|
"T20", # flake8-print
|
|
"PYI", # flake8-pyi
|
|
"PT", # flake8-pytest-style
|
|
"Q", # flake8-quotes
|
|
"RSE", # flake8-raise
|
|
"RET", # flake8-return
|
|
"SLF", # flake8-self
|
|
"SIM", # flake8-simplify
|
|
"TID", # flake8-tidy-imports
|
|
"TCH", # flake8-type-checking
|
|
"ARG", # flake8-unused-arguments
|
|
"PTH", # flake8-use-pathlib
|
|
"ERA", # eradicate
|
|
"PD", # pandas-vet
|
|
"PGH", # pygrep-hooks
|
|
"PL", # Pylint
|
|
"TRY", # tryceratops
|
|
"FLY", # flynt
|
|
"PERF", # Perflint
|
|
"RUF", # Ruff-specific rules
|
|
]
|
|
|
|
ignore = [
|
|
"S101", # Use of assert
|
|
"S104", # Possible binding to all interfaces
|
|
"S301", # Use of pickle
|
|
"COM812", # Missing trailing comma (handled by formatter)
|
|
"ISC001", # Single line implicit string concatenation (handled by formatter)
|
|
"PLR0913", # Too many arguments to function call
|
|
"TRY003", # Avoid specifying long messages outside the exception class
|
|
"EM101", # Exception must not use a string literal
|
|
"EM102", # Exception must not use an f-string literal
|
|
"FBT001", # Boolean positional arg in function definition
|
|
"FBT002", # Boolean default positional argument in function definition
|
|
"G004", # Logging statement uses f-string
|
|
"PLR2004", # Magic value used in comparison
|
|
"SLF001", # Private member accessed
|
|
]
|
|
|
|
[tool.ruff.lint.per-file-ignores]
|
|
# Pre-existing lazy imports inside functions (avoid circular dependency
|
|
# with strix.telemetry). Keep until the dependency graph is refactored.
|
|
"strix/llm/llm.py" = ["PLC0415"]
|
|
"strix/tools/notes/notes_actions.py" = ["PLC0415"]
|
|
"tests/**/*.py" = [
|
|
"S105", # Possible hardcoded password (string literal)
|
|
"S106", # Possible hardcoded password (function call)
|
|
"S108", # Possible insecure usage of temporary file/directory
|
|
"ARG001", # Unused function argument
|
|
"ARG002", # Unused method argument (test helpers / fakes mirror SDK signatures)
|
|
"PLR2004", # Magic value used in comparison
|
|
"PT018", # Multi-part assertions are a pytest style preference
|
|
"TC002", # Type-only third-party import (tests import for runtime instantiation)
|
|
"TC003", # Type-only stdlib import
|
|
]
|
|
"strix/tools/**/*.py" = [
|
|
"ARG001", # Unused function argument (tools may have unused args for interface consistency)
|
|
]
|
|
# SDK lifecycle hooks have a fixed signature — unused args are part of the contract.
|
|
"strix/orchestration/hooks.py" = [
|
|
"ARG002", # Unused method argument (RunHooks signature is set by SDK)
|
|
"TC002", # ModelResponse, RunContextWrapper, AgentHookContext are annotation-only
|
|
]
|
|
# Anthropic cache wrapper inherits from LitellmModel; signature shadows builtin `input`.
|
|
"strix/llm/anthropic_cache_wrapper.py" = [
|
|
"A002", # Argument shadows builtin (parent signature uses `input`)
|
|
"TC002", # Many SDK types are imports-for-annotations only
|
|
"TC003", # collections.abc.AsyncIterator imported for return type
|
|
]
|
|
# Custom Docker subclass duplicates parent body; some imports are for annotations.
|
|
"strix/runtime/strix_docker_client.py" = [
|
|
"TC002", # Manifest, Container imported for annotations
|
|
"TC003", # uuid imported for annotation
|
|
]
|
|
"strix/llm/multi_provider_setup.py" = [
|
|
"TC002", # Model, ModelProvider imported for annotations
|
|
]
|
|
"strix/tools/_decorator.py" = [
|
|
"TC002", # FunctionTool imported for annotation
|
|
]
|
|
# SDK function-tool wrappers: the SDK calls get_type_hints() at registration
|
|
# time to derive the JSON schema, which evaluates annotations at runtime —
|
|
# so RunContextWrapper must be imported eagerly, not under TYPE_CHECKING.
|
|
"strix/tools/todo/todo_sdk_tools.py" = ["TC002"]
|
|
"strix/tools/notes/notes_sdk_tools.py" = ["TC002"]
|
|
"strix/tools/thinking/thinking_sdk_tools.py" = ["TC002"]
|
|
"strix/tools/web_search/web_search_sdk_tool.py" = ["TC002"]
|
|
"strix/tools/file_edit/file_edit_sdk_tools.py" = ["TC002"]
|
|
"strix/tools/reporting/reporting_sdk_tools.py" = ["TC002"]
|
|
"strix/tools/load_skill/load_skill_sdk_tool.py" = ["TC002"]
|
|
"strix/tools/finish/finish_sdk_tool.py" = ["TC002"]
|
|
"strix/tools/browser/browser_sdk_tool.py" = ["TC002"]
|
|
"strix/tools/terminal/terminal_sdk_tool.py" = ["TC002"]
|
|
"strix/tools/python/python_sdk_tool.py" = ["TC002"]
|
|
"strix/tools/proxy/proxy_sdk_tools.py" = ["TC002"]
|
|
"strix/tools/agents_graph/agents_graph_sdk_tools.py" = ["TC002"]
|
|
# CaidoCapability uses agents.tool.Tool at runtime — pydantic Field
|
|
# annotations and the cached _CAIDO_TOOLS tuple need it eagerly.
|
|
"strix/sandbox/caido_capability.py" = ["TC002"]
|
|
# Agent factory: agents.tool.Tool is used at runtime in the _BASE_TOOLS
|
|
# tuple type, not just for annotations.
|
|
"strix/agents/sdk_factory.py" = ["TC002"]
|
|
# Entry point: ``Path`` is used at runtime by the typing of the
|
|
# session_manager call; importing under TYPE_CHECKING would defer
|
|
# resolution past where mypy needs it. ``_build_root_task`` legitimately
|
|
# walks every supported target type — splitting it into per-type
|
|
# helpers would add indirection without simplifying anything.
|
|
"strix/sdk_entry.py" = ["TC003", "PLR0912"]
|
|
# Legacy interface utility with intentionally many branches per supported
|
|
# scope-mode / target-type combination; refactor would obscure the
|
|
# decision tree without simplifying it.
|
|
"strix/interface/utils.py" = ["PLR0912"]
|
|
# Sandbox dispatch helper has many short-circuit error returns (auth fail,
|
|
# size cap, decode fail, etc). Each is a distinct, documented failure mode
|
|
# the model needs to see verbatim — collapsing them harms readability.
|
|
"strix/tools/_sandbox_dispatch.py" = ["PLR0911"]
|
|
# StrixSession + StrixTracingProcessor catch broad Exception intentionally:
|
|
# the whole point is that compressor / sanitizer / disk failures must not
|
|
# tear down the agent run (C10, C16). Calls already log at exception level.
|
|
"strix/llm/strix_session.py" = ["BLE001"]
|
|
"strix/telemetry/strix_processor.py" = ["BLE001"]
|
|
|
|
[tool.ruff.lint.isort]
|
|
force-single-line = false
|
|
lines-after-imports = 2
|
|
known-first-party = ["strix"]
|
|
known-third-party = ["fastapi", "pydantic"]
|
|
|
|
[tool.ruff.lint.pylint]
|
|
max-args = 8
|
|
|
|
[tool.ruff.format]
|
|
quote-style = "double"
|
|
indent-style = "space"
|
|
skip-magic-trailing-comma = false
|
|
line-ending = "auto"
|
|
|
|
# ============================================================================
|
|
# PyRight Configuration (Alternative type checker)
|
|
# ============================================================================
|
|
|
|
[tool.pyright]
|
|
include = ["strix"]
|
|
exclude = ["**/__pycache__", "build", "dist"]
|
|
pythonVersion = "3.12"
|
|
pythonPlatform = "Linux"
|
|
|
|
typeCheckingMode = "strict"
|
|
reportMissingImports = true
|
|
reportMissingTypeStubs = false
|
|
reportGeneralTypeIssues = true
|
|
reportPropertyTypeMismatch = true
|
|
reportFunctionMemberAccess = true
|
|
reportMissingParameterType = true
|
|
reportMissingTypeArgument = true
|
|
reportIncompatibleMethodOverride = true
|
|
reportIncompatibleVariableOverride = true
|
|
reportInconsistentConstructor = true
|
|
reportOverlappingOverload = true
|
|
reportConstantRedefinition = true
|
|
reportImportCycles = true
|
|
reportUnusedImport = true
|
|
reportUnusedClass = true
|
|
reportUnusedFunction = true
|
|
reportUnusedVariable = true
|
|
reportDuplicateImport = true
|
|
|
|
# ============================================================================
|
|
# Black Configuration (Code Formatter)
|
|
# ============================================================================
|
|
|
|
[tool.black]
|
|
line-length = 100
|
|
target-version = ['py312']
|
|
include = '\\.pyi?$'
|
|
extend-exclude = '''
|
|
/(
|
|
# directories
|
|
\.eggs
|
|
| \.git
|
|
| \.hg
|
|
| \.mypy_cache
|
|
| \.tox
|
|
| \.venv
|
|
| build
|
|
| dist
|
|
)/
|
|
'''
|
|
|
|
# ============================================================================
|
|
# isort Configuration (Import Sorting)
|
|
# ============================================================================
|
|
|
|
[tool.isort]
|
|
profile = "black"
|
|
line_length = 100
|
|
multi_line_output = 3
|
|
include_trailing_comma = true
|
|
force_grid_wrap = 0
|
|
use_parentheses = true
|
|
ensure_newline_before_comments = true
|
|
known_first_party = ["strix"]
|
|
known_third_party = ["fastapi", "pydantic", "litellm", "tenacity"]
|
|
|
|
# ============================================================================
|
|
# Pytest Configuration
|
|
# ============================================================================
|
|
|
|
[tool.pytest.ini_options]
|
|
minversion = "6.0"
|
|
addopts = [
|
|
"--strict-markers",
|
|
"--strict-config",
|
|
"--cov=strix",
|
|
"--cov-report=term-missing",
|
|
"--cov-report=html",
|
|
"--cov-report=xml",
|
|
]
|
|
testpaths = ["tests"]
|
|
python_files = ["test_*.py", "*_test.py"]
|
|
python_functions = ["test_*"]
|
|
python_classes = ["Test*"]
|
|
asyncio_mode = "auto"
|
|
|
|
[tool.coverage.run]
|
|
source = ["strix"]
|
|
omit = [
|
|
"*/tests/*",
|
|
"*/migrations/*",
|
|
"*/__pycache__/*"
|
|
]
|
|
|
|
[tool.coverage.report]
|
|
exclude_lines = [
|
|
"pragma: no cover",
|
|
"def __repr__",
|
|
"if self.debug:",
|
|
"if settings.DEBUG",
|
|
"raise AssertionError",
|
|
"raise NotImplementedError",
|
|
"if 0:",
|
|
"if __name__ == .__main__.:",
|
|
"class .*\\bProtocol\\):",
|
|
"@(abc\\.)?abstractmethod",
|
|
]
|
|
|
|
# ============================================================================
|
|
# Bandit Configuration (Security Linting)
|
|
# ============================================================================
|
|
|
|
[tool.bandit]
|
|
exclude_dirs = ["tests", "docs", "build", "dist"]
|
|
skips = ["B101", "B601", "B404", "B603", "B607"] # Skip assert, shell injection, subprocess import and partial path checks
|
|
severity = "medium"
|