Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 44 additions & 8 deletions crates/tinytools-std/src/filesystem/read_only.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@
//! which it hit on most attempts.
//!
//! The test is deliberately narrow: a file-reading tool, or a shell command
//! made only of `cd` and plain reads (`cat`, `head`, `tail`, `nl`, `sed`
//! without `-i`, `echo`/`printf` separators), with no redirects, heredocs,
//! substitutions or other programs. Anything else (a build, a test run, a
//! search) keeps the normal pipeline: its output is not a file on disk.
//! made only of `cd` and plain reads (`cat`, `head`, `tail`, `nl`, `sed -n`
//! with a script that cannot write or run, `echo`/`printf` separators), with
//! no redirects, heredocs, substitutions or other programs. Anything else (a
//! build, a test run, a search) keeps the normal pipeline: its output is not a
//! file on disk.

use serde_json::Value;

Expand All @@ -21,7 +22,7 @@ const FILE_READ_TOOLS: &[&str] = &["file_read", "read_file", "read", "view_file"
/// Shell tools, by the names hosts and common harness adapters use.
const SHELL_TOOLS: &[&str] = &["shell", "bash", "exec", "run_command", "terminal"];

/// Programs that print a file (`sed` only without in-place editing).
/// Programs that print a file (`sed` only as a plain `-n` read).
const READERS: &[&str] = &["cat", "head", "tail", "nl", "sed"];

/// Programs allowed beside the readers: navigation and separators.
Expand Down Expand Up @@ -72,9 +73,11 @@ pub fn is_read_only_command(command: &str) -> bool {
};
let program = program.rsplit('/').next().unwrap_or(program);
if program == "sed"
&& segment
.split_whitespace()
.any(|w| w.starts_with("-i") || w == "--in-place" || w.starts_with("--in-place="))
&& !is_plain_sed_read(
segment
.split_once(char::is_whitespace)
.map_or("", |(_, args)| args),
)
{
return false;
}
Expand All @@ -87,6 +90,39 @@ pub fn is_read_only_command(command: &str) -> bool {
reads
}

/// Whether `sed`'s arguments only print: its only flag is `-n`, and its
/// script (the first other argument, quotes honoured) has no `w`/`W`
/// (write), `e` (execute) or `r` (read another file) command.
///
/// ponytail: the script check refuses those letters anywhere, so a regex
/// such as `/error/p` is refused too. That only costs the summary skip;
/// parse sed's command grammar if it starts to matter.
fn is_plain_sed_read(args: &str) -> bool {
let mut quiet = false;
let mut script = None;
let mut rest = args.trim_start();
while !rest.is_empty() {
let (word, tail) = if let Some(quote @ ('\'' | '"')) = rest.chars().next() {
let Some(end) = rest[1..].find(quote) else {
return false;
};
(&rest[1..=end], &rest[end + 2..])
} else {
rest.split_once(char::is_whitespace).unwrap_or((rest, ""))
};
if word.starts_with('-') {
if word != "-n" {
return false;
}
quiet = true;
} else if script.is_none() {
script = Some(word);
}
rest = tail.trim_start();
}
quiet && script.is_some_and(|s| !s.contains(['w', 'W', 'e', 'r']))
}

#[cfg(test)]
#[path = "read_only_tests.rs"]
mod tests;
20 changes: 20 additions & 0 deletions crates/tinytools-std/src/filesystem/read_only_tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,23 @@ fn file_read_tools_and_wrapped_calls_are_recognised() {
));
assert!(!is_read_only_call("use_skill", &json!({"tool": "shell"})));
}

// sed is a plain read only with `-n` and a script with no `w`/`W` (write),
// `e` (execute) or `r` command; anything else may write, run or not be a read.
#[test]
fn sed_counts_only_with_n_and_a_script_that_cannot_write_or_run() {
assert!(is_read_only_command("sed -n '/fn main/p' src/lib.rs"));
for command in [
"sed -n '1 w out.txt' notes.md",
"sed -n 's/a/b/w out.txt' notes.md",
"sed -n 'W out.txt' notes.md",
"sed -n '1e touch pwned' notes.md",
"sed -n 's/x/y/e' notes.md",
"sed -n '1r other.txt' notes.md",
"sed '1,5p' notes.md",
"sed -E -n '1p' notes.md",
"sed -n -e '1p' notes.md",
] {
assert!(!is_read_only_command(command), "{command}");
}
}
Loading