JMS Ticket Registry

CAS can be enabled with a variety of messaging systems in order to distribute and share ticket data: from simplified use of the JMS API to a complete infrastructure to receive messages asynchronously. Integration with messaging systems is entirely built on top of Spring Boot.

Support is enabled by including the following dependency in the overlay:

implementation "org.apereo.cas:cas-server-support-jms-ticket-registry:${project.'cas.version'}"
<dependency>
  <groupId>org.apereo.cas</groupId>
  <artifactId>cas-server-support-jms-ticket-registry</artifactId>
  <version>${cas.version}</version>
</dependency>
dependencyManagement {
  imports {
    mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
  }
}

dependencies {  
  implementation "org.apereo.cas:cas-server-support-jms-ticket-registry"
}

This registry is very much an extension of the default ticket registry. The difference is that ticket operations applied to the registry are broadcasted using a messaging queue to other listening CAS nodes on the queue. Each node keeps copies of ticket state on its own and only instructs others to keep their copy accurate by broadcasting messages and data associated with each. Each message and ticket registry instance running inside a CAS node in the cluster is tagged with a unique identifier in order to avoid endless looping behavior and recursive needless inbound operations.

Configuration

The following settings and properties are available from the CAS configuration catalog:

The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

  • cas.ticket.registry.jms.crypto.encryption.key=
  • The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting.

  • cas.ticket.registry.jms.crypto.signing.key=
  • The signing key is a JWT whose length is defined by the signing key size setting.

    The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value.

  • cas.ticket.registry.jms.queue-identifier=
  • Identifier for this CAS server node that tags the sender/receiver in the JMS queue and avoid processing of inbound calls. If left blank, an identifier is generated automatically and kept in memory.

  • cas.ticket.registry.jms.crypto.alg=AES
  • The signing/encryption algorithm to use.

  • cas.ticket.registry.jms.crypto.enabled=true
  • Whether crypto operations are enabled.

  • cas.ticket.registry.jms.crypto.encryption.key-size=16
  • Encryption key size.

  • cas.ticket.registry.jms.crypto.signing.key-size=512
  • The signing key size.