mirror of
https://github.com/kuhyx/utils.git
synced 2026-11-22 13:32:28 +01:00
The three Python packages pinned ruff twice at different versions: requirements.txt at 0.16.7, .pre-commit-config.yaml at v0.15.2. Only the older one ever ran, so `select = ["ALL"]` was enforced two minor versions behind. Measured before aligning: v0.15.2 reports 0 findings, every 0.16.x reports CPY001 on each file -- 70 crdt-sync, 23 freedays, 71 gatelock, and no other rule. Resolved by adding the notice rather than ignoring the rule, so the gate keeps its teeth. Two gatelock modules sat at exactly the 250-line cap, so a one-line header tipped them to 251. Both are split along a real seam rather than shaved: _widget_fills.py colour arithmetic over LockConfig, no tkinter import _surfaces_focus.py selects among existing surfaces, never mutates them The focus split keeps _surfaces.py's documented containment (it stays the only module that creates, moves or destroys windows), and the static guard in test_recovery_invariants.py globs _surfaces*.py, so the new sibling is covered with no list to extend. widgets.py re-exports the fills helpers, which keeps gatelock.widgets the single public surface its tests import. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019kMvSMtsVMB3d2uoZ56pbp
92 lines
3.0 KiB
Python
92 lines
3.0 KiB
Python
# Copyright (c) 2026 Krzysztof Rudnicki
|
|
"""Signing the audit trail, using nothing but the standard library.
|
|
|
|
This deliberately does not call ``gatelock.log_integrity``, even though the
|
|
scheme below is byte-for-byte the same one and was lifted from it. Importing
|
|
``gatelock`` executes ``gatelock/__init__``, which imports ``tkinter`` for the
|
|
lock-window machinery -- so a headless policy library would have acquired a
|
|
hard dependency on a GUI toolkit, and ``import freedays`` would fail on any
|
|
machine without Tk. A sandbox run caught exactly that:
|
|
|
|
ImportError: libtk8.6.so: cannot open shared object file
|
|
|
|
The signature format is unchanged (HMAC-SHA256 over compact, sorted-key
|
|
JSON), so trail entries written before this module existed still verify
|
|
against the same key file.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import hashlib
|
|
import hmac
|
|
import json
|
|
import logging
|
|
import secrets
|
|
from typing import TYPE_CHECKING, Any
|
|
|
|
if TYPE_CHECKING:
|
|
from pathlib import Path
|
|
|
|
_logger = logging.getLogger(__name__)
|
|
|
|
_KEY_BYTES = 32
|
|
|
|
|
|
def load_key(key_file: Path) -> bytes | None:
|
|
"""Return the key bytes at ``key_file``, or None if unreadable."""
|
|
try:
|
|
return key_file.read_bytes().strip()
|
|
except OSError:
|
|
_logger.warning("cannot read the free-day signing key from %s", key_file)
|
|
return None
|
|
|
|
|
|
def generate_key(key_file: Path) -> bytes | None:
|
|
"""Create a key at ``key_file`` with owner-only permissions.
|
|
|
|
Returns:
|
|
The new key bytes, or None if it could not be written.
|
|
"""
|
|
key = secrets.token_bytes(_KEY_BYTES)
|
|
try:
|
|
key_file.parent.mkdir(parents=True, exist_ok=True)
|
|
key_file.write_bytes(key)
|
|
key_file.chmod(0o600)
|
|
except OSError:
|
|
_logger.warning("cannot write the free-day signing key to %s", key_file)
|
|
return None
|
|
return key
|
|
|
|
|
|
def _payload(entry: dict[str, Any]) -> bytes:
|
|
return json.dumps(entry, sort_keys=True, separators=(",", ":")).encode()
|
|
|
|
|
|
def sign(entry: dict[str, Any], *, key_file: Path) -> str | None:
|
|
"""Return the hex HMAC of ``entry``, or None when the key is unavailable.
|
|
|
|
``entry`` must not already contain a ``hmac`` field.
|
|
"""
|
|
key = load_key(key_file)
|
|
if key is None:
|
|
return None
|
|
return hmac.new(key, _payload(entry), hashlib.sha256).hexdigest()
|
|
|
|
|
|
def verify(entry: dict[str, Any], *, key_file: Path) -> bool:
|
|
"""Whether ``entry``'s stored ``hmac`` matches its contents.
|
|
|
|
False when the field is missing or not a string, and when the key cannot
|
|
be read -- "cannot check" and "does not match" are the same answer to the
|
|
only question a caller asks, which is whether to trust the line.
|
|
"""
|
|
stored = entry.get("hmac")
|
|
if not isinstance(stored, str):
|
|
return False
|
|
key = load_key(key_file)
|
|
if key is None:
|
|
return False
|
|
without = {name: value for name, value in entry.items() if name != "hmac"}
|
|
expected = hmac.new(key, _payload(without), hashlib.sha256).hexdigest()
|
|
return hmac.compare_digest(stored, expected)
|