Files
stackpilot/backend/routers/files.py
T
menzeljandClaude Opus 5.5 d6cebb3371
CI / check (push) Successful in 4m9s
CI / build-and-push (push) Failing after 16m10s
Fix what a review of the whole app found, end to end (0.67.1)
A pass over every feature against a real Docker daemon, then clicking
through the UI as admin and read-only user, on a desktop and a phone.

Security. /ws/deploy ran compose up for the read-only role; it is
admin-only now. A container's inspect view, a stack's compose file
(POSTGRES_PASSWORD: hunter2) and the viewer's .env tab no longer show
credentials to that role. Git branch and URL values that git would read
as options (-x, ext::) are refused. SFTP host keys are checked: pinned
on first use or entered by hand (key line or SHA256 fingerprint), a
different key is refused before the password is sent. A backup name
from the API can no longer reach outside the destination folder. The
file browser refuses to move or rename a browse root, as delete did.

Docker lifecycle. Closing the deploy console released the stack lock
while compose was still running and logged rc=None as success; deploys
and updates are now background runs that hold the lock to the end,
report the real exit code and can be re-attached to. Every closed log
view left a `compose logs -f` behind. A dozen open tabs exhausted the
default thread pool and hung the API; event and exec streams have their
own threads. Auto-update and the update endpoint ignored failed pulls.
A deleted git stack was recreated and started by the next webhook or
poll; deleting a stack now drops its git source, auto-update policy and
schedule entries. Deleting no longer walks into mounted shares, is
refused while a backup runs, and removes the containers even when the
compose file is broken. Stack folders compose has to normalise
(Nextcloud -> nextcloud) work everywhere and group correctly on the
volumes, networks and images pages.

Detection. Host port conflicts read the container's own network
namespace; /proc/1/net is read instead. Images referenced as docker.io/…
were never update-checked; local builds no longer report "needs
credentials". NVIDIA GPUs are read from the driver's procfs. The backup
dialog's "path mismatch" warning came from mountinfo's filesystem-relative
root and fired for any stacks folder on its own disk, ZFS dataset or
btrfs subvolume; the host path now comes from Docker's mounts.

Backups and destinations. The download ignored the folder/volume
selection (axios sent binds[]). Restoring under a new name kept the old
one. A report header past nginx's buffer turned a good backup into a
502. SFTP/S3 errors were bare 500s and "Test" did not try to write.
A destination used by a schedule could be deleted. Backup file names
are in the schedule's or the browser's time zone instead of UTC.

Editor and converter. `docker run` conversion produced invalid compose
for --network host, named volumes and -dit; --gpus and --mount were
dropped; a multi-line command pasted into the one-line field became
`image: ' '` (now a textarea, and flattened continuations are read).
Validation failed for env_file stacks. The editor overwrote unsaved
edits on every container event, lost them on a stray click (now asks),
threw when closing the diff, and its helper panel listed the starter
service "app" for every existing stack. Monaco is bundled instead of
loaded from jsdelivr, so the editor works offline (and monaco-editor
0.57 drops the dompurify advisory; axios and react-router updated).

UI. All times were two hours off: offset-less UTC from SQLite was read
as local time, and "next run" always said "just now". A token refresh
mid-session duplicated deploys, reset terminals and doubled logs. A
backend restart (update, self-update) signed everyone out on reload; the
page now waits for it. The editor was unusable on a phone, tables and
tabs overflowed, dialog text was black on the dark theme, and the file
browser opened on an error with the default roots. Read-only users get
"Admin only" pages instead of 403s; in-use networks offer no delete;
"Scan all" covers StackPilot's own stacks only and runs in the
background instead of timing out at 600s.

Deployment. nginx passes the port in Host (the OIDC redirect URI lost
:5009) and keeps an outer proxy's X-Forwarded-Proto. The frontend waits
for a healthy backend (healthcheck probes every 2s while starting). The
frontend image builds with npm ci. Secrets are 0644 in a 0700 folder so
non-root containers can read them; existing files are fixed at startup.
The test suite no longer starts real containers on a host with Docker.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Fx7gcuy8d6nPd95g43rGHu
2026-10-15 13:51:26 +02:00

296 lines
8.7 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
"""Full host filesystem browser: list, read, edit, manage, up/download.
Every operation requires admin. Reads are not less dangerous than writes here:
the browser reaches whatever the backend container can see, which includes
every stack's ``.env`` and ``.secrets/*``. Reading a file and downloading one
are audit-logged just like the mutating operations; directory listing is not,
because the Files page polls it and would drown the log.
All paths are sandboxed by :mod:`services.file_service`.
"""
from __future__ import annotations
import os
import stat
import tempfile
from urllib.parse import quote
from fastapi import (
APIRouter,
Depends,
File,
Form,
HTTPException,
Query,
Request,
UploadFile,
)
from fastapi.responses import FileResponse, StreamingResponse
from pydantic import BaseModel
from sqlmodel import Session
from auth import require_admin
from database import get_session
from models.user import User
from services import audit_service, device_service, file_service
router = APIRouter(prefix="/api/files", tags=["files"])
def _attachment(filename: str) -> str:
"""A safe ``Content-Disposition`` value for an arbitrary filename.
Headers are latin-1; a folder called "Fotos – 2024" (en dash) raised
UnicodeEncodeError and the download died with a 500. Non-ASCII names go
out as RFC 5987 ``filename*``, with an ASCII fallback beside it.
"""
safe = filename.replace("\\", "_").replace('"', "_")
try:
safe.encode("ascii")
return f'attachment; filename="{safe}"'
except UnicodeEncodeError:
fallback = safe.encode("ascii", "replace").decode("ascii").replace("?", "_")
return f"attachment; filename=\"{fallback}\"; filename*=UTF-8''{quote(filename)}"
def _ip(request: Request) -> str:
return request.client.host if request.client else "unknown"
def _guard(fn, *args, **kwargs):
try:
return fn(*args, **kwargs)
except file_service.BrowseError as exc:
raise HTTPException(status_code=400, detail=str(exc)) from exc
# --------------------------------------------------------------------------- #
# Read-only
# --------------------------------------------------------------------------- #
@router.get("/list")
def list_dir(
path: str = Query("/"),
show_hidden: bool = Query(False),
_admin: User = Depends(require_admin),
) -> dict:
return _guard(device_service.browse, path, show_hidden)
@router.get("/read")
def read_file(
request: Request,
path: str = Query(...),
session: Session = Depends(get_session),
user: User = Depends(require_admin),
) -> dict:
result = _guard(file_service.read_file, path)
audit_service.record(
session, user=user.username, action="file.read", target=path, ip=_ip(request)
)
return result
@router.get("/download")
def download(
request: Request,
path: str = Query(...),
session: Session = Depends(get_session),
user: User = Depends(require_admin),
):
audit_service.record(
session, user=user.username, action="file.download", target=path, ip=_ip(request)
)
if _guard(file_service.is_dir, path):
filename, chunks = _guard(file_service.open_archive, path)
# Stream the zip as it's built so the response starts immediately
# (large folders no longer hit the proxy's read timeout).
return StreamingResponse(
chunks, media_type="application/zip",
headers={"Content-Disposition": _attachment(filename)},
)
real, filename = _guard(file_service.resolve_download, path)
return FileResponse(real, filename=filename, media_type="application/octet-stream")
# --------------------------------------------------------------------------- #
# Mutating (admin only)
# --------------------------------------------------------------------------- #
class WriteBody(BaseModel):
path: str
content: str
class NameBody(BaseModel):
path: str
name: str
class RenameBody(BaseModel):
path: str
new_name: str
class TransferBody(BaseModel):
src: str
dest_dir: str
overwrite: bool = False
@router.put("/write")
def write_file(
body: WriteBody,
request: Request,
session: Session = Depends(get_session),
user: User = Depends(require_admin),
) -> dict:
result = _guard(file_service.write_file, body.path, body.content)
audit_service.record(
session, user=user.username, action="file.write", target=body.path, ip=_ip(request)
)
return result
@router.post("/mkdir")
def mkdir(
body: NameBody,
request: Request,
session: Session = Depends(get_session),
user: User = Depends(require_admin),
) -> dict:
result = _guard(file_service.create_dir, body.path, body.name)
audit_service.record(
session, user=user.username, action="file.mkdir", target=result["path"], ip=_ip(request)
)
return result
@router.post("/touch")
def touch(
body: NameBody,
request: Request,
session: Session = Depends(get_session),
user: User = Depends(require_admin),
) -> dict:
result = _guard(file_service.create_file, body.path, body.name)
audit_service.record(
session, user=user.username, action="file.create", target=result["path"], ip=_ip(request)
)
return result
@router.post("/rename")
def rename(
body: RenameBody,
request: Request,
session: Session = Depends(get_session),
user: User = Depends(require_admin),
) -> dict:
result = _guard(file_service.rename, body.path, body.new_name)
audit_service.record(
session, user=user.username, action="file.rename",
target=body.path, detail=f"-> {result['path']}", ip=_ip(request),
)
return result
@router.post("/copy")
def copy(
body: TransferBody,
request: Request,
session: Session = Depends(get_session),
user: User = Depends(require_admin),
) -> dict:
result = _guard(file_service.copy, body.src, body.dest_dir, body.overwrite)
audit_service.record(
session, user=user.username, action="file.copy",
target=body.src, detail=f"-> {result['path']}", ip=_ip(request),
)
return result
@router.post("/move")
def move(
body: TransferBody,
request: Request,
session: Session = Depends(get_session),
user: User = Depends(require_admin),
) -> dict:
result = _guard(file_service.move, body.src, body.dest_dir, body.overwrite)
audit_service.record(
session, user=user.username, action="file.move",
target=body.src, detail=f"-> {result['path']}", ip=_ip(request),
)
return result
@router.delete("")
def delete(
request: Request,
path: str = Query(...),
recursive: bool = Query(False),
session: Session = Depends(get_session),
user: User = Depends(require_admin),
) -> dict:
result = _guard(file_service.delete, path, recursive)
audit_service.record(
session, user=user.username, action="file.delete", target=path,
detail="recursive" if recursive else None, ip=_ip(request),
)
return result
def _settle_mode(tmp: str, target: str) -> None:
"""Give an upload the permissions a normal file there would have.
A temp file is created 0600, and ``os.replace`` kept that — so a config
uploaded into a stack folder was unreadable for any container not running
as root. An overwritten file keeps its mode and owner; a new one gets the
usual 0644 (minus umask).
"""
try:
st = os.stat(target)
os.chmod(tmp, stat.S_IMODE(st.st_mode))
try:
os.chown(tmp, st.st_uid, st.st_gid)
except OSError:
pass
except FileNotFoundError:
umask = os.umask(0)
os.umask(umask)
os.chmod(tmp, 0o666 & ~umask)
@router.post("/upload")
async def upload(
request: Request,
path: str = Form(...),
overwrite: bool = Form(False),
rel_path: str = Form(""),
file: UploadFile = File(...),
session: Session = Depends(get_session),
user: User = Depends(require_admin),
) -> dict:
real = _guard(
file_service.upload_target, path, file.filename or "", overwrite, rel_path or None
)
# Stream to a temp file first, then move into place atomically.
tmp = tempfile.NamedTemporaryFile(delete=False, dir=os.path.dirname(real))
try:
while chunk := await file.read(1024 * 1024):
tmp.write(chunk)
tmp.close()
_settle_mode(tmp.name, real)
os.replace(tmp.name, real)
except OSError as exc:
if os.path.exists(tmp.name):
os.unlink(tmp.name)
raise HTTPException(status_code=400, detail=f"Upload failed: {exc}") from exc
audit_service.record(
session, user=user.username, action="file.upload",
target=path, detail=rel_path or file.filename, ip=_ip(request),
)
return {"ok": True, "name": rel_path or file.filename}