mirror of
https://github.com/usestrix/strix.git
synced 2026-08-25 04:12:37 +02:00
feat: place caller-provided files into the sandbox workspace (extra_files, --workspace-file) (#1085)
* add extra-files plumbing so orchestrators can drop single files into the sandbox workspace * reject extra-file paths that collide with a local source tree * add --workspace-file so CLI users can place files in the sandbox workspace * reject repeated and control-character workspace paths * revalidate persisted workspace files when resuming a run * drop the workspace-file size limit
This commit is contained in:
@@ -8,10 +8,11 @@ import sys
|
||||
from pathlib import Path
|
||||
from typing import TYPE_CHECKING, Any
|
||||
|
||||
from agents.sandbox.entries import BaseEntry, LocalDir
|
||||
from agents.sandbox.entries import BaseEntry, File, LocalDir
|
||||
from agents.sandbox.manifest import Environment, Manifest
|
||||
|
||||
from strix.config import load_settings
|
||||
from strix.core.paths import run_dir_for, runtime_state_dir
|
||||
from strix.runtime.backends import backend_supports_bind_mounts, get_backend
|
||||
from strix.runtime.caido_bootstrap import bootstrap_caido
|
||||
|
||||
@@ -73,6 +74,145 @@ def build_manifest_entries(local_sources: list[dict[str, Any]]) -> dict[str | Pa
|
||||
return entries
|
||||
|
||||
|
||||
def _extra_file_rel_path(workspace_path: str) -> str | None:
|
||||
"""Validate an extra-file target path and return it relative to /workspace.
|
||||
|
||||
Only absolute paths under the workspace root are accepted; anything else
|
||||
(including ``..`` traversal segments) is rejected so callers cannot place
|
||||
orchestrator-provided content outside the sandbox workspace.
|
||||
"""
|
||||
prefix = f"{_WORKSPACE_ROOT}/"
|
||||
if not workspace_path.startswith(prefix):
|
||||
return None
|
||||
rel = workspace_path[len(prefix) :].strip("/")
|
||||
if not rel or any(part in ("", ".", "..") for part in rel.split("/")):
|
||||
return None
|
||||
# Control characters would let a path break out of the single line it is
|
||||
# rendered on in the agent task, so the path is rejected rather than escaped.
|
||||
if any(ord(char) < 0x20 or ord(char) == 0x7F for char in rel):
|
||||
return None
|
||||
return rel
|
||||
|
||||
|
||||
def _source_root_rels(local_sources: list[dict[str, Any]] | None) -> list[str]:
|
||||
"""Workspace-relative roots the local sources occupy (e.g. ``["repo"]``)."""
|
||||
if not local_sources:
|
||||
return []
|
||||
return [
|
||||
str(src.get("workspace_subdir") or "").strip("/")
|
||||
for src in local_sources
|
||||
if src.get("workspace_subdir") and src.get("source_path")
|
||||
]
|
||||
|
||||
|
||||
def _collides_with_source_root(rel: str, source_roots: list[str]) -> bool:
|
||||
"""True when an extra-file path would land on or inside a source tree.
|
||||
|
||||
An exact match would replace the whole source tree with one file (a
|
||||
manifest ``entries`` key collision); a path nested under a source root
|
||||
would race the source upload; a path that is an ancestor of a source root
|
||||
would shadow the directory the source materializes into.
|
||||
"""
|
||||
for root in source_roots:
|
||||
if not root:
|
||||
continue
|
||||
if rel == root or rel.startswith(f"{root}/") or root.startswith(f"{rel}/"):
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
def _extra_file_content(extra_file: dict[str, Any]) -> bytes | None:
|
||||
content = extra_file.get("content")
|
||||
if isinstance(content, bytes | bytearray):
|
||||
return bytes(content)
|
||||
if isinstance(content, str):
|
||||
return content.encode("utf-8")
|
||||
return None
|
||||
|
||||
|
||||
def build_extra_file_entries(
|
||||
extra_files: list[dict[str, Any]],
|
||||
local_sources: list[dict[str, Any]] | None = None,
|
||||
) -> dict[str | Path, BaseEntry]:
|
||||
"""Map extra files to in-memory ``File`` manifest entries.
|
||||
|
||||
Each item is ``{"workspace_path": "/workspace/<rel>", "content": bytes|str}``;
|
||||
manifest backends materialize the entry at the requested path alongside the
|
||||
``LocalDir`` source uploads. Invalid items — including paths that collide
|
||||
with a ``local_sources`` tree or with an earlier extra file, which would
|
||||
otherwise replace its manifest entry — are skipped with a warning.
|
||||
"""
|
||||
source_roots = _source_root_rels(local_sources)
|
||||
placed: list[str] = []
|
||||
entries: dict[str | Path, BaseEntry] = {}
|
||||
for extra_file in extra_files:
|
||||
rel = _extra_file_rel_path(str(extra_file.get("workspace_path") or ""))
|
||||
content = _extra_file_content(extra_file)
|
||||
if rel is None or content is None:
|
||||
logger.warning(
|
||||
"Skipping invalid extra file entry (workspace_path=%r)",
|
||||
extra_file.get("workspace_path"),
|
||||
)
|
||||
continue
|
||||
if _collides_with_source_root(rel, source_roots + placed):
|
||||
logger.warning(
|
||||
"Skipping extra file colliding with a local source tree or an "
|
||||
"earlier extra file (workspace_path=%r)",
|
||||
extra_file.get("workspace_path"),
|
||||
)
|
||||
continue
|
||||
placed.append(rel)
|
||||
entries[rel] = File(content=content)
|
||||
return entries
|
||||
|
||||
|
||||
def build_extra_file_bind_mounts(
|
||||
extra_files: list[dict[str, Any]],
|
||||
staging_dir: Path,
|
||||
local_sources: list[dict[str, Any]] | None = None,
|
||||
) -> list[dict[str, Any]]:
|
||||
"""Stage extra files on the host and map them to read-only bind mounts.
|
||||
|
||||
Bind-mount backends bypass the manifest, so the content is written under
|
||||
``staging_dir`` (one numbered subdirectory per file to avoid basename
|
||||
collisions) and mounted read-only at the same ``/workspace/<rel>`` path the
|
||||
manifest path would use. Invalid items — including paths that collide with
|
||||
a ``local_sources`` tree or with an earlier extra file, which would
|
||||
duplicate or shadow its mount target — are skipped with a warning.
|
||||
"""
|
||||
source_roots = _source_root_rels(local_sources)
|
||||
placed: list[str] = []
|
||||
mounts: list[dict[str, Any]] = []
|
||||
for index, extra_file in enumerate(extra_files):
|
||||
rel = _extra_file_rel_path(str(extra_file.get("workspace_path") or ""))
|
||||
content = _extra_file_content(extra_file)
|
||||
if rel is None or content is None:
|
||||
logger.warning(
|
||||
"Skipping invalid extra file entry (workspace_path=%r)",
|
||||
extra_file.get("workspace_path"),
|
||||
)
|
||||
continue
|
||||
if _collides_with_source_root(rel, source_roots + placed):
|
||||
logger.warning(
|
||||
"Skipping extra file colliding with a local source tree or an "
|
||||
"earlier extra file (workspace_path=%r)",
|
||||
extra_file.get("workspace_path"),
|
||||
)
|
||||
continue
|
||||
placed.append(rel)
|
||||
host_file = staging_dir / str(index) / Path(rel).name
|
||||
host_file.parent.mkdir(parents=True, exist_ok=True)
|
||||
host_file.write_bytes(content)
|
||||
mounts.append(
|
||||
{
|
||||
"source": str(host_file),
|
||||
"target": f"{_WORKSPACE_ROOT}/{rel}",
|
||||
"read_only": True,
|
||||
}
|
||||
)
|
||||
return mounts
|
||||
|
||||
|
||||
def _metadata_mounts(tree: Path, target: str) -> list[dict[str, Any]]:
|
||||
mounts: list[dict[str, Any]] = []
|
||||
for name in _PROTECTED_METADATA_NAMES:
|
||||
@@ -111,12 +251,19 @@ async def create_or_reuse(
|
||||
*,
|
||||
image: str,
|
||||
local_sources: list[dict[str, Any]],
|
||||
extra_files: list[dict[str, Any]] | None = None,
|
||||
status_sink: StatusSink | None = None,
|
||||
) -> dict[str, Any]:
|
||||
"""Return the existing session bundle for ``scan_id`` or create a new one.
|
||||
|
||||
Each ``local_sources`` entry exposes its host ``source_path`` at
|
||||
``/workspace/<workspace_subdir>`` inside the container.
|
||||
|
||||
Each ``extra_files`` entry (``{"workspace_path": "/workspace/<rel>",
|
||||
"content": bytes | str}``) lands as a single file at its ``workspace_path``
|
||||
regardless of backend: an in-memory ``File`` manifest entry on manifest
|
||||
backends, a read-only bind mount of a host-staged copy on bind-mount
|
||||
backends.
|
||||
"""
|
||||
|
||||
def report(phase: str) -> None:
|
||||
@@ -134,9 +281,16 @@ async def create_or_reuse(
|
||||
if backend_supports_bind_mounts(backend_name):
|
||||
bind_mounts = build_bind_mounts(local_sources)
|
||||
entries: dict[str | Path, BaseEntry] = {}
|
||||
if extra_files:
|
||||
staging_dir = runtime_state_dir(run_dir_for(scan_id)) / "extra_files"
|
||||
bind_mounts.extend(
|
||||
build_extra_file_bind_mounts(extra_files, staging_dir, local_sources)
|
||||
)
|
||||
else:
|
||||
bind_mounts = []
|
||||
entries = build_manifest_entries(local_sources)
|
||||
if extra_files:
|
||||
entries.update(build_extra_file_entries(extra_files, local_sources))
|
||||
|
||||
# Caido runs as an in-container sidecar; HTTP(S) traffic from any
|
||||
# process started via ``session.exec`` (the SDK's Shell tool, etc.)
|
||||
|
||||
Reference in New Issue
Block a user