feat: mint access tokens with the negotiated scope - #28237
Conversation
Add ScopesCover, which reports whether every permission a requested scope grants is also granted by at least one of a set of allowed scopes. It expands both sides and compares the resulting permissions, so coder:workspaces.access covers workspace:read even though it never names it, and coder:all covers everything. The comparison is deliberately asymmetric. Positive permissions on the allowed side that it does not model are dropped, which can only make the answer stricter. Anything unmodelled on the requested side is an error instead, because ignoring it would answer "covered" about authority that was never compared. Negative permissions are the exception and fail closed on both sides, since dropping an anti-grant from the ceiling would widen it rather than narrow it. Add CanonicalScopeName, which maps the backward-compatibility aliases IsExternalScope accepts onto the names the api_key_scope enum stores. IsExternalScope answers whether a name may be requested, not how that name is spelled once persisted, so a caller that stores what it validated has to canonicalize in between. Both functions are added without production callers. The OAuth2 authorize endpoint uses them to negotiate a requested scope against an app's configured allowlist, which follows in a separate change.
State the rule the guards enforce, site-level grants only, instead of describing the asymmetry abstractly. The allow-list case is now covered alongside negative permissions, which the previous wording omitted even though the code treats them identically. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Docs previewCheck off each page once it's been reviewed. If a page changes in a later push, its checkbox clears automatically so it gets a fresh look. Pages not yet wired into the docs navigation aren't listed here. |
|
/coder-agents-review |
|
Chat: Review posted | View chat Review history
deep-review v0.9.0 | Round 1 | Last posted: Round 1, 14 findings (1 P2, 1 P3, 5 Nit, 7 Note), COMMENT. Review Finding inventoryFindings
Contested and acknowledgedNone yet. Round logRound 1Panel. Netero clean at first pass (Nit on PR title only). 16 trigger-matched reviewers + Luffy and Knuckle as wildcards. 1 P2, 1 P3, 6 Nit, 7 Note new. No dropped findings. Reviewed against 0b7827e..3e18461. About deep-reviewCRF = Coder Review Finding (P0-P4, Nit, Note)
|
There was a problem hiding this comment.
This PR closes a real gap: the scope negotiated at /oauth2/authorize is finally what the minted api_keys.scopes carries, and refresh no longer widens a narrow token to coder:all on hour two. The tests assert against the api_keys row rather than the token response, and IssuedTokenBoundsTheAPI drives the issued token through dbauthz against a real API call, which is where the assertion actually earns its keep. Removing the two TODO: We are ignoring scopes for now. comments together with the fix that makes them true is the shape of the change I want to see.
One fun observation from Luffy: "A client asked for workspace:ssh, walked out with coder:all, and the consent page had already told the user 'you're granting workspace:ssh.' That is worse than having no scope system at all: users saw a narrow grant, clients believed they had a narrow grant, dbauthz saw an unrestricted one."
Severity: 1 P2, 1 P3, 6 Nit, 7 Note. No P0/P1 on the code itself; the review is a COMMENT rather than REQUEST_CHANGES. The most consequential finding is that the OAuth2 token response omits the scope field even though the granted scope now routinely differs from the request. Fixing it is a one-line addition on the same struct literals that already write dbCode.Scope / dbToken.Scope to the DB. Details inline.
Process observations, kept in the body so they do not clutter the diff:
- PR title scope —
feat(coderd/oauth2provider): ...does not contain every changed file.coderd/database/modelmethods.goanddocs/admin/integrations/oauth2-provider.mdare outsidecoderd/oauth2provider/. This is exactly the rule.github/workflows/contrib.yaml(lines 191-220) enforces mechanically, and thetitleCI job is currently failing on it (run 95582966188). Drop the scope (feat: mint access tokens with the negotiated scope) or split;coderdalone still excludesdocs/. Same defect on commit3e1846174f test(coderd/oauth2provider): cover the negotiated scope end to end, which also modifies the docs page and rewrites thescopeStringToAPIKeyScopesdocstring ("cover the negotiated scope end to end" is not what those lines do). Split or squash into the parentfeatcommit; the type has to name what is inside. - PR body placeholder —
Depends on #<plat479-3 PR>shipped unfilled. A reviewer cannot tell whether the depended-on PR exists, is merged, or is the reason the change is safe to merge without asking, and the base branch is stacked onplat479-*andplat478-*so the actual dependency is knowable. Wire in the number or drop the line before merge; it will otherwise render as literal text in the merged commit body.
On the code itself, the analysis by the panel converges on the same story: the scope now really binds the token, but the client-facing signal that it binds anything (the scope field in the token response) still is not there. That is what makes CRF-1 the load-bearing finding for a follow-up, and CRF-2 the smaller sibling that goes with it.
🤖 This review was automatically generated with Coder Agents.
|
Replies to the two process items in the review body. PR title CI. Stale. The cited On the commit you flagged: PR body placeholder. Fixed. |
ScopesCover checked the requested scope for org and user grants but not the allowed scopes, whose User and ByOrgID permissions were discarded unread. A scope granting workspace:* at site level while negating workspace:delete for the user would have covered a request for workspace:delete, because the negative that carves the action back out lives in the half coverage never examined. No catalog scope populates those fields today, so nothing was miscompared in practice. The gap mattered because these guards exist to keep the comparison fail-closed, and this one failed open. Both sides now run the same checkCoverable helper, which refuses a scope carrying org or user grants, a negative permission, or a resource allow list. The helper names the side, so an error reports which half of the comparison was undecidable. The doc comment claimed an unmodeled grant on the allowed side is dropped; nothing is dropped now, so it is gone. ScopesCover builds every Scope it reads from ExpandScope, which cannot produce these shapes, so the guards are unreachable through the public API. scopes_internal_test.go drives synthetic Scope values through checkCoverable instead. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
permissionCovered skipped negative permissions, but checkCoverable now refuses a scope carrying one on either side, so the branch was dead. It was never defense in depth. Had a negative reached it, skipping the anti-grant would leave any wildcard beside it free to match, and a scope granting workspace:* while negating workspace:delete would report workspace:delete as covered. The skip widened the ceiling while looking like it narrowed it. The precondition moves to the doc comment, which names checkCoverable as what enforces it and says why subsumption cannot answer the question an anti-grant poses. No behavior change: the branch was unreachable. permissionCovered goes from 88.9% to 100% statement coverage.
Five review findings on the coverage tests, all in scopes_test.go. CanonicalScopeName had both alias arms at zero coverage. Its only caller in the tests loops over ExternalScopeNames, which yields canonical names only, so the canonicalizing call returned its input unchanged on every iteration and read as coverage without being any. Swapping the arms, so that `all` persisted application_connect and the reverse, kept the suite green. TestCanonicalScopeName now pins the mapping and the loop appends the aliases, taking the function from 50% to 100%. The appended aliases raise branch coverage and assert a requestable name is comparable once canonicalized, but they cannot detect a swapped mapping, since both aliases resolve to scopes that cover themselves. The comment says so rather than implying the loop guards more than it does. CompositeDoesNotCoverNonMember and CompositeDoesNotCoverWiderActionOnCoveredResource both asked for an ungranted action on a resource coder:workspaces.access does grant, so they tested one branch twice and left "resource not granted at all" untested. They are now split along that line, with names that describe which failure each one is. The three wantErr rows shared a bare require.Error, so any error passed any row and a bug failing every input on the requested side would have left the allowed-side row green. wantErrContains replaces the bool and names the side. Rewording the allowed-side message as the requested-side one now fails three rows that previously all passed. Alias rejection was tested for one alias on one side. Both aliases are now tested on both sides. The allowed-side rows are the ones that earn their place: they are what would catch someone canonicalizing inside the allowed loop and widening the contract without a caller asking.
ScopesCover expanded and compared in a single pass, so the invariant guards only ever ran on scopes ExpandScope had produced. Every such scope satisfies them, which left the guards unverified in the position that matters: the existing test called checkCoverable directly and could not tell whether ScopesCover consulted it on both sides, or at all. Split the comparison into scopesCoverExpanded, which takes already expanded scopes paired with the names they came from. Tests drive synthetic Scope values through it, so dropping the guard from either side now fails, as does an allowed scope that grants every workspace action except delete answering a request for delete. Expanding every allowed scope before any guard runs reorders two error paths against each other: a requested scope that fails a guard alongside an unknown allowed name now reports the expansion failure rather than the guard failure. Both return (false, error), and no ScopeName reaches that combination today.
…ontract The knowledge of which spellings are backward-compatibility aliases lived in two switches, one in IsExternalScope and one in CanonicalScopeName, kept in step by discipline. Drift between them is asymmetric: a name the first accepts and the second does not rewrite is declared public and then fails to expand on every request naming it. Both now read one table, so they agree by construction, and an internal test walks that table asserting each alias is public, resolves to a public name, and resolves to one ExpandScope accepts. A third alias is covered the day it is added. ScopesCover stated "names must be canonical" in prose only, which is wrong for exactly the two inputs IsExternalScope accepts and ExpandScope does not. The parameters are now canonicalAllowed and canonicalRequested, so the requirement shows up in editor hints at every call site rather than only in a doc comment the caller may not have opened. Naming the parameters was chosen over canonicalizing inside ScopesCover. The single downstream caller already canonicalizes both sides in bulk before comparing, so absorbing the step would remove nothing from it while dissolving the distinction between a public spelling and a stored one at the layer that should hold it.
…roken The site-only, wildcard-allow-list, no-negatives invariant was described on ScopesCover and enforced by its guards, but ExpandScope, which is what produces those values, had no doc comment at all. Someone adding a scope reads ExpandScope and its neighbors; nothing there warned that populating User or adding a negative makes the scope uncomparable. State it there, along with the canonicalization requirement, and name the consequence rather than just the rule. Also note on ScopesCover that a wildcard request needs a wildcard grant. Enumerating today's concrete actions genuinely is narrower than `workspace:*`, so the rejection is intended. The OneActionDoesNotCoverResourceWildcard row already pins the behavior; the note stops the next reader of an authorize endpoint from taking it for a bug and closing the gap. Comments only. Checked that the documented invariant actually holds for all three builtin scopes and all seven composites.
0b7827e to
464debf
Compare
416050a to
98868ad
Compare
TestScopesCoverAllowedNegativeDoesNotWiden drove the same scope shape as the NegativeUserPermission row of TestScopesCoverGuards, but asserted only that some error came back. The row asserts the message, the side it names, and that the comparison reports no coverage, and it runs the shape on both sides rather than one. The weaker copy could pass on a regression that returned the wrong error or stopped naming the side. Fold the scenario it documented into the row's comment and drop the copy. Rename the shared permission fixtures after the value they hold. The site prefix read as "belongs in Role.Site", while two of the three are placed in Role.User to build the shapes the guards refuse, and the No suffix gave no hint that it means Negate. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The allowed-side wrap printed the scope name and then wrapped an error that prints it again, so the two sides of one comparison read differently: expand allowed scope "foo": no scope named "foo" expand requested scope: no scope named "foo" Drop the redundant verb and let the inner error carry the name on both sides. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The docstring said the list includes the `all` and `application_connect` special scopes. It appends ScopeAll and ScopeApplicationConnect, which are the `coder:` spellings, so the bare aliases are absent. Two callers already compensate by appending them by hand, one of them with a comment stating the mismatch. Describe what the function returns and name the helper that bridges the gap. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The invariant that expansion populates Site only was stated in full on ExpandScope, checkCoverable and ScopesCover, and the "everything except delete" example appeared on checkCoverable and again on permissionCovered twenty lines below. State it once on ScopesCover, which is the function whose behaviour depends on it, and cross-reference from the other two. Drop framing that ranked implementation choices nobody proposed, and cut the two test comments down to the facts the assertions do not already carry. Kept in full: what each guard in checkCoverable defends, since no other comment says it, and the wildcard rule on ScopesCover. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
checkCoverable said a negative site permission would be skipped, naming a branch permissionCovered no longer has. A negative reaching it matches on resource type and action like any other grant, so the anti-grant would read as a grant. Name that instead, so the cross-reference lands on a doc that matches the code.
The docstring listed the aliases and the low-level scopes, omitting the curated composites the function also accepts. A caller consulting it to decide whether coder:workspaces.access is public read no from the doc and yes from the code.
ExternalScopeNames promises it offers each scope under one canonical spelling, and no test held it to that. TestScopesCoverEveryExternalScope appended the two aliases, but canonicalized them back into names the list already carries, so it re-ran assertions the list iteration had made and left the promise itself unpinned. Assert on the alias table instead: the list omits the alias and offers its canonical target. Every offered name is already proven coverable, so the aliases inherit coverage, and a third alias inherits both invariants the day it is added rather than needing a third hardcoded pair here.
The authorize endpoint parsed the scope parameter and discarded it, so an app's configured allowlist never restricted anything and a client asking for more than it should get was never told no. Phase 1 added the columns that carry a negotiated scope from a code to the token it becomes, but nothing wrote one, so every code was stamped unrestricted. Negotiate the scope at authorization time and persist the result: - Requested names must be in the external scope catalog, and the app's stored allowlist is filtered through that same catalog. Filtering only ever narrows what can be granted. - The allowlist bounds authority, not spelling. A request is granted when every permission it grants is also granted by the allowlist, whether or not the allowlist names it, so an app allowed coder:workspaces.access can approve a client asking only for workspace:ssh. - Omitting scope grants the filtered allowlist, per RFC 6749 section 3.3. - Both handlers negotiate, so a request that cannot succeed fails before the consent page renders rather than after the user clicks Allow. Each reports the failure the way it already reports its own errors: a static error page on the GET side, an OAuth2 error body on the POST side. - Two paths produce an empty result and are deliberately distinct. No allowlist and no request keeps the previous unrestricted grant, written as an explicit sentinel because the column is NOT NULL with a non-empty CHECK. An allowlist that filters to nothing is rejected, since falling back would grant strictly more than the allowlist ever permitted. Dynamic client registration performs no catalog validation, so apps registered with scopes such as openid or admin hold allowlists this server cannot grant from. They now fail authorization in both directions. Grandfathering unknown names would seed the enforcement path with values it cannot evaluate, trading a visible negotiation-time error for a silent enforcement-time hole. The failure names the registered scopes and the remedy. Issued tokens are still unrestricted: the exchange copies the negotiated scope onto the token record, but the API key it mints carries no scope. This changes which authorization requests succeed, not what a token can do.
The consent page told every user the app was getting full access to their account, which stopped being true once the authorize endpoint began negotiating a narrower scope. A user approving a request has no other place to learn what they are handing over, so the page has to follow the grant rather than a fixed sentence. List the negotiated permissions when the grant is bounded, and keep the original full-access wording when it is not. An unrestricted grant is reported as full access rather than as "coder:all", since the scope name tells a user less than the sentence does. The list collapses to the full-access wording whenever the unrestricted scope is present, not only when it stands alone: an allowlist registered as `coder:all coder:workspaces.access` grants everything, and naming the narrower entry beside it would describe the grant as bounded. role="list" and role="listitem" are explicit because WebKit drops the implicit list semantics from a list styled with list-style: none, which would otherwise leave VoiceOver announcing the permissions as loose text. Also narrow the fragment the tests match for one rejection branch. The GET side renders its description into HTML, which escapes the apostrophe in "this app's allowed scope list", so the fragment stops before it.
Co-authored-by: Steven Masley <Emyrk@users.noreply.github.com>
Co-authored-by: Steven Masley <Emyrk@users.noreply.github.com>
…ated-scope # Conflicts: # coderd/oauth2provider/authorize.go # coderd/rbac/scopes_internal_test.go
…tiated-scope # Conflicts: # coderd/oauth2provider/authorize.go # coderd/oauth2provider/authorize_test.go # coderd/rbac/scopes_internal_test.go
…-negotiated-scope
Shorten the comments on the scope negotiation helpers to plain sentences and drop restatements of what the code shows. Also trim the PKCE revocation comments in tokens.go.
…-negotiated-scope # Conflicts: # coderd/oauth2provider/authorize.go
Shorten the comments introduced with the negotiated-scope exchange to plain sentences and drop restatements of what the code shows.
… coverage negotiateScope returns errCoverageUndecidable when the coverage comparison against the app's allowlist fails outright, which is this server failing to decide rather than a defect in the request. Both authorize call sites reported it as invalid_scope and echoed the sentinel text, which names RBAC internals. Map it to server_error (RFC 6749 §4.1.2.1) with a fixed description. The other rejections keep invalid_scope and their existing text.
…-negotiated-scope
Both conflicts are comment and prose wording that #28179 trimmed on main while this branch reworded for scope enforcement. Took this branch's wording in each: the negotiated scope now bounds the issued token, so "the pre-enforcement grant" and "does not yet restrict what the issued token can do" are no longer true.
RFC 6749 §5.2 scopes invalid_scope to what the client requested, but a stored scope outside the api_key_scope enum is server state the client cannot change by asking differently. The grant is what is unusable and re-authorizing is the only remedy, which is what invalid_grant says.

TL;DR
First of PLAT-480, continuing the merged PLAT-479 stack. #28178 decided what the scope is and #28179 reported it; this PR is the one that makes it bind. Until now the scope negotiated at
/oauth2/authorizewas recorded on the grant but never reached the token: every OAuth2 access key was minted withcoder:all, so a client that asked forcoder:workspaces.accessstill got full API access.ScopesCovercompares an allowlist against a request by permission coverage rather than by name. Merged.invalid_scopereaches the client's own callback per RFC 6749 §4.1.2.1. Merged.scoperequest parameter this PR still ignores.coder:allwill start seeing 403.coder:all, so they refresh unrestricted and reach what they reached before. Pinned byBackfilledScopeRefreshesUnrestricted, seeded the way the migration leaves a row rather than exchanged.rbac.ScopeAll. Narrowing it to the granted scope would denyapi_key:createand fail the exchange. The bound lives onapi_keys.scopes, which dbauthz reads on every request, not on the actor doing the insert.Where in the flow
Diagram: where the stored scope turns into a bound on the token
flowchart TD AZ["GET or POST /oauth2/authorize<br/>negotiates the scope and persists it on the code<br/>PR 28178, merged"] AZ --> TK["POST /oauth2/tokens"] TK --> GT{"grant_type"} GT -->|authorization_code| S1["scope read from codes.scope"] GT -->|refresh_token| S2["scope read from tokens.scope<br/>req.Scope is parsed and ignored, PR 28751"] S1 --> CV["scopeStringToAPIKeyScopes, this PR<br/>every name must be in the api_key_scope enum<br/>an empty list is an error, not coder:all"] S2 --> CV CV -->|"unknown name, or empty"| ERR["400 invalid_grant, this PR<br/>error_description names the offending value"] CV -->|mintable| GEN["apikey.Generate with Scopes, this PR<br/>was: no Scopes, so every key defaulted to coder:all"] GEN --> KEY["api_keys.scopes<br/>read by dbauthz on every later request:<br/>this is where the grant becomes a bound"] GEN --> ROW["the new tokens row carries the same scope,<br/>so the next refresh reads back the same grant"] KEY --> RESP["200 with scope in the token response, this PR<br/>RFC 6749 5.1, OAuth 2.1 1.4.1"] ROW --> RESPscopeStringToAPIKeyScopesturns the stored scope string intodatabase.APIKeyScopesforapikey.Generate. Names are checked there rather than insideapikey.Generate, whose error would surface as a 500 rather than an OAuth2 error.apikey.Generatedefaults an empty scope list tocoder:all, so an empty stored scope would silently widen the grant instead of failing it. The same reasoning is why theexpandRBACScopecomment inmodelmethods.gowas stale: that function already errored on an empty list while its comment still promisedrbac.ScopeAll.api_key_scopeenum answers 400invalid_grantrather than 500, with the offending name inerror_description. Notinvalid_scope: RFC 6749 §5.2 and OAuth 2.1 §3.2.4 both scope that code to what the client requested, and this value is server state the client cannot change by asking differently. The grant is what is unusable, and re-authorizing is the only way out.req.Scopeis parsed but ignored; feat: let an OAuth2 refresh narrow the granted scope #28751 is where it starts being honoured.oauth2.Tokentocodersdk.OAuth2TokenResponse, becauseoauth2.Tokenhas noscopefield to document.EveryCatalogNameMintablepins the catalog against theapi_key_scopeenum. The two are maintained separately, and a name negotiable at authorization but unmintable at exchange would leave a client holding a code it can never redeem.What it satisfies
Checked against both RFC 6749 and the OAuth 2.1 draft (draft-ietf-oauth-v2-1-15). The 2.1 draft moves the scope-reporting rule from RFC 6749 §5.1 into §1.4.1 and grades it in §3.2.3, but the requirement is the same one.
scoperesponse parameter in the token response". OAuth 2.1 §3.2.3 gradesscopeas "RECOMMENDED, if identical to the scope requested by the client; otherwise, REQUIRED". Both grants set it unconditionally, which covers both grades. Without it, a client whose request was narrowed against the app's allowlist, or defaulted because it requested nothing, first learns its bounds from an unexplained 403. Pinned byIssuedTokenBoundsTheAPI, which requests no scope and asserts the response names what it got.scopeon a refresh, and the licence is conditional on reporting the actual grant. Before this PR the exchange both ignored the request and said nothing, which is the half that was not defensible.scopeparameter is OPTIONAL and "if omitted is treated as equal to the scope originally granted by the resource owner". Exactly whatrefreshTokenGrantdoes withdbToken.Scope.dbToken.Scopeonto the new refresh row.RefreshDoesNotWidenTheScope.scopemust be met with "a pre-defined default value or fail the request indicating an invalid scope", and the server "SHOULD document its scope requirements and default value". feat: negotiate and persist authorization scope #28178 chose the default;scopes_supportedand the integration guide document it. Unchanged here, but it is whyIssuedTokenBoundsTheAPIcan request nothing and still receive a bounded token.invalid_scope(§3.2.4, "exceeds the scope granted by the resource owner"). Neither case widens a token, so there is no escalation, and §1.4.1's MAY plus thescoperesponse parameter keep the client correctly informed in the meantime. feat: let an OAuth2 refresh narrow the granted scope #28751 is where narrowing lands. Documented under Limitations until then.First of three, PLAT-480. Depends on #28179, which has merged, so this reviews against main.
#28178 decided the scope and #28179 reported it. This PR is the one that makes a token feel it.