feat(catalog-console): a keys status command, and complete rotation without a red main (#62, #68)
CI / Lint (ruff) (pull_request) Successful in 7s
CI / Tests (py3.10 / ubuntu-latest) (pull_request) Successful in 12s
CI / Tests (py3.12 / windows-latest) (pull_request) Successful in 25s
CI / Tests (py3.12 / ubuntu-latest) (pull_request) Successful in 11s
CI / Tests (py3.13 / ubuntu-latest) (pull_request) Successful in 11s
CI / Catalog signature (pull_request) Failing after 6s
CI / Lint (ruff) (pull_request) Successful in 7s
CI / Tests (py3.10 / ubuntu-latest) (pull_request) Successful in 12s
CI / Tests (py3.12 / windows-latest) (pull_request) Successful in 25s
CI / Tests (py3.12 / ubuntu-latest) (pull_request) Successful in 11s
CI / Tests (py3.13 / ubuntu-latest) (pull_request) Successful in 11s
CI / Catalog signature (pull_request) Failing after 6s
Two problems from issue #68's follow-up review: 1. The maintainer -- the only person who will ever use this tool -- cannot reliably tell which of the two signing keys is which or what state either is in. He already pasted a private key into a chat window because a prompt was ambiguous. That's a defect in this tool, not user error. 2. PR #71 rotates bcc_core.CATALOG_PUBKEYS, which makes data/catalog.json.sig (signed by the retired key) stop verifying and the CI catalog-signature job go red. The Console could previously only load/sign against `main`, so the only way through was to merge a red PR and fix main afterwards -- normalizing exactly the alarm fatigue this whole design exists to prevent. Task 1 -- `python catalog_console.py keys`: A plain-English-first status report for BOTH keys: purpose, where the private half lives, whether it exists locally, its fingerprint, whether that fingerprint matches every place its public half is expected to be committed (bcc_core.CATALOG_PUBKEYS, ci.yml's trust anchor, and scripts/sign_checksums.RELEASE_PUBKEYS -- checked independently, since issue #68 finding 4 was exactly bcc_core.py and ci.yml silently drifting apart), and whether data/catalog.json.sig currently verifies -- ending with the exact command to run next. Needs no passphrase and never touches private key bytes: a plaintext public-key cache (store_public_key/load_public_key) is written alongside the existing encrypted private blob at keygen time, precisely so this command can report a fingerprint without decrypting anything. The status/report logic (key_status, render_key_status_report, recommend_next_steps, fingerprint_pubkey, extract_pubkey_list_literal, extract_ci_trust_anchor_pubkey) is pure and lives in catalog_review.py; cmd_keys in catalog_console.py is a thin printer over it, per the project's existing pure-core/thin-GUI split. Task 2 -- rotation completable without a red main: ReviewWindow now offers a "current branch" source (auto-detected via `current_branch()`, or --ref to name one explicitly) alongside "main" and open PRs. Loading it runs the exact same diff-against-last-signed / rotation-detection logic "main" always used (_load_own_ref, extracted from the old hardcoded-to-main _on_load), just parameterized on the ref. Signing now pushes to session.loaded_ref, never a hardcoded "main" (commit_and_push_signed_catalog's branch param was already there -- only the call site was wrong). The ref-list computation itself is a pure function (compute_own_refs) so this seam is unit-testable without git or Qt. None of can_sign()'s guards (empty-diff, acknowledge-all, blocking-risk, TOCTOU) were touched. This lets a rotation branch be reviewed, re-attested (every entry, since the new key never vouched for any of them -- issue #68 finding 5 follow-up), signed, and pushed to ITS OWN branch before it's ever merged. Task 3 -- label the keys everywhere: PassphraseDialog now shows which key (CATALOG vs RELEASE) and its fingerprint before the passphrase field, both in its window title and its prompt text -- the exact ambiguity that led to a private key being pasted into a chat window. cmd_keygen's stored-key confirmation now reads "CATALOG private key encrypted..." / "RELEASE private key encrypted..." instead of a capitalized-lowercase kind. The reattest banner now says "CATALOG signing key" / "CATALOG key" throughout instead of "the key". PySide6's import is now guarded (try/except -> _PYSIDE6_AVAILABLE) and every GUI class definition that depends on it moved under `if _PYSIDE6_AVAILABLE:`. `keygen`, `show-seed-b64`, and the new `keys` command have no GUI dependency and now work (and are testable) in an environment without PySide6 -- which is exactly this repo's own `test` CI job (pytest + cryptography only, no PySide6). `gui` fails with a clear message instead of an ImportError stack trace if it's missing. Tests: 26 new pure-function tests in tests/test_catalog_review.py (fingerprint_pubkey, extract_pubkey_list_literal, extract_ci_trust_anchor_pubkey, key_status, recommend_next_steps, render_key_status_report) and a new tests/test_catalog_console_git.py (14 tests) covering compute_own_refs, current_branch, commit_and_push_signed_catalog's branch targeting, and catalog_sig_status_on_disk against real local git repos -- importing catalog_console.py directly, proving it works without PySide6. 400 passed, 1 skipped (pre-existing). ruff check / ruff format --check clean.
This commit is contained in:
@@ -90,6 +90,21 @@ key, because they protect different things and live in different places:
|
|||||||
| Generated with | `python catalog_console.py keygen` | `python catalog_console.py keygen --release` |
|
| Generated with | `python catalog_console.py keygen` | `python catalog_console.py keygen --release` |
|
||||||
| Exported for CI with | *(never — there is no supported way to export this key)* | `python catalog_console.py show-seed-b64 --release` |
|
| Exported for CI with | *(never — there is no supported way to export this key)* | `python catalog_console.py show-seed-b64 --release` |
|
||||||
|
|
||||||
|
**Confused about which key is which, or what state either is in?** Run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python catalog_console.py keys
|
||||||
|
```
|
||||||
|
|
||||||
|
It needs no passphrase (it never touches private key bytes) and prints a
|
||||||
|
plain-English report for both keys: where each private half lives, whether
|
||||||
|
it's present on this machine, its fingerprint, whether that fingerprint
|
||||||
|
matches what's actually committed in `bcc_core.py`, `ci.yml`'s trust
|
||||||
|
anchor, and `scripts/sign_checksums.py`, and whether
|
||||||
|
`data/catalog.json.sig` currently verifies — ending with the exact command
|
||||||
|
to run next for whatever state it finds. This is the check that would have
|
||||||
|
caught [issue #68](../../issues/68)'s finding 5 incident before it happened.
|
||||||
|
|
||||||
**Why two keys:** the catalog key is the root of trust for what BCC
|
**Why two keys:** the catalog key is the root of trust for what BCC
|
||||||
actually *executes* on a user's machine — every `command`/`args` pair in
|
actually *executes* on a user's machine — every `command`/`args` pair in
|
||||||
the shipped catalog is only there because this key signed it. If that key
|
the shipped catalog is only there because this key signed it. If that key
|
||||||
@@ -207,7 +222,7 @@ file is also listed, marked *legacy*, so you can copy them over.
|
|||||||
- `bcc.spec` — PyInstaller build spec (cross-platform).
|
- `bcc.spec` — PyInstaller build spec (cross-platform).
|
||||||
- `scripts/build_icons.py` — regenerates `icons/app.icns` and `icons/app.ico` from source PNGs.
|
- `scripts/build_icons.py` — regenerates `icons/app.icns` and `icons/app.ico` from source PNGs.
|
||||||
- `scripts/sign_checksums.py` — generates and Ed25519-signs the release `SHA256SUMS` manifest (see [Verifying your download](#verifying-your-download)).
|
- `scripts/sign_checksums.py` — generates and Ed25519-signs the release `SHA256SUMS` manifest (see [Verifying your download](#verifying-your-download)).
|
||||||
- `catalog_console.py` / `catalog_review.py` — **maintainer-only**, never shipped to users (excluded from `bcc.spec`; see `tests/test_catalog_console_packaging.py`). The Catalog Console: review + sign `data/catalog.json`, and generate/manage both signing keys (`keygen`, `keygen --release`) — see [Signing keys](#signing-keys).
|
- `catalog_console.py` / `catalog_review.py` — **maintainer-only**, never shipped to users (excluded from `bcc.spec`; see `tests/test_catalog_console_packaging.py`). The Catalog Console: review + sign `data/catalog.json` (against `main`, an open PR, or the branch you have checked out — `--ref <branch>` to be explicit, e.g. mid key-rotation, so a rotation can be signed and pushed to its own branch *before* it's merged, never forcing a red `main`), generate/manage both signing keys (`keygen`, `keygen --release`), and report on their status (`keys`, no passphrase needed) — see [Signing keys](#signing-keys).
|
||||||
|
|
||||||
## Building from source
|
## Building from source
|
||||||
|
|
||||||
|
|||||||
+449
-72
@@ -10,14 +10,20 @@ for data/catalog.json (issue #62).
|
|||||||
Flow: Load -> Review -> Sign.
|
Flow: Load -> Review -> Sign.
|
||||||
|
|
||||||
1. Load -- pick a source: an open Gitea PR touching data/catalog.json,
|
1. Load -- pick a source: an open Gitea PR touching data/catalog.json,
|
||||||
or the current tip of `main`. The Console fetches the exact
|
the current tip of `main`, or the branch this checkout is
|
||||||
git blob (via a local clone's git plumbing) and PINS its
|
currently ON (or --ref names) -- the latter exists so a
|
||||||
blob SHA *and the ref it came from* for the rest of this
|
catalog-signing-key rotation, or any other catalog change
|
||||||
review pass. For a PR, the diff is against `main`; for
|
landed on a branch, can be reviewed and SIGNED before that
|
||||||
`main`, the diff is against the last catalog a maintainer
|
branch is ever merged, instead of merging a PR that leaves
|
||||||
actually SIGNED (the bytes covered by the current
|
main red and fixing it up afterwards (issue #68). The
|
||||||
data/catalog.json.sig), never against itself -- an empty
|
Console fetches the exact git blob (via a local clone's git
|
||||||
diff must mean "nothing to sign", never "sign unlocked".
|
plumbing) and PINS its blob SHA *and the ref it came from*
|
||||||
|
for the rest of this review pass. For a PR, the diff is
|
||||||
|
against `main`; for `main` or a branch, the diff is against
|
||||||
|
the last catalog a maintainer actually SIGNED on that same
|
||||||
|
ref (the bytes covered by the current data/catalog.json.sig
|
||||||
|
there), never against itself -- an empty diff must mean
|
||||||
|
"nothing to sign", never "sign unlocked".
|
||||||
2. Review -- a semantic diff (catalog_review.diff_catalogs), one card per
|
2. Review -- a semantic diff (catalog_review.diff_catalogs), one card per
|
||||||
changed entry, with risk annotations
|
changed entry, with risk annotations
|
||||||
(catalog_review.entry_risk_findings). A registry lookup for
|
(catalog_review.entry_risk_findings). A registry lookup for
|
||||||
@@ -37,13 +43,23 @@ Flow: Load -> Review -> Sign.
|
|||||||
blocking risk finding (catalog_review.sign_precondition /
|
blocking risk finding (catalog_review.sign_precondition /
|
||||||
can_sign -- the TOCTOU fix). On success, writes
|
can_sign -- the TOCTOU fix). On success, writes
|
||||||
data/catalog.json + data/catalog.json.sig and commits BOTH
|
data/catalog.json + data/catalog.json.sig and commits BOTH
|
||||||
in a single commit, then pushes -- so main is never red
|
in a single commit, then pushes to the SAME ref that was
|
||||||
between a catalog merge and its signature. Signing uses the
|
reviewed (never a hardcoded "main") -- so that ref is never
|
||||||
|
red between a catalog merge and its signature, whether
|
||||||
|
that ref is `main` or a rotation branch. Signing uses the
|
||||||
CATALOG key ONLY -- see "Two signing keys" below.
|
CATALOG key ONLY -- see "Two signing keys" below.
|
||||||
|
|
||||||
The signature must be the artefact of an actual review, not a step that
|
The signature must be the artefact of an actual review, not a step that
|
||||||
follows one. Signing IS the approval act.
|
follows one. Signing IS the approval act.
|
||||||
|
|
||||||
|
Confused about which key is which, or what state either is in? Run
|
||||||
|
`python catalog_console.py keys` -- it needs no passphrase and prints a
|
||||||
|
plain-English status report for both keys: where each private half lives,
|
||||||
|
whether it's present, its fingerprint, whether that fingerprint matches
|
||||||
|
what's committed in bcc_core.py / ci.yml / scripts/sign_checksums.py, and
|
||||||
|
whether data/catalog.json.sig currently verifies -- ending with exactly
|
||||||
|
what to run next.
|
||||||
|
|
||||||
Two signing keys (issue #68 finding 5): the CATALOG key (offline,
|
Two signing keys (issue #68 finding 5): the CATALOG key (offline,
|
||||||
Console-only, `keygen` / `keygen --release` picks which) is the root of
|
Console-only, `keygen` / `keygen --release` picks which) is the root of
|
||||||
trust for what BCC executes and must never touch CI. The RELEASE key is
|
trust for what BCC executes and must never touch CI. The RELEASE key is
|
||||||
@@ -69,6 +85,7 @@ import urllib.error
|
|||||||
import urllib.request
|
import urllib.request
|
||||||
from dataclasses import dataclass
|
from dataclasses import dataclass
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
from typing import ClassVar
|
||||||
|
|
||||||
import bcc_core as core
|
import bcc_core as core
|
||||||
import catalog_review as review
|
import catalog_review as review
|
||||||
@@ -197,6 +214,89 @@ def unlock_signing_key(passphrase: str, kind: str = "catalog") -> bytes:
|
|||||||
return review.decrypt_private_key(blob, passphrase)
|
return review.decrypt_private_key(blob, passphrase)
|
||||||
|
|
||||||
|
|
||||||
|
def _pubkey_cache_file(kind: str) -> Path:
|
||||||
|
assert kind in _KEY_KINDS, f"unknown key kind {kind!r}, expected one of {_KEY_KINDS}"
|
||||||
|
return KEY_STORAGE_DIR / f"signing_key_{kind}.pub"
|
||||||
|
|
||||||
|
|
||||||
|
def store_public_key(pubkey: bytes, kind: str = "catalog") -> None:
|
||||||
|
"""Cache the PUBLIC half of a signing key, in plain base64, next to its
|
||||||
|
encrypted private counterpart (OS keychain if available, else the file
|
||||||
|
cache). Public keys are not secret -- this cache exists purely so
|
||||||
|
`catalog_console.py keys` can report a fingerprint and compare it
|
||||||
|
against what's committed in source WITHOUT ever decrypting (or asking
|
||||||
|
for a passphrase to unlock) the private key. Called by cmd_keygen()
|
||||||
|
right after a keypair is generated.
|
||||||
|
"""
|
||||||
|
keyring = _keyring_module()
|
||||||
|
pub_b64 = base64.b64encode(pubkey).decode("ascii")
|
||||||
|
if keyring is not None:
|
||||||
|
try:
|
||||||
|
keyring.set_password(_KEYRING_SERVICE, f"{_keyring_username(kind)}-pub", pub_b64)
|
||||||
|
return
|
||||||
|
except Exception:
|
||||||
|
pass # fall through to the file-based cache
|
||||||
|
KEY_STORAGE_DIR.mkdir(parents=True, exist_ok=True)
|
||||||
|
_pubkey_cache_file(kind).write_text(pub_b64 + "\n", encoding="utf-8")
|
||||||
|
|
||||||
|
|
||||||
|
def load_public_key(kind: str = "catalog") -> bytes | None:
|
||||||
|
"""The cached PUBLIC key of the given `kind`, or None if no key of that
|
||||||
|
kind has been generated yet (or it predates public-key caching -- an
|
||||||
|
older keygen run that never called store_public_key). Never touches the
|
||||||
|
encrypted private blob and never asks for a passphrase."""
|
||||||
|
keyring = _keyring_module()
|
||||||
|
if keyring is not None:
|
||||||
|
try:
|
||||||
|
pub_b64 = keyring.get_password(_KEYRING_SERVICE, f"{_keyring_username(kind)}-pub")
|
||||||
|
if pub_b64:
|
||||||
|
return base64.b64decode(pub_b64)
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
path = _pubkey_cache_file(kind)
|
||||||
|
if not path.exists():
|
||||||
|
return None
|
||||||
|
text = path.read_text(encoding="utf-8").strip()
|
||||||
|
if not text:
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
return base64.b64decode(text)
|
||||||
|
except ValueError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def has_encrypted_key(kind: str = "catalog") -> bool:
|
||||||
|
"""Whether a private key of this `kind` has been generated on this
|
||||||
|
machine -- checked WITHOUT decrypting or asking for a passphrase, so
|
||||||
|
`catalog_console.py keys` can report existence unconditionally."""
|
||||||
|
keyring = _keyring_module()
|
||||||
|
if keyring is not None:
|
||||||
|
try:
|
||||||
|
if keyring.get_password(_KEYRING_SERVICE, _keyring_username(kind)):
|
||||||
|
return True
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
return _key_storage_file(kind).exists()
|
||||||
|
|
||||||
|
|
||||||
|
def describe_local_key_location(kind: str) -> str:
|
||||||
|
"""Human-readable description of where a `kind` key's PRIVATE half
|
||||||
|
lives on this machine, for the `keys` report and the sign-flow prompt.
|
||||||
|
Never the release key's CI location -- that's cmd_keys' job to append,
|
||||||
|
since it's true regardless of whether a local copy also exists."""
|
||||||
|
keyring = _keyring_module()
|
||||||
|
if keyring is not None:
|
||||||
|
try:
|
||||||
|
if keyring.get_password(_KEYRING_SERVICE, _keyring_username(kind)):
|
||||||
|
return "on this machine, in the OS keychain (encrypted, passphrase-protected)"
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
|
key_file = _key_storage_file(kind)
|
||||||
|
if key_file.exists():
|
||||||
|
return f"on this machine, at {key_file} (encrypted, passphrase-protected)"
|
||||||
|
return "not generated yet"
|
||||||
|
|
||||||
|
|
||||||
# --------------------------------------------------------------------------- #
|
# --------------------------------------------------------------------------- #
|
||||||
# git plumbing against a local clone. The clone's `origin` remote is assumed
|
# git plumbing against a local clone. The clone's `origin` remote is assumed
|
||||||
# to already carry credentials (the "tokened remote" every other BCC
|
# to already carry credentials (the "tokened remote" every other BCC
|
||||||
@@ -223,6 +323,40 @@ def fetch_ref(repo_dir: Path, ref: str) -> str:
|
|||||||
return _git(repo_dir, "rev-parse", "FETCH_HEAD").strip()
|
return _git(repo_dir, "rev-parse", "FETCH_HEAD").strip()
|
||||||
|
|
||||||
|
|
||||||
|
def current_branch(repo_dir: Path) -> str | None:
|
||||||
|
"""The branch currently checked out at `repo_dir`, or None if it can't
|
||||||
|
be determined (detached HEAD, bare repo, mid-rebase, ...). This is what
|
||||||
|
lets the Console offer "sign against the branch I already have checked
|
||||||
|
out" as a source (issue #68 rotation-completability fix) without the
|
||||||
|
maintainer having to type the branch name -- ReviewWindow defaults to
|
||||||
|
it unless --ref names one explicitly.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
name = _git(repo_dir, "rev-parse", "--abbrev-ref", "HEAD").strip()
|
||||||
|
except GitError:
|
||||||
|
return None
|
||||||
|
return None if name in ("", "HEAD") else name
|
||||||
|
|
||||||
|
|
||||||
|
def compute_own_refs(explicit_ref: str | None, detected_branch: str | None) -> list[str]:
|
||||||
|
""" "main" plus (if different) `explicit_ref` or `detected_branch` -- the
|
||||||
|
exact list of refs ReviewWindow offers as "own" sources (loadable,
|
||||||
|
signable, AND pushable directly, unlike a PR's read-only
|
||||||
|
refs/pull/<n>/head). Pure: `detected_branch` is injected (normally
|
||||||
|
current_branch(repo_dir)) so this ref-resolution seam -- the fix for
|
||||||
|
issue #68's "rotation can't complete without a red main" -- is testable
|
||||||
|
without git or Qt. "main" is always index 0 so a stale/absent
|
||||||
|
list-widget selection still defaults sanely (see ReviewWindow._on_load's
|
||||||
|
row-clamping, and cmd_gui/ReviewWindow.__init__ for how `explicit_ref`
|
||||||
|
is threaded from --ref).
|
||||||
|
"""
|
||||||
|
refs = ["main"]
|
||||||
|
branch = explicit_ref or detected_branch
|
||||||
|
if branch and branch not in refs:
|
||||||
|
refs.append(branch)
|
||||||
|
return refs
|
||||||
|
|
||||||
|
|
||||||
def blob_sha_at(repo_dir: Path, commit: str, path: str) -> str:
|
def blob_sha_at(repo_dir: Path, commit: str, path: str) -> str:
|
||||||
"""The git blob SHA of `path` as it exists at `commit`. This is what
|
"""The git blob SHA of `path` as it exists at `commit`. This is what
|
||||||
gets pinned at review-start and re-checked immediately before signing
|
gets pinned at review-start and re-checked immediately before signing
|
||||||
@@ -313,11 +447,18 @@ def commit_and_push_signed_catalog(
|
|||||||
"""Write data/catalog.json + data/catalog.json.sig and commit BOTH in a
|
"""Write data/catalog.json + data/catalog.json.sig and commit BOTH in a
|
||||||
single commit, then push to `branch`. Returns the new commit SHA.
|
single commit, then push to `branch`. Returns the new commit SHA.
|
||||||
|
|
||||||
|
`branch` MUST be the same ref that was actually reviewed
|
||||||
|
(ReviewWindow._on_sign passes `session.loaded_ref`, never a hardcoded
|
||||||
|
"main" -- issue #68 completability fix): a catalog change reviewed on a
|
||||||
|
branch has to be signed and pushed to THAT branch so the branch itself
|
||||||
|
is never red, rather than landing the signature on main after a merge.
|
||||||
|
|
||||||
This is deliberate: if signing happened in a commit AFTER the catalog
|
This is deliberate: if signing happened in a commit AFTER the catalog
|
||||||
merge, main would be red (payload present, signature missing) between
|
merge, `branch` would be red (payload present, signature missing)
|
||||||
every catalog merge and its signing commit. Routine red-main trains
|
between the catalog merge and its signing commit. Routine red branches
|
||||||
exactly the alarm fatigue this whole design exists to prevent. Emitting
|
train exactly the alarm fatigue this whole design exists to prevent.
|
||||||
one commit with both files means main is never in that state.
|
Emitting one commit with both files means `branch` is never in that
|
||||||
|
state -- whether `branch` is main or a rotation-in-progress branch.
|
||||||
"""
|
"""
|
||||||
_git(repo_dir, "checkout", branch)
|
_git(repo_dir, "checkout", branch)
|
||||||
_git(repo_dir, "pull", "--ff-only", "origin", branch)
|
_git(repo_dir, "pull", "--ff-only", "origin", branch)
|
||||||
@@ -507,14 +648,76 @@ def registry_fetcher(ref: review.PackageRef) -> dict | None:
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
# Key status ("keys" command, issue #62/#68 follow-up: "make key handling
|
||||||
|
# comprehensible"). File I/O only -- the actual status/report logic is pure
|
||||||
|
# and lives in catalog_review (key_status / render_key_status_report), so
|
||||||
|
# it's unit-testable without touching disk. These wrappers read the THREE
|
||||||
|
# places a signing key's public half is expected to be committed, from
|
||||||
|
# `repo_dir`'s working tree, so `keys` reports on whatever ref/branch is
|
||||||
|
# actually checked out there (never this process's own sys.path import).
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
|
||||||
|
|
||||||
|
def read_catalog_pubkeys_from_source(repo_dir: Path) -> list[bytes]:
|
||||||
|
path = repo_dir / "bcc_core.py"
|
||||||
|
if not path.exists():
|
||||||
|
return []
|
||||||
|
return review.extract_pubkey_list_literal(path.read_text(encoding="utf-8"), "CATALOG_PUBKEYS")
|
||||||
|
|
||||||
|
|
||||||
|
def read_release_pubkeys_from_source(repo_dir: Path) -> list[bytes]:
|
||||||
|
path = repo_dir / "scripts" / "sign_checksums.py"
|
||||||
|
if not path.exists():
|
||||||
|
return []
|
||||||
|
return review.extract_pubkey_list_literal(path.read_text(encoding="utf-8"), "RELEASE_PUBKEYS")
|
||||||
|
|
||||||
|
|
||||||
|
def read_ci_trust_anchor_pubkeys(repo_dir: Path) -> list[bytes]:
|
||||||
|
path = repo_dir / ".github" / "workflows" / "ci.yml"
|
||||||
|
if not path.exists():
|
||||||
|
return []
|
||||||
|
pubkey = review.extract_ci_trust_anchor_pubkey(path.read_text(encoding="utf-8"))
|
||||||
|
return [pubkey] if pubkey is not None else []
|
||||||
|
|
||||||
|
|
||||||
|
def catalog_sig_status_on_disk(repo_dir: Path, committed_catalog_pubkeys: list[bytes]) -> str:
|
||||||
|
""" "valid" / "invalid" / "missing" for data/catalog.json.sig as it sits
|
||||||
|
in `repo_dir`'s WORKING TREE right now (not a git ref -- the `keys`
|
||||||
|
command deliberately reports on-disk state, which is what "the current
|
||||||
|
checked-out branch" concretely means and avoids a network fetch just to
|
||||||
|
print a status line). Verified against `committed_catalog_pubkeys`
|
||||||
|
(whatever bcc_core.py on this same working tree currently says), not
|
||||||
|
the running process's own bcc_core import, so this stays correct no
|
||||||
|
matter which ref/branch happens to be checked out.
|
||||||
|
"""
|
||||||
|
catalog_path = repo_dir / CATALOG_PATH
|
||||||
|
sig_path = repo_dir / SIG_PATH
|
||||||
|
if not catalog_path.exists() or not sig_path.exists():
|
||||||
|
return "missing"
|
||||||
|
raw = catalog_path.read_bytes()
|
||||||
|
sig = sig_path.read_bytes()
|
||||||
|
if core.verify_catalog_signature(raw, sig, committed_catalog_pubkeys):
|
||||||
|
return "valid"
|
||||||
|
return "invalid"
|
||||||
|
|
||||||
|
|
||||||
# --------------------------------------------------------------------------- #
|
# --------------------------------------------------------------------------- #
|
||||||
# GUI (PySide6). Everything above this line has no Qt dependency and is
|
# GUI (PySide6). Everything above this line has no Qt dependency and is
|
||||||
# exercised by tests/test_catalog_review.py; everything below is a thin
|
# exercised by tests/test_catalog_review.py; everything below is a thin
|
||||||
# shell that calls into it.
|
# shell that calls into it.
|
||||||
# --------------------------------------------------------------------------- #
|
# --------------------------------------------------------------------------- #
|
||||||
|
|
||||||
from PySide6.QtCore import Qt, QThread, Signal # noqa: E402
|
# PySide6 is imported defensively: `keygen`, `show-seed-b64`, and `keys`
|
||||||
from PySide6.QtWidgets import ( # noqa: E402
|
# (the commands a maintainer runs most often, and the ones this file's
|
||||||
|
# tests/py_compile-only CI environment can exercise) have no GUI dependency
|
||||||
|
# at all and must keep working even somewhere PySide6 isn't installed or
|
||||||
|
# won't import (e.g. no system Qt libs). Only `gui` needs it -- cmd_gui()
|
||||||
|
# checks _PYSIDE6_AVAILABLE and fails with a clear message instead of an
|
||||||
|
# ImportError stack trace if it's missing.
|
||||||
|
try:
|
||||||
|
from PySide6.QtCore import Qt, QThread, Signal
|
||||||
|
from PySide6.QtWidgets import (
|
||||||
QApplication,
|
QApplication,
|
||||||
QCheckBox,
|
QCheckBox,
|
||||||
QDialog,
|
QDialog,
|
||||||
@@ -533,7 +736,15 @@ from PySide6.QtWidgets import ( # noqa: E402
|
|||||||
QVBoxLayout,
|
QVBoxLayout,
|
||||||
QWidget,
|
QWidget,
|
||||||
)
|
)
|
||||||
|
except ImportError as _pyside6_exc: # pragma: no cover - only hit where PySide6 is absent
|
||||||
|
_PYSIDE6_IMPORT_ERROR: str | None = str(_pyside6_exc)
|
||||||
|
else:
|
||||||
|
_PYSIDE6_IMPORT_ERROR = None
|
||||||
|
|
||||||
|
_PYSIDE6_AVAILABLE = _PYSIDE6_IMPORT_ERROR is None
|
||||||
|
|
||||||
|
|
||||||
|
if _PYSIDE6_AVAILABLE: # pragma: no branch - GUI class defs, only skipped where PySide6 is absent
|
||||||
|
|
||||||
def plain_label(text: object) -> QLabel:
|
def plain_label(text: object) -> QLabel:
|
||||||
"""A QLabel guaranteed to render `text` as plain text, never HTML.
|
"""A QLabel guaranteed to render `text` as plain text, never HTML.
|
||||||
@@ -551,10 +762,8 @@ def plain_label(text: object) -> QLabel:
|
|||||||
label.setWordWrap(True)
|
label.setWordWrap(True)
|
||||||
return label
|
return label
|
||||||
|
|
||||||
|
|
||||||
_SEVERITY_PREFIX = {"blocking": "✖ BLOCKING", "warning": "⚠ WARNING", "info": "ℹ INFO"}
|
_SEVERITY_PREFIX = {"blocking": "✖ BLOCKING", "warning": "⚠ WARNING", "info": "ℹ INFO"}
|
||||||
|
|
||||||
|
|
||||||
class RegistryLookupWorker(QThread):
|
class RegistryLookupWorker(QThread):
|
||||||
"""Off-UI-thread registry lookups, mirroring bcc.py's ConnTester/
|
"""Off-UI-thread registry lookups, mirroring bcc.py's ConnTester/
|
||||||
SpawnTester pattern. Never blocks the review UI on a slow/dead network."""
|
SpawnTester pattern. Never blocks the review UI on a slow/dead network."""
|
||||||
@@ -573,7 +782,6 @@ class RegistryLookupWorker(QThread):
|
|||||||
]
|
]
|
||||||
self.done.emit(results)
|
self.done.emit(results)
|
||||||
|
|
||||||
|
|
||||||
class EntryCard(QWidget):
|
class EntryCard(QWidget):
|
||||||
"""One changed catalog entry: the diff, risk findings, and the
|
"""One changed catalog entry: the diff, risk findings, and the
|
||||||
acknowledge checkbox that gates Sign. `command`/`args` are rendered
|
acknowledge checkbox that gates Sign. `command`/`args` are rendered
|
||||||
@@ -685,15 +893,24 @@ class EntryCard(QWidget):
|
|||||||
self.registry_label.setText(html.escape(text))
|
self.registry_label.setText(html.escape(text))
|
||||||
self.registry_label.setTextFormat(Qt.PlainText)
|
self.registry_label.setTextFormat(Qt.PlainText)
|
||||||
|
|
||||||
|
|
||||||
class PassphraseDialog(QDialog):
|
class PassphraseDialog(QDialog):
|
||||||
def __init__(self, prompt: str, parent=None):
|
"""Prompts for a signing key's passphrase.
|
||||||
|
|
||||||
|
`prompt` must say plainly WHICH key (CATALOG or RELEASE) is about to be
|
||||||
|
unlocked, and its fingerprint when known -- issue #62/#68 follow-up: a
|
||||||
|
maintainer must see which key he's about to type a passphrase for
|
||||||
|
BEFORE typing it, not infer it from context. This is the exact ambiguity
|
||||||
|
that led to a private key being pasted into a chat window.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, prompt: str, window_title: str = "Signing key passphrase", parent=None):
|
||||||
super().__init__(parent)
|
super().__init__(parent)
|
||||||
self.setWindowTitle("Signing key passphrase")
|
self.setWindowTitle(window_title)
|
||||||
layout = QFormLayout(self)
|
layout = QFormLayout(self)
|
||||||
|
layout.addRow(plain_label(prompt))
|
||||||
self.edit = QLineEdit()
|
self.edit = QLineEdit()
|
||||||
self.edit.setEchoMode(QLineEdit.EchoMode.Password)
|
self.edit.setEchoMode(QLineEdit.EchoMode.Password)
|
||||||
layout.addRow(prompt, self.edit)
|
layout.addRow("Passphrase:", self.edit)
|
||||||
buttons = QDialogButtonBox(
|
buttons = QDialogButtonBox(
|
||||||
QDialogButtonBox.StandardButton.Ok | QDialogButtonBox.StandardButton.Cancel
|
QDialogButtonBox.StandardButton.Ok | QDialogButtonBox.StandardButton.Cancel
|
||||||
)
|
)
|
||||||
@@ -704,14 +921,26 @@ class PassphraseDialog(QDialog):
|
|||||||
def passphrase(self) -> str:
|
def passphrase(self) -> str:
|
||||||
return self.edit.text()
|
return self.edit.text()
|
||||||
|
|
||||||
|
|
||||||
class ReviewWindow(QMainWindow):
|
class ReviewWindow(QMainWindow):
|
||||||
def __init__(self, repo_dir: Path):
|
#: Placeholder empty catalog used when there is nothing to diff against
|
||||||
|
#: yet (no prior signature, or a key rotation invalidated the old one).
|
||||||
|
_EMPTY_CATALOG: ClassVar[dict] = {"schema": 1, "version": 0, "servers": []}
|
||||||
|
|
||||||
|
def __init__(self, repo_dir: Path, ref: str | None = None):
|
||||||
super().__init__()
|
super().__init__()
|
||||||
self.repo_dir = repo_dir
|
self.repo_dir = repo_dir
|
||||||
self.session: review.ReviewSession | None = None
|
self.session: review.ReviewSession | None = None
|
||||||
self.cards: dict[str, EntryCard] = {}
|
self.cards: dict[str, EntryCard] = {}
|
||||||
|
|
||||||
|
# "Own" refs this clone can load/diff/sign+push against directly --
|
||||||
|
# issue #68 rotation-completability fix. "main" is always offered;
|
||||||
|
# if the checkout is on a different branch (or --ref names one
|
||||||
|
# explicitly), that branch is offered too, so a rotation in
|
||||||
|
# progress on a branch can be reviewed, signed, and pushed to ITS
|
||||||
|
# OWN ref -- completing the rotation before merge, never forcing a
|
||||||
|
# red main in between. See _load_own_ref() / _on_sign().
|
||||||
|
self._own_refs = self._compute_own_refs(ref)
|
||||||
|
|
||||||
self.setWindowTitle("BCC Catalog Console -- maintainer-only, never shipped")
|
self.setWindowTitle("BCC Catalog Console -- maintainer-only, never shipped")
|
||||||
central = QWidget()
|
central = QWidget()
|
||||||
self.setCentralWidget(central)
|
self.setCentralWidget(central)
|
||||||
@@ -719,7 +948,13 @@ class ReviewWindow(QMainWindow):
|
|||||||
|
|
||||||
top = QHBoxLayout()
|
top = QHBoxLayout()
|
||||||
self.source_list = QListWidget()
|
self.source_list = QListWidget()
|
||||||
self.source_list.addItem(QListWidgetItem("main (current tip)"))
|
for own_ref in self._own_refs:
|
||||||
|
label = (
|
||||||
|
f"{own_ref} (current tip)"
|
||||||
|
if own_ref == "main"
|
||||||
|
else f"{own_ref} (current branch)"
|
||||||
|
)
|
||||||
|
self.source_list.addItem(QListWidgetItem(label))
|
||||||
top.addWidget(self.source_list, 1)
|
top.addWidget(self.source_list, 1)
|
||||||
|
|
||||||
side = QVBoxLayout()
|
side = QVBoxLayout()
|
||||||
@@ -768,58 +1003,66 @@ class ReviewWindow(QMainWindow):
|
|||||||
self._prs: list[CatalogPR] = []
|
self._prs: list[CatalogPR] = []
|
||||||
self._refresh_pr_list()
|
self._refresh_pr_list()
|
||||||
|
|
||||||
|
def _compute_own_refs(self, explicit_ref: str | None) -> list[str]:
|
||||||
|
"""Thin GUI-side wrapper: injects current_branch(self.repo_dir)
|
||||||
|
(a git call) into the pure compute_own_refs() -- see that
|
||||||
|
function's docstring for what this list actually means."""
|
||||||
|
return compute_own_refs(explicit_ref, current_branch(self.repo_dir))
|
||||||
|
|
||||||
def _refresh_pr_list(self):
|
def _refresh_pr_list(self):
|
||||||
self._prs = list_open_catalog_prs(self._token)
|
self._prs = list_open_catalog_prs(self._token)
|
||||||
while self.source_list.count() > 1:
|
while self.source_list.count() > len(self._own_refs):
|
||||||
self.source_list.takeItem(1)
|
self.source_list.takeItem(len(self._own_refs))
|
||||||
for pr in self._prs:
|
for pr in self._prs:
|
||||||
self.source_list.addItem(QListWidgetItem(f"PR #{pr.number}: {pr.title}"))
|
self.source_list.addItem(QListWidgetItem(f"PR #{pr.number}: {pr.title}"))
|
||||||
|
|
||||||
def _on_load(self):
|
def _load_own_ref(self, loaded_ref: str):
|
||||||
row = self.source_list.currentRow()
|
"""Load + diff `loaded_ref` -- "main" or the maintainer's own
|
||||||
reattest = False
|
working branch, ANY ref this clone's origin can fetch directly (as
|
||||||
try:
|
opposed to a PR's read-only refs/pull/<n>/head). Diffs against the
|
||||||
if row <= 0:
|
last catalog a maintainer actually SIGNED on that ref (never
|
||||||
# source = main: diff against the last catalog a maintainer
|
against itself -- an empty diff must mean "nothing to sign", never
|
||||||
# actually SIGNED (the bytes covered by the current
|
"sign unlocked", issue #68 finding 1) and enters KEY-ROTATION
|
||||||
# data/catalog.json.sig), never against itself. Diffing
|
RE-ATTESTATION mode if the committed .sig doesn't verify under the
|
||||||
# main-vs-main is what made an empty diff -> instantly
|
currently-trusted bcc_core.CATALOG_PUBKEYS (issue #68 finding 5
|
||||||
# "signable" in the first place (issue #68 finding 1) --
|
follow-up). This is the exact logic "main" always used -- pulled
|
||||||
# this is the only path that reaches sign_catalog_bytes(),
|
into its own method, parameterized on the ref, so a rotation on a
|
||||||
# so if it can't be trusted nothing can.
|
branch gets the SAME treatment as one on main and can be signed
|
||||||
loaded_ref = "main"
|
(and pushed back to that SAME branch, see _on_sign) before merge --
|
||||||
|
the completability fix this method exists for.
|
||||||
|
|
||||||
|
Returns (new_raw, new_blob_sha, new_catalog, old_catalog, reattest).
|
||||||
|
"""
|
||||||
commit = fetch_ref(self.repo_dir, loaded_ref)
|
commit = fetch_ref(self.repo_dir, loaded_ref)
|
||||||
new_raw, new_blob_sha = read_catalog_at_commit(self.repo_dir, commit)
|
new_raw, new_blob_sha = read_catalog_at_commit(self.repo_dir, commit)
|
||||||
new_catalog = core.load_catalog(new_raw)
|
new_catalog = core.load_catalog(new_raw)
|
||||||
|
|
||||||
# KEY-ROTATION RE-ATTESTATION (issue #68 finding 5
|
|
||||||
# follow-up): if the committed .sig does not verify under
|
|
||||||
# the CURRENTLY-trusted bcc_core.CATALOG_PUBKEYS, the
|
|
||||||
# trusted key changed since this catalog was last signed.
|
|
||||||
# The new key has never vouched for ANY of this catalog's
|
|
||||||
# content, so there is nothing meaningful to diff against
|
|
||||||
# -- every entry needs a fresh acknowledgement under the
|
|
||||||
# new key. Do NOT fall through to last_signed_catalog_raw()
|
|
||||||
# in this case: it walks history looking for a match under
|
|
||||||
# the (now-untrusted) old key's signature, which is exactly
|
|
||||||
# backwards after a rotation.
|
|
||||||
if not catalog_signature_valid_at(self.repo_dir, commit, new_raw):
|
if not catalog_signature_valid_at(self.repo_dir, commit, new_raw):
|
||||||
reattest = True
|
reattest = True
|
||||||
old_catalog = {"schema": 1, "version": 0, "servers": []}
|
old_catalog = dict(self._EMPTY_CATALOG)
|
||||||
else:
|
else:
|
||||||
|
reattest = False
|
||||||
old_raw = last_signed_catalog_raw(self.repo_dir, commit)
|
old_raw = last_signed_catalog_raw(self.repo_dir, commit)
|
||||||
old_catalog = (
|
old_catalog = (
|
||||||
core.load_catalog(old_raw)
|
core.load_catalog(old_raw) if old_raw is not None else dict(self._EMPTY_CATALOG)
|
||||||
if old_raw is not None
|
)
|
||||||
else {
|
|
||||||
"schema": 1,
|
return new_raw, new_blob_sha, new_catalog, old_catalog, reattest
|
||||||
"version": 0,
|
|
||||||
"servers": [],
|
def _on_load(self):
|
||||||
}
|
row = self.source_list.currentRow()
|
||||||
|
if row < 0:
|
||||||
|
row = 0 # nothing explicitly selected -- default to index 0 ("main")
|
||||||
|
try:
|
||||||
|
if row < len(self._own_refs):
|
||||||
|
loaded_ref = self._own_refs[row]
|
||||||
|
new_raw, new_blob_sha, new_catalog, old_catalog, reattest = self._load_own_ref(
|
||||||
|
loaded_ref
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
pr = self._prs[row - 1]
|
pr = self._prs[row - len(self._own_refs)]
|
||||||
loaded_ref = pr.head_ref
|
loaded_ref = pr.head_ref
|
||||||
|
reattest = False
|
||||||
commit = fetch_ref(self.repo_dir, loaded_ref)
|
commit = fetch_ref(self.repo_dir, loaded_ref)
|
||||||
old_commit = fetch_ref(self.repo_dir, "main")
|
old_commit = fetch_ref(self.repo_dir, "main")
|
||||||
|
|
||||||
@@ -842,12 +1085,12 @@ class ReviewWindow(QMainWindow):
|
|||||||
)
|
)
|
||||||
if reattest:
|
if reattest:
|
||||||
self.reattest_banner.setText(
|
self.reattest_banner.setText(
|
||||||
"KEY ROTATION IN PROGRESS -- the trusted catalog signing key changed. "
|
"KEY ROTATION IN PROGRESS -- the trusted CATALOG signing key changed. "
|
||||||
"The existing data/catalog.json.sig does NOT verify under the current "
|
"The existing data/catalog.json.sig does NOT verify under the current "
|
||||||
"bcc_core.CATALOG_PUBKEYS, so it is NOT trusted. Every one of the "
|
"bcc_core.CATALOG_PUBKEYS, so it is NOT trusted. Every one of the "
|
||||||
f"{len(self.session.changes)} entries below must be re-reviewed and "
|
f"{len(self.session.changes)} entries below must be re-reviewed and "
|
||||||
"acknowledged before the new key can re-sign this catalog -- this is "
|
"acknowledged before the new CATALOG key can re-sign this catalog -- "
|
||||||
"the intended cost of rotating the key, not a bug."
|
"this is the intended cost of rotating the CATALOG key, not a bug."
|
||||||
)
|
)
|
||||||
self.reattest_banner.setVisible(True)
|
self.reattest_banner.setVisible(True)
|
||||||
else:
|
else:
|
||||||
@@ -864,7 +1107,11 @@ class ReviewWindow(QMainWindow):
|
|||||||
|
|
||||||
assert self.session is not None
|
assert self.session is not None
|
||||||
all_ids = sorted(
|
all_ids = sorted(
|
||||||
{e.get("id") for e in (self.session.new_catalog.get("servers") or []) if e.get("id")}
|
{
|
||||||
|
e.get("id")
|
||||||
|
for e in (self.session.new_catalog.get("servers") or [])
|
||||||
|
if e.get("id")
|
||||||
|
}
|
||||||
)
|
)
|
||||||
for change in self.session.changes:
|
for change in self.session.changes:
|
||||||
card = EntryCard(change, all_ids)
|
card = EntryCard(change, all_ids)
|
||||||
@@ -935,23 +1182,52 @@ class ReviewWindow(QMainWindow):
|
|||||||
self._on_load()
|
self._on_load()
|
||||||
return
|
return
|
||||||
|
|
||||||
dialog = PassphraseDialog("Enter CATALOG signing key passphrase:", self)
|
# Show WHICH key is about to be used, and its fingerprint, BEFORE
|
||||||
|
# the passphrase field even appears -- issue #62/#68 follow-up. A
|
||||||
|
# maintainer must never have to infer which key a bare "Enter
|
||||||
|
# passphrase" prompt means; that ambiguity is exactly what led to a
|
||||||
|
# private key being pasted into a chat window.
|
||||||
|
catalog_pubkey = load_public_key("catalog")
|
||||||
|
if catalog_pubkey is not None:
|
||||||
|
fp_note = f"fingerprint {review.fingerprint_pubkey(catalog_pubkey)}"
|
||||||
|
else:
|
||||||
|
fp_note = "fingerprint unknown (generated before fingerprint caching -- re-run keygen to cache it)"
|
||||||
|
prompt = (
|
||||||
|
f"About to sign with the CATALOG signing key ({fp_note}).\n"
|
||||||
|
"This is the root of trust for what BCC executes on a user's machine -- "
|
||||||
|
"it is never the RELEASE key.\n\n"
|
||||||
|
"Enter the CATALOG key's passphrase:"
|
||||||
|
)
|
||||||
|
dialog = PassphraseDialog(prompt, "CATALOG signing key passphrase", self)
|
||||||
if dialog.exec() != QDialog.DialogCode.Accepted:
|
if dialog.exec() != QDialog.DialogCode.Accepted:
|
||||||
return
|
return
|
||||||
try:
|
try:
|
||||||
seed = unlock_signing_key(dialog.passphrase())
|
seed = unlock_signing_key(dialog.passphrase(), kind="catalog")
|
||||||
except (FileNotFoundError, ValueError) as e:
|
except (FileNotFoundError, ValueError) as e:
|
||||||
QMessageBox.critical(self, "Sign failed", html.escape(str(e)))
|
QMessageBox.critical(self, "Sign failed", html.escape(str(e)))
|
||||||
return
|
return
|
||||||
|
|
||||||
signature = review.sign_catalog_bytes(self._new_raw, seed)
|
signature = review.sign_catalog_bytes(self._new_raw, seed)
|
||||||
try:
|
try:
|
||||||
new_commit = commit_and_push_signed_catalog(self.repo_dir, self._new_raw, signature)
|
# Push to the SAME ref that was reviewed (session.loaded_ref),
|
||||||
|
# never a hardcoded "main" -- issue #68 completability fix. A
|
||||||
|
# rotation (or any other catalog change) reviewed on a branch
|
||||||
|
# must land on THAT branch so it can be signed and pushed
|
||||||
|
# before the branch is ever merged, instead of forcing a merge
|
||||||
|
# of a red PR followed by a fix-up on main.
|
||||||
|
new_commit = commit_and_push_signed_catalog(
|
||||||
|
self.repo_dir, self._new_raw, signature, branch=self.session.loaded_ref
|
||||||
|
)
|
||||||
except GitError as e:
|
except GitError as e:
|
||||||
QMessageBox.critical(self, "Commit/push failed", html.escape(str(e)))
|
QMessageBox.critical(self, "Commit/push failed", html.escape(str(e)))
|
||||||
return
|
return
|
||||||
|
|
||||||
QMessageBox.information(self, "Signed", f"Signed and pushed as commit {new_commit[:12]}.")
|
QMessageBox.information(
|
||||||
|
self,
|
||||||
|
"Signed",
|
||||||
|
f"Signed with the CATALOG key and pushed to {self.session.loaded_ref} "
|
||||||
|
f"as commit {new_commit[:12]}.",
|
||||||
|
)
|
||||||
self.sign_btn.setEnabled(False)
|
self.sign_btn.setEnabled(False)
|
||||||
|
|
||||||
|
|
||||||
@@ -981,9 +1257,10 @@ def cmd_keygen(args: argparse.Namespace) -> int:
|
|||||||
|
|
||||||
blob = review.encrypt_private_key(seed, passphrase)
|
blob = review.encrypt_private_key(seed, passphrase)
|
||||||
where = store_encrypted_key(blob, kind=kind)
|
where = store_encrypted_key(blob, kind=kind)
|
||||||
|
store_public_key(pubkey, kind=kind) # non-secret; lets `keys` fingerprint without a passphrase
|
||||||
pubkey_b64 = base64.b64encode(pubkey).decode("ascii")
|
pubkey_b64 = base64.b64encode(pubkey).decode("ascii")
|
||||||
|
|
||||||
print(f"{kind.capitalize()} private key encrypted and stored in: {where}")
|
print(f"{kind.upper()} private key encrypted and stored in: {where}")
|
||||||
print()
|
print()
|
||||||
if kind == "catalog":
|
if kind == "catalog":
|
||||||
print(
|
print(
|
||||||
@@ -1082,6 +1359,15 @@ def cmd_show_seed_b64(args: argparse.Namespace) -> int:
|
|||||||
|
|
||||||
|
|
||||||
def cmd_gui(args: argparse.Namespace) -> int:
|
def cmd_gui(args: argparse.Namespace) -> int:
|
||||||
|
if not _PYSIDE6_AVAILABLE:
|
||||||
|
print(
|
||||||
|
"error: PySide6 is not available in this Python environment, so the GUI "
|
||||||
|
f"can't launch ({_PYSIDE6_IMPORT_ERROR}). `keygen`, `show-seed-b64`, and "
|
||||||
|
"`keys` don't need it and still work here.",
|
||||||
|
file=sys.stderr,
|
||||||
|
)
|
||||||
|
return 1
|
||||||
|
|
||||||
repo_dir = Path(args.repo).resolve()
|
repo_dir = Path(args.repo).resolve()
|
||||||
if not (repo_dir / CATALOG_PATH).exists():
|
if not (repo_dir / CATALOG_PATH).exists():
|
||||||
print(
|
print(
|
||||||
@@ -1092,18 +1378,98 @@ def cmd_gui(args: argparse.Namespace) -> int:
|
|||||||
|
|
||||||
app = QApplication(sys.argv)
|
app = QApplication(sys.argv)
|
||||||
app.setApplicationName("BCC Catalog Console")
|
app.setApplicationName("BCC Catalog Console")
|
||||||
win = ReviewWindow(repo_dir)
|
win = ReviewWindow(repo_dir, ref=args.ref)
|
||||||
win.resize(900, 700)
|
win.resize(900, 700)
|
||||||
win.show()
|
win.show()
|
||||||
return app.exec()
|
return app.exec()
|
||||||
|
|
||||||
|
|
||||||
|
def cmd_keys(args: argparse.Namespace) -> int:
|
||||||
|
"""`python catalog_console.py keys` -- "which key is what, and what
|
||||||
|
state is everything in?" (issue #62/#68 follow-up). Reads the CURRENT
|
||||||
|
WORKING TREE at --repo (so it reports on whatever branch/ref is
|
||||||
|
actually checked out there -- issue #68 rotation-completability fix
|
||||||
|
means that's often not "main" during a rotation), gathers every input
|
||||||
|
the pure catalog_review.key_status()/render_key_status_report() need,
|
||||||
|
and prints the result. Never touches, decrypts, or prints a private key
|
||||||
|
-- everything gathered here is a cached PUBLIC key, a fingerprint, file
|
||||||
|
text, or a signature verification result.
|
||||||
|
"""
|
||||||
|
repo_dir = Path(args.repo).resolve()
|
||||||
|
branch = current_branch(repo_dir) or "(unknown -- detached HEAD or not a git checkout)"
|
||||||
|
print(f"Catalog Console -- key status for {repo_dir}")
|
||||||
|
print(f"Checked-out ref: {branch}")
|
||||||
|
print()
|
||||||
|
|
||||||
|
committed_catalog_pubkeys = read_catalog_pubkeys_from_source(repo_dir)
|
||||||
|
ci_trust_anchor_pubkeys = read_ci_trust_anchor_pubkeys(repo_dir)
|
||||||
|
committed_release_pubkeys = read_release_pubkeys_from_source(repo_dir)
|
||||||
|
|
||||||
|
catalog_status = review.key_status(
|
||||||
|
"catalog",
|
||||||
|
display_name="CATALOG",
|
||||||
|
purpose=(
|
||||||
|
"Signs the server list that BCC writes into your Claude config. This is "
|
||||||
|
"what decides which programs run on a user's machine -- the root of trust."
|
||||||
|
),
|
||||||
|
private_key_location=describe_local_key_location("catalog"),
|
||||||
|
local_exists=has_encrypted_key("catalog"),
|
||||||
|
local_pubkey=load_public_key("catalog"),
|
||||||
|
locations=[
|
||||||
|
("bcc_core.CATALOG_PUBKEYS", committed_catalog_pubkeys),
|
||||||
|
("ci.yml trust anchor (EXPECTED_CATALOG_PUBKEY_B64)", ci_trust_anchor_pubkeys),
|
||||||
|
],
|
||||||
|
catalog_sig_status=catalog_sig_status_on_disk(repo_dir, committed_catalog_pubkeys),
|
||||||
|
)
|
||||||
|
|
||||||
|
release_where = describe_local_key_location("release")
|
||||||
|
if release_where == "not generated yet":
|
||||||
|
release_where = (
|
||||||
|
"not generated yet, and not verifiable from here as present in CI "
|
||||||
|
"(check the Gitea repo secret RELEASE_SIGNING_KEY directly)"
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
release_where = (
|
||||||
|
f"{release_where} -- intended to be pasted into the Gitea secret "
|
||||||
|
"RELEASE_SIGNING_KEY (via `show-seed-b64 --release`) and not kept as the "
|
||||||
|
"primary copy once that's done"
|
||||||
|
)
|
||||||
|
release_status = review.key_status(
|
||||||
|
"release",
|
||||||
|
display_name="RELEASE",
|
||||||
|
purpose=(
|
||||||
|
"Signs the SHA256SUMS checksum manifest for release downloads only. "
|
||||||
|
"CI-resident on purpose: a CI compromise burns this key, never the "
|
||||||
|
"catalog key -- that asymmetry is the whole point of having two keys."
|
||||||
|
),
|
||||||
|
private_key_location=release_where,
|
||||||
|
local_exists=has_encrypted_key("release"),
|
||||||
|
local_pubkey=load_public_key("release"),
|
||||||
|
locations=[("scripts/sign_checksums.py RELEASE_PUBKEYS", committed_release_pubkeys)],
|
||||||
|
catalog_sig_status=None,
|
||||||
|
)
|
||||||
|
|
||||||
|
print(review.render_key_status_report([catalog_status, release_status]))
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
def build_parser() -> argparse.ArgumentParser:
|
def build_parser() -> argparse.ArgumentParser:
|
||||||
parser = argparse.ArgumentParser(description=__doc__)
|
parser = argparse.ArgumentParser(description=__doc__)
|
||||||
sub = parser.add_subparsers(dest="command")
|
sub = parser.add_subparsers(dest="command")
|
||||||
|
|
||||||
p_gui = sub.add_parser("gui", help="launch the review/sign GUI (default)")
|
p_gui = sub.add_parser("gui", help="launch the review/sign GUI (default)")
|
||||||
p_gui.add_argument("--repo", default=".", help="path to a BCC git checkout (default: cwd)")
|
p_gui.add_argument("--repo", default=".", help="path to a BCC git checkout (default: cwd)")
|
||||||
|
p_gui.add_argument(
|
||||||
|
"--ref",
|
||||||
|
default=None,
|
||||||
|
help=(
|
||||||
|
"branch to offer as an additional load/sign/push source, alongside "
|
||||||
|
"'main' and any open PRs -- e.g. a key-rotation branch, so rotation "
|
||||||
|
"can be reviewed and signed BEFORE merge instead of forcing a red main "
|
||||||
|
"(issue #68). Defaults to whatever branch --repo is currently checked "
|
||||||
|
"out on; only needed if that's not the branch you mean."
|
||||||
|
),
|
||||||
|
)
|
||||||
p_gui.set_defaults(func=cmd_gui)
|
p_gui.set_defaults(func=cmd_gui)
|
||||||
|
|
||||||
p_keygen = sub.add_parser(
|
p_keygen = sub.add_parser(
|
||||||
@@ -1131,10 +1497,21 @@ def build_parser() -> argparse.ArgumentParser:
|
|||||||
)
|
)
|
||||||
p_seed.set_defaults(func=cmd_show_seed_b64)
|
p_seed.set_defaults(func=cmd_show_seed_b64)
|
||||||
|
|
||||||
|
p_keys = sub.add_parser(
|
||||||
|
"keys",
|
||||||
|
help=(
|
||||||
|
"print a plain-English status report: which key is what, where its "
|
||||||
|
"private half lives, whether it matches what's committed, and whether "
|
||||||
|
"data/catalog.json.sig currently verifies"
|
||||||
|
),
|
||||||
|
)
|
||||||
|
p_keys.add_argument("--repo", default=".", help="path to a BCC git checkout (default: cwd)")
|
||||||
|
p_keys.set_defaults(func=cmd_keys)
|
||||||
|
|
||||||
return parser
|
return parser
|
||||||
|
|
||||||
|
|
||||||
_SUBCOMMANDS = ("gui", "keygen", "show-seed-b64", "-h", "--help")
|
_SUBCOMMANDS = ("gui", "keygen", "show-seed-b64", "keys", "-h", "--help")
|
||||||
|
|
||||||
|
|
||||||
def main(argv: list[str] | None = None) -> int:
|
def main(argv: list[str] | None = None) -> int:
|
||||||
|
|||||||
@@ -16,6 +16,8 @@ new surface" recurring-bug lesson).
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import base64
|
||||||
|
import hashlib
|
||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
@@ -851,3 +853,243 @@ _NON_ASCII_RE = re.compile(r"[^\x00-\x7f]")
|
|||||||
|
|
||||||
def contains_non_ascii(s: str) -> bool:
|
def contains_non_ascii(s: str) -> bool:
|
||||||
return bool(_NON_ASCII_RE.search(s))
|
return bool(_NON_ASCII_RE.search(s))
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
# Key status reporting (issue #62/#68 follow-up: "make key handling
|
||||||
|
# comprehensible"). Pure functions only -- `catalog_console.py cmd_keys` is a
|
||||||
|
# thin printer that gathers inputs (local key caches, source-file text, the
|
||||||
|
# catalog + its .sig) and hands them here. NEVER touches private key bytes:
|
||||||
|
# every input/output here is a public key, a fingerprint, or a status string.
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
|
||||||
|
|
||||||
|
def fingerprint_pubkey(pubkey: bytes) -> str:
|
||||||
|
"""Short, human-comparable fingerprint of a raw Ed25519 public key: the
|
||||||
|
first 16 hex chars of its SHA-256 digest, grouped in 4s (e.g. "3F2A 9C1B
|
||||||
|
44DE 08AA") so two fingerprints can be eyeballed for a mismatch the way a
|
||||||
|
PGP fingerprint is. Deliberately NOT the raw base64 pubkey itself in the
|
||||||
|
default short form (that's available via the full committed value in the
|
||||||
|
report) -- a fixed-width grouped hex string is easier to compare at a
|
||||||
|
glance and to read aloud/type over chat if needed. Never derived from,
|
||||||
|
and never printed alongside, any private key material.
|
||||||
|
"""
|
||||||
|
digest = hashlib.sha256(pubkey).hexdigest().upper()[:16]
|
||||||
|
return " ".join(digest[i : i + 4] for i in range(0, len(digest), 4))
|
||||||
|
|
||||||
|
|
||||||
|
_PUBKEY_LIST_B64_RE = re.compile(r'base64\.b64decode\(\s*"([^"]+)"\s*\)')
|
||||||
|
|
||||||
|
|
||||||
|
def extract_pubkey_list_literal(source_text: str, var_name: str) -> list[bytes]:
|
||||||
|
"""Best-effort extraction of a `<var_name>: list[bytes] = [...]` literal
|
||||||
|
(each entry a `base64.b64decode("...")` call, matching the exact style
|
||||||
|
bcc_core.CATALOG_PUBKEYS and scripts.sign_checksums.RELEASE_PUBKEYS are
|
||||||
|
both written in) straight out of Python source TEXT.
|
||||||
|
|
||||||
|
Deliberately a regex over text, not an import: `catalog_console.py keys`
|
||||||
|
must report on whatever ref/branch is checked out at the inspected repo
|
||||||
|
path, which may not be (and need not be) importable from the running
|
||||||
|
process's own sys.path. Returns [] if the variable isn't found in this
|
||||||
|
exact shape -- callers treat that as "nothing committed here", not an
|
||||||
|
error, since a report that can't parse a file should say so plainly
|
||||||
|
rather than crash the whole `keys` command over one malformed file.
|
||||||
|
"""
|
||||||
|
match = re.search(
|
||||||
|
rf"{re.escape(var_name)}\s*:\s*list\[bytes\]\s*=\s*\[(.*?)\]", source_text, re.DOTALL
|
||||||
|
)
|
||||||
|
if not match:
|
||||||
|
return []
|
||||||
|
keys: list[bytes] = []
|
||||||
|
for b64 in _PUBKEY_LIST_B64_RE.findall(match.group(1)):
|
||||||
|
try:
|
||||||
|
keys.append(base64.b64decode(b64))
|
||||||
|
except ValueError:
|
||||||
|
continue
|
||||||
|
return keys
|
||||||
|
|
||||||
|
|
||||||
|
_CI_TRUST_ANCHOR_RE = re.compile(r'EXPECTED_CATALOG_PUBKEY_B64:\s*"([^"]+)"')
|
||||||
|
|
||||||
|
|
||||||
|
def extract_ci_trust_anchor_pubkey(ci_yml_text: str) -> bytes | None:
|
||||||
|
"""Best-effort extraction of ci.yml's `EXPECTED_CATALOG_PUBKEY_B64` trust
|
||||||
|
anchor (issue #68 finding 4) from the workflow file's TEXT. Returns None
|
||||||
|
if the constant isn't found -- the `keys` report shows that plainly
|
||||||
|
("not found in ci.yml") rather than raising.
|
||||||
|
"""
|
||||||
|
match = _CI_TRUST_ANCHOR_RE.search(ci_yml_text)
|
||||||
|
if not match:
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
return base64.b64decode(match.group(1))
|
||||||
|
except ValueError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class PubkeyLocationCheck:
|
||||||
|
"""One place in the source tree a key's public half is expected to be
|
||||||
|
committed, and whether the fingerprint(s) found there match the key
|
||||||
|
stored locally."""
|
||||||
|
|
||||||
|
location: str
|
||||||
|
committed_fingerprints: tuple[str, ...]
|
||||||
|
status: str # "match" | "mismatch" | "unknown" (no local key to compare against)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class KeyStatus:
|
||||||
|
"""Everything `catalog_console.py keys` reports about ONE signing key.
|
||||||
|
Built by key_status() below; rendered by render_key_status_report().
|
||||||
|
Never carries private key material -- every field here is safe to print.
|
||||||
|
"""
|
||||||
|
|
||||||
|
kind: str # "catalog" | "release"
|
||||||
|
display_name: str # "CATALOG" | "RELEASE"
|
||||||
|
purpose: str # one-line plain-English purpose
|
||||||
|
private_key_location: str # human-readable, e.g. "on this machine, in the OS keychain"
|
||||||
|
local_exists: bool
|
||||||
|
local_fingerprint: str | None
|
||||||
|
locations: tuple[PubkeyLocationCheck, ...]
|
||||||
|
catalog_sig_status: str | None = None # "valid" | "invalid" | "missing" | None (n/a)
|
||||||
|
|
||||||
|
|
||||||
|
def key_status(
|
||||||
|
kind: str,
|
||||||
|
*,
|
||||||
|
display_name: str,
|
||||||
|
purpose: str,
|
||||||
|
private_key_location: str,
|
||||||
|
local_exists: bool,
|
||||||
|
local_pubkey: bytes | None,
|
||||||
|
locations: list[tuple[str, list[bytes]]],
|
||||||
|
catalog_sig_status: str | None = None,
|
||||||
|
) -> KeyStatus:
|
||||||
|
"""Pure assembly of a KeyStatus from already-resolved inputs (no file or
|
||||||
|
git I/O here -- that's catalog_console.py's job). `locations` is a list
|
||||||
|
of (label, committed_pubkeys) pairs, e.g.
|
||||||
|
[("bcc_core.CATALOG_PUBKEYS", [...]), ("ci.yml trust anchor", [...])],
|
||||||
|
so a key can be checked against every place its public half is expected
|
||||||
|
to be committed, independently -- this is the check that would have
|
||||||
|
caught bcc_core.CATALOG_PUBKEYS and ci.yml's trust anchor silently
|
||||||
|
drifting apart (issue #68 finding 4 was exactly that kind of drift).
|
||||||
|
"""
|
||||||
|
checks: list[PubkeyLocationCheck] = []
|
||||||
|
for label, committed_pubkeys in locations:
|
||||||
|
fps = tuple(fingerprint_pubkey(pk) for pk in committed_pubkeys)
|
||||||
|
if local_pubkey is None:
|
||||||
|
status = "unknown"
|
||||||
|
elif local_pubkey in committed_pubkeys:
|
||||||
|
status = "match"
|
||||||
|
else:
|
||||||
|
status = "mismatch"
|
||||||
|
checks.append(
|
||||||
|
PubkeyLocationCheck(location=label, committed_fingerprints=fps, status=status)
|
||||||
|
)
|
||||||
|
|
||||||
|
return KeyStatus(
|
||||||
|
kind=kind,
|
||||||
|
display_name=display_name,
|
||||||
|
purpose=purpose,
|
||||||
|
private_key_location=private_key_location,
|
||||||
|
local_exists=local_exists,
|
||||||
|
local_fingerprint=fingerprint_pubkey(local_pubkey) if local_pubkey is not None else None,
|
||||||
|
locations=tuple(checks),
|
||||||
|
catalog_sig_status=catalog_sig_status,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
_LOCATION_STATUS_ICON = {"match": "✅", "mismatch": "❌", "unknown": "⚠️"}
|
||||||
|
_LOCATION_STATUS_VERDICT = {
|
||||||
|
"match": "MATCHES the local private key",
|
||||||
|
"mismatch": "DOES NOT MATCH the local private key",
|
||||||
|
"unknown": "cannot compare -- no local key to check against",
|
||||||
|
}
|
||||||
|
_CATALOG_SIG_STATUS_LINE = {
|
||||||
|
"valid": "✅ data/catalog.json.sig verifies under the committed CATALOG_PUBKEYS.",
|
||||||
|
"invalid": (
|
||||||
|
"❌ data/catalog.json.sig does NOT verify under the committed CATALOG_PUBKEYS -- "
|
||||||
|
"the catalog needs re-signing (Load → acknowledge all → Sign)."
|
||||||
|
),
|
||||||
|
"missing": (
|
||||||
|
"⚠️ data/catalog.json.sig is missing entirely -- the catalog has never been signed."
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def recommend_next_steps(statuses: list[KeyStatus]) -> list[str]:
|
||||||
|
"""The pure "what to do next" logic behind the keys report's closing
|
||||||
|
section -- one concrete, runnable-looking instruction per problem found,
|
||||||
|
naming the exact key involved (never just "the key"). Returns a single
|
||||||
|
reassuring line if nothing needs attention."""
|
||||||
|
steps: list[str] = []
|
||||||
|
for s in statuses:
|
||||||
|
if not s.local_exists:
|
||||||
|
flag = " --release" if s.kind == "release" else ""
|
||||||
|
steps.append(
|
||||||
|
f"{s.display_name} key has never been generated on this machine -- run "
|
||||||
|
f"`python catalog_console.py keygen{flag}`."
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
for loc in s.locations:
|
||||||
|
if loc.status == "mismatch":
|
||||||
|
steps.append(
|
||||||
|
f"{s.display_name} key's local fingerprint does not match "
|
||||||
|
f"{loc.location} -- update {loc.location} to the fingerprint shown "
|
||||||
|
"above (or, if this is unexpected, treat the committed key as "
|
||||||
|
"untrusted and investigate before doing anything else)."
|
||||||
|
)
|
||||||
|
elif loc.status == "unknown":
|
||||||
|
steps.append(
|
||||||
|
f"{s.display_name} key's local fingerprint could not be checked against "
|
||||||
|
f"{loc.location} -- re-run keygen (or, for an older install, unlock the "
|
||||||
|
"key once) so its public half is cached locally."
|
||||||
|
)
|
||||||
|
if s.kind == "catalog" and s.catalog_sig_status in ("invalid", "missing"):
|
||||||
|
steps.append(
|
||||||
|
"The catalog needs re-signing: run `python catalog_console.py gui --repo .` "
|
||||||
|
"and Load → acknowledge every entry → Sign. If main is red because "
|
||||||
|
"of a key rotation, load the branch with the rotation instead of main "
|
||||||
|
"(current-branch / --ref source) so the fix lands before merge."
|
||||||
|
)
|
||||||
|
if not steps:
|
||||||
|
steps.append("Everything is consistent -- no action needed.")
|
||||||
|
return steps
|
||||||
|
|
||||||
|
|
||||||
|
def render_key_status_report(statuses: list[KeyStatus]) -> str:
|
||||||
|
"""Render a full, plain-English-first key status report as one string.
|
||||||
|
`catalog_console.py cmd_keys` prints this verbatim -- the CLI is a thin
|
||||||
|
printer over this pure function, which is what makes the report's
|
||||||
|
content (not just its plumbing) unit-testable."""
|
||||||
|
lines: list[str] = []
|
||||||
|
for s in statuses:
|
||||||
|
lines.append(f"=== {s.display_name} KEY ===")
|
||||||
|
lines.append(s.purpose)
|
||||||
|
lines.append(f"Private half lives: {s.private_key_location}")
|
||||||
|
if s.local_exists and s.local_fingerprint:
|
||||||
|
lines.append(f"Exists locally: yes (fingerprint {s.local_fingerprint})")
|
||||||
|
elif s.local_exists:
|
||||||
|
lines.append("Exists locally: yes (fingerprint unknown -- re-run keygen to cache it)")
|
||||||
|
else:
|
||||||
|
lines.append("Exists locally: no")
|
||||||
|
for loc in s.locations:
|
||||||
|
icon = _LOCATION_STATUS_ICON.get(loc.status, "?")
|
||||||
|
fps = (
|
||||||
|
", ".join(loc.committed_fingerprints)
|
||||||
|
if loc.committed_fingerprints
|
||||||
|
else "(nothing committed here)"
|
||||||
|
)
|
||||||
|
verdict = _LOCATION_STATUS_VERDICT.get(loc.status, loc.status)
|
||||||
|
lines.append(f" {icon} {loc.location}: {fps} -- {verdict}")
|
||||||
|
if s.catalog_sig_status is not None:
|
||||||
|
lines.append(
|
||||||
|
f"Catalog signature: {_CATALOG_SIG_STATUS_LINE.get(s.catalog_sig_status, s.catalog_sig_status)}"
|
||||||
|
)
|
||||||
|
lines.append("")
|
||||||
|
|
||||||
|
lines.append("What to do next:")
|
||||||
|
for step in recommend_next_steps(statuses):
|
||||||
|
lines.append(f" - {step}")
|
||||||
|
return "\n".join(lines)
|
||||||
|
|||||||
@@ -0,0 +1,215 @@
|
|||||||
|
"""Tests for catalog_console.py's non-Qt git plumbing and ref-resolution
|
||||||
|
seam (issue #68 rotation-completability fix).
|
||||||
|
|
||||||
|
catalog_console.py is importable here WITHOUT PySide6 -- its Qt import is
|
||||||
|
guarded (`_PYSIDE6_AVAILABLE`) precisely so `keygen`, `show-seed-b64`,
|
||||||
|
`keys`, and this git plumbing stay usable (and testable) wherever PySide6
|
||||||
|
isn't installed, including this CI test job, which never installs it. If
|
||||||
|
PySide6 genuinely isn't importable in this environment, that itself
|
||||||
|
exercises the guard path -- see test_module_imports_without_pyside6.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
|
||||||
|
|
||||||
|
import catalog_console as cc
|
||||||
|
import catalog_review as review
|
||||||
|
|
||||||
|
_SEED_CATALOG = b'{"schema": 1, "version": 1, "servers": []}'
|
||||||
|
_SEED_SIG = b"\x00" * 64
|
||||||
|
|
||||||
|
|
||||||
|
def _run(*args: str, cwd: Path) -> None:
|
||||||
|
subprocess.run(["git", *args], cwd=cwd, check=True, capture_output=True)
|
||||||
|
|
||||||
|
|
||||||
|
def _init_bare_and_clone(tmp_path: Path) -> tuple[Path, Path]:
|
||||||
|
"""A bare "origin" repo with `main` and `rotation-branch` both seeded
|
||||||
|
with a catalog + (dummy) signature, plus a working clone with `origin`
|
||||||
|
already configured -- mirroring the tokened-remote clone
|
||||||
|
catalog_console.py's git plumbing is always run against."""
|
||||||
|
origin = tmp_path / "origin.git"
|
||||||
|
_run("init", "--bare", str(origin), cwd=tmp_path)
|
||||||
|
|
||||||
|
seed = tmp_path / "seed"
|
||||||
|
_run("clone", str(origin), str(seed), cwd=tmp_path)
|
||||||
|
_run("config", "user.email", "test@example.com", cwd=seed)
|
||||||
|
_run("config", "user.name", "Test", cwd=seed)
|
||||||
|
|
||||||
|
(seed / "data").mkdir()
|
||||||
|
(seed / "data" / "catalog.json").write_bytes(_SEED_CATALOG)
|
||||||
|
(seed / "data" / "catalog.json.sig").write_bytes(_SEED_SIG)
|
||||||
|
_run("add", "-A", cwd=seed)
|
||||||
|
_run("commit", "-m", "seed", cwd=seed)
|
||||||
|
_run("push", "origin", "HEAD:refs/heads/main", cwd=seed)
|
||||||
|
_run("checkout", "-b", "rotation-branch", cwd=seed)
|
||||||
|
_run("push", "origin", "HEAD:refs/heads/rotation-branch", cwd=seed)
|
||||||
|
|
||||||
|
clone = tmp_path / "work"
|
||||||
|
_run("clone", str(origin), str(clone), cwd=tmp_path)
|
||||||
|
_run("config", "user.email", "test@example.com", cwd=clone)
|
||||||
|
_run("config", "user.name", "Test", cwd=clone)
|
||||||
|
return origin, clone
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
# The module must stay importable without PySide6 -- this IS the fix that
|
||||||
|
# lets `keys`/`keygen`/`show-seed-b64` (and this whole test file) run
|
||||||
|
# somewhere PySide6 isn't installed.
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
def test_module_imports_without_pyside6():
|
||||||
|
assert hasattr(cc, "_PYSIDE6_AVAILABLE")
|
||||||
|
# This CI test job never installs PySide6 (see .github/workflows/ci.yml
|
||||||
|
# "Install test dependencies": pytest + cryptography only) -- so on CI,
|
||||||
|
# this assertion is itself proof the guard is doing its job. Locally,
|
||||||
|
# where a maintainer's env DOES have PySide6, it's fine either way; the
|
||||||
|
# only real assertion this test needs is "importing the module never
|
||||||
|
# raises", which happened just by getting this far.
|
||||||
|
assert cc._PYSIDE6_AVAILABLE in (True, False)
|
||||||
|
|
||||||
|
|
||||||
|
def test_cmd_gui_fails_soft_without_pyside6(monkeypatch, capsys):
|
||||||
|
if cc._PYSIDE6_AVAILABLE:
|
||||||
|
return # nothing to prove where PySide6 IS available
|
||||||
|
import argparse
|
||||||
|
|
||||||
|
args = argparse.Namespace(repo=".", ref=None)
|
||||||
|
assert cc.cmd_gui(args) == 1
|
||||||
|
assert "PySide6" in capsys.readouterr().err
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
# compute_own_refs: the PURE ref-resolution seam. No git, no Qt.
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
def test_compute_own_refs_defaults_to_main_only():
|
||||||
|
assert cc.compute_own_refs(None, None) == ["main"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_compute_own_refs_adds_detected_branch():
|
||||||
|
assert cc.compute_own_refs(None, "chore/68-key-rotation") == [
|
||||||
|
"main",
|
||||||
|
"chore/68-key-rotation",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def test_compute_own_refs_explicit_ref_overrides_detected_branch():
|
||||||
|
assert cc.compute_own_refs("explicit-branch", "detected-branch") == [
|
||||||
|
"main",
|
||||||
|
"explicit-branch",
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
def test_compute_own_refs_does_not_duplicate_main():
|
||||||
|
assert cc.compute_own_refs(None, "main") == ["main"]
|
||||||
|
assert cc.compute_own_refs("main", "some-other-branch") == ["main"]
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
# current_branch: git plumbing, no Qt.
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
def test_current_branch_detects_checked_out_branch(tmp_path):
|
||||||
|
_origin, clone = _init_bare_and_clone(tmp_path)
|
||||||
|
_run("fetch", "origin", "rotation-branch", cwd=clone)
|
||||||
|
_run("checkout", "-B", "rotation-branch", "origin/rotation-branch", cwd=clone)
|
||||||
|
assert cc.current_branch(clone) == "rotation-branch"
|
||||||
|
|
||||||
|
|
||||||
|
def test_current_branch_none_on_detached_head(tmp_path):
|
||||||
|
_origin, clone = _init_bare_and_clone(tmp_path)
|
||||||
|
commit = cc.fetch_ref(clone, "main")
|
||||||
|
_run("checkout", commit, cwd=clone)
|
||||||
|
assert cc.current_branch(clone) is None
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
# commit_and_push_signed_catalog: MUST target the given branch, never a
|
||||||
|
# hardcoded "main" -- issue #68's completability fix. This is exactly the
|
||||||
|
# bug that, before the fix, would have made ReviewWindow._on_sign push a
|
||||||
|
# PR/branch review's signature straight to main regardless of what was
|
||||||
|
# actually reviewed.
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
def test_commit_and_push_signed_catalog_targets_the_given_branch_not_main(tmp_path):
|
||||||
|
_origin, clone = _init_bare_and_clone(tmp_path)
|
||||||
|
|
||||||
|
new_raw = b'{"schema": 1, "version": 2, "servers": []}'
|
||||||
|
new_sig = b"\x01" * 64
|
||||||
|
cc.commit_and_push_signed_catalog(clone, new_raw, new_sig, branch="rotation-branch")
|
||||||
|
|
||||||
|
rotation_commit = cc.fetch_ref(clone, "rotation-branch")
|
||||||
|
rotation_raw, _sha = cc.read_catalog_at_commit(clone, rotation_commit)
|
||||||
|
assert rotation_raw == new_raw
|
||||||
|
|
||||||
|
# main on the shared origin must be COMPLETELY untouched by a sign that
|
||||||
|
# was reviewed and pushed against rotation-branch.
|
||||||
|
main_commit = cc.fetch_ref(clone, "main")
|
||||||
|
main_raw, _sha = cc.read_catalog_at_commit(clone, main_commit)
|
||||||
|
assert main_raw == _SEED_CATALOG
|
||||||
|
|
||||||
|
|
||||||
|
def test_commit_and_push_signed_catalog_still_defaults_to_main(tmp_path):
|
||||||
|
"""Backward-compatible default: callers that don't pass `branch` (there
|
||||||
|
are none left in catalog_console.py itself, but the signature keeps the
|
||||||
|
default for any other caller / test fixture) still push to main."""
|
||||||
|
_origin, clone = _init_bare_and_clone(tmp_path)
|
||||||
|
|
||||||
|
new_raw = b'{"schema": 1, "version": 2, "servers": []}'
|
||||||
|
new_sig = b"\x01" * 64
|
||||||
|
cc.commit_and_push_signed_catalog(clone, new_raw, new_sig)
|
||||||
|
|
||||||
|
main_commit = cc.fetch_ref(clone, "main")
|
||||||
|
main_raw, _sha = cc.read_catalog_at_commit(clone, main_commit)
|
||||||
|
assert main_raw == new_raw
|
||||||
|
|
||||||
|
rotation_commit = cc.fetch_ref(clone, "rotation-branch")
|
||||||
|
rotation_raw, _sha = cc.read_catalog_at_commit(clone, rotation_commit)
|
||||||
|
assert rotation_raw == _SEED_CATALOG # untouched
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
# catalog_sig_status_on_disk: the check behind `keys`' "does catalog.json.sig
|
||||||
|
# currently verify?" line -- this is precisely the check that would have
|
||||||
|
# caught the current chore/68-key-rotation state (bcc_core.CATALOG_PUBKEYS
|
||||||
|
# rotated, data/catalog.json.sig still signed by the retired key).
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
def test_catalog_sig_status_on_disk_valid(tmp_path):
|
||||||
|
seed, pub = review.generate_keypair()
|
||||||
|
raw = b'{"schema": 1, "version": 1, "servers": []}'
|
||||||
|
sig = review.sign_catalog_bytes(raw, seed)
|
||||||
|
|
||||||
|
(tmp_path / "data").mkdir()
|
||||||
|
(tmp_path / "data" / "catalog.json").write_bytes(raw)
|
||||||
|
(tmp_path / "data" / "catalog.json.sig").write_bytes(sig)
|
||||||
|
|
||||||
|
assert cc.catalog_sig_status_on_disk(tmp_path, [pub]) == "valid"
|
||||||
|
|
||||||
|
|
||||||
|
def test_catalog_sig_status_on_disk_invalid_when_pubkey_rotated(tmp_path):
|
||||||
|
"""The exact chore/68-key-rotation scenario: signed by an OLD key, but
|
||||||
|
the committed pubkey list now only has the NEW key."""
|
||||||
|
old_seed, _old_pub = review.generate_keypair()
|
||||||
|
_new_seed, new_pub = review.generate_keypair()
|
||||||
|
raw = b'{"schema": 1, "version": 1, "servers": []}'
|
||||||
|
sig = review.sign_catalog_bytes(raw, old_seed)
|
||||||
|
|
||||||
|
(tmp_path / "data").mkdir()
|
||||||
|
(tmp_path / "data" / "catalog.json").write_bytes(raw)
|
||||||
|
(tmp_path / "data" / "catalog.json.sig").write_bytes(sig)
|
||||||
|
|
||||||
|
assert cc.catalog_sig_status_on_disk(tmp_path, [new_pub]) == "invalid"
|
||||||
|
|
||||||
|
|
||||||
|
def test_catalog_sig_status_on_disk_missing_when_no_sig_file(tmp_path):
|
||||||
|
(tmp_path / "data").mkdir()
|
||||||
|
(tmp_path / "data" / "catalog.json").write_bytes(b"{}")
|
||||||
|
assert cc.catalog_sig_status_on_disk(tmp_path, []) == "missing"
|
||||||
|
|
||||||
|
|
||||||
|
def test_catalog_sig_status_on_disk_missing_when_no_catalog_file(tmp_path):
|
||||||
|
(tmp_path / "data").mkdir()
|
||||||
|
(tmp_path / "data" / "catalog.json.sig").write_bytes(b"\x00" * 64)
|
||||||
|
assert cc.catalog_sig_status_on_disk(tmp_path, []) == "missing"
|
||||||
@@ -785,3 +785,245 @@ def test_contains_non_ascii_true():
|
|||||||
|
|
||||||
def test_contains_non_ascii_false():
|
def test_contains_non_ascii_false():
|
||||||
assert r.contains_non_ascii("package") is False
|
assert r.contains_non_ascii("package") is False
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
# fingerprint_pubkey
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
def test_fingerprint_pubkey_is_deterministic():
|
||||||
|
pub = b"\x01" * 32
|
||||||
|
assert r.fingerprint_pubkey(pub) == r.fingerprint_pubkey(pub)
|
||||||
|
|
||||||
|
|
||||||
|
def test_fingerprint_pubkey_differs_for_different_keys():
|
||||||
|
assert r.fingerprint_pubkey(b"\x01" * 32) != r.fingerprint_pubkey(b"\x02" * 32)
|
||||||
|
|
||||||
|
|
||||||
|
def test_fingerprint_pubkey_never_contains_the_key_bytes_themselves():
|
||||||
|
pub = b"\x42" * 32
|
||||||
|
fp = r.fingerprint_pubkey(pub)
|
||||||
|
assert pub.hex() not in fp.lower().replace(" ", "")
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
# extract_pubkey_list_literal / extract_ci_trust_anchor_pubkey: text parsing
|
||||||
|
# for `catalog_console.py keys`, exercised here with no file I/O.
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
def test_extract_pubkey_list_literal_single_key():
|
||||||
|
_seed, pub = r.generate_keypair()
|
||||||
|
import base64
|
||||||
|
|
||||||
|
text = (
|
||||||
|
"CATALOG_PUBKEYS: list[bytes] = [\n"
|
||||||
|
f' base64.b64decode("{base64.b64encode(pub).decode()}"),\n'
|
||||||
|
"]\n"
|
||||||
|
)
|
||||||
|
assert r.extract_pubkey_list_literal(text, "CATALOG_PUBKEYS") == [pub]
|
||||||
|
|
||||||
|
|
||||||
|
def test_extract_pubkey_list_literal_multiple_keys():
|
||||||
|
import base64
|
||||||
|
|
||||||
|
pubs = [r.generate_keypair()[1] for _ in range(2)]
|
||||||
|
body = ",\n".join(f' base64.b64decode("{base64.b64encode(p).decode()}")' for p in pubs)
|
||||||
|
text = f"RELEASE_PUBKEYS: list[bytes] = [\n{body},\n]\n"
|
||||||
|
assert r.extract_pubkey_list_literal(text, "RELEASE_PUBKEYS") == pubs
|
||||||
|
|
||||||
|
|
||||||
|
def test_extract_pubkey_list_literal_missing_variable_returns_empty():
|
||||||
|
assert r.extract_pubkey_list_literal("some unrelated text", "CATALOG_PUBKEYS") == []
|
||||||
|
|
||||||
|
|
||||||
|
def test_extract_pubkey_list_literal_does_not_match_a_different_variable():
|
||||||
|
import base64
|
||||||
|
|
||||||
|
_seed, pub = r.generate_keypair()
|
||||||
|
text = f'OTHER_PUBKEYS: list[bytes] = [base64.b64decode("{base64.b64encode(pub).decode()}")]\n'
|
||||||
|
assert r.extract_pubkey_list_literal(text, "CATALOG_PUBKEYS") == []
|
||||||
|
|
||||||
|
|
||||||
|
def test_extract_ci_trust_anchor_pubkey_found():
|
||||||
|
import base64
|
||||||
|
|
||||||
|
_seed, pub = r.generate_keypair()
|
||||||
|
text = f' EXPECTED_CATALOG_PUBKEY_B64: "{base64.b64encode(pub).decode()}"\n'
|
||||||
|
assert r.extract_ci_trust_anchor_pubkey(text) == pub
|
||||||
|
|
||||||
|
|
||||||
|
def test_extract_ci_trust_anchor_pubkey_missing_returns_none():
|
||||||
|
assert r.extract_ci_trust_anchor_pubkey("no anchor here") is None
|
||||||
|
|
||||||
|
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
# key_status / render_key_status_report / recommend_next_steps
|
||||||
|
# --------------------------------------------------------------------------- #
|
||||||
|
def _kw(**overrides):
|
||||||
|
base = dict(
|
||||||
|
kind="catalog",
|
||||||
|
display_name="CATALOG",
|
||||||
|
purpose="Signs the catalog.",
|
||||||
|
private_key_location="on this machine",
|
||||||
|
local_exists=True,
|
||||||
|
local_pubkey=b"\x01" * 32,
|
||||||
|
locations=[("bcc_core.CATALOG_PUBKEYS", [b"\x01" * 32])],
|
||||||
|
catalog_sig_status="valid",
|
||||||
|
)
|
||||||
|
base.update(overrides)
|
||||||
|
return base
|
||||||
|
|
||||||
|
|
||||||
|
def test_key_status_reports_match_when_local_pubkey_in_committed_list():
|
||||||
|
status = r.key_status(**_kw())
|
||||||
|
assert status.locations[0].status == "match"
|
||||||
|
|
||||||
|
|
||||||
|
def test_key_status_reports_mismatch_when_local_pubkey_not_in_committed_list():
|
||||||
|
status = r.key_status(**_kw(locations=[("bcc_core.CATALOG_PUBKEYS", [b"\x02" * 32])]))
|
||||||
|
assert status.locations[0].status == "mismatch"
|
||||||
|
|
||||||
|
|
||||||
|
def test_key_status_reports_unknown_when_no_local_pubkey():
|
||||||
|
status = r.key_status(**_kw(local_pubkey=None, local_exists=False))
|
||||||
|
assert status.locations[0].status == "unknown"
|
||||||
|
assert status.local_fingerprint is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_key_status_never_carries_a_local_fingerprint_when_key_absent():
|
||||||
|
status = r.key_status(**_kw(local_pubkey=None, local_exists=False))
|
||||||
|
assert status.local_exists is False
|
||||||
|
assert status.local_fingerprint is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_key_status_fingerprint_matches_fingerprint_pubkey_helper():
|
||||||
|
pub = b"\x03" * 32
|
||||||
|
status = r.key_status(**_kw(local_pubkey=pub, locations=[("x", [pub])]))
|
||||||
|
assert status.local_fingerprint == r.fingerprint_pubkey(pub)
|
||||||
|
|
||||||
|
|
||||||
|
def test_key_status_checks_multiple_locations_independently():
|
||||||
|
"""A key can match one committed location and mismatch another -- this
|
||||||
|
is exactly the drift issue #68 finding 4 was about (bcc_core.py and
|
||||||
|
ci.yml silently disagreeing on the trust anchor)."""
|
||||||
|
pub = b"\x04" * 32
|
||||||
|
other = b"\x05" * 32
|
||||||
|
status = r.key_status(
|
||||||
|
**_kw(
|
||||||
|
local_pubkey=pub,
|
||||||
|
locations=[
|
||||||
|
("bcc_core.CATALOG_PUBKEYS", [pub]),
|
||||||
|
("ci.yml trust anchor", [other]),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
)
|
||||||
|
assert status.locations[0].status == "match"
|
||||||
|
assert status.locations[1].status == "mismatch"
|
||||||
|
|
||||||
|
|
||||||
|
def test_recommend_next_steps_flags_never_generated_key():
|
||||||
|
status = r.key_status(**_kw(local_exists=False, local_pubkey=None, locations=[]))
|
||||||
|
steps = r.recommend_next_steps([status])
|
||||||
|
assert any("keygen" in s and "CATALOG" in s for s in steps)
|
||||||
|
|
||||||
|
|
||||||
|
def test_recommend_next_steps_release_key_uses_release_flag():
|
||||||
|
status = r.key_status(
|
||||||
|
kind="release",
|
||||||
|
display_name="RELEASE",
|
||||||
|
purpose="Signs checksums.",
|
||||||
|
private_key_location="not generated yet",
|
||||||
|
local_exists=False,
|
||||||
|
local_pubkey=None,
|
||||||
|
locations=[],
|
||||||
|
)
|
||||||
|
steps = r.recommend_next_steps([status])
|
||||||
|
assert any("keygen --release" in s for s in steps)
|
||||||
|
|
||||||
|
|
||||||
|
def test_recommend_next_steps_flags_mismatch_by_location_name():
|
||||||
|
status = r.key_status(**_kw(locations=[("bcc_core.CATALOG_PUBKEYS", [b"\x99" * 32])]))
|
||||||
|
steps = r.recommend_next_steps([status])
|
||||||
|
assert any("bcc_core.CATALOG_PUBKEYS" in s and "CATALOG" in s for s in steps)
|
||||||
|
|
||||||
|
|
||||||
|
def test_recommend_next_steps_flags_invalid_catalog_signature():
|
||||||
|
status = r.key_status(**_kw(catalog_sig_status="invalid"))
|
||||||
|
steps = r.recommend_next_steps([status])
|
||||||
|
assert any("re-signing" in s for s in steps)
|
||||||
|
|
||||||
|
|
||||||
|
def test_recommend_next_steps_flags_missing_catalog_signature():
|
||||||
|
status = r.key_status(**_kw(catalog_sig_status="missing"))
|
||||||
|
steps = r.recommend_next_steps([status])
|
||||||
|
assert any("re-signing" in s for s in steps)
|
||||||
|
|
||||||
|
|
||||||
|
def test_recommend_next_steps_all_clear_when_nothing_wrong():
|
||||||
|
status = r.key_status(**_kw())
|
||||||
|
steps = r.recommend_next_steps([status])
|
||||||
|
assert steps == ["Everything is consistent -- no action needed."]
|
||||||
|
|
||||||
|
|
||||||
|
def test_recommend_next_steps_release_key_has_no_catalog_signature_advice():
|
||||||
|
"""A mismatched RELEASE key must never trigger catalog-signing advice --
|
||||||
|
the two keys' remediation paths must not bleed into each other."""
|
||||||
|
status = r.key_status(
|
||||||
|
kind="release",
|
||||||
|
display_name="RELEASE",
|
||||||
|
purpose="Signs checksums.",
|
||||||
|
private_key_location="on this machine",
|
||||||
|
local_exists=True,
|
||||||
|
local_pubkey=b"\x06" * 32,
|
||||||
|
locations=[("scripts/sign_checksums.py RELEASE_PUBKEYS", [b"\x07" * 32])],
|
||||||
|
catalog_sig_status=None,
|
||||||
|
)
|
||||||
|
steps = r.recommend_next_steps([status])
|
||||||
|
assert not any("re-signing" in s for s in steps)
|
||||||
|
assert any("RELEASE" in s for s in steps)
|
||||||
|
|
||||||
|
|
||||||
|
def test_render_key_status_report_never_prints_private_key_material():
|
||||||
|
"""The report string must be built ONLY from public inputs. Sanity
|
||||||
|
check: no field on KeyStatus/PubkeyLocationCheck is capable of holding
|
||||||
|
private key bytes in the first place (there's no such field to leak),
|
||||||
|
and the render function only touches fields that exist -- this test
|
||||||
|
guards against a future field addition reintroducing that risk."""
|
||||||
|
status = r.key_status(**_kw())
|
||||||
|
text = r.render_key_status_report([status])
|
||||||
|
assert "CATALOG" in text
|
||||||
|
assert (
|
||||||
|
"purpose" not in text.lower() or "Signs the catalog." in text
|
||||||
|
) # sanity, not a real secret
|
||||||
|
# No 64-hex-char (or longer) run anywhere -- a raw 32-byte seed/sig
|
||||||
|
# would show up as one if it were ever accidentally interpolated in.
|
||||||
|
import re as _re
|
||||||
|
|
||||||
|
assert not _re.search(r"[0-9a-fA-F]{64,}", text)
|
||||||
|
|
||||||
|
|
||||||
|
def test_render_key_status_report_names_the_specific_key_not_generic_the_key():
|
||||||
|
status = r.key_status(**_kw())
|
||||||
|
text = r.render_key_status_report([status])
|
||||||
|
assert "CATALOG KEY" in text
|
||||||
|
assert "the key" not in text.lower()
|
||||||
|
|
||||||
|
|
||||||
|
def test_render_key_status_report_includes_catalog_signature_line_only_for_catalog():
|
||||||
|
catalog_status = r.key_status(**_kw())
|
||||||
|
release_status = r.key_status(
|
||||||
|
kind="release",
|
||||||
|
display_name="RELEASE",
|
||||||
|
purpose="Signs checksums.",
|
||||||
|
private_key_location="on this machine",
|
||||||
|
local_exists=True,
|
||||||
|
local_pubkey=b"\x08" * 32,
|
||||||
|
locations=[("scripts/sign_checksums.py RELEASE_PUBKEYS", [b"\x08" * 32])],
|
||||||
|
catalog_sig_status=None,
|
||||||
|
)
|
||||||
|
text = r.render_key_status_report([catalog_status, release_status])
|
||||||
|
assert text.count("Catalog signature:") == 1
|
||||||
|
|
||||||
|
|
||||||
|
def test_render_key_status_report_ends_with_what_to_do_next_section():
|
||||||
|
status = r.key_status(**_kw())
|
||||||
|
text = r.render_key_status_report([status])
|
||||||
|
assert "What to do next:" in text
|
||||||
|
|||||||
Reference in New Issue
Block a user