- Notifications
You must be signed in to change notification settings - Fork1k
feat: add allow list to API keys#19972
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
ThomasK33 wants to merge1 commit intothomask33/09-25-feat_add_allow_list_field_api_keysChoose a base branch
base:thomask33/09-25-feat_add_allow_list_field_api_keys
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Open
feat: add allow list to API keys#19972
ThomasK33 wants to merge1 commit intothomask33/09-25-feat_add_allow_list_field_api_keysfromthomask33/09-25-resource_scoped_api_keys_in_codersdk
+161 −46
Conversation
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 was referencedSep 25, 2025
MemberAuthor
ThomasK33 commentedSep 25, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stackon Graphite.
This stack of pull requests is managed byGraphite. Learn more aboutstacking. |
05cdebd to5442fcdCompare1fea0d8 to8013625Compareda32dec tof2fbea4Compare8013625 to4382587Comparef2fbea4 to847f52eCompare4382587 tofb2440eCompare847f52e to1361b86Comparefb2440e toce693c0Compare1361b86 to581bc52Compare581bc52 to6d17ef1Comparece693c0 tof1a4e56Comparef1a4e56 toa591e0aCompare6d17ef1 to6fa5fe1Comparec8a7549 toc50a0acCompareUh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
276874b to662f3faCompare56cd860 tod38ed5bCompare5dd3400 to5a6e8ccCompared38ed5b to5cb53f7Compare5a6e8cc to73a65faCompare5cb53f7 to6248fffCompare7d422aa tod590c1dCompare6248fff to67ed32bCompared590c1d to49af2b4Compare4beef99 to86f7de9Compare49af2b4 tofa53285Compare86f7de9 to854efb0Comparefa53285 tod7df2aaCompare87fb51c to3bdb267Compare Comment on lines +54 to +63
| funcAPIAllowListTarget(entry rbac.AllowListElement) codersdk.APIAllowListTarget { | ||
| target:=codersdk.AllowAllTarget() | ||
| ifentry.Type!="" { | ||
| target.Type=codersdk.RBACResource(entry.Type) | ||
| } | ||
| ifentry.ID!="" { | ||
| target.ID=entry.ID | ||
| } | ||
| returntarget | ||
| } |
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.
I know we have to figure out the semantics of an empty string for theid, but it should not be treated as a wildcard imo.
I think we should just pass the rbac entry to the SDK as is. Do not do:target := codersdk.AllowAllTarget() as the default.
Comment on lines +1599 to +1601
| allowList:=db2sdk.List(k.AllowList,db2sdk.APIAllowListTarget) | ||
| iflen(allowList)==0 { | ||
| allowList=append(allowList,codersdk.AllowAllTarget()) |
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.
I still think we should never have an empty allow list. The db migration handles this iirc, so defaulting toall if the list is empty feels like it's hiding some other issue.
Add allow_list field to API key data structures and ensure properJSON serialization across backend and frontend. Initialize with default wildcard entry (*:*) for backward compatibility withexisting API keys that don't have explicit resource restrictions.Fixes#19854
d7df2aa toa1346f5Compare3bdb267 toc41112aCompareSign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Labels
None yet
2 participants
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.
Uh oh!
There was an error while loading.Please reload this page.
Add API key allow list to the SDK
This PR adds an allow list to API keys in the SDK. The allow list is a list of targets that the API key is allowed to access. If the allow list is empty, a default allow list with a single entry that allows access to all resources is created.
The changes include:
Fixes#19854