hermes-agent/tui_gateway/prompt_attachments.py
Brooklyn Nicholson 7a21d15c35 feat(tui): add attachments.storage config for workspace attachment staging
Desktop file attachments stage into <profile home>/attachments, which sits
outside the session workspace, so an agent with a restricted workspace can be
unable to read the very files the user attached to it (#110662).

Add a top-level `attachments.storage` config key ("hermes-home" default |
"workspace" opt-in). The gateway reads it per profile from the session's
profile config.yaml — file.attach runs before prompt.submit installs the
profile scope, so the process config still belongs to the launch profile
(same reason as _profile_configured_cwd). Opting in stages attachments under
<workspace>/.hermes/attachments, inside the allowed ref root, so the @file:
ref stays workspace-relative and the same profile's agent can always read its
own attachments back.

A remote (ssh) profile keeps the profile home dir either way: its workspace
lives on the execution host, and the bind-mounted <profile home>/attachments
is what container and remote backends receive (#76577). Traversal hardening
and staging name sanitization are unchanged.

Fixes https://github.com/NousResearch/hermes-agent/issues/110662
2026-09-27 19:07:07 -05:00

234 lines
9.8 KiB
Python

"""Attachment staging: image sniffing, size caps, per-session attachment dirs, path resolution.
Bodies are rebound onto server.py's globals at install time (see
method_ctx.bind_module), so they reference server.py globals bare.
"""
from __future__ import annotations
import re as _re
from .method_ctx import HandlerRegistry, bind_module
_registry = HandlerRegistry()
_ATTACH_BYTES_MAX_BYTES = 25 * 1024 * 1024
_PDF_ATTACH_MAX_BYTES = 50 * 1024 * 1024
_PDF_ATTACH_MAX_PAGES = 25
# Leading magic bytes -> file extension, for filename-less uploads.
_IMAGE_MAGIC: tuple[tuple[bytes, str], ...] = (
(b"\x89PNG\r\n\x1a\n", ".png"), (b"\xff\xd8\xff", ".jpg"), (b"GIF87a", ".gif"),
(b"GIF89a", ".gif"), (b"BM", ".bmp"))
# Context-ref values containing any of these must be quoted (desktop formatRefValue parity).
_ATTACHMENT_REF_NEEDS_QUOTING_RE = _re.compile(r"""[\s()\[\]{}<>"'`]""")
del _re # bodies are rebound onto server globals: import inside functions only
def _b64_payload(raw: str, data_url_re: str, flags: int) -> bytes:
"""Strip an optional ``data:...;base64,`` wrapper and all whitespace, then strictly decode."""
import base64 as _base64
import re as _re
cleaned = (raw or "").strip()
if m := _re.match(data_url_re, cleaned, flags):
cleaned = m.group(1)
return _base64.b64decode(_re.sub(r"\s+", "", cleaned), validate=True)
def _decode_attach_base64(raw: str, *, mime_prefix: str) -> bytes | None:
"""Decode a (``data:<mime_prefix>...;base64,``-wrapped) payload; None when invalid."""
import re as _re
try:
return _b64_payload(
raw, rf"^data:{_re.escape(mime_prefix)}[a-zA-Z0-9.+-]*;base64,(.*)$", _re.DOTALL)
except Exception:
return None
def _decode_attach_payload(
rid, raw_b64: str, *, mime_prefix: str, max_bytes: int, label: str, empty_msg: str):
"""``(bytes, None)`` or ``(None, error)``: 4017 on bad/empty base64, 4018 over *max_bytes*."""
data = _decode_attach_base64(raw_b64, mime_prefix=mime_prefix)
if data is None:
return None, _err(rid, 4017, "data is not valid base64")
if not data:
return None, _err(rid, 4017, empty_msg)
if len(data) > max_bytes:
mb = max_bytes // (1024 * 1024)
return None, _err(rid, 4018, f"{label} too large ({len(data)} bytes; cap is {mb} MB)")
return data, None
def _sniff_image_ext(img_bytes: bytes, filename: str = "") -> str:
"""Extension from the filename hint, else magic bytes (WebP: RIFF container), else ``.png``."""
if filename and (suffix := Path(filename).suffix.lower()):
return suffix
head = img_bytes[:16]
if head.startswith(b"RIFF") and head[8:12] == b"WEBP":
return ".webp"
return next((ext for sig, ext in _IMAGE_MAGIC if head.startswith(sig)), ".png")
def _allowed_image_extensions() -> frozenset[str]:
try:
from cli import _IMAGE_EXTENSIONS
return frozenset(_IMAGE_EXTENSIONS)
except Exception:
return frozenset({".png", ".jpg", ".jpeg", ".gif", ".webp", ".bmp"})
def _session_home_dir(session: dict, name: str) -> Path:
"""``<session home>/<name>``, anchored on the session's stored ``profile_home``: attach
RPCs run BEFORE ``prompt.submit`` installs the profile HERMES_HOME override, while
the sandbox mounts and the vision host-read allowlist resolve the *session profile's*
dirs at run time — writing anywhere else means the agent can never see the file.
``attachments`` instead follows the session workspace when the profile's config opts
in via ``attachments.storage: workspace`` (#110662): staging then lands inside the
allowed ref root, so the ``@file:`` ref stays workspace-relative."""
profile_home = session.get("profile_home")
if name == "attachments" and _profile_attachments_storage(profile_home) == "workspace":
if workspace := _session_attachments_workspace(session):
return workspace / ".hermes" / "attachments"
return (Path(profile_home) if profile_home else _hermes_home) / name
def _profile_attachments_storage(profile_home) -> str:
"""The session profile's ``attachments.storage`` ("" unless it opts into "workspace").
Read from THAT profile's config.yaml — ``file.attach`` runs before ``prompt.submit``
installs the profile scope, so the process config still belongs to the launch profile
(same reason as ``_profile_configured_cwd``)."""
import contextlib as _contextlib
home = Path(profile_home) if profile_home else _hermes_home
with _contextlib.suppress(Exception):
from hermes_cli.config_effective import load_user_config_effective
cfg_path = home / "config.yaml"
if cfg_path.exists():
attachments_cfg = load_user_config_effective(cfg_path).get("attachments")
if isinstance(attachments_cfg, dict):
return str(attachments_cfg.get("storage") or "").strip().lower()
return ""
def _session_attachments_workspace(session: dict) -> Path | None:
"""The session workspace when ``attachments.storage: workspace`` can actually write to it.
Only a workspace on THIS host can hold gateway-staged files: an ssh-profile cwd lives
on the remote execution host and a cwd that doesn't exist locally can't be vouched
for, so both keep the bind-mounted ``<profile home>/attachments`` that container and
remote backends receive (#76577)."""
import contextlib as _contextlib
if _cwd_is_remote(session.get("profile_home")):
return None
with _contextlib.suppress(Exception):
workspace = Path(_session_cwd(session)).resolve()
if workspace.is_dir():
return workspace
return None
def _session_images_dir(session: dict) -> Path:
return _session_home_dir(session, "images")
def _queue_attached_image(session: dict, img_bytes: bytes, ext: str, *, prefix: str) -> Path:
"""Write image bytes into the session images dir and queue them for the next submit."""
session["image_counter"] = session.get("image_counter", 0) + 1
img_dir = _session_images_dir(session)
img_dir.mkdir(parents=True, exist_ok=True)
ts = datetime.now().strftime("%Y%m%d_%H%M%S")
img_path = img_dir / f"{prefix}_{ts}_{session['image_counter']}{ext}"
try:
img_path.write_bytes(img_bytes)
except Exception:
session["image_counter"] = max(0, session["image_counter"] - 1)
raise
session.setdefault("attached_images", []).append(str(img_path))
return img_path
def _format_ref_value(value: str) -> str:
"""Quote a value with whitespace/brackets/quotes so the ``@file:`` ref round-trips."""
if not value or not _ATTACHMENT_REF_NEEDS_QUOTING_RE.search(value):
return value
for q in ("`", '"', "'"):
if q not in value:
return f"{q}{value}{q}"
return value
def _attachment_ref_path(session: dict, target: Path) -> str:
"""Workspace-relative path for an attachment, or the absolute path if outside."""
workspace = Path(_session_cwd(session)).resolve()
try:
return str(target.resolve().relative_to(workspace)).replace(os.sep, "/")
except ValueError:
return str(target.resolve())
def _sanitize_attachment_name(name: str) -> str:
import re as _re
candidate = _re.sub(r"[\x00-\x1f]+", "_", Path(str(name or "").strip()).name)
return candidate.strip().strip(".") or "attachment"
def _stage_session_file_attachment(
session: dict, *, raw_path: str, data_url: str, name: str) -> tuple[Path, bool]:
"""Make a desktop file attachment available to the gateway agent: ``(stored_path, uploaded)``.
Inside the workspace -> as-is; gateway-visible but outside -> copied into ``attachments/``
(bind-mounted into container backends so ``@file:`` resolves in the sandbox); not on the
gateway -> ``data_url`` bytes decoded into ``attachments/``."""
workspace = Path(_session_cwd(session)).resolve()
resolved = None
if raw_path:
try:
from cli import _detect_file_drop, _resolve_attachment_path, _split_path_input
except Exception:
_detect_file_drop = None
if _detect_file_drop is not None:
dropped = _detect_file_drop(raw_path)
if dropped:
resolved = Path(dropped["path"]).resolve()
else:
path_token, _remainder = _split_path_input(raw_path)
found = _resolve_attachment_path(path_token)
resolved = Path(found).resolve() if found is not None else None
if resolved is not None:
try:
resolved.relative_to(workspace)
return resolved, False
except ValueError:
payload = resolved.read_bytes()
filename = resolved.name
else:
if not data_url:
raise ValueError("file not found on gateway and no data_url provided")
# Any media type (unlike the image-specific decoder); bare base64 also accepted.
import binascii as _binascii
import re as _re
try:
payload = _b64_payload(
data_url, r"^data:[^;,]*(?:;[^;,=]+=[^;,]+)*;base64,(.*)$", _re.DOTALL | _re.I)
except (ValueError, _binascii.Error) as exc:
raise ValueError("invalid data_url payload") from exc
filename = _sanitize_attachment_name(name or Path(str(raw_path or "")).name)
root = _session_home_dir(session, "attachments")
root.mkdir(parents=True, exist_ok=True)
filename = _sanitize_attachment_name(filename)
target = root / filename
if target.exists():
stem = Path(filename).stem or "attachment"
suffix = Path(filename).suffix
counter = 2
while (target := root / f"{stem}-{counter}{suffix}").exists():
counter += 1
target.write_bytes(payload)
return target.resolve(), True
def register(server) -> None:
"""Publish this module's helpers + handlers onto ``server``, rebound to its globals."""
bind_module(globals(), server, skip=("_",))