Package org.craftercms.engine.util

Class SecurityUtils

java.lang.Object
org.craftercms.engine.util.SecurityUtils
public class SecurityUtils extends Object
Utility class for security related operations.

  • Field Details

  • Method Details

    • getAuthorizedRolesMatchValue

      public static String getAuthorizedRolesMatchValue(@NonNull Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)
      Returns the value to be used in the authorizedRoles field of a search request.
      For each role, this method will include the role itself and the role with the ROLE_ prefix.
      Parameters:
      authorities - the user authorities/roles
      Returns:
      the value to be used in the authorizedRoles field of a search request

    • checkAccess

      public static void checkAccess(Collection<String> authorizedRoles, String url) throws org.springframework.security.access.AccessDeniedException, org.springframework.security.core.AuthenticationException
      Validates that the user has access to a content protected by the specified roles. This method will throw an AccessDeniedException if the user doesn't have access. Access is granted if:
      • authorizedRoles is empty
      • authorizedRoles contains 'anonymous' pseudo-role
      • authorizedRoles contains 'authenticated' pseudo-role and authentication is not anonymous
      • authorizedRoles contains any of the user roles/authorities
      Throws:
      org.springframework.security.access.AccessDeniedException
      org.springframework.security.core.AuthenticationException

    • containsRole

      protected static boolean containsRole(String role, Collection<String> roles)

    • hasAnyRole

      protected static boolean hasAnyRole(org.springframework.security.core.Authentication auth, Collection<String> roles)