Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| aa40f8e139 | |||
| 4836c6cb48 | |||
| cd2ac2f6f8 | |||
| 26c66b7db1 | |||
| 86139100eb | |||
| 38f14deeff |
@@ -95,12 +95,39 @@ jobs:
|
||||
- name: Install dependencies
|
||||
run: pip install cryptography
|
||||
|
||||
# 🔴 TRUST ANCHOR — issue #68 finding 4.
|
||||
#
|
||||
# This step used to do `import bcc_core as c` FROM THE CHECKED-OUT PR
|
||||
# BRANCH and verify the catalog against c.CATALOG_PUBKEYS — i.e. it
|
||||
# trusted the public key shipped in the very diff it was reviewing. A
|
||||
# PR that changed data/catalog.json AND bcc_core.CATALOG_PUBKEYS (to
|
||||
# an attacker key, with a matching signature produced by the attacker's
|
||||
# matching private key) went green, because there was nothing outside
|
||||
# the PR's own content to check the key against. The gate's whole
|
||||
# point is catching a friendly-looking PR the maintainer merges
|
||||
# without really reading it — and that hole made it a two-file diff.
|
||||
#
|
||||
# EXPECTED_CATALOG_PUBKEY_B64 below is hardcoded HERE, in the workflow
|
||||
# file, independent of whatever bcc_core.py says on the PR branch. It
|
||||
# is intentionally the only line in this step that matters for
|
||||
# security review: changing it changes what this gate is willing to
|
||||
# trust. THIS CONSTANT IS A TRUST ANCHOR. A PR that changes this line
|
||||
# in the same diff as a catalog change is exactly the attack this gate
|
||||
# exists to prevent — review a change to this line on its own,
|
||||
# never bundled with a catalog update.
|
||||
#
|
||||
# NOTE for the next key rotation: update EXPECTED_CATALOG_PUBKEY_B64
|
||||
# below to the new key's base64 form, as its own reviewed change.
|
||||
- name: Verify data/catalog.json.sig
|
||||
env:
|
||||
EXPECTED_CATALOG_PUBKEY_B64: "0s24PmkZcTT5yxNDdyTPHl5fyxArrHNPJKBjnXoQd8k="
|
||||
run: |
|
||||
python - <<'PY'
|
||||
import pathlib, sys
|
||||
import base64, os, pathlib, sys
|
||||
import bcc_core as c
|
||||
|
||||
expected_pubkey_b64 = os.environ["EXPECTED_CATALOG_PUBKEY_B64"]
|
||||
|
||||
raw = pathlib.Path("data/catalog.json").read_bytes()
|
||||
sig_path = pathlib.Path("data/catalog.json.sig")
|
||||
|
||||
@@ -111,6 +138,26 @@ jobs:
|
||||
if b"\x00" * 32 in c.CATALOG_PUBKEYS:
|
||||
sys.exit("FAIL: CATALOG_PUBKEYS still holds the placeholder key.")
|
||||
|
||||
# Trust anchor check FIRST, before verifying anything against
|
||||
# bcc_core.CATALOG_PUBKEYS: a PR is not allowed to bring its own
|
||||
# key. CATALOG_PUBKEYS on the checked-out branch must be EXACTLY
|
||||
# the key(s) this workflow file itself expects -- no more, no
|
||||
# fewer, no substitutions.
|
||||
actual_pubkeys_b64 = [base64.b64encode(k).decode() for k in c.CATALOG_PUBKEYS]
|
||||
if actual_pubkeys_b64 != [expected_pubkey_b64]:
|
||||
sys.exit(
|
||||
"FAIL: bcc_core.CATALOG_PUBKEYS on this branch does not match the "
|
||||
"trust anchor hardcoded in .github/workflows/ci.yml.\n"
|
||||
f" expected: {[expected_pubkey_b64]}\n"
|
||||
f" actual: {actual_pubkeys_b64}\n"
|
||||
"\n"
|
||||
"This PR is changing (or has changed) the catalog signing key. That "
|
||||
"change must be reviewed on its own, separately from any catalog "
|
||||
"content change, and the workflow's EXPECTED_CATALOG_PUBKEY_B64 "
|
||||
"updated deliberately -- not accepted because it happened to match "
|
||||
"whatever bcc_core.py says on this branch."
|
||||
)
|
||||
|
||||
if not c.verify_catalog_signature(raw, sig_path.read_bytes(), c.CATALOG_PUBKEYS):
|
||||
sys.exit(
|
||||
"FAIL: data/catalog.json does NOT match its signature.\n"
|
||||
@@ -124,5 +171,6 @@ jobs:
|
||||
if problems:
|
||||
sys.exit("FAIL: catalog failed validation:\n " + "\n ".join(problems))
|
||||
|
||||
print("OK: catalog signature verifies and the catalog validates clean.")
|
||||
print("OK: catalog signature verifies, the pubkey matches the CI trust anchor, "
|
||||
"and the catalog validates clean.")
|
||||
PY
|
||||
|
||||
@@ -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` |
|
||||
| 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
|
||||
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
|
||||
@@ -110,12 +125,29 @@ refuses to run without `--release` specifically so the catalog seed can't
|
||||
be exported by habit or muscle memory.
|
||||
|
||||
**Release signing public key** (Ed25519, base64, raw 32 bytes) — this is
|
||||
the RELEASE key, not the catalog key:
|
||||
the RELEASE key, which signs `SHA256SUMS` (release checksums). It does
|
||||
**not** sign `data/catalog.json` and is not the key `bcc_core.CATALOG_PUBKEYS`
|
||||
trusts:
|
||||
|
||||
```
|
||||
<PLACEHOLDER — AJ: paste the release public key from `catalog_console.py keygen --release` here>
|
||||
6BnPgJEHJFyVltFoLTCNadIsehjy00iiW8IRlC1TfhA=
|
||||
```
|
||||
|
||||
The catalog public key (Ed25519, base64, raw 32 bytes) — this is the key
|
||||
that signs `data/catalog.json` and is trusted via `bcc_core.CATALOG_PUBKEYS`
|
||||
and the CI trust anchor in `.github/workflows/ci.yml`. It is listed here
|
||||
for completeness, not because you need it to verify a download — use the
|
||||
*release* key above for that:
|
||||
|
||||
```
|
||||
0s24PmkZcTT5yxNDdyTPHl5fyxArrHNPJKBjnXoQd8k=
|
||||
```
|
||||
|
||||
Both keys above were rotated 2026-07 — see [issue #68](../../issues/68)
|
||||
finding 5. The prior (shared) key is retired and is deliberately **not**
|
||||
kept in either trust list; retaining a burned key would defeat the point
|
||||
of rotating it.
|
||||
|
||||
## Run from source
|
||||
|
||||
```bash
|
||||
@@ -190,7 +222,7 @@ file is also listed, marked *legacy*, so you can copy them over.
|
||||
- `bcc.spec` — PyInstaller build spec (cross-platform).
|
||||
- `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)).
|
||||
- `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
|
||||
|
||||
|
||||
+297
-38
@@ -2164,12 +2164,36 @@ def restart_claude_desktop() -> RestartResult:
|
||||
# is rejected by validate_catalog() regardless of how plausible it looks.
|
||||
CATALOG_ALLOWED_COMMANDS = frozenset({"npx", "uvx", "docker", "node", "python", "python3"})
|
||||
|
||||
# Env var keys a catalog entry's config.env must never set. Every one of
|
||||
# these is a loader/interpreter override that lets a value walk straight
|
||||
# past CATALOG_ALLOWED_COMMANDS and the -e/--eval/-c deny-rule below: e.g.
|
||||
# NODE_OPTIONS="--require /tmp/x.js" turns an allowlisted `npx` entry into
|
||||
# arbitrary code execution without ever touching config.args, which is the
|
||||
# only field the allowlist/deny-rules/ASCII/secret checks used to cover.
|
||||
# Matched case-insensitively -- env keys are case-sensitive on POSIX, but a
|
||||
# `node_options` lookalike is exactly the kind of thing this must catch.
|
||||
CATALOG_DENIED_ENV_KEYS = frozenset(
|
||||
{
|
||||
"NODE_OPTIONS",
|
||||
"PYTHONSTARTUP",
|
||||
"PYTHONPATH",
|
||||
"PYTHONHOME",
|
||||
"LD_PRELOAD",
|
||||
"LD_LIBRARY_PATH",
|
||||
"DYLD_INSERT_LIBRARIES",
|
||||
"DYLD_LIBRARY_PATH",
|
||||
"BROWSER",
|
||||
"PATH",
|
||||
"NODE_REPL_EXTERNAL_MODULE",
|
||||
}
|
||||
)
|
||||
|
||||
# Ed25519 public keys allowed to sign a catalog, raw 32-byte form. A LIST
|
||||
# (not a single key) so keys can be rotated without bricking installs that
|
||||
# still trust an older key: verify_catalog_signature() accepts a match
|
||||
# against ANY key in this list.
|
||||
CATALOG_PUBKEYS: list[bytes] = [
|
||||
base64.b64decode("082NOwVB7uURkvfyS3+knJ+40Fk6C9unsF47+2uPKo4="),
|
||||
base64.b64decode("0s24PmkZcTT5yxNDdyTPHl5fyxArrHNPJKBjnXoQd8k="),
|
||||
]
|
||||
|
||||
# Domain-separation prefix for the signed message. The signature covers
|
||||
@@ -2189,6 +2213,36 @@ _CATALOG_SECRET_ARG_RE = re.compile(r"(?i)--api[-_]?key=|--token=|--password=")
|
||||
# <PLACEHOLDER>-style tokens the GUI must have the user fill in before Save.
|
||||
_PLACEHOLDER_RE = re.compile(r"<[^<>\s]+>")
|
||||
|
||||
# A catalog entry's id becomes an mcpServers JSON key AND is interpolated
|
||||
# into Qt.AutoText widgets (status bar, QMessageBox) -- an id like
|
||||
# "<b>Verified</b>" renders as markup there. Not RCE, but UI spoofing, so
|
||||
# ids are constrained to a plain lowercase slug.
|
||||
_CATALOG_ID_RE = re.compile(r"^[a-z0-9][a-z0-9._-]{0,63}$")
|
||||
|
||||
# Docker flags that consume the next arg as a value (so that value must not
|
||||
# be mistaken for the image reference when locating it in config.args).
|
||||
_DOCKER_VALUE_FLAGS = frozenset(
|
||||
{
|
||||
"-e",
|
||||
"--env",
|
||||
"-v",
|
||||
"--volume",
|
||||
"-p",
|
||||
"--publish",
|
||||
"--name",
|
||||
"-w",
|
||||
"--workdir",
|
||||
"-u",
|
||||
"--user",
|
||||
"--entrypoint",
|
||||
"--network",
|
||||
"--platform",
|
||||
"--add-host",
|
||||
"-l",
|
||||
"--label",
|
||||
}
|
||||
)
|
||||
|
||||
# How many versions a single accepted catalog jump may leap in one go. Bounds
|
||||
# a "freeze" attack: a compromised/leaked signing key claiming an absurd
|
||||
# future version would otherwise permanently outrank every legitimate
|
||||
@@ -2263,6 +2317,121 @@ def _docker_arg_violations(tag: str, args: list[str]) -> list[str]:
|
||||
return problems
|
||||
|
||||
|
||||
def _catalog_package_spec_version(spec: str) -> str | None:
|
||||
"""
|
||||
Extract the version pin from an npm-style package spec, or None if the
|
||||
spec carries no pin.
|
||||
|
||||
Handles unscoped "name@version" and scoped "@scope/name@version" --
|
||||
scoped names have a leading "@" that is NOT the version separator, so a
|
||||
naive split on the first/only "@" misparses "@scope/pkg" (no version)
|
||||
as pinned to "scope/pkg". Splitting from the right side instead is safe
|
||||
for both forms because a package name may contain "@" only as the
|
||||
scope's leading character.
|
||||
"""
|
||||
if spec.startswith("@"):
|
||||
rest = spec[1:]
|
||||
if "@" not in rest:
|
||||
return None
|
||||
_, _, version = rest.rpartition("@")
|
||||
return version or None
|
||||
if "@" not in spec:
|
||||
return None
|
||||
_, _, version = spec.rpartition("@")
|
||||
return version or None
|
||||
|
||||
|
||||
def _catalog_package_spec_pinned(spec: str) -> bool:
|
||||
"""
|
||||
True if `spec` carries an exact version pin. Covers npm's "name@version"
|
||||
/ "@scope/name@version" and uv's documented PyPI pin forms
|
||||
"name@version" and "name==version".
|
||||
"""
|
||||
if "==" in spec:
|
||||
_, _, version = spec.partition("==")
|
||||
return bool(version)
|
||||
return bool(_catalog_package_spec_version(spec))
|
||||
|
||||
|
||||
def _first_catalog_package_spec(args: list[str]) -> str | None:
|
||||
"""
|
||||
The first arg that could plausibly BE a package spec: skip flags
|
||||
(leading "-") and <PLACEHOLDER> tokens (which can't be validated and
|
||||
are filled in by the user later, never shipped by the catalog as the
|
||||
package name itself). Everything after the first hit is ignored --
|
||||
trailing flags, paths, and placeholders are not package specs.
|
||||
"""
|
||||
for a in args:
|
||||
if a.startswith("-"):
|
||||
continue
|
||||
if _PLACEHOLDER_RE.fullmatch(a):
|
||||
continue
|
||||
return a
|
||||
return None
|
||||
|
||||
|
||||
def _catalog_pin_violations(tag: str, command: str, args: list[str]) -> list[str]:
|
||||
"""
|
||||
Version-pinning enforcement (finding #3): a catalog PR can otherwise
|
||||
ship `npx -y @scope/pkg` or `docker run img:latest` and the *next*
|
||||
resolve of that package/image is whatever the registry serves that day
|
||||
-- outside review, outside the signature's meaning. This is the only
|
||||
place that enforces pinning at runtime; catalog_review.py's
|
||||
risk_unpinned_package() is a maintainer-facing hint, not a gate.
|
||||
"""
|
||||
if command in ("npx", "uvx"):
|
||||
spec = _first_catalog_package_spec(args)
|
||||
if spec is None:
|
||||
return [f"{tag}: config.args must include a package spec to pin (e.g. name@1.2.3)."]
|
||||
if not _catalog_package_spec_pinned(spec):
|
||||
return [
|
||||
f"{tag}: config.args package {spec!r} is not version-pinned; use "
|
||||
"name@version, @scope/name@version, or name==version."
|
||||
]
|
||||
return []
|
||||
|
||||
if command == "docker":
|
||||
image = _docker_image_ref(args)
|
||||
if image is None:
|
||||
return [f"{tag}: config.args docker command has no image reference to pin."]
|
||||
_, sep, image_tag = image.rpartition(":")
|
||||
if not sep or "/" in image_tag:
|
||||
return [
|
||||
f"{tag}: config.args docker image {image!r} has no explicit tag; "
|
||||
"pin an exact version (not 'latest', not untagged)."
|
||||
]
|
||||
if image_tag == "latest":
|
||||
return [
|
||||
f"{tag}: config.args docker image {image!r} uses the 'latest' tag, "
|
||||
"which is not allowed; pin an exact version."
|
||||
]
|
||||
return []
|
||||
|
||||
return []
|
||||
|
||||
|
||||
def _docker_image_ref(args: list[str]) -> str | None:
|
||||
"""
|
||||
Locate the image reference in a `docker run ...` args list: skip the
|
||||
"run" subcommand and any flags, including ones that consume the next
|
||||
token as a value (-e, -v, --name, ...) so that value isn't mistaken for
|
||||
the image. The first remaining positional token is the image.
|
||||
"""
|
||||
i = 0
|
||||
if i < len(args) and args[i] == "run":
|
||||
i += 1
|
||||
while i < len(args):
|
||||
a = args[i]
|
||||
if a.startswith("-"):
|
||||
if a in _DOCKER_VALUE_FLAGS and "=" not in a:
|
||||
i += 2
|
||||
else:
|
||||
i += 1
|
||||
continue
|
||||
return a
|
||||
return None
|
||||
|
||||
|
||||
def _validate_catalog_config(tag: str, config) -> list[str]:
|
||||
"""Validate the `config` block of a basic-tier catalog entry."""
|
||||
if not isinstance(config, dict):
|
||||
@@ -2283,10 +2452,11 @@ def _validate_catalog_config(tag: str, config) -> list[str]:
|
||||
f"({', '.join(sorted(CATALOG_ALLOWED_COMMANDS))})."
|
||||
)
|
||||
|
||||
args = config.get("args")
|
||||
if not isinstance(args, list) or not all(isinstance(a, str) for a in args):
|
||||
raw_args = config.get("args")
|
||||
args_ok = isinstance(raw_args, list) and all(isinstance(a, str) for a in raw_args)
|
||||
args = raw_args if args_ok else []
|
||||
if not args_ok:
|
||||
problems.append(f"{tag}: config.args must be a list of strings.")
|
||||
args = []
|
||||
|
||||
for a in args:
|
||||
if not a.isascii():
|
||||
@@ -2305,11 +2475,55 @@ def _validate_catalog_config(tag: str, config) -> list[str]:
|
||||
if command == "docker":
|
||||
problems.extend(_docker_arg_violations(tag, args))
|
||||
|
||||
# Version pinning (finding #3) -- only meaningful once command/args are
|
||||
# actually well-formed; a malformed args list already got its own
|
||||
# problem above and has nothing left to pin-check.
|
||||
if args_ok and command in ("npx", "uvx", "docker"):
|
||||
problems.extend(_catalog_pin_violations(tag, command, args))
|
||||
|
||||
env = config.get("env")
|
||||
if env is not None and (
|
||||
not isinstance(env, dict) or any(not isinstance(v, str) for v in env.values())
|
||||
):
|
||||
if env is not None:
|
||||
env_ok = isinstance(env, dict) and all(
|
||||
isinstance(k, str) and isinstance(v, str) for k, v in env.items()
|
||||
)
|
||||
if not env_ok:
|
||||
problems.append(f"{tag}: config.env must be an object of string values.")
|
||||
else:
|
||||
# config.env (finding #2): unlike args, env was previously
|
||||
# type-checked ONLY -- no allowlist, no deny-rule, no ASCII
|
||||
# check, no secret check. That made it the single easiest way
|
||||
# to smuggle a payload past every other guard in this
|
||||
# function: an allowlisted `command: npx` plus
|
||||
# NODE_OPTIONS=--require /tmp/x.js in env walks straight past
|
||||
# the command allowlist AND the -e/--eval/-c deny-rule above,
|
||||
# because neither of those ever looks at env.
|
||||
for key, value in env.items():
|
||||
if not key.isascii():
|
||||
problems.append(
|
||||
f"{tag}: config.env key {key!r} must be ASCII "
|
||||
"(non-ASCII code points rejected)."
|
||||
)
|
||||
if key.upper() in CATALOG_DENIED_ENV_KEYS:
|
||||
problems.append(
|
||||
f"{tag}: config.env key {key!r} is on the catalog deny-list "
|
||||
"(interpreter/loader override) and is not allowed."
|
||||
)
|
||||
if not value.isascii():
|
||||
problems.append(
|
||||
f"{tag}: config.env value for {key!r} must be ASCII "
|
||||
"(non-ASCII code points rejected)."
|
||||
)
|
||||
if _is_secret_value(value):
|
||||
problems.append(
|
||||
f"{tag}: config.env[{key!r}] looks like a real secret value; "
|
||||
"catalog entries must never ship secret values."
|
||||
)
|
||||
if value != "" and not _PLACEHOLDER_RE.fullmatch(value):
|
||||
problems.append(
|
||||
f"{tag}: config.env[{key!r}] must be an empty string or a "
|
||||
"single <PLACEHOLDER> token -- the catalog declares which env "
|
||||
"vars a server needs, it never supplies their values."
|
||||
)
|
||||
|
||||
return problems
|
||||
|
||||
@@ -2329,6 +2543,12 @@ def _validate_catalog_entry(idx: int, entry, seen_ids: set[str]) -> list[str]:
|
||||
tag = f"servers[{idx}] ({entry_id!r})"
|
||||
if not entry_id.isascii():
|
||||
problems.append(f"{tag}: 'id' must be ASCII (non-ASCII code points rejected).")
|
||||
elif not _CATALOG_ID_RE.match(entry_id):
|
||||
problems.append(
|
||||
f"{tag}: 'id' must match ^[a-z0-9][a-z0-9._-]{{0,63}}$ "
|
||||
"(it becomes an mcpServers JSON key and is interpolated into "
|
||||
"Qt.AutoText widgets)."
|
||||
)
|
||||
if entry_id in seen_ids:
|
||||
problems.append(f"{tag}: duplicate id.")
|
||||
seen_ids.add(entry_id)
|
||||
@@ -2442,15 +2662,32 @@ def verify_catalog_signature(raw: bytes, sig: bytes, pubkeys: list[bytes]) -> bo
|
||||
return False
|
||||
|
||||
|
||||
def _verify_catalog_candidate(candidate: tuple[bytes, bytes] | None) -> tuple[dict | None, int]:
|
||||
"""Verify+load+validate one (raw, sig) candidate. Returns (None, -1) on any failure."""
|
||||
if not candidate:
|
||||
return None, -1
|
||||
raw, sig = candidate
|
||||
if not verify_catalog_signature(raw, sig, CATALOG_PUBKEYS):
|
||||
return None, -1
|
||||
try:
|
||||
data = load_catalog(raw)
|
||||
except (ValueError, TypeError):
|
||||
return None, -1
|
||||
if validate_catalog(data):
|
||||
return None, -1
|
||||
return data, catalog_version(data)
|
||||
|
||||
|
||||
def resolve_catalog(
|
||||
bundled: tuple[bytes, bytes] | None,
|
||||
cached: tuple[bytes, bytes] | None,
|
||||
remote: tuple[bytes, bytes] | None,
|
||||
floor: int = 0,
|
||||
) -> dict:
|
||||
"""
|
||||
Pick the highest-version catalog among bundled/cached/remote. Each
|
||||
argument is either None (unavailable) or an (raw_bytes, signature_bytes)
|
||||
pair.
|
||||
Pick the highest-version catalog among bundled/cached/remote. Each of
|
||||
bundled/cached/remote is either None (unavailable) or an (raw_bytes,
|
||||
signature_bytes) pair.
|
||||
|
||||
🔴 SECURITY: every candidate — including `bundled`, the copy frozen into
|
||||
this binary — is verified against CATALOG_PUBKEYS and re-validated from
|
||||
@@ -2461,46 +2698,68 @@ def resolve_catalog(
|
||||
by virtue of being local. Signing (and checking the signature at
|
||||
runtime, every time) closes that.
|
||||
|
||||
Anti-rollback: a candidate's version is never accepted if it's lower
|
||||
than the best verified candidate already found in this same resolution
|
||||
pass — an attacker replaying an old, since-superseded signed catalog
|
||||
can't downgrade you.
|
||||
`floor` is a pure, caller-supplied lower bound (e.g. a persisted
|
||||
"last accepted version" the GUI can load from disk and pass in) — this
|
||||
function does no storage of its own.
|
||||
|
||||
Anti-freeze: a candidate whose version leaps more than
|
||||
_CATALOG_MAX_VERSION_JUMP past the current best is also rejected. A
|
||||
compromised/leaked signing key claiming an absurd future version would
|
||||
otherwise permanently outrank every legitimate release from then on,
|
||||
since the resolver always prefers the highest verified version — this
|
||||
caps how far a single accepted jump can go.
|
||||
Anti-rollback / anti-freeze, and WHY they apply to every candidate
|
||||
including the first one evaluated: the previous version of this
|
||||
function only ran these checks `if best_version >= 0`, i.e. once a
|
||||
candidate had already been accepted in this pass. That let the FIRST
|
||||
verified candidate through unconditionally — a signed catalog claiming
|
||||
version=999999999 sailed straight past both guards if it happened to be
|
||||
evaluated first, and rollback protection reset on every call anyway
|
||||
(nothing persisted across restarts). Now both guards are anchored to
|
||||
something that doesn't depend on iteration order:
|
||||
|
||||
- The anti-freeze cap is measured against the BUNDLED catalog's version
|
||||
(verified independently, once), not against "whatever was accepted
|
||||
so far in this loop." Bundled ships inside the binary, so it's the
|
||||
one candidate that isn't attacker-supplied at resolve time — the
|
||||
natural trust anchor. If bundled itself doesn't verify, `floor` is
|
||||
the anchor instead.
|
||||
- The anti-rollback floor is max(floor, bundled's version), so a
|
||||
caller that persists `floor` across restarts gets real rollback
|
||||
protection; a caller that doesn't still gets "never below bundled."
|
||||
|
||||
On a version TIE, the bundled candidate wins over cached/remote (it
|
||||
previously lost ties to whichever candidate happened to be evaluated
|
||||
last, silently preferring remote over bundled at equal version).
|
||||
|
||||
Returns the winning catalog dict, or {} if nothing verified and
|
||||
validated.
|
||||
"""
|
||||
bundled_data, bundled_version = _verify_catalog_candidate(bundled)
|
||||
|
||||
anchor = bundled_version if bundled_version >= 0 else floor
|
||||
min_accepted = max(floor, bundled_version if bundled_version >= 0 else 0)
|
||||
|
||||
candidates = (
|
||||
("bundled", bundled_data, bundled_version),
|
||||
("cached", *_verify_catalog_candidate(cached)),
|
||||
("remote", *_verify_catalog_candidate(remote)),
|
||||
)
|
||||
|
||||
best: dict = {}
|
||||
best_version = -1
|
||||
best_is_bundled = False
|
||||
|
||||
for candidate in (bundled, cached, remote):
|
||||
if not candidate:
|
||||
continue
|
||||
raw, sig = candidate
|
||||
if not verify_catalog_signature(raw, sig, CATALOG_PUBKEYS):
|
||||
continue
|
||||
try:
|
||||
data = load_catalog(raw)
|
||||
except (ValueError, TypeError):
|
||||
continue
|
||||
if validate_catalog(data):
|
||||
for source, data, version in candidates:
|
||||
if data is None:
|
||||
continue
|
||||
if version < min_accepted:
|
||||
continue # anti-rollback / below the persisted floor
|
||||
if version > anchor + _CATALOG_MAX_VERSION_JUMP:
|
||||
continue # anti-freeze, capped against the bundled trust anchor
|
||||
|
||||
version = catalog_version(data)
|
||||
if best_version >= 0:
|
||||
if version < best_version:
|
||||
continue # anti-rollback
|
||||
if version > best_version + _CATALOG_MAX_VERSION_JUMP:
|
||||
continue # anti-freeze
|
||||
|
||||
is_bundled = source == "bundled"
|
||||
better = version > best_version or (
|
||||
version == best_version and is_bundled and not best_is_bundled
|
||||
)
|
||||
if better:
|
||||
best = data
|
||||
best_version = version
|
||||
best_is_bundled = is_bundled
|
||||
|
||||
return best
|
||||
|
||||
|
||||
+558
-69
@@ -10,14 +10,20 @@ for data/catalog.json (issue #62).
|
||||
Flow: Load -> Review -> Sign.
|
||||
|
||||
1. Load -- pick a source: an open Gitea PR touching data/catalog.json,
|
||||
or the current tip of `main`. The Console fetches the exact
|
||||
git blob (via a local clone's git 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`, the diff is against the last catalog a maintainer
|
||||
actually SIGNED (the bytes covered by the current
|
||||
data/catalog.json.sig), never against itself -- an empty
|
||||
diff must mean "nothing to sign", never "sign unlocked".
|
||||
the current tip of `main`, or the branch this checkout is
|
||||
currently ON (or --ref names) -- the latter exists so a
|
||||
catalog-signing-key rotation, or any other catalog change
|
||||
landed on a branch, can be reviewed and SIGNED before that
|
||||
branch is ever merged, instead of merging a PR that leaves
|
||||
main red and fixing it up afterwards (issue #68). The
|
||||
Console fetches the exact git blob (via a local clone's git
|
||||
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
|
||||
changed entry, with risk annotations
|
||||
(catalog_review.entry_risk_findings). A registry lookup for
|
||||
@@ -37,13 +43,23 @@ Flow: Load -> Review -> Sign.
|
||||
blocking risk finding (catalog_review.sign_precondition /
|
||||
can_sign -- the TOCTOU fix). On success, writes
|
||||
data/catalog.json + data/catalog.json.sig and commits BOTH
|
||||
in a single commit, then pushes -- so main is never red
|
||||
between a catalog merge and its signature. Signing uses the
|
||||
in a single commit, then pushes to the SAME ref that was
|
||||
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.
|
||||
|
||||
The signature must be the artefact of an actual review, not a step that
|
||||
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,
|
||||
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
|
||||
@@ -69,6 +85,7 @@ import urllib.error
|
||||
import urllib.request
|
||||
from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
from typing import ClassVar
|
||||
|
||||
import bcc_core as core
|
||||
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)
|
||||
|
||||
|
||||
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
|
||||
# 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()
|
||||
|
||||
|
||||
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:
|
||||
"""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
|
||||
@@ -283,17 +417,48 @@ def last_signed_catalog_raw(repo_dir: Path, commit: str) -> bytes | None:
|
||||
return review.find_last_signed_catalog_raw(candidates, sig_bytes, core.CATALOG_PUBKEYS)
|
||||
|
||||
|
||||
def catalog_signature_valid_at(repo_dir: Path, commit: str, raw: bytes) -> bool:
|
||||
"""Whether data/catalog.json.sig as of `commit` verifies `raw` against
|
||||
the CURRENTLY-TRUSTED bcc_core.CATALOG_PUBKEYS.
|
||||
|
||||
False whenever there is no .sig file, or the .sig exists but was
|
||||
produced by a key that is not (or no longer) in CATALOG_PUBKEYS -- most
|
||||
notably right after a catalog signing-key rotation (issue #68 finding 5
|
||||
follow-up), when the committed .sig was produced by the now-retired old
|
||||
key. This is the rotation-detection primitive ReviewWindow._on_load
|
||||
uses to decide whether to enter re-attestation mode
|
||||
(review.start_review(..., reattest=True)) instead of the ordinary
|
||||
diff-against-last-signed path.
|
||||
|
||||
Delegates to bcc_core.verify_catalog_signature -- never reimplemented,
|
||||
per this module's docstring ("one source of truth").
|
||||
"""
|
||||
try:
|
||||
sig_sha = blob_sha_at(repo_dir, commit, SIG_PATH)
|
||||
except GitError:
|
||||
return False
|
||||
sig_bytes = blob_bytes(repo_dir, sig_sha)
|
||||
return core.verify_catalog_signature(raw, sig_bytes, core.CATALOG_PUBKEYS)
|
||||
|
||||
|
||||
def commit_and_push_signed_catalog(
|
||||
repo_dir: Path, raw_bytes: bytes, signature: bytes, *, branch: str = "main"
|
||||
) -> str:
|
||||
"""Write data/catalog.json + data/catalog.json.sig and commit BOTH in a
|
||||
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
|
||||
merge, main would be red (payload present, signature missing) between
|
||||
every catalog merge and its signing commit. Routine red-main trains
|
||||
exactly the alarm fatigue this whole design exists to prevent. Emitting
|
||||
one commit with both files means main is never in that state.
|
||||
merge, `branch` would be red (payload present, signature missing)
|
||||
between the catalog merge and its signing commit. Routine red branches
|
||||
train exactly the alarm fatigue this whole design exists to prevent.
|
||||
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, "pull", "--ff-only", "origin", branch)
|
||||
@@ -483,14 +648,76 @@ def registry_fetcher(ref: review.PackageRef) -> dict | 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
|
||||
# exercised by tests/test_catalog_review.py; everything below is a thin
|
||||
# shell that calls into it.
|
||||
# --------------------------------------------------------------------------- #
|
||||
|
||||
from PySide6.QtCore import Qt, QThread, Signal # noqa: E402
|
||||
from PySide6.QtWidgets import ( # noqa: E402
|
||||
# PySide6 is imported defensively: `keygen`, `show-seed-b64`, and `keys`
|
||||
# (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,
|
||||
QCheckBox,
|
||||
QDialog,
|
||||
@@ -508,10 +735,18 @@ from PySide6.QtWidgets import ( # noqa: E402
|
||||
QScrollArea,
|
||||
QVBoxLayout,
|
||||
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
|
||||
|
||||
|
||||
def plain_label(text: object) -> QLabel:
|
||||
if _PYSIDE6_AVAILABLE: # pragma: no branch - GUI class defs, only skipped where PySide6 is absent
|
||||
|
||||
def plain_label(text: object) -> QLabel:
|
||||
"""A QLabel guaranteed to render `text` as plain text, never HTML.
|
||||
|
||||
Qt's QLabel auto-interprets HTML by default (Qt.AutoText), which means
|
||||
@@ -527,11 +762,9 @@ def plain_label(text: object) -> QLabel:
|
||||
label.setWordWrap(True)
|
||||
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/
|
||||
SpawnTester pattern. Never blocks the review UI on a slow/dead network."""
|
||||
|
||||
@@ -549,8 +782,7 @@ class RegistryLookupWorker(QThread):
|
||||
]
|
||||
self.done.emit(results)
|
||||
|
||||
|
||||
class EntryCard(QWidget):
|
||||
class EntryCard(QWidget):
|
||||
"""One changed catalog entry: the diff, risk findings, and the
|
||||
acknowledge checkbox that gates Sign. `command`/`args` are rendered
|
||||
visually dominant (bold-weight, larger, first) since they're the fields
|
||||
@@ -661,15 +893,24 @@ class EntryCard(QWidget):
|
||||
self.registry_label.setText(html.escape(text))
|
||||
self.registry_label.setTextFormat(Qt.PlainText)
|
||||
|
||||
class PassphraseDialog(QDialog):
|
||||
"""Prompts for a signing key's passphrase.
|
||||
|
||||
class PassphraseDialog(QDialog):
|
||||
def __init__(self, prompt: str, parent=None):
|
||||
`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)
|
||||
self.setWindowTitle("Signing key passphrase")
|
||||
self.setWindowTitle(window_title)
|
||||
layout = QFormLayout(self)
|
||||
layout.addRow(plain_label(prompt))
|
||||
self.edit = QLineEdit()
|
||||
self.edit.setEchoMode(QLineEdit.EchoMode.Password)
|
||||
layout.addRow(prompt, self.edit)
|
||||
layout.addRow("Passphrase:", self.edit)
|
||||
buttons = QDialogButtonBox(
|
||||
QDialogButtonBox.StandardButton.Ok | QDialogButtonBox.StandardButton.Cancel
|
||||
)
|
||||
@@ -680,14 +921,26 @@ class PassphraseDialog(QDialog):
|
||||
def passphrase(self) -> str:
|
||||
return self.edit.text()
|
||||
|
||||
class ReviewWindow(QMainWindow):
|
||||
#: 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": []}
|
||||
|
||||
class ReviewWindow(QMainWindow):
|
||||
def __init__(self, repo_dir: Path):
|
||||
def __init__(self, repo_dir: Path, ref: str | None = None):
|
||||
super().__init__()
|
||||
self.repo_dir = repo_dir
|
||||
self.session: review.ReviewSession | None = None
|
||||
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")
|
||||
central = QWidget()
|
||||
self.setCentralWidget(central)
|
||||
@@ -695,7 +948,13 @@ class ReviewWindow(QMainWindow):
|
||||
|
||||
top = QHBoxLayout()
|
||||
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)
|
||||
|
||||
side = QVBoxLayout()
|
||||
@@ -709,6 +968,22 @@ class ReviewWindow(QMainWindow):
|
||||
top.addLayout(side)
|
||||
root.addLayout(top)
|
||||
|
||||
# KEY-ROTATION RE-ATTESTATION BANNER (issue #68 finding 5 follow-up).
|
||||
# Hidden until _on_load() detects that the loaded catalog's
|
||||
# signature does NOT verify under the currently-trusted
|
||||
# bcc_core.CATALOG_PUBKEYS (catalog_signature_valid_at()) -- most
|
||||
# commonly, right after the maintainer rotates the catalog signing
|
||||
# key. This mode must NEVER be entered silently: this banner is the
|
||||
# only thing standing between "every entry needs re-review" and a
|
||||
# maintainer wondering why the diff view suddenly shows 19
|
||||
# "added" entries with no explanation.
|
||||
self.reattest_banner = plain_label("")
|
||||
self.reattest_banner.setStyleSheet(
|
||||
"background-color: #c62828; color: white; font-weight: bold; padding: 8px;"
|
||||
)
|
||||
self.reattest_banner.setVisible(False)
|
||||
root.addWidget(self.reattest_banner)
|
||||
|
||||
self.scroll = QScrollArea()
|
||||
self.scroll.setWidgetResizable(True)
|
||||
self.card_container = QWidget()
|
||||
@@ -728,41 +1003,66 @@ class ReviewWindow(QMainWindow):
|
||||
self._prs: list[CatalogPR] = []
|
||||
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):
|
||||
self._prs = list_open_catalog_prs(self._token)
|
||||
while self.source_list.count() > 1:
|
||||
self.source_list.takeItem(1)
|
||||
while self.source_list.count() > len(self._own_refs):
|
||||
self.source_list.takeItem(len(self._own_refs))
|
||||
for pr in self._prs:
|
||||
self.source_list.addItem(QListWidgetItem(f"PR #{pr.number}: {pr.title}"))
|
||||
|
||||
def _on_load(self):
|
||||
row = self.source_list.currentRow()
|
||||
try:
|
||||
if row <= 0:
|
||||
# source = main: diff against the last catalog a maintainer
|
||||
# actually SIGNED (the bytes covered by the current
|
||||
# data/catalog.json.sig), never against itself. Diffing
|
||||
# main-vs-main is what made an empty diff -> instantly
|
||||
# "signable" in the first place (issue #68 finding 1) --
|
||||
# this is the only path that reaches sign_catalog_bytes(),
|
||||
# so if it can't be trusted nothing can.
|
||||
loaded_ref = "main"
|
||||
def _load_own_ref(self, loaded_ref: str):
|
||||
"""Load + diff `loaded_ref` -- "main" or the maintainer's own
|
||||
working branch, ANY ref this clone's origin can fetch directly (as
|
||||
opposed to a PR's read-only refs/pull/<n>/head). Diffs against the
|
||||
last catalog a maintainer actually SIGNED on that ref (never
|
||||
against itself -- an empty diff must mean "nothing to sign", never
|
||||
"sign unlocked", issue #68 finding 1) and enters KEY-ROTATION
|
||||
RE-ATTESTATION mode if the committed .sig doesn't verify under the
|
||||
currently-trusted bcc_core.CATALOG_PUBKEYS (issue #68 finding 5
|
||||
follow-up). This is the exact logic "main" always used -- pulled
|
||||
into its own method, parameterized on the ref, so a rotation on a
|
||||
branch gets the SAME treatment as one on main and can be signed
|
||||
(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)
|
||||
new_raw, new_blob_sha = read_catalog_at_commit(self.repo_dir, commit)
|
||||
new_catalog = core.load_catalog(new_raw)
|
||||
|
||||
if not catalog_signature_valid_at(self.repo_dir, commit, new_raw):
|
||||
reattest = True
|
||||
old_catalog = dict(self._EMPTY_CATALOG)
|
||||
else:
|
||||
reattest = False
|
||||
old_raw = last_signed_catalog_raw(self.repo_dir, commit)
|
||||
old_catalog = (
|
||||
core.load_catalog(old_raw)
|
||||
if old_raw is not None
|
||||
else {
|
||||
"schema": 1,
|
||||
"version": 0,
|
||||
"servers": [],
|
||||
}
|
||||
core.load_catalog(old_raw) if old_raw is not None else dict(self._EMPTY_CATALOG)
|
||||
)
|
||||
|
||||
return new_raw, new_blob_sha, new_catalog, old_catalog, reattest
|
||||
|
||||
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:
|
||||
pr = self._prs[row - 1]
|
||||
pr = self._prs[row - len(self._own_refs)]
|
||||
loaded_ref = pr.head_ref
|
||||
reattest = False
|
||||
commit = fetch_ref(self.repo_dir, loaded_ref)
|
||||
old_commit = fetch_ref(self.repo_dir, "main")
|
||||
|
||||
@@ -781,8 +1081,21 @@ class ReviewWindow(QMainWindow):
|
||||
# from the SAME ref that was reviewed, instead of a hardcoded
|
||||
# "main" -- see review.sign_precondition and issue #68 finding 1.
|
||||
self.session = review.start_review(
|
||||
new_blob_sha, old_catalog, new_catalog, loaded_ref=loaded_ref
|
||||
new_blob_sha, old_catalog, new_catalog, loaded_ref=loaded_ref, reattest=reattest
|
||||
)
|
||||
if reattest:
|
||||
self.reattest_banner.setText(
|
||||
"KEY ROTATION IN PROGRESS -- the trusted CATALOG signing key changed. "
|
||||
"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 "
|
||||
f"{len(self.session.changes)} entries below must be re-reviewed and "
|
||||
"acknowledged before the new CATALOG key can re-sign this catalog -- "
|
||||
"this is the intended cost of rotating the CATALOG key, not a bug."
|
||||
)
|
||||
self.reattest_banner.setVisible(True)
|
||||
else:
|
||||
self.reattest_banner.setVisible(False)
|
||||
self.reattest_banner.setText("")
|
||||
self._render_cards()
|
||||
|
||||
def _render_cards(self):
|
||||
@@ -794,7 +1107,11 @@ class ReviewWindow(QMainWindow):
|
||||
|
||||
assert self.session is not None
|
||||
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:
|
||||
card = EntryCard(change, all_ids)
|
||||
@@ -817,6 +1134,12 @@ class ReviewWindow(QMainWindow):
|
||||
all_ack = review.all_entries_acknowledged(self.session)
|
||||
self.sign_btn.setEnabled(all_ack)
|
||||
pending = len(self.session.changes) - len(self.session.acknowledged)
|
||||
if self.session.reattest:
|
||||
self.status_label.setText(
|
||||
f"RE-ATTESTATION under the new key: {len(self.session.changes)} entries, "
|
||||
f"{pending} not yet acknowledged."
|
||||
)
|
||||
else:
|
||||
self.status_label.setText(
|
||||
f"{len(self.session.changes)} changed entries, {pending} not yet acknowledged."
|
||||
)
|
||||
@@ -859,23 +1182,52 @@ class ReviewWindow(QMainWindow):
|
||||
self._on_load()
|
||||
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:
|
||||
return
|
||||
try:
|
||||
seed = unlock_signing_key(dialog.passphrase())
|
||||
seed = unlock_signing_key(dialog.passphrase(), kind="catalog")
|
||||
except (FileNotFoundError, ValueError) as e:
|
||||
QMessageBox.critical(self, "Sign failed", html.escape(str(e)))
|
||||
return
|
||||
|
||||
signature = review.sign_catalog_bytes(self._new_raw, seed)
|
||||
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:
|
||||
QMessageBox.critical(self, "Commit/push failed", html.escape(str(e)))
|
||||
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)
|
||||
|
||||
|
||||
@@ -905,9 +1257,10 @@ def cmd_keygen(args: argparse.Namespace) -> int:
|
||||
|
||||
blob = review.encrypt_private_key(seed, passphrase)
|
||||
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")
|
||||
|
||||
print(f"{kind.capitalize()} private key encrypted and stored in: {where}")
|
||||
print(f"{kind.upper()} private key encrypted and stored in: {where}")
|
||||
print()
|
||||
if kind == "catalog":
|
||||
print(
|
||||
@@ -920,8 +1273,12 @@ def cmd_keygen(args: argparse.Namespace) -> int:
|
||||
)
|
||||
print()
|
||||
print(
|
||||
"Public key (base64) -- hand this to whoever maintains bcc_core.py so "
|
||||
"they can add it to CATALOG_PUBKEYS (this tool does not edit that file):"
|
||||
"PUBLIC key (base64, safe to commit/share) -- hand this to whoever "
|
||||
"maintains bcc_core.py so they can add it to CATALOG_PUBKEYS (this tool "
|
||||
"does not edit that file). There is no PRIVATE-key output for the catalog "
|
||||
"key: it is never meant to leave this machine, and this tool has no "
|
||||
"command that exports it (show-seed-b64 refuses without --release, and "
|
||||
"even then only exports the release key)."
|
||||
)
|
||||
print(f" {pubkey_b64}")
|
||||
else:
|
||||
@@ -932,14 +1289,23 @@ def cmd_keygen(args: argparse.Namespace) -> int:
|
||||
"contain it)."
|
||||
)
|
||||
print()
|
||||
print("1. Public key (base64) -- paste into scripts/sign_checksums.py RELEASE_PUBKEYS:")
|
||||
print(
|
||||
"1. PUBLIC key (base64, safe to commit/share) -- paste into "
|
||||
"scripts/sign_checksums.py RELEASE_PUBKEYS:"
|
||||
)
|
||||
print(f" {pubkey_b64}")
|
||||
print()
|
||||
print(
|
||||
"2. Private key -- add it as the Gitea repo secret RELEASE_SIGNING_KEY "
|
||||
"(base64 of the 32-byte private seed). Get that value with:"
|
||||
"2. PRIVATE key (secret -- NEVER commit, NEVER paste into chat/email) -- "
|
||||
"add it as the Gitea repo secret RELEASE_SIGNING_KEY (base64 of the "
|
||||
"32-byte private seed). This command does not print it; fetch it "
|
||||
"separately, when you're ready to paste it straight into the Gitea "
|
||||
"secret field, with:"
|
||||
)
|
||||
print(
|
||||
" python catalog_console.py show-seed-b64 --release "
|
||||
"# prints the PRIVATE key -- read the warning banner it shows"
|
||||
)
|
||||
print(" python catalog_console.py show-seed-b64 --release # prints the raw key")
|
||||
return 0
|
||||
|
||||
|
||||
@@ -959,17 +1325,49 @@ def cmd_show_seed_b64(args: argparse.Namespace) -> int:
|
||||
file=sys.stderr,
|
||||
)
|
||||
return 1
|
||||
passphrase = getpass.getpass("Release signing key passphrase: ")
|
||||
# The prior wording ("Release signing key passphrase:") was ambiguous
|
||||
# enough that a maintainer who ran this command, saw that prompt, and
|
||||
# then saw a base64 blob printed with zero surrounding context, pasted
|
||||
# the output into a chat believing it was the PUBLIC key. It is not --
|
||||
# it is the raw private seed. Every string this command prints from here
|
||||
# down exists to make that mistake structurally harder to make again.
|
||||
passphrase = getpass.getpass(
|
||||
"Passphrase for the release signing key (the one YOU chose when generating it): "
|
||||
)
|
||||
try:
|
||||
seed = unlock_signing_key(passphrase, kind="release")
|
||||
except (FileNotFoundError, ValueError) as e:
|
||||
print(f"error: {e}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
# Loud banner on STDERR, seed alone on STDOUT -- so `show-seed-b64
|
||||
# --release | pbcopy` (or piping into the Gitea secret field) still
|
||||
# gets ONLY the seed, while anyone watching the terminal still sees the
|
||||
# warning. Never merge these into one stream.
|
||||
print("!!! PRIVATE KEY BELOW -- this is the RELEASE_SIGNING_KEY secret value.", file=sys.stderr)
|
||||
print(
|
||||
"!!! Paste it ONLY into the Gitea secret field. Never into chat, email, "
|
||||
"a file, or a commit.",
|
||||
file=sys.stderr,
|
||||
)
|
||||
print(
|
||||
"!!! Anyone holding this value can forge release checksum signatures.",
|
||||
file=sys.stderr,
|
||||
)
|
||||
print(base64.b64encode(seed).decode("ascii"))
|
||||
return 0
|
||||
|
||||
|
||||
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()
|
||||
if not (repo_dir / CATALOG_PATH).exists():
|
||||
print(
|
||||
@@ -980,18 +1378,98 @@ def cmd_gui(args: argparse.Namespace) -> int:
|
||||
|
||||
app = QApplication(sys.argv)
|
||||
app.setApplicationName("BCC Catalog Console")
|
||||
win = ReviewWindow(repo_dir)
|
||||
win = ReviewWindow(repo_dir, ref=args.ref)
|
||||
win.resize(900, 700)
|
||||
win.show()
|
||||
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:
|
||||
parser = argparse.ArgumentParser(description=__doc__)
|
||||
sub = parser.add_subparsers(dest="command")
|
||||
|
||||
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(
|
||||
"--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_keygen = sub.add_parser(
|
||||
@@ -1019,10 +1497,21 @@ def build_parser() -> argparse.ArgumentParser:
|
||||
)
|
||||
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
|
||||
|
||||
|
||||
_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:
|
||||
|
||||
@@ -16,6 +16,8 @@ new surface" recurring-bug lesson).
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import base64
|
||||
import hashlib
|
||||
import os
|
||||
import re
|
||||
from collections.abc import Callable
|
||||
@@ -442,17 +444,42 @@ class ReviewSession:
|
||||
from the reviewed ref on every PR review (the bug that made the PR path
|
||||
unable to sign at all, and forced everyone onto the vacuous
|
||||
main-vs-itself path instead).
|
||||
|
||||
`reattest` marks a KEY-ROTATION re-attestation pass (issue #68 finding 5
|
||||
follow-up): the currently-trusted `bcc_core.CATALOG_PUBKEYS` key changed
|
||||
and the existing `data/catalog.json.sig` no longer verifies under it.
|
||||
Content-wise nothing may have changed -- `diff_catalogs(old, new)` can be
|
||||
genuinely empty -- but the NEW key has never vouched for any of this
|
||||
catalog before, so every entry needs a first-time attestation under the
|
||||
new key, not a diff against the old one. When `reattest` is set,
|
||||
`changes` is built as "every entry in `new_catalog`, presented as if
|
||||
newly added" (via `diff_catalogs(None, new_catalog)`) instead of a
|
||||
diff against `old_catalog`, so the acknowledge-gate in `can_sign()`
|
||||
requires re-reviewing everything the new key will sign -- which is the
|
||||
intended cost of a key rotation, not a bypass of the empty-diff guard.
|
||||
"""
|
||||
|
||||
pinned_blob_sha: str
|
||||
old_catalog: dict
|
||||
new_catalog: dict
|
||||
loaded_ref: str = "main"
|
||||
reattest: bool = False
|
||||
changes: list[EntryChange] = field(default_factory=list)
|
||||
acknowledged: set[str] = field(default_factory=set)
|
||||
|
||||
def __post_init__(self) -> None:
|
||||
if not self.changes:
|
||||
if self.reattest:
|
||||
# Every entry in the new catalog is treated as though it
|
||||
# were newly added -- because, under the NEW signing key,
|
||||
# it is: nothing this key signs was ever attested by it
|
||||
# before. Reusing diff_catalogs(None, new) (rather than a
|
||||
# bespoke code path) means the same "added" risk predicate
|
||||
# (risk_new_entry) and the same EntryChange shape the rest
|
||||
# of this module and the GUI already know how to render
|
||||
# apply here unmodified.
|
||||
self.changes = diff_catalogs(None, self.new_catalog)
|
||||
else:
|
||||
self.changes = diff_catalogs(self.old_catalog, self.new_catalog)
|
||||
|
||||
|
||||
@@ -461,12 +488,14 @@ def start_review(
|
||||
old_catalog: dict,
|
||||
new_catalog: dict,
|
||||
loaded_ref: str = "main",
|
||||
reattest: bool = False,
|
||||
) -> ReviewSession:
|
||||
return ReviewSession(
|
||||
pinned_blob_sha=pinned_blob_sha,
|
||||
old_catalog=old_catalog,
|
||||
new_catalog=new_catalog,
|
||||
loaded_ref=loaded_ref,
|
||||
reattest=reattest,
|
||||
)
|
||||
|
||||
|
||||
@@ -531,6 +560,14 @@ def can_sign(session: ReviewSession, current_blob_sha: str) -> SignDecision:
|
||||
mean "nothing to sign", never "sign unlocked". (Issue #68 finding 1;
|
||||
this is what let commit b08cf21 sign all 19 entries with zero of them
|
||||
ever reviewed.)
|
||||
|
||||
This gate is unaffected by `session.reattest`: a key-rotation
|
||||
re-attestation session's `changes` is built from
|
||||
`diff_catalogs(None, new_catalog)` (see ReviewSession), which is
|
||||
empty ONLY if the catalog itself has zero entries -- a genuinely
|
||||
empty catalog either way. Rotation never manufactures a non-empty
|
||||
changeset out of an empty one; it just changes *what* "non-empty"
|
||||
is computed against.
|
||||
1. TOCTOU: `current_blob_sha` (fetched fresh, immediately before signing,
|
||||
from the ref that was actually reviewed -- see sign_precondition())
|
||||
must match the blob SHA pinned when review began. If the bytes on the
|
||||
@@ -816,3 +853,243 @@ _NON_ASCII_RE = re.compile(r"[^\x00-\x7f]")
|
||||
|
||||
def contains_non_ascii(s: str) -> bool:
|
||||
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)
|
||||
|
||||
@@ -53,13 +53,17 @@ DOMAIN_PREFIX = b"bcc-release-v1|"
|
||||
# the signature on every past release: verification accepts a match against
|
||||
# ANY key here.
|
||||
#
|
||||
# Empty until the maintainer generates the release keypair (separately from
|
||||
# the catalog keypair) and pastes the public half in:
|
||||
# Populated by the maintainer via:
|
||||
# python catalog_console.py keygen --release
|
||||
# This is intentionally NOT pre-populated with a placeholder that looks
|
||||
# like a real key -- release.yml's signing-smoke-test fails closed (loudly)
|
||||
# on an empty list rather than silently verifying against nothing.
|
||||
RELEASE_PUBKEYS: list[bytes] = []
|
||||
# Rotated 2026-07 (issue #68 finding 5 / #68 CI-exposure incident): the
|
||||
# original key was shared with the catalog key and had been exposed to CI,
|
||||
# so both keypairs were regenerated as separate, disjoint keys. This list
|
||||
# holds only the current release key -- if release.yml's signing-smoke-test
|
||||
# ever sees this list empty, it fails closed (loudly) rather than silently
|
||||
# verifying against nothing.
|
||||
RELEASE_PUBKEYS: list[bytes] = [
|
||||
base64.b64decode("6BnPgJEHJFyVltFoLTCNadIsehjy00iiW8IRlC1TfhA="),
|
||||
]
|
||||
|
||||
CHUNK_SIZE = 1024 * 1024
|
||||
|
||||
|
||||
@@ -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"
|
||||
@@ -491,6 +491,98 @@ def test_sign_precondition_defaults_to_main_when_loaded_ref_unset():
|
||||
assert decision.ok is True
|
||||
|
||||
|
||||
# --------------------------------------------------------------------------- #
|
||||
# ReviewSession(reattest=True): key-rotation re-attestation (issue #68
|
||||
# finding 5 follow-up). After rotating bcc_core.CATALOG_PUBKEYS, the
|
||||
# existing data/catalog.json.sig no longer verifies under the new key even
|
||||
# though catalog CONTENT is unchanged -- diff_catalogs(old, new) would be
|
||||
# empty, and an empty changeset must never unlock Sign (can_sign gate 0).
|
||||
# Re-attestation mode sidesteps that correctly: instead of diffing against
|
||||
# the (now-untrustworthy) last-signed content, it treats every entry as
|
||||
# requiring a fresh acknowledgement, exactly like a brand-new catalog.
|
||||
# --------------------------------------------------------------------------- #
|
||||
def test_reattest_mode_with_unchanged_content_yields_one_change_per_entry():
|
||||
same = _catalog(_entry(id="a"), _entry(id="b"), _entry(id="c"))
|
||||
session = r.start_review("sha1", same, same, reattest=True)
|
||||
assert len(session.changes) == 3
|
||||
assert {c_.entry_id for c_ in session.changes} == {"a", "b", "c"}
|
||||
# Presented "as if newly added" -- old_catalog plays no role here.
|
||||
assert all(c_.status == "added" for c_ in session.changes)
|
||||
assert all(c_.old is None for c_ in session.changes)
|
||||
|
||||
|
||||
def test_reattest_mode_can_sign_refuses_until_all_acknowledged_then_permits():
|
||||
same = _catalog(_entry(id="a"), _entry(id="b"), _entry(id="c"))
|
||||
session = r.start_review("sha1", same, same, reattest=True)
|
||||
|
||||
decision = r.can_sign(session, "sha1")
|
||||
assert decision.ok is False
|
||||
assert "acknowledged" in decision.reason.lower()
|
||||
|
||||
r.acknowledge_entry(session, "a")
|
||||
r.acknowledge_entry(session, "b")
|
||||
decision = r.can_sign(session, "sha1")
|
||||
assert decision.ok is False # "c" still outstanding
|
||||
assert "acknowledged" in decision.reason.lower()
|
||||
|
||||
r.acknowledge_entry(session, "c")
|
||||
decision = r.can_sign(session, "sha1")
|
||||
assert decision.ok is True
|
||||
assert decision.reason is None
|
||||
|
||||
|
||||
def test_normal_mode_with_unchanged_content_still_refuses_empty_diff():
|
||||
"""The rotation path must NOT become a general bypass of the empty-diff
|
||||
guard: reattest=False (the default) against identical old/new catalogs
|
||||
must behave exactly as before -- can_sign refuses with 'nothing to
|
||||
sign', full stop."""
|
||||
same = _catalog(_entry(id="a"), _entry(id="b"))
|
||||
session = r.start_review("sha1", same, same) # reattest defaults False
|
||||
assert session.changes == []
|
||||
decision = r.can_sign(session, "sha1")
|
||||
assert decision.ok is False
|
||||
assert "nothing to sign" in decision.reason.lower()
|
||||
|
||||
|
||||
def test_reattest_mode_still_enforces_blocking_risk_check():
|
||||
"""Re-attestation must not relax the blocking-risk gate: a
|
||||
disallowed-command entry blocks Sign even with every entry
|
||||
acknowledged."""
|
||||
cat = _catalog(
|
||||
_entry(id="a"),
|
||||
_entry(id="evil", config={"command": "bash", "args": ["-c", "rm -rf /"]}),
|
||||
)
|
||||
session = r.start_review("sha1", cat, cat, reattest=True)
|
||||
assert len(session.changes) == 2
|
||||
r.acknowledge_entry(session, "a")
|
||||
r.acknowledge_entry(session, "evil")
|
||||
assert r.all_entries_acknowledged(session) is True
|
||||
decision = r.can_sign(session, "sha1")
|
||||
assert decision.ok is False
|
||||
assert "blocking" in decision.reason.lower()
|
||||
|
||||
|
||||
def test_reattest_mode_still_enforces_toctou_pin():
|
||||
"""Re-attestation must not relax the TOCTOU blob-SHA pin: acknowledging
|
||||
everything is not enough if the bytes moved underneath the review."""
|
||||
same = _catalog(_entry(id="a"))
|
||||
session = r.start_review("sha1", same, same, reattest=True)
|
||||
r.acknowledge_entry(session, "a")
|
||||
decision = r.can_sign(session, "sha1")
|
||||
assert decision.ok is True # sanity: matches when blob is unchanged
|
||||
|
||||
decision = r.can_sign(session, "sha2-a-new-commit-landed")
|
||||
assert decision.ok is False
|
||||
assert "mismatch" in decision.reason.lower() or "changed" in decision.reason.lower()
|
||||
|
||||
|
||||
def test_reattest_defaults_to_false():
|
||||
"""start_review()'s reattest parameter defaults to False -- normal
|
||||
(diff-based) review is the default behaviour, never silently entered."""
|
||||
session = r.start_review("sha1", _catalog(), _catalog(_entry()))
|
||||
assert session.reattest is False
|
||||
|
||||
|
||||
# --------------------------------------------------------------------------- #
|
||||
# find_last_signed_catalog_raw: what source=main diffs against
|
||||
# --------------------------------------------------------------------------- #
|
||||
@@ -693,3 +785,245 @@ def test_contains_non_ascii_true():
|
||||
|
||||
def test_contains_non_ascii_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
|
||||
|
||||
+312
-4
@@ -1690,8 +1690,12 @@ def _minimal_catalog(version: int = 1) -> dict:
|
||||
"official": True,
|
||||
"setup": "basic",
|
||||
"config": {
|
||||
# Pinned on purpose (issue #68 finding 3): an earlier
|
||||
# version of this fixture used an unpinned package and
|
||||
# asserted it validated clean, which enshrined the bug
|
||||
# instead of catching it.
|
||||
"command": "npx",
|
||||
"args": ["-y", "widget-mcp"],
|
||||
"args": ["-y", "widget-mcp@1.0.0"],
|
||||
},
|
||||
"placeholders": {},
|
||||
"env_required": {},
|
||||
@@ -1952,6 +1956,213 @@ def test_validate_catalog_rejects_duplicate_ids():
|
||||
assert any("duplicate id" in p for p in problems)
|
||||
|
||||
|
||||
# --- validate_catalog: config.env (issue #68 finding 2) -------------------- #
|
||||
def test_validate_catalog_rejects_each_denied_env_key():
|
||||
for key in sorted(c.CATALOG_DENIED_ENV_KEYS):
|
||||
data = _catalog_with(
|
||||
{"config": {"command": "npx", "args": ["-y", "widget-mcp@1.0.0"], "env": {key: ""}}}
|
||||
)
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("deny-list" in p for p in problems), (key, problems)
|
||||
|
||||
|
||||
def test_validate_catalog_rejects_denied_env_key_case_insensitively():
|
||||
data = _catalog_with(
|
||||
{
|
||||
"config": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "widget-mcp@1.0.0"],
|
||||
"env": {"node_options": ""},
|
||||
}
|
||||
}
|
||||
)
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("deny-list" in p for p in problems)
|
||||
|
||||
|
||||
def test_validate_catalog_rejects_nonempty_nonplaceholder_env_value():
|
||||
data = _catalog_with(
|
||||
{
|
||||
"config": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "widget-mcp@1.0.0"],
|
||||
"env": {"FOO_URL": "https://example.com"},
|
||||
}
|
||||
}
|
||||
)
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("empty string or a single <PLACEHOLDER>" in p for p in problems)
|
||||
|
||||
|
||||
def test_validate_catalog_accepts_empty_and_placeholder_env_values():
|
||||
data = _catalog_with(
|
||||
{
|
||||
"config": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "widget-mcp@1.0.0"],
|
||||
"env": {"FOO": "", "BAR_URL": "<BAR_URL>"},
|
||||
}
|
||||
}
|
||||
)
|
||||
assert c.validate_catalog(data) == []
|
||||
|
||||
|
||||
def test_validate_catalog_rejects_non_ascii_env_key():
|
||||
data = _catalog_with(
|
||||
{
|
||||
"config": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "widget-mcp@1.0.0"],
|
||||
"env": {"FÖO": ""},
|
||||
}
|
||||
}
|
||||
)
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("config.env key" in p and "ASCII" in p for p in problems)
|
||||
|
||||
|
||||
def test_validate_catalog_rejects_non_ascii_env_value():
|
||||
data = _catalog_with(
|
||||
{
|
||||
"config": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "widget-mcp@1.0.0"],
|
||||
"env": {"FOO": "<Bäd>"},
|
||||
}
|
||||
}
|
||||
)
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("config.env value" in p and "ASCII" in p for p in problems)
|
||||
|
||||
|
||||
def test_validate_catalog_rejects_secret_looking_env_value():
|
||||
data = _catalog_with(
|
||||
{
|
||||
"config": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "widget-mcp@1.0.0"],
|
||||
"env": {"SOME_TOKEN": "ghp_abcdef1234567890"},
|
||||
}
|
||||
}
|
||||
)
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("real secret value" in p for p in problems)
|
||||
|
||||
|
||||
def test_validate_catalog_rejects_node_options_env_walking_past_allowlist():
|
||||
# The exact reproduction from issue #68 finding 2: an allowlisted
|
||||
# `npx` command carrying NODE_OPTIONS in env, which previously passed
|
||||
# validation and would have flowed straight into the executed
|
||||
# subprocess via catalog_entry_to_paste_json().
|
||||
data = _catalog_with(
|
||||
{
|
||||
"config": {
|
||||
"command": "npx",
|
||||
"args": ["-y", "widget-mcp@1.0.0"],
|
||||
"env": {"NODE_OPTIONS": "--require /tmp/payload.js"},
|
||||
}
|
||||
}
|
||||
)
|
||||
problems = c.validate_catalog(data)
|
||||
assert problems != []
|
||||
|
||||
|
||||
# --- validate_catalog: version pinning (issue #68 finding 3) --------------- #
|
||||
def test_validate_catalog_rejects_unpinned_npx_package():
|
||||
data = _catalog_with({"config": {"command": "npx", "args": ["-y", "widget-mcp"]}})
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("not version-pinned" in p for p in problems)
|
||||
|
||||
|
||||
def test_validate_catalog_rejects_unpinned_scoped_npx_package():
|
||||
data = _catalog_with({"config": {"command": "npx", "args": ["-y", "@scope/pkg"]}})
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("not version-pinned" in p for p in problems)
|
||||
|
||||
|
||||
def test_validate_catalog_accepts_pinned_scoped_npx_package():
|
||||
data = _catalog_with({"config": {"command": "npx", "args": ["-y", "@scope/pkg@1.2.3"]}})
|
||||
assert c.validate_catalog(data) == []
|
||||
|
||||
|
||||
def test_validate_catalog_rejects_unpinned_uvx_package():
|
||||
data = _catalog_with({"config": {"command": "uvx", "args": ["some-tool"]}})
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("not version-pinned" in p for p in problems)
|
||||
|
||||
|
||||
def test_validate_catalog_accepts_uvx_at_version_pin():
|
||||
data = _catalog_with({"config": {"command": "uvx", "args": ["some-tool@1.0.0"]}})
|
||||
assert c.validate_catalog(data) == []
|
||||
|
||||
|
||||
def test_validate_catalog_accepts_uvx_double_equals_pin():
|
||||
data = _catalog_with({"config": {"command": "uvx", "args": ["some-tool==1.0.0"]}})
|
||||
assert c.validate_catalog(data) == []
|
||||
|
||||
|
||||
def test_validate_catalog_rejects_docker_latest_tag():
|
||||
data = _catalog_with({"config": {"command": "docker", "args": ["run", "some/image:latest"]}})
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("'latest'" in p for p in problems)
|
||||
|
||||
|
||||
def test_validate_catalog_rejects_docker_untagged_image():
|
||||
data = _catalog_with({"config": {"command": "docker", "args": ["run", "some/image"]}})
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("no explicit tag" in p for p in problems)
|
||||
|
||||
|
||||
def test_validate_catalog_accepts_pinned_docker_image_with_flags():
|
||||
data = _catalog_with(
|
||||
{
|
||||
"config": {
|
||||
"command": "docker",
|
||||
"args": ["run", "-i", "--rm", "-e", "SOME_TOKEN", "some/image:1.2.3"],
|
||||
}
|
||||
}
|
||||
)
|
||||
assert c.validate_catalog(data) == []
|
||||
|
||||
|
||||
def test_validate_catalog_does_not_pin_check_placeholders_flags_or_subcommand():
|
||||
# A pinned uvx spec followed by flags and a <PLACEHOLDER> positional
|
||||
# must not itself get mistaken for an unpinned package.
|
||||
data = _catalog_with(
|
||||
{
|
||||
"config": {
|
||||
"command": "uvx",
|
||||
"args": ["mcp-server-git@2026.7.10", "--repository", "<REPO_PATH>"],
|
||||
}
|
||||
}
|
||||
)
|
||||
assert c.validate_catalog(data) == []
|
||||
|
||||
|
||||
# --- validate_catalog: id constraint (issue #68 finding 7) ----------------- #
|
||||
def test_validate_catalog_rejects_id_with_markup():
|
||||
data = _catalog_with({"id": "<b>Verified</b>"})
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("must match" in p for p in problems)
|
||||
|
||||
|
||||
def test_validate_catalog_rejects_id_with_uppercase():
|
||||
data = _catalog_with({"id": "Widget"})
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("must match" in p for p in problems)
|
||||
|
||||
|
||||
def test_validate_catalog_rejects_id_starting_with_dash():
|
||||
data = _catalog_with({"id": "-widget"})
|
||||
problems = c.validate_catalog(data)
|
||||
assert any("must match" in p for p in problems)
|
||||
|
||||
|
||||
def test_validate_catalog_accepts_valid_slug_id():
|
||||
data = _catalog_with({"id": "widget-2.thing-ok"})
|
||||
assert c.validate_catalog(data) == []
|
||||
|
||||
|
||||
# --- resolve_catalog -------------------------------------------------------- #
|
||||
def test_resolve_catalog_nothing_available_returns_empty_dict():
|
||||
assert c.resolve_catalog(None, None, None) == {}
|
||||
@@ -2003,13 +2214,93 @@ def test_resolve_catalog_rejects_absurd_version_jump(monkeypatch):
|
||||
pub = priv.public_key().public_bytes_raw()
|
||||
monkeypatch.setattr(c, "CATALOG_PUBKEYS", [pub])
|
||||
|
||||
cached = _signed(_minimal_catalog(version=5), priv)
|
||||
# The freeze attempt goes FIRST (as `cached`), the legitimate catalog
|
||||
# SECOND (as `remote`) -- on purpose. Putting the good catalog first
|
||||
# (as an earlier version of this test did) never exercises the
|
||||
# vulnerable path: the old implementation only guarded a candidate
|
||||
# against "the best accepted so far," so whichever candidate was
|
||||
# evaluated FIRST got in unconditionally, uncapped. Ordering the freeze
|
||||
# attempt first is what actually proves the cap holds regardless of
|
||||
# evaluation order.
|
||||
freeze_attempt = _signed(_minimal_catalog(version=999999), priv)
|
||||
good = _signed(_minimal_catalog(version=5), priv)
|
||||
|
||||
result = c.resolve_catalog(None, cached, freeze_attempt)
|
||||
result = c.resolve_catalog(None, freeze_attempt, good)
|
||||
assert c.catalog_version(result) == 5
|
||||
|
||||
|
||||
def test_resolve_catalog_caps_first_and_only_candidate(monkeypatch):
|
||||
# issue #68 finding 6: with no bundled catalog to anchor against, a
|
||||
# signed catalog claiming an absurd version must still be capped even
|
||||
# when it is the ONLY candidate resolve_catalog() ever sees -- there is
|
||||
# no "best so far" for it to be compared against, so the cap has to
|
||||
# apply unconditionally, not "once something else has already landed."
|
||||
priv = Ed25519PrivateKey.generate()
|
||||
pub = priv.public_key().public_bytes_raw()
|
||||
monkeypatch.setattr(c, "CATALOG_PUBKEYS", [pub])
|
||||
|
||||
freeze_attempt = _signed(_minimal_catalog(version=999999999), priv)
|
||||
|
||||
result = c.resolve_catalog(None, None, freeze_attempt)
|
||||
assert result == {}
|
||||
|
||||
|
||||
def test_resolve_catalog_anchors_cap_to_bundled_not_a_chained_best(monkeypatch):
|
||||
# Anti-freeze must be measured against the BUNDLED version specifically,
|
||||
# not against "whatever the best-so-far happens to be after each
|
||||
# candidate is accepted" -- a chained anchor lets each accepted
|
||||
# candidate ratchet the allowed ceiling upward, so a legitimate
|
||||
# moderate bump (cached) plus a second, much larger jump (remote) can
|
||||
# each individually look "within _CATALOG_MAX_VERSION_JUMP of the
|
||||
# previous one" while remote is nowhere near bundled's version.
|
||||
priv = Ed25519PrivateKey.generate()
|
||||
pub = priv.public_key().public_bytes_raw()
|
||||
monkeypatch.setattr(c, "CATALOG_PUBKEYS", [pub])
|
||||
|
||||
bundled = _signed(_minimal_catalog(version=2), priv)
|
||||
cached = _signed(_minimal_catalog(version=1000), priv) # within 1000 of bundled
|
||||
remote = _signed(_minimal_catalog(version=1900), priv) # within 1000 of cached,
|
||||
# NOT of bundled
|
||||
|
||||
result = c.resolve_catalog(bundled, cached, remote)
|
||||
assert c.catalog_version(result) == 1000
|
||||
|
||||
|
||||
def test_resolve_catalog_prefers_bundled_on_version_tie(monkeypatch):
|
||||
# issue #68 finding 6: on a tie the LAST candidate evaluated used to
|
||||
# win, so remote silently beat bundled at equal version. Bundled --
|
||||
# the copy frozen into the binary -- must win ties.
|
||||
priv = Ed25519PrivateKey.generate()
|
||||
pub = priv.public_key().public_bytes_raw()
|
||||
monkeypatch.setattr(c, "CATALOG_PUBKEYS", [pub])
|
||||
|
||||
bundled_data = _minimal_catalog(version=5)
|
||||
bundled = _signed(bundled_data, priv)
|
||||
|
||||
remote_data = _minimal_catalog(version=5)
|
||||
remote_data["servers"][0]["display"] = "Remote Impostor"
|
||||
remote = _signed(remote_data, priv)
|
||||
|
||||
result = c.resolve_catalog(bundled, None, remote)
|
||||
assert c.catalog_version(result) == 5
|
||||
assert result["servers"][0]["display"] == "Widget"
|
||||
|
||||
|
||||
def test_resolve_catalog_floor_rejects_below_persisted_version(monkeypatch):
|
||||
# `floor` is a pure parameter: the caller (eventually the GUI, from
|
||||
# persisted storage) can pass a previously-accepted version, and
|
||||
# nothing below it may be accepted even with no bundled catalog to
|
||||
# anchor against.
|
||||
priv = Ed25519PrivateKey.generate()
|
||||
pub = priv.public_key().public_bytes_raw()
|
||||
monkeypatch.setattr(c, "CATALOG_PUBKEYS", [pub])
|
||||
|
||||
stale = _signed(_minimal_catalog(version=3), priv)
|
||||
|
||||
result = c.resolve_catalog(None, None, stale, floor=10)
|
||||
assert result == {}
|
||||
|
||||
|
||||
def test_resolve_catalog_malformed_candidate_does_not_raise(monkeypatch):
|
||||
priv = Ed25519PrivateKey.generate()
|
||||
pub = priv.public_key().public_bytes_raw()
|
||||
@@ -2039,15 +2330,32 @@ def test_resolve_catalog_invalid_but_signed_candidate_is_skipped(monkeypatch):
|
||||
def test_catalog_entry_to_paste_json_basic_shape():
|
||||
entry = _minimal_catalog()["servers"][0]
|
||||
result = c.catalog_entry_to_paste_json(entry)
|
||||
assert result == {"widget": {"command": "npx", "args": ["-y", "widget-mcp"]}}
|
||||
assert result == {"widget": {"command": "npx", "args": ["-y", "widget-mcp@1.0.0"]}}
|
||||
|
||||
|
||||
def test_catalog_entry_to_paste_json_includes_env_when_present():
|
||||
# NOTE: catalog_entry_to_paste_json() is a pure shape-converter for an
|
||||
# entry that has ALREADY passed validate_catalog() -- it is correct for
|
||||
# it to carry env through verbatim. The bug (issue #68 finding 2) was
|
||||
# never in this function; it was that validate_catalog() let entries
|
||||
# with dangerous/non-placeholder env values reach this function in the
|
||||
# first place. This test now proves that boundary explicitly: a
|
||||
# validation-legal env value (a <PLACEHOLDER> token) survives the
|
||||
# conversion, and a value validate_catalog() would have rejected is
|
||||
# confirmed rejected before it ever gets here.
|
||||
entry = _minimal_catalog()["servers"][0]
|
||||
entry["config"]["env"] = {"GRAFANA_URL": "<GRAFANA_URL>"}
|
||||
result = c.catalog_entry_to_paste_json(entry)
|
||||
assert result["widget"]["env"] == {"GRAFANA_URL": "<GRAFANA_URL>"}
|
||||
|
||||
catalog = _minimal_catalog()
|
||||
catalog["servers"][0]["config"]["env"] = {"GRAFANA_URL": "<GRAFANA_URL>"}
|
||||
assert c.validate_catalog(catalog) == []
|
||||
|
||||
malicious = _minimal_catalog()
|
||||
malicious["servers"][0]["config"]["env"] = {"NODE_OPTIONS": "--require /tmp/payload.js"}
|
||||
assert c.validate_catalog(malicious) != []
|
||||
|
||||
|
||||
def test_config_has_unfilled_placeholders_true_for_token():
|
||||
cfg = {"command": "npx", "args": ["-y", "server", "<ALLOWED_DIR>"]}
|
||||
|
||||
Reference in New Issue
Block a user