Repository navigation
Use caller-scoped job token for release assets #167
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| #!/usr/bin/env python3 | ||
| """Check least-privilege token wiring without release credentials or network.""" | ||
| import copy | ||
| import json | ||
| from pathlib import Path | ||
| import subprocess | ||
| import unittest | ||
|
|
||
| ROOT = Path(__file__).resolve().parent.parent | ||
|
|
||
|
|
||
| def load_yaml(path): | ||
| return json.loads(subprocess.check_output(["yq", ".", str(ROOT / path)], text=True)) | ||
|
|
||
|
|
||
| def token_errors(workflow): | ||
| errors = [] | ||
| if workflow["permissions"] != {}: | ||
| errors.append("workflow-wide permissions must remain empty") | ||
| residuals = [] | ||
| for name, job in workflow["jobs"].items(): | ||
| expected = "write" if name == "goreleaser-binaries" else "read" | ||
| if job["permissions"].get("contents") != expected: | ||
| errors.append(f"{name}: unexpected contents permission") | ||
| for step in job.get("steps", []): | ||
| if "secrets.RELENG_GITHUB_TOKEN" in json.dumps(step): | ||
| residuals.append((name, step["name"])) | ||
| if step.get("run", "").startswith("goreleaser release "): | ||
| if step.get("env", {}).get("GITHUB_TOKEN") != "${{ github.token }}": | ||
| errors.append(f"{name}: GoReleaser must use the job token") | ||
| if "gh api" in step.get("run", ""): | ||
| if step.get("env", {}).get("GH_TOKEN") != "${{ github.token }}": | ||
| errors.append(f"{name}: metadata reads must use the job token") | ||
| if residuals != [("goreleaser-binaries", "Publish Homebrew formula")]: | ||
| errors.append("only the deferred Homebrew tap step may consume the legacy token") | ||
| return errors | ||
|
|
||
|
|
||
| class ReleaseTokenTest(unittest.TestCase): | ||
| def setUp(self): | ||
| self.workflow = load_yaml(".github/workflows/release.yaml") | ||
|
|
||
| def test_release_job_permissions_and_tokens(self): | ||
| self.assertEqual(token_errors(self.workflow), []) | ||
| release_steps = [step for job in self.workflow["jobs"].values() for step in job.get("steps", []) | ||
| if step.get("run", "").startswith("goreleaser release ")] | ||
| self.assertEqual(len(release_steps), 4) | ||
| tap = next(step for step in self.workflow["jobs"]["goreleaser-binaries"]["steps"] | ||
| if step["name"] == "Publish Homebrew formula") | ||
| self.assertEqual(tap["if"], "inputs.brew == true") | ||
| self.assertEqual(tap["env"]["GITHUB_TOKEN"], "${{ secrets.RELENG_GITHUB_TOKEN }}") | ||
|
|
||
| def test_only_binaries_publish_github_release(self): | ||
| binaries = load_yaml("templates/.goreleaser-binaries-template.yaml.tmpl") | ||
| self.assertNotEqual(binaries["release"].get("disable"), True) | ||
| self.assertEqual(binaries["brews"][0]["skip_upload"], "true") | ||
| for template in ("windows", "docker-oci", "docker-lambda"): | ||
| config = load_yaml(f"templates/.goreleaser-{template}-template.yaml.tmpl") | ||
| self.assertTrue(config["release"]["disable"]) | ||
|
|
||
| def test_read_only_publisher_negative_control(self): | ||
| changed = copy.deepcopy(self.workflow) | ||
| changed["jobs"]["goreleaser-binaries"]["permissions"]["contents"] = "read" | ||
| self.assertIn("goreleaser-binaries: unexpected contents permission", token_errors(changed)) | ||
|
|
||
| def test_no_broader_grants_negative_controls(self): | ||
| for name in self.workflow["jobs"]: | ||
| if name == "goreleaser-binaries": | ||
| continue | ||
| changed = copy.deepcopy(self.workflow) | ||
| changed["jobs"][name]["permissions"]["contents"] = "write" | ||
| self.assertTrue(token_errors(changed), name) | ||
| changed = copy.deepcopy(self.workflow) | ||
| changed["permissions"] = {"contents": "write"} | ||
| self.assertTrue(token_errors(changed)) | ||
|
|
||
| def test_legacy_release_token_negative_control(self): | ||
| for name, job in self.workflow["jobs"].items(): | ||
| for index, step in enumerate(job.get("steps", [])): | ||
| if not step.get("run", "").startswith("goreleaser release "): | ||
| continue | ||
| changed = copy.deepcopy(self.workflow) | ||
| changed["jobs"][name]["steps"][index]["env"]["GITHUB_TOKEN"] = "${{ secrets.RELENG_GITHUB_TOKEN }}" | ||
| self.assertTrue(token_errors(changed), name) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| unittest.main() |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟡 Suggestion (medium confidence): If a caller grants only
contents: read, for example through a read-only org default, GitHub rejects the whole called workflow at startup. The error is "nested job is requesting 'contents: write'", so this is not limited to the binaries job, and it affects every caller that tracks this ref as soon as it merges. The PR body covers this, but the guard is only prose. Consider merging only after the caller-template PR lands, or tagging this as a breaking release so callers that pin a ref opt in.