Class PermissionProviderBase
Base implementation of permission provider with common business logic.
Database-specific providers inherit from this class and provide ISqlDialect.
IMPORTANT: Uses DB-specific SQL function for effective permissions!
PostgreSQL: get_user_permissions_for_object()
MSSQL: Must provide equivalent CTE/JOIN query
public abstract class PermissionProviderBase : IPermissionProvider
Inheritance
Implements
Derived
Methods
CanUserDeleteObject(IRedbObject, CancellationToken)
Check if current user can delete object.
public virtual Task<bool> CanUserDeleteObject(IRedbObject obj, CancellationToken cancellationToken = default)
CanUserDeleteObject(IRedbObject, IRedbUser, CancellationToken)
Check if user can delete object.
public virtual Task<bool> CanUserDeleteObject(IRedbObject obj, IRedbUser user, CancellationToken cancellationToken = default)
CanUserDeleteObject(IRedbObject, IRedbUser)
Check if user can delete object.
public virtual Task<bool> CanUserDeleteObject(IRedbObject obj, IRedbUser user)
CanUserDeleteObject(IRedbObject)
Check if current user can delete object.
public virtual Task<bool> CanUserDeleteObject(IRedbObject obj)
CanUserDeleteObject(long, long, CancellationToken)
public virtual Task<bool> CanUserDeleteObject(long objectId, long userId, CancellationToken cancellationToken = default)
CanUserDeleteObject(long, long)
public virtual Task<bool> CanUserDeleteObject(long objectId, long userId)
CanUserDeleteObject(RedbObject, CancellationToken)
Check if current user can delete object.
public virtual Task<bool> CanUserDeleteObject(RedbObject obj, CancellationToken cancellationToken = default)
CanUserDeleteObject(RedbObject, IRedbUser, CancellationToken)
Check if user can delete object.
public virtual Task<bool> CanUserDeleteObject(RedbObject obj, IRedbUser user, CancellationToken cancellationToken = default)
CanUserDeleteObject(RedbObject, IRedbUser)
Check if user can delete object.
public virtual Task<bool> CanUserDeleteObject(RedbObject obj, IRedbUser user)
CanUserDeleteObject(RedbObject)
Check if current user can delete object.
public virtual Task<bool> CanUserDeleteObject(RedbObject obj)
CanUserEditObject(IRedbObject, CancellationToken)
Check if current user can edit object.
public virtual Task<bool> CanUserEditObject(IRedbObject obj, CancellationToken cancellationToken = default)
CanUserEditObject(IRedbObject, IRedbUser, CancellationToken)
Check if user can edit object.
public virtual Task<bool> CanUserEditObject(IRedbObject obj, IRedbUser user, CancellationToken cancellationToken = default)
CanUserEditObject(IRedbObject, IRedbUser)
Check if user can edit object.
public virtual Task<bool> CanUserEditObject(IRedbObject obj, IRedbUser user)
CanUserEditObject(IRedbObject)
Check if current user can edit object.
public virtual Task<bool> CanUserEditObject(IRedbObject obj)
CanUserEditObject(long, long, CancellationToken)
public virtual Task<bool> CanUserEditObject(long objectId, long userId, CancellationToken cancellationToken = default)
CanUserEditObject(long, long)
public virtual Task<bool> CanUserEditObject(long objectId, long userId)
CanUserEditObject(RedbObject, CancellationToken)
Check if current user can edit object.
public virtual Task<bool> CanUserEditObject(RedbObject obj, CancellationToken cancellationToken = default)
CanUserEditObject(RedbObject, IRedbUser, CancellationToken)
Check if user can edit object.
public virtual Task<bool> CanUserEditObject(RedbObject obj, IRedbUser user, CancellationToken cancellationToken = default)
CanUserEditObject(RedbObject, IRedbUser)
Check if user can edit object.
public virtual Task<bool> CanUserEditObject(RedbObject obj, IRedbUser user)
CanUserEditObject(RedbObject)
Check if current user can edit object.
public virtual Task<bool> CanUserEditObject(RedbObject obj)
CanUserInsertScheme(IRedbScheme, CancellationToken)
Check if current user can create objects in scheme.
public virtual Task<bool> CanUserInsertScheme(IRedbScheme scheme, CancellationToken cancellationToken = default)
CanUserInsertScheme(IRedbScheme, IRedbUser, CancellationToken)
Check if user can create objects in scheme.
public virtual Task<bool> CanUserInsertScheme(IRedbScheme scheme, IRedbUser user, CancellationToken cancellationToken = default)
CanUserInsertScheme(IRedbScheme, IRedbUser)
Check if user can create objects in scheme.
public virtual Task<bool> CanUserInsertScheme(IRedbScheme scheme, IRedbUser user)
CanUserInsertScheme(IRedbScheme)
Check if current user can create objects in scheme.
public virtual Task<bool> CanUserInsertScheme(IRedbScheme scheme)
CanUserInsertScheme(long, long, CancellationToken)
public virtual Task<bool> CanUserInsertScheme(long schemeId, long userId, CancellationToken cancellationToken = default)
CanUserInsertScheme(long, long)
public virtual Task<bool> CanUserInsertScheme(long schemeId, long userId)
CanUserInsertScheme(RedbObject, IRedbUser, CancellationToken)
Check if user can create objects in object's scheme.
public virtual Task<bool> CanUserInsertScheme(RedbObject obj, IRedbUser user, CancellationToken cancellationToken = default)
CanUserInsertScheme(RedbObject, IRedbUser)
Check if user can create objects in object's scheme.
public virtual Task<bool> CanUserInsertScheme(RedbObject obj, IRedbUser user)
CanUserSelectObject(IRedbObject, CancellationToken)
Check if current user can read object.
public virtual Task<bool> CanUserSelectObject(IRedbObject obj, CancellationToken cancellationToken = default)
CanUserSelectObject(IRedbObject, IRedbUser, CancellationToken)
Check if user can read object.
public virtual Task<bool> CanUserSelectObject(IRedbObject obj, IRedbUser user, CancellationToken cancellationToken = default)
CanUserSelectObject(IRedbObject, IRedbUser)
Check if user can read object.
public virtual Task<bool> CanUserSelectObject(IRedbObject obj, IRedbUser user)
CanUserSelectObject(IRedbObject)
Check if current user can read object.
public virtual Task<bool> CanUserSelectObject(IRedbObject obj)
CanUserSelectObject(long, long, CancellationToken)
public virtual Task<bool> CanUserSelectObject(long objectId, long userId, CancellationToken cancellationToken = default)
CanUserSelectObject(long, long)
public virtual Task<bool> CanUserSelectObject(long objectId, long userId)
CanUserSelectObject(RedbObject, CancellationToken)
Check if current user can read object.
public virtual Task<bool> CanUserSelectObject(RedbObject obj, CancellationToken cancellationToken = default)
CanUserSelectObject(RedbObject, IRedbUser, CancellationToken)
Check if user can read object.
public virtual Task<bool> CanUserSelectObject(RedbObject obj, IRedbUser user, CancellationToken cancellationToken = default)
CanUserSelectObject(RedbObject, IRedbUser)
Check if user can read object.
public virtual Task<bool> CanUserSelectObject(RedbObject obj, IRedbUser user)
CanUserSelectObject(RedbObject)
Check if current user can read object.
public virtual Task<bool> CanUserSelectObject(RedbObject obj)
CanUserSelectObjectSync(long, long)
Synchronous for the
public virtual bool CanUserSelectObjectSync(long objectId, long userId)
CreatePermissionAsync(PermissionRequest, IRedbUser?, CancellationToken)
Create new permission.
public virtual Task<IRedbPermission> CreatePermissionAsync(PermissionRequest request, IRedbUser? currentUser = null, CancellationToken cancellationToken = default)
CreatePermissionAsync(PermissionRequest, IRedbUser?)
Create new permission.
public virtual Task<IRedbPermission> CreatePermissionAsync(PermissionRequest request, IRedbUser? currentUser = null)
DeletePermissionAsync(IRedbPermission, IRedbUser?, CancellationToken)
Delete permission.
public virtual Task<bool> DeletePermissionAsync(IRedbPermission permission, IRedbUser? currentUser = null, CancellationToken cancellationToken = default)
DeletePermissionAsync(IRedbPermission, IRedbUser?)
Delete permission.
public virtual Task<bool> DeletePermissionAsync(IRedbPermission permission, IRedbUser? currentUser = null)
GetAllEffectivePermissionsAsync(IRedbUser, CancellationToken)
Get all effective user permissions.
public virtual Task<List<EffectivePermissionResult>> GetAllEffectivePermissionsAsync(IRedbUser user, CancellationToken cancellationToken = default)
GetAllEffectivePermissionsAsync(IRedbUser)
Get all effective user permissions.
public virtual Task<List<EffectivePermissionResult>> GetAllEffectivePermissionsAsync(IRedbUser user)
GetAllEffectivePermissionsAsync(long, CancellationToken)
Get all effective permissions for user.
protected virtual Task<List<EffectivePermissionResult>> GetAllEffectivePermissionsAsync(long userId, CancellationToken cancellationToken = default)
GetAllEffectivePermissionsAsync(long)
Get all effective permissions for user.
protected virtual Task<List<EffectivePermissionResult>> GetAllEffectivePermissionsAsync(long userId)
GetEffectivePermissionsAsync(IRedbUser, IRedbObject, CancellationToken)
Get effective user permissions for object (including inheritance and roles).
public virtual Task<EffectivePermissionResult> GetEffectivePermissionsAsync(IRedbUser user, IRedbObject obj, CancellationToken cancellationToken = default)
GetEffectivePermissionsAsync(IRedbUser, IRedbObject)
Get effective user permissions for object (including inheritance and roles).
public virtual Task<EffectivePermissionResult> GetEffectivePermissionsAsync(IRedbUser user, IRedbObject obj)
GetEffectivePermissionsAsync(long, long, CancellationToken)
Get effective permissions for user and object.
protected virtual Task<EffectivePermissionResult> GetEffectivePermissionsAsync(long userId, long objectId, CancellationToken cancellationToken = default)
GetEffectivePermissionsAsync(long, long)
Get effective permissions for user and object.
protected virtual Task<EffectivePermissionResult> GetEffectivePermissionsAsync(long userId, long objectId)
GetEffectivePermissionsBatchAsync(IRedbUser, IRedbObject[], CancellationToken)
Get effective user permissions for multiple objects (batch).
public virtual Task<Dictionary<IRedbObject, EffectivePermissionResult>> GetEffectivePermissionsBatchAsync(IRedbUser user, IRedbObject[] objects, CancellationToken cancellationToken = default)
GetEffectivePermissionsBatchAsync(IRedbUser, IRedbObject[])
Get effective user permissions for multiple objects (batch).
public virtual Task<Dictionary<IRedbObject, EffectivePermissionResult>> GetEffectivePermissionsBatchAsync(IRedbUser user, IRedbObject[] objects)
GetEffectivePermissionsBatchAsync(long, long[], CancellationToken)
Batch get effective permissions.
protected virtual Task<Dictionary<long, EffectivePermissionResult>> GetEffectivePermissionsBatchAsync(long userId, long[] objectIds, CancellationToken cancellationToken = default)
GetEffectivePermissionsBatchAsync(long, long[])
Batch get effective permissions.
protected virtual Task<Dictionary<long, EffectivePermissionResult>> GetEffectivePermissionsBatchAsync(long userId, long[] objectIds)
GetEffectivePermissionViaSql(long, long)
Synchronous twin of for the
protected virtual UserPermissionResult? GetEffectivePermissionViaSql(long objectId, long userId)
GetEffectivePermissionViaSqlAsync(long, long, CancellationToken)
Get effective permission via SQL (uses DB function or query).
protected virtual Task<UserPermissionResult?> GetEffectivePermissionViaSqlAsync(long objectId, long userId, CancellationToken cancellationToken = default)
GetEffectivePermissionViaSqlAsync(long, long)
Get effective permission via SQL (uses DB function or query).
protected virtual Task<UserPermissionResult?> GetEffectivePermissionViaSqlAsync(long objectId, long userId)
GetPermissionByIdAsync(long, CancellationToken)
Get permission by ID.
public virtual Task<IRedbPermission?> GetPermissionByIdAsync(long permissionId, CancellationToken cancellationToken = default)
GetPermissionByIdAsync(long)
Get permission by ID.
public virtual Task<IRedbPermission?> GetPermissionByIdAsync(long permissionId)
GetPermissionCountAsync()
Get total permission count.
public virtual Task<int> GetPermissionCountAsync()
GetPermissionCountAsync(CancellationToken)
Get total permission count.
public virtual Task<int> GetPermissionCountAsync(CancellationToken cancellationToken = default)
GetPermissionsByObjectAsync(IRedbObject, CancellationToken)
Get permissions for object.
public virtual Task<List<IRedbPermission>> GetPermissionsByObjectAsync(IRedbObject obj, CancellationToken cancellationToken = default)
GetPermissionsByObjectAsync(IRedbObject)
Get permissions for object.
public virtual Task<List<IRedbPermission>> GetPermissionsByObjectAsync(IRedbObject obj)
GetPermissionsByRoleAsync(IRedbRole, CancellationToken)
Get role permissions.
public virtual Task<List<IRedbPermission>> GetPermissionsByRoleAsync(IRedbRole role, CancellationToken cancellationToken = default)
GetPermissionsByRoleAsync(IRedbRole)
Get role permissions.
public virtual Task<List<IRedbPermission>> GetPermissionsByRoleAsync(IRedbRole role)
GetPermissionsByUserAsync(IRedbUser, CancellationToken)
Get user permissions.
public virtual Task<List<IRedbPermission>> GetPermissionsByUserAsync(IRedbUser user, CancellationToken cancellationToken = default)
GetPermissionsByUserAsync(IRedbUser)
Get user permissions.
public virtual Task<List<IRedbPermission>> GetPermissionsByUserAsync(IRedbUser user)
GetReadableObjectIds()
Get IDs of objects readable by current user.
public virtual IQueryable<long> GetReadableObjectIds()
GetReadableObjectIds(IRedbUser)
Get IDs of objects readable by user.
public virtual IQueryable<long> GetReadableObjectIds(IRedbUser user)
GetReadableObjectIds(long)
public virtual IQueryable<long> GetReadableObjectIds(long userId)
GetReadableObjectIdsAsync(long, CancellationToken)
Async version of GetReadableObjectIds.
protected virtual Task<List<long>> GetReadableObjectIdsAsync(long userId, CancellationToken cancellationToken = default)
GetReadableObjectIdsAsync(long)
Async version of GetReadableObjectIds.
protected virtual Task<List<long>> GetReadableObjectIdsAsync(long userId)
GetRolePermissionCountAsync(IRedbRole, CancellationToken)
Get role permission count.
public virtual Task<int> GetRolePermissionCountAsync(IRedbRole role, CancellationToken cancellationToken = default)
GetRolePermissionCountAsync(IRedbRole)
Get role permission count.
public virtual Task<int> GetRolePermissionCountAsync(IRedbRole role)
GetSelectableObjectIdsAsync(IReadOnlyCollection<long>, long, CancellationToken)
The objects of objectIds the user may read, by the rule of
public virtual Task<IReadOnlySet<long>> GetSelectableObjectIdsAsync(IReadOnlyCollection<long> objectIds, long userId, CancellationToken cancellationToken = default)
GetUserPermissionCountAsync(IRedbUser, CancellationToken)
Get user permission count.
public virtual Task<int> GetUserPermissionCountAsync(IRedbUser user, CancellationToken cancellationToken = default)
GetUserPermissionCountAsync(IRedbUser)
Get user permission count.
public virtual Task<int> GetUserPermissionCountAsync(IRedbUser user)
GetUserPermissionCountAsync(long, CancellationToken)
Get permission count for user.
protected virtual Task<int> GetUserPermissionCountAsync(long userId, CancellationToken cancellationToken = default)
GetUserPermissionCountAsync(long)
Get permission count for user.
protected virtual Task<int> GetUserPermissionCountAsync(long userId)
GrantPermissionAsync(IRedbRole, IRedbObject, PermissionAction, IRedbUser?, CancellationToken)
Grant permission to role.
public virtual Task<bool> GrantPermissionAsync(IRedbRole role, IRedbObject obj, PermissionAction actions, IRedbUser? currentUser = null, CancellationToken cancellationToken = default)
GrantPermissionAsync(IRedbRole, IRedbObject, PermissionAction, IRedbUser?)
Grant permission to role.
public virtual Task<bool> GrantPermissionAsync(IRedbRole role, IRedbObject obj, PermissionAction actions, IRedbUser? currentUser = null)
GrantPermissionAsync(IRedbUser, IRedbObject, PermissionAction, IRedbUser?, CancellationToken)
Grant permission to user.
public virtual Task<bool> GrantPermissionAsync(IRedbUser user, IRedbObject obj, PermissionAction actions, IRedbUser? currentUser = null, CancellationToken cancellationToken = default)
GrantPermissionAsync(IRedbUser, IRedbObject, PermissionAction, IRedbUser?)
Grant permission to user.
public virtual Task<bool> GrantPermissionAsync(IRedbUser user, IRedbObject obj, PermissionAction actions, IRedbUser? currentUser = null)
GrantPermissionInternalAsync(long?, long?, long, PermissionAction, IRedbUser?, CancellationToken)
Internal method to grant permission.
protected virtual Task<bool> GrantPermissionInternalAsync(long? userId, long? roleId, long objectId, PermissionAction actions, IRedbUser? currentUser = null, CancellationToken cancellationToken = default)
GrantPermissionInternalAsync(long?, long?, long, PermissionAction, IRedbUser?)
Internal method to grant permission.
protected virtual Task<bool> GrantPermissionInternalAsync(long? userId, long? roleId, long objectId, PermissionAction actions, IRedbUser? currentUser = null)
InvalidatePermissionCache(long?, long?)
Invalidate permission cache. Called after permission changes.
protected void InvalidatePermissionCache(long? userId = null, long? objectId = null)
OnPermissionCreatedAsync(IRedbPermission, IRedbUser?, CancellationToken)
Called after permission is created. Override in Pro for audit.
protected virtual Task OnPermissionCreatedAsync(IRedbPermission permission, IRedbUser? currentUser, CancellationToken cancellationToken = default)
OnPermissionCreatedAsync(IRedbPermission, IRedbUser?)
Called after permission is created. Override in Pro for audit.
protected virtual Task OnPermissionCreatedAsync(IRedbPermission permission, IRedbUser? currentUser)
OnPermissionDeletedAsync(IRedbPermission, IRedbUser?, CancellationToken)
Called after permission is deleted. Override in Pro for audit.
protected virtual Task OnPermissionDeletedAsync(IRedbPermission permission, IRedbUser? currentUser, CancellationToken cancellationToken = default)
OnPermissionDeletedAsync(IRedbPermission, IRedbUser?)
Called after permission is deleted. Override in Pro for audit.
protected virtual Task OnPermissionDeletedAsync(IRedbPermission permission, IRedbUser? currentUser)
OnPermissionUpdatedAsync(IRedbPermission, IRedbUser?, CancellationToken)
Called after permission is updated. Override in Pro for audit.
protected virtual Task OnPermissionUpdatedAsync(IRedbPermission permission, IRedbUser? currentUser, CancellationToken cancellationToken = default)
OnPermissionUpdatedAsync(IRedbPermission, IRedbUser?)
Called after permission is updated. Override in Pro for audit.
protected virtual Task OnPermissionUpdatedAsync(IRedbPermission permission, IRedbUser? currentUser)
RevokeAllRolePermissionsAsync(IRedbRole, IRedbUser?, CancellationToken)
Revoke all role permissions.
public virtual Task<int> RevokeAllRolePermissionsAsync(IRedbRole role, IRedbUser? currentUser = null, CancellationToken cancellationToken = default)
RevokeAllRolePermissionsAsync(IRedbRole, IRedbUser?)
Revoke all role permissions.
public virtual Task<int> RevokeAllRolePermissionsAsync(IRedbRole role, IRedbUser? currentUser = null)
RevokeAllUserPermissionsAsync(IRedbUser, IRedbUser?, CancellationToken)
Revoke all user permissions.
public virtual Task<int> RevokeAllUserPermissionsAsync(IRedbUser user, IRedbUser? currentUser = null, CancellationToken cancellationToken = default)
RevokeAllUserPermissionsAsync(IRedbUser, IRedbUser?)
Revoke all user permissions.
public virtual Task<int> RevokeAllUserPermissionsAsync(IRedbUser user, IRedbUser? currentUser = null)
RevokePermissionAsync(IRedbRole, IRedbObject, IRedbUser?, CancellationToken)
Revoke permission from role.
public virtual Task<bool> RevokePermissionAsync(IRedbRole role, IRedbObject obj, IRedbUser? currentUser = null, CancellationToken cancellationToken = default)
RevokePermissionAsync(IRedbRole, IRedbObject, IRedbUser?)
Revoke permission from role.
public virtual Task<bool> RevokePermissionAsync(IRedbRole role, IRedbObject obj, IRedbUser? currentUser = null)
RevokePermissionAsync(IRedbUser, IRedbObject, IRedbUser?, CancellationToken)
Revoke permission from user.
public virtual Task<bool> RevokePermissionAsync(IRedbUser user, IRedbObject obj, IRedbUser? currentUser = null, CancellationToken cancellationToken = default)
RevokePermissionAsync(IRedbUser, IRedbObject, IRedbUser?)
Revoke permission from user.
public virtual Task<bool> RevokePermissionAsync(IRedbUser user, IRedbObject obj, IRedbUser? currentUser = null)
RevokePermissionInternalAsync(long?, long?, long, IRedbUser?, CancellationToken)
Internal method to revoke permission.
protected virtual Task<bool> RevokePermissionInternalAsync(long? userId, long? roleId, long objectId, IRedbUser? currentUser = null, CancellationToken cancellationToken = default)
RevokePermissionInternalAsync(long?, long?, long, IRedbUser?)
Internal method to revoke permission.
protected virtual Task<bool> RevokePermissionInternalAsync(long? userId, long? roleId, long objectId, IRedbUser? currentUser = null)
UpdatePermissionAsync(IRedbPermission, PermissionRequest, IRedbUser?, CancellationToken)
Update permission.
public virtual Task<IRedbPermission> UpdatePermissionAsync(IRedbPermission permission, PermissionRequest request, IRedbUser? currentUser = null, CancellationToken cancellationToken = default)
UpdatePermissionAsync(IRedbPermission, PermissionRequest, IRedbUser?)
Update permission.
public virtual Task<IRedbPermission> UpdatePermissionAsync(IRedbPermission permission, PermissionRequest request, IRedbUser? currentUser = null)