Nucleus .Net Core CMS

Authorization.PermissionExtensions Class

Namespace: Nucleus.Extensions.Authorization
Assembly: Nucleus.Extensions.dll
Extensions used to check the a user's permissions.

Fields

CONTROL_PANEL_DOCKING_COOKIE_NAME

Name of the cookie used to store the user control panel docking location.

EDIT_COOKIE_NAME

Name of the cookie used to track whether the user is in "edit mode".

Methods

CanEditContent (ClaimsPrincipal, Site, Page) Method 

CanEditContent (ClaimsPrincipal user, Site site, Page page)
Returns a value specifying whether the user has permission to edit content in any module on the specified page.
Parameters
Name Type
user System.Security.Claims.ClaimsPrincipal
site Nucleus.Abstractions.Models.Site
page Nucleus.Abstractions.Models.Page

HasBrowsePermission (ClaimsPrincipal, Site, Folder) Method 

HasBrowsePermission (ClaimsPrincipal user, Site site, Folder folder)
Returns a true/false value indicating whether the user has browse rights for the folder.
Parameters
Name Type
user System.Security.Claims.ClaimsPrincipal
site Nucleus.Abstractions.Models.Site
folder Nucleus.Abstractions.Models.FileSystem.Folder

HasEditPermission (ClaimsPrincipal, Site, Page) Method 

HasEditPermission (ClaimsPrincipal user, Site site, Page page)
Returns a true/false value indicating whether the user has edit rights for the module.
Parameters
Name Type
user System.Security.Claims.ClaimsPrincipal
site Nucleus.Abstractions.Models.Site
page Nucleus.Abstractions.Models.Page

HasEditPermission (ClaimsPrincipal, Site, ControlPanelExtensionDefinition, Type) Method 

HasEditPermission (ClaimsPrincipal user, Site site, ControlPanelExtensionDefinition controlPanelExtension, Type controllerType)
Return whether the current user has permission to use the specified control panel extension.
Parameters
Name Type
user System.Security.Claims.ClaimsPrincipal
site Nucleus.Abstractions.Models.Site
controlPanelExtension Nucleus.Abstractions.Models.ControlPanelExtensionDefinition
controllerType Type
Remarks
This function is intended for use with the standard Nucleus authorization policies and only checks the system admin policy and site admin policy. This function checks the AuthorizeAttribute policy property only, it does not check the AuthorizationSchemes or Roles properties.

HasEditPermission (ClaimsPrincipal, Site, Page, PageModule) Method 

HasEditPermission (ClaimsPrincipal user, Site site, Page page, PageModule moduleInfo)
Returns a true/false value indicating whether the user has edit rights for the specified module.
Parameters
Name Type
user System.Security.Claims.ClaimsPrincipal
site Nucleus.Abstractions.Models.Site
page Nucleus.Abstractions.Models.Page
moduleInfo Nucleus.Abstractions.Models.PageModule

HasEditPermission (ClaimsPrincipal, Site, Folder) Method 

HasEditPermission (ClaimsPrincipal user, Site site, Folder folder)
Returns a true/false value indicating whether the user has edit rights for the folder.
Parameters
Name Type
user System.Security.Claims.ClaimsPrincipal
site Nucleus.Abstractions.Models.Site
folder Nucleus.Abstractions.Models.FileSystem.Folder

HasPermission (ClaimsPrincipal, Site, List<Permission>, String) Method 

HasPermission (ClaimsPrincipal user, Site site, List<Permission> permissions, String scope)
Returns a true/false value indicating whether the user has the specified permission.
Parameters
Name Type
user System.Security.Claims.ClaimsPrincipal
site Nucleus.Abstractions.Models.Site
permissions System.Collections.Generic.List<Nucleus.Abstractions.Models.Permission>
scope String

HasViewPermission (ClaimsPrincipal, Site, Page) Method 

HasViewPermission (ClaimsPrincipal user, Site site, Page page)
Returns a true/false value indicating whether the user has view rights for the module.
Parameters
Name Type
user System.Security.Claims.ClaimsPrincipal
site Nucleus.Abstractions.Models.Site
page Nucleus.Abstractions.Models.Page

HasViewPermission (Role, Page) Method 

HasViewPermission (Role role, Page page)
Returns a true/false value indicating whether the role has view rights for the page.
Parameters
Name Type
role Nucleus.Abstractions.Models.Role
page Nucleus.Abstractions.Models.Page

HasViewPermission (ClaimsPrincipal, Site, Page, PageModule) Method 

HasViewPermission (ClaimsPrincipal user, Site site, Page page, PageModule moduleInfo)
Returns a true/false value indicating whether the user has view rights for the module.
Parameters
Name Type
user System.Security.Claims.ClaimsPrincipal
site Nucleus.Abstractions.Models.Site
page Nucleus.Abstractions.Models.Page
moduleInfo Nucleus.Abstractions.Models.PageModule

HasViewPermission (Role, PageModule) Method 

HasViewPermission (Role role, PageModule moduleInfo)
Returns a true/false value indicating whether the role has view rights for the module.
Parameters
Name Type
role Nucleus.Abstractions.Models.Role
moduleInfo Nucleus.Abstractions.Models.PageModule

HasViewPermission (ClaimsPrincipal, Site, Folder) Method 

HasViewPermission (ClaimsPrincipal user, Site site, Folder folder)
Returns a true/false value indicating whether the user has view rights for the folder.
Parameters
Name Type
user System.Security.Claims.ClaimsPrincipal
site Nucleus.Abstractions.Models.Site
folder Nucleus.Abstractions.Models.FileSystem.Folder

HasViewPermission (Role, Folder) Method 

HasViewPermission (Role role, Folder folder)
Returns a true/false value indicating whether the role has view rights for the folder.
Parameters
Name Type
role Nucleus.Abstractions.Models.Role
folder Nucleus.Abstractions.Models.FileSystem.Folder

IsEditing (ClaimsPrincipal, HttpContext) Method 

IsEditing (ClaimsPrincipal user, HttpContext context)
Returns a value specifying whether the user is in edit mode.
Parameters
Name Type
user System.Security.Claims.ClaimsPrincipal
context Microsoft.AspNetCore.Http.HttpContext

IsEditing (ClaimsPrincipal, HttpContext, Site, Page, PageModule) Method 

IsEditing (ClaimsPrincipal user, HttpContext context, Site site, Page page, PageModule module)
Returns a value specifying whether the user has permissions to edit the specified module and has clicked the control panel button to enable editing (which sets a cookie).
Parameters
Name Type
user System.Security.Claims.ClaimsPrincipal
context Microsoft.AspNetCore.Http.HttpContext
site Nucleus.Abstractions.Models.Site
page Nucleus.Abstractions.Models.Page
module Nucleus.Abstractions.Models.PageModule

IsEditing (ClaimsPrincipal, HttpContext, Site, Page) Method 

IsEditing (System.Security.Claims.ClaimsPrincipal,  Microsoft.AspNetCore.Http.HttpContext,  Nucleus.Abstractions.Models.Site,  Nucleus.Abstractions.Models.Page)
Returns a value specifying whether the user has permissions to edit the specified page and has clicked the control panel button to enable editing (which sets a cookie).

IsFolderBrowsePermission (Permission) Method 

IsFolderBrowsePermission (Permission permission)
Returns a true/false value indicating whether the specified permission is a Models.FileSystem.Folder View permission.
Parameters
Name Type
permission Nucleus.Abstractions.Models.Permission

IsFolderBrowsePermission (PermissionType) Method 

IsFolderBrowsePermission (PermissionType permissionType)
Returns a true/false value indicating whether the specified permission typeis a Models.FileSystem.Folder View permission.
Parameters
Name Type
permissionType Nucleus.Abstractions.Models.PermissionType

IsFolderEditPermission (Permission) Method 

IsFolderEditPermission (Permission permission)
Returns a true/false value indicating whether the specified permission is a Models.FileSystem.Folder Edit permission.
Parameters
Name Type
permission Nucleus.Abstractions.Models.Permission

IsFolderEditPermission (PermissionType) Method 

IsFolderEditPermission (PermissionType permissionType)
Returns a true/false value indicating whether the specified permissiontype is a Models.FileSystem.Folder Edit permission.
Parameters
Name Type
permissionType Nucleus.Abstractions.Models.PermissionType

IsFolderViewPermission (Permission) Method 

IsFolderViewPermission (Permission permission)
Returns a true/false value indicating whether the specified permission is a Models.FileSystem.Folder View permission.
Parameters
Name Type
permission Nucleus.Abstractions.Models.Permission

IsFolderViewPermission (PermissionType) Method 

IsFolderViewPermission (PermissionType permissionType)
Returns a true/false value indicating whether the specified permission typeis a Models.FileSystem.Folder View permission.
Parameters
Name Type
permissionType Nucleus.Abstractions.Models.PermissionType

IsModuleEditPermission (Permission) Method 

IsModuleEditPermission (Permission permission)
Returns a true/false value indicating whether the specified permission is a Models.PageModule Edit permission.
Parameters
Name Type
permission Nucleus.Abstractions.Models.Permission

IsModuleEditPermission (PermissionType) Method 

IsModuleEditPermission (PermissionType permissionType)
Returns a true/false value indicating whether the specified permission type is a Models.PageModule Edit permission.
Parameters
Name Type
permissionType Nucleus.Abstractions.Models.PermissionType

IsModuleViewPermission (Permission) Method 

IsModuleViewPermission (Permission permission)
Returns a true/false value indicating whether the specified permission is a Models.PageModule View permission.
Parameters
Name Type
permission Nucleus.Abstractions.Models.Permission

IsModuleViewPermission (PermissionType) Method 

IsModuleViewPermission (PermissionType permissionType)
Returns a true/false value indicating whether the specified permission type is a Models.PageModule View permission.
Parameters
Name Type
permissionType Nucleus.Abstractions.Models.PermissionType

IsPageEditPermission (Permission) Method 

IsPageEditPermission (Permission permission)
Returns a true/false value indicating whether the specified permission is a Models.Page Edit permission.
Parameters
Name Type
permission Nucleus.Abstractions.Models.Permission

IsPageEditPermission (PermissionType) Method 

IsPageEditPermission (PermissionType permissionType)
Returns a true/false value indicating whether the specified permission type is a Models.Page Edit permission.
Parameters
Name Type
permissionType Nucleus.Abstractions.Models.PermissionType

IsPageViewPermission (Permission) Method 

IsPageViewPermission (Permission permission)
Returns a true/false value indicating whether the specified permission is a Models.Page View permission.
Parameters
Name Type
permission Nucleus.Abstractions.Models.Permission

IsPageViewPermission (PermissionType) Method 

IsPageViewPermission (PermissionType permissionType)
Returns a true/false value indicating whether the specified permission type is a Models.Page View permission.
Parameters
Name Type
permissionType Nucleus.Abstractions.Models.PermissionType

IsValid (Permission, Site, ClaimsPrincipal) Method 

IsValid (Permission permission, Site site, ClaimsPrincipal user)
Returns a true/false value indicating whether the user is allowed to access the resource represented by the specified permission.
Parameters
Name Type
permission Nucleus.Abstractions.Models.Permission
site Nucleus.Abstractions.Models.Site
user System.Security.Claims.ClaimsPrincipal
Quick links
    Privacy Policy