feat: RBAC support (Sync/Async) #349
Open
+2,745
−24
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
…locally Pass lombok version to lombok-maven-plugin explicitly, as the default version is not up-to-date. See: awhitford/lombok.maven#179 (comment)
@EqualsAndHashCode makes comparing Role and Permission objects easy
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
Makes creating several permissions for the same resource easier.
For example, instead of 'Permission.data('Pizza', CREATE), Permission.data('Pizza', DELETE)'
users can write 'Permission.data('Pizza', CREATE, DELETE)'.
To avoid having ~4 different withPermission() builder methods in the client classes
all factory methods on Permission class will return Permission[] (even if known to be length 1).
Moved to a separate file and documented.
| * Then {@code MyAction.FOO} can be retrieved from "do_foo" using | ||
| * {@link #fromString}. | ||
| */ | ||
| interface RbacAction { |
There was a problem hiding this comment.
shouldn't RbacAction interface be public?
There was a problem hiding this comment.
It doesn't need to, because we only ever use it internally for deserializing responses from the server.
What the user passes/receives is one of the "concrete" public enums that implement RbacAction.
Ideally, we want to shield the user from the methods of this interface, because passing an invalid string might throw an IllegalArgumentException.
antas-marcin
approved these changes
Jan 30, 2025
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.
Related to #343.
This PR is the first iteration of that story, adding RBAC support to the sync client.
Initially it drew a lot on the Python's client, but I ended up re-organizing things to be consistent with the current client.
client.async().roles()Files to pay attention to (have denser logic):
Permission.java
WeaviatePermission.java
Role.java
WeaviateRole.java
ClientRbacTestSuite.java