open-swe/agent/middleware/workflow_push_guard.py
amoussa1229 57e8afa19f Key workflow approval fingerprint on file content hash
Switches the fingerprint from {repo, branch, base_sha, files} to
{repo, branch, files, content_hash}, where content_hash is a SHA-256 of the
workflow-file contents at the pushed head. This keeps the security property:
a content change to the same workflow file requires re-review, while a rebase
that replays the same workflow diff stays auto-approved.

Also updates the prompt and Slack approval copy to match the new behavior, and
extends the test to exercise the remote-branch-exists path (changing base_sha)
and assert content changes produce a different fingerprint.

Refs: 98
2026-07-01 19:23:34 +00:00

619 lines
21 KiB
Python

"""Gate workflow-file pushes on human approval."""
from __future__ import annotations
import asyncio
import hashlib
import json
import logging
import os
import re
import shlex
import threading
from collections.abc import Awaitable, Callable, Mapping
from dataclasses import dataclass
from typing import Any
from langchain.agents.middleware.types import AgentMiddleware, AgentState
from langchain_core.messages import ToolMessage
from langgraph.config import get_config
from langgraph.prebuilt.tool_node import ToolCallRequest
from langgraph.types import Command
from ..dashboard.workflow_approval import (
ensure_workflow_push_pending,
find_workflow_push_approval,
mark_workflow_push_notified,
workflow_push_approved,
)
from ..tools.slack_thread_reply import build_workflow_approval_blocks
from ..utils.github_app import (
BASE_RUNTIME_PROXY_TOKEN_PERMISSIONS,
RUNTIME_PROXY_TOKEN_PERMISSIONS,
WORKFLOW_RUNTIME_PROXY_TOKEN_PERMISSIONS,
)
from ..utils.github_proxy import refresh_proxy_token
from ..utils.sandbox_state import SANDBOX_BACKENDS
from ..utils.slack import post_slack_thread_reply_with_ts
logger = logging.getLogger(__name__)
_WORKFLOW_PREFIX = ".github/workflows/"
_SHELL_OPERATORS = {";", "|", "||", "&"}
_REF_NAME = re.compile(r"^[A-Za-z0-9._/@+-]+$")
_GIT_OBJECT_ID = re.compile(r"^[0-9a-fA-F]{40,64}$")
_UNSAFE_RAW_COMMAND = re.compile(r"[;|`$<>\n\r]")
@dataclass(frozen=True)
class ParsedGitPush:
repo_dir: str | None
remote: str
local_ref: str
remote_ref: str
set_upstream: bool = False
@dataclass(frozen=True)
class WorkflowPushChange:
fingerprint: str
repo: str
branch: str
base_sha: str
head_sha: str
files: list[str]
remote: str
local_ref: str
remote_ref: str
fixed_command: str
@dataclass(frozen=True)
class GitInspectResult:
output: str
ok: bool
def _tool_name(request: ToolCallRequest) -> str | None:
tool_call = getattr(request, "tool_call", None)
if isinstance(tool_call, Mapping):
name = tool_call.get("name")
return name if isinstance(name, str) else None
return None
def _tool_args(request: ToolCallRequest) -> dict[str, Any]:
tool_call = getattr(request, "tool_call", None)
args = tool_call.get("args") if isinstance(tool_call, Mapping) else None
return dict(args) if isinstance(args, Mapping) else {}
def _tool_call_id(request: ToolCallRequest) -> str | None:
tool_call = getattr(request, "tool_call", None)
if isinstance(tool_call, Mapping):
value = tool_call.get("id")
return value if isinstance(value, str) else None
return None
def _config(request: ToolCallRequest) -> Mapping[str, Any]:
runtime_config = getattr(getattr(request, "runtime", None), "config", None)
if isinstance(runtime_config, Mapping):
return runtime_config
try:
config = get_config()
except Exception:
return {}
return config if isinstance(config, Mapping) else {}
def _configurable(request: ToolCallRequest) -> Mapping[str, Any]:
config = _config(request)
configurable = config.get("configurable")
return configurable if isinstance(configurable, Mapping) else {}
def _thread_id(request: ToolCallRequest) -> str | None:
thread_id = _configurable(request).get("thread_id")
return thread_id if isinstance(thread_id, str) and thread_id else None
def _backend(thread_id: str | None) -> Any | None:
return SANDBOX_BACKENDS.get(thread_id) if thread_id else None
def _response_output(response: Any) -> str:
output = getattr(response, "output", None)
if isinstance(output, str):
return output
if isinstance(response, Mapping):
value = response.get("output")
if isinstance(value, str):
return value
return str(response or "")
def _response_ok(response: Any) -> bool:
exit_code = getattr(response, "exit_code", None)
if isinstance(exit_code, int):
return exit_code == 0
if isinstance(response, Mapping):
value = response.get("exit_code")
if isinstance(value, int):
return value == 0
return True
def _parse_git_push(command: str) -> ParsedGitPush | None:
stripped = command.strip()
if _UNSAFE_RAW_COMMAND.search(stripped) or "&" in stripped.replace("&&", ""):
return None
try:
tokens = shlex.split(stripped)
except ValueError:
return None
if not tokens:
return None
if len(tokens) >= 4 and tokens[0] == "cd" and tokens[2] == "&&":
if any(token in _SHELL_OPERATORS or token == "&&" for token in tokens[3:]):
return None
return _parse_git_tokens(tokens[3:], repo_dir=tokens[1])
if any(token in _SHELL_OPERATORS or token == "&&" for token in tokens):
return None
return _parse_git_tokens(tokens, repo_dir=None)
def _parse_git_tokens(tokens: list[str], *, repo_dir: str | None) -> ParsedGitPush | None:
if not tokens or tokens[0] != "git":
return None
i = 1
while i < len(tokens) and tokens[i] != "push":
if tokens[i] == "-C" and i + 1 < len(tokens):
repo_dir = tokens[i + 1]
i += 2
continue
return None
if i >= len(tokens) or tokens[i] != "push":
return None
return _parse_push_args(tokens[i + 1 :], repo_dir=repo_dir)
def _parse_push_args(tokens: list[str], *, repo_dir: str | None) -> ParsedGitPush | None:
set_upstream = False
while tokens and tokens[0] in {"-u", "--set-upstream"}:
set_upstream = True
tokens = tokens[1:]
if len(tokens) != 2 or tokens[0] != "origin":
return None
parsed = _parse_refspec(tokens[1])
if parsed is None:
return None
local_ref, remote_ref = parsed
return ParsedGitPush(
repo_dir=repo_dir,
remote="origin",
local_ref=local_ref,
remote_ref=remote_ref,
set_upstream=set_upstream,
)
def _parse_refspec(refspec: str) -> tuple[str, str] | None:
if refspec.startswith("-") or ".." in refspec:
return None
if ":" in refspec:
parts = refspec.split(":")
if len(parts) != 2 or not parts[0] or not parts[1]:
return None
local_ref, remote_ref = parts
else:
local_ref = remote_ref = refspec
if not _safe_ref(local_ref, allow_head=True) or not _safe_ref(remote_ref, allow_head=False):
return None
return local_ref, remote_ref
def _safe_ref(ref: str, *, allow_head: bool) -> bool:
if allow_head and ref == "HEAD":
return True
if ref == "HEAD" or not _REF_NAME.fullmatch(ref):
return False
return not any(part in {"", ".", ".."} for part in ref.split("/"))
def _git_command(repo_dir: str | None, args: str) -> str:
if repo_dir:
return f"git -C {shlex.quote(repo_dir)} {args}"
return f"git {args}"
def _run_git(backend: Any, repo_dir: str | None, args: str) -> GitInspectResult:
try:
response = backend.execute(_git_command(repo_dir, args), timeout=30)
except Exception:
logger.debug("workflow push inspection failed for git %s", args, exc_info=True)
return GitInspectResult("", False)
return GitInspectResult(_response_output(response).strip(), _response_ok(response))
def _first_line(text: str) -> str:
for line in text.splitlines():
stripped = line.strip()
if stripped:
return stripped
return ""
def _normalize_remote(remote: str) -> str:
value = remote.strip()
if value.endswith(".git"):
value = value[:-4]
value = re.sub(r"^https://[^/@]+@github\.com/", "https://github.com/", value)
value = re.sub(r"^git@github\.com:", "https://github.com/", value)
return value
def _fingerprint(payload: Mapping[str, Any]) -> str:
encoded = json.dumps(payload, sort_keys=True, separators=(",", ":")).encode("utf-8")
return hashlib.sha256(encoded).hexdigest()
def _run_coroutine_sync(coro: Awaitable[ToolMessage | Command]) -> ToolMessage | Command:
try:
asyncio.get_running_loop()
except RuntimeError:
return asyncio.run(coro)
result: dict[str, ToolMessage | Command | BaseException] = {}
def target() -> None:
try:
result["value"] = asyncio.run(coro)
except BaseException as exc: # noqa: BLE001
result["value"] = exc
thread = threading.Thread(target=target)
thread.start()
thread.join()
value = result["value"]
if isinstance(value, BaseException):
raise value
return value
def _workflow_change_for_push(backend: Any, parsed: ParsedGitPush) -> WorkflowPushChange | None:
root_result = _run_git(backend, parsed.repo_dir, "rev-parse --show-toplevel")
if not root_result.ok:
return None
root = _first_line(root_result.output)
if not root:
return None
branch = _run_git(backend, root, "rev-parse --abbrev-ref HEAD")
branch_name = _first_line(branch.output) if branch.ok else ""
if not branch_name or branch_name == "HEAD" or parsed.remote_ref != branch_name:
return None
if parsed.local_ref not in {"HEAD", branch_name}:
return None
target_sha = _run_git(backend, root, f"rev-parse {shlex.quote(parsed.local_ref)}")
head = _first_line(target_sha.output) if target_sha.ok else ""
if not head or not _GIT_OBJECT_ID.fullmatch(head):
return None
remote_branch = f"refs/remotes/{parsed.remote}/{parsed.remote_ref}"
remote_branch_exists = _run_git(
backend, root, f"rev-parse --verify {shlex.quote(remote_branch)}"
)
if remote_branch_exists.ok and _first_line(remote_branch_exists.output):
base_ref = remote_branch
range_expr = f"{shlex.quote(base_ref)}..{shlex.quote(head)}"
base_sha = _first_line(_run_git(backend, root, f"rev-parse {shlex.quote(base_ref)}").output)
else:
origin_head = _run_git(backend, root, "symbolic-ref --short refs/remotes/origin/HEAD")
base_ref = _first_line(origin_head.output) if origin_head.ok else "origin/main"
range_expr = f"{shlex.quote(base_ref)}...{shlex.quote(head)}"
base_sha = _first_line(
_run_git(
backend, root, f"merge-base {shlex.quote(head)} {shlex.quote(base_ref)}"
).output
)
names = _run_git(
backend,
root,
f"diff --name-only --diff-filter=ACMRTD {range_expr} -- .github/workflows",
)
if not names.ok:
return None
files = sorted(
line.strip()
for line in names.output.splitlines()
if line.strip().startswith(_WORKFLOW_PREFIX)
)
if not files:
return None
diff = _run_git(backend, root, f"diff --binary --full-index {range_expr} -- .github/workflows")
if not diff.ok or not diff.output:
return None
content_parts: list[str] = []
for path in files:
blob = _run_git(backend, root, f"show {shlex.quote(head)}:{shlex.quote(path)}")
if not blob.ok:
return None
content_parts.append(blob.output)
content_hash = _fingerprint({"contents": content_parts})
remote = _run_git(backend, root, "config --get remote.origin.url")
repo = _normalize_remote(_first_line(remote.output)) if remote.ok else ""
fixed_refspec = f"{head}:refs/heads/{parsed.remote_ref}"
fixed_args = ["push"]
if parsed.set_upstream:
fixed_args.append("--set-upstream")
fixed_args.extend([parsed.remote, fixed_refspec])
fixed_command = _git_command(root, " ".join(shlex.quote(arg) for arg in fixed_args))
content_payload = {
"repo": repo,
"branch": branch_name,
"files": files,
"content_hash": content_hash,
}
return WorkflowPushChange(
fingerprint=_fingerprint(content_payload),
repo=repo,
branch=branch_name,
base_sha=base_sha,
head_sha=head,
files=files,
remote=parsed.remote,
local_ref=parsed.local_ref,
remote_ref=parsed.remote_ref,
fixed_command=fixed_command,
)
def _blocked_message(
change: WorkflowPushChange, *, already_rejected: bool = False, stale: bool = False
) -> ToolMessage:
status = "rejected" if already_rejected else "approval_required"
if stale:
error = (
"This git push includes GitHub workflow file changes. A previous approval "
"exists for the same branch and workflow files, but the workflow diff has "
"changed since that approval (for example, a rebase or amend). The thread "
"owner must re-approve the new fingerprint before Open SWE can push it."
)
else:
error = (
"This git push includes GitHub workflow file changes and requires human "
"approval before Open SWE can push it. Retry the same standalone git push "
"after the thread owner approves the workflow diff."
)
content = {
"status": "error",
"error_type": "WorkflowPushApprovalRequired",
"error": error,
"workflow_approval_status": status,
"fingerprint": change.fingerprint,
"files": change.files,
"repo": change.repo,
"branch": change.branch,
}
return ToolMessage(content=json.dumps(content), tool_call_id="", status="error")
def _tool_message_for_request(message: ToolMessage, request: ToolCallRequest) -> ToolMessage:
message.tool_call_id = _tool_call_id(request)
return message
def _override_execute_command(request: ToolCallRequest, command: str) -> ToolCallRequest:
tool_call = getattr(request, "tool_call", None)
if not isinstance(tool_call, Mapping):
return request
args = dict(_tool_args(request))
args["command"] = command
return request.override(tool_call={**dict(tool_call), "args": args})
def _approval_slack_message(change: WorkflowPushChange) -> str:
files = "\n".join(f"• `{path}`" for path in change.files[:10])
if len(change.files) > 10:
files += f"\n• …and {len(change.files) - 10} more"
repo = change.repo or "the repository"
branch = change.branch or "the current branch"
return (
"*Workflow file approval required*\n"
f"Open SWE is trying to push changes to GitHub workflow files in `{repo}` on `{branch}`.\n\n"
f"*Files:*\n{files}\n\n"
f"*Fingerprint:* `{change.fingerprint}`\n\n"
"Approval covers the exact workflow-file content diff listed above on this branch, "
"including future rebases or amends that replay the same diff. If the set of workflow "
"files, the branch, or the workflow-file content changes, a new fingerprint will be required."
)
async def _post_slack_approval_if_needed(
request: ToolCallRequest, change: WorkflowPushChange, record: Mapping[str, Any]
) -> None:
if record.get("notified") is True:
return
configurable = _configurable(request)
slack_thread = configurable.get("slack_thread")
if not isinstance(slack_thread, Mapping):
return
channel_id = slack_thread.get("channel_id")
thread_ts = slack_thread.get("thread_ts")
if not isinstance(channel_id, str) or not isinstance(thread_ts, str):
return
message = _approval_slack_message(change)
message_ts, error = await post_slack_thread_reply_with_ts(
channel_id,
thread_ts,
message,
blocks=build_workflow_approval_blocks(message, change.fingerprint),
)
if message_ts and not error:
thread_id = _thread_id(request)
if thread_id:
await mark_workflow_push_notified(thread_id, change.fingerprint)
async def _approval_state(request: ToolCallRequest, change: WorkflowPushChange) -> str:
thread_id = _thread_id(request)
if not thread_id:
return "missing_thread"
try:
if await workflow_push_approved(thread_id, change.fingerprint):
return "approved"
# If the exact identity fingerprint is not approved, check whether a prior
# approval covers the same (repo, branch, files) identity. If so, the diff
# changed underneath the prior approval (rebase/amend/edit), so we surface a
# loud re-approval message rather than a fresh silent pending record.
prior = await find_workflow_push_approval(
thread_id,
repo=change.repo,
branch=change.branch,
files=change.files,
)
if prior is not None:
return "stale_approval"
record, _created = await ensure_workflow_push_pending(
thread_id,
fingerprint=change.fingerprint,
repo=change.repo,
branch=change.branch,
base_sha=change.base_sha,
head_sha=change.head_sha,
files=change.files,
)
await _post_slack_approval_if_needed(request, change, record)
return str(record.get("status") or "pending")
except Exception:
logger.exception("Failed to read or write workflow push approval state")
return "approval_error"
async def _run_with_workflow_token(
thread_id: str,
request: ToolCallRequest,
run: Callable[[], Awaitable[ToolMessage | Command]],
) -> ToolMessage | Command:
sandbox_type = os.getenv("SANDBOX_TYPE", "langsmith")
if sandbox_type != "langsmith":
return await run()
elevated = await refresh_proxy_token(
thread_id, permissions=WORKFLOW_RUNTIME_PROXY_TOKEN_PERMISSIONS
)
if not elevated:
logger.error(
"Workflow push approved for thread %s, but proxy token elevation to workflows:write "
"failed; the sandbox cannot push workflow files without an elevated token.",
thread_id,
)
error_message = ToolMessage(
content=json.dumps(
{
"status": "error",
"error_type": "WorkflowPushElevationFailed",
"error": (
"Workflow push approved, but the sandbox could not obtain a "
"workflows-scoped token. Please retry the push or check the "
"GitHub proxy / token minting configuration."
),
}
),
tool_call_id="",
status="error",
)
return _tool_message_for_request(error_message, request)
try:
return await run()
finally:
restored = await refresh_proxy_token(thread_id, permissions=RUNTIME_PROXY_TOKEN_PERMISSIONS)
if not restored:
await refresh_proxy_token(thread_id, permissions=BASE_RUNTIME_PROXY_TOKEN_PERMISSIONS)
class WorkflowPushGuardMiddleware(AgentMiddleware):
"""Require approval before pushing `.github/workflows` changes."""
state_schema = AgentState
def _change_for_request(self, request: ToolCallRequest) -> WorkflowPushChange | None:
if _tool_name(request) != "execute":
return None
command = _tool_args(request).get("command")
if not isinstance(command, str):
return None
parsed = _parse_git_push(command)
if parsed is None:
return None
backend = _backend(_thread_id(request))
if backend is None:
return None
return _workflow_change_for_push(backend, parsed)
async def _handle_change_async(
self,
request: ToolCallRequest,
handler: Callable[[ToolCallRequest], Awaitable[ToolMessage | Command]],
change: WorkflowPushChange,
) -> ToolMessage | Command:
thread_id = _thread_id(request)
state = await _approval_state(request, change)
if state == "approved" and thread_id:
safe_request = _override_execute_command(request, change.fixed_command)
return await _run_with_workflow_token(thread_id, request, lambda: handler(safe_request))
if state == "stale_approval":
record, _created = await ensure_workflow_push_pending(
thread_id,
fingerprint=change.fingerprint,
repo=change.repo,
branch=change.branch,
base_sha=change.base_sha,
head_sha=change.head_sha,
files=change.files,
)
await _post_slack_approval_if_needed(request, change, record)
return _tool_message_for_request(
_blocked_message(
change,
already_rejected=state == "rejected",
stale=state == "stale_approval",
),
request,
)
def wrap_tool_call(
self,
request: ToolCallRequest,
handler: Callable[[ToolCallRequest], ToolMessage | Command],
) -> ToolMessage | Command:
change = self._change_for_request(request)
if change is None:
return handler(request)
async def run_handler() -> ToolMessage | Command:
return handler(request)
return _run_coroutine_sync(
self._handle_change_async(request, lambda _request: run_handler(), change)
)
async def awrap_tool_call(
self,
request: ToolCallRequest,
handler: Callable[[ToolCallRequest], Awaitable[ToolMessage | Command]],
) -> ToolMessage | Command:
change = self._change_for_request(request)
if change is None:
return await handler(request)
return await self._handle_change_async(request, handler, change)