Field Detail

• public static final java.lang.String AJAX_HEADER

  Default value for the name of the Ajax header.

• public static final java.lang.String DEFAULT_TARGET_PARAMETER

• public static final java.lang.String FILTERS_NONE

• public static final java.lang.String NO_ROLE

  Used to ensure that all authenticated users have at least one granted authority to work around Spring Security code that assumes at least one. By granting this non-authority, the user can't do anything but gets past the somewhat arbitrary restrictions.

• public static final java.lang.String SAVED_REQUEST

• public static final java.lang.String SPRING_SECURITY_LAST_USERNAME_KEY

• public static final java.lang.String XML_HTTP_REQUEST

Property Detail

• static java.util.List<java.lang.String> afterInvocationManagerProviderNames

  AfterInvocationProvider names. Plugins add or remove them, and can be overridden by config.

• static java.util.SortedMap<java.lang.Integer, jakarta.servlet.Filter> configuredOrderedFilters

  Set by SpringSecurityCoreGrailsPlugin contains the actual filter beans in order.

• static java.util.List<java.lang.String> logoutHandlerNames

  Logout handler names. Plugins add or remove them, and can be overridden by config.

• static java.util.Map<java.lang.Integer, java.lang.String> orderedFilters

  Ordered filter names. Plugins add or remove them, and can be overridden by config.

• static java.util.List<java.lang.String> providerNames

  Authentication provider names. Plugins add or remove them, and can be overridden by config.

• groovy.util.ConfigObject securityConfig

• static java.util.List<java.lang.String> voterNames

  Voter names. Plugins add or remove them and can be overridden by config.

Method Detail

• static java.util.Set<java.lang.String> authoritiesToRoles(java.lang.Object authorities)

  Extract the role names from authorities.

  Parameters:

  authorities - the authorities (a collection or array of org.springframework.security.core.GrantedAuthority).

  Returns:

  the names

• static void buildFilterChains(java.util.SortedMap<java.lang.Integer, java.lang.String> filterNames, java.util.List<java.util.Map<java.lang.String, ?>> chainMap, java.util.List<GrailsSecurityFilterChain> filterChains, org.springframework.context.ApplicationContext applicationContext)

• static void clientRegisterFilter(java.lang.String beanName, SecurityFilterPosition position)

  Register a filter in a specified position in the chain. Note - this is for use in application code after the plugin has initialized, e.g. in BootStrap where you want to register a custom filter in the correct order without dealing with the existing configured filters.

  Parameters:

  beanName - the Spring bean name of the filter

  position - the position

• @java.lang.SuppressWarnings(value: deprecation)
  static void clientRegisterFilter(java.lang.String beanName, int order)

  Register a filter in a specified position in the chain. Note - this is for use in application code after the plugin has initialized, e.g. in BootStrap where you want to register a custom filter in the correct order without dealing with the existing configured filters.

  Parameters:

  beanName - the Spring bean name of the filter

  order - the position (see SecurityFilterPosition)

• static java.lang.Object doWithAuth(groovy.lang.Closure<?> closure)

  Execute a closure with the current authentication. Assumes that there's an authentication in the http session and that the closure is running in a separate thread from the web request, so the context and authentication aren't available to the standard ThreadLocal.

  Parameters:

  closure - the code to run

  Returns:

  the closure's return value

• static java.lang.Object doWithAuth(java.lang.String username, groovy.lang.Closure<?> closure)

  Authenticate as the specified user and execute the closure with that authentication. Restores the authentication to the one that was active if it exists, or clears the context otherwise. This is similar to run-as and switch-user but is only local to a Closure.

  Parameters:

  username - the username to authenticate as

  closure - the code to run

  Returns:

  the closure's return value

• static java.util.SortedMap<java.lang.Integer, java.lang.String> findFilterChainNames(java.lang.Object filterChainFilterNames, boolean useSecureChannel, boolean useIpRestrictions, boolean useX509, boolean useDigestAuth, boolean useBasicAuth, boolean useSwitchUserFilter)

• static java.lang.Throwable getLastException(jakarta.servlet.http.HttpSession session)

  Get the last auth exception.

  Parameters:

  session - the session

  Returns:

  the exception

• static java.lang.String getLastUsername(jakarta.servlet.http.HttpSession session)

  Get the last attempted username.

  Parameters:

  session - the session

  Returns:

  the username

• @groovy.transform.CompileDynamic
  static java.util.Collection<org.springframework.security.core.GrantedAuthority> getPrincipalAuthorities()

  Get the current user's authorities.

  Returns:

  a list of authorities (empty if not authenticated).

• static org.springframework.security.web.savedrequest.SavedRequest getSavedRequest(jakarta.servlet.http.HttpSession session)

  Get the saved request from the session.

  Parameters:

  session - the session

  Returns:

  the saved request

• static groovy.util.ConfigObject getSecurityConfig()

  Parse and load the security configuration.

  Returns:

  the configuration

• static java.lang.String getSecurityConfigType()

  Lookup the security type as a String to avoid dev mode reload issues.

  Returns:

  the name of the SecurityConfigType

• static org.springframework.security.core.context.SecurityContext getSecurityContext(jakarta.servlet.http.HttpSession session)

• static java.lang.String getSwitchedUserOriginalUsername()

  Get the username of the original user before switching to another.

  Returns:

  the original login name

• static boolean ifAllGranted(java.lang.String roles)

  Check if the current user has all of the specified roles.

  Parameters:

  roles - a comma-delimited list of role names

  Returns:

  true if the user is authenticated and has all the roles

• static boolean ifAllGranted(java.util.Collection<? extends org.springframework.security.core.GrantedAuthority> roles)

• static boolean ifAnyGranted(java.lang.String roles)

  Check if the current user has any of the specified roles.

  Parameters:

  roles - a comma-delimited list of role names

  Returns:

  true if the user is authenticated and has any the roles

• static boolean ifAnyGranted(java.util.Collection<? extends org.springframework.security.core.GrantedAuthority> roles)

• static boolean ifNotGranted(java.lang.String roles)

  Check if the current user has none of the specified roles.

  Parameters:

  roles - a comma-delimited list of role names

  Returns:

  true if the user is authenticated and has none the roles

• static boolean ifNotGranted(java.util.Collection<? extends org.springframework.security.core.GrantedAuthority> roles)

• static boolean isAjax(jakarta.servlet.http.HttpServletRequest request)

  Check if the request was triggered by an Ajax call.

  Parameters:

  request - the request

  Returns:

  true if Ajax

• static boolean isSwitched()

  Check if the current user is switched to another user.

  Returns:

  true if logged in and switched

• static void loadSecondaryConfig(java.lang.String className)

  Allow a secondary plugin to add config attributes.

  Parameters:

  className - the name of the config class.

• static boolean noFilterIsApplied(java.util.List<java.util.Map<java.lang.String, ?>> chainMap, java.lang.String pattern)

• static java.util.List<org.springframework.security.core.GrantedAuthority> parseAuthoritiesString(java.lang.String roleNames)

  Split the role names and create org.springframework.security.core.GrantedAuthoritys for each.

  Parameters:

  roleNames - comma-delimited role names

  Returns:

  authorities (possibly empty)

• static void reauthenticate(java.lang.String username, java.lang.String password)

  Rebuild an Authentication for the given username and register it in the security context. Typically used after updating a user's authorities or other auth-cached info. Also removes the user from the user cache to force a refresh at next login.

  Parameters:

  username - the user's login name

  password - optional

• static void registerAfterInvocationProvider(java.lang.String beanName)

  Register an AfterInvocationProvider bean name. Note - only for use by plugins during bean building.

  Parameters:

  beanName - the Spring bean name of the provider

• static void registerFilter(java.lang.String beanName, SecurityFilterPosition position)

  Register a filter bean name in a specified position in the chain. Note - only for use by plugins during bean building - to register at runtime (preferably in BootStrap) use clientRegisterFilter.

  Parameters:

  beanName - the Spring bean name of the filter

  position - the position

• static void registerFilter(java.lang.String beanName, int order)

  Register a filter bean name in a specified position in the chain. Note - only for use by plugins during bean building - to register at runtime (preferably in BootStrap) use clientRegisterFilter.

  Parameters:

  beanName - the Spring bean name of the filter

  order - the position (see SecurityFilterPosition)

• static void registerLogoutHandler(java.lang.String beanName)

  Register a logout handler bean name. Note - only for use by plugins during bean building.

  Parameters:

  beanName - the Spring bean name of the handler

• static void registerProvider(java.lang.String beanName)

  Register a provider bean name. Note - only for use by plugins during bean building.

  Parameters:

  beanName - the Spring bean name of the provider

• static void registerVoter(java.lang.String beanName)

  Register a voter bean name. Note - only for use by plugins during bean building.

  Parameters:

  beanName - the Spring bean name of the voter

• static void reloadSecurityConfig()

  Force a reload of the security configuration.

• static void resetSecurityConfig()

  Reset the config for testing or after a dev mode Config.groovy change.

• static java.util.Set<java.lang.String> retainAll(java.lang.Object granted, java.lang.Object required)

  Find authorities in granted that are also in required.

  Parameters:

  granted - the granted authorities (a collection or array of org.springframework.security.core.GrantedAuthority).

  required - the required authorities (a collection or array of org.springframework.security.core.GrantedAuthority).

  Returns:

  the authority names

• static void setApplication(grails.core.GrailsApplication app)

  Set at startup by plugin.

  Parameters:

  app - the application

• static void setSecurityConfig(groovy.util.ConfigObject config)

  For testing only.

  Parameters:

  config - the config