mirror of
https://github.com/zitadel/zitadel.git
synced 2025-07-11 22:28:31 +00:00

# Which Problems Are Solved The commands for the resource based v2beta AuthorizationService API are added. Authorizations, previously knows as user grants, give a user in a specific organization and project context roles. The project can be owned or granted. The given roles can be used to restrict access within the projects applications. The commands for the resource based v2beta InteralPermissionService API are added. Administrators, previously knows as memberships, give a user in a specific organization and project context roles. The project can be owned or granted. The give roles give the user permissions to manage different resources in Zitadel. API definitions from https://github.com/zitadel/zitadel/issues/9165 are implemented. Contains endpoints for user metadata. # How the Problems Are Solved ### New Methods - CreateAuthorization - UpdateAuthorization - DeleteAuthorization - ActivateAuthorization - DeactivateAuthorization - ListAuthorizations - CreateAdministrator - UpdateAdministrator - DeleteAdministrator - ListAdministrators - SetUserMetadata to set metadata on a user - DeleteUserMetadata to delete metadata on a user - ListUserMetadata to query for metadata of a user ## Deprecated Methods ### v1.ManagementService - GetUserGrantByID - ListUserGrants - AddUserGrant - UpdateUserGrant - DeactivateUserGrant - ReactivateUserGrant - RemoveUserGrant - BulkRemoveUserGrant ### v1.AuthService - ListMyUserGrants - ListMyProjectPermissions # Additional Changes - Permission checks for metadata functionality on query and command side - correct existence checks for resources, for example you can only be an administrator on an existing project - combined all member tables to singular query for the administrators - add permission checks for command an query side functionality - combined functions on command side where necessary for easier maintainability # Additional Context Closes #9165 --------- Co-authored-by: Elio Bischof <elio@zitadel.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Livio Spring <livio.a@gmail.com>
193 lines
7.2 KiB
Go
193 lines
7.2 KiB
Go
package internal_permission
|
|
|
|
import (
|
|
"context"
|
|
|
|
"connectrpc.com/connect"
|
|
"google.golang.org/protobuf/types/known/timestamppb"
|
|
|
|
filter "github.com/zitadel/zitadel/internal/api/grpc/filter/v2beta"
|
|
"github.com/zitadel/zitadel/internal/query"
|
|
"github.com/zitadel/zitadel/internal/zerrors"
|
|
filter_pb "github.com/zitadel/zitadel/pkg/grpc/filter/v2beta"
|
|
internal_permission "github.com/zitadel/zitadel/pkg/grpc/internal_permission/v2beta"
|
|
)
|
|
|
|
func (s *Server) ListAdministrators(ctx context.Context, req *connect.Request[internal_permission.ListAdministratorsRequest]) (*connect.Response[internal_permission.ListAdministratorsResponse], error) {
|
|
queries, err := s.listAdministratorsRequestToModel(req.Msg)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
resp, err := s.query.SearchAdministrators(ctx, queries, s.checkPermission)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return connect.NewResponse(&internal_permission.ListAdministratorsResponse{
|
|
Administrators: administratorsToPb(resp.Administrators),
|
|
Pagination: filter.QueryToPaginationPb(queries.SearchRequest, resp.SearchResponse),
|
|
}), nil
|
|
}
|
|
|
|
func (s *Server) listAdministratorsRequestToModel(req *internal_permission.ListAdministratorsRequest) (*query.MembershipSearchQuery, error) {
|
|
offset, limit, asc, err := filter.PaginationPbToQuery(s.systemDefaults, req.Pagination)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
queries, err := administratorSearchFiltersToQuery(req.Filters)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return &query.MembershipSearchQuery{
|
|
SearchRequest: query.SearchRequest{
|
|
Offset: offset,
|
|
Limit: limit,
|
|
Asc: asc,
|
|
SortingColumn: administratorFieldNameToSortingColumn(req.GetSortingColumn()),
|
|
},
|
|
Queries: queries,
|
|
}, nil
|
|
}
|
|
|
|
func administratorFieldNameToSortingColumn(field internal_permission.AdministratorFieldName) query.Column {
|
|
switch field {
|
|
case internal_permission.AdministratorFieldName_ADMINISTRATOR_FIELD_NAME_CREATION_DATE:
|
|
return query.MembershipCreationDate
|
|
case internal_permission.AdministratorFieldName_ADMINISTRATOR_FIELD_NAME_USER_ID:
|
|
return query.MembershipUserID
|
|
case internal_permission.AdministratorFieldName_ADMINISTRATOR_FIELD_NAME_CHANGE_DATE:
|
|
return query.MembershipChangeDate
|
|
case internal_permission.AdministratorFieldName_ADMINISTRATOR_FIELD_NAME_UNSPECIFIED:
|
|
return query.MembershipCreationDate
|
|
default:
|
|
return query.MembershipCreationDate
|
|
}
|
|
}
|
|
|
|
func administratorSearchFiltersToQuery(queries []*internal_permission.AdministratorSearchFilter) (_ []query.SearchQuery, err error) {
|
|
q := make([]query.SearchQuery, len(queries))
|
|
for i, qry := range queries {
|
|
q[i], err = administratorFilterToModel(qry)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
}
|
|
return q, nil
|
|
}
|
|
|
|
func administratorFilterToModel(filter *internal_permission.AdministratorSearchFilter) (query.SearchQuery, error) {
|
|
switch q := filter.Filter.(type) {
|
|
case *internal_permission.AdministratorSearchFilter_InUserIdsFilter:
|
|
return inUserIDsFilterToQuery(q.InUserIdsFilter)
|
|
case *internal_permission.AdministratorSearchFilter_CreationDate:
|
|
return creationDateFilterToQuery(q.CreationDate)
|
|
case *internal_permission.AdministratorSearchFilter_ChangeDate:
|
|
return changeDateFilterToQuery(q.ChangeDate)
|
|
case *internal_permission.AdministratorSearchFilter_UserOrganizationId:
|
|
return userResourceOwnerFilterToQuery(q.UserOrganizationId)
|
|
case *internal_permission.AdministratorSearchFilter_UserPreferredLoginName:
|
|
return userLoginNameFilterToQuery(q.UserPreferredLoginName)
|
|
case *internal_permission.AdministratorSearchFilter_UserDisplayName:
|
|
return userDisplayNameFilterToQuery(q.UserDisplayName)
|
|
case *internal_permission.AdministratorSearchFilter_Resource:
|
|
return resourceFilterToQuery(q.Resource)
|
|
default:
|
|
return nil, zerrors.ThrowInvalidArgument(nil, "ORG-vR9nC", "List.Query.Invalid")
|
|
}
|
|
}
|
|
|
|
func inUserIDsFilterToQuery(q *filter_pb.InIDsFilter) (query.SearchQuery, error) {
|
|
return query.NewMemberInUserIDsSearchQuery(q.GetIds())
|
|
}
|
|
|
|
func userResourceOwnerFilterToQuery(q *filter_pb.IDFilter) (query.SearchQuery, error) {
|
|
return query.NewAdministratorUserResourceOwnerSearchQuery(q.GetId())
|
|
}
|
|
|
|
func userLoginNameFilterToQuery(q *internal_permission.UserPreferredLoginNameFilter) (query.SearchQuery, error) {
|
|
return query.NewAdministratorUserLoginNameSearchQuery(q.GetPreferredLoginName())
|
|
}
|
|
|
|
func userDisplayNameFilterToQuery(q *internal_permission.UserDisplayNameFilter) (query.SearchQuery, error) {
|
|
return query.NewAdministratorUserDisplayNameSearchQuery(q.GetDisplayName())
|
|
}
|
|
|
|
func creationDateFilterToQuery(q *filter_pb.TimestampFilter) (query.SearchQuery, error) {
|
|
return query.NewMembershipCreationDateQuery(q.GetTimestamp().AsTime(), filter.TimestampMethodPbToQuery(q.Method))
|
|
}
|
|
|
|
func changeDateFilterToQuery(q *filter_pb.TimestampFilter) (query.SearchQuery, error) {
|
|
return query.NewMembershipChangeDateQuery(q.GetTimestamp().AsTime(), filter.TimestampMethodPbToQuery(q.Method))
|
|
}
|
|
|
|
func resourceFilterToQuery(q *internal_permission.ResourceFilter) (query.SearchQuery, error) {
|
|
switch q.GetResource().(type) {
|
|
case *internal_permission.ResourceFilter_Instance:
|
|
if q.GetInstance() {
|
|
return query.NewMembershipIsIAMQuery()
|
|
}
|
|
case *internal_permission.ResourceFilter_OrganizationId:
|
|
return query.NewMembershipOrgIDQuery(q.GetOrganizationId())
|
|
case *internal_permission.ResourceFilter_ProjectId:
|
|
return query.NewMembershipProjectIDQuery(q.GetProjectId())
|
|
case *internal_permission.ResourceFilter_ProjectGrantId:
|
|
return query.NewMembershipProjectGrantIDQuery(q.GetProjectGrantId())
|
|
}
|
|
return nil, nil
|
|
}
|
|
|
|
func administratorsToPb(administrators []*query.Administrator) []*internal_permission.Administrator {
|
|
a := make([]*internal_permission.Administrator, len(administrators))
|
|
for i, admin := range administrators {
|
|
a[i] = administratorToPb(admin)
|
|
}
|
|
return a
|
|
}
|
|
|
|
func administratorToPb(admin *query.Administrator) *internal_permission.Administrator {
|
|
var resource internal_permission.Resource
|
|
if admin.Instance != nil {
|
|
resource = &internal_permission.Administrator_Instance{Instance: true}
|
|
}
|
|
if admin.Org != nil {
|
|
resource = &internal_permission.Administrator_Organization{
|
|
Organization: &internal_permission.Organization{
|
|
Id: admin.Org.OrgID,
|
|
Name: admin.Org.Name,
|
|
},
|
|
}
|
|
}
|
|
if admin.Project != nil {
|
|
resource = &internal_permission.Administrator_Project{
|
|
Project: &internal_permission.Project{
|
|
Id: admin.Project.ProjectID,
|
|
Name: admin.Project.Name,
|
|
OrganizationId: admin.Project.ResourceOwner,
|
|
},
|
|
}
|
|
}
|
|
if admin.ProjectGrant != nil {
|
|
resource = &internal_permission.Administrator_ProjectGrant{
|
|
ProjectGrant: &internal_permission.ProjectGrant{
|
|
Id: admin.ProjectGrant.GrantID,
|
|
ProjectId: admin.ProjectGrant.ProjectID,
|
|
ProjectName: admin.ProjectGrant.ProjectName,
|
|
OrganizationId: admin.ProjectGrant.ResourceOwner,
|
|
GrantedOrganizationId: admin.ProjectGrant.GrantedOrgID,
|
|
},
|
|
}
|
|
}
|
|
|
|
return &internal_permission.Administrator{
|
|
CreationDate: timestamppb.New(admin.CreationDate),
|
|
ChangeDate: timestamppb.New(admin.ChangeDate),
|
|
User: &internal_permission.User{
|
|
Id: admin.User.UserID,
|
|
PreferredLoginName: admin.User.LoginName,
|
|
DisplayName: admin.User.DisplayName,
|
|
OrganizationId: admin.User.ResourceOwner,
|
|
},
|
|
Resource: resource,
|
|
Roles: admin.Roles,
|
|
}
|
|
}
|