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:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-jms-ticket-registry</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-jms-ticket-registry:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-jms-ticket-registry"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references should be included automatically and are listed here for reference only.
implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
*/
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:
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.
|
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.
|
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.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.
|
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.
|
This CAS feature is able to accept signing and encryption crypto keys. In most scenarios if keys are not provided, CAS will auto-generate them. The following instructions apply if you wish to manually and beforehand create the signing and encryption keys.
Note that if you are asked to create a JWK of a certain size for the key, you are to use the following set of commands to generate the token:
1
2
wget https://raw.githubusercontent.com/apereo/cas/master/etc/jwk-gen.jar
java -jar jwk-gen.jar -t oct -s [size]
The outcome would be similar to:
1
2
3
4
5
{
"kty": "oct",
"kid": "...",
"k": "..."
}
The generated value for k
needs to be assigned to the relevant CAS settings. Note that keys generated via
the above algorithm are processed by CAS using the Advanced Encryption Standard (AES
) algorithm which is a
specification for the encryption of electronic data established by the U.S. National Institute of Standards and Technology.
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be
recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION
that should be set to true
. Additional validation processes are also handled
via Configuration Metadata and property migrations applied automatically on
startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
ActiveMQ
CAS can configure the ticket registry when it detects that ActiveMQ is available on the classpath. If the broker is present, an embedded broker is started and configured automatically, as long as no broker URL is specified through configuration. By default, ActiveMQ creates a destination if it does not exist yet, so destinations are resolved against their provided names.
The following settings and properties are available from the CAS configuration catalog:
spring.activemq.broker-url=
URL of the ActiveMQ broker. Auto-generated by default.
|
spring.activemq.close-timeout=15s
Time to wait before considering a close complete.
|
spring.activemq.in-memory=true
Whether the default broker URL should be in memory. Ignored if an explicit broker has been specified.
|
spring.activemq.non-blocking-redelivery=false
Whether to stop message delivery before re-delivering messages from a rolled back transaction. This implies that message order is not preserved when this is enabled.
|
spring.activemq.packages.trust-all=
Whether to trust all packages.
|
spring.activemq.packages.trusted=
Comma-separated list of specific packages to trust (when not trusting all packages).
|
spring.activemq.password=
Login password of the broker.
|
spring.activemq.pool.block-if-full=true
Whether to block when a connection is requested and the pool is full. Set it to false to throw a "JMSException" instead.
|
spring.activemq.pool.block-if-full-timeout=-1ms
Blocking period before throwing an exception if the pool is still full.
|
spring.activemq.pool.create-connection-on-startup=true
Whether to create a connection on startup. Can be used to warm up the pool on startup. How can I configure this property?
Deprecation status is |
spring.activemq.pool.enabled=false
Whether a JmsPoolConnectionFactory should be created, instead of a regular ConnectionFactory.
|
spring.activemq.pool.expiry-timeout=0ms
Deprecation status is |
spring.activemq.pool.idle-timeout=30s
Connection idle timeout.
|
spring.activemq.pool.max-connections=1
Maximum number of pooled connections.
|
spring.activemq.pool.max-sessions-per-connection=500
Maximum number of pooled sessions per connection in the pool.
|
spring.activemq.pool.maximum-active-session-per-connection=
Deprecation status is |
spring.activemq.pool.reconnect-on-exception=true
Deprecation status is |
spring.activemq.pool.time-between-expiration-check=-1ms
Time to sleep between runs of the idle connection eviction thread. When negative, no idle connection eviction thread runs.
|
spring.activemq.pool.use-anonymous-producers=true
Whether to use only one anonymous "MessageProducer" instance. Set it to false to create one "MessageProducer" every time one is required.
|
spring.activemq.send-timeout=0ms
Time to wait on message sends for a response. Set it to 0 to wait forever.
|
spring.activemq.user=
Login user of the broker.
|
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be
recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION
that should be set to true
. Additional validation processes are also handled
via Configuration Metadata and property migrations applied automatically on
startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
The default setting for ActiveMQ is that all persistent messages outside of a transaction
are sent to a broker are synchronous. This means that the send method is blocked until the
message is received by the broker, its then written to disk - then a response is returned
to the client and the send()
unblocks with success or throws an error if
the send could not complete (e.g. due to a security exception).
Artemis
CAS can auto-configure the ticket registry when it detects that Artemis is available on the classpath. If the broker is present, an embedded broker is started and configured automatically (unless the mode property has been explicitly set). The supported modes are: embedded (to make explicit that an embedded broker is required and should lead to an error if the broker is not available in the classpath), and native to connect to a broker using the netty transport protocol. When the latter is configured, CAS configures the registry connecting to a broker running on the local machine with the default settings.
Support is enabled by including the following dependency in the overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>spring-boot-starter-artemis</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:spring-boot-starter-artemis:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:spring-boot-starter-artemis"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references should be included automatically and are listed here for reference only.
implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
*/
implementation "org.apereo.cas:spring-boot-starter-artemis"
}
The following settings and properties are available from the CAS configuration catalog:
spring.artemis.broker-url=tcp://localhost:61616
Artemis broker port.
|
spring.artemis.embedded.cluster-password=
Cluster password. Randomly generated on startup by default.
|
spring.artemis.embedded.data-directory=
Journal file directory. Not necessary if persistence is turned off.
|
spring.artemis.embedded.enabled=true
Whether to enable embedded mode if the Artemis server APIs are available.
|
spring.artemis.embedded.persistent=false
Whether to enable persistent store.
|
spring.artemis.embedded.queues=
Comma-separated list of queues to create on startup.
|
spring.artemis.embedded.server-id=0
Server ID. By default, an auto-incremented counter is used.
|
spring.artemis.embedded.topics=
Comma-separated list of topics to create on startup.
|
spring.artemis.host=
Deprecation status is |
spring.artemis.mode=
Artemis deployment mode, auto-detected by default.
|
spring.artemis.password=
Login password of the broker.
|
spring.artemis.pool.block-if-full=true
Whether to block when a connection is requested and the pool is full. Set it to false to throw a "JMSException" instead.
|
spring.artemis.pool.block-if-full-timeout=-1ms
Blocking period before throwing an exception if the pool is still full.
|
spring.artemis.pool.enabled=false
Whether a JmsPoolConnectionFactory should be created, instead of a regular ConnectionFactory.
|
spring.artemis.pool.idle-timeout=30s
Connection idle timeout.
|
spring.artemis.pool.max-connections=1
Maximum number of pooled connections.
|
spring.artemis.pool.max-sessions-per-connection=500
Maximum number of pooled sessions per connection in the pool.
|
spring.artemis.pool.maximum-active-session-per-connection=
Deprecation status is |
spring.artemis.pool.time-between-expiration-check=-1ms
Time to sleep between runs of the idle connection eviction thread. When negative, no idle connection eviction thread runs.
|
spring.artemis.pool.use-anonymous-producers=true
Whether to use only one anonymous "MessageProducer" instance. Set it to false to create one "MessageProducer" every time one is required.
|
spring.artemis.port=
Deprecation status is |
spring.artemis.user=
Login user of the broker.
|
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be
recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION
that should be set to true
. Additional validation processes are also handled
via Configuration Metadata and property migrations applied automatically on
startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
JNDI
If you are running CAS in an application server,
CAS will attempt to locate a JMS connection using JNDI. By default, the locations
java:/JmsXA
and java:/XAConnectionFactory
will be checked.
The following settings and properties are available from the CAS configuration catalog:
spring.jms.cache.consumers=false
Whether to cache message consumers.
|
spring.jms.cache.enabled=true
Whether to cache sessions.
|
spring.jms.cache.producers=true
Whether to cache message producers.
|
spring.jms.cache.session-cache-size=1
Size of the session cache (per JMS Session type).
|
spring.jms.jndi-name=
Connection factory JNDI name. When set, takes precedence to others connection factory auto-configurations.
|
spring.jms.listener.acknowledge-mode=
Acknowledge mode of the container. By default, the listener is transacted with automatic acknowledgment.
|
spring.jms.listener.auto-startup=true
Start the container automatically on startup.
|
spring.jms.listener.concurrency=
Minimum number of concurrent consumers.
|
spring.jms.listener.max-concurrency=
Maximum number of concurrent consumers.
|
spring.jms.listener.receive-timeout=1s
Timeout to use for receive calls. Use -1 for a no-wait receive or 0 for no timeout at all. The latter is only feasible if not running within a transaction manager and is generally discouraged since it prevents clean shutdown.
|
spring.jms.pub-sub-domain=false
Whether the default destination type is topic.
|
spring.jms.servicebus.connection-string=
|
spring.jms.servicebus.idle-timeout=1800000
|
spring.jms.servicebus.topic-client-id=
JMS clientID
|
spring.jms.template.default-destination=
Default destination to use on send and receive operations that do not have a destination parameter.
|
spring.jms.template.delivery-delay=
Delivery delay to use for send calls.
|
spring.jms.template.delivery-mode=
Delivery mode. Enables QoS (Quality of Service) when set.
|
spring.jms.template.priority=
Priority of a message when sending. Enables QoS (Quality of Service) when set.
|
spring.jms.template.qos-enabled=
Whether to enable explicit QoS (Quality of Service) when sending a message. When enabled, the delivery mode, priority and time-to-live properties will be used when sending a message. QoS is automatically enabled when at least one of those settings is customized.
|
spring.jms.template.receive-timeout=
Timeout to use for receive calls.
|
spring.jms.template.time-to-live=
Time-to-live of a message when sending. Enables QoS (Quality of Service) when set.
|
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be
recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION
that should be set to true
. Additional validation processes are also handled
via Configuration Metadata and property migrations applied automatically on
startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
Troubleshooting
To enable additional logging, configure the log4j configuration file to add the following levels:
1
2
3
4
5
6
...
<Logger name="org.springframework.jms" level="debug" additivity="false">
<AppenderRef ref="console"/>
<AppenderRef ref="file"/>
</Logger>
...