chore(backend,types): Prevent system permissions usage in server-side #4816
Conversation
This file contains 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
🦋 Changeset detectedLatest commit: ca63d27 The changes in this PR will be included in the next version bump. This PR includes changesets to release 23 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
LauraBeatris
force-pushed
the
laura/orgs-441-do-not-allow-passing-system-permissions-to-has-from-the
branch
from
4b60ed7 to
44bb684
Compare
LauraBeatris
changed the title
LauraBeatris
force-pushed
the
laura/orgs-441-do-not-allow-passing-system-permissions-to-has-from-the
branch
from
65a25ba to
ca63d27
Compare
Comment on lines
+116
to
+122
| it('prevents usage of system permissions with auth.has()', () => { | ||
| clerkMiddlewareMock(async (auth, _event, _request) => { | ||
| // @ts-expect-error - system permissions are not allowed | ||
| (await auth()).has({ permission: 'org:sys_foo' }); | ||
| }); | ||
| }); | ||
|
|
There was a problem hiding this comment.
do you think we should add a test case for useAuth() where the type says that sys permissions are allowed ?
In order to not break something in the future
BRKalow
reviewed
Dec 20, 2024
Comment on lines
+29
to
+31
| type DisallowSystemPermissions<P extends string> = P extends `${OrganizationSystemPermissionPrefix}${string}` | ||
| ? 'System permissions are not included in session claims and cannot be used on the server-side' | ||
| : P; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Resolves ORGS-441
Context
System permissions (e.g.,
org:sys_domains:manage) are intentionally excluded from session claims to maintain reasonable JWT sizes. While these permissions work in client-side authorization checks (where they're validated against FAPI organization memberships), they cannot be verified server-side.Problem
Despite documentation updates, developers continue to use server-side authorization checks with system permissions, leading to confusion and support tickets.
Solution
Add type-level validation to catch misuse of system permissions during development. I've opted not to introduce a runtime warning since developers might ignore it.
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change