Files
hermes-agent/hermes_cli/install_identity.py
ethernet b4a294fff9 Merge origin/main; keep PM as plugin dependency owner
Reconcile plugin declarations and validation through PM's atomic generation publication; preserve external runtimes, target markers, and conflict refusal. Keep one source-update completion owner and port upstream lifecycle changes to the PM desktop/runtime paths.
2026-09-17 13:52:05 -04:00

111 lines
4.0 KiB
Python

"""Stable opaque identity shared by every profile in one Hermes install."""
from __future__ import annotations
import contextlib
import os
from pathlib import Path
import re
import threading
from typing import Optional
import uuid
from hermes_constants import get_default_hermes_root
from utils import atomic_write_text
_INSTALL_ID_FILENAME = "install_id"
_INSTALL_ID_RE = re.compile(r"^[0-9a-f]{32}$")
_INSTALL_ID_CACHE: dict[str, Optional[str]] = {"root": None, "value": None}
_INSTALL_ID_LOCK, _INSTALL_ID_PUBLICATION_LOCK = threading.Lock(), threading.Lock()
@contextlib.contextmanager
def _install_id_file_lock(root: Path):
"""Serialize identity publication across processes on POSIX and Windows."""
fd = os.open(root / ".install_id.lock", os.O_RDWR | os.O_CREAT, 0o600)
windows = os.name == "nt"
try:
if windows:
import msvcrt
if os.fstat(fd).st_size == 0:
os.write(fd, b"\0")
os.fsync(fd)
os.lseek(fd, 0, os.SEEK_SET)
msvcrt.locking(fd, msvcrt.LK_LOCK, 1)
else:
import fcntl
fcntl.flock(fd, fcntl.LOCK_EX)
yield
finally:
try:
if windows:
os.lseek(fd, 0, os.SEEK_SET)
msvcrt.locking(fd, msvcrt.LK_UNLCK, 1)
else:
fcntl.flock(fd, fcntl.LOCK_UN)
finally:
os.close(fd)
def _read_existing(path: Path) -> tuple[Optional[str], bool]:
"""``(valid id or None, mint?)`` — mint on a missing or malformed file, never on a read failure."""
try:
existing = path.read_text(encoding="utf-8-sig").strip().lower()
except FileNotFoundError:
return None, True
except (OSError, UnicodeDecodeError):
return None, False
return (existing, False) if _INSTALL_ID_RE.fullmatch(existing) else (None, True)
def read_or_create_install_id(root: Path | None = None) -> Optional[str]:
"""Read or atomically mint the opaque id for the physical install.
``None`` = neither readable nor persistable; an ephemeral id would violate the authority/registry contract.
"""
root = get_default_hermes_root() if root is None else root
path = root / _INSTALL_ID_FILENAME
# A reader can collide with the first atomic replace on Windows. Serialize
# threads before reading, and recheck an unavailable file under the OS lock.
with _INSTALL_ID_PUBLICATION_LOCK:
existing, _ = _read_existing(path)
if existing is not None:
return existing # Existing identities remain readable on read-only roots.
try:
from hermes_constants import mkdir_under_hermes_home
mkdir_under_hermes_home(root)
with _install_id_file_lock(root):
existing, mint = _read_existing(path)
if not mint:
return existing
atomic_write_text(path, uuid.uuid4().hex + "\n", tmp_prefix=".install_id-", fsync_dir=True, mode=0o600)
committed = path.read_text(encoding="utf-8-sig").strip().lower()
return committed if _INSTALL_ID_RE.fullmatch(committed) else None
except OSError:
return None
def get_install_id(*, cache: dict[str, Optional[str]] | None = None) -> Optional[str]:
"""Return the process-cached stable id for the active Hermes root."""
root = get_default_hermes_root()
root_key = str(root)
target_cache = _INSTALL_ID_CACHE if cache is None else cache
def _cached() -> Optional[str]:
cached = target_cache.get("value")
return cached if cached and target_cache.get("root") in (None, root_key) else None
if value := _cached():
return value
with _INSTALL_ID_LOCK:
if value := _cached():
return value
value = read_or_create_install_id(root)
if value:
target_cache["root"] = root_key
target_cache["value"] = value
return value
__all__ = ["get_install_id", "read_or_create_install_id"]