Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 119 additions & 0 deletions .github/scripts/test_desktop_pgp_handoff.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
import copy
import hashlib
import importlib.util
import json
from pathlib import Path
import unittest

spec = importlib.util.spec_from_file_location("guard", Path(__file__).with_name("validate_desktop_pgp_handoff.py"))
guard = importlib.util.module_from_spec(spec)
spec.loader.exec_module(guard)


class GuardTests(unittest.TestCase):
def setUp(self):
self.sha = "a" * 40
self.digest = "b" * 64
self.manifest = {"release_id": 123, "tag": "keeper-desktop-v0.2.6", "source_sha": self.sha,
"build_run_id": 456, "assets": [{"id": 789, "name": "Keeper.Desktop_0.2.6_aarch64.dmg", "size": 42, "sha256": self.digest}]}
self.release = {"id": 123, "tag_name": "keeper-desktop-v0.2.6", "target_commitish": self.sha, "draft": True, "prerelease": False,
"assets": [{"id": 789, "name": "Keeper.Desktop_0.2.6_aarch64.dmg", "size": 42, "state": "uploaded", "digest": "sha256:" + self.digest}]}
self.run = {"id": 456, "head_sha": self.sha, "repository": {"id": 846051536, "full_name": guard.REPOSITORY},
"path": ".github/workflows/release.yml", "event": "push", "head_branch": "release", "status": "completed", "conclusion": "success"}
self.jobs = {"total_count": 2, "jobs": [{"name": "build-qa", "status": "completed", "conclusion": "skipped"},
{"name": "publish-tauri (macos-latest)", "status": "completed", "conclusion": "success"}]}

def invoke(self, manifest=None, release=None, run=None, jobs=None, digest=None):
raw = json.dumps(self.manifest if manifest is None else manifest)
return guard.validate(raw, hashlib.sha256(raw.encode()).hexdigest() if digest is None else digest,
self.release if release is None else release, self.run if run is None else run,
self.jobs if jobs is None else jobs)

def test_explicit_production_handoff_is_only_preflight(self):
result = self.invoke()
self.assertEqual(result["state"], "PREFLIGHT_ONLY")
self.assertEqual([result[x] for x in ("signing", "upload", "publication")], ["NOT RUN"] * 3)

def test_qa_run_even_on_release_branch_is_refused(self):
self.jobs["jobs"][0]["conclusion"] = "success"
self.jobs["jobs"][1]["conclusion"] = "skipped"
with self.assertRaisesRegex(ValueError, "QA runs"):
self.invoke()

def test_dev_and_qa_tags_are_refused(self):
for suffix in ("-qa.1", "-dev"):
with self.subTest(suffix=suffix):
value = copy.deepcopy(self.manifest)
value["tag"] += suffix
with self.assertRaisesRegex(ValueError, "Production Desktop tag"):
self.invoke(manifest=value)

def test_manifest_byte_tampering_is_refused(self):
with self.assertRaisesRegex(ValueError, "manifest bytes"):
self.invoke(digest="0" * 64)

def test_wrong_release_or_tag_or_source_is_refused(self):
for key, value in (("id", 124), ("tag_name", "keeper-desktop-v0.2.5"), ("target_commitish", "release")):
with self.subTest(key=key):
release = copy.deepcopy(self.release)
release[key] = value
with self.assertRaises(ValueError):
self.invoke(release=release)

def test_published_or_prerelease_is_refused(self):
for key, value in (("draft", False), ("prerelease", True)):
release = copy.deepcopy(self.release)
release[key] = value
with self.assertRaisesRegex(ValueError, "production draft"):
self.invoke(release=release)

def test_untrusted_wrong_source_or_failed_build_is_refused(self):
for key, value in (("head_sha", "c"*40), ("path", ".github/workflows/dev-release.yml"), ("head_branch", "main"),
("event", "pull_request"), ("conclusion", "failure")):
with self.subTest(key=key):
run = copy.deepcopy(self.run)
run[key] = value
with self.assertRaises(ValueError):
self.invoke(run=run)
self.run["repository"]["id"] = 1
with self.assertRaisesRegex(ValueError, "repository"):
self.invoke()

def test_failed_skipped_or_missing_production_packaging_is_refused(self):
for result in ("failure", "skipped", None):
jobs = copy.deepcopy(self.jobs)
jobs["jobs"][1]["conclusion"] = result
with self.assertRaisesRegex(ValueError, "production packaging"):
self.invoke(jobs=jobs)

def test_incomplete_job_page_is_refused(self):
self.jobs["total_count"] = 101
with self.assertRaisesRegex(ValueError, "Incomplete job"):
self.invoke()

def test_extra_missing_and_duplicate_assets_are_refused(self):
for assets in ([], self.release["assets"] * 2):
release = copy.deepcopy(self.release)
release["assets"] = assets
with self.assertRaises(ValueError):
self.invoke(release=release)

def test_asset_id_name_size_digest_and_upload_state_are_bound(self):
for key, value in (("id", 790), ("name", "Other.dmg"), ("size", 43), ("digest", None), ("state", "new")):
with self.subTest(key=key):
release = copy.deepcopy(self.release)
release["assets"][0][key] = value
with self.assertRaises(ValueError):
self.invoke(release=release)

def test_existing_outputs_and_path_names_are_refused(self):
for name in ("SHA256SUMS.txt", "SHA256SUMS.txt.asc", "../payload", "-option"):
manifest = copy.deepcopy(self.manifest)
manifest["assets"][0]["name"] = name
with self.assertRaises(ValueError):
self.invoke(manifest=manifest)


if __name__ == "__main__":
unittest.main()

94 changes: 94 additions & 0 deletions .github/scripts/validate_desktop_pgp_handoff.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
"""Read-only validation for an explicitly approved Desktop PGP handoff.

This does not download, sign, upload, publish, or infer human approval.
"""
import argparse
import hashlib
import json
import re
from pathlib import Path

REPOSITORY = "KeeperCommunity/keeper-desktop"
REPOSITORY_ID = 846051536


def require(condition, message):
if not condition:
raise ValueError(message)


def validate(raw_manifest, manifest_digest, release, run, jobs):
require(re.fullmatch(r"[0-9a-f]{64}", manifest_digest or ""), "Expected manifest SHA-256 required")
require(hashlib.sha256(raw_manifest.encode("utf-8")).hexdigest() == manifest_digest, "Approved manifest bytes differ")
manifest = json.loads(raw_manifest)
require(set(manifest) == {"release_id", "tag", "source_sha", "build_run_id", "assets"}, "Unexpected manifest fields")
sha = manifest["source_sha"]
tag = manifest["tag"]
require(re.fullmatch(r"[0-9a-f]{40}", sha or ""), "Full approved source SHA required")
require(re.fullmatch(r"keeper-desktop-v[0-9]+\.[0-9]+\.[0-9]+", tag or ""), "Production Desktop tag required; QA/dev tags refused")
require(type(manifest["release_id"]) is int and manifest["release_id"] > 0, "Explicit release ID required")
require(type(manifest["build_run_id"]) is int and manifest["build_run_id"] > 0, "Explicit build run ID required")
require(release.get("id") == manifest["release_id"], "Release ID mismatch")
require(release.get("tag_name") == tag, "Release tag mismatch")
require(release.get("target_commitish") == sha, "Draft target must be the exact approved source SHA")
require(release.get("draft") is True and release.get("prerelease") is False, "Only a production draft is eligible")
require(run.get("id") == manifest["build_run_id"] and run.get("head_sha") == sha, "Build source/run mismatch")
require(run.get("repository", {}).get("id") == REPOSITORY_ID and
run.get("repository", {}).get("full_name") == REPOSITORY, "Wrong build repository")
require(run.get("path") == ".github/workflows/release.yml", "Wrong build workflow")
require(run.get("event") in {"push", "workflow_dispatch"} and run.get("head_branch") == "release", "Unapproved build route")
require(run.get("status") == "completed" and run.get("conclusion") == "success", "Production build not successful")
job_list = jobs.get("jobs", [])
require(jobs.get("total_count") == len(job_list), "Incomplete job metadata")
require(not any(j.get("name") == "build-qa" and j.get("conclusion") != "skipped" for j in job_list), "QA runs cannot sign releases")
production_jobs = [j for j in job_list if j.get("name", "").startswith("publish-tauri")]
require(production_jobs and all(j.get("status") == "completed" and j.get("conclusion") == "success" for j in production_jobs), "Every production packaging job must succeed")
expected = manifest["assets"]
actual = release.get("assets", [])
require(isinstance(expected, list) and bool(expected), "Complete nonempty approved asset manifest required")
require(len(expected) == len(actual), "Missing or extra release assets")
require(len({a.get("id") for a in expected}) == len(expected) and
len({a.get("name") for a in expected}) == len(expected), "Duplicate asset IDs/names")
require(len({a.get("id") for a in actual}) == len(actual) and
len({a.get("name") for a in actual}) == len(actual), "Duplicate remote asset IDs/names")
actual_by_id = {a.get("id"): a for a in actual}
for asset in expected:
require(set(asset) == {"id", "name", "size", "sha256"}, "Unexpected asset fields")
name = asset["name"]
require(isinstance(name, str) and re.fullmatch(r"[A-Za-z0-9][A-Za-z0-9_.+ -]*", name), "Unsafe asset filename")
require(name not in {"SHA256SUMS.txt", "SHA256SUMS.txt.asc"}, "Existing checksum/signature output refused; no clobber")
require(type(asset["id"]) is int and asset["id"] > 0 and type(asset["size"]) is int and asset["size"] > 0, "Invalid asset ID/size")
require(re.fullmatch(r"[0-9a-f]{64}", asset["sha256"] or ""), "Approved asset SHA-256 required")
remote = actual_by_id.get(asset["id"], {})
require(remote.get("name") == name and remote.get("size") == asset["size"] and remote.get("state") == "uploaded", "Asset identity mismatch")
require(remote.get("digest") == "sha256:" + asset["sha256"], "Remote asset digest absent or mismatched")
return {
"state": "PREFLIGHT_ONLY",
"release_id": manifest["release_id"], "tag": tag, "source_sha": sha,
"build_run_id": manifest["build_run_id"], "approved_manifest_sha256": manifest_digest,
"assets": expected,
"signing": "NOT RUN", "upload": "NOT RUN", "publication": "NOT RUN",
"next_gate": "Independent review and specific signing/upload authorization; re-read release/run/assets and verify downloaded bytes before signing."
}


def main():
parser = argparse.ArgumentParser()
parser.add_argument("--manifest", required=True)
parser.add_argument("--manifest-sha256", required=True)
parser.add_argument("--release", required=True)
parser.add_argument("--run", required=True)
parser.add_argument("--jobs", required=True)
parser.add_argument("--output", required=True)
args = parser.parse_args()
result = validate(Path(args.manifest).read_text(), args.manifest_sha256,
json.loads(Path(args.release).read_text()),
json.loads(Path(args.run).read_text()),
json.loads(Path(args.jobs).read_text()))
Path(args.output).write_text(json.dumps(result, indent=2) + "\n")
print("Read-only Desktop handoff preflight PASS; signing/upload/publication NOT RUN")


if __name__ == "__main__":
main()

2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ jobs:
libudev-dev
- name: Install Rust 1.85.1
uses: dtolnay/rust-toolchain@1.85.1
with:
components: rustfmt, clippy
- name: Run ESLint
run: npm run lint
- name: Check Prettier formatting
Expand Down
104 changes: 51 additions & 53 deletions .github/workflows/pgp-sign-release.yml
Original file line number Diff line number Diff line change
@@ -1,64 +1,62 @@
name: PGP sign release
name: PGP release handoff preflight

# Automatic workflow_run signing is intentionally removed. In particular,
# successful QA builds must never select or mutate an unrelated draft release.
on:
workflow_run:
workflows: ["release", "dev-release"]
types:
- completed
workflow_dispatch:
inputs:
approved_manifest_json:
description: Exact reviewed JSON (release_id, tag, source_sha, build_run_id, complete assets with IDs/names/sizes/SHA-256)
required: true
type: string
approved_manifest_sha256:
description: SHA-256 of those exact UTF-8 JSON bytes (no added newline)
required: true
type: string

permissions:
contents: read
actions: read

concurrency:
group: desktop-pgp-handoff-preflight
cancel-in-progress: false

jobs:
sign-release:
preflight:
runs-on: ubuntu-latest
if: ${{ github.event.workflow_run.conclusion == 'success' }}
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Install GPG
run: sudo apt-get install -y gnupg

- name: Import GPG key
- name: Checkout workflow implementation only
uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
with:
ref: ${{ github.workflow_sha }}
persist-credentials: false
- name: Validate handoff guard contracts
run: python3 -m unittest discover -s .github/scripts -p 'test_desktop_pgp_handoff.py'
- name: Read exact approved release and build metadata
env:
PGP_PRIVATE_KEY: ${{ secrets.PGP_PRIVATE_KEY }}
PGP_PASSWORD: ${{ secrets.PGP_PASSWORD }}
GH_TOKEN: ${{ github.token }}
APPROVED_MANIFEST: ${{ inputs.approved_manifest_json }}
run: |
echo "$PGP_PRIVATE_KEY" | gpg --batch --yes --import
echo "$PGP_PASSWORD" | gpg --batch --yes --passphrase-fd 0 --pinentry-mode loopback --change-passphrase $(gpg --list-secret-keys --with-colons | awk -F: '/^sec:/ { print $5 }')

- name: Create and Sign SHA256SUMS
set -euo pipefail
umask 077
printf '%s' "$APPROVED_MANIFEST" > "$RUNNER_TEMP/desktop-approved-manifest.json"
release_id=$(jq -er '.release_id | select(type == "number" and . > 0 and . == floor)' "$RUNNER_TEMP/desktop-approved-manifest.json")
build_run_id=$(jq -er '.build_run_id | select(type == "number" and . > 0 and . == floor)' "$RUNNER_TEMP/desktop-approved-manifest.json")
gh api "repos/KeeperCommunity/keeper-desktop/releases/$release_id" > "$RUNNER_TEMP/desktop-release.json"
gh api "repos/KeeperCommunity/keeper-desktop/actions/runs/$build_run_id" > "$RUNNER_TEMP/desktop-build-run.json"
gh api "repos/KeeperCommunity/keeper-desktop/actions/runs/$build_run_id/jobs?per_page=100" > "$RUNNER_TEMP/desktop-build-jobs.json"
- name: Validate explicit production handoff
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PGP_PASSWORD: ${{ secrets.PGP_PASSWORD }}
APPROVED_MANIFEST_SHA256: ${{ inputs.approved_manifest_sha256 }}
run: |
version=$(grep '^version =' src-tauri/Cargo.toml | cut -d '"' -f2)
echo "Version: $version"

releases=$(gh release list --limit 20 --json tagName,name,isDraft,isPrerelease)
releaseInfo=$(echo "$releases" | jq -r '.[] | select(.isDraft == true and (.tagName | contains("'"$version"'"))) | .tagName' | head -n1)

if [ -z "$releaseInfo" ]; then
echo "Error: Could not find a draft release for version $version"
exit 1
fi

tagName="$releaseInfo"
echo "Found draft release: $tagName"

# Create a temporary directory for downloaded assets
mkdir -p tmp_assets
cd tmp_assets

# Download all assets
gh release download "$tagName" --pattern "*"

# Create SHA256SUMS.txt
sha256sum * > SHA256SUMS.txt

# Sign SHA256SUMS.txt
gpg --batch --yes --passphrase "$PGP_PASSWORD" --pinentry-mode loopback --detach-sig --armor SHA256SUMS.txt

# Upload SHA256SUMS.txt and SHA256SUMS.txt.asc
gh release upload "$tagName" SHA256SUMS.txt SHA256SUMS.txt.asc --clobber
python3 .github/scripts/validate_desktop_pgp_handoff.py \
--manifest "$RUNNER_TEMP/desktop-approved-manifest.json" \
--manifest-sha256 "$APPROVED_MANIFEST_SHA256" \
--release "$RUNNER_TEMP/desktop-release.json" \
--run "$RUNNER_TEMP/desktop-build-run.json" \
--jobs "$RUNNER_TEMP/desktop-build-jobs.json" \
--output "$RUNNER_TEMP/desktop-pgp-handoff-plan.json"
echo 'Read-only preflight passed. Signing, upload and publication remain NOT RUN.' >> "$GITHUB_STEP_SUMMARY"
# No signing secrets, private-key import, release upload or publication here.

cd ..
rm -rf tmp_assets
Loading