mirror of
https://github.com/freemkv/freemkv-keysources.git
synced 2026-10-07 18:13:11 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
db3b78e1f9 | ||
|
|
f44de130b6 | ||
|
|
c562bfbad0 | ||
|
|
bd07927292 | ||
|
|
49348eab2d | ||
|
|
36e9d93525 | ||
|
|
d2f6bbd272 | ||
|
|
8c2d9be19a | ||
|
|
473f629d13 | ||
|
|
1662345b7e | ||
|
|
0ec14fc338 | ||
|
|
520df9ebe3 | ||
|
|
5bf4afce0b | ||
|
|
d0a3ab852b | ||
|
|
91b906fa61 | ||
|
|
e987506d96 | ||
|
|
60cff0ead6 | ||
|
|
c333c6000b | ||
|
|
adf2401c06 | ||
|
|
b89b7c9660 | ||
|
|
1121522534 | ||
|
|
146f53873d | ||
|
|
b925a4fa50 | ||
|
|
4f169a4881 | ||
|
|
e251e0bf6f | ||
|
|
6704c1e05b | ||
|
|
a34980970b | ||
|
|
948511853e | ||
|
|
373cdc4cf2 | ||
|
|
a60b021c35 | ||
|
|
fc8b6e3a05 | ||
|
|
bdbc805ba5 | ||
|
|
fa75d28441 | ||
|
|
5d2e11a4dd |
+31
-61
@@ -1,63 +1,33 @@
|
||||
# Version updates are monthly and grouped into one PR per ecosystem.
|
||||
# Security updates are separate and run whenever an advisory is published.
|
||||
version: 2
|
||||
|
||||
# Dependency updates land on `dev`, never on `main`.
|
||||
#
|
||||
# `main` here is a RELEASE POINTER that release.sh moves to each tag. A bot
|
||||
# commit on it would put work there that no tag contains, which is exactly the
|
||||
# state that aborted the 1.6.2 cascade at the last step -- so pointing
|
||||
# Dependabot at main would recreate that failure on a schedule.
|
||||
updates:
|
||||
- package-ecosystem: cargo
|
||||
directory: /
|
||||
target-branch: dev
|
||||
schedule:
|
||||
interval: weekly
|
||||
open-pull-requests-limit: 5
|
||||
# One PR per week for the routine bumps instead of one per crate. Eight
|
||||
# repos times a handful of crates is a volume nobody reads, and an
|
||||
# unread PR queue is indistinguishable from no updates at all.
|
||||
groups:
|
||||
minor-and-patch:
|
||||
update-types:
|
||||
- minor
|
||||
- patch
|
||||
ignore:
|
||||
# The freemkv crates depend on each other by GIT TAG, re-pinned by
|
||||
# release.sh as part of the release commit. Dependabot cannot see that
|
||||
# cascade, so a PR bumping one of these would fight the release process
|
||||
# and could pin a version whose tag does not exist yet.
|
||||
- dependency-name: freemkv-unlock
|
||||
- dependency-name: libfreemkv
|
||||
- dependency-name: freemkv-keysources
|
||||
- dependency-name: freemkv-i18n
|
||||
- dependency-name: freemkv-engine
|
||||
|
||||
# The workflows are now real infrastructure -- the release cascade, the
|
||||
# cross-platform hash matrix, the disc gate -- so their actions need the same
|
||||
# attention as the crates.
|
||||
- package-ecosystem: github-actions
|
||||
directory: /
|
||||
target-branch: dev
|
||||
schedule:
|
||||
interval: weekly
|
||||
open-pull-requests-limit: 5
|
||||
groups:
|
||||
actions:
|
||||
update-types:
|
||||
- minor
|
||||
- patch
|
||||
ignore:
|
||||
# NOT a dependency: `dtolnay/rust-toolchain` is versioned by the RUST
|
||||
# release it installs, and the tag we pin is the toolchain CI is pinned
|
||||
# to on purpose -- precommit.sh runs the same one locally so a lint that
|
||||
# passes on a developer's newer default cannot pass CI by accident.
|
||||
#
|
||||
# Dependabot reads those tags as semver and proposed 1.97.0 -> 1.100.0,
|
||||
# a Rust version that does not exist. Every such PR 404s on toolchain
|
||||
# download across all eight repos, and they regenerate weekly -- eight
|
||||
# permanently-red PRs that promote.yml then has to special-case when it
|
||||
# decides whether dev is green.
|
||||
#
|
||||
# Bumping the toolchain is a deliberate, all-eight-repos change, made by
|
||||
# hand together with precommit.sh. There is nothing here for a bot.
|
||||
- dependency-name: dtolnay/rust-toolchain
|
||||
- package-ecosystem: cargo
|
||||
directory: /
|
||||
target-branch: dev
|
||||
schedule:
|
||||
interval: monthly
|
||||
open-pull-requests-limit: 5
|
||||
groups:
|
||||
all:
|
||||
patterns:
|
||||
- '*'
|
||||
ignore:
|
||||
- dependency-name: freemkv-unlock
|
||||
- dependency-name: libfreemkv
|
||||
- dependency-name: freemkv-keysources
|
||||
- dependency-name: freemkv-i18n
|
||||
- dependency-name: freemkv-engine
|
||||
- package-ecosystem: github-actions
|
||||
directory: /
|
||||
target-branch: dev
|
||||
schedule:
|
||||
interval: monthly
|
||||
open-pull-requests-limit: 5
|
||||
groups:
|
||||
all:
|
||||
patterns:
|
||||
- '*'
|
||||
ignore:
|
||||
- dependency-name: dtolnay/rust-toolchain
|
||||
- dependency-name: freemkv/.github*
|
||||
|
||||
+42
-122
@@ -10,16 +10,22 @@ on:
|
||||
branches: [main, dev, qa]
|
||||
pull_request:
|
||||
|
||||
# Rapid dev pushes supersede their own in-progress runs instead of stacking.
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
# WHY THE SIBLING CHECKOUTS — this is NOT a monorepo.
|
||||
#
|
||||
# The committed Cargo.toml resolves libfreemkv from a git TAG (it is off
|
||||
# crates.io). That means CI was building this branch against the LAST RELEASE
|
||||
# of libfreemkv, never against libfreemkv's dev tip — so a coordinated change
|
||||
# across the two repos could not be verified until release.sh cut the tags.
|
||||
# across the two repos could not be verified until release-orchestrate.yml cut the tags.
|
||||
# Green here meant "compiles against last month's library".
|
||||
#
|
||||
# The fix mirrors the developer's local layout. Every repo is checked out into
|
||||
# a subdirectory of $GITHUB_WORKSPACE, reproducing
|
||||
# The fix mirrors the developer's local layout via the shared composite
|
||||
# freemkv/.github//actions/checkout-siblings: every sibling repo is checked out
|
||||
# into a subdirectory of $GITHUB_WORKSPACE, reproducing
|
||||
# ~/Developer/freemkv/{freemkv-keysources,libfreemkv,freemkv-unlock}, and a
|
||||
# generated .cargo/config.toml redirects the git-tag patch to those paths.
|
||||
# Config-level [patch.crates-io] wins over the manifest one, which is the same
|
||||
@@ -36,7 +42,7 @@ on:
|
||||
# the `deny` job audits the resolved graph, but CI's sibling path-patch layout
|
||||
# resolves the freemkv crates as path packages, which `--locked` can't satisfy —
|
||||
# the same reason the binary crates omit it. The lock that has to hold is the one
|
||||
# release.sh regenerates in each consuming binary.
|
||||
# release-orchestrate.yml regenerates in each consuming binary.
|
||||
|
||||
jobs:
|
||||
# Single source of truth for the MSRV — read rust-version from Cargo.toml once
|
||||
@@ -85,25 +91,11 @@ jobs:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
path: freemkv-keysources
|
||||
- uses: actions/checkout@v7
|
||||
- uses: freemkv/.github/.github/actions/checkout-siblings@v1
|
||||
with:
|
||||
repository: freemkv/libfreemkv
|
||||
ref: "${{ github.ref_name == 'qa' && 'qa' || 'dev' }}"
|
||||
path: libfreemkv
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
repository: freemkv/freemkv-unlock
|
||||
ref: "${{ github.ref_name == 'qa' && 'qa' || 'dev' }}"
|
||||
path: freemkv-unlock
|
||||
- name: Resolve siblings from their dev tips
|
||||
shell: bash
|
||||
working-directory: freemkv-keysources
|
||||
run: |
|
||||
mkdir -p .cargo
|
||||
cat > .cargo/config.toml <<'EOF'
|
||||
[patch.crates-io]
|
||||
libfreemkv = { path = "../libfreemkv" }
|
||||
EOF
|
||||
checkout: libfreemkv freemkv-unlock
|
||||
patch: libfreemkv freemkv-unlock
|
||||
self: freemkv-keysources
|
||||
# fmt runs on the MSRV pin; clippy runs on stable so new-lint debt is a
|
||||
# blocking gate the pinned toolchain would hide. Stable is installed first
|
||||
# for clippy; the MSRV pin goes second so it stays fmt's default toolchain.
|
||||
@@ -130,25 +122,11 @@ jobs:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
path: freemkv-keysources
|
||||
- uses: actions/checkout@v7
|
||||
- uses: freemkv/.github/.github/actions/checkout-siblings@v1
|
||||
with:
|
||||
repository: freemkv/libfreemkv
|
||||
ref: "${{ github.ref_name == 'qa' && 'qa' || 'dev' }}"
|
||||
path: libfreemkv
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
repository: freemkv/freemkv-unlock
|
||||
ref: "${{ github.ref_name == 'qa' && 'qa' || 'dev' }}"
|
||||
path: freemkv-unlock
|
||||
- name: Resolve siblings from their dev tips
|
||||
shell: bash
|
||||
working-directory: freemkv-keysources
|
||||
run: |
|
||||
mkdir -p .cargo
|
||||
cat > .cargo/config.toml <<'EOF'
|
||||
[patch.crates-io]
|
||||
libfreemkv = { path = "../libfreemkv" }
|
||||
EOF
|
||||
checkout: libfreemkv freemkv-unlock
|
||||
patch: libfreemkv freemkv-unlock
|
||||
self: freemkv-keysources
|
||||
- uses: dtolnay/rust-toolchain@master
|
||||
with:
|
||||
toolchain: ${{ needs.resolve-msrv.outputs.v }}
|
||||
@@ -168,30 +146,16 @@ jobs:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
path: freemkv-keysources
|
||||
- uses: actions/checkout@v7
|
||||
- uses: freemkv/.github/.github/actions/checkout-siblings@v1
|
||||
with:
|
||||
repository: freemkv/libfreemkv
|
||||
ref: "${{ github.ref_name == 'qa' && 'qa' || 'dev' }}"
|
||||
path: libfreemkv
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
repository: freemkv/freemkv-unlock
|
||||
ref: "${{ github.ref_name == 'qa' && 'qa' || 'dev' }}"
|
||||
path: freemkv-unlock
|
||||
- name: Resolve siblings from their dev tips
|
||||
shell: bash
|
||||
working-directory: freemkv-keysources
|
||||
run: |
|
||||
mkdir -p .cargo
|
||||
cat > .cargo/config.toml <<'EOF'
|
||||
[patch.crates-io]
|
||||
libfreemkv = { path = "../libfreemkv" }
|
||||
EOF
|
||||
checkout: libfreemkv freemkv-unlock
|
||||
patch: libfreemkv freemkv-unlock
|
||||
self: freemkv-keysources
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
- uses: EmbarkStudios/cargo-deny-action@v2
|
||||
with:
|
||||
command: check advisories bans licenses sources
|
||||
manifest-path: freemkv-keysources/Cargo.toml
|
||||
- uses: taiki-e/install-action@cargo-deny
|
||||
# Run from the repo dir so the generated .cargo/config.toml path patches apply.
|
||||
- run: cargo deny --all-features check advisories bans licenses sources
|
||||
working-directory: freemkv-keysources
|
||||
|
||||
# This crate ships wherever freemkv and autorip ship, and it drags in all of
|
||||
# libfreemkv's platform code (SCSI transports included). Build the tests, not
|
||||
@@ -206,9 +170,8 @@ jobs:
|
||||
# to agree is what a release candidate is for.
|
||||
#
|
||||
# `if` SKIPS the job (it does not queue). A queued job would be far worse
|
||||
# than a slow one: release.sh's CI gate refuses while any run for the
|
||||
# commit is still in progress, so a never-scheduled job blocks releases
|
||||
# silently -- see the note on real-media in qa.yml.
|
||||
# than a slow one: a never-scheduled job leaves the run pending forever, so
|
||||
# the branch's required checks never report complete.
|
||||
needs: resolve-msrv
|
||||
if: github.ref_name == 'qa' || github.ref_name == 'main'
|
||||
runs-on: macos-latest
|
||||
@@ -216,25 +179,11 @@ jobs:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
path: freemkv-keysources
|
||||
- uses: actions/checkout@v7
|
||||
- uses: freemkv/.github/.github/actions/checkout-siblings@v1
|
||||
with:
|
||||
repository: freemkv/libfreemkv
|
||||
ref: "${{ github.ref_name == 'qa' && 'qa' || 'dev' }}"
|
||||
path: libfreemkv
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
repository: freemkv/freemkv-unlock
|
||||
ref: "${{ github.ref_name == 'qa' && 'qa' || 'dev' }}"
|
||||
path: freemkv-unlock
|
||||
- name: Resolve siblings from their dev tips
|
||||
shell: bash
|
||||
working-directory: freemkv-keysources
|
||||
run: |
|
||||
mkdir -p .cargo
|
||||
cat > .cargo/config.toml <<'EOF'
|
||||
[patch.crates-io]
|
||||
libfreemkv = { path = "../libfreemkv" }
|
||||
EOF
|
||||
checkout: libfreemkv freemkv-unlock
|
||||
patch: libfreemkv freemkv-unlock
|
||||
self: freemkv-keysources
|
||||
- uses: dtolnay/rust-toolchain@master
|
||||
with:
|
||||
toolchain: ${{ needs.resolve-msrv.outputs.v }}
|
||||
@@ -257,25 +206,11 @@ jobs:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
path: freemkv-keysources
|
||||
- uses: actions/checkout@v7
|
||||
- uses: freemkv/.github/.github/actions/checkout-siblings@v1
|
||||
with:
|
||||
repository: freemkv/libfreemkv
|
||||
ref: "${{ github.ref_name == 'qa' && 'qa' || 'dev' }}"
|
||||
path: libfreemkv
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
repository: freemkv/freemkv-unlock
|
||||
ref: "${{ github.ref_name == 'qa' && 'qa' || 'dev' }}"
|
||||
path: freemkv-unlock
|
||||
- name: Resolve siblings from their dev tips
|
||||
shell: bash
|
||||
working-directory: freemkv-keysources
|
||||
run: |
|
||||
mkdir -p .cargo
|
||||
cat > .cargo/config.toml <<'EOF'
|
||||
[patch.crates-io]
|
||||
libfreemkv = { path = "../libfreemkv" }
|
||||
EOF
|
||||
checkout: libfreemkv freemkv-unlock
|
||||
patch: libfreemkv freemkv-unlock
|
||||
self: freemkv-keysources
|
||||
- uses: dtolnay/rust-toolchain@master
|
||||
with:
|
||||
toolchain: ${{ needs.resolve-msrv.outputs.v }}
|
||||
@@ -303,9 +238,8 @@ jobs:
|
||||
# to agree is what a release candidate is for.
|
||||
#
|
||||
# `if` SKIPS the job (it does not queue). A queued job would be far worse
|
||||
# than a slow one: release.sh's CI gate refuses while any run for the
|
||||
# commit is still in progress, so a never-scheduled job blocks releases
|
||||
# silently -- see the note on real-media in qa.yml.
|
||||
# than a slow one: a never-scheduled job leaves the run pending forever, so
|
||||
# the branch's required checks never report complete.
|
||||
needs: resolve-msrv
|
||||
if: github.ref_name == 'qa' || github.ref_name == 'main'
|
||||
runs-on: windows-latest
|
||||
@@ -313,25 +247,11 @@ jobs:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
path: freemkv-keysources
|
||||
- uses: actions/checkout@v7
|
||||
- uses: freemkv/.github/.github/actions/checkout-siblings@v1
|
||||
with:
|
||||
repository: freemkv/libfreemkv
|
||||
ref: "${{ github.ref_name == 'qa' && 'qa' || 'dev' }}"
|
||||
path: libfreemkv
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
repository: freemkv/freemkv-unlock
|
||||
ref: "${{ github.ref_name == 'qa' && 'qa' || 'dev' }}"
|
||||
path: freemkv-unlock
|
||||
- name: Resolve siblings from their dev tips
|
||||
shell: bash
|
||||
working-directory: freemkv-keysources
|
||||
run: |
|
||||
mkdir -p .cargo
|
||||
cat > .cargo/config.toml <<'EOF'
|
||||
[patch.crates-io]
|
||||
libfreemkv = { path = "../libfreemkv" }
|
||||
EOF
|
||||
checkout: libfreemkv freemkv-unlock
|
||||
patch: libfreemkv freemkv-unlock
|
||||
self: freemkv-keysources
|
||||
- uses: dtolnay/rust-toolchain@master
|
||||
with:
|
||||
toolchain: ${{ needs.resolve-msrv.outputs.v }}
|
||||
|
||||
@@ -1,17 +1,12 @@
|
||||
name: comment-guard
|
||||
|
||||
# Caps explanatory prose by COMMENT INTENT (not visibility):
|
||||
# //! / /*! module docs — unbounded (module-scoped, can't hide per-item text)
|
||||
# /// / /** */ item docs — 8 prose lines (fenced ``` examples excluded)
|
||||
# // / /* */ asides — 3 lines (single-blank-separated runs count as one)
|
||||
# Overflow belongs in the module //! or docs/<topic>.md with a one-line // pointer.
|
||||
|
||||
# Thin caller → the canonical reusable guard in freemkv/.github (one definition
|
||||
# for every repo). Fork PRs still run it; same-repo pushes aren't double-run.
|
||||
on: [push, pull_request]
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
jobs:
|
||||
comment-guard:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
- name: Run comment-guard
|
||||
run: python3 ci/comment-guard.py
|
||||
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork
|
||||
uses: freemkv/.github/.github/workflows/guard-comment.yml@v2
|
||||
|
||||
@@ -1,41 +1,14 @@
|
||||
name: identity-guard
|
||||
# Prevention: no commit may carry an unrelated-business or non-canonical author/
|
||||
# committer email. dev@example.com (a dead corp address) once slipped onto the
|
||||
# release cascade + a batch of local commits; this fails the build if it recurs.
|
||||
|
||||
# Thin caller → the canonical reusable guard in freemkv/.github.
|
||||
on:
|
||||
push:
|
||||
branches: [dev, qa, main]
|
||||
pull_request:
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
jobs:
|
||||
identity:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Reject banned author/committer emails
|
||||
env:
|
||||
BEFORE: ${{ github.event.before }}
|
||||
AFTER: ${{ github.sha }}
|
||||
EVENT: ${{ github.event_name }}
|
||||
PR_BASE: ${{ github.event.pull_request.base.sha }}
|
||||
PR_HEAD: ${{ github.event.pull_request.head.sha }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
# Unrelated business domains + a personal address normalized to the
|
||||
# GitHub noreply. Real external contributors are unaffected.
|
||||
BANNED='@example-a\.invalid|@example-b\.invalid|owner@example\.invalid'
|
||||
if [ "$EVENT" = "pull_request" ]; then
|
||||
range="$PR_BASE..$PR_HEAD"
|
||||
elif [ -n "${BEFORE:-}" ] && [ "$BEFORE" != "0000000000000000000000000000000000000000" ] && git cat-file -e "$BEFORE" 2>/dev/null; then
|
||||
range="$BEFORE..$AFTER"
|
||||
else
|
||||
range="$AFTER~1..$AFTER"
|
||||
fi
|
||||
bad=$(git log --format='%an <%ae>%n%cn <%ce>' "$range" 2>/dev/null | sort -u | grep -iE "$BANNED" || true)
|
||||
if [ -n "$bad" ]; then
|
||||
echo "::error::commit(s) carry a banned author/committer identity:"; echo "$bad" | sed 's/^/ /'
|
||||
echo "::error::Commit as your GitHub noreply (1085847+MattJackson@users.noreply.github.com). Fix: git config user.email <noreply>; git commit --amend --reset-author."
|
||||
exit 1
|
||||
fi
|
||||
echo "identity-guard: clean"
|
||||
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork
|
||||
uses: freemkv/.github/.github/workflows/guard-identity.yml@v1
|
||||
|
||||
@@ -1,35 +1,11 @@
|
||||
name: leak-guard
|
||||
|
||||
# Self-contained public-repo leak gate. Public CI cannot reach the private
|
||||
# tooling, so this encodes only the generic net: internal-infra references,
|
||||
# tracked CLAUDE.md/.claude paths, and AI-attribution in commit messages.
|
||||
# No project-specific reverse-engineering vocabulary lives here.
|
||||
|
||||
# Thin caller → the canonical reusable guard in freemkv/.github.
|
||||
on: [push, pull_request]
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
jobs:
|
||||
leak-guard:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- name: Compute commit range
|
||||
id: range
|
||||
run: |
|
||||
if [ "${{ github.event_name }}" = "pull_request" ]; then
|
||||
base="${{ github.event.pull_request.base.sha }}"
|
||||
head="${{ github.event.pull_request.head.sha }}"
|
||||
echo "range=$base..$head" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
before="${{ github.event.before }}"
|
||||
after="${{ github.sha }}"
|
||||
# New branch / first push: github.event.before is all-zeros.
|
||||
if [ -z "$before" ] || [ "$before" = "0000000000000000000000000000000000000000" ]; then
|
||||
echo "range=$after" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "range=$before..$after" >> "$GITHUB_OUTPUT"
|
||||
fi
|
||||
fi
|
||||
- name: Run leak-guard
|
||||
run: bash ci/leak-guard.sh "${{ steps.range.outputs.range }}"
|
||||
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork
|
||||
uses: freemkv/.github/.github/workflows/guard-leak.yml@v1
|
||||
|
||||
+20
-57
@@ -13,16 +13,21 @@ name: qa
|
||||
# Sibling repos are checked out at `qa`, NOT `dev`. A qa run that resolved its
|
||||
# dependencies from dev tips would be validating a combination that is not the
|
||||
# one being released, which is the exact failure this branch exists to prevent.
|
||||
# The shared checkout-siblings composite resolves qa->qa from the caller branch.
|
||||
#
|
||||
# What this gate CANNOT cover: `disc://` and real `iso://` need physical media,
|
||||
# and no hosted runner has an optical drive or the image hoard. Those run on a
|
||||
# self-hosted runner (see the media job at the end) and are the one leg that
|
||||
# stays on hardware.
|
||||
# and no hosted runner has an optical drive or the image hoard. That coverage
|
||||
# lives in freemkv's qa.yml (the real-media EC2 matrix), not in this file.
|
||||
on:
|
||||
push:
|
||||
branches: [qa]
|
||||
workflow_dispatch:
|
||||
|
||||
# Supersede an in-progress qa run when a newer candidate lands on the branch.
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
# Single source of truth for the MSRV — see ci.yml. Jobs that build/test AT
|
||||
# the MSRV read needs.resolve-msrv.outputs.v from Cargo.toml's rust-version;
|
||||
@@ -88,25 +93,11 @@ jobs:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
path: freemkv-keysources
|
||||
- uses: actions/checkout@v7
|
||||
- uses: freemkv/.github/.github/actions/checkout-siblings@v1
|
||||
with:
|
||||
repository: freemkv/libfreemkv
|
||||
ref: qa
|
||||
path: libfreemkv
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
repository: freemkv/freemkv-unlock
|
||||
ref: qa
|
||||
path: freemkv-unlock
|
||||
- name: Resolve siblings from their qa tips
|
||||
shell: bash
|
||||
working-directory: freemkv-keysources
|
||||
run: |
|
||||
mkdir -p .cargo
|
||||
cat > .cargo/config.toml <<'EOF'
|
||||
[patch.crates-io]
|
||||
libfreemkv = { path = "../libfreemkv" }
|
||||
EOF
|
||||
checkout: libfreemkv freemkv-unlock
|
||||
patch: libfreemkv freemkv-unlock
|
||||
self: freemkv-keysources
|
||||
- uses: dtolnay/rust-toolchain@master
|
||||
with:
|
||||
toolchain: ${{ needs.resolve-msrv.outputs.v }}
|
||||
@@ -125,25 +116,11 @@ jobs:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
path: freemkv-keysources
|
||||
- uses: actions/checkout@v7
|
||||
- uses: freemkv/.github/.github/actions/checkout-siblings@v1
|
||||
with:
|
||||
repository: freemkv/libfreemkv
|
||||
ref: qa
|
||||
path: libfreemkv
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
repository: freemkv/freemkv-unlock
|
||||
ref: qa
|
||||
path: freemkv-unlock
|
||||
- name: Resolve siblings from their qa tips
|
||||
shell: bash
|
||||
working-directory: freemkv-keysources
|
||||
run: |
|
||||
mkdir -p .cargo
|
||||
cat > .cargo/config.toml <<'EOF'
|
||||
[patch.crates-io]
|
||||
libfreemkv = { path = "../libfreemkv" }
|
||||
EOF
|
||||
checkout: libfreemkv freemkv-unlock
|
||||
patch: libfreemkv freemkv-unlock
|
||||
self: freemkv-keysources
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
with:
|
||||
components: clippy
|
||||
@@ -165,25 +142,11 @@ jobs:
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
path: freemkv-keysources
|
||||
- uses: actions/checkout@v7
|
||||
- uses: freemkv/.github/.github/actions/checkout-siblings@v1
|
||||
with:
|
||||
repository: freemkv/libfreemkv
|
||||
ref: qa
|
||||
path: libfreemkv
|
||||
- uses: actions/checkout@v7
|
||||
with:
|
||||
repository: freemkv/freemkv-unlock
|
||||
ref: qa
|
||||
path: freemkv-unlock
|
||||
- name: Resolve siblings from their qa tips
|
||||
shell: bash
|
||||
working-directory: freemkv-keysources
|
||||
run: |
|
||||
mkdir -p .cargo
|
||||
cat > .cargo/config.toml <<'EOF'
|
||||
[patch.crates-io]
|
||||
libfreemkv = { path = "../libfreemkv" }
|
||||
EOF
|
||||
checkout: libfreemkv freemkv-unlock
|
||||
patch: libfreemkv freemkv-unlock
|
||||
self: freemkv-keysources
|
||||
- uses: dtolnay/rust-toolchain@master
|
||||
with:
|
||||
toolchain: ${{ needs.resolve-msrv.outputs.v }}
|
||||
|
||||
@@ -29,14 +29,14 @@ jobs:
|
||||
|
||||
# Tests run as a PARALLEL TRIPWIRE: they fail the run if they fail, but the
|
||||
# release job does NOT `needs:` this job. The tag decision was already gated by
|
||||
# the local precommit (same MSRV, same commit).
|
||||
# CI (ci.yml on dev, then a green qa.yml on the same commit).
|
||||
#
|
||||
# Cargo.lock is now committed (issue #15), but --locked is still omitted: on
|
||||
# the runner the libfreemkv dep resolves from crates.io, not the local path
|
||||
# patch, which --locked can't reconcile. Its
|
||||
# libfreemkv dep resolves from crates.io (the dev .cargo/config.toml patch is
|
||||
# gitignored and absent on the runner), so libfreemkv must already be published
|
||||
# at this version — the release script enforces that ordering before tagging.
|
||||
# at this version — release-orchestrate.yml enforces that ordering before tagging.
|
||||
test:
|
||||
needs: verify
|
||||
runs-on: ubuntu-latest
|
||||
@@ -51,12 +51,10 @@ jobs:
|
||||
- uses: Swatinem/rust-cache@v2
|
||||
- run: cargo test
|
||||
|
||||
# NOTE: the crates.io publish is driven by the maintainer's release tooling
|
||||
# from local credentials, not from CI — this repo has no CARGO_REGISTRY_TOKEN
|
||||
# secret. release.sh runs `cargo publish --no-verify` locally. CI here only
|
||||
# verifies the version/tag match, runs tests (tripwire), and cuts the GitHub
|
||||
# Release. The binaries git-tag-pin keysources, so they don't wait on the
|
||||
# crates.io publish — it serves external consumers in parallel.
|
||||
# NOTE: there is no crates.io publish — keysources is `publish = false` and
|
||||
# git-tag-only. Consumers git-tag-pin it via a committed [patch.crates-io], so
|
||||
# the git tag itself is the release artifact. CI here only verifies the
|
||||
# version/tag match, runs tests (tripwire), and cuts the GitHub Release.
|
||||
|
||||
release:
|
||||
# Only needs `verify`; the GitHub Release is cut as soon as the version
|
||||
|
||||
@@ -1,5 +1,65 @@
|
||||
# Changelog
|
||||
|
||||
## [1.8.2] — Unreleased
|
||||
|
||||
### Added
|
||||
|
||||
- The online source logs its connection-slot wait and DNS time before each request.
|
||||
|
||||
## [1.8.1] — 2026-10-07
|
||||
|
||||
### Changed
|
||||
|
||||
- Unit tests live in `*_tests.rs` side files. No behaviour change.
|
||||
|
||||
## [1.8.0] — 2026-10-05
|
||||
|
||||
### Fixed
|
||||
|
||||
- The online key service ignores `HTTP_PROXY`/`HTTPS_PROXY`/`ALL_PROXY`: with one set, every key lookup failed (the pinned resolver also answered the proxy's address, so the proxy request went to the key service).
|
||||
|
||||
### Changed
|
||||
|
||||
- `KeydbSource` hands out host certs best first, with no disc input: certs with no `Revoked in MKBv<N>` note in keydb order, then revoked ones by latest revocation. The inherent `host_certs()` and the `KeySource::host_certs` trait method both return this order; the trait ignores its `mkb` argument.
|
||||
|
||||
### Deprecated
|
||||
|
||||
- `KeyDb::host_certs(mkb)`: use `KeyDb::host_certs_ranked`.
|
||||
|
||||
### Added
|
||||
|
||||
- `KeyDb::host_certs_ranked`.
|
||||
- `check_keyserver_url` with `KeyserverUrlRejection`/`KeyserverUrlFault`: a typed Permanent vs Temporary verdict, so callers need not match `validate_keyserver_url`'s text.
|
||||
- `test-hooks` feature exposing `set_last_decode_reachability`, to test decode-verdict handling without a network.
|
||||
|
||||
## [1.7.7] — 2026-09-26
|
||||
|
||||
### Maintenance
|
||||
|
||||
- Replace comment-overflow documentation with concise source contracts and README instructions; enforce the shared comment policy in CI.
|
||||
|
||||
## [1.7.6] — 2026-09-26
|
||||
|
||||
### Changed
|
||||
|
||||
- Version aligned to 1.7.6 for the unified release. No functional changes to this crate; the release is driven by the freemkv 1.7.6 Linux desktop shell (GTK4 + libadwaita) and the rip-finished desktop notification (issue #56).
|
||||
|
||||
## [1.7.5] — 2026-09-23
|
||||
|
||||
### Changed
|
||||
|
||||
- Version aligned to 1.7.5 for the unified release. No functional changes to this crate; the release is driven by freemkv-unlock mirroring the freemkv-firmware 0.9.0 ABI (the drive's `Ake` and `Bus` levers retired into a single `Encryption` lever).
|
||||
|
||||
## [1.7.4] — 2026-09-21
|
||||
### Fixed
|
||||
|
||||
- keydb lookups now report match state and entry shape, so a "no entry" result tells you whether the disc was truly absent or matched-but-underivable (no usable VID) (#46).
|
||||
- ureq 3.4.2 with a bounded, rolling-idle reply body, so a slow-but-progressing download is no longer killed by an absolute deadline.
|
||||
|
||||
### Maintenance
|
||||
|
||||
- CI moved to the central reusable workflows.
|
||||
|
||||
## [1.7.3] — 2026-09-19
|
||||
|
||||
### Changed
|
||||
|
||||
Generated
+75
-8
@@ -31,6 +31,12 @@ version = "0.23.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "ac07cdecf99051d9a5238b80f35af32cdeba5b336e55d957b318b50137e18da5"
|
||||
|
||||
[[package]]
|
||||
name = "bitflags"
|
||||
version = "2.13.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3ded4057c258ba199e2d26386d3af3780957ecaee6c4ef4041c6b4b8b97c0b06"
|
||||
|
||||
[[package]]
|
||||
name = "block-buffer"
|
||||
version = "0.12.1"
|
||||
@@ -240,6 +246,16 @@ version = "1.0.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f"
|
||||
|
||||
[[package]]
|
||||
name = "errno"
|
||||
version = "0.3.14"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "39cab71617ae0d63f51a36d69f866391735b51691dbda63cf6f96d042b63efeb"
|
||||
dependencies = [
|
||||
"libc",
|
||||
"windows-sys 0.52.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "find-msvc-tools"
|
||||
version = "0.1.11"
|
||||
@@ -268,7 +284,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "freemkv-keysources"
|
||||
version = "1.7.1"
|
||||
version = "1.7.7"
|
||||
dependencies = [
|
||||
"base64",
|
||||
"flate2",
|
||||
@@ -281,7 +297,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "freemkv-unlock"
|
||||
version = "1.7.1"
|
||||
version = "1.7.7"
|
||||
dependencies = [
|
||||
"aes",
|
||||
"base64",
|
||||
@@ -487,7 +503,7 @@ checksum = "3eaf3ede3fee6db1a4c2ee091bf8a8b4dccdc6d17f656fb07896ee72867612f2"
|
||||
|
||||
[[package]]
|
||||
name = "libfreemkv"
|
||||
version = "1.7.1"
|
||||
version = "1.7.7"
|
||||
dependencies = [
|
||||
"aes",
|
||||
"base64",
|
||||
@@ -497,13 +513,22 @@ dependencies = [
|
||||
"memchr",
|
||||
"rayon",
|
||||
"roxmltree",
|
||||
"rustix",
|
||||
"serde",
|
||||
"serde_json",
|
||||
"sha1",
|
||||
"sha2",
|
||||
"socket2",
|
||||
"tracing",
|
||||
"zip",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "linux-raw-sys"
|
||||
version = "0.12.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "32a66949e030da00e8c7d4434b251670a91556f4144941d37452769c25d58a53"
|
||||
|
||||
[[package]]
|
||||
name = "litemap"
|
||||
version = "0.8.3"
|
||||
@@ -677,7 +702,7 @@ dependencies = [
|
||||
"getrandom 0.2.17",
|
||||
"libc",
|
||||
"untrusted",
|
||||
"windows-sys",
|
||||
"windows-sys 0.52.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -686,6 +711,19 @@ version = "0.20.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "6c20b6793b5c2fa6553b250154b78d6d0db37e72700ae35fad9387a46f487c97"
|
||||
|
||||
[[package]]
|
||||
name = "rustix"
|
||||
version = "1.1.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "891efababe418670775f199f0d233d84843c227a0949a883ce15b37c78d6629d"
|
||||
dependencies = [
|
||||
"bitflags",
|
||||
"errno",
|
||||
"libc",
|
||||
"linux-raw-sys",
|
||||
"windows-sys 0.52.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "rustls"
|
||||
version = "0.23.45"
|
||||
@@ -804,6 +842,16 @@ version = "1.16.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "b9be42f50aa861c555654aa3a37f52f4b1074bacf4e48fe0ef7fa584e80f1f0f"
|
||||
|
||||
[[package]]
|
||||
name = "socket2"
|
||||
version = "0.6.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c3d1e2c7f27f8d4cb10542a02c49005dbd6e93095799d6f3be745fae9f8fedd4"
|
||||
dependencies = [
|
||||
"libc",
|
||||
"windows-sys 0.61.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "stable_deref_trait"
|
||||
version = "1.2.1"
|
||||
@@ -946,9 +994,9 @@ checksum = "8ecb6da28b8a351d773b68d5825ac39017e680750f980f3a1a85cd8dd28a47c1"
|
||||
|
||||
[[package]]
|
||||
name = "ureq"
|
||||
version = "3.4.0"
|
||||
version = "3.4.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "972d7902c8735f2695410b8aed7df6ed12a47394aa1c8d7af49f0497b731a94d"
|
||||
checksum = "9a7ac20be9b7726e0bbdbf974c059676d9acb1cd414961f570a4e8231cacd7fc"
|
||||
dependencies = [
|
||||
"base64",
|
||||
"cookie_store",
|
||||
@@ -1021,6 +1069,12 @@ dependencies = [
|
||||
"rustls-pki-types",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "windows-link"
|
||||
version = "0.2.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
|
||||
|
||||
[[package]]
|
||||
name = "windows-sys"
|
||||
version = "0.52.0"
|
||||
@@ -1030,6 +1084,15 @@ dependencies = [
|
||||
"windows-targets",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "windows-sys"
|
||||
version = "0.61.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc"
|
||||
dependencies = [
|
||||
"windows-link",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "windows-targets"
|
||||
version = "0.52.6"
|
||||
@@ -1237,8 +1300,12 @@ dependencies = [
|
||||
|
||||
[[patch.unused]]
|
||||
name = "freemkv-engine"
|
||||
version = "1.7.1"
|
||||
version = "1.7.7"
|
||||
|
||||
[[patch.unused]]
|
||||
name = "freemkv-i18n"
|
||||
version = "1.7.1"
|
||||
version = "1.7.7"
|
||||
|
||||
[[patch.unused]]
|
||||
name = "freemkv-keysources"
|
||||
version = "1.7.7"
|
||||
|
||||
+13
-3
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "freemkv-keysources"
|
||||
version = "1.7.3"
|
||||
version = "1.8.1"
|
||||
edition = "2024"
|
||||
rust-version = "1.88"
|
||||
license = "MIT"
|
||||
@@ -17,7 +17,7 @@ publish = false
|
||||
# The crate provides the `KeySource` trait + `Key`/`DiscInputs` types these impls fill.
|
||||
# libfreemkv is git-only now; the committed [patch.crates-io] below redirects this
|
||||
# bare version req to the libfreemkv git tag (local dev overrides it to a path).
|
||||
libfreemkv = "1.7"
|
||||
libfreemkv = "1.8"
|
||||
# OnlineSource: POST disc inputs + samples to a key service over HTTP.
|
||||
ureq = { version = "3", features = ["json"] }
|
||||
serde_json = "1"
|
||||
@@ -30,6 +30,15 @@ zip = { version = "8", default-features = false, features = ["deflate"] }
|
||||
# key material).
|
||||
tracing = "0.1"
|
||||
|
||||
[features]
|
||||
# `set_last_decode_reachability`, for consumers' tests only (enable in dev-dependencies).
|
||||
test-hooks = []
|
||||
|
||||
[dev-dependencies]
|
||||
# `test_util` fixtures (`decrypt_unit`, …) for this crate's tests (keys-upfront
|
||||
# KU-P1). CI resolves it through the sibling path patch.
|
||||
libfreemkv = { version = "1.8", features = ["test-util"] }
|
||||
|
||||
[profile.release]
|
||||
lto = "thin"
|
||||
codegen-units = 1
|
||||
@@ -40,7 +49,8 @@ codegen-units = 1
|
||||
# overrides it with a path patch via the gitignored .cargo/config.toml (a
|
||||
# config-level [patch.crates-io] wins over this manifest one for the same crate).
|
||||
[patch.crates-io]
|
||||
libfreemkv = { git = "https://github.com/freemkv/libfreemkv", tag = "v1.7.3" }
|
||||
libfreemkv = { git = "https://github.com/freemkv/libfreemkv", tag = "v1.8.1" }
|
||||
freemkv-unlock = { git = "https://github.com/freemkv/freemkv-unlock", tag = "v1.8.1" }
|
||||
|
||||
[lints.clippy]
|
||||
uninlined_format_args = "allow"
|
||||
|
||||
@@ -9,6 +9,13 @@ Pluggable AACS key sources (keydb, online key service) for
|
||||
and hands libfreemkv its terminal Unit Keys via `get_unit_keys`; the library
|
||||
does all derivation.
|
||||
|
||||
## Development
|
||||
|
||||
Build API documentation with `cargo doc --no-deps --open` for source construction,
|
||||
keydb paths and online-query contracts. Run `cargo test --tests` to validate
|
||||
parsing, caching and request guards. Tests use synthetic keys and local fixtures;
|
||||
never commit real key material or credentials.
|
||||
|
||||
## License
|
||||
|
||||
MIT — see [LICENSE](LICENSE).
|
||||
|
||||
@@ -1,252 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
"""comment-guard: cap explanatory prose by COMMENT INTENT, not visibility.
|
||||
|
||||
Three tiers, keyed on the syntax the author reached for:
|
||||
|
||||
* `//!` / `/*!` — a module (or crate) design doc. UNBOUNDED. There is one per
|
||||
file, at the top, documenting the module as a whole, so it can't be used to
|
||||
smuggle per-item rationale the way item docs can. Long correctness / design
|
||||
essays (e.g. a memory-ordering proof) legitimately live here.
|
||||
* `///` / `/** */` — item documentation. Up to DOC_CAP *prose* lines. Fenced
|
||||
``` code blocks do NOT count, so real examples aren't punished. This holds
|
||||
whether or not the item is `pub`: a `pub(crate)` fn deserves a real doc
|
||||
paragraph just like a `pub` one. Capping `///` here (rather than exempting
|
||||
it, as the old guard did — issue #17) is what stops rationale being hidden
|
||||
behind a doc sigil, while still leaving room for a genuine paragraph.
|
||||
* `//` / `/* */` — a quick internal aside. Up to INLINE_CAP lines. This is the
|
||||
shape that sprawls into walls, so it's kept tight: stanzas separated by a
|
||||
single blank line count CUMULATIVELY, so one essay can't be split into runs.
|
||||
|
||||
Overflow belongs in the module `//!`, or in docs/<topic>.md with a one-line `//`
|
||||
pointer — both show up in review.
|
||||
|
||||
Scans src/ and tests/ under the given root (default cwd). `--selftest` runs
|
||||
built-in cases. Exit non-zero if any block exceeds its cap.
|
||||
"""
|
||||
import re
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
INLINE_CAP = 3
|
||||
DOC_CAP = 8
|
||||
|
||||
_RAW_OPEN = re.compile(r'r(#*)"') # raw string opener: r"…", r#"…"#, br##"…"## …
|
||||
|
||||
|
||||
def _strip_line_comment(s):
|
||||
"""Return (kind, body) for a whole-line comment, else (None, None).
|
||||
|
||||
kind is 'doc' for `///`/`//!`, 'plain' for other `//`. A trailing comment on
|
||||
a code line is not a whole-line comment and is ignored (single-line, cheap).
|
||||
"""
|
||||
if s.startswith("//!"):
|
||||
return "doc", s[3:]
|
||||
if s.startswith("///") and not s.startswith("////"):
|
||||
return "doc", s[3:]
|
||||
if s.startswith("//"):
|
||||
return "plain", s[2:]
|
||||
return None, None
|
||||
|
||||
|
||||
def _fence_toggle(body):
|
||||
"""True if this doc body line opens/closes a ``` fenced code block."""
|
||||
return body.strip().startswith("```")
|
||||
|
||||
|
||||
def _classify(lines):
|
||||
"""Yield per-line dicts: comment kind ('doc'/'plain'/None), doc-ness of
|
||||
block comments, and code info. Block comments are tracked across lines.
|
||||
"""
|
||||
info = []
|
||||
in_block = False
|
||||
block_is_doc = False
|
||||
raw_hashes = None # None = not in a raw string; int N = open, needs '"' + N*'#'
|
||||
for raw in lines:
|
||||
s = raw.lstrip()
|
||||
rec = {"raw": raw, "s": s, "comment": None, "is_doc": False, "code": False}
|
||||
# Inside a raw string literal (e.g. an embedded HTML/CSS/JS asset): the
|
||||
# bytes are string data, not Rust comments, so the guard is blind to them
|
||||
# until the string closes. Prevents `/* */` or `//` lines in an embedded
|
||||
# page from being counted as comment blocks.
|
||||
if raw_hashes is not None:
|
||||
if ('"' + "#" * raw_hashes) in raw:
|
||||
raw_hashes = None
|
||||
info.append(rec)
|
||||
continue
|
||||
if in_block:
|
||||
rec["comment"] = "doc" if block_is_doc else "plain"
|
||||
rec["is_doc"] = block_is_doc
|
||||
if "*/" in raw:
|
||||
in_block = False
|
||||
info.append(rec)
|
||||
continue
|
||||
# A block comment only starts a comment-line if it's the first token.
|
||||
if s.startswith("/*"):
|
||||
rec["is_doc"] = s.startswith("/**") or s.startswith("/*!")
|
||||
rec["comment"] = "doc" if rec["is_doc"] else "plain"
|
||||
if "*/" not in s[2:]:
|
||||
in_block = True
|
||||
block_is_doc = rec["is_doc"]
|
||||
info.append(rec)
|
||||
continue
|
||||
kind, _ = _strip_line_comment(s)
|
||||
if kind is not None:
|
||||
rec["comment"] = kind
|
||||
rec["is_doc"] = kind == "doc"
|
||||
info.append(rec)
|
||||
continue
|
||||
# Code (or blank). Blank = empty after strip.
|
||||
rec["code"] = s != ""
|
||||
# A code line may OPEN a raw string that spans following lines. Detected
|
||||
# only on code (comments were handled above), so `// see r"x"` is safe.
|
||||
m = _RAW_OPEN.search(raw)
|
||||
if m and ('"' + "#" * len(m.group(1))) not in raw[m.end():]:
|
||||
raw_hashes = len(m.group(1))
|
||||
info.append(rec)
|
||||
return info
|
||||
|
||||
|
||||
def violations(path):
|
||||
lines = path.read_text(encoding="utf-8", errors="replace").splitlines()
|
||||
info = _classify(lines)
|
||||
n = len(info)
|
||||
out = []
|
||||
|
||||
i = 0
|
||||
while i < n:
|
||||
rec = info[i]
|
||||
if rec["comment"] is None:
|
||||
i += 1
|
||||
continue
|
||||
|
||||
start = i
|
||||
if rec["is_doc"]:
|
||||
# Doc run: contiguous doc lines. `//!` / `/*!` module docs are
|
||||
# UNBOUNDED; any other doc run caps PROSE (fenced ``` excluded) at
|
||||
# DOC_CAP, regardless of the documented item's visibility.
|
||||
j = i
|
||||
prose = 0
|
||||
in_fence = False
|
||||
module_doc = False
|
||||
while j < n and info[j]["comment"] == "doc":
|
||||
s = info[j]["s"]
|
||||
if s.startswith("//!") or s.startswith("/*!"):
|
||||
module_doc = True
|
||||
body = (
|
||||
s[3:] if (s.startswith("///") or s.startswith("//!")) else s
|
||||
)
|
||||
if _fence_toggle(body):
|
||||
in_fence = not in_fence
|
||||
elif not in_fence and body.strip() != "":
|
||||
prose += 1
|
||||
j += 1
|
||||
if not module_doc and prose > DOC_CAP:
|
||||
out.append((start + 1, prose, DOC_CAP, "doc prose"))
|
||||
i = j
|
||||
continue
|
||||
|
||||
# Internal (plain) run, with single-blank bridging (cumulative).
|
||||
j = i
|
||||
count = 0
|
||||
while j < n:
|
||||
r = info[j]
|
||||
if r["comment"] == "plain":
|
||||
count += 1
|
||||
j += 1
|
||||
continue
|
||||
if r["comment"] == "doc":
|
||||
break
|
||||
if r["comment"] is None and not r["code"]:
|
||||
# blank: bridge only a SINGLE blank, else stop
|
||||
if j + 1 < n and info[j + 1]["comment"] == "plain":
|
||||
j += 1
|
||||
continue
|
||||
break
|
||||
break # code
|
||||
if count > INLINE_CAP:
|
||||
out.append((start + 1, count, INLINE_CAP, "inline comment"))
|
||||
i = j
|
||||
return out
|
||||
|
||||
|
||||
def main(argv):
|
||||
if "--selftest" in argv:
|
||||
return _selftest()
|
||||
root = Path(argv[1]) if len(argv) > 1 else Path.cwd()
|
||||
files = sorted(p for d in ("src", "tests") for p in (root / d).rglob("*.rs"))
|
||||
total = 0
|
||||
for f in files:
|
||||
for start, length, cap, kind in violations(f):
|
||||
rel = f.relative_to(root)
|
||||
print(f"{rel}:{start}: {kind} block is {length} lines (max {cap})")
|
||||
total += 1
|
||||
if total:
|
||||
print(f"\ncomment-guard: {total} comment block(s) exceed their cap.")
|
||||
print(
|
||||
f"Inline // asides cap at {INLINE_CAP}; /// item-doc prose caps at "
|
||||
f"{DOC_CAP} (fenced examples excluded); //! module docs are unbounded. "
|
||||
"Trim, move the rationale into the module //!, or docs/<topic>.md "
|
||||
"with a // pointer."
|
||||
)
|
||||
return 1
|
||||
return 0
|
||||
|
||||
|
||||
def _selftest():
|
||||
import tempfile
|
||||
|
||||
cases = [
|
||||
# (rust source, expected number of violations)
|
||||
# short /// doc -> ok
|
||||
("/// short doc\npub fn a() {}\n", 0),
|
||||
# /// on a PRIVATE item now gets the doc cap (8), so 4 lines is fine
|
||||
("/// l1\n/// l2\n/// l3\n/// l4\nfn priv_a() {}\n", 0),
|
||||
# ...but /// is NOT unlimited: 9 prose lines on a private item fails
|
||||
("".join(f"/// l{k}\n" for k in range(9)) + "fn priv_b() {}\n", 1),
|
||||
# 8 prose /// on a pub item -> ok (boundary)
|
||||
("".join(f"/// l{k}\n" for k in range(8)) + "pub fn c() {}\n", 0),
|
||||
# 9 prose /// on a pub item -> violation
|
||||
("".join(f"/// l{k}\n" for k in range(9)) + "pub fn d() {}\n", 1),
|
||||
# /// with a long fenced example -> example excluded, ok
|
||||
(
|
||||
"/// summary\n/// # Examples\n/// ```\n"
|
||||
+ "".join("/// code\n" for _ in range(12))
|
||||
+ "/// ```\npub fn e() {}\n",
|
||||
0,
|
||||
),
|
||||
# pub(crate) gets the SAME doc cap as pub (no pub/private split anymore)
|
||||
("".join(f"/// l{k}\n" for k in range(6)) + "pub(crate) fn f() {}\n", 0),
|
||||
# bare inline 4 lines -> violation
|
||||
("// a\n// b\n// c\n// d\nlet x = 1;\n", 1),
|
||||
# blank-split dodge: 3 + blank + 3 inline -> cumulative -> violation
|
||||
("// a\n// b\n// c\n\n// d\n// e\n// f\nfn z() {}\n", 1),
|
||||
# plain /* */ block, 5 lines -> inline cap -> violation
|
||||
("/* one\n two\n three\n four\n five */\nfn q() {}\n", 1),
|
||||
# comment-like lines INSIDE a raw string are string data, not comments
|
||||
(
|
||||
'const H: &str = r##"<style>\n'
|
||||
+ "".join("/* css note */\n" for _ in range(8))
|
||||
+ '</style>"##;\nfn h() {}\n',
|
||||
0,
|
||||
),
|
||||
# //! module doc may run long -> EXEMPT (no cap)
|
||||
("".join(f"//! l{k}\n" for k in range(40)) + "\npub fn m() {}\n", 0),
|
||||
# /*! block module doc may run long -> EXEMPT
|
||||
("/*! l0\n" + "".join(f" l{k}\n" for k in range(30)) + "*/\nfn n() {}\n", 0),
|
||||
]
|
||||
ok = True
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
for idx, (src, want) in enumerate(cases):
|
||||
p = Path(d) / f"case{idx}.rs"
|
||||
p.write_text(src)
|
||||
got = len(violations(p))
|
||||
flag = "ok" if got == want else "FAIL"
|
||||
if got != want:
|
||||
ok = False
|
||||
print(f" selftest {idx}: want {want} got {got} [{flag}]")
|
||||
print("selftest PASSED" if ok else "selftest FAILED")
|
||||
return 0 if ok else 1
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main(sys.argv))
|
||||
@@ -1,120 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# leak-guard.sh — self-contained public-repo leak gate.
|
||||
#
|
||||
# This is the LAST line of defense in CI. It is intentionally self-contained:
|
||||
# public CI cannot reach the private tooling, so this script encodes ONLY the
|
||||
# generic net — internal infrastructure references, agent-context files, and
|
||||
# AI-attribution in commit messages. It deliberately contains NO project-
|
||||
# specific reverse-engineering vocabulary (those words would themselves be a
|
||||
# leak). The richer private scanner stays private.
|
||||
#
|
||||
# Fails (exit 1) if any of the following appear in the repo:
|
||||
# 1. a tracked CLAUDE.md or .claude/ path (agent context — never public),
|
||||
# 2. tracked file content matching the internal-infra net,
|
||||
# 3. a commit message (in the given range) with AI attribution.
|
||||
#
|
||||
# Usage:
|
||||
# leak-guard.sh [<commit-range>]
|
||||
# <commit-range> optional git rev-list range to scan commit messages
|
||||
# (e.g. "abc..def"). If omitted, commit-message scan is
|
||||
# skipped (path + content checks always run).
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
# Absolute path to this script, resolved before any cd, so we can exclude it
|
||||
# from the content scan (it necessarily contains the detection patterns).
|
||||
SELF_ABS="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/$(basename "${BASH_SOURCE[0]}")"
|
||||
|
||||
REPO="$(git rev-parse --show-toplevel)"
|
||||
cd "$REPO"
|
||||
|
||||
fail=0
|
||||
note() { printf ' ✗ %s\n' "$1"; fail=1; }
|
||||
|
||||
# Internal-infra net — GENERIC ONLY. This script ships in the public repo, so
|
||||
# the patterns themselves must not name any org-specific identifier (doing so
|
||||
# would itself leak the infra they guard). We catch the leak *class*:
|
||||
# - RFC1918 private IPv4 ranges (10/8, 172.16/12, 192.168/16),
|
||||
# - private/internal/non-routable TLDs (.internal/.local/.lan/.corp/.invalid),
|
||||
# - docker.internal.
|
||||
# The full org-specific net (literal hostnames, service names, repo paths,
|
||||
# vendor tooling, …) lives ONLY in the private scanner and never ships here.
|
||||
INFRA_RE='\b10\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}|\b172\.(1[6-9]|2[0-9]|3[01])\.[0-9]{1,3}\.[0-9]{1,3}|\b192\.168\.[0-9]{1,3}\.[0-9]{1,3}|\.internal\b|\.local\b|\.lan\b|\.corp\b|\.invalid\b|docker\.internal'
|
||||
# Home-path net — GENERIC ONLY. Catches an absolute developer home path
|
||||
# committed into a tracked file (a macOS /Users/<user>/… or Linux /home/<user>/…
|
||||
# path). This names NO specific user — it matches the leak *class* (any home
|
||||
# path), so the pattern itself reveals nothing org- or person-specific. A real
|
||||
# leak (e.g. /Users/alice/Developer/x slipping into a public RELEASE.md) trips
|
||||
# this regardless of whose machine it came from. The username segment is a
|
||||
# literal-username class ([A-Za-z0-9._-]) so dynamic/templated paths that build
|
||||
# the user at runtime — shell `/home/$USER/`, doc `/home/<rip>/`, Rust
|
||||
# `/home/{user}/` — do NOT false-positive; only a baked-in literal home leaks.
|
||||
HOMEPATH_RE='/Users/[A-Za-z0-9._-]+/|/home/[A-Za-z0-9._-]+/'
|
||||
# AI-attribution net (case-insensitive). "claude" matches only as a standalone
|
||||
# word — NOT preceded by a dot/slash/alnum and NOT followed by .md — so legit
|
||||
# mentions of CLAUDE.md / .claude/ in a commit message don't false-positive.
|
||||
ATTR_RE='co-authored-by|generated with|🤖|(?<![.\/A-Za-z0-9])claude(?!\.md)'
|
||||
|
||||
echo "── leak-guard: tracked agent-context paths ──"
|
||||
while IFS= read -r f; do
|
||||
case "$f" in
|
||||
CLAUDE.md|*/CLAUDE.md|.claude|.claude/*|*/.claude|*/.claude/*)
|
||||
note "tracked agent-context file: $f (CLAUDE.md/.claude must never be tracked in a public repo)" ;;
|
||||
esac
|
||||
done < <(git ls-files)
|
||||
|
||||
# Match a PCRE against a file, emitting "LINE: MATCH". The pattern is passed as
|
||||
# an argument (not interpolated into a //) so metacharacters like the "/" in a
|
||||
# path-style token can't break the regex. Reads raw bytes so non-UTF-8 blobs
|
||||
# don't abort the scan.
|
||||
pcre_matches() {
|
||||
perl -e '
|
||||
my ($file, $re) = @ARGV;
|
||||
open(my $fh, "<:raw", $file) or exit 0;
|
||||
my $rx; eval { $rx = qr/$re/i }; exit 0 if $@;
|
||||
while (my $l = <$fh>) { if ($l =~ /$rx/) { print "$.: $&\n"; } }
|
||||
' "$1" "$2" 2>/dev/null
|
||||
}
|
||||
|
||||
# This script's own source necessarily contains the detection patterns (e.g.
|
||||
# the regex tokens in INFRA_RE), so scanning it would always self-flag. Skip it.
|
||||
SELF="$(git ls-files --full-name -- "$SELF_ABS" 2>/dev/null | head -1)"
|
||||
|
||||
echo "── leak-guard: internal-infra references in tracked files ──"
|
||||
while IFS= read -r f; do
|
||||
case "$f" in *.png|*.jpg|*.jpeg|*.ico|*.gif|*.bin|*.crate|*.gz|*.zip|*.pdf) continue ;; esac
|
||||
[ -n "$SELF" ] && [ "$f" = "$SELF" ] && continue
|
||||
[ -f "$f" ] || continue
|
||||
while IFS= read -r hit; do
|
||||
[ -z "$hit" ] && continue
|
||||
note "internal-infra reference: $f:$hit"
|
||||
done < <(pcre_matches "$f" "$INFRA_RE")
|
||||
while IFS= read -r hit; do
|
||||
[ -z "$hit" ] && continue
|
||||
note "[HOME-PATH] absolute home path: $f:$hit (no local home path may be committed to a public repo)"
|
||||
done < <(pcre_matches "$f" "$HOMEPATH_RE")
|
||||
done < <(git ls-files)
|
||||
|
||||
RANGE="${1:-}"
|
||||
if [ -n "$RANGE" ]; then
|
||||
echo "── leak-guard: AI-attribution in commit messages ($RANGE) ──"
|
||||
while IFS= read -r sha; do
|
||||
[ -z "$sha" ] && continue
|
||||
msg="$(git log -1 --format='%B' "$sha" 2>/dev/null || true)"
|
||||
# Pass the pattern as an argument (not interpolated into a //) so the
|
||||
# lookbehind char class and "/" don't break the regex.
|
||||
hit="$(printf '%s' "$msg" | perl -e '
|
||||
my $re = $ARGV[0]; my $rx = qr/$re/i;
|
||||
while (my $l = <STDIN>) { if ($l =~ /($rx)/) { print "$1\n"; last; } }
|
||||
' "$ATTR_RE" | head -1 || true)"
|
||||
[ -n "$hit" ] && note "commit ${sha:0:12}: message contains \"$hit\" (owner rule: zero AI attribution, ever)"
|
||||
done < <(git rev-list "$RANGE" 2>/dev/null || true)
|
||||
fi
|
||||
|
||||
echo
|
||||
if [ "$fail" -ne 0 ]; then
|
||||
echo "✗ leak-guard: blocking finding(s) above — DO NOT MERGE/PUBLISH"
|
||||
exit 1
|
||||
fi
|
||||
echo "✓ leak-guard: clean"
|
||||
@@ -1,159 +0,0 @@
|
||||
# keydb_format.rs — design notes
|
||||
|
||||
## Full parser API retained on purpose
|
||||
|
||||
The parser is copied verbatim, so it carries the full KeyDb/DiscEntry API
|
||||
even though this crate's consumer (`keydb.rs`) only exercises a subset
|
||||
(`load`, `find_disc`, `iter_disc_entries`, and the public fields read by
|
||||
`KeydbSource::unit_keys_from` / `KeydbSource::host_certs`). NOTE: an earlier
|
||||
revision of this comment cited a `candidates_from` function — no such
|
||||
function has ever existed in this crate; the real consumer is
|
||||
`KeydbSource::unit_keys_from` (keydb.rs), which reads `unit_keys`, `vuk`,
|
||||
`media_key` AND `vid` (`vid` is load-bearing for the MK+VID derivation the
|
||||
kat_c / kat_d KATs pin — it is NOT unused). `DiscEntry::title` is likewise
|
||||
read — by `to_keydb_cfg` and the redacting `Debug` impl — so it is not
|
||||
unused either. The genuinely unused items — `empty` and `find_vuk` — are
|
||||
part of the faithful copy and are retained rather than pruned; allow
|
||||
dead_code so the byte-for-byte copy compiles clean without diverging from
|
||||
the libfreemkv original.
|
||||
|
||||
## ParseStats — what `KeyDb::parse` threw away
|
||||
|
||||
The parser is fed a THIRD-PARTY file: a mirror can serve a truncated or
|
||||
byte-shifted download that is still valid UTF-8, still contains enough
|
||||
recognisable rows to pass `KeydbSource::save`'s "at least one entry" check,
|
||||
and is then atomically committed as the new keydb — after which every disc
|
||||
past the corruption point silently resolves nothing. Before this counter,
|
||||
each malformed `| DK` / `| PK` / `| HC` / `| HC2` / `0x…` row was dropped by
|
||||
an `if let Some(..) = .. { }` with no `else`, no counter and no log, so that
|
||||
file was indistinguishable from a healthy one at every layer above.
|
||||
|
||||
The counts are logged ONCE per parse (a per-line log would be 181k lines on
|
||||
a real keydb, which is why the rate limit is "one summary", never "hide the
|
||||
count").
|
||||
|
||||
## `KeyDb::load_counted` — same-descriptor stamp + parse
|
||||
|
||||
Two callers need this seam, both in `crate::KeydbSource`:
|
||||
|
||||
* The identity stamp and the bytes must come from the SAME descriptor.
|
||||
Stat-the-path-then-load-the-path is two independent resolutions of one
|
||||
name, so an atomic rename landing between them stored a stamp
|
||||
describing one file next to the parsed contents of another — and the
|
||||
cache then served that pairing until the stamp changed again. `fstat`
|
||||
on the open handle cannot be pointed at a different inode.
|
||||
* The rejection counts have to be RETAINED, not just logged, so a cache
|
||||
hit can re-emit them.
|
||||
|
||||
## `to_keydb_cfg` — trailing-comment placement
|
||||
|
||||
The trailing `; <comment>` (MKB version / volume size / UHD) is emitted
|
||||
ONLY after a `U` (unit-keys) field — that is the one place the parser
|
||||
splits the value on `;`. Gluing a comment onto an `M`/`I`/`V` value would
|
||||
make `parse_hex16` reject the whole field, so a comment-bearing entry that
|
||||
has no unit keys drops its comment (keys always survive; the metadata is a
|
||||
derivable hint). Real per-disc rows that carry metadata also carry keys.
|
||||
|
||||
## `parse_disc_entry` title handling
|
||||
|
||||
Title = everything between `= ` and the first ` | ` field (or the trailing
|
||||
`;` comment), kept VERBATIM (trimmed). This is a FAITHFUL copy of the keydb
|
||||
title, so it must round-trip exactly: a previous version extracted a `(...)`
|
||||
substring as a "display title", but that TRUNCATED real titles that
|
||||
legitimately contain parentheses ("Lawrence of Arabia (Restored Version) –
|
||||
Disc 2 …" → "Restored Version") and broke serialize→parse idempotence.
|
||||
Display prettification, if wanted, belongs in the title-display layer, NOT
|
||||
this codec.
|
||||
|
||||
## Real-data test notes
|
||||
|
||||
`to_keydb_cfg_is_idempotent_on_real_keydb`: parse the full keydb -> serialize
|
||||
(S1) -> parse S1 -> serialize again (S2). S1 MUST equal S2 byte-for-byte.
|
||||
This is the right invariant: a raw keydb.cfg has formatting variance
|
||||
(whitespace, optional fields, comment style) that our CANONICAL serializer
|
||||
normalizes, so `text == to_keydb_cfg` is NOT expected — but once normalized,
|
||||
a re-load+re-serialize must be stable. Idempotence here proves `parse` is
|
||||
lossless on its own output and `to_keydb_cfg` is deterministic. Also asserts
|
||||
no rows are dropped. It used to carry no `#[ignore]` and `return` early when
|
||||
`KEYDB_PATH` was unset — so CI ran it, asserted NOTHING about 181k-entry
|
||||
behaviour, and reported green. A skip has to be visible in the test output
|
||||
to mean anything, and an ignored test that is RUN without its fixture must
|
||||
fail loudly rather than silently pass.
|
||||
|
||||
`real_keydb_path`: the old pattern (`match keydb_path() { Some(p) => p, None
|
||||
=> return }`) on a non-ignored test is the worst of both worlds: CI ran the
|
||||
test, asserted nothing, and reported success. These tests are `#[ignore]`d,
|
||||
so running one at all is an explicit request — and an explicit request with
|
||||
no fixture must fail, not quietly pass.
|
||||
|
||||
## `load_counted_reads_the_handle_not_the_path` test
|
||||
|
||||
`load_counted` must read the HANDLE it was given, never re-resolve the
|
||||
path. `KeydbSource::cached_db` stamps the open file with `fstat` and then
|
||||
parses from that same descriptor precisely so the recorded identity and
|
||||
the parsed bytes cannot describe two different files; the moment this
|
||||
function re-opens the path, that guarantee is gone and an atomic rename
|
||||
landing in between stores one file's stamp beside another file's keys —
|
||||
a mismatch the cache then serves as if it were valid.
|
||||
|
||||
The race itself cannot be scheduled deterministically in-process, so the
|
||||
SEAM is what is pinned: with the path already replaced, the handle's
|
||||
contents must still win. Catches the mutation that restores an internal
|
||||
`File::open(path)`.
|
||||
|
||||
## `host_cert_debug_is_redacted_including_the_sibling_wrapper` test
|
||||
|
||||
The SIBLING type. `KeyDb`'s hand-written `Debug` prints `host_certs_len`, so
|
||||
it protects the whole-db rendering and nothing else — `KeyDb::host_certs` is
|
||||
a public field, and `{:?}` on ONE element of it walks a completely different
|
||||
code path: `KeydbHostCert`'s derive, then `HostCert`'s impl. That path
|
||||
carries the AACS host PRIVATE key, the only key material in the crate that
|
||||
authenticates US rather than opening a disc.
|
||||
|
||||
It is safe today only because `libfreemkv::HostCert` hand-writes a redacting
|
||||
`Debug` (`aacs::types`, `private_key: "<redacted>"` + `certificate_len`) —
|
||||
an EXTERNAL guarantee this crate silently inherits through the derive, with
|
||||
nothing on this side pinning it. This test pins it: it catches a libfreemkv
|
||||
upgrade that swaps that impl for `#[derive(Debug)]`, which would leak the
|
||||
host private key out of this crate's public API with no diff in this
|
||||
repository at all.
|
||||
|
||||
Rendered three ways because callers reach the cert three ways: the whole
|
||||
`Vec` (`db.host_certs`), one element, and the inner `HostCert` a caller
|
||||
gets back from `KeyDb::host_certs(mkb)`.
|
||||
|
||||
## KEYDB-parser integration tests relocated from libfreemkv
|
||||
|
||||
These exercise the parser (`KeyDb::load`) end-to-end against a real
|
||||
keydb.cfg and feed its material into libfreemkv's AACS crypto
|
||||
(`derive_vuk`, then `decrypt_unit` + `is_clean_ts`). They live here now
|
||||
that the parser lives here. All are `KEYDB_PATH`-env-gated and no-op in CI
|
||||
when the env is unset; they must still COMPILE.
|
||||
|
||||
## `test_decrypt_real_unit` — no-decrypt outcome
|
||||
|
||||
Reaching the fallback path is the EXPECTED outcome for the AACS 2.0 (BEE)
|
||||
sample this test was written against: the unit is still bus-encrypted, so
|
||||
no unit key alone can open it. That makes "no key worked" an unusable
|
||||
assertion on its own — which is exactly why this test used to end in an
|
||||
`eprintln!` and fall off the end, i.e. pass unconditionally. A no-op
|
||||
`decrypt_unit`, an `is_clean` stuck at `false`, or a parser that yielded
|
||||
zero keys would all have produced this same clean exit.
|
||||
|
||||
What CAN be asserted regardless of the sample: the pipeline actually ran,
|
||||
and the decrypt primitive actually transformed the bytes.
|
||||
|
||||
## Hand-written redacting `Debug`
|
||||
|
||||
Key material must never reach a log, a panic message, or a bug report. Both
|
||||
`KeyDb` and `DiscEntry` carry raw AACS key bytes, and both are public API, so
|
||||
a `#[derive(Debug)]` on either is a leak of the crown jewels: `{:?}` on a
|
||||
loaded `KeyDb` printed every processing key plus every disc's Media Key,
|
||||
VID, VUK and Unit Keys. libfreemkv's equivalent types (`aacs::types`:
|
||||
`DeviceKey`, `HostCert`, `Vid`, `MediaKey`, `Vuk`, `ProcessingKey`,
|
||||
`UnitKey`, its own `DiscEntry`) all hand-write a redacting `Debug` for
|
||||
exactly this reason; this crate's copy of the parser dropped that
|
||||
convention when it was relocated. These restore it, field-for-field in the
|
||||
same style (`<redacted>` for key bytes, a `_len` for key-bearing
|
||||
collections). Pinned by `keydb_debug_is_redacted` /
|
||||
`disc_entry_debug_is_redacted`.
|
||||
-432
@@ -1,432 +0,0 @@
|
||||
# `keydb.rs` design notes
|
||||
|
||||
Long-form rationale moved out of `src/keydb.rs` doc comments to satisfy the
|
||||
repo's comment-guard line caps. Each section is pointed to from the file by a
|
||||
one-line `// See docs/keydb.md#<anchor>` comment.
|
||||
|
||||
## candidate-order
|
||||
|
||||
Full derivation path this source walks, cheapest-first:
|
||||
|
||||
1. per-disc **Unit Keys** (hash hit) → returned terminal, no derivation.
|
||||
2. per-disc **VUK** (hash hit) → `uks_from_vuk` over the disc's encrypted
|
||||
title keys.
|
||||
3. a **Media Key**, then `derive_vuk` → `uks_from_vuk`. The MK comes from, in
|
||||
order: the disc's stored MK (hash hit); the keydb's **Processing Key**
|
||||
pool walked against THIS disc's MKB via `derive_media_key_from_pk`; or the
|
||||
device-key pool via `derive_media_key_from_dk`. The PK and DK pools
|
||||
resolve the Media Key WITHOUT a VID; the final `derive_vuk` still needs
|
||||
one. The VID is the unlocker's physical VID (`ResolveCtx::vid`) when
|
||||
present, else the keydb entry's OWN stored VID (the `I` field, `vid`) for
|
||||
the non-physical / ISO path. With no VID from either source the MK path
|
||||
cannot complete — return nothing.
|
||||
|
||||
The cross-disc MK-pool brute (trying OTHER discs' stored media keys against
|
||||
this disc) stays RETIRED: every MK path here is anchored to the matched
|
||||
disc's own MKB or stored material.
|
||||
|
||||
The library still OWNS the crypto; this source owns only which primitive to
|
||||
call with which material. Returning an empty `Vec` is a genuine "no key for
|
||||
this disc here".
|
||||
|
||||
## file-identity
|
||||
|
||||
`(len, modified)` ALONE IS NOT AN IDENTITY. mtime is stored at whole-second
|
||||
resolution on HFS+, on many container overlays and on most network
|
||||
filesystems, so a writer that replaces `keydb.cfg` within the same second
|
||||
with a file of the same byte length leaves `(len, modified)` bit-identical —
|
||||
and the cache then serves the superseded parse for the rest of the process's
|
||||
life. For a key database that is not a stale page: it is serving retired or
|
||||
since-corrected keys while reporting success. The writers that hit this are
|
||||
real and named in this crate's own docs: the daily-refresh job, a second
|
||||
freemkv process, an operator's editor, a sync tool.
|
||||
|
||||
Two independent discriminators close it:
|
||||
|
||||
1. `dev` + `ino`. Every writer that publishes ATOMICALLY (temp file, fsync,
|
||||
rename — what `KeydbSource::save` does, and what any correct publisher
|
||||
does) creates a NEW inode, so the stamp differs immediately and
|
||||
unconditionally, whatever the clock or the mtime resolution did. Zero on
|
||||
platforms without them (see `FileStamp::of`), which costs nothing: rule 2
|
||||
stands alone.
|
||||
2. A freshness rule on the cache entry — `CacheEntry::is_settled` — which
|
||||
covers the residual in-place rewrite that reuses the inode.
|
||||
|
||||
What this still does NOT catch: a writer that FORGES the timestamp, i.e.
|
||||
restores an mtime equal to the cached one (`touch -t`, `rsync --times`, a
|
||||
tar/backup restore) into the SAME inode with the SAME length. Nothing short
|
||||
of hashing the content can see that, and hashing 62 MiB per lookup is
|
||||
precisely the cost the cache exists to remove (~141 ms × ≥3 loads per rip).
|
||||
`KeydbSource::save` therefore keeps invalidating the cache directly, so the
|
||||
one write path this crate owns never depends on any of the above.
|
||||
|
||||
## settle-proof
|
||||
|
||||
Whether a cache entry's stamp can be TRUSTED to change if the file changes.
|
||||
|
||||
The proof, for a filesystem storing mtime at granularity `G`: suppose this
|
||||
entry was stamped at `stamped_at` with `stamped_at - modified >= G`, and some
|
||||
writer later rewrites the file in place at wall time `T > stamped_at`. The
|
||||
recorded mtime `m'` of that write is within one granule of `T`, so
|
||||
`m' >= T - G > stamped_at - G >= modified`. Hence `m' != modified` and the
|
||||
stamp DOES change. The ambiguous window is therefore exactly the one where
|
||||
the cached entry was stamped less than `G` after the file's own mtime — i.e.
|
||||
we looked at the file while it was still "hot" — and in that window the
|
||||
entry is refused and the file is re-read. Once the file has been quiet for
|
||||
`G`, its entry settles and the cache is fully effective again.
|
||||
|
||||
Cost: after every keydb write, lookups re-parse for up to `G` (2 s). The
|
||||
published keydb is rewritten daily, so that is ~2 s of re-parsing per day
|
||||
against a cache that saves ~420 ms per rip.
|
||||
|
||||
`modified: None` (a filesystem that reports no mtime) never settles: the only
|
||||
two discriminators left would be size and inode, so the entry is re-read
|
||||
every time rather than being trusted on a weaker basis.
|
||||
|
||||
CLOCK CAVEAT: `stamped_at` is the local clock and `modified` is the
|
||||
filesystem's. On a network share whose server clock runs AHEAD of the
|
||||
client's by more than `G`, entries never settle (safe: more re-parsing). A
|
||||
server clock BEHIND the client's makes an entry settle early, which re-opens
|
||||
the same-second window it closes — the inode rule (1) is what covers the
|
||||
realistic writers there.
|
||||
|
||||
## keydbsource-cache
|
||||
|
||||
`KeydbSource` caches the parsed database behind the file's identity stamp.
|
||||
The published keydb is ~62 MiB / ~181k entries and a single AACS-cert rip
|
||||
parses it repeatedly — `host_certs()` for the drive handshake (freemkv's
|
||||
`pipe.rs`/`engine.rs`, autorip's `keysource.rs` each build their own source),
|
||||
then the trait `host_certs(mkb)` during resolution, then `get_unit_keys` —
|
||||
and every one of those calls used to re-read all 62 MiB from disk and
|
||||
re-parse it from scratch, because the struct held nothing but a `PathBuf`.
|
||||
|
||||
A keydb replaced underneath this source is picked up on the next call, with
|
||||
ONE stated exception: a writer that rewrites the file in place, into the
|
||||
same inode, at the same byte length, having restored the previous mtime
|
||||
exactly (`touch -t` / `rsync --times` / a backup restore). Everything else —
|
||||
any atomic rename, any length change, any real clock advance — changes the
|
||||
stamp. `FileStamp` and `CacheEntry::is_settled` carry the full argument and
|
||||
the clock caveats; do not weaken either without re-reading them. (The
|
||||
earlier wording here — "an externally replaced keydb is still picked up" —
|
||||
was simply false for a same-second, same-length replacement, which is the
|
||||
common shape of a daily-refresh job on a whole-second-mtime filesystem.)
|
||||
|
||||
MEMORY RESIDENCY (accepted, and deliberately recorded rather than fixed
|
||||
here): a hit keeps the entire parsed keydb — every disc's Media Key / VID /
|
||||
VUK / Unit Keys, the processing- and device-key pools, and the host-cert
|
||||
PRIVATE keys — resident for the process's life, where the pre-cache code
|
||||
held one parse transiently. Nothing in this crate zeroizes on drop, so that
|
||||
material was always exposed to a core dump or a swapped page; the cache
|
||||
widens the WINDOW, it does not create the class. Closing it properly means
|
||||
zeroize-on-drop across `KeyDb`, `DiscEntry` and libfreemkv's `aacs::types`
|
||||
(which owns most of the buffers) — a cross-crate change, tracked separately,
|
||||
NOT smuggled in behind a cache fix.
|
||||
|
||||
## cached-db-one-open
|
||||
|
||||
Errors are the same ones `KeyDb::load` produces, unchanged: a missing file
|
||||
is `NotFound` (the documented benign case), an over-cap or non-UTF-8 file is
|
||||
`InvalidData`. The stamp costs an `fstat`, not a 62 MiB read.
|
||||
|
||||
ONE OPEN, ONE IDENTITY. The file is opened once and both the stamp (`fstat`
|
||||
on that handle) and, on a miss, the bytes come from it. The previous shape —
|
||||
`std::fs::metadata(path)` and then a separate `KeyDb::load(path)` — resolved
|
||||
the path TWICE with no atomicity between them, so a rename landing in the
|
||||
gap cached the new file's stamp beside the old file's contents (or the
|
||||
reverse); the pairing was then served, looking perfectly valid, until the
|
||||
stamp changed again. The stamp is read BEFORE the bytes on purpose: a write
|
||||
racing the read then leaves the OLD stamp cached, which the next call
|
||||
detects, whereas stamping afterwards would file torn content under a
|
||||
fresh-looking identity and pin it.
|
||||
|
||||
## cached-db-reemit
|
||||
|
||||
Re-emit the parser's rejection summary on EVERY hit, not just on the parse
|
||||
that produced it. `KeyDb::parse` is what logs it, and a hit skips `parse`
|
||||
entirely — so a daemon that cached a corrupt keydb logged its rejected-row
|
||||
counts exactly once, at whatever moment it first read the file, and then
|
||||
served that same damaged database to every later rip in silence. Repetition
|
||||
is the correct failure mode here: the line is emitted only when the file
|
||||
really does have rejected or duplicate rows, and a warning an operator can
|
||||
still see on the tenth rip is worth more than one they had to catch on the
|
||||
first.
|
||||
|
||||
## load-failure
|
||||
|
||||
A MISSING keydb is the documented benign case: the app may simply not have
|
||||
one, another source may hold the key, and "no keydb" is genuinely "no key
|
||||
here". Everything else is NOT that: `InvalidData` is a keydb over the
|
||||
128 MiB cap or one that is not valid UTF-8 — i.e. corrupt, truncated, or a
|
||||
half-finished download — and a permission/IO failure means the file could
|
||||
not be read at all. Reporting either as an empty result made a broken keydb
|
||||
indistinguishable from "this disc has no key" (the same conflation as the
|
||||
seven-hour 502), with no log to notice it by. Both are now logged AND
|
||||
surfaced as errors so the resolver reports a source failure instead of
|
||||
`E7022`.
|
||||
|
||||
## save-mirror-parse
|
||||
|
||||
Mirror `KeyDb::parse`'s disc-entry rule EXACTLY by CALLING it
|
||||
(`is_disc_entry_line`), so `save()` never validates + persists content that
|
||||
parses to zero usable entries (e.g. a stray "0xDEADBEEF" comment line) and
|
||||
the two can no longer drift — they did drift once already, on the `0X` case
|
||||
rule.
|
||||
|
||||
## unit-keys-from
|
||||
|
||||
CPS-unit numbering: a returned `UnitKey::idx` is the POSITIONAL index
|
||||
libfreemkv's `resolve_and_apply` turns into the canonical CPS-unit number
|
||||
`idx + 1`. For the terminal per-disc unit-key path we therefore map the
|
||||
keydb's stored CPS number `num` to `idx = num - 1`, so the committed number
|
||||
is byte-identical to the keydb's `num` (and to what the OLD
|
||||
`Key::Unit(entry.unit_keys)` path committed). For the VUK / MK paths the
|
||||
boil primitive already yields 0-based positional indices, matching
|
||||
`parse_unit_key_ro`'s `(i + 1)` after the resolver's `+ 1`.
|
||||
|
||||
## unit-keys-per-disc-hit
|
||||
|
||||
Per-disc hit (most specific). `find_disc` normalizes the hash form. Without
|
||||
a matched entry this keydb has no per-disc material (Unit Keys / VUK / Media
|
||||
Key / stored VID) to anchor a derivation for the disc, so it resolves
|
||||
nothing. (The PK and DK pools are global, but the cross-disc MK-pool brute —
|
||||
trying OTHER discs' media keys against this disc — stays retired; a PK/DK
|
||||
pool only ever resolves a disc reached through its own matched entry below.)
|
||||
|
||||
## unit-keys-union
|
||||
|
||||
UNION every source of terminal keys, then dedup — never first-hit. A stored
|
||||
`unit_keys` list can be PARTIAL (the key-import tool only ever sampled the
|
||||
CPS units reachable from a playlist, so an orphan unit's key may be
|
||||
missing), while the per-disc VUK boils EVERY declared CPS unit. Taking the
|
||||
stored list alone (the old return-at-first-path) would shadow the VUK and
|
||||
silently drop the orphan unit's key. So gather both and keep a unique-by-key
|
||||
list: the read path tries every key per unit, so an extra or stale key is
|
||||
harmless — only a MISSING key hurts.
|
||||
|
||||
## unit-keys-vuk-or-mk
|
||||
|
||||
2. Per-disc VUK — one step, no VID needed; boils ALL declared units.
|
||||
3. Else a Media Key path (stored MK / PK pool / DK pool) → VUK → all
|
||||
declared units. The MK itself carries no VID, but the final `vuk_from_mk`
|
||||
needs one: physical (unlocker) VID first, else the entry's stored VID
|
||||
(`I` field), else cannot derive. Either branch yields the COMPLETE
|
||||
declared set, so we take the first that resolves (VUK preferred —
|
||||
cheapest).
|
||||
|
||||
## write-atomic
|
||||
|
||||
keydb.cfg is the single source of AACS truth, and save/update run
|
||||
unattended (first-boot download + daily-refresh thread, with a container
|
||||
restart on every release). A bare in-place `fs::write` truncates the file
|
||||
before writing, so a SIGKILL (docker stop's grace window), OOM-kill, power
|
||||
loss, or ENOSPC mid-write would leave the keydb half-written — the prior
|
||||
good copy already gone. A truncated keydb doesn't error at write time; it
|
||||
silently breaks key resolution on every later AACS rip. Writing to a temp
|
||||
file then renaming (POSIX rename is atomic within a filesystem) means an
|
||||
interrupted update leaves the previous keydb fully intact.
|
||||
|
||||
The fsync MUST succeed before the rename: a `sync_all` failure (ENOSPC,
|
||||
ESTALE on the bind-mounted volume) means the kernel never guaranteed the
|
||||
bytes reached stable storage, so publishing them via rename would defeat
|
||||
crash-safety. The temp name is unique per call (pid + monotonic counter) so
|
||||
a concurrent update can't share a fixed temp path and rename a mangled file
|
||||
over the keydb.
|
||||
|
||||
## get-unit-keys-trait
|
||||
|
||||
A MISSING keydb is not an error — it simply yields no keys (another source
|
||||
may have them), the same as the library's own loader. A keydb that exists
|
||||
but cannot be USED (over the size cap, not UTF-8, unreadable) is a source
|
||||
failure and returns `Err`: it says nothing about whether this disc has a
|
||||
key, and reporting it as an empty result is the same looks-like-success
|
||||
failure as a 502 reported as `E7022`.
|
||||
|
||||
The keydb carries no AACS 2.1 forensic index keys today, so it does not
|
||||
override `get_fmts_indexes` — the default (empty) opts it out, and an FMTS
|
||||
disc's forensic set comes from the online source.
|
||||
|
||||
## host-certs-trait
|
||||
|
||||
Expose the keydb's host certs through the trait — the OEM/AACS cert-auth
|
||||
route collects them across every source via this method. Wires the disc's
|
||||
MKB generation through for revocation filtering (the keydb parser's
|
||||
`; Revoked in MKBv<N>` annotation): a cert revoked at generation `R` is
|
||||
withheld once the disc's generation reaches `R`.
|
||||
|
||||
## test-pinned-mtime
|
||||
|
||||
Force a file's mtime to `PINNED_MTIME`, so two different files can be made
|
||||
bit-identical to a `(len, mtime)` stamp on purpose. The cache tests that
|
||||
matter all depend on FORCING the indistinguishable case rather than hoping
|
||||
the filesystem produces it: on APFS (nanosecond mtimes) a same-second
|
||||
replacement is otherwise detected by mtime alone, and a test that relies on
|
||||
that passes with the fix reverted — which is worth nothing.
|
||||
|
||||
## test-committed
|
||||
|
||||
The committed `(cps, key)` pairs libfreemkv's `resolve_and_apply` derives
|
||||
from a source's Unit Keys: positional `idx` → canonical CPS number
|
||||
`idx + 1`. The KATs compare against THIS to prove byte-identical parity with
|
||||
the OLD `Key::Unit` / resolver-derived commit.
|
||||
|
||||
## test-mock-ctx-stub
|
||||
|
||||
`MockCtx` implements the full `ResolveCtx` trait so it can stand in for a
|
||||
real disc, but `KeydbSource` itself never calls `title()`/`samples()` (those
|
||||
matter to the online source, not the local keydb). Exercise them directly
|
||||
so the mock's trait surface is proven correct too.
|
||||
|
||||
## test-kat-a
|
||||
|
||||
Here `enc_title_keys` is empty, so the VUK can't derive anything — only the
|
||||
stored list contributes, and it commits byte-identically to the stored
|
||||
`(cps, key)` pairs.
|
||||
|
||||
## test-orphan-union
|
||||
|
||||
Orphan-unit completeness (the real keydb bug): an entry stores only `uk1`
|
||||
(the key-import tool sampled one reachable CPS unit) but ALSO carries the
|
||||
VUK, which boils BOTH declared units. The old return-at-first-path handed
|
||||
back just `[uk1]`, shadowing the VUK and silently dropping the orphan unit.
|
||||
The union must return BOTH — the stored uk1 AND the VUK-derived second unit.
|
||||
|
||||
## test-kat-c
|
||||
|
||||
A hash hit with a Media Key and a physical VID (from the unlocker) derives
|
||||
`MK → VUK → UK`. The PHYSICAL VID must be used in preference to the keydb's
|
||||
stored VID — proven by giving the entry a DIFFERENT stored VID and showing
|
||||
the result tracks the physical one.
|
||||
|
||||
## test-kat-f
|
||||
|
||||
Owner decision #1 (AACS): a keydb Processing Key must be walked against the
|
||||
matched disc's own MKB to recover the Media Key, then driven down the full
|
||||
chain `PK → MK → VUK → UK`. The disc entry carries NO stored MK/VUK/UK — the
|
||||
only key material is a global `PK` row — and the result must be the real
|
||||
Unit Keys, byte-identical to deriving from the recovered MK.
|
||||
|
||||
The MKB + PK use a known-answer construction (a planted PK whose derived MK
|
||||
satisfies the synthetic verify record); the constants are precomputed AES
|
||||
vectors so this crate needs no AES primitive of its own. They mirror
|
||||
libfreemkv's `boil::mk_from_pk_drives_full_chain_to_uks` KAT.
|
||||
|
||||
## test-repeated-lookups
|
||||
|
||||
A single AACS-cert rip drives this source at least three times — the
|
||||
scan-options builder's inherent `host_certs()`, the trait `host_certs(mkb)`
|
||||
during the handshake, then `get_unit_keys` — and each call used to re-read
|
||||
and re-parse the WHOLE file, because `KeydbSource` held nothing but a
|
||||
`PathBuf`. Measured on the real 62 MiB / 184,860-entry keydb: ~140 ms per
|
||||
parse in `--release`, i.e. ~420 ms and ~186 MiB of file reads per rip,
|
||||
against ~1 µs for a cache hit.
|
||||
|
||||
Catches the mutation that drops the cache (every call re-parses: count 3)
|
||||
and the mutation that makes the cache unconditional (see the invalidation
|
||||
tests below).
|
||||
|
||||
The mtime is pinned into the PAST first, because a cache entry is only
|
||||
trusted once the file has been quiet for the mtime granularity
|
||||
(`CacheEntry::is_settled`) — a keydb written microseconds ago is
|
||||
deliberately re-read. Unix-only: pinning an mtime needs `touch -t` (no
|
||||
`filetime` dependency for a test).
|
||||
|
||||
## test-changed-keydb
|
||||
|
||||
The cache must not go stale: a keydb replaced UNDERNEATH the source (the
|
||||
daily-refresh thread writing through a different `KeydbSource`, or an
|
||||
operator dropping in a new file) has a different size/mtime stamp and must
|
||||
be re-read. Catches the mutation that caches on first load and never
|
||||
re-stats — which would pin a rip to a keydb deleted hours earlier.
|
||||
|
||||
## test-two-discriminators
|
||||
|
||||
The defect both of the inode/settle tests below pin: `(len, mtime)` is not a
|
||||
file identity. An external writer — the daily-refresh job, a second freemkv
|
||||
process, an editor, a sync tool — that replaces `keydb.cfg` inside one mtime
|
||||
granule with a file of the SAME length leaves that pair bit-identical, and
|
||||
the source then serves the superseded parse for the rest of the process's
|
||||
life: retired or since-corrected keys, reported as success.
|
||||
|
||||
Each test disables the OTHER discriminator through `mtime_granularity`, so
|
||||
neither can pass on the strength of the one it is not testing, and neither
|
||||
depends on the host filesystem's real mtime resolution (on APFS the naive
|
||||
scenario is not reproducible at all).
|
||||
|
||||
## test-inode-rename
|
||||
|
||||
A keydb replaced by ATOMIC RENAME — how every correct publisher, including
|
||||
this crate's own `save()`, installs a new file — must be re-read even when
|
||||
length and mtime are identical. `mtime_granularity: 0` makes every entry
|
||||
settle, so ONLY dev+ino can distinguish the two files here.
|
||||
|
||||
Catches the mutation that drops `dev`/`ino` from `FileStamp` (the original
|
||||
`(len, modified)` stamp): the source then keeps answering with the previous
|
||||
keydb's keys.
|
||||
|
||||
## test-inplace-rewrite
|
||||
|
||||
A keydb rewritten IN PLACE — same inode, same length, mtime forced back to
|
||||
the same value — must still be re-read while the cached entry is too young
|
||||
to trust. `mtime_granularity` is set to a decade so nothing ever settles,
|
||||
which is the same condition a real same-second, whole-second-mtime
|
||||
replacement creates and the only way to reproduce it deterministically on a
|
||||
nanosecond-mtime filesystem.
|
||||
|
||||
Catches the mutation that deletes the `is_settled` check from `cached_db`
|
||||
(every stamp match trusted unconditionally, which is what the original code
|
||||
did): dev, ino, len and mtime are ALL identical here, so without the
|
||||
freshness rule the source serves the old keys forever.
|
||||
|
||||
## test-corrupt-warns
|
||||
|
||||
`ParseStats::log` runs inside `KeyDb::parse`, and a cache hit skips `parse`
|
||||
— so once the cache landed, the rejected-row summary for a given file was
|
||||
emitted exactly ONCE for the entire life of the process, while that same
|
||||
damaged file went on being served to every subsequent rip. A long-running
|
||||
daemon (autorip) logs it at startup, the operator misses it in the startup
|
||||
noise or loses it to log rotation, and there is no second chance for as long
|
||||
as the process runs.
|
||||
|
||||
Catches the mutation that deletes the `emit_parse_stats` call from the
|
||||
cache-HIT arm of `cached_db`: warnings would drop to 1 while the file is
|
||||
still served three times.
|
||||
|
||||
## test-healthy-silent
|
||||
|
||||
Catches the mutation that makes `emit_parse_stats` unconditional (drops
|
||||
`ParseStats::log`'s empty-counts early return).
|
||||
|
||||
## test-fresh-not-trusted
|
||||
|
||||
Catches the mutation that widens the window to something unbounded (a
|
||||
granularity of hours would re-parse 62 MiB on every lookup all day) by
|
||||
pairing with `repeated_lookups_parse_the_keydb_once`, which proves the entry
|
||||
DOES settle once the mtime is in the past.
|
||||
|
||||
## test-save-invalidates
|
||||
|
||||
`save()` replaces the very file this source reads, so it drops the cached
|
||||
parse ITSELF rather than trusting the (size, mtime) stamp: a same-size
|
||||
rewrite that lands inside the filesystem's timestamp granularity is the one
|
||||
change the stamp cannot see — and it is exactly the change this crate
|
||||
performs (the daily-refresh thread re-saving a keydb through the source it
|
||||
then reads from).
|
||||
|
||||
The test forces that indistinguishable case rather than hoping for it: the
|
||||
file is written, stamped to a FIXED mtime, cached, re-saved with different
|
||||
keys of the SAME length, and stamped back to the same mtime. To the stamp
|
||||
the two files are identical, so only the explicit invalidation can produce
|
||||
the new key. Unix-only because pinning an mtime needs `touch -t` (no
|
||||
`filetime` dependency for one test).
|
||||
|
||||
## test-corrupt-is-error
|
||||
|
||||
`KeyDb::load` fails distinguishably for a keydb that is over the 128 MiB cap
|
||||
or not valid UTF-8 — a truncated download, a half-written file, a binary
|
||||
blob dropped in by mistake. Both used to collapse into `Ok(Vec::new())` with
|
||||
ZERO tracing, i.e. into the benign "no key for this disc" the resolver
|
||||
reports as `E7022` — the same looks-like-success failure as the seven-hour
|
||||
502. Only a MISSING file is genuinely benign.
|
||||
|
||||
Catches the mutation that restores `Err(_) => Ok(Vec::new())`.
|
||||
</content>
|
||||
@@ -1,49 +0,0 @@
|
||||
# freemkv-keysources: scope and design notes
|
||||
|
||||
## Mechanism vs. policy
|
||||
|
||||
Applications (autorip, the `freemkv` CLI) choose and order the key sources
|
||||
from their own config — the local-vs-online policy is just which impls they
|
||||
plug in — then resolve and hand the resulting key to `Disc::decrypt_with`.
|
||||
|
||||
Each source resolves a disc's terminal **Unit Keys** in one shot via
|
||||
`KeySource::get_unit_keys`, driving libfreemkv's boil-down crypto primitives
|
||||
for whatever level of material it holds. Compose several with `MultiSource`
|
||||
in the caller's chosen order.
|
||||
|
||||
Reading the encrypted content-sample units a key server validates on, and
|
||||
applying the resolved keys against a disc, is decryption *mechanism* — it
|
||||
lives in the library (`libfreemkv::resolve_and_apply`,
|
||||
`libfreemkv::read_encrypted_units`), not here.
|
||||
|
||||
## `MultiSource` failure semantics
|
||||
|
||||
`MultiSource::get_unit_keys` tries each inner source in order and returns the
|
||||
first non-empty Unit Key set (and `get_fmts_indexes` does the same for the
|
||||
forensic set). The caller supplies the list AND the order — local-first
|
||||
`[Keydb, Online]`, online-first `[Online, Keydb]`, etc. — so the "which
|
||||
sources, in what order" policy lives entirely with the application, not the
|
||||
library. `MultiSource` is itself a `KeySource`, so it nests and composes.
|
||||
|
||||
**A source that could not ANSWER is not a source that answered "no key".**
|
||||
When no inner source produces keys, the composition returns `Err` if any
|
||||
inner source failed, and `Ok(empty)` only when every source genuinely
|
||||
answered and none held a key. This mirrors libfreemkv's own resolver
|
||||
(`keysource::drive_unit_keys`, which tracks an `errored` flag, and
|
||||
`source_failure`, which stamps the first failure onto the disc) — a
|
||||
composition that swallowed the `Err` would hand the resolver a clean
|
||||
`Ok(empty)`, and an outage would once again be reported to the operator as
|
||||
`E7022 No key source has a decryption key for this disc`.
|
||||
|
||||
## `first_non_empty` ordering rule
|
||||
|
||||
A source failure never blocks the chain (a later source is still tried, and
|
||||
a later success still wins outright, error or no error), but it is not
|
||||
forgotten either: with no keys anywhere, the FIRST failure is returned.
|
||||
First (not last) matches libfreemkv's `source_failure` rule, so the
|
||||
most-preferred source's reason is the one the operator is told about, in the
|
||||
same order the caller expressed a preference for successes.
|
||||
|
||||
`get` selects which trait method to drive, so the base and forensic paths
|
||||
share ONE implementation of this rule and cannot drift apart — the forensic
|
||||
half carried the identical bug.
|
||||
@@ -1,13 +0,0 @@
|
||||
# `MultiSource`: a source that could not answer is not a source that said no
|
||||
|
||||
`MultiSource` used to re-collapse the Ok/Err distinction `OnlineSource` was
|
||||
engineered to draw: `if let Ok(uks) = s.get_unit_keys(ctx)` discarded every
|
||||
`Err`, so a composition whose sources ALL failed returned `Ok(Vec::new())` —
|
||||
which the resolver reports as `E7022 No key source has a decryption key for
|
||||
this disc`. That is the seven-hour-502 incident reproduced one layer up.
|
||||
|
||||
The regression test `multi_source_reports_a_source_failure_instead_of_a_clean_no_key`
|
||||
is THE regression check, one layer up from `interpret_reply`: when no source
|
||||
holds a key AND a source could not answer, the composition must report the
|
||||
FAILURE, never a clean "no key". It catches the mutation that restores
|
||||
`if let Ok(uks) = ..` (which drops the `Err` and returns `Ok(empty)`).
|
||||
@@ -1,39 +0,0 @@
|
||||
# `src/online.rs` — `OnlineSource::agent` caching
|
||||
|
||||
## Why cache at all
|
||||
|
||||
`query` used to build a FRESH `ureq::Agent` every call, and an FMTS disc
|
||||
makes two calls per rip (`get_unit_keys` + `get_fmts_indexes`), so it paid
|
||||
two TLS handshakes to the same host for no reason — an agent owns the
|
||||
connection pool, and a discarded agent discards the pooled, already
|
||||
negotiated TLS connection with it.
|
||||
|
||||
## Security invariant
|
||||
|
||||
The agent is reused ONLY when the freshly resolved + guarded address SET is
|
||||
identical to the one the cached agent is pinned to. Every query still
|
||||
re-resolves and re-runs the SSRF guard — that is the whole anti-rebinding
|
||||
defence and is deliberately not cached; what is reused is the connection,
|
||||
and only to addresses just re-validated this call.
|
||||
|
||||
## Why the cache key is a sorted, deduped SET, not an ordered sequence
|
||||
|
||||
`to_socket_addrs` hands back whatever order the resolver felt like, and a
|
||||
round-robin keyserver reorders its A/AAAA records on essentially every
|
||||
lookup — an ordered `==` therefore missed the cache every single time
|
||||
against exactly the deployment that most needs it, silently degrading to
|
||||
the per-query TLS handshake this field exists to avoid.
|
||||
|
||||
Set equality is also the honest predicate: the security property being
|
||||
asserted is "these are the same validated addresses", which says nothing
|
||||
about their order. The agent itself stays pinned to the order it was BUILT
|
||||
with; that is safe because an equal set means every address it holds was
|
||||
re-resolved and re-guarded this call.
|
||||
|
||||
## `a_reordered_but_identical_address_set_reuses_the_agent`
|
||||
|
||||
Catches the mutation that drops the sort/dedup from `agent_for`'s key (the
|
||||
reversed order would then build a second agent) and, via the second half of
|
||||
the test, the mutation that "fixes" order-sensitivity by comparing only
|
||||
lengths or the first element — which would wrongly reuse an agent pinned to
|
||||
a DIFFERENT address.
|
||||
@@ -1,41 +0,0 @@
|
||||
# `src/online.rs` — `GuardFail` classification details
|
||||
|
||||
## Malformed-port authority
|
||||
|
||||
A `host:port` authority whose port is not a u16 is a TYPO in the operator's
|
||||
config — `https://example.com:notaport/keys`. This used to fall back to the
|
||||
WHOLE authority as the hostname (port text included), which of course never
|
||||
resolves, so the URL surfaced as `GuardFail::Unreachable` →
|
||||
`Err(KeyServiceUnavailable)`: a standing misconfiguration reported as a
|
||||
transient outage, the exact collapse `GuardFail`'s own doc says must not
|
||||
happen, because the two halves demand OPPOSITE operator actions (fix the URL
|
||||
vs. wait).
|
||||
|
||||
Reject it as `Config`, identical to the bracketed-IPv6 branch a few lines
|
||||
above, which already returns `Config` for an unparseable port. Silently
|
||||
substituting `default_port` would be worse still — it would ship the bearer
|
||||
token and key material to a port the operator never configured.
|
||||
|
||||
## Guard-blocked address (`Config` arm, `resolve_and_guard`)
|
||||
|
||||
Log THAT the URL was rejected, never WHY: the guard's message names the
|
||||
resolved address, and an internal address must not reach a log an operator
|
||||
may paste into a bug report. The static label is enough to separate
|
||||
"misconfigured/blocked key-service URL" from "this disc has no key", which
|
||||
is the only distinction the operator needs here.
|
||||
|
||||
`error!`, not `warn!`, and `Err`, not `Ok(empty)`. This arm used to return
|
||||
`Ok(Vec::new())`, which made the PERMANENT fault quieter than the transient
|
||||
one directly above it: the service was never asked, yet the composition was
|
||||
handed a clean empty and — with no other source holding the key — told the
|
||||
operator `E7022 no key for this disc`. Same lie as the seven-hour 502, from
|
||||
a config typo that never self-heals. A failure to ask is never evidence
|
||||
about the disc, so it leaves as `Err`; `MultiSource::first_non_empty` still
|
||||
lets a later source's real key win outright, so this cannot fail a rip that
|
||||
the local keydb could have served.
|
||||
|
||||
NOTE (reported upstream): libfreemkv has no `KeyServiceMisconfigured` code,
|
||||
so the permanent fault borrows the transient E7028. E7028's contract — "the
|
||||
source never got as far as answering the question" — is exactly true here;
|
||||
only its "transient, retry later" hint is wrong, and the `error!` log
|
||||
carries the correcting detail until a 70xx config code exists.
|
||||
@@ -1,20 +0,0 @@
|
||||
# `src/online.rs` tests — pre-flight guards in `query`
|
||||
|
||||
Each of the three guards (cleartext scheme, over-cap MKB, under-sampled)
|
||||
fires BEFORE any address is resolved and before anything is sent. None was
|
||||
exercised before these tests: a reordering that let the cleartext POST
|
||||
through would have shipped green, and that POST carries the bearer token
|
||||
plus base64 key material.
|
||||
|
||||
Their VERDICTS differ on purpose (see docs/online-query-guards.md): the
|
||||
cleartext-scheme guard is an operator fault and yields `Err`, while the two
|
||||
input-shaped guards yield `Ok(empty)` — this source has nothing for THIS
|
||||
disc, permanently, and calling that an outage would send the operator
|
||||
waiting for nothing.
|
||||
|
||||
The discriminator in all three: the configured host is `.test`, which RFC
|
||||
6761 guarantees never resolves. On the guarded path nothing resolves it, so
|
||||
the test touches no network and returns `Ok(empty)`. Remove the guard and
|
||||
control reaches `resolve_and_guard`, which fails as `Unreachable` ->
|
||||
`Err(KeyServiceUnavailable)` — a different Result, so the mutation cannot
|
||||
pass.
|
||||
@@ -1,19 +0,0 @@
|
||||
# `src/online.rs` — `OnlineSource::query` return contract
|
||||
|
||||
The return type draws THE distinction this source exists to draw:
|
||||
|
||||
* `Ok(non-empty)` — the service answered with a key.
|
||||
* `Ok(empty)` — the service ANSWERED and holds no key for this disc, or this
|
||||
source had nothing to ask with (no service configured, a misconfigured
|
||||
URL, an over-cap MKB, too few samples). A genuine miss; the resolver moves
|
||||
to the next source and `E7022` is the right verdict.
|
||||
* `Err(..)` — the service could not answer: unreachable, timed out, DNS
|
||||
failed, returned 5xx, rejected the token (401/403), rate-limited (429), or
|
||||
replied with something unreadable. NOTHING is known about whether a key
|
||||
exists. Collapsing this into `Ok(empty)` is the bug this signature fixes:
|
||||
a seven-hour run of HTTP 502s was reported to operators as
|
||||
`E7022 No key source has a decryption key for this disc`, and they went
|
||||
hunting for a VUK when the correct action was to wait.
|
||||
|
||||
`&self`: one-shot is the resolver's contract (each source's
|
||||
`get_unit_keys` is called once), so no per-call latch is needed.
|
||||
@@ -1,57 +0,0 @@
|
||||
# `src/online.rs` — `OnlineSource::query` pre-flight guards
|
||||
|
||||
## Refusing cleartext (`http://`)
|
||||
|
||||
The request body always carries base64 AACS key material
|
||||
(inf/mkb/units/vid) and, when configured, a bearer token in a header — so an
|
||||
`http://` POST hands both to any on-path observer, and the token is
|
||||
replayable.
|
||||
|
||||
There is no legitimate plaintext deployment to preserve here: the address
|
||||
guard rejects loopback, RFC1918, ULA and link-local, so an `http://` URL can
|
||||
only ever reach the PUBLIC internet — the single worst case for cleartext. A
|
||||
self-hosted keyserver on a LAN is already impossible by that guard, whatever
|
||||
its scheme.
|
||||
|
||||
Still falls THROUGH to the next key source (a local keydb) — an `Err` here
|
||||
does not block the chain, because `MultiSource::first_non_empty` returns any
|
||||
later source's non-empty key set outright and only surfaces the failure
|
||||
when nothing anywhere resolved. What it does stop is the silent case: a
|
||||
cleartext URL is the same permanent operator fault as the address-guard
|
||||
rejection (see `GuardFail`), so it gets the same verdict. Returning
|
||||
`Ok(empty)` here made "we refused to ask" indistinguishable from "the
|
||||
service answered and has no key".
|
||||
|
||||
## The three-way skip/fault/miss line (MKB cap, sample count)
|
||||
|
||||
Written out after the `Config`-was-quieter-than-`Unreachable` bug, in three
|
||||
parts:
|
||||
|
||||
* NO URL AT ALL is not a fault: the operator did not configure an online
|
||||
source, so there is nothing to report. `Ok(empty)`, silently (the first
|
||||
guard in `query`).
|
||||
* A bad URL — wrong scheme, mistyped port, guard-blocked address — is an
|
||||
OPERATOR FAULT. Every disc is affected, nothing was asked, and the fix is
|
||||
to edit the config. That is `Err`.
|
||||
* An over-cap MKB or too few content samples is a property of THIS DISC's
|
||||
inputs, not a fault: the request cannot be *formed* for this disc, so this
|
||||
source has nothing for it and never will, whatever the operator does and
|
||||
however long they wait. Reporting that as `KeyServiceUnavailable` would
|
||||
send the operator waiting out an outage that does not exist — the same
|
||||
mislabelling in the opposite direction. These stay `Ok(empty)`, and stay
|
||||
logged.
|
||||
|
||||
Logging on the MKB-cap skip matters: a silent empty return there is
|
||||
indistinguishable from "no key", so the real cause is surfaced (the cap is
|
||||
64 MiB, far above any real trimmed MKB).
|
||||
|
||||
## `cleartext_http_url_is_refused_before_anything_is_sent`
|
||||
|
||||
Catches two mutations: sending the request anyway (the host is `.test` and
|
||||
would surface as `Unreachable`, but the assertion would still hold, which is
|
||||
why `too_few_samples_skips_the_request` guards the send-path ordering
|
||||
separately) and — the one this test was rewritten for — returning
|
||||
`Ok(Vec::new())`, which made a permanent cleartext misconfiguration
|
||||
indistinguishable from a genuine miss. A later source's real key still wins
|
||||
(`MultiSource::first_non_empty`), so refusing does not fail a rip the local
|
||||
keydb can serve.
|
||||
@@ -1,44 +0,0 @@
|
||||
# `src/online.rs` — SSRF guard
|
||||
|
||||
## Threat model
|
||||
|
||||
The keyserver URL is operator-supplied and the bearer token is confidential.
|
||||
After `validate_keyserver_url` checked the host at config time, an attacker
|
||||
who controls the keyserver's DNS can rebind it to 169.254.169.254 (cloud
|
||||
metadata) or an RFC1918 host in the window between validation and the actual
|
||||
POST, exfiltrating the key material and the Authorization token.
|
||||
|
||||
## Defence
|
||||
|
||||
Resolve the host once just before the POST, reject any blocked IP, and pin
|
||||
the ureq connection to those validated addresses so a subsequent DNS flip
|
||||
cannot redirect the request. Use `redirects(0)` so a public URL can't
|
||||
30x-redirect to an internal host.
|
||||
|
||||
## Resolver wiring pitfall (`PinnedResolver`)
|
||||
|
||||
ureq 3 replaced v2's resolver closure with the `Resolver` trait. The agent
|
||||
MUST be built through `Agent::with_parts` to take a custom one:
|
||||
`Agent::new_with_config` silently keeps the default resolver, which would
|
||||
send the request to live DNS and quietly reopen the rebinding window this
|
||||
module exists to close. That failure is invisible — it has no symptom short
|
||||
of an actual attack — so it is pinned by the test
|
||||
`hardened_agent_connects_to_the_pinned_address_not_dns`.
|
||||
|
||||
## Why that test is structured the way it is
|
||||
|
||||
`resolve_and_guard` VALIDATES addresses; `hardened_agent` PINS them, so a
|
||||
hostname cannot re-resolve to an internal address between validation and
|
||||
connection. The validation half is well covered by other tests — but every
|
||||
one of those still passes if the pinned resolver is never consulted, because
|
||||
none of them makes a connection. Nothing else in the file proves the agent
|
||||
honours the pin, and a mis-wired resolver fails OPEN: the connection quietly
|
||||
falls back to live DNS and the rebinding window this module exists to close
|
||||
is reopened, with no visible symptom.
|
||||
|
||||
The discriminator: pin the agent to a loopback listener the test owns, then
|
||||
ask it for a host that CANNOT resolve — `.test` is reserved by RFC 6761 and
|
||||
never resolves in the public DNS. Only a consulted resolver can turn that
|
||||
name into a connection; a fallback to live DNS fails instead. No network is
|
||||
touched, and `query` (whose guard blocks loopback by design) is not
|
||||
involved — this drives `hardened_agent` directly.
|
||||
@@ -1,13 +0,0 @@
|
||||
# `keydb.cfg` path policy (`src/paths.rs`)
|
||||
|
||||
Key-path policy belongs with the key sources (this crate), not the library:
|
||||
libfreemkv is handed a path and reads it. The CLI/app asks here for the
|
||||
list of locations to *search* (first existing wins) and for the single
|
||||
*default* location to write to (e.g. `update-keys`/save).
|
||||
|
||||
freemkv is a portable, standalone binary: the `keydb.cfg` lives *next to*
|
||||
the executable — `<dir of current exe>/keydb.cfg` — and nowhere else. There
|
||||
is no OS-specific config-dir lookup (`%APPDATA%`, `%USERPROFILE%\.config`,
|
||||
`$XDG_CONFIG_HOME`, `$HOME/.config`). Drop the exe and its `keydb.cfg` in
|
||||
the same folder and it works. Callers needing a custom location pass
|
||||
`--keydb PATH`, which bypasses this module entirely.
|
||||
+153
-1228
File diff suppressed because it is too large
Load Diff
+34
-1553
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
+1311
File diff suppressed because it is too large
Load Diff
+72
-111
@@ -1,11 +1,10 @@
|
||||
//! Pluggable AACS key sources for libfreemkv.
|
||||
//!
|
||||
//! libfreemkv owns the AACS crypto; this crate provides [`KeySource`] impls
|
||||
//! that look a disc up and drive the boil-down primitives to terminal Unit
|
||||
//! Keys: [`KeydbSource`] (local `keydb.cfg`) and [`OnlineSource`] (remote key
|
||||
//! service). Applications choose and order sources, then resolve and hand
|
||||
//! the key to `Disc::decrypt_with`; compose several with [`MultiSource`].
|
||||
//! See docs/lib-scope.md for the mechanism-vs-policy split with libfreemkv.
|
||||
//! libfreemkv owns the AACS crypto; this crate provides [`KeySource`] impls that look a disc up
|
||||
//! and drive the boil-down primitives to terminal Unit Keys: [`KeydbSource`] (local
|
||||
//! `keydb.cfg`) and [`OnlineSource`] (remote key service). Applications choose and order
|
||||
//! sources, then resolve and hand the key to `Disc::decrypt_with`; compose several with
|
||||
//! [`MultiSource`].
|
||||
|
||||
mod keydb;
|
||||
/// The `keydb.cfg` parser (`KeyDb`, `DiscEntry`, …). Public: parsing the keydb
|
||||
@@ -17,8 +16,11 @@ mod paths;
|
||||
|
||||
pub use keydb::{KeydbSource, UpdateResult};
|
||||
pub use keydb_format::{DiscEntry, KeyDb};
|
||||
#[cfg(feature = "test-hooks")]
|
||||
pub use online::set_last_decode_reachability;
|
||||
pub use online::{
|
||||
DecodeReachability, MIN_SAMPLE_UNITS, OnlineSource, take_last_decode_reachability,
|
||||
DecodeReachability, KeyserverUrlFault, KeyserverUrlRejection, MIN_SAMPLE_UNITS, OnlineSource,
|
||||
check_keyserver_url, check_keyserver_url_static, take_last_decode_reachability,
|
||||
validate_keyserver_url,
|
||||
};
|
||||
pub use paths::{default_keydb_path, existing_keydb_path, keydb_search_paths};
|
||||
@@ -42,13 +44,11 @@ pub(crate) fn uks_from_vuk(vuk: &[u8; 16], enc_title_keys: &[[u8; 16]]) -> Vec<U
|
||||
|
||||
/// An ordered composition of key sources, driven as one.
|
||||
///
|
||||
/// [`MultiSource::get_unit_keys`] tries each inner source in order and
|
||||
/// returns the first non-empty Unit Key set (and
|
||||
/// [`MultiSource::get_fmts_indexes`] does the same for the forensic set). The
|
||||
/// caller supplies the list AND the order — local-first `[Keydb, Online]`,
|
||||
/// online-first `[Online, Keydb]`, etc. `MultiSource` is itself a
|
||||
/// [`KeySource`], so it nests and composes. See docs/lib-scope.md for the
|
||||
/// `Err`-vs-`Ok(empty)` failure contract.
|
||||
/// [`MultiSource::get_unit_keys`] tries each inner source in order and returns the first
|
||||
/// non-empty Unit Key set (and [`MultiSource::get_fmts_indexes`] does the same for the forensic
|
||||
/// set). The caller supplies the list AND the order — local-first `[Keydb, Online]`,
|
||||
/// online-first `[Online, Keydb]`, etc. `MultiSource` is itself a [`KeySource`], so it nests
|
||||
/// and composes.
|
||||
pub struct MultiSource {
|
||||
sources: Vec<Box<dyn KeySource>>,
|
||||
}
|
||||
@@ -60,9 +60,9 @@ impl MultiSource {
|
||||
}
|
||||
}
|
||||
|
||||
// Drive `sources` in order, returning the first non-empty result and
|
||||
// preserving Ok/Err when nothing resolves. `get` selects the trait method so
|
||||
// the base and forensic paths share one implementation. See docs/lib-scope.md.
|
||||
// Drive `sources` in order, returning the first non-empty result and preserving Ok/Err when
|
||||
// nothing resolves. `get` selects the trait method so the base and forensic paths share one
|
||||
// implementation.
|
||||
fn first_non_empty(
|
||||
sources: &[Box<dyn KeySource>],
|
||||
get: impl Fn(&dyn KeySource, &dyn ResolveCtx) -> Result<Vec<UnitKey>, libfreemkv::Error>,
|
||||
@@ -97,6 +97,39 @@ impl KeySource for MultiSource {
|
||||
first_non_empty(&self.sources, |s, c| s.get_unit_keys(c), ctx)
|
||||
}
|
||||
|
||||
// De-conflated counterpart: first inner source with keys wins; else the
|
||||
// richest miss survives composition (a MATCHED inner source beats a plain
|
||||
// miss). Same Err/Ok failure contract as `get_unit_keys`.
|
||||
fn resolve_unit_keys(
|
||||
&self,
|
||||
ctx: &dyn ResolveCtx,
|
||||
) -> Result<libfreemkv::keysource::UnitKeyResolution, libfreemkv::Error> {
|
||||
let mut first_failure: Option<libfreemkv::Error> = None;
|
||||
let mut matched: Option<libfreemkv::keysource::UnitKeyResolution> = None;
|
||||
for s in &self.sources {
|
||||
match s.resolve_unit_keys(ctx) {
|
||||
Ok(r) if !r.keys.is_empty() => return Ok(r),
|
||||
Ok(r) => {
|
||||
if r.matched && matched.is_none() {
|
||||
matched = Some(r);
|
||||
}
|
||||
}
|
||||
Err(e) => {
|
||||
if first_failure.is_none() {
|
||||
first_failure = Some(e);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
if let Some(r) = matched {
|
||||
return Ok(r);
|
||||
}
|
||||
match first_failure {
|
||||
Some(e) => Err(e),
|
||||
None => Ok(libfreemkv::keysource::UnitKeyResolution::default()),
|
||||
}
|
||||
}
|
||||
|
||||
// Forensic-index counterpart to `get_unit_keys`, same failure-preserving
|
||||
// rule. A source with no forensic material (keydb, via the trait default)
|
||||
// contributes empty and is skipped; today the online source answers.
|
||||
@@ -104,9 +137,9 @@ impl KeySource for MultiSource {
|
||||
first_non_empty(&self.sources, |s, c| s.get_fmts_indexes(c), ctx)
|
||||
}
|
||||
|
||||
/// UNION every inner source's host certs (filtered at the given MKB
|
||||
/// generation). Without this a composed source would hide an inner source's
|
||||
/// cert from the OEM cert-auth route — the gap this fixes.
|
||||
/// UNION every inner source's host certs, in source order (`mkb` is passed
|
||||
/// through unchanged). Without this a composed source would hide an inner
|
||||
/// source's cert from the OEM cert-auth route — the gap this fixes.
|
||||
fn host_certs(&self, mkb: Option<u32>) -> Vec<libfreemkv::aacs::types::HostCert> {
|
||||
self.sources
|
||||
.iter()
|
||||
@@ -117,97 +150,25 @@ impl KeySource for MultiSource {
|
||||
fn label(&self) -> &'static str {
|
||||
"multi"
|
||||
}
|
||||
|
||||
// KU3-6: depends on samples if ANY inner source does, so a nested
|
||||
// sample-dependent source keeps getting the per-piece ask.
|
||||
fn answer_depends_on_samples(&self) -> bool {
|
||||
self.sources.iter().any(|s| s.answer_depends_on_samples())
|
||||
}
|
||||
|
||||
// Same `any(inner)` rule (KU-K1 review): `resolve` retries the composition
|
||||
// whenever any inner source's last failure was transport-class.
|
||||
fn last_failure_was_transport(&self) -> bool {
|
||||
self.sources.iter().any(|s| s.last_failure_was_transport())
|
||||
}
|
||||
|
||||
// KU J23: any inner source that consumes the VID makes the composition one.
|
||||
fn uses_vid(&self) -> bool {
|
||||
self.sources.iter().any(|s| s.uses_vid())
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use libfreemkv::aacs::types::HostCert;
|
||||
|
||||
// A minimal KeySource that only supplies host certs — the sole MultiSource
|
||||
// behaviour under test. It never resolves a unit key.
|
||||
struct CertOnly {
|
||||
certs: Vec<HostCert>,
|
||||
}
|
||||
impl KeySource for CertOnly {
|
||||
fn get_unit_keys(&self, _ctx: &dyn ResolveCtx) -> Result<Vec<UnitKey>, libfreemkv::Error> {
|
||||
Ok(Vec::new())
|
||||
}
|
||||
fn host_certs(&self, _mkb: Option<u32>) -> Vec<HostCert> {
|
||||
self.certs.clone()
|
||||
}
|
||||
}
|
||||
|
||||
// A host cert tagged with a distinct marker byte so a returned set can be
|
||||
// identified exactly. Synthetic bytes only; no real key material.
|
||||
fn cert(marker: u8) -> HostCert {
|
||||
HostCert {
|
||||
private_key: [marker; 20],
|
||||
certificate: vec![marker; 92],
|
||||
private_key_v2: None,
|
||||
certificate_v2: None,
|
||||
}
|
||||
}
|
||||
|
||||
fn boxed(certs: Vec<HostCert>) -> Box<dyn KeySource> {
|
||||
Box::new(CertOnly { certs }) as Box<dyn KeySource>
|
||||
}
|
||||
|
||||
/// `MultiSource::host_certs` must UNION every inner source's certs. Without
|
||||
/// this a composed source hides an inner source's cert from the OEM
|
||||
/// cert-auth route — the gap the union closes.
|
||||
#[test]
|
||||
fn multi_source_host_certs_unions_every_inner_source() {
|
||||
let multi = MultiSource::new(vec![
|
||||
boxed(vec![cert(0x01)]),
|
||||
boxed(vec![cert(0x02), cert(0x03)]),
|
||||
]);
|
||||
let mut markers: Vec<u8> = multi
|
||||
.host_certs(Some(50))
|
||||
.iter()
|
||||
.map(|c| c.certificate[0])
|
||||
.collect();
|
||||
markers.sort_unstable();
|
||||
assert_eq!(
|
||||
markers,
|
||||
vec![0x01, 0x02, 0x03],
|
||||
"certs from every inner source must be unioned"
|
||||
);
|
||||
}
|
||||
|
||||
/// With no inner source holding a cert, the union is empty (not an error).
|
||||
#[test]
|
||||
fn multi_source_host_certs_empty_when_no_source_has_one() {
|
||||
let multi = MultiSource::new(vec![boxed(vec![]), boxed(vec![])]);
|
||||
assert!(multi.host_certs(None).is_empty());
|
||||
}
|
||||
|
||||
/// The `mkb` generation must reach each inner source so its OWN revocation
|
||||
/// filter can act; a source that drops everything at a given generation is
|
||||
/// honoured by the union.
|
||||
#[test]
|
||||
fn multi_source_host_certs_passes_mkb_through_to_inner_sources() {
|
||||
struct GenAware;
|
||||
impl KeySource for GenAware {
|
||||
fn get_unit_keys(
|
||||
&self,
|
||||
_c: &dyn ResolveCtx,
|
||||
) -> Result<Vec<UnitKey>, libfreemkv::Error> {
|
||||
Ok(Vec::new())
|
||||
}
|
||||
fn host_certs(&self, mkb: Option<u32>) -> Vec<HostCert> {
|
||||
match mkb {
|
||||
// Modelled on a cert revoked in MKBv72.
|
||||
Some(g) if g >= 72 => Vec::new(),
|
||||
_ => vec![cert(0xaa)],
|
||||
}
|
||||
}
|
||||
}
|
||||
let multi = MultiSource::new(vec![Box::new(GenAware) as Box<dyn KeySource>]);
|
||||
assert_eq!(multi.host_certs(Some(50)).len(), 1, "usable below gen 72");
|
||||
assert!(
|
||||
multi.host_certs(Some(72)).is_empty(),
|
||||
"the gen must reach the inner source's filter"
|
||||
);
|
||||
}
|
||||
}
|
||||
#[path = "lib_tests.rs"]
|
||||
mod tests;
|
||||
|
||||
@@ -0,0 +1,172 @@
|
||||
use super::*;
|
||||
use libfreemkv::aacs::types::HostCert;
|
||||
|
||||
// A minimal KeySource that only supplies host certs — the sole MultiSource
|
||||
// behaviour under test. It never resolves a unit key.
|
||||
struct CertOnly {
|
||||
certs: Vec<HostCert>,
|
||||
}
|
||||
impl KeySource for CertOnly {
|
||||
fn get_unit_keys(&self, _ctx: &dyn ResolveCtx) -> Result<Vec<UnitKey>, libfreemkv::Error> {
|
||||
Ok(Vec::new())
|
||||
}
|
||||
fn host_certs(&self, _mkb: Option<u32>) -> Vec<HostCert> {
|
||||
self.certs.clone()
|
||||
}
|
||||
}
|
||||
|
||||
// A host cert tagged with a distinct marker byte so a returned set can be
|
||||
// identified exactly. Synthetic bytes only; no real key material.
|
||||
fn cert(marker: u8) -> HostCert {
|
||||
HostCert {
|
||||
private_key: [marker; 20],
|
||||
certificate: vec![marker; 92],
|
||||
private_key_v2: None,
|
||||
certificate_v2: None,
|
||||
}
|
||||
}
|
||||
|
||||
fn boxed(certs: Vec<HostCert>) -> Box<dyn KeySource> {
|
||||
Box::new(CertOnly { certs }) as Box<dyn KeySource>
|
||||
}
|
||||
|
||||
/// `MultiSource::host_certs` must UNION every inner source's certs. Without
|
||||
/// this a composed source hides an inner source's cert from the OEM
|
||||
/// cert-auth route — the gap the union closes.
|
||||
#[test]
|
||||
fn multi_source_host_certs_unions_every_inner_source() {
|
||||
let multi = MultiSource::new(vec![
|
||||
boxed(vec![cert(0x01)]),
|
||||
boxed(vec![cert(0x02), cert(0x03)]),
|
||||
]);
|
||||
let mut markers: Vec<u8> = multi
|
||||
.host_certs(Some(50))
|
||||
.iter()
|
||||
.map(|c| c.certificate[0])
|
||||
.collect();
|
||||
markers.sort_unstable();
|
||||
assert_eq!(
|
||||
markers,
|
||||
vec![0x01, 0x02, 0x03],
|
||||
"certs from every inner source must be unioned"
|
||||
);
|
||||
}
|
||||
|
||||
/// With no inner source holding a cert, the union is empty (not an error).
|
||||
#[test]
|
||||
fn multi_source_host_certs_empty_when_no_source_has_one() {
|
||||
let multi = MultiSource::new(vec![boxed(vec![]), boxed(vec![])]);
|
||||
assert!(multi.host_certs(None).is_empty());
|
||||
}
|
||||
|
||||
// A source whose `answer_depends_on_samples` is fixed to the given value —
|
||||
// the only behaviour KSK2 exercises.
|
||||
struct FixedDependency(bool);
|
||||
impl KeySource for FixedDependency {
|
||||
fn get_unit_keys(&self, _ctx: &dyn ResolveCtx) -> Result<Vec<UnitKey>, libfreemkv::Error> {
|
||||
Ok(Vec::new())
|
||||
}
|
||||
fn answer_depends_on_samples(&self) -> bool {
|
||||
self.0
|
||||
}
|
||||
}
|
||||
|
||||
// KSK2: `MultiSource::answer_depends_on_samples` is `any(inner)`, so nesting
|
||||
// a sample-dependent online source under a sample-independent keydb still
|
||||
// gets the per-piece ask (`resolve` must not treat the pair as keydb-only).
|
||||
#[test]
|
||||
fn multi_source_answer_depends_on_samples_is_any_inner() {
|
||||
let all_independent = MultiSource::new(vec![
|
||||
Box::new(FixedDependency(false)) as Box<dyn KeySource>,
|
||||
Box::new(FixedDependency(false)) as Box<dyn KeySource>,
|
||||
]);
|
||||
assert!(!all_independent.answer_depends_on_samples());
|
||||
|
||||
let keydb_then_online = MultiSource::new(vec![
|
||||
Box::new(FixedDependency(false)) as Box<dyn KeySource>,
|
||||
Box::new(FixedDependency(true)) as Box<dyn KeySource>,
|
||||
]);
|
||||
assert!(keydb_then_online.answer_depends_on_samples());
|
||||
}
|
||||
|
||||
// A source whose `uses_vid` is fixed to the given value.
|
||||
struct FixedVid(bool);
|
||||
impl KeySource for FixedVid {
|
||||
fn get_unit_keys(&self, _ctx: &dyn ResolveCtx) -> Result<Vec<UnitKey>, libfreemkv::Error> {
|
||||
Ok(Vec::new())
|
||||
}
|
||||
fn uses_vid(&self) -> bool {
|
||||
self.0
|
||||
}
|
||||
}
|
||||
|
||||
// KU J23: like `answer_depends_on_samples`, a composed source uses the VID if any
|
||||
// inner one does, so a nested online source still makes a Missing piece VID-derivable.
|
||||
#[test]
|
||||
fn multi_source_uses_vid_is_any_inner() {
|
||||
let neither = MultiSource::new(vec![
|
||||
Box::new(FixedVid(false)) as Box<dyn KeySource>,
|
||||
Box::new(FixedVid(false)) as Box<dyn KeySource>,
|
||||
]);
|
||||
assert!(!neither.uses_vid());
|
||||
let keydb_then_online = MultiSource::new(vec![
|
||||
Box::new(FixedVid(false)) as Box<dyn KeySource>,
|
||||
Box::new(FixedVid(true)) as Box<dyn KeySource>,
|
||||
]);
|
||||
assert!(keydb_then_online.uses_vid());
|
||||
}
|
||||
|
||||
// A source whose `last_failure_was_transport` is fixed to the given value.
|
||||
struct FixedTransport(bool);
|
||||
impl KeySource for FixedTransport {
|
||||
fn get_unit_keys(&self, _ctx: &dyn ResolveCtx) -> Result<Vec<UnitKey>, libfreemkv::Error> {
|
||||
Ok(Vec::new())
|
||||
}
|
||||
fn last_failure_was_transport(&self) -> bool {
|
||||
self.0
|
||||
}
|
||||
}
|
||||
|
||||
// For consistency with `answer_depends_on_samples` (KU3-6): a composed
|
||||
// source's last-failure verdict is `any(inner)` too, so `resolve` retries
|
||||
// the composition whenever ANY inner source's last failure was transport.
|
||||
#[test]
|
||||
fn multi_source_last_failure_was_transport_is_any_inner() {
|
||||
let none_transport = MultiSource::new(vec![
|
||||
Box::new(FixedTransport(false)) as Box<dyn KeySource>,
|
||||
Box::new(FixedTransport(false)) as Box<dyn KeySource>,
|
||||
]);
|
||||
assert!(!none_transport.last_failure_was_transport());
|
||||
|
||||
let one_transport = MultiSource::new(vec![
|
||||
Box::new(FixedTransport(false)) as Box<dyn KeySource>,
|
||||
Box::new(FixedTransport(true)) as Box<dyn KeySource>,
|
||||
]);
|
||||
assert!(one_transport.last_failure_was_transport());
|
||||
}
|
||||
|
||||
/// The `mkb` generation must reach each inner source so its OWN revocation
|
||||
/// filter can act; a source that drops everything at a given generation is
|
||||
/// honoured by the union.
|
||||
#[test]
|
||||
fn multi_source_host_certs_passes_mkb_through_to_inner_sources() {
|
||||
struct GenAware;
|
||||
impl KeySource for GenAware {
|
||||
fn get_unit_keys(&self, _c: &dyn ResolveCtx) -> Result<Vec<UnitKey>, libfreemkv::Error> {
|
||||
Ok(Vec::new())
|
||||
}
|
||||
fn host_certs(&self, mkb: Option<u32>) -> Vec<HostCert> {
|
||||
match mkb {
|
||||
// Modelled on a cert revoked in MKBv72.
|
||||
Some(g) if g >= 72 => Vec::new(),
|
||||
_ => vec![cert(0xaa)],
|
||||
}
|
||||
}
|
||||
}
|
||||
let multi = MultiSource::new(vec![Box::new(GenAware) as Box<dyn KeySource>]);
|
||||
assert_eq!(multi.host_certs(Some(50)).len(), 1, "usable below gen 72");
|
||||
assert!(
|
||||
multi.host_certs(Some(72)).is_empty(),
|
||||
"the gen must reach the inner source's filter"
|
||||
);
|
||||
}
|
||||
+615
-1225
File diff suppressed because it is too large
Load Diff
+1936
File diff suppressed because it is too large
Load Diff
+4
-45
@@ -4,9 +4,8 @@
|
||||
//! just reads a handed-in path. This module gives the *search* list (first
|
||||
//! existing wins) and the single *default* write location.
|
||||
//!
|
||||
//! freemkv is portable: `keydb.cfg` lives next to the exe —
|
||||
//! `<dir of current exe>/keydb.cfg` — with no OS config-dir fallback.
|
||||
//! `--keydb PATH` bypasses this module. See docs/paths.md for rationale.
|
||||
//! freemkv is portable: `keydb.cfg` lives next to the exe — `<dir of current exe>/keydb.cfg` —
|
||||
//! with no OS config-dir fallback. `--keydb PATH` bypasses this module.
|
||||
|
||||
use std::path::PathBuf;
|
||||
|
||||
@@ -47,45 +46,5 @@ pub fn default_keydb_path() -> Option<PathBuf> {
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
/// The expected exe-local keydb path, computed the same way the code does.
|
||||
/// Under `cargo test`, `current_exe()` is the test binary under `target/…`.
|
||||
fn expected_local() -> Option<PathBuf> {
|
||||
std::env::current_exe()
|
||||
.ok()
|
||||
.and_then(|exe| exe.parent().map(|dir| dir.join("keydb.cfg")))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn search_paths_is_exactly_exe_local_keydb() {
|
||||
let paths = keydb_search_paths();
|
||||
match expected_local() {
|
||||
Some(expected) => {
|
||||
assert_eq!(
|
||||
paths,
|
||||
vec![expected],
|
||||
"search list must be exactly [<exe dir>/keydb.cfg]"
|
||||
);
|
||||
}
|
||||
None => {
|
||||
// No exe dir available → empty, no OS fallback (local only).
|
||||
assert!(
|
||||
paths.is_empty(),
|
||||
"no exe dir means an empty search list, never an OS fallback"
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn default_path_matches_search_head() {
|
||||
// The write default is the single search entry, or None if unavailable.
|
||||
assert_eq!(default_keydb_path(), expected_local());
|
||||
assert_eq!(
|
||||
default_keydb_path(),
|
||||
keydb_search_paths().into_iter().next()
|
||||
);
|
||||
}
|
||||
}
|
||||
#[path = "paths_tests.rs"]
|
||||
mod tests;
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
use super::*;
|
||||
|
||||
/// The expected exe-local keydb path, computed the same way the code does.
|
||||
/// Under `cargo test`, `current_exe()` is the test binary under `target/…`.
|
||||
fn expected_local() -> Option<PathBuf> {
|
||||
std::env::current_exe()
|
||||
.ok()
|
||||
.and_then(|exe| exe.parent().map(|dir| dir.join("keydb.cfg")))
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn search_paths_is_exactly_exe_local_keydb() {
|
||||
let paths = keydb_search_paths();
|
||||
match expected_local() {
|
||||
Some(expected) => {
|
||||
assert_eq!(
|
||||
paths,
|
||||
vec![expected],
|
||||
"search list must be exactly [<exe dir>/keydb.cfg]"
|
||||
);
|
||||
}
|
||||
None => {
|
||||
// No exe dir available → empty, no OS fallback (local only).
|
||||
assert!(
|
||||
paths.is_empty(),
|
||||
"no exe dir means an empty search list, never an OS fallback"
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn default_path_matches_search_head() {
|
||||
// The write default is the single search entry, or None if unavailable.
|
||||
assert_eq!(default_keydb_path(), expected_local());
|
||||
assert_eq!(
|
||||
default_keydb_path(),
|
||||
keydb_search_paths().into_iter().next()
|
||||
);
|
||||
}
|
||||
+10
-14
@@ -138,7 +138,7 @@ fn keydb_source_label_is_keydb() {
|
||||
assert_eq!(KeydbSource::new("/nonexistent/keydb.cfg").label(), "keydb");
|
||||
}
|
||||
|
||||
// ── KeydbSource: MKB-aware host-cert serving from a file ────────────────────
|
||||
// ── KeydbSource: host-cert serving from a file ──────────────────────────────
|
||||
|
||||
#[test]
|
||||
fn keydb_source_serves_host_cert_from_hc_row() {
|
||||
@@ -152,14 +152,13 @@ fn keydb_source_serves_host_cert_from_hc_row() {
|
||||
let path = s.write("keydb.cfg", &line);
|
||||
|
||||
let src = KeydbSource::new(&path);
|
||||
// Inherent (no-MKB, scan-options) form.
|
||||
// Inherent (scan-options) form.
|
||||
assert_eq!(
|
||||
src.host_certs().len(),
|
||||
1,
|
||||
"inherent host_certs sees the HC row"
|
||||
);
|
||||
// Trait form now wires the MKB generation through (no revocation annotation
|
||||
// → always returned).
|
||||
// Trait form: `mkb` is ignored; the ranked list is returned.
|
||||
let via_trait = KeySource::host_certs(&src, Some(70));
|
||||
assert_eq!(via_trait.len(), 1, "trait host_certs sees the HC row");
|
||||
assert_eq!(via_trait[0].certificate.len(), 92);
|
||||
@@ -229,13 +228,14 @@ fn online_source_metadata() {
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn validate_keyserver_url_gates_scheme_and_ssrf() {
|
||||
fn validate_keyserver_url_gates_scheme_and_allows_lan() {
|
||||
assert!(validate_keyserver_url("https://8.8.8.8/keys").is_ok());
|
||||
// Home app: LAN/loopback/link-local hosts pass; cleartext http and invalid addresses do not.
|
||||
assert!(validate_keyserver_url("https://127.0.0.1/keys").is_ok());
|
||||
assert!(validate_keyserver_url("https://169.254.1.5/keys").is_ok());
|
||||
assert!(validate_keyserver_url("https://[::1]:9000/keys").is_ok());
|
||||
assert!(validate_keyserver_url("http://127.0.0.1/keys").is_err());
|
||||
// SSRF blocking is IP-based, not scheme-gated: https://<private-IP> is rejected too.
|
||||
assert!(validate_keyserver_url("https://127.0.0.1/keys").is_err());
|
||||
assert!(validate_keyserver_url("http://169.254.169.254/latest/meta-data/").is_err());
|
||||
assert!(validate_keyserver_url("http://[::1]:9000/keys").is_err());
|
||||
assert!(validate_keyserver_url("https://0.0.0.0/keys").is_err());
|
||||
assert!(validate_keyserver_url("ftp://example.com/keys").is_err());
|
||||
assert!(validate_keyserver_url("").is_err());
|
||||
}
|
||||
@@ -368,9 +368,7 @@ fn multi_source_real_keydb_resolves_through_chain() {
|
||||
);
|
||||
}
|
||||
|
||||
// ── MultiSource: a source that could not ANSWER is not a source that said no ─
|
||||
// See docs/multi-source-failure-collapse.md — the Ok/Err collapse incident
|
||||
// this section's tests exist to catch.
|
||||
// ── MultiSource: a source that could not ANSWER is not a source that said no ─.
|
||||
|
||||
/// A source that always fails, with a chosen error — the key-service outage.
|
||||
struct FailingSource {
|
||||
@@ -398,8 +396,6 @@ fn unauthorized() -> libfreemkv::Error {
|
||||
libfreemkv::Error::KeyServiceUnauthorized
|
||||
}
|
||||
|
||||
// See docs/multi-source-failure-collapse.md — must report FAILURE, not a
|
||||
// clean "no key", when no source holds a key and one could not answer.
|
||||
#[test]
|
||||
fn multi_source_reports_a_source_failure_instead_of_a_clean_no_key() {
|
||||
let multi = MultiSource::new(vec![
|
||||
|
||||
Reference in New Issue
Block a user