bambuddy/backend/tests/unit/test_safe_path.py
maziggy 396e9aa09e security: harden path-traversal class across routes + services; fifth CI backstop
Two attacker-controlled strings were being joined to library_dir with no
  resolve + containment check in the project ZIP import endpoint:

    - linked_folders[*].name from the request's project.json
    - per-entry zf.namelist() paths from the ZIP itself

  An absolute path in either field collapsed the join (Path("/lib") / "/etc"
  becomes Path("/etc") because pathlib discards the left side when the right
  is absolute) and the next write_bytes landed wherever the attacker chose.

  Adjacent finding from the routes audit: GET /archives/{id}/photos/{filename}
  had NO validation on filename and FileResponse-served arbitrary paths -
  the DELETE counterpart at least gated on the photos membership check.

  Adjacent finding from the services audit: ArchiveService.attach_timelapse
  wrote archive_dir / filename where filename ultimately came from a printer's
  FTP listing (compromised-printer threat model) or the /timelapse/select
  query param. A malicious printer that exposes a directory entry with ..
  segments could write the timelapse outside the archive directory.

  New backend/app/utils/safe_path.py::safe_join_under(parent, *parts) is the
  single source of truth: rejects empty / null-byte / absolute parts up-front,
  joins under parent, resolves both sides, asserts is_relative_to. Returns the
  resolved canonical path on success, raises HTTPException(400) on escape, or
  PathTraversalError when http=False (for service-layer callers that need to
  match a non-HTTP return contract).

  Wired into the import vectors, both archive photo handlers, and the
  attach_timelapse service. The full audit sweep inspected every Path/Name
  join in backend/app/api/routes/ AND backend/app/services/ - 25 route-layer
  sites + 8 service-layer sites confirmed safe and tagged with
  # SEC-PATH-OK: <reason> so future audits trust the inline guard at a glance.

  Fifth CI backstop test_route_path_arithmetic_is_safe_joined_or_marked
  AST-walks both layers and fails the build on any <dir-like>/<bare variable>
  join that doesn't either route through safe_join_under or carry the marker.
  The services layer is in scope because it receives values verbatim from the
  routes AND from external sources Bambuddy has no control over (the printer
  FTP-listing case above).

  SECURITY.md gets a fifth rule + a fifth row in the CI test mapping table;
  the rule now names the printer FTP-listing case explicitly so future
  services-layer audits set the right expectation.

--------------

  fix(library): suppress warning storm when bulk-uploading ZIPs of empty/stub STL files

  Uploading a ZIP of stub or empty STL files (e.g. the 24-byte
  "solid test\nendsolid test" shape) produced one WARNING per file in
  stl_thumbnail.py::generate_stl_thumbnail. The warnings were technically
  correct - trimesh returns a valid Mesh with zero vertices, the safeguard
  matches, and the function returns None so the library entry is still
  created without a thumbnail - but the volume turned a successful upload
  into thousands of WARNING lines in the journal.

  Two changes:

  1. The per-file "Failed to load STL or empty mesh" message in
     stl_thumbnail.py is now logger.debug instead of logger.warning. It's
     a per-file content observation, not an actionable error; the caller
     already handles None correctly. The branch now catches the rare
     "large enough but trimesh still can't parse it" case, visible in
     debug logs without spamming production.

  2. New module constant MIN_USABLE_STL_BYTES = 200 (smallest binary STL
     with one triangle is 134B, smallest ASCII ~150B; 200 is a safe floor
     below any real STL). The three thumbnail call sites in library.py
     (extract_zip_file, single-file upload, _backfill_external_stl_thumbnails)
     pre-skip files below this size before calling generate_stl_thumbnail.
     Stubs never enter the trimesh pipeline at all.

  Behavior is unchanged for real STLs: any file >=200 bytes runs through
  the existing pipeline, MAX_VERTICES still triggers simplification at
  100k vertices for the 256x256 thumbnail render, large files still get
  thumbnails.

------------

  fix(stl-thumbnail): silence matplotlib first-import noise (writable cache + font_manager log level)

  On first STL upload, three matplotlib-internal log lines surfaced:

    WARNING [matplotlib] /opt/claude/.config/matplotlib is not a writable directory
    INFO    [matplotlib.font_manager] Failed to extract font properties from NotoColorEmoji.ttf
    INFO    [matplotlib.font_manager] generated new fontManager

  The writable-dir warning fired because Bambuddy's $HOME isn't writable for
  matplotlib's default config path; matplotlib fell back to /tmp/matplotlib-XXX
  which lost the font cache on every host reboot, so font_manager rebuilt it
  each cold start - producing another batch of INFO lines.

  Fix is two small additions in stl_thumbnail.py before the matplotlib import:

  1. New _configure_matplotlib_cache() sets MPLCONFIGDIR to
     settings.base_dir/.cache/matplotlib (mkdir if missing) so the cache
     persists across container restarts and the writable-dir warning never
     fires. Respects an externally-set MPLCONFIGDIR so operators who chose
     their own path aren't overridden. Best-effort with a debug fallback if
     settings can't be imported or the mkdir fails.

  2. logging.getLogger("matplotlib.font_manager").setLevel(WARNING) at module
     import demotes the per-font INFO scan that fires when font_manager
     builds its cache cold. Real font warnings (>= WARNING) still surface.

  3 new tests: font_manager logger at WARNING after module import;
  _configure_matplotlib_cache creates the directory under base_dir and sets
  MPLCONFIGDIR; an externally-set MPLCONFIGDIR is preserved verbatim.
  5516 backend tests green, frontend gates clean.
2026-06-02 12:12:54 +02:00

124 lines
4.8 KiB
Python

"""Tests for ``backend.app.utils.safe_path.safe_join_under``.
Cover every escape vector documented in the helper plus the legitimate
nested-path use case so the helper's behaviour is locked in.
"""
from __future__ import annotations
from pathlib import Path
import pytest
from fastapi import HTTPException
from backend.app.utils.safe_path import (
PathTraversalError,
assert_under,
safe_join_under,
)
@pytest.fixture()
def library(tmp_path: Path) -> Path:
"""A real on-disk directory that mimics the "trusted parent" role."""
lib = tmp_path / "library"
lib.mkdir()
return lib
class TestSafeJoinUnder:
def test_simple_filename_is_joined(self, library: Path):
result = safe_join_under(library, "model.3mf")
assert result == (library / "model.3mf").resolve()
def test_nested_path_components_are_joined(self, library: Path):
result = safe_join_under(library, "myfolder", "sub", "file.3mf")
assert result == (library / "myfolder" / "sub" / "file.3mf").resolve()
def test_absolute_path_rejected(self, library: Path):
# The exact shape that produced the original CVE — ``Path("/lib") / "/etc/passwd"``
# collapses to ``Path("/etc/passwd")`` in Python's pathlib.
with pytest.raises(HTTPException) as exc:
safe_join_under(library, "/etc/passwd")
assert exc.value.status_code == 400
def test_absolute_windows_path_rejected(self, library: Path):
with pytest.raises(HTTPException):
safe_join_under(library, "\\\\evil\\share\\x")
def test_parent_traversal_rejected(self, library: Path):
with pytest.raises(HTTPException):
safe_join_under(library, "..", "etc", "passwd")
def test_embedded_parent_traversal_rejected(self, library: Path):
# ``library/foo/../../etc/passwd`` resolves outside ``library``.
with pytest.raises(HTTPException):
safe_join_under(library, "foo", "..", "..", "etc", "passwd")
def test_null_byte_rejected(self, library: Path):
with pytest.raises(HTTPException):
safe_join_under(library, "evil\x00.3mf")
def test_empty_string_part_rejected(self, library: Path):
with pytest.raises(HTTPException):
safe_join_under(library, "")
def test_no_parts_rejected(self, library: Path):
with pytest.raises(HTTPException):
safe_join_under(library)
def test_non_string_part_rejected(self, library: Path):
with pytest.raises(HTTPException):
safe_join_under(library, 42) # type: ignore[arg-type]
def test_http_false_raises_path_traversal_error(self, library: Path):
with pytest.raises(PathTraversalError):
safe_join_under(library, "/etc/passwd", http=False)
def test_http_false_allows_clean_join(self, library: Path):
result = safe_join_under(library, "ok.txt", http=False)
assert result == (library / "ok.txt").resolve()
def test_returned_path_is_resolved(self, library: Path):
# The helper returns a resolved path so callers don't need to do it
# themselves — every downstream is_relative_to/parent check assumes
# a canonical form.
result = safe_join_under(library, "x.txt")
assert result == result.resolve()
class TestAssertUnder:
def test_inside_passes(self, library: Path):
candidate = library / "x" / "y" / "z.txt"
out = assert_under(library, candidate)
assert out == candidate.resolve()
def test_outside_rejects(self, library: Path, tmp_path: Path):
outside = tmp_path / "elsewhere" / "evil.txt"
with pytest.raises(HTTPException):
assert_under(library, outside)
def test_outside_raises_path_traversal_error_with_http_false(self, library: Path, tmp_path: Path):
outside = tmp_path / "elsewhere" / "evil.txt"
with pytest.raises(PathTraversalError):
assert_under(library, outside, http=False)
class TestPocReproducer:
"""The exact attacker payload from the advisory.
A directly attacker-controlled folder name pointing at a venv's
site-packages directory used to land a ``.pth`` file on disk. With the
helper in place the join now raises before any write.
"""
def test_advisory_poc_target_dir_rejected(self, library: Path):
# Verbatim shape from the advisory POC.
target_dir = "BAMBUDDY_BASE_DIR/bambuddy/venv/lib/python3.14/site-packages"
# Leading slash → absolute → rejected up-front.
with pytest.raises(HTTPException):
safe_join_under(library, "/" + target_dir)
# No leading slash but with ``..`` traversal embedded in the
# follow-up file path — also rejected.
with pytest.raises(HTTPException):
safe_join_under(library, "innocent", "..", "..", "evil.pth")