-
Notifications
You must be signed in to change notification settings - Fork 509
Enforce gh-aw v0.85.3 security compatibility floor #55796
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 9 commits
9ba74a6
313ee1e
b435280
b3644de
e5e0922
1033341
0434cba
d2bdb92
84c209e
3ec639e
3b02852
b2d52b0
a6e0791
778f022
2e2ca34
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,30 @@ | ||
| { | ||
| "$schema": "./compat.schema.json", | ||
| "blockedVersions": [], | ||
| "blockedVersions": [ | ||
| "v0.82.8", | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Consider bumping "minRecommendedVersion": "v0.85.4",@copilot please address this.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Bumped |
||
| "v0.82.9", | ||
| "v0.82.10", | ||
| "v0.82.11", | ||
| "v0.82.12", | ||
| "v0.82.13", | ||
| "v0.82.14", | ||
| "v0.82.15", | ||
| "v0.83.0", | ||
| "v0.83.1", | ||
| "v0.83.2", | ||
| "v0.83.3", | ||
| "v0.83.4", | ||
| "v0.83.5", | ||
| "v0.84.0", | ||
| "v0.84.1", | ||
| "v0.84.2", | ||
| "v0.84.3", | ||
| "v0.84.4", | ||
| "v0.85.0", | ||
| "v0.85.1", | ||
| "v0.85.2", | ||
| "v0.85.3" | ||
| ], | ||
| "minimumVersion": "v0.65.3", | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [/diagnosing-bugs] The PR description states " 💡 What to doEither:
The new @copilot please address this.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The maintainer confirmed range-blocking is the intended policy (see follow-up comments):
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [/diagnosing-bugs] 💡 Suggested fixThe first safe, unaffected release is If relying solely on @copilot please address this.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No conflict — |
||
| "minRecommendedVersion": "v0.65.3", | ||
| "agent-compat-v1": { | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Blocked gh-aw versions | ||
|
|
||
| The following releases are blocked by `.github/aw/compat.json` and fail during | ||
| workflow activation. | ||
|
|
||
| | Versions | Reason | | ||
| | --- | --- | | ||
| | `v0.82.8` through `v0.85.3` | Affected by [GHSA-8h78-hpm7-29gg](https://github.com/github/gh-aw/security/advisories/GHSA-8h78-hpm7-29gg). `v0.85.4` is the first unaffected release. | | ||
|
|
||
| ## Remediation | ||
|
|
||
| Upgrade to [`v0.85.4`](https://github.com/github/gh-aw/releases/tag/v0.85.4) or | ||
| later, verify the installed version, then regenerate and review the repository's | ||
| compiled workflows: | ||
|
|
||
| ```bash | ||
| gh extension upgrade gh-aw | ||
| gh aw version | ||
| gh aw upgrade | ||
| git diff -- .github/workflows | ||
| ``` | ||
|
|
||
| Confirm that `gh aw version` reports `v0.85.4` or later and commit the regenerated | ||
| `.lock.yml` files. Blocking the affected compiler versions prevents their | ||
| workflows from activating but does not regenerate existing workflow artifacts. | ||
| See [Upgrading Agentic Workflows](https://github.com/github/gh-aw/blob/main/docs/src/content/docs/guides/upgrading.md) | ||
|
Copilot marked this conversation as resolved.
Outdated
|
||
| for the supported upgrade process. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| --- | ||
|
pelikhan marked this conversation as resolved.
|
||
| name: security-advisory-compat-enforcer | ||
| description: Review a GitHub security advisory and safely update .github/aw/compat.json with evidence-backed version enforcement. | ||
| --- | ||
|
|
||
| # Security Advisory Compatibility Enforcer | ||
|
|
||
| Use this skill to translate a GitHub repository security advisory into the | ||
| smallest safe update to `.github/aw/compat.json`. | ||
|
|
||
| ## Required inputs | ||
|
|
||
| Record the repository, GHSA identifier, requested enforcement policy, and any | ||
| patched version supplied by the user. Treat a user-supplied version as a target | ||
| to verify, not as evidence for advisory details. | ||
|
|
||
| ## Evidence retrieval | ||
|
|
||
| 1. Attempt authenticated retrieval first: | ||
| `gh api repos/OWNER/REPO/security-advisories/GHSA-ID`. | ||
| 2. If authentication is unavailable or access fails, try the public global | ||
| advisory endpoint: `gh api advisories/GHSA-ID` (or its equivalent REST URL). | ||
| 3. Record the endpoint and outcome of each attempt. If both sources are | ||
| inaccessible, state that explicitly. Never infer or invent the affected | ||
| package, vulnerable range, severity, CVE, publication state, or patched | ||
| version. | ||
| 4. Verify the proposed patched version independently. Prefer a published | ||
| repository release or tag, then package-registry metadata when applicable. | ||
| Cite the exact URL or command result. Do not update compatibility policy if | ||
| the target cannot be verified, unless the user explicitly directs use of a | ||
| supplied target despite inaccessible advisory metadata; document that | ||
| limitation without converting it into fabricated advisory evidence. | ||
|
|
||
| ## Choose the correct policy field | ||
|
|
||
| - `minimumVersion` is a hard floor: activation fails for every compiler version | ||
| below it. Change it only when the requested remediation is a universal | ||
| minimum-version enforcement. | ||
| - `blockedVersions` rejects listed versions exactly. Change it only when | ||
| evidence or explicit instructions identify exact versions to deny and a | ||
| continuous minimum floor would be inaccurate. | ||
| - `minRecommendedVersion` only warns below the value. Change it only for an | ||
| explicitly requested recommendation, never as a substitute for enforcement. | ||
| - Agent rows under `agent-compat-v1` select compatible agent versions; they are | ||
| unrelated to compiler security enforcement unless separate evidence requires | ||
| an agent compatibility change. | ||
|
|
||
| ## Write remediation guidance | ||
|
|
||
| Provide concise, actionable remediation in `.github/aw/compat.md` and the final | ||
| report. Follow established security-advisory terminology: | ||
|
|
||
| 1. Identify the affected product or component, GHSA identifier, CVE identifier | ||
| when assigned, affected versions, and first fixed or unaffected version. | ||
| Use exact bounded ranges and do not broaden the advisory's claims. | ||
| 2. State the permanent remediation in imperative language. Give exact, | ||
| copyable upgrade and regeneration commands verified against official | ||
| documentation. For compiler advisories, explain whether existing generated | ||
| workflows must be recompiled and redeployed; blocking a vulnerable version | ||
| prevents execution but does not repair generated artifacts. | ||
| 3. Separate remediation from mitigations and workarounds. Include a temporary | ||
| measure only when the advisory documents it. If the retrieved advisory does | ||
| not identify one, say so without claiming that no workaround exists. | ||
| 4. Include a verification step that checks the installed version and any | ||
| regenerated artifacts. Do not treat a successful install alone as proof that | ||
| deployed workflows were remediated. | ||
| 5. Link the advisory, fixed release, and authoritative upgrade documentation. | ||
| Mention severity, CVSS, known exploitation, CISA KEV status, deadlines, or | ||
| urgency only when verified from authoritative evidence. | ||
|
|
||
| Do not invent commands, CVE identifiers, affected configurations, mitigations, | ||
| or timelines. If remediation details cannot be verified, identify the missing | ||
| evidence and leave the instructions explicitly incomplete. | ||
|
|
||
| ## Safe edit procedure | ||
|
|
||
| 1. Parse the current JSON and record all four policy areas above. | ||
| 2. Compare semantic versions numerically. A minimum is monotonic: never lower a | ||
| non-empty `minimumVersion` or `minRecommendedVersion`. Stop and report a | ||
| requested downgrade rather than applying it. | ||
| 3. Make the narrowest evidence-backed edit. Preserve `blockedVersions`, | ||
| `minRecommendedVersion`, every `agent-compat-v1` row, key ordering, and | ||
| formatting unless the selected policy specifically requires changing them. | ||
| 4. When changing `blockedVersions`, update `.github/aw/compat.md` in the same | ||
| change. Account for every blocked version, state why each version or | ||
| contiguous range is blocked, link to the corresponding advisory, and provide | ||
| the remediation and verification steps defined above. | ||
| 5. Review the final diff and reject unrelated changes. | ||
|
|
||
| ## Required validation | ||
|
|
||
| Before reporting completion: | ||
|
|
||
| 1. Run the repository's `Validate compat.json structure and version formats` | ||
| task from `.github/workflows/cgo.yml`. | ||
| 2. Validate `.github/aw/compat.json` against | ||
| `.github/aw/compat.schema.json` with a JSON Schema Draft 7 validator. JSON | ||
| parsing or ad hoc field checks are not substitutes for schema validation. | ||
| 3. Confirm `.github/aw/compat.md` accounts for every `blockedVersions` entry | ||
| and that each documented range links to its advisory. | ||
| 4. Exercise the runtime policy semantics with versions immediately below, at, | ||
| and above the changed boundary; confirm only the intended hard-fail, warning, | ||
| or exact-block behavior changed. | ||
| 5. Confirm semantic-version monotonicity and byte-for-byte preservation of | ||
| unrelated policy fields and agent rows. | ||
|
|
||
| Do not claim validation that was not run. If repository constraints prohibit a | ||
| required check, report it as outstanding. | ||
|
|
||
| ## Report | ||
|
|
||
| Cite advisory retrieval attempts and patched-version verification. State which | ||
| field changed, old and new values, why that policy is correct, which fields were | ||
| preserved, and the compatibility task, schema, documentation, and runtime | ||
| validation results. Include the remediation, any advisory-supported temporary | ||
| mitigation, and verification steps. Clearly separate verified facts, | ||
| user-provided inputs, and unavailable advisory details. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| //go:build !integration | ||
|
|
||
| package linters_test | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "os" | ||
| "testing" | ||
|
|
||
| "github.com/github/gh-aw/pkg/parser" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestCompatJSONConformsToSchema(t *testing.T) { | ||
| schemaJSON, err := os.ReadFile("../../.github/aw/compat.schema.json") | ||
| require.NoError(t, err) | ||
|
|
||
| schema, err := parser.CompileSchema(string(schemaJSON), "https://github.com/github/gh-aw/.github/aw/compat.schema.json") | ||
| require.NoError(t, err) | ||
|
|
||
| configJSON, err := os.ReadFile("../../.github/aw/compat.json") | ||
| require.NoError(t, err) | ||
|
|
||
| var config any | ||
| require.NoError(t, json.Unmarshal(configJSON, &config)) | ||
| require.NoError(t, schema.Validate(config)) | ||
| } | ||
|
pelikhan marked this conversation as resolved.
|
||
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.
Agreed, the PR description was inaccurate. The implemented policy is:
blockedVersionsenumerates the exact affected rangev0.82.8–v0.85.3(per GHSA-8h78-hpm7-29gg),minimumVersionstays atv0.65.3, andminRecommendedVersionis nowv0.85.4for the upgrade nudge. I'll update the PR title/description to reflect this.