Tracking Authentication Interrupts Per Service

Application definitions may be assigned a dedicated webflow interrupt policy. A sample JSON file follows:

1
2
3
4
5
6
7
8
9
10
11

{
  "@class" : "org.apereo.cas.services.CasRegisteredService",
  "serviceId" : "^https://.+",
  "name" : "sample service",
  "id" : 100,
  "webflowInterruptPolicy" : {
    "@class" : "org.apereo.cas.services.DefaultRegisteredServiceWebflowInterruptPolicy",
    "enabled": true,
    "forceExecution": "TRUE"
  }
}

Protocol Support

Authentication interrupts should work for all client application types supported by CAS, regardless of authentication protocol. Whether your application speaks CAS, SAML2, OpenID Connect, etc, the interrupt policy should equally apply and its method of configuration in the application definition remains the same.

The following policy settings are supported:

Additional interrupt triggers are listed below.

• Principal Attribute
• Groovy Script

• Interrupt triggers per application can be triggered based on the principal attributes. If the defined attribute name exists and can produce a value to match the defined attribute value, interrupt may be triggered.

  Field	Description
  attributeName	Regular expression pattern to compare against authentication and principal attribute names to trigger interrupt.
  attributeValue	Regular expression pattern to compare against authentication and principal attribute values to trigger interrupt.

  The application definition may be defined as:

  
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  
  {
    "@class" : "org.apereo.cas.services.CasRegisteredService",
    "serviceId" : "^https://.+",
    "name" : "sample service",
    "id" : 100,
    "webflowInterruptPolicy" : {
      "@class" : "org.apereo.cas.services.DefaultRegisteredServiceWebflowInterruptPolicy",
      "attributeName": "mem...of",
      "attributeValue": "^st[a-z]ff$"
    }
  }
  
  

  These fields support the Spring Expression Language syntax.

• Interrupt triggers per application can be triggered based on the outcome of an external or inline Groovy script. The script should return a boolean value, i.e. true or false to indicate whether interrupt should be triggered.

  Field	Description
  groovyScript	Inline or external groovy script to determine whether interrupt should be triggered for this application.

  This field supports the Spring Expression Language syntax.

  The application definition may be defined as:

  
  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  
  {
    "@class" : "org.apereo.cas.services.CasRegisteredService",
    "serviceId" : "^https://.+",
    "name" : "sample service",
    "id" : 100,
    "webflowInterruptPolicy" : {
      "@class" : "org.apereo.cas.services.DefaultRegisteredServiceWebflowInterruptPolicy",
      "groovyScript": "file:/path/to/script.groovy"
    }
  }
  
  

  An external script itself may be designed in Groovy as:

  
  1
  2
  3
  4
  5
  6
  
  def run(Object... args) {
      def (attributes,username,registeredService,service,logger) = args
      logger.debug("Current attributes received are {}", attributes)
      // Determine whether interrupt should be triggered...
      return true
  }
  
  

  Usage Warning

  Activating this mode is not without cost, as CAS needs to evaluate the script, compile and run it for subsequent executions. While the compiled script is cached and should help with execution performance, as a general rule, you should avoid opting for and designing complicated scripts.

  The following parameters are passed to the script:

  Parameter	Description
  attributes	Map of attributes currently resolved and available for release.
  username	The object representing the authenticated username.
  registeredService	The object representing the corresponding service definition in the registry.
  service	The object representing the service requesting authentication.
  logger	The object responsible for issuing log messages such as logger.info(...).