Files
odysseus/tests/test_code_nav_tools.py
T
Ashvin d3faa00aaa fix(security): match grep's rg sensitive-file exclusions case-insensitively (#5189)
The grep tool's ripgrep fast-path excluded deny-listed key files with
`--glob "!*<pat>*"` for each entry in _SENSITIVE_FILE_PATTERNS. ripgrep's
--glob is case-sensitive, so on a case-insensitive filesystem (Windows,
default macOS) a key stored under a case variant of its name (ID_RSA,
Known_Hosts, Authorized_Keys) is the same file on disk but slips past the
lowercase exclusion, and ripgrep returns its contents. Those names are
non-dotfiles, so ripgrep's default hidden-file skipping does not cover them
either. The Python fallback already blocks them via the case-folded
_is_sensitive_path (#5097), so the two paths disagreed.

Switch the sensitive-pattern exclusions to --iglob so they match
case-insensitively, mirroring _is_sensitive_path. Add a regression test
that seeds ID_RSA and Known_Hosts and asserts grep returns ordinary
matches but not the key contents.
2026-07-04 16:52:25 +01:00

199 lines
7.4 KiB
Python

"""Tests for the code-navigation tools (grep, glob, ls) + read_file line range."""
import os
import shutil
import asyncio
import tempfile
import pytest
os.environ.setdefault("DATABASE_URL", "sqlite:////tmp/test_code_nav.db")
from src.tool_execution import _direct_fallback
def _run(tool, content):
return asyncio.run(_direct_fallback(tool, content))
@pytest.fixture
def repo():
# Built under /tmp, which is on the default tool-path allowlist.
root = tempfile.mkdtemp(dir="/tmp", prefix="codenav_")
try:
with open(os.path.join(root, "a.py"), "w") as f:
f.write("import os\n# needle here\nprint('x')\n")
os.mkdir(os.path.join(root, "sub"))
with open(os.path.join(root, "sub", "b.txt"), "w") as f:
f.write("nothing\nNEEDLE upper\n")
os.mkdir(os.path.join(root, "sub", "deep"))
with open(os.path.join(root, "sub", "deep", "c.py"), "w") as f:
f.write("# deep python\n")
os.mkdir(os.path.join(root, "node_modules"))
with open(os.path.join(root, "node_modules", "dep.py"), "w") as f:
f.write("needle in dep\n")
g = os.path.join(root, ".git")
os.mkdir(g)
with open(os.path.join(g, "config"), "w") as f:
f.write("needle in git\n")
yield root
finally:
shutil.rmtree(root, ignore_errors=True)
# ── grep ──────────────────────────────────────────────────────────────────
def test_grep_finds_match(repo):
r = _run("grep", f'{{"pattern": "needle", "path": "{repo}"}}')
assert r["exit_code"] == 0
assert "a.py:2:" in r["output"]
def test_grep_skips_junk_dirs(repo):
r = _run("grep", f'{{"pattern": "needle", "path": "{repo}"}}')
assert "node_modules" not in r["output"]
assert ".git/config" not in r["output"]
def test_grep_ignore_case(repo):
r = _run("grep", f'{{"pattern": "needle", "ignore_case": true, "path": "{repo}"}}')
assert "b.txt:2:" in r["output"]
def test_grep_glob_filter(repo):
r = _run("grep", f'{{"pattern": "needle", "ignore_case": true, "glob": "*.py", "path": "{repo}"}}')
assert "a.py" in r["output"]
assert "b.txt" not in r["output"]
def test_grep_no_match(repo):
r = _run("grep", f'{{"pattern": "zzzznotfound", "path": "{repo}"}}')
assert r["exit_code"] == 0
assert "No matches" in r["output"]
def test_grep_requires_pattern(repo):
r = _run("grep", "{}")
assert r["exit_code"] == 1
assert "pattern is required" in r["error"]
def test_grep_path_outside_roots_rejected(repo):
r = _run("grep", '{"pattern": "x", "path": "/etc"}')
assert r["exit_code"] == 1
assert "outside the allowed roots" in r["error"]
def test_grep_python_fallback_when_no_rg(repo, monkeypatch):
monkeypatch.setattr(shutil, "which", lambda name: None)
r = _run("grep", f'{{"pattern": "needle", "path": "{repo}"}}')
assert r["exit_code"] == 0
assert "a.py:2:" in r["output"]
assert "node_modules" not in r["output"]
assert ".git/config" not in r["output"]
@pytest.mark.skipif(shutil.which("rg") is None, reason="targets the ripgrep fast-path")
def test_grep_skips_case_variant_sensitive_files_rg(repo):
"""The rg fast-path must exclude deny-listed key files case-insensitively.
A file whose name is a case variant of a sensitive pattern (e.g. ID_RSA vs
id_rsa, Known_Hosts vs known_hosts) points at the same secret on a
case-insensitive filesystem, so grep must not return its contents. The
Python fallback already folds case via _is_sensitive_path; a plain --glob
exclusion is case-sensitive, so it would leak these — this pins the rg path.
"""
token = "GREPSECRET_TOKEN_ZZZ"
with open(os.path.join(repo, "notes.txt"), "w") as f:
f.write(f"see {token}\n")
with open(os.path.join(repo, "ID_RSA"), "w") as f:
f.write(f"PRIVATE {token}\n")
with open(os.path.join(repo, "Known_Hosts"), "w") as f:
f.write(f"host {token}\n")
r = _run("grep", f'{{"pattern": "{token}", "path": "{repo}"}}')
assert r["exit_code"] == 0
assert "notes.txt" in r["output"] # ordinary matches still returned
assert "ID_RSA" not in r["output"] # case-variant key excluded
assert "Known_Hosts" not in r["output"]
# ── glob ──────────────────────────────────────────────────────────────────
def test_glob_py(repo):
r = _run("glob", f'{{"pattern": "*.py", "path": "{repo}"}}')
assert r["exit_code"] == 0
assert "a.py" in r["output"]
def test_glob_recursive_skips_junk(repo):
r = _run("glob", f'{{"pattern": "**/*.py", "path": "{repo}"}}')
assert "a.py" in r["output"]
assert "node_modules" not in r["output"]
def test_glob_requires_pattern(repo):
r = _run("glob", "{}")
assert r["exit_code"] == 1
def test_glob_literal_in_subdir(repo):
"""Bare literal should match at any depth (like rglob), not only at root."""
r = _run("glob", f'{{"pattern": "b.txt", "path": "{repo}"}}')
assert r["exit_code"] == 0
assert "b.txt" in r["output"]
def test_glob_multi_segment_single_star(repo):
"""sub/*.txt matches sub/b.txt but NOT sub/deep/c.py (single * stays in one segment)."""
r = _run("glob", f'{{"pattern": "sub/*.txt", "path": "{repo}"}}')
assert r["exit_code"] == 0
assert "b.txt" in r["output"]
assert "c.py" not in r["output"]
def test_glob_star_does_not_cross_slash(repo):
"""src/*.py must NOT match src/a/b/x.py — * is single-segment only."""
r = _run("glob", f'{{"pattern": "sub/*.py", "path": "{repo}"}}')
assert r["exit_code"] == 0
# sub/ has no .py directly, only sub/deep/c.py — should NOT match
assert "No files matching" in r["output"]
def test_glob_double_star_matches_deep(repo):
"""**/*.py should match files at any depth."""
r = _run("glob", f'{{"pattern": "**/*.py", "path": "{repo}"}}')
assert r["exit_code"] == 0
assert "a.py" in r["output"]
assert "c.py" in r["output"]
# ── ls ────────────────────────────────────────────────────────────────────
def test_ls_lists_entries(repo):
r = _run("ls", f'{{"path": "{repo}"}}')
assert r["exit_code"] == 0
assert "a.py" in r["output"]
assert "sub/" in r["output"]
assert ".git" not in r["output"] # hidden skipped
def test_ls_path_outside_rejected(repo):
r = _run("ls", '{"path": "/etc"}')
assert r["exit_code"] == 1
assert "outside the allowed roots" in r["error"]
# ── read_file line range ───────────────────────────────────────────────────
def test_read_file_offset_limit(repo):
p = os.path.join(repo, "lines.txt")
with open(p, "w") as f:
f.write("\n".join(f"line{i}" for i in range(1, 11)) + "\n")
r = _run("read_file", f'{{"path": "{p}", "offset": 3, "limit": 2}}')
assert r["exit_code"] == 0
assert r["output"] == "line3\nline4\n"
def test_read_file_plain_path_backcompat(repo):
r = _run("read_file", os.path.join(repo, "a.py"))
assert r["exit_code"] == 0
assert "needle" in r["output"]