mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-11 14:37:34 +00:00
perf: role permissions in database (#9152)
# Which Problems Are Solved Currently ZITADEL defines organization and instance member roles and permissions in defaults.yaml. The permission check is done on API call level. For example: "is this user allowed to make this call on this org". This makes sense on the V1 API where the API is permission-level shaped. For example, a search for users always happens in the context of the organization. (Either the organization the calling user belongs to, or through member ship and the x-zitadel-orgid header. However, for resource based APIs we must be able to resolve permissions by object. For example, an IAM_OWNER listing users should be able to get all users in an instance based on the query filters. Alternatively a user may have user.read permissions on one or more orgs. They should be able to read just those users. # How the Problems Are Solved ## Role permission mapping The role permission mappings defined from `defaults.yaml` or local config override are synchronized to the database on every run of `zitadel setup`: - A single query per **aggregate** builds a list of `add` and `remove` actions needed to reach the desired state or role permission mappings from the config. - The required events based on the actions are pushed to the event store. - Events define search fields so that permission checking can use the indices and is strongly consistent for both query and command sides. The migration is split in the following aggregates: - System aggregate for for roles prefixed with `SYSTEM` - Each instance for roles not prefixed with `SYSTEM`. This is in anticipation of instance level management over the API. ## Membership Current instance / org / project membership events now have field table definitions. Like the role permissions this ensures strong consistency while still being able to use the indices of the fields table. A migration is provided to fill the membership fields. ## Permission check I aimed keeping the mental overhead to the developer to a minimal. The provided implementation only provides a permission check for list queries for org level resources, for example users. In the `query` package there is a simple helper function `wherePermittedOrgs` which makes sure the underlying database function is called as part of the `SELECT` query and the permitted organizations are part of the `WHERE` clause. This makes sure results from non-permitted organizations are omitted. Under the hood: - A Pg/PlSQL function searches for a list of organization IDs the passed user has the passed permission. - When the user has the permission on instance level, it returns early with all organizations. - The functions uses a number of views. The views help mapping the fields entries into relational data and simplify the code use for the function. The views provide some pre-filters which allow proper index usage once the final `WHERE` clauses are set by the function. # Additional Changes # Additional Context Closes #9032 Closes https://github.com/zitadel/zitadel/issues/9014 https://github.com/zitadel/zitadel/issues/9188 defines follow-ups for the new permission framework based on this concept.
This commit is contained in:
@@ -99,6 +99,13 @@ message SetInstanceFeaturesRequest{
|
||||
description: "Specify the login UI for all users and applications regardless of their preference.";
|
||||
}
|
||||
];
|
||||
|
||||
optional bool permission_check_v2 = 14 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
example: "true";
|
||||
description: "Enable a newer, more performant, permission check used for v2 and v3 resource based APIs.";
|
||||
}
|
||||
];
|
||||
}
|
||||
|
||||
message SetInstanceFeaturesResponse {
|
||||
@@ -212,4 +219,10 @@ message GetInstanceFeaturesResponse {
|
||||
description: "If the flag is set, all users will be redirected to the login V2 regardless of the application's preference.";
|
||||
}
|
||||
];
|
||||
|
||||
FeatureFlag permission_check_v2 = 15 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
description: "Enable a newer, more performant, permission check used for v2 and v3 resource based APIs.";
|
||||
}
|
||||
];
|
||||
}
|
||||
|
@@ -88,6 +88,13 @@ message SetSystemFeaturesRequest{
|
||||
description: "Specify the login UI for all users and applications regardless of their preference.";
|
||||
}
|
||||
];
|
||||
|
||||
optional bool permission_check_v2 = 12 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
example: "true";
|
||||
description: "Enable a newer, more performant, permission check used for v2 and v3 resource based APIs.";
|
||||
}
|
||||
];
|
||||
}
|
||||
|
||||
message SetSystemFeaturesResponse {
|
||||
@@ -180,4 +187,10 @@ message GetSystemFeaturesResponse {
|
||||
description: "If the flag is set, all users will be redirected to the login V2 regardless of the application's preference.";
|
||||
}
|
||||
];
|
||||
|
||||
FeatureFlag permission_check_v2 = 13 [
|
||||
(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {
|
||||
description: "Enable a newer, more performant, permission check used for v2 and v3 resource based APIs.";
|
||||
}
|
||||
];
|
||||
}
|
||||
|
Reference in New Issue
Block a user