Add command policy audit trail
This commit is contained in:
@@ -0,0 +1,180 @@
|
||||
import shlex
|
||||
from dataclasses import dataclass
|
||||
|
||||
from pydantic import BaseModel
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class CommandPattern:
|
||||
words: tuple[str, ...]
|
||||
action_type: str
|
||||
risk_level: str
|
||||
|
||||
|
||||
class CommandPolicyResult(BaseModel):
|
||||
command: str
|
||||
normalized_command: str
|
||||
action_type: str
|
||||
risk_level: str
|
||||
requires_approval: bool
|
||||
requires_password: bool
|
||||
blocked: bool = False
|
||||
reason: str | None = None
|
||||
|
||||
|
||||
class CommandPolicy:
|
||||
READONLY_PATTERNS = (
|
||||
CommandPattern(("pwd",), "working_directory", "low"),
|
||||
CommandPattern(("ls",), "directory_list", "low"),
|
||||
CommandPattern(("cat",), "file_read", "low"),
|
||||
CommandPattern(("head",), "file_read", "low"),
|
||||
CommandPattern(("tail",), "file_read", "low"),
|
||||
CommandPattern(("grep",), "text_search", "low"),
|
||||
CommandPattern(("find",), "file_search", "low"),
|
||||
CommandPattern(("apt", "list"), "package_check", "low"),
|
||||
CommandPattern(("apt-cache", "policy"), "package_check", "low"),
|
||||
CommandPattern(("git", "status"), "vcs_status", "low"),
|
||||
CommandPattern(("git", "diff"), "vcs_inspect", "low"),
|
||||
CommandPattern(("git", "log"), "vcs_inspect", "low"),
|
||||
CommandPattern(("pytest",), "test_run", "low"),
|
||||
CommandPattern(("python", "-m", "pytest"), "test_run", "low"),
|
||||
CommandPattern(("python3", "-m", "pytest"), "test_run", "low"),
|
||||
)
|
||||
SYSTEM_PATTERNS = (
|
||||
CommandPattern(("apt", "update"), "package_cache_update", "high"),
|
||||
CommandPattern(("apt", "install"), "package_install", "high"),
|
||||
CommandPattern(("apt", "remove"), "package_remove", "high"),
|
||||
CommandPattern(("apt", "upgrade"), "package_upgrade", "high"),
|
||||
CommandPattern(("systemctl",), "service_control", "high"),
|
||||
CommandPattern(("service",), "service_control", "high"),
|
||||
)
|
||||
DESTRUCTIVE_COMMANDS = {
|
||||
"rm",
|
||||
"dd",
|
||||
"mkfs",
|
||||
"mount",
|
||||
"umount",
|
||||
"shutdown",
|
||||
"reboot",
|
||||
"poweroff",
|
||||
"su",
|
||||
}
|
||||
DANGEROUS_FRAGMENTS = ("curl | sh", "wget | sh", "chmod -r", "chown -r")
|
||||
|
||||
@classmethod
|
||||
def classify(cls, command: str) -> CommandPolicyResult:
|
||||
command = command.strip()
|
||||
parts = cls._split(command)
|
||||
normalized_parts = cls._strip_sudo(parts)
|
||||
normalized_command = shlex.join(normalized_parts) if normalized_parts else command
|
||||
uses_sudo = bool(parts) and parts[0] == "sudo"
|
||||
lowered = command.lower()
|
||||
|
||||
if not command:
|
||||
return cls._result(command, normalized_command, "empty", "low", False, False, True, "Empty command")
|
||||
if not parts:
|
||||
return cls._result(command, normalized_command, "invalid", "medium", True, False, False, "Command could not be parsed")
|
||||
if cls._is_destructive(normalized_parts, lowered):
|
||||
return cls._result(
|
||||
command,
|
||||
normalized_command,
|
||||
"destructive",
|
||||
"critical",
|
||||
False,
|
||||
uses_sudo,
|
||||
True,
|
||||
"Command is blocked by safety policy",
|
||||
)
|
||||
|
||||
readonly = cls._match(normalized_parts, cls.READONLY_PATTERNS)
|
||||
if readonly:
|
||||
requires_approval = uses_sudo
|
||||
return cls._result(
|
||||
command,
|
||||
normalized_command,
|
||||
readonly.action_type,
|
||||
readonly.risk_level if not uses_sudo else "medium",
|
||||
requires_approval,
|
||||
uses_sudo,
|
||||
False,
|
||||
"Sudo command requires approval" if uses_sudo else None,
|
||||
)
|
||||
|
||||
system = cls._match(normalized_parts, cls.SYSTEM_PATTERNS)
|
||||
if system:
|
||||
return cls._result(
|
||||
command,
|
||||
normalized_command,
|
||||
system.action_type,
|
||||
system.risk_level,
|
||||
True,
|
||||
uses_sudo,
|
||||
False,
|
||||
"System command requires approval",
|
||||
)
|
||||
|
||||
return cls._result(
|
||||
command,
|
||||
normalized_command,
|
||||
"shell_command",
|
||||
"medium",
|
||||
True,
|
||||
uses_sudo,
|
||||
False,
|
||||
"Command is outside allowlist and requires approval",
|
||||
)
|
||||
|
||||
@classmethod
|
||||
def _split(cls, command: str) -> list[str]:
|
||||
try:
|
||||
return shlex.split(command)
|
||||
except ValueError:
|
||||
return []
|
||||
|
||||
@classmethod
|
||||
def _strip_sudo(cls, parts: list[str]) -> list[str]:
|
||||
if parts and parts[0] == "sudo":
|
||||
stripped = parts[1:]
|
||||
while stripped and stripped[0].startswith("-"):
|
||||
stripped = stripped[1:]
|
||||
return stripped
|
||||
return parts
|
||||
|
||||
@classmethod
|
||||
def _match(
|
||||
cls, parts: list[str], patterns: tuple[CommandPattern, ...]
|
||||
) -> CommandPattern | None:
|
||||
lowered = tuple(part.lower() for part in parts)
|
||||
for pattern in patterns:
|
||||
if lowered[: len(pattern.words)] == pattern.words:
|
||||
return pattern
|
||||
return None
|
||||
|
||||
@classmethod
|
||||
def _is_destructive(cls, parts: list[str], lowered_command: str) -> bool:
|
||||
if any(fragment in lowered_command for fragment in cls.DANGEROUS_FRAGMENTS):
|
||||
return True
|
||||
return bool(parts) and parts[0].lower() in cls.DESTRUCTIVE_COMMANDS
|
||||
|
||||
@classmethod
|
||||
def _result(
|
||||
cls,
|
||||
command: str,
|
||||
normalized_command: str,
|
||||
action_type: str,
|
||||
risk_level: str,
|
||||
requires_approval: bool,
|
||||
requires_password: bool,
|
||||
blocked: bool,
|
||||
reason: str | None,
|
||||
) -> CommandPolicyResult:
|
||||
return CommandPolicyResult(
|
||||
command=command,
|
||||
normalized_command=normalized_command,
|
||||
action_type=action_type,
|
||||
risk_level=risk_level,
|
||||
requires_approval=requires_approval,
|
||||
requires_password=requires_password,
|
||||
blocked=blocked,
|
||||
reason=reason,
|
||||
)
|
||||
@@ -3,6 +3,7 @@ import subprocess
|
||||
from typing import Any
|
||||
|
||||
from duck_core.tools.base import ToolResult
|
||||
from duck_core.tools.command_policy import CommandPolicy
|
||||
|
||||
|
||||
ALLOWLIST = {
|
||||
@@ -60,15 +61,19 @@ class ShellExecSafeTool:
|
||||
command = str(args.get("command", "")).strip()
|
||||
approved = bool(args.get("_approved"))
|
||||
password = args.get("_password")
|
||||
policy = CommandPolicy.classify(command)
|
||||
allowed, reason, blocked = self._is_allowed(command, approved=approved)
|
||||
if not allowed:
|
||||
metadata = {"blocked": True} if blocked else {"requires_approval": True}
|
||||
metadata = {
|
||||
**policy.model_dump(),
|
||||
**({"blocked": True} if blocked else {"requires_approval": True}),
|
||||
}
|
||||
return ToolResult(ok=False, error=reason, metadata=metadata)
|
||||
if self._is_sudo_command(command) and not password:
|
||||
return ToolResult(
|
||||
ok=False,
|
||||
error="Sudo password is required to run this command.",
|
||||
metadata={"requires_password": True},
|
||||
metadata={**policy.model_dump(), "requires_password": True},
|
||||
)
|
||||
run_command = self._sudo_stdin_command(command) if self._is_sudo_command(command) else command
|
||||
input_text = f"{password}\n" if self._is_sudo_command(command) else None
|
||||
@@ -89,23 +94,27 @@ class ShellExecSafeTool:
|
||||
ok=completed.returncode == 0,
|
||||
output=completed.stdout,
|
||||
error=completed.stderr if completed.returncode else None,
|
||||
metadata={"returncode": completed.returncode, "command": command},
|
||||
metadata={
|
||||
**{
|
||||
key: value
|
||||
for key, value in policy.model_dump().items()
|
||||
if key not in {"requires_approval", "requires_password"}
|
||||
},
|
||||
"returncode": completed.returncode,
|
||||
},
|
||||
)
|
||||
|
||||
def _is_allowed(
|
||||
self, command: str, approved: bool = False
|
||||
) -> tuple[bool, str | None, bool]:
|
||||
if not command:
|
||||
return False, "Empty command", False
|
||||
lowered = command.lower()
|
||||
parts = shlex.split(command)
|
||||
for blocked in BLOCKLIST:
|
||||
if self._matches_blocked_command(lowered, parts, blocked):
|
||||
return False, f"Command is blocked: {blocked}", True
|
||||
policy = CommandPolicy.classify(command)
|
||||
if policy.blocked:
|
||||
return False, policy.reason, True
|
||||
if approved:
|
||||
return True, None, False
|
||||
if self._is_sudo_command(command):
|
||||
return False, "Sudo command requires approval.", False
|
||||
if policy.requires_approval:
|
||||
return False, policy.reason, False
|
||||
parts = shlex.split(command)
|
||||
prefix1 = parts[0] if parts else ""
|
||||
prefix2 = " ".join(parts[:2])
|
||||
prefix3 = " ".join(parts[:3])
|
||||
|
||||
Reference in New Issue
Block a user