| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667 |
- """Symlink-safe creation helpers for spill/cache files under ``~/.hermes``, where a plain
- ``open(path, "w")`` would follow a pre-planted symlink onto ``~/.bashrc`` etc. New files use
- ``O_CREAT | O_EXCL`` (fails on ANY existing path, even a dangling link); overwrites ``lstat`` +
- ``unlink`` first (removes the link, never its target) then create exclusively, so the pair
- can't be raced. ``private=True`` (default) = ``0o700`` dirs / ``0o600`` files for spills that
- may hold pre-redaction secrets; ``private=False`` keeps umask perms for cache dirs bind-mounted
- into remote backends (``credential_files._CACHE_DIRS``). Disk failures raise ``OSError``."""
- from __future__ import annotations
- import os
- import stat
- from pathlib import Path
- from typing import IO
- from hermes_dir_acl import make_user_dir
- __all__ = ["ensure_spill_dir", "open_exclusive", "write_text_exclusive"]
- # O_NOFOLLOW is POSIX-only; on Windows O_EXCL alone already refuses every pre-existing path.
- _O_NOFOLLOW = getattr(os, "O_NOFOLLOW", 0)
- def ensure_spill_dir(path: Path, *, private: bool = True) -> Path:
- """Create ``path`` (and parents) as a directory, refusing symlinks. ``private=True``
- creates the leaf ``0o700`` and tightens an existing leaf. Raises ``OSError`` if the leaf
- is not a real directory."""
- path = Path(path)
- make_user_dir(path, mode=0o700 if private else 0o777, parents=True, exist_ok=True)
- st = os.lstat(path)
- if not stat.S_ISDIR(st.st_mode):
- raise OSError(f"spill dir is not a directory (symlink?): {path}")
- if private and stat.S_IMODE(st.st_mode) != 0o700:
- os.chmod(path, 0o700)
- return path
- def open_exclusive(path: Path, *, private: bool = True, overwrite: bool = False,
- encoding: str = "utf-8", errors: str = "strict") -> IO[str]:
- """Open ``path`` for writing via exclusive create; never follows a link. ``overwrite=True``
- first unlinks an existing path (``lstat``-checked, so only the link itself is removed and
- directories are refused), then creates exclusively — the overwrite path cannot be
- redirected through a symlink either."""
- path = Path(path)
- if overwrite:
- try:
- st = os.lstat(path)
- except FileNotFoundError:
- pass
- else:
- if stat.S_ISDIR(st.st_mode):
- raise OSError(f"refusing to overwrite a directory: {path}")
- os.unlink(path)
- mode = 0o600 if private else 0o666 # non-private honors umask
- fd = os.open(path, os.O_WRONLY | os.O_CREAT | os.O_EXCL | _O_NOFOLLOW, mode)
- try:
- return os.fdopen(fd, "w", encoding=encoding, errors=errors)
- except Exception:
- os.close(fd)
- raise
- def write_text_exclusive(path: Path, text: str, *, private: bool = True, overwrite: bool = False,
- encoding: str = "utf-8", errors: str = "strict") -> None:
- """``Path.write_text`` equivalent that refuses to follow symlinks."""
- with open_exclusive(path, private=private, overwrite=overwrite, encoding=encoding,
- errors=errors) as fh:
- fh.write(text)
|